Orbit OS SDK — API Reference

Language v26.0501.2330

Auth Manager

Authentication and session management.

Signature

func (m *AuthManager) Login(username, password string) (token string, expiresAt int64, err error)

Parameters

Name	Type	Notes
username	string
password	string

Returns

Name	Type	Notes
token	string
expiresAt	int64	Unix timestamp
error	error

Example

token, expiresAt, err := client.AuthManager.Login(username, password)

Logout Invalidates a session token.

Signature

func (m *AuthManager) Logout(token string) error

Parameters

Name	Type	Notes
token	string

Returns

Name	Type	Notes
error	error

Example

err := client.AuthManager.Logout(token)

System Manager

Device identity, hardware info, OS metadata and live metrics.

PermissionSystemService/*

GetApiVersion Returns the API version and revision running on the device.

Signature

func (s *SystemManager) GetApiVersion() (version int64, revision int64, err error)

Returns

Name	Type	Notes
version	int64
revision	int64
error	error

Example

version, revision, err := client.SystemManager.GetApiVersion()

GetApiVersionInfo Returns the API version as a formatted string.

Signature

func (s *SystemManager) GetApiVersionInfo() (string, error)

Returns

Name	Type	Notes
version	string
error	error

Example

ver, err := client.SystemManager.GetApiVersionInfo()

GetDeviceName Returns the configured device name.

Signature

func (s *SystemManager) GetDeviceName() (string, error)

Returns

Name	Type	Notes
value	string
error	error

Example

name, err := client.SystemManager.GetDeviceName()

GetSocModel Returns the SoC model identifier.

Signature

func (s *SystemManager) GetSocModel() (string, error)

Returns

Name	Type	Notes
value	string
error	error

Example

model, err := client.SystemManager.GetSocModel()

GetSocVendor Returns the SoC vendor name.

Signature

func (s *SystemManager) GetSocVendor() (string, error)

Returns

Name	Type	Notes
value	string
error	error

Example

vendor, err := client.SystemManager.GetSocVendor()

GetBoardModel Returns the board model identifier.

Signature

func (s *SystemManager) GetBoardModel() (string, error)

Returns

Name	Type	Notes
value	string
error	error

Example

model, err := client.SystemManager.GetBoardModel()

GetBoardVendor Returns the board vendor name.

Signature

func (s *SystemManager) GetBoardVendor() (string, error)

Returns

Name	Type	Notes
value	string
error	error

Example

vendor, err := client.SystemManager.GetBoardVendor()

GetHardwareVersion Returns the hardware revision string.

Signature

func (s *SystemManager) GetHardwareVersion() (string, error)

Returns

Name	Type	Notes
value	string
error	error

Example

ver, err := client.SystemManager.GetHardwareVersion()

GetHardwareModel Returns the hardware model identifier.

Signature

func (s *SystemManager) GetHardwareModel() (string, error)

Returns

Name	Type	Notes
value	string
error	error

Example

model, err := client.SystemManager.GetHardwareModel()

GetSystemUuid Returns the system UUID.

Signature

func (s *SystemManager) GetSystemUuid() (string, error)

Returns

Name	Type	Notes
value	string
error	error

Example

uuid, err := client.SystemManager.GetSystemUuid()

GetBoardSerial Returns the board serial number.

Signature

func (s *SystemManager) GetBoardSerial() (string, error)

Returns

Name	Type	Notes
value	string
error	error

Example

serial, err := client.SystemManager.GetBoardSerial()

GetCpuSerial Returns the CPU serial number.

Signature

func (s *SystemManager) GetCpuSerial() (string, error)

Returns

Name	Type	Notes
value	string
error	error

Example

serial, err := client.SystemManager.GetCpuSerial()

GetMachineId Returns the machine ID.

Signature

func (s *SystemManager) GetMachineId() (string, error)

Returns

Name	Type	Notes
value	string
error	error

Example

id, err := client.SystemManager.GetMachineId()

GetArchitecture Returns the CPU architecture (e.g. "arm64", "amd64").

Signature

func (s *SystemManager) GetArchitecture() (string, error)

Returns

Name	Type	Notes
value	string
error	error

Example

arch, err := client.SystemManager.GetArchitecture()

GetTotalRAM Returns total RAM in bytes.

Signature

func (s *SystemManager) GetTotalRAM() (uint64, error)

Returns

Name	Type	Notes
value	uint64
error	error

Example

ram, err := client.SystemManager.GetTotalRAM()

GetCpuModel Returns the CPU model string.

Signature

func (s *SystemManager) GetCpuModel() (string, error)

Returns

Name	Type	Notes
value	string
error	error

Example

model, err := client.SystemManager.GetCpuModel()

GetCpuCores Returns the number of physical CPU cores.

Signature

func (s *SystemManager) GetCpuCores() (int64, error)

Returns

Name	Type	Notes
value	int64
error	error

Example

cores, err := client.SystemManager.GetCpuCores()

GetCpuThreads Returns the number of logical CPU threads.

Signature

func (s *SystemManager) GetCpuThreads() (int64, error)

Returns

Name	Type	Notes
value	int64
error	error

Example

threads, err := client.SystemManager.GetCpuThreads()

GetCpuMinMhz Returns the minimum CPU frequency in MHz.

Signature

func (s *SystemManager) GetCpuMinMhz() (float64, error)

Returns

Name	Type	Notes
value	float64
error	error

Example

minMhz, err := client.SystemManager.GetCpuMinMhz()

GetCpuMaxMhz Returns the maximum CPU frequency in MHz.

Signature

func (s *SystemManager) GetCpuMaxMhz() (float64, error)

Returns

Name	Type	Notes
value	float64
error	error

Example

maxMhz, err := client.SystemManager.GetCpuMaxMhz()

GetOsName Returns the OS name.

Signature

func (s *SystemManager) GetOsName() (string, error)

Returns

Name	Type	Notes
value	string
error	error

Example

name, err := client.SystemManager.GetOsName()

GetOsVersion Returns the OS version string.

Signature

func (s *SystemManager) GetOsVersion() (string, error)

Returns

Name	Type	Notes
value	string
error	error

Example

ver, err := client.SystemManager.GetOsVersion()

GetKernelVersion Returns the kernel version string.

Signature

func (s *SystemManager) GetKernelVersion() (string, error)

Returns

Name	Type	Notes
value	string
error	error

Example

ver, err := client.SystemManager.GetKernelVersion()

GetDistro Returns the Linux distribution name.

Signature

func (s *SystemManager) GetDistro() (string, error)

Returns

Name	Type	Notes
value	string
error	error

Example

distro, err := client.SystemManager.GetDistro()

GetDistroVersion Returns the distribution version string.

Signature

func (s *SystemManager) GetDistroVersion() (string, error)

Returns

Name	Type	Notes
value	string
error	error

Example

ver, err := client.SystemManager.GetDistroVersion()

GetRuntimeVersion Returns the Orbit runtime version.

Signature

func (s *SystemManager) GetRuntimeVersion() (string, error)

Returns

Name	Type	Notes
value	string
error	error

Example

ver, err := client.SystemManager.GetRuntimeVersion()

GetOsRevision Returns the logical OS revision string.

Signature

func (s *SystemManager) GetOsRevision() (string, error)

Returns

Name	Type	Notes
value	string
error	error

Example

rev, err := client.SystemManager.GetOsRevision()

GetBuildVersion Alias for GetOsRevision.

Signature

func (s *SystemManager) GetBuildVersion() (string, error)

Returns

Name	Type	Notes
value	string
error	error

Example

ver, err := client.SystemManager.GetBuildVersion()

GetRuntimeBuildDate Returns the runtime image build date.

Signature

func (s *SystemManager) GetRuntimeBuildDate() (string, error)

Returns

Name	Type	Notes
value	string
error	error

Example

date, err := client.SystemManager.GetRuntimeBuildDate()

GetBuildDate Alias for GetRuntimeBuildDate.

Signature

func (s *SystemManager) GetBuildDate() (string, error)

Returns

Name	Type	Notes
value	string
error	error

Example

date, err := client.SystemManager.GetBuildDate()

GetMetrics Returns live CPU usage, RAM and storage stats.

Signature

func (s *SystemManager) GetMetrics() (*MetricsInfoResponse, error)

Returns

Name	Type	Notes
*MetricsInfoResponse
error	error

Example

metrics, err := client.SystemManager.GetMetrics()

Attach Attaches the SDK client to the running Gravity system service.

Signature

func (s *SystemManager) Attach() (bool, error)

Returns

Name	Type	Notes
ok	bool
error	error

Example

ok, err := client.SystemManager.Attach()

EnableDevMode Enables developer mode on the device.

Signature

func (s *SystemManager) EnableDevMode() (bool, error)

Returns

Name	Type	Notes
ok	bool
error	error

Example

ok, err := client.SystemManager.EnableDevMode()

DisableDevMode Disables developer mode on the device.

Signature

func (s *SystemManager) DisableDevMode() (bool, error)

Returns

Name	Type	Notes
ok	bool
error	error

Example

ok, err := client.SystemManager.DisableDevMode()

IsDevModeEnabled Reports whether developer mode is currently enabled.

Signature

func (s *SystemManager) IsDevModeEnabled() (bool, error)

Returns

Name	Type	Notes
enabled	bool
error	error

Example

ok, err := client.SystemManager.IsDevModeEnabled()

EnableSSHServer Enables the SSH server on the device.

Signature

func (s *SystemManager) EnableSSHServer() (bool, error)

Returns

Name	Type	Notes
ok	bool
error	error

Example

ok, err := client.SystemManager.EnableSSHServer()

DisableSSHServer Disables the SSH server on the device.

Signature

func (s *SystemManager) DisableSSHServer() (bool, error)

Returns

Name	Type	Notes
ok	bool
error	error

Example

ok, err := client.SystemManager.DisableSSHServer()

IsSSHServerEnabled Reports whether the SSH server is currently enabled.

Signature

func (s *SystemManager) IsSSHServerEnabled() (bool, error)

Returns

Name	Type	Notes
enabled	bool
error	error

Example

ok, err := client.SystemManager.IsSSHServerEnabled()

EnableRebootOnFailure Enables automatic reboot when a critical failure is detected.

Signature

func (s *SystemManager) EnableRebootOnFailure() (bool, error)

Returns

Name	Type	Notes
ok	bool
error	error

Example

ok, err := client.SystemManager.EnableRebootOnFailure()

DisableRebootOnFailure Disables automatic reboot on failure.

Signature

func (s *SystemManager) DisableRebootOnFailure() (bool, error)

Returns

Name	Type	Notes
ok	bool
error	error

Example

ok, err := client.SystemManager.DisableRebootOnFailure()

IsRebootOnFailureEnabled Reports whether automatic reboot on failure is enabled.

Signature

func (s *SystemManager) IsRebootOnFailureEnabled() (bool, error)

Returns

Name	Type	Notes
enabled	bool
error	error

Example

ok, err := client.SystemManager.IsRebootOnFailureEnabled()

AllowUntrustedApps Allows installation of apps from untrusted sources.

Signature

func (s *SystemManager) AllowUntrustedApps() (bool, error)

Returns

Name	Type	Notes
ok	bool
error	error

Example

ok, err := client.SystemManager.AllowUntrustedApps()

DisallowUntrustedApps Blocks installation of apps from untrusted sources.

Signature

func (s *SystemManager) DisallowUntrustedApps() (bool, error)

Returns

Name	Type	Notes
ok	bool
error	error

Example

ok, err := client.SystemManager.DisallowUntrustedApps()

IsUntrustedAppsAllowed Reports whether untrusted app installation is currently allowed.

Signature

func (s *SystemManager) IsUntrustedAppsAllowed() (bool, error)

Returns

Name	Type	Notes
allowed	bool
error	error

Example

ok, err := client.SystemManager.IsUntrustedAppsAllowed()

Package Manager

Application package installation and management.

PermissionPackageService/*

ListInstalledPackages Returns all installed packages.

Signature

func (p *PackageManager) ListInstalledPackages() ([]*InstalledPackage, error)

Returns

Name	Type	Notes
[]InstalledPackage
error	error

Example

pkgs, err := client.PackageManager.ListInstalledPackages()

InstallPackage Uploads and installs an .orb package from a local path.

Signature

func (p *PackageManager) InstallPackage(ctx context.Context, orbPath string) error

Parameters

Name	Type	Notes
ctx	Context
orbPath	string

Returns

Name	Type	Notes
error	error

Example

err := client.PackageManager.InstallPackage(ctx, "/path/to/app.orb")

RemovePackage Uninstalls a package by ID.

Signature

func (p *PackageManager) RemovePackage(ctx context.Context, packageID string) error

Parameters

Name	Type	Notes
ctx	Context
packageID	string

Returns

Name	Type	Notes
error	error

Example

err := client.PackageManager.RemovePackage(ctx, packageID)

Ethernet Manager

Ethernet interface configuration and status.

PermissionEthernetService/*

ListEthernetInterfaces Returns all Ethernet interfaces available on the device.

Signature

func (e *EthernetManager) ListEthernetInterfaces() ([]*EthernetLinkProperties, error)

Returns

Name	Type	Notes
[]*EthernetLinkProperties
error	error

Example

ifaces, err := client.EthernetManager.ListEthernetInterfaces()

IsEthernetConnected Reports whether the given interface has link.

Signature

func (e *EthernetManager) IsEthernetConnected(interfaceName string) (bool, error)

Parameters

Name	Type	Notes
interfaceName	string

Returns

Name	Type	Notes
connected	bool
error	error

Example

ok, err := client.EthernetManager.IsEthernetConnected("eth0")

GetEthernetLinkProperties Returns link properties (MAC, state, MTU, IP config) for an interface.

Signature

func (e *EthernetManager) GetEthernetLinkProperties(interfaceName string) (*EthernetLinkProperties, error)

Parameters

Name	Type	Notes
interfaceName	string

Returns

Name	Type	Notes
*EthernetLinkProperties
error	error

Example

props, err := client.EthernetManager.GetEthernetLinkProperties("eth0")

SetEthernetConfig Applies static IP or DHCP settings to an interface.

Signature

func (e *EthernetManager) SetEthernetConfig(
    interfaceName string, enable, dhcpEnable bool,
    ipv4Address, ipv4Gateway string, ipv4Dns []string,
) (bool, error)

Parameters

Name	Type	Notes
interfaceName	string
enable	bool
dhcpEnable	bool
ipv4Address	string	CIDR notation — ignored when dhcpEnable is true
ipv4Gateway	string
ipv4Dns	[]string

Returns

Name	Type	Notes
ok	bool
error	error

Example

ok, err := client.EthernetManager.SetEthernetConfig(
    "eth0", true, false,
    "192.168.1.10/24", "192.168.1.1", []string{"8.8.8.8"},
)

EnableEthernet Brings an Ethernet interface up.

Signature

func (e *EthernetManager) EnableEthernet(interfaceName string) (bool, error)

Parameters

Name	Type	Notes
interfaceName	string

Returns

Name	Type	Notes
ok	bool
error	error

Example

ok, err := client.EthernetManager.EnableEthernet("eth0")

DisableEthernet Brings an Ethernet interface down.

Signature

func (e *EthernetManager) DisableEthernet(interfaceName string) (bool, error)

Parameters

Name	Type	Notes
interfaceName	string

Returns

Name	Type	Notes
ok	bool
error	error

Example

ok, err := client.EthernetManager.DisableEthernet("eth0")

WiFi Manager

Wi-Fi interface management — client mode and access point.

PermissionWiFiService/*

General

ListInterfaces Returns all Wi-Fi interfaces on the device.

Signature

func (w *WiFiManager) ListInterfaces() ([]*WiFiLinkProperties, error)

Returns

Name	Type	Notes
[]*WiFiLinkProperties
error	error

Example

ifaces, err := client.WiFiManager.ListInterfaces()

GetLinkProperties Returns link-layer and mode properties for a Wi-Fi interface.

Signature

func (w *WiFiManager) GetLinkProperties(ifname string) (*WiFiLinkProperties, error)

Parameters

Name	Type	Notes
ifname	string

Returns

Name	Type	Notes
*WiFiLinkProperties
error	error

Example

props, err := client.WiFiManager.GetLinkProperties("wlan0")

IsConnected Returns true if the interface has an active Wi-Fi connection.

Signature

func (w *WiFiManager) IsConnected(ifname string) (bool, error)

Parameters

Name	Type	Notes
ifname	string

Returns

Name	Type	Notes
connected	bool
error	error

Example

ok, err := client.WiFiManager.IsConnected("wlan0")

GetMode Returns the current operating mode of the interface.

Signature

func (w *WiFiManager) GetMode(ifname string) (WiFiMode, error)

Parameters

Name	Type	Notes
ifname	string

Returns

Name	Type	Notes
mode	WiFiMode
error	error

Example

mode, err := client.WiFiManager.GetMode("wlan0")

SetModeClient Switches the interface to client (station) mode.

Signature

func (w *WiFiManager) SetModeClient(ifname string) (bool, error)

Parameters

Name	Type	Notes
ifname	string

Returns

Name	Type	Notes
ok	bool
error	error

Example

ok, err := client.WiFiManager.SetModeClient("wlan0")

Client

SetClientConfig Configures and stores Wi-Fi client settings for the interface.

Signature

func (w *WiFiManager) SetClientConfig(
    ifname, ssid, password, security string,
    dhcpEnable bool,
    ipv4Address, ipv4Gateway string,
    ipv4Dns []string,
) (bool, error)

Parameters

Name	Type	Notes
ifname	string
ssid	string
password	string
security	string	"none" \| "wpa2" \| "wpa3" \| "wpa2-wpa3"
dhcpEnable	bool
ipv4Address	string	CIDR — ignored when dhcpEnable is true
ipv4Gateway	string
ipv4Dns	[]string

Returns

Name	Type	Notes
ok	bool
error	error

Example

ok, err := client.WiFiManager.SetClientConfig(
    "wlan0", "MySSID", "pass", "wpa2",
    true, "", "", nil,
)

GetClientProperties Returns IP and radio properties for the current client connection.

Signature

func (w *WiFiManager) GetClientProperties(ifname string) (*ClientProperties, error)

Parameters

Name	Type	Notes
ifname	string

Returns

Name	Type	Notes
*ClientProperties
error	error

Example

props, err := client.WiFiManager.GetClientProperties("wlan0")

Connect Brings up the Wi-Fi connection using the previously stored client config.

Signature

func (w *WiFiManager) Connect(ifname string) (bool, error)

Parameters

Name	Type	Notes
ifname	string

Returns

Name	Type	Notes
ok	bool
error	error

Example

ok, err := client.WiFiManager.Connect("wlan0")

Disconnect Disconnects from the current Wi-Fi network.

Signature

func (w *WiFiManager) Disconnect(ifname string) (bool, error)

Parameters

Name	Type	Notes
ifname	string

Returns

Name	Type	Notes
ok	bool
error	error

Example

ok, err := client.WiFiManager.Disconnect("wlan0")

Access Point

StartAP Configures and starts an access point on the given interface.

Signature

func (w *WiFiManager) StartAP(ifname, ssid, password, band string, channel int32) (bool, error)

Parameters

Name	Type	Notes
ifname	string
ssid	string
password	string
band	string	"2.4GHz" or "5GHz"
channel	int32	0 = auto

Returns

Name	Type	Notes
ok	bool
error	error

Example

ok, err := client.WiFiManager.StartAP("wlan0", "MyAP", "pass", "5GHz", 0)

StopAP Stops the access point on the given interface.

Signature

func (w *WiFiManager) StopAP(ifname string) (bool, error)

Parameters

Name	Type	Notes
ifname	string

Returns

Name	Type	Notes
ok	bool
error	error

Example

ok, err := client.WiFiManager.StopAP("wlan0")

GetAPProperties Returns properties of the active access point.

Signature

func (w *WiFiManager) GetAPProperties(ifname string) (*APProperties, error)

Parameters

Name	Type	Notes
ifname	string

Returns

Name	Type	Notes
*APProperties
error	error

Example

props, err := client.WiFiManager.GetAPProperties("wlan0")

Scan

Scan Scans for nearby Wi-Fi networks. forceRescan=true triggers a new hardware scan (~3 s).

Signature

func (w *WiFiManager) Scan(ifname string, forceRescan bool) ([]*ScannedNetwork, error)

Parameters

Name	Type	Notes
ifname	string
forceRescan	bool

Returns

Name	Type	Notes
[]*ScannedNetwork
error	error

Example

nets, err := client.WiFiManager.Scan("wlan0", true)

GPIO Manager

General-purpose I/O pin control.

PermissionGpioService/*

ListPins Returns all GPIO pins available on the device.

Signature

func (m *GpioManager) ListPins() ([]*GpioPin, error)

Returns

Name	Type	Notes
[]GpioPin
error	error

Example

pins, err := client.GpioManager.ListPins()

GetDirection Reads the current direction of a pin.

Signature

func (m *GpioManager) GetDirection(pin *GpioPin) (GpioDirection, error)

Parameters

Name	Type	Notes
pin	*GpioPin

Returns

Name	Type	Notes
dir	GpioDirection
error	error

Example

dir, err := client.GpioManager.GetDirection(pin)

SetDirection Configures a pin as input or output.

Signature

func (m *GpioManager) SetDirection(pin *GpioPin, dir GpioDirection) error

Parameters

Name	Type	Notes
pin	*GpioPin
dir	GpioDirection	GPIO_DIR_IN \| GPIO_DIR_OUT

Returns

Name	Type	Notes
error	error

Example

err := client.GpioManager.SetDirection(pin, GPIO_DIR_OUT)

GetLevel Reads the current logic level of a pin.

Signature

func (m *GpioManager) GetLevel(pin *GpioPin) (GpioLevel, error)

Parameters

Name	Type	Notes
pin	*GpioPin

Returns

Name	Type	Notes
level	GpioLevel
error	error

Example

level, err := client.GpioManager.GetLevel(pin)

SetLevel Sets the logic level of an output pin.

Signature

func (m *GpioManager) SetLevel(pin *GpioPin, level GpioLevel) error

Parameters

Name	Type	Notes
pin	*GpioPin
level	GpioLevel	GPIO_LEVEL_LOW \| GPIO_LEVEL_HIGH

Returns

Name	Type	Notes
error	error

Example

err := client.GpioManager.SetLevel(pin, GPIO_LEVEL_HIGH)

PWM Manager

PWM channel configuration and control.

PermissionPwmService/*

ListChannels Returns all available PWM channels.

Signature

func (m *PwmManager) ListChannels() ([]*PwmChannel, error)

Returns

Name	Type	Notes
[]PwmChannel		{ Channel, Name }
error	error

Example

channels, err := client.PwmManager.ListChannels()

GetProperties Reads the current configuration of a PWM channel.

Signature

func (m *PwmManager) GetProperties(ch *PwmChannel) (*PwmProperties, error)

Parameters

Name	Type	Notes
ch	*PwmChannel

Returns

Name	Type	Notes
props	*PwmProperties	{ Channel, Enabled, DutyCycle, FrequencyHz }
error	error

Example

props, err := client.PwmManager.GetProperties(ch)

SetPwm Configures and starts a PWM output on the given channel.

Signature

func (m *PwmManager) SetPwm(ch *PwmChannel, dutyCycle, frequencyHz float64) error

Parameters

Name	Type	Notes
ch	*PwmChannel
dutyCycle	float64	0.0–1.0
frequencyHz	float64

Returns

Name	Type	Notes
error	error

Example

err := client.PwmManager.SetPwm(ch, 0.5, 1000.0)

StopPwm Disables PWM output on the given channel.

Signature

func (m *PwmManager) StopPwm(ch *PwmChannel) error

Parameters

Name	Type	Notes
ch	*PwmChannel

Returns

Name	Type	Notes
error	error

Example

err := client.PwmManager.StopPwm(ch)

UART Manager

Serial port (UART) communication. Open returns a UartPort handle — all port operations are called on the handle.

PermissionUartService/*

UartManager

ListPorts Returns the names of all available UART ports.

Signature

func (m *UartManager) ListPorts() ([]string, error)

Returns

Name	Type	Notes
[]string
error	error

Example

ports, err := client.UartManager.ListPorts()

Open Opens and configures a UART port. Returns a UartPort handle for all subsequent operations.

Signature

func (m *UartManager) Open(cfg UartConfig) (*UartPort, error)

Parameters

Name	Type	Notes
cfg	UartConfig

Returns

Name	Type	Notes
*UartPort
error	error

Example

port, err := client.UartManager.Open(UartConfig{
    Port:     "ttyS0",
    Baudrate: 115200,
    DataBits: 8,
    Parity:   UartParityNone,
    StopBits: UartStopBits1,
})

UartPort

Close Closes the port.

Signature

func (p *UartPort) Close() error

Returns

Name	Type	Notes
error	error

Example

err := port.Close()

GetConfig Returns the current configuration of the port.

Signature

func (p *UartPort) GetConfig() (*UartConfig, error)

Returns

Name	Type	Notes
*UartConfig
error	error

Example

cfg, err := port.GetConfig()

Write Writes raw bytes to the port. Returns the number of bytes written.

Signature

func (p *UartPort) Write(data []byte) (int, error)

Parameters

Name	Type	Notes
data	[]byte

Returns

Name	Type	Notes
bytesWritten	int
error	error

Example

n, err := port.Write([]byte("hello"))

Listen Streams incoming bytes, calling onChunk for each chunk. Blocks until ctx is cancelled or the stream ends.

Signature

func (p *UartPort) Listen(ctx context.Context, maxChunkSize int, onChunk func([]byte)) error

Parameters

Name	Type	Notes
ctx	Context
maxChunkSize	int
onChunk	func([]byte)

Returns

Name	Type	Notes
error	error

Example

err := port.Listen(ctx, 256, func(b []byte) {
    fmt.Printf("rx: %q
", b)
})

ListenAsync Like Listen but returns a channel instead of a callback. Channel is closed when the stream ends or ctx is cancelled.

Signature

func (p *UartPort) ListenAsync(ctx context.Context, maxChunkSize int) (<-chan []byte, error)

Parameters

Name	Type	Notes
ctx	Context
maxChunkSize	int

Returns

Name	Type	Notes
<-chan []byte
error	error

Example

ch, err := port.ListenAsync(ctx, 256)
for b := range ch {
    fmt.Printf("rx: %q
", b)
}

I2C Manager

I²C bus discovery and data transfer.

PermissionI2cService/*

I2CManager

ListBuses Returns the indices of all available I²C buses.

Signature

func (m *I2CManager) ListBuses() ([]uint32, error)

Returns

Name	Type	Notes
[]uint32
error	error

Example

buses, err := client.I2CManager.ListBuses()

Open Configures the bus and returns a handle for all subsequent operations.

Signature

func (m *I2CManager) Open(bus uint32, clockHz uint32, tenBitAddr bool, clockStretching bool) (*I2CBus, error)

Parameters

Name	Type	Notes
bus	uint32
clockHz	uint32
tenBitAddr	bool
clockStretching	bool

Returns

Name	Type	Notes
*I2CBus	I2CBus
error	error

Example

b, err := client.I2CManager.Open(1, 400000, false, false)

I2CBus

Scan Probes all 7-bit addresses (0x03–0x77) and returns those that respond.

Signature

func (b *I2CBus) Scan() ([]uint32, error)

Returns

Name	Type	Notes
[]uint32		responding addresses
error	error

Example

addrs, err := b.Scan()

GetConfig Returns the current configuration of the bus.

Signature

func (b *I2CBus) GetConfig() (I2CConfig, error)

Returns

Name	Type	Notes
cfg	I2CConfig
error	error

Example

cfg, err := b.GetConfig()

Transfer Performs a write, read, or write-then-read transaction. Pass nil data for read-only; 0 readLen for write-only.

Signature

func (b *I2CBus) Transfer(addr uint32, data []byte, readLen uint32, flags uint32) ([]byte, error)

Parameters

Name	Type	Notes
addr	uint32	7-bit device address (e.g. 0x48)
data	[]byte	bytes to write (nil for read-only)
readLen	uint32	bytes to read back (0 for write-only)
flags	uint32	i2c_msg flags (0 for most uses)

Returns

Name	Type	Notes
[]byte		received bytes (nil for write-only)
error	error

Example

data, err := b.Transfer(0x48, []byte{0x00}, 2, 0)

SPI Manager

SPI bus configuration and full-duplex transfer.

PermissionSpiService/*

SpiManager

ListDevices Returns available SPI device names (e.g. "spidev0.0").

Signature

func (m *SpiManager) ListDevices() ([]string, error)

Returns

Name	Type	Notes
[]string
error	error

Example

devices, err := client.SpiManager.ListDevices()

Open Configures the SPI device at (bus, cs) and returns a handle for all subsequent operations.

Signature

func (m *SpiManager) Open(bus, cs uint32, maxSpeedHz, bitsPerWord uint32, mode int, lsbFirst bool) (*SpiDevice, error)

Parameters

Name	Type	Notes
bus	uint32
cs	uint32	Chip select index
maxSpeedHz	uint32
bitsPerWord	uint32
mode	int	0–3 (CPOL/CPHA)
lsbFirst	bool

Returns

Name	Type	Notes
*SpiDevice	SpiDevice
error	error

Example

dev, err := client.SpiManager.Open(0, 0, 1000000, 8, 0, false)

SpiDevice

GetConfig Returns the current configuration of the device.

Signature

func (d *SpiDevice) GetConfig() (*SpiConfig, error)

Returns

Name	Type	Notes
*SpiConfig	SpiConfig
error	error

Example

cfg, err := dev.GetConfig()

Transfer Performs a full-duplex SPI transfer. Pass readLength=0 for write-only; when smaller than len(dataOut), the last readLength bytes are returned.

Signature

func (d *SpiDevice) Transfer(dataOut []byte, readLength uint32) ([]byte, error)

Parameters

Name	Type	Notes
dataOut	[]byte
readLength	uint32	0 = write-only

Returns

Name	Type	Notes
[]byte		received MISO bytes
error	error

Example

rx, err := dev.Transfer(txData, uint32(len(txData)))

Camera Manager

V4L2 camera capture and streaming.

PermissionCameraService/*

ListDevices Returns all V4L2 video devices available on the system.

Signature

func (m *CameraManager) ListDevices(ctx context.Context) ([]*CameraDeviceInfo, error)

Parameters

Name	Type	Notes
ctx	Context

Returns

Name	Type	Notes
[]*CameraDeviceInfo
error	error

Example

devices, err := client.CameraManager.ListDevices(ctx)

GetDeviceInfo Returns metadata (driver, card, formats, resolutions) for a specific camera device.

Signature

func (m *CameraManager) GetDeviceInfo(ctx context.Context, deviceID string) (*CameraDeviceInfo, error)

Parameters

Name	Type	Notes
ctx	Context
deviceID	string	e.g. "/dev/video0"

Returns

Name	Type	Notes
*CameraDeviceInfo
error	error

Example

info, err := client.CameraManager.GetDeviceInfo(ctx, "/dev/video0")

LockCamera Acquires an exclusive lock on a camera for a given client ID. Must be called before CaptureImage or StreamFrames.

Signature

func (m *CameraManager) LockCamera(ctx context.Context, deviceID, clientID string) error

Parameters

Name	Type	Notes
ctx	Context
deviceID	string
clientID	string

Returns

Name	Type	Notes
error	error

Example

err := client.CameraManager.LockCamera(ctx, "/dev/video0", "myapp")

UnlockCamera Releases the lock obtained with LockCamera.

Signature

func (m *CameraManager) UnlockCamera(ctx context.Context, deviceID, clientID string) error

Parameters

Name	Type	Notes
ctx	Context
deviceID	string
clientID	string

Returns

Name	Type	Notes
error	error

Example

err := client.CameraManager.UnlockCamera(ctx, "/dev/video0", "myapp")

CaptureImage Captures a single frame from a camera device. Requires LockCamera first.

Signature

func (m *CameraManager) CaptureImage(ctx context.Context, deviceID string, width, height int32, format string) (*CaptureImageResult, error)

Parameters

Name	Type	Notes
ctx	Context
deviceID	string
width	int32
height	int32
format	string	"mjpeg" or "yuyv"

Returns

Name	Type	Notes
*CaptureImageResult
error	error

Example

img, err := client.CameraManager.CaptureImage(ctx, "/dev/video0", 1280, 720, "mjpeg")

StreamFrames Opens a server-streaming frame stream at the requested FPS and resolution. Read from the stream until io.EOF or error.

Signature

func (m *CameraManager) StreamFrames(ctx context.Context, req *StreamFramesRequest) (ServerStream[Frame], error)

Parameters

Name	Type	Notes
ctx	Context
req	*StreamFramesRequest

Returns

Name	Type	Notes
ServerStream[Frame]
error	error

Example

stream, err := client.CameraManager.StreamFrames(ctx, &StreamFramesRequest{
    DeviceId: "/dev/video0", Fps: 30, Width: 1280, Height: 720,
})
for {
    frame, err := stream.Recv()
    if err == io.EOF { break }
}

AI Manager

On-device AI model management and inference. LoadModel / UploadAndLoadModel return an AIModel handle — inference and lifecycle operations are called on the handle.

PermissionAiService/*

AIManager

ListModels Returns metadata for all currently loaded models.

Signature

func (m *AIManager) ListModels() ([]*ModelInfo, error)

Returns

Name	Type	Notes
[]*ModelInfo
error	error

Example

models, err := client.AIManager.ListModels()

LoadModel Loads a model already present on the device filesystem. Returns an AIModel handle.

Signature

func (m *AIManager) LoadModel(modelID, modelPath string, backend ModelBackend, execution ExecutionMode) (*AIModel, error)

Parameters

Name	Type	Notes
modelID	string
modelPath	string	Absolute path on the device
backend	ModelBackend
execution	ExecutionMode

Returns

Name	Type	Notes
*AIModel
error	error

Example

model, err := client.AIManager.LoadModel(
    "detector", "/models/yolo.onnx",
    ModelBackend_ONNX, ExecutionMode_EXEC_CPU,
)

UploadAndLoadModel Streams a local model file to the device in chunks then loads it. Returns an AIModel handle.

Signature

func (m *AIManager) UploadAndLoadModel(modelID, localPath string, backend ModelBackend, execution ExecutionMode) (*AIModel, error)

Parameters

Name	Type	Notes
modelID	string
localPath	string	Path to the model file on the host
backend	ModelBackend
execution	ExecutionMode

Returns

Name	Type	Notes
*AIModel
error	error

Example

model, err := client.AIManager.UploadAndLoadModel(
    "detector", "./yolo.onnx",
    ModelBackend_ONNX, ExecutionMode_EXEC_CPU,
)

AIModel

Unload Frees the model from the inference backend.

Signature

func (m *AIModel) Unload() error

Returns

Name	Type	Notes
error	error

Example

err := model.Unload()

IsLoaded Returns whether the model is loaded and its tensor schema.

Signature

func (m *AIModel) IsLoaded() (*IsModelLoadedResponse, error)

Returns

Name	Type	Notes
*IsModelLoadedResponse
error	error

Example

r, err := model.IsLoaded()

Infer Runs a single synchronous forward pass. inputShape nil uses the schema from load.

Signature

func (m *AIModel) Infer(ctx context.Context, inputData []byte, inputShape []int32, dtype TensorDataType) (*InferResponse, error)

Parameters

Name	Type	Notes
ctx	Context
inputData	[]byte	Raw little-endian bytes
inputShape	[]int32	nil = use schema from LoadModel
dtype	TensorDataType

Returns

Name	Type	Notes
*InferResponse
error	error

Example

resp, err := model.Infer(ctx, inputData, []int32{1, 3, 640, 640}, TensorDataType_TENSOR_FLOAT32)

StreamInfer Opens a bidirectional inference stream. Returns an AIInferStream handle.

Signature

func (m *AIModel) StreamInfer(ctx context.Context) (*AIInferStream, error)

Parameters

Name	Type	Notes
ctx	Context

Returns

Name	Type	Notes
*AIInferStream
error	error

Example

s, err := model.StreamInfer(ctx)

AIInferStream

Send Submits an inference request on the stream.

Signature

func (s *AIInferStream) Send(inputData []byte, inputShape []int32, dtype TensorDataType) error

Parameters

Name	Type	Notes
inputData	[]byte
inputShape	[]int32
dtype	TensorDataType

Returns

Name	Type	Notes
error	error

Example

err := s.Send(inputData, nil, TensorDataType_TENSOR_FLOAT32)

Recv Reads the next inference result. Returns io.EOF when the server closes the stream.

Signature

func (s *AIInferStream) Recv() (*InferResponse, error)

Returns

Name	Type	Notes
*InferResponse
error	error

Example

resp, err := s.Recv()

Close Signals the end of the send side of the stream.

Signature

func (s *AIInferStream) Close() error

Returns

Name	Type	Notes
error	error

Example

err := s.Close()

Firewall Manager

Network firewall zone and rule management.

PermissionFirewallService/*

Zones

ListZones Returns all configured firewall zones.

Signature

func (f *FirewallManager) ListZones() ([]*ZoneRequest, error)

Returns

Name	Type	Notes
[]*ZoneRequest
error	error

Example

zones, err := client.FirewallManager.ListZones()

AddZone Creates a new firewall zone.

Signature

func (f *FirewallManager) AddZone(name string, interfaces []string, inputPolicy, outputPolicy ZonePolicy, masquerade bool) (bool, error)

Parameters

Name	Type	Notes
name	string
interfaces	[]string
inputPolicy	ZonePolicy
outputPolicy	ZonePolicy
masquerade	bool

Returns

Name	Type	Notes
ok	bool
error	error

Example

ok, err := client.FirewallManager.AddZone("lan", []string{"eth0"}, ZonePolicy_ACCEPT, ZonePolicy_ACCEPT, false)

RemoveZone Deletes a firewall zone by name.

Signature

func (f *FirewallManager) RemoveZone(name string) (bool, error)

Parameters

Name	Type	Notes
name	string

Returns

Name	Type	Notes
ok	bool
error	error

Example

ok, err := client.FirewallManager.RemoveZone("lan")

Rules

ListRules Returns all configured firewall rules.

Signature

func (f *FirewallManager) ListRules() ([]*FirewallRule, error)

Returns

Name	Type	Notes
[]*FirewallRule
error	error

Example

rules, err := client.FirewallManager.ListRules()

AddRule Adds a traffic rule between two zones.

Signature

func (f *FirewallManager) AddRule(srcZone, dstZone string, protocol FirewallProtocol, srcIP string, destPort int32, action ZonePolicy, comment string) (bool, error)

Parameters

Name	Type	Notes
srcZone	string
dstZone	string
protocol	FirewallProtocol	PROTO_ANY \| PROTO_TCP \| PROTO_UDP \| PROTO_ICMP
srcIP	string	CIDR or empty for any
destPort	int32	0 for any
action	ZonePolicy
comment	string

Returns

Name	Type	Notes
ok	bool
error	error

Example

ok, err := client.FirewallManager.AddRule("lan", "wan", FirewallProtocol_TCP, "", 443, ZonePolicy_ACCEPT, "allow HTTPS")

RemoveRule Removes a traffic rule by its ID.

Signature

func (f *FirewallManager) RemoveRule(id string) (bool, error)

Parameters

Name	Type	Notes
id	string

Returns

Name	Type	Notes
ok	bool
error	error

Example

ok, err := client.FirewallManager.RemoveRule(ruleID)

FlushRules Removes all traffic rules (zones are preserved).

Signature

func (f *FirewallManager) FlushRules() (bool, error)

Returns

Name	Type	Notes
ok	bool
error	error

Example

ok, err := client.FirewallManager.FlushRules()

ApplyFirewall Commits all pending zone and rule changes to the active firewall.

Signature

func (f *FirewallManager) ApplyFirewall() (bool, error)

Returns

Name	Type	Notes
ok	bool
error	error

Example

ok, err := client.FirewallManager.ApplyFirewall()

VPN Manager

VPN profile management and connection control.

PermissionVpnService/*

Capabilities

GetCapabilities Reports which VPN providers are available on the device.

Signature

func (v *VPNManager) GetCapabilities() (*VpnCapabilities, error)

Returns

Name	Type	Notes
*VpnCapabilities
error	error

Example

caps, err := client.VPNManager.GetCapabilities()

Profiles

ListProfiles Returns all saved VPN profiles (config data not included).

Signature

func (v *VPNManager) ListProfiles() ([]*VpnProfile, error)

Returns

Name	Type	Notes
[]*VpnProfile
error	error

Example

profiles, err := client.VPNManager.ListProfiles()

ApplyProfile Creates or updates a VPN profile. If ProfileId is empty the server assigns one.

Signature

func (v *VPNManager) ApplyProfile(profile *VpnProfile, connectAfterApply bool) (string, error)

Parameters

Name	Type	Notes
profile	*VpnProfile
connectAfterApply	bool

Returns

Name	Type	Notes
profileID	string
error	error

Example

id, err := client.VPNManager.ApplyProfile(profile, false)

ApplyWireGuard Convenience wrapper — creates or updates a WireGuard profile from a raw .conf file.

Signature

func (v *VPNManager) ApplyWireGuard(displayName string, configData []byte, autoConnect bool) (string, error)

Parameters

Name	Type	Notes
displayName	string
configData	[]byte	Raw WireGuard .conf content
autoConnect	bool

Returns

Name	Type	Notes
profileID	string
error	error

Example

id, err := client.VPNManager.ApplyWireGuard("office", confBytes, true)

ApplyOpenVPN Convenience wrapper — creates or updates an OpenVPN profile from a raw .ovpn file.

Signature

func (v *VPNManager) ApplyOpenVPN(displayName string, configData []byte, autoConnect bool) (string, error)

Parameters

Name	Type	Notes
displayName	string
configData	[]byte	Raw .ovpn file content
autoConnect	bool

Returns

Name	Type	Notes
profileID	string
error	error

Example

id, err := client.VPNManager.ApplyOpenVPN("corp", ovpnBytes, false)

RemoveProfile Deletes a VPN profile by ID (disconnects first if active).

Signature

func (v *VPNManager) RemoveProfile(profileID string) (bool, error)

Parameters

Name	Type	Notes
profileID	string

Returns

Name	Type	Notes
ok	bool
error	error

Example

ok, err := client.VPNManager.RemoveProfile(profileID)

Connection

Connect Activates a VPN profile and returns the session ID. The tunnel comes up asynchronously — use WatchEvents or GetStatus to track.

Signature

func (v *VPNManager) Connect(profileID string) (string, error)

Parameters

Name	Type	Notes
profileID	string

Returns

Name	Type	Notes
sessionID	string
error	error

Example

sessionID, err := client.VPNManager.Connect(profileID)

Disconnect Tears down the active tunnel for the given profile. Pass empty string to disconnect the currently active profile.

Signature

func (v *VPNManager) Disconnect(profileID string) (bool, error)

Parameters

Name	Type	Notes
profileID	string

Returns

Name	Type	Notes
ok	bool
error	error

Example

ok, err := client.VPNManager.Disconnect(profileID)

Status

GetStatus Returns the current active session and provider details. Session is nil when no tunnel is active.

Signature

func (v *VPNManager) GetStatus() (*Session, string, error)

Returns

Name	Type	Notes
*Session
providerDetails	string
error	error

Example

sess, details, err := client.VPNManager.GetStatus()

ListSessions Returns all active sessions (at most one in the current implementation).

Signature

func (v *VPNManager) ListSessions() ([]*Session, error)

Returns

Name	Type	Notes
[]*Session
error	error

Example

sessions, err := client.VPNManager.ListSessions()

IsConnected Reports whether there is an active tunnel in state UP.

Signature

func (v *VPNManager) IsConnected() (bool, error)

Returns

Name	Type	Notes
bool
error	error

Example

connected, err := client.VPNManager.IsConnected()

WatchEvents Streams VPN tunnel events. Blocks until ctx is cancelled or the server closes the connection. Pass empty profileID to receive events from all profiles.

Signature

func (v *VPNManager) WatchEvents(ctx context.Context, profileID string, handler func(*VPNEvent)) error

Parameters

Name	Type	Notes
ctx	Context
profileID	string	empty = all profiles
handler	func(*VPNEvent)

Returns

Name	Type	Notes
error	error

Example

err := client.VPNManager.WatchEvents(ctx, "", func(e *VPNEvent) {
    fmt.Println(e.GetState())
})

App Hub Manager

Service registration and HTTP routing via the Orbit app hub.

PermissionAppHubService/*

Registration

RegisterWebUI Convenience wrapper — registers a local HTTP server with a TCP health-check. Prefer this for the common case.

Signature

func (m *AppHubManager) RegisterWebUI(addr, route string) error

Parameters

Name	Type	Notes
addr	string	"host:port" or ":port"
route	string	Path prefix to proxy, e.g. "/myapp"

Returns

Name	Type	Notes
error	error

Example

err := client.AppHubManager.RegisterWebUI("127.0.0.1:9033", "/myapp")

RegisterService Announces the app's HTTP server to the portal with full control over routes and health check.

Signature

func (m *AppHubManager) RegisterService(req *RegisterServiceRequest) error

Parameters

Name	Type	Notes
req	*RegisterServiceRequest

Returns

Name	Type	Notes
error	error

Example

err := client.AppHubManager.RegisterService(req)

UnregisterService Removes the app's registration from the portal. Safe to call on shutdown.

Signature

func (m *AppHubManager) UnregisterService() error

Returns

Name	Type	Notes
error	error

Example

err := client.AppHubManager.UnregisterService()

Discovery

GetService Returns registration details for a given service ID.

Signature

func (m *AppHubManager) GetService(serviceID string) (*Service, error)

Parameters

Name	Type	Notes
serviceID	string

Returns

Name	Type	Notes
*Service
error	error

Example

svc, err := client.AppHubManager.GetService("my-service-id")

ListServices Returns all services currently registered in the portal.

Signature

func (m *AppHubManager) ListServices() ([]*Service, error)

Returns

Name	Type	Notes
[]*Service
error	error

Example

services, err := client.AppHubManager.ListServices()

Routes

AddRoute Adds an extra path prefix to the already-registered service.

Signature

func (m *AppHubManager) AddRoute(path string) error

Parameters

Name	Type	Notes
path	string

Returns

Name	Type	Notes
error	error

Example

err := client.AppHubManager.AddRoute("/api/v2")

RemoveRoute Removes a path prefix from the registered service.

Signature

func (m *AppHubManager) RemoveRoute(path string) error

Parameters

Name	Type	Notes
path	string

Returns

Name	Type	Notes
error	error

Example

err := client.AppHubManager.RemoveRoute("/api/v1")

GetRoutingTable Returns all current proxy routing entries.

Signature

func (m *AppHubManager) GetRoutingTable() ([]*RoutingEntry, error)

Returns

Name	Type	Notes
[]*RoutingEntry
error	error

Example

entries, err := client.AppHubManager.GetRoutingTable()

Events

WatchServices Streams service lifecycle events. Blocks until ctx is cancelled or the server closes.

Signature

func (m *AppHubManager) WatchServices(ctx context.Context, handler func(*ServiceEvent)) error

Parameters

Name	Type	Notes
ctx	Context
handler	func(*ServiceEvent)

Returns

Name	Type	Notes
error	error

Example

err := client.AppHubManager.WatchServices(ctx, func(e *ServiceEvent) {
    fmt.Println(e.GetType(), e.GetService().GetServiceId())
})

Event Manager

System-wide event bus.

PermissionEventService/*

Subscribe Subscribes to system events. Calls handler for each event. Blocks until context is cancelled.

Signature

func (e *EventManager) Subscribe(ctx context.Context, handler func(*Event), types ...EventType) error

Parameters

Name	Type	Notes
ctx	Context
handler	func(*Event)
types	...EventType	Omit to receive all events (EVENT_APP_INSTALLED, EVENT_APP_REMOVED, EVENT_APP_STARTED, etc.)

Returns

Name	Type	Notes
error	error

Example

err := client.EventManager.Subscribe(ctx, func(e *Event) {
    fmt.Println(e.Type, e.Payload)
}, client.EVENT_APP_STARTED)

Development Manager

Live log streaming from running applications.

PermissionDevelopmentService/*

SubscribeLogs Streams log entries matching the given filter. Blocks until context is cancelled.

Signature

func (d *DevelopmentManager) SubscribeLogs(ctx context.Context, app string, tag string, level LogLevel, onEntry func(LogEntry)) error

Parameters

Name	Type	Notes
ctx	Context
app	string	app name filter (empty = all)
tag	string	tag filter (empty = all)
level	LogLevel	minimum log level (LOG_LEVEL_DEBUG, LOG_LEVEL_INFO, LOG_LEVEL_WARNING, LOG_LEVEL_ERROR, LOG_LEVEL_FATAL)
onEntry	func(LogEntry)

Returns

Name	Type	Notes
error	error

Example

err := client.DevelopmentManager.SubscribeLogs(ctx, "myapp", "", client.LOG_LEVEL_INFO, func(e LogEntry) {
    fmt.Println(e.Timestamp, e.Message)
})

SubscribeLogsAsync Starts SubscribeLogs in a goroutine with automatic reconnection. Returns a channel.

Signature

func (d *DevelopmentManager) SubscribeLogsAsync(ctx context.Context, app string, tag string, level LogLevel) <-chan LogEntry

Parameters

Name	Type	Notes
ctx	Context
app	string	app name filter (empty = all)
tag	string	tag filter (empty = all)
level	LogLevel	minimum log level (LOG_LEVEL_DEBUG, LOG_LEVEL_INFO, LOG_LEVEL_WARNING, LOG_LEVEL_ERROR, LOG_LEVEL_FATAL)

Returns

Name	Type	Notes
<-chan LogEntry	chan
error	error

Example

ch := client.DevelopmentManager.SubscribeLogsAsync(ctx, "myapp", "", client.LOG_LEVEL_INFO)

Update Manager

OTA firmware update and factory reset.

PermissionUpdateService/*

Update Sends a .orbit system image to the device to perform an OS update.

Signature

func (u *UpdateManager) Update(ctx context.Context, orbitPath string) error

Parameters

Name	Type	Notes
ctx	Context
orbitPath	string

Returns

Name	Type	Notes
error	error

Example

err := client.UpdateManager.Update(ctx, "/path/to/update.orbit")

FactoryReset Performs a factory reset, erasing all user data.

Signature

func (u *UpdateManager) FactoryReset() (bool, error)

Returns

Name	Type	Notes
ok	bool
error	error

Example

ok, err := client.UpdateManager.FactoryReset()

Power Manager

Device power control.

PermissionPowerService/*

Reboot Reboots the device.

Signature

func (p *PowerManager) Reboot(force bool, reason string) (*PowerResult, error)

Parameters

Name	Type	Notes
force	bool
reason	string

Returns

Name	Type	Notes
*PowerResult		{ Success, Message }
error	error

Example

res, err := client.PowerManager.Reboot(false, "update")

Shutdown Shuts down the device.

Signature

func (p *PowerManager) Shutdown(force bool, reason string) (*PowerResult, error)

Parameters

Name	Type	Notes
force	bool
reason	string

Returns

Name	Type	Notes
*PowerResult		{ Success, Message }
error	error

Example

res, err := client.PowerManager.Shutdown(false, "maintenance")

Types

Complex objects returned or accepted by the SDK methods.

GpioPin Identifies a GPIO line by chip index and line offset.

Fields

Field	Type	Description
Name	string	Human-readable pin name (e.g. "GPIO17", "PWM0_OUT")
Number	int32	Line offset within the chip
ChipNumber	int32	Chip index (0 = /dev/gpiochip0)

GpioDirection GPIO pin direction enum.

Fields

Field	Type	Description
GPIO_DIR_OUT	0	Output
GPIO_DIR_IN	1	Input

GpioLevel GPIO pin logic level enum.

Fields

Field	Type	Description
GPIO_LEVEL_LOW	0
GPIO_LEVEL_HIGH	1

UartConfig Configuration used to open a UART port.

Fields

Field	Type	Description
Port	string	Port name (e.g. "ttyS0", "ttyAMA0")
Baudrate	int	Baud rate (e.g. 9600, 115200)
DataBits	int	5, 6, 7 or 8
Parity	UartParity	None / Even / Odd
StopBits	UartStopBits	1 or 2 stop bits
FlowControl	UartFlowControl	None / Hardware (RTS/CTS) / Software (XON/XOFF)

UartParity Parity mode for a UART port.

Fields

Field	Type	Description
UartParityNone	0	No parity
UartParityEven	1	Even parity
UartParityOdd	2	Odd parity

UartStopBits Number of stop bits for a UART port.

Fields

Field	Type	Description
UartStopBits1	0	1 stop bit
UartStopBits2	1	2 stop bits

UartFlowControl Flow control mode for a UART port.

Fields

Field	Type	Description
UartFlowNone	0	No flow control
UartFlowHardware	1	Hardware flow control (RTS/CTS)
UartFlowSoftware	2	Software flow control (XON/XOFF)

I2CConfig I²C bus configuration as returned by I2CBus.GetConfig().

Fields

Field	Type	Description
Bus	uint32
ClockHz	uint32
TenBitAddr	bool
ClockStretching	bool

I2CBus Handle to a specific I²C bus returned by I2CManager.Open().

Fields

Field	Type	Description
(bus number stored internally)

SpiConfig SPI device configuration as returned by SpiDevice.GetConfig().

Fields

Field	Type	Description
Bus	uint32
ChipSelect	uint32
MaxSpeedHz	uint32
BitsPerWord	uint32
Mode	int	0–3 (CPOL/CPHA)
LSBFirst	bool

SpiDevice Handle to a configured SPI device (bus + chip select) returned by SpiManager.Open().

Fields

Field	Type	Description
(bus + cs stored internally)

MetricsInfoResponse Response returned by SystemManager.GetMetrics.

Fields

Field	Type	Description
Metrics	*MetricsInfo	System metrics snapshot
Error	*ErrorInfo	Non-nil when the request failed

MetricsInfo Full snapshot of system metrics at the time of the call.

Fields

Field	Type	Description
SysUptime	*MetricsInfo_SysUptime	System uptime and load
CpuUsage	float64	Overall CPU usage (0–100 %)
CpuCorePercent	[]float64	Per-core CPU usage (0–100 %)
MemoryUsage	float64	Memory usage percentage
SocThermal	float64	SoC temperature (°C)
CpuStats	*MetricsInfo_CpuStats	CPU context-switch and interrupt counters
CpuFreq	*MetricsInfo_CpuFreq	CPU frequency info (MHz)
VirtualMemory	*MetricsInfo_VirtualMemory	Detailed memory breakdown
DiskUsage	map[string]*MetricsInfo_DiskUsage	Disk usage per mount point
DiskIoCounters	*MetricsInfo_DiskIoCounters	Disk I/O counters
Network	*MetricsInfo_Network	Network I/O counters
SensorsTemperatures	int32	Sensor temperature reading

MetricsInfo_SysUptime System uptime and load average.

Fields

Field	Type	Description
Time	string	Current system time string
Uptime	int64	Uptime in seconds
Users	int32	Number of logged-in users
LoadAverage	[]float64	1-min, 5-min, 15-min load averages

MetricsInfo_CpuStats CPU context-switch and interrupt counters since boot.

Fields

Field	Type	Description
CtxSwitches	int64	Total context switches
Interrupts	int64	Total hardware interrupts
SoftInterrupts	int64	Total software interrupts
Syscalls	int64	Total system calls

MetricsInfo_CpuFreq CPU frequency information in MHz.

Fields

Field	Type	Description
Current	float64	Current CPU frequency (MHz)
Min	float64	Minimum CPU frequency (MHz)
Max	float64	Maximum CPU frequency (MHz)

MetricsInfo_VirtualMemory Detailed virtual memory breakdown (all sizes in bytes).

Fields

Field	Type	Description
Total	int64	Total installed RAM (bytes)
Available	int64	Available memory (bytes)
Percent	float64	Usage percentage
Used	int64	Used memory (bytes)
Free	int64	Free memory (bytes)
Active	int64	Active memory (bytes)
Inactive	int64	Inactive memory (bytes)
Buffers	int64	Buffer cache (bytes)
Cached	int64	Page cache (bytes)
Shared	int64	Shared memory (bytes)
Slab	int64	Kernel slab cache (bytes)

MetricsInfo_DiskUsage Disk usage for a single mount point (all sizes in bytes).

Fields

Field	Type	Description
Total	int64	Total disk size (bytes)
Used	int64	Used space (bytes)
Free	int64	Free space (bytes)
Percent	float64	Usage percentage

MetricsInfo_DiskIoCounters Disk I/O counters since boot.

Fields

Field	Type	Description
ReadCount	int64	Number of reads
WriteCount	int64	Number of writes
ReadBytes	int64	Bytes read
WriteBytes	int64	Bytes written
ReadTime	int64	Time spent reading (ms)
WriteTime	int64	Time spent writing (ms)
ReadMergedCount	int64	Merged read operations
WriteMergedCount	int64	Merged write operations
BusyTime	int64	Time disk was busy (ms)

MetricsInfo_Network Aggregated network I/O counters across all interfaces.

Fields

Field	Type	Description
BytesSent	int64	Total bytes sent
BytesRecv	int64	Total bytes received
PacketsSent	int64	Total packets sent
PacketsRecv	int64	Total packets received
Errin	int64	Total input errors
Errout	int64	Total output errors
Dropin	int64	Total inbound packets dropped
Dropout	int64	Total outbound packets dropped

EthernetLinkProperties Link-layer and IP properties of an Ethernet interface.

Fields

Field	Type	Description
InterfaceName	string	Interface name (e.g. "eth0")
MacAddress	string	MAC address
State	EthernetState	Current link state
Mtu	int32	Maximum transmission unit
DhcpEnable	bool	True when DHCP is active
Ipv4Address	string	IPv4 address with prefix length (e.g. "192.168.1.10/24")
Ipv4Gateway	string	Default IPv4 gateway
Ipv4Dns	[]string	List of DNS server addresses

EthernetState Link state of an Ethernet interface.

Fields

Field	Type	Description
ETH_UNKNOWN	0	Unknown state
ETH_UNMANAGED	10	Device not managed by NetworkManager
ETH_UNAVAILABLE	20	Device present but not available
ETH_DISCONNECTED	30	Disconnected
ETH_PREPARE	40	Preparing connection
ETH_CONFIG	50	Configuring
ETH_NEED_AUTH	60	Authentication required
ETH_IP_CONFIG	70	Configuring IP
ETH_IP_CHECK	80	Verifying IP configuration
ETH_SECONDARIES	90	Configuring secondary connections
ETH_CONNECTED	100	Connected
ETH_DEACTIVATING	110	Deactivating
ETH_FAILED	120	Failed

WiFiLinkProperties Link-layer and mode properties of a Wi-Fi interface.

Fields

Field	Type	Description
InterfaceName	string	Interface name (e.g. "wlan0")
MacAddress	string	MAC address
Mode	WiFiMode	Current operating mode
State	WiFiState	Current connection state
Mtu	int32	Maximum transmission unit
ApProperties	*APProperties	Set when mode is AP
ClientProperties	*ClientProperties	Set when mode is Client

ClientProperties IP and radio properties of the current client (station) connection.

Fields

Field	Type	Description
InterfaceName	string	Interface name
MacAddress	string	MAC address
State	WiFiState	Connection state
Mtu	int32	MTU
Ssid	string	Connected network SSID
Bssid	string	Connected AP BSSID
Security	string	Security type (e.g. "wpa2")
SignalStrength	int32	RSSI in dBm
Channel	int32	Radio channel
Band	string	"2.4GHz" or "5GHz"
DhcpEnable	bool	True when DHCP is active
Ipv4Address	string	IPv4 address with prefix (CIDR)
Ipv4Gateway	string	Default IPv4 gateway
Ipv4Dns	[]string	DNS servers

APProperties Properties of the active access point.

Fields

Field	Type	Description
InterfaceName	string	Interface name
Ssid	string	AP SSID
Security	string	Security type (e.g. "wpa2")
Ipv4Address	string	AP IPv4 address
Channel	int32	Radio channel
Band	string	"2.4GHz" or "5GHz"
Hidden	bool	True if SSID is hidden
Active	bool	True if AP is currently active
ConnectedClients	int32	Number of connected clients

ScannedNetwork A Wi-Fi network found during a scan.

Fields

Field	Type	Description
Ssid	string	Network SSID
Bssid	string	AP BSSID (MAC)
Security	string	Security type (e.g. "wpa2")
SignalStrength	int32	RSSI in dBm
Channel	int32	Radio channel
Band	string	"2.4GHz" or "5GHz"
Hidden	bool	True if SSID is hidden

WiFiMode Operating mode of a Wi-Fi interface.

Fields

Field	Type	Description
WIFI_MODE_UNKNOWN	0	Unknown
WIFI_MODE_AP	1	Access Point only
WIFI_MODE_CLIENT	2	Client (station) only
WIFI_MODE_AP_CLIENT	3	AP + Client simultaneously
WIFI_MODE_DISABLED	4	Disabled

WiFiState Connection state of a Wi-Fi interface.

Fields

Field	Type	Description
WIFI_UNKNOWN	0	Unknown
WIFI_UNMANAGED	10	Not managed by NetworkManager
WIFI_UNAVAILABLE	20	Managed but not available (no carrier)
WIFI_DISCONNECTED	30	Disconnected
WIFI_PREPARE	40	Preparing connection
WIFI_CONFIG	50	Configuring
WIFI_NEED_AUTH	60	Authentication required
WIFI_IP_CONFIG	70	Configuring IP
WIFI_IP_CHECK	80	Verifying IP configuration
WIFI_SECONDARIES	90	Configuring secondary connections
WIFI_ACTIVATED	100	Connected
WIFI_DEACTIVATING	110	Deactivating
WIFI_FAILED	120	Failed

ModelBackend Inference backend / model format.

Fields

Field	Type	Description
MODEL_BACKEND_UNSPECIFIED	0	Unspecified
ONNX	1	ONNX Runtime
TFLITE	2	TensorFlow Lite

ExecutionMode Hardware execution target for inference.

Fields

Field	Type	Description
EXEC_CPU	0	CPU (single/multi core)
EXEC_GPU	1	GPU / NPU delegate
EXEC_HIGH_THREADS	2	CPU with maximum thread count

TensorDataType Element type of a tensor buffer.

Fields

Field	Type	Description
TENSOR_FLOAT32	0	4-byte little-endian IEEE 754, normalised [0, 1]
TENSOR_UINT8	1	1-byte unsigned integer [0, 255]
TENSOR_INT32	2	4-byte little-endian signed integer
TENSOR_INT64	3	8-byte little-endian signed integer

CameraDeviceInfo Metadata for a V4L2 camera node.

Fields

Field	Type	Description
DeviceID	string	Device path (e.g. "/dev/video0")
Driver	string	Kernel driver name
Card	string	Camera card / model name
SupportedFormats	[]string	Pixel formats (e.g. "mjpeg", "yuyv")
Resolutions	[]string	Supported resolutions (e.g. "1280x720")

CaptureImageResult A single captured frame returned by CaptureImage.

Fields

Field	Type	Description
ImageData	[]byte	Raw frame bytes (e.g. JPEG)
Format	string	Pixel format of the data
Timestamp	int64	Capture timestamp (Unix µs)

StreamFramesRequest Parameters for StreamFrames.

Fields

Field	Type	Description
DeviceId	string	Camera device path (e.g. "/dev/video0")
Fps	int32	Requested frames per second
Width	int32	Frame width in pixels
Height	int32	Frame height in pixels

Frame A single video frame received from StreamFrames.

Fields

Field	Type	Description
Data	[]byte	Raw frame bytes
Timestamp	int64	Capture timestamp (Unix µs)
Width	int32	Frame width in pixels
Height	int32	Frame height in pixels
Format	string	Pixel format

AIModel Handle to a loaded model. Returned by LoadModel / UploadAndLoadModel.

Fields

Field	Type	Description
Response	*LoadModelResponse	Tensor schema and metadata returned at load time

LoadModelResponse Response from LoadModel / UploadAndLoadModel.

Fields

Field	Type	Description
ModelId	string	Confirmed model ID
Success	bool	True on success
Error	ErrorInfo	Set on failure
Inputs	[]*TensorInfo	Input tensor schema
Outputs	[]*TensorInfo	Output tensor schema
SkippedUpload	bool	True if model was already loaded

ModelInfo Metadata for a loaded model (returned by ListModels).

Fields

Field	Type	Description
ModelId	string	Model identifier
Version	string	Model version string
Backend	ModelBackend	Active backend
LoadedAtUnix	int64	Unix timestamp of load

IsModelLoadedResponse Response from IsModelLoaded.

Fields

Field	Type	Description
Loaded	bool	True if the model is currently loaded
Inputs	[]*TensorInfo	Input tensor schema
Outputs	[]*TensorInfo	Output tensor schema

InferResponse Result of a single inference pass.

Fields

Field	Type	Description
Success	bool	True on success
Error	ErrorInfo	Set on failure
OutputData	[]byte	Raw output tensor bytes
OutputShape	[]int32	Output tensor shape
NamedOutputs	map[string][]byte	Named output tensors
LatencyUs	int64	Inference latency in microseconds

TensorInfo Schema of a single input or output tensor.

Fields

Field	Type	Description
Name	string	Tensor name
Dtype	TensorDataType	Element data type
Shape	[]int32	Tensor dimensions

LogLevel Log severity level enum used by DevelopmentManager.

Fields

Field	Type	Description
LOG_LEVEL_DEBUG	0
LOG_LEVEL_INFO	1
LOG_LEVEL_WARNING	2
LOG_LEVEL_ERROR	3
LOG_LEVEL_FATAL	4

PwmChannel Identifies a PWM channel.

Fields

Field	Type	Description
Channel	uint32	Channel index
Name	string	Human-readable name

PwmProperties Current state and configuration of a PWM channel.

Fields

Field	Type	Description
Channel	PwmChannel
Enabled	bool
DutyCycle	float64	0.0–1.0
FrequencyHz	float64

VpnProfile VPN profile configuration passed to ApplyProfile.

Fields

Field	Type	Description
ProfileId	string	Empty = server assigns
DisplayName	string
Provider	VpnProvider
ConfigData	[]byte	Raw .conf / .ovpn file content
AutoConnect	bool
SecretRef	string	Optional credential reference

RegisterServiceRequest Full registration payload passed to AppHubManager.RegisterService().

Fields

Field	Type	Description
Host	string
Port	int32
Routes	[]*Route	Path prefixes to proxy
Health	*HealthCheck	Health check configuration
ExposureMode	string	Visibility scope

FirewallProtocol Protocol filter enum used in firewall rules.

Fields

Field	Type	Description
PROTO_ANY	0
PROTO_TCP	1
PROTO_UDP	2
PROTO_ICMP	3

ZonePolicy Default zone policy or rule action enum.

Fields

Field	Type	Description
POLICY_ACCEPT	0
POLICY_DROP	1
POLICY_REJECT	2

ZoneRequest Firewall zone definition (as returned by ListZones).

Fields

Field	Type	Description
Name	string	Zone name (e.g. "lan", "wan")
Interfaces	[]string	Network interfaces assigned to this zone
InputPolicy	ZonePolicy	POLICY_ACCEPT \| POLICY_DROP \| POLICY_REJECT
OutputPolicy	ZonePolicy	POLICY_ACCEPT \| POLICY_DROP \| POLICY_REJECT
Masquerade	bool	Enable NAT masquerade (typically wan only)

FirewallRule A firewall traffic rule as returned by ListRules.

Fields

Field	Type	Description
Id	string	Server-generated rule ID
SrcZone	string	Source zone (empty = any)
DstZone	string	Destination zone (empty = any)
Protocol	FirewallProtocol	PROTO_ANY \| PROTO_TCP \| PROTO_UDP \| PROTO_ICMP
SrcIp	string	Source IP/CIDR (empty = any)
DestPort	int32	Destination port (0 = any)
Action	ZonePolicy	POLICY_ACCEPT \| POLICY_DROP \| POLICY_REJECT
Comment	string	Optional description

VPNEvent Tunnel event received via WatchEvents. Payload is one of Tunnel or ProviderEvent.

Fields

Field	Type	Description
TsUnixMs	int64	Event timestamp (Unix ms)
ProfileId	string
SessionId	string
Provider	VpnProvider	WIREGUARD \| OPENVPN \| IPSEC \| CUSTOM
Tunnel	TunnelStateChanged	Set when tunnel state changes
ProviderEvent	ProviderNotification	Set for provider-specific events

VpnProvider VPN provider / protocol enum.

Fields

Field	Type	Description
VPN_PROVIDER_WIREGUARD	1
VPN_PROVIDER_OPENVPN	2
VPN_PROVIDER_IPSEC	3
VPN_PROVIDER_CUSTOM	15

TunnelStateChanged Payload of a VPNEvent when the tunnel state changes.

Fields

Field	Type	Description
NewState	string	DOWN \| CONNECTING \| UP \| DEGRADED \| ERROR
Message	string	Optional human-readable detail

ProviderNotification Payload of a VPNEvent for provider-specific notifications.

Fields

Field	Type	Description
Kind	string	Provider-defined event kind
Details	string	Provider-defined event details