Orbit OS SDK — API Reference

⚠ Under Construction — documentation is incomplete and subject to change

Language

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/*

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()

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(ifname)

SetClientConfig Configures the interface for client (station) mode.

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(
    ifname, ssid, password, "wpa2",
    true, "", "", nil,
)

Connect Brings up the Wi-Fi connection on the interface.

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(ifname)

Scan Scans for nearby Wi-Fi networks.

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(ifname, true)

StartHotspot Starts an access point on the given interface.

Signature

func (w *WiFiManager) StartHotspot(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

Returns

Name	Type	Notes
ok	bool
error	error

Example

ok, err := client.WiFiManager.StartHotspot(ifname, ssid, password, "5GHz", 6)

Bluetooth Manager

Bluetooth Classic and BLE device management.

PermissionBluetoothService/*

GetAdapterInfo Returns information about the local Bluetooth adapter.

Signature

func (m *BluetoothManager) GetAdapterInfo(ctx context.Context) (*AdapterInfo, error)

Parameters

Name	Type	Notes
ctx	Context

Returns

Name	Type	Notes
*AdapterInfo		{ Address, Name, Powered, Discoverable, Discovering }
error	error

Example

info, err := client.BluetoothManager.GetAdapterInfo(ctx)

ScanClassic Scans for Classic Bluetooth devices. Calls onResult for each discovery. Blocks until context is cancelled.

Signature

func (m *BluetoothManager) ScanClassic(ctx context.Context, onResult func(BtDevice)) error

Parameters

Name	Type	Notes
ctx	Context
onResult	func(BtDevice)

Returns

Name	Type	Notes
error	error

Example

err := client.BluetoothManager.ScanClassic(ctx, func(d BtDevice) {
    fmt.Println(d.Address, d.Name)
})

ScanBLE Scans for BLE devices with optional filters. Blocks until context is cancelled (~30 s).

Signature

func (m *BluetoothManager) ScanBLE(ctx context.Context, filters []BLEScanFilter, onResult func(BLEScanResult)) error

Parameters

Name	Type	Notes
ctx	Context
filters	[]BLEScanFilter	{ NamePrefix, Address, ServiceUUID }
onResult	func(BLEScanResult)

Returns

Name	Type	Notes
error	error

Example

err := client.BluetoothManager.ScanBLE(ctx, nil, func(r BLEScanResult) {
    fmt.Println(r.Address, r.RSSI)
})

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.

PermissionUartService/*

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.

Signature

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

Parameters

Name	Type	Notes
cfg	UartConfig	{ Port, Baudrate, DataBits, Parity, StopBits, FlowControl }

Returns

Name	Type	Notes
error	error

Example

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

Write Writes raw bytes to an open UART port.

Signature

func (m *UartManager) Write(port string, data []byte) (int, error)

Parameters

Name	Type	Notes
port	string
data	bytes

Returns

Name	Type	Notes
bytesWritten	int
error	error

Example

n, err := client.UartManager.Write("ttyS0", data)

Listen Streams incoming bytes from a UART port. Calls onChunk for each received chunk. Blocks until context is cancelled.

Signature

func (m *UartManager) Listen(ctx context.Context, port string, maxChunkSize int, onChunk func([]byte)) error

Parameters

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

Returns

Name	Type	Notes
error	error

Example

err := client.UartManager.Listen(ctx, "ttyS0", 256, func(chunk []byte) {
    // handle received data
})

I2C Manager

I²C bus discovery and data transfer.

PermissionI2cService/*

ListBuses Returns the indices of available I²C buses.

Signature

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

Returns

Name	Type	Notes
[]uint32
error	error

Example

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

ScanBus Probes all 7-bit addresses on a bus and returns those that respond.

Signature

func (m *I2CManager) ScanBus(bus uint32) ([]uint32, error)

Parameters

Name	Type	Notes
bus	uint32

Returns

Name	Type	Notes
[]uint32		responding addresses
error	error

Example

addrs, err := client.I2CManager.ScanBus(1)

GetConfig Returns the current configuration of an I²C bus.

Signature

func (m *I2CManager) GetConfig(bus uint32) (I2CConfig, error)

Parameters

Name	Type	Notes
bus	uint32

Returns

Name	Type	Notes
cfg	I2CConfig	{ Bus, ClockHz, TenBitAddr, ClockStretching }
error	error

Example

cfg, err := client.I2CManager.GetConfig(1)

SetConfig Applies configuration changes to an I²C bus.

Signature

func (m *I2CManager) SetConfig(cfg I2CConfig) error

Parameters

Name	Type	Notes
cfg	I2CConfig	{ Bus, ClockHz, TenBitAddr, ClockStretching }

Returns

Name	Type	Notes
error	error

Example

err := client.I2CManager.SetConfig(I2CConfig{Bus: 1, ClockHz: 400000})

Transfer Performs a write, read, or write-then-read I²C transaction. Operation is inferred from the fields set in the request.

Signature

func (m *I2CManager) Transfer(req I2CTransferRequest) ([]byte, error)

Parameters

Name	Type	Notes
req	I2CTransferRequest	{ Bus, Address, Data, ReadLength, Flags }

Returns

Name	Type	Notes
[]byte
error	error

Example

data, err := client.I2CManager.Transfer(I2CTransferRequest{
    Bus: 1, Address: 0x48,
    Data: []byte{0x00}, ReadLength: 2,
})

SPI Manager

SPI bus configuration and full-duplex transfer.

PermissionSpiService/*

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()

Transfer Performs a full-duplex SPI transfer.

Signature

func (m *SpiManager) Transfer(bus, cs uint32, dataOut []byte, readLength uint32) ([]byte, error)

Parameters

Name	Type	Notes
bus	uint32
cs	uint32	Chip select index
dataOut	bytes
readLength	uint32	0 = write-only

Returns

Name	Type	Notes
[]byte
error	error

Example

rx, err := client.SpiManager.Transfer(0, 0, 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)

CaptureImage Captures a single frame from a camera device.

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		{ ImageData, Format, Timestamp }
error	error

Example

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

AI Manager

On-device AI model management and inference.

PermissionAiService/*

LoadModel Loads a model already present on the device filesystem.

Signature

func (m *AI Manager) LoadModel(modelID, modelPath string, backend ModelBackend, execution ExecutionMode) (*LoadModelResponse, error)

Parameters

Name	Type	Notes
modelID	string
modelPath	string
backend	ModelBackend	ONNX \| TFLITE
execution	ExecutionMode	CPU \| GPU \| NPU

Returns

Name	Type	Notes
*LoadModelResponse
error	error

Example

resp, err := client.AI Manager.LoadModel(
    "detector", "/models/yolo.onnx",
    ModelBackend_ONNX, ExecutionMode_NPU,
)

Infer Runs synchronous inference on a loaded model.

Signature

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

Parameters

Name	Type	Notes
ctx	Context
modelID	string
inputData	bytes
inputShape	[]int32
dtype	TensorDataType

Returns

Name	Type	Notes
*InferResponse
error	error

Example

resp, err := client.AI Manager.Infer(
    ctx, "detector", inputData,
    []int32{1, 3, 640, 640}, TensorDataType_FLOAT32,
)

Firewall Manager

Network firewall zone and rule management.

PermissionFirewallService/*

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()

AddRule Adds a firewall 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
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",
)

VPN Manager

VPN profile management and connection control.

PermissionVpnService/*

ApplyWireGuard Creates or updates a WireGuard VPN 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	bytes	Raw WireGuard .conf content
autoConnect	bool

Returns

Name	Type	Notes
profileID	string
error	error

Example

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

Connect Starts a VPN session for the given profile.

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 Terminates the VPN session for the given 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)

App Hub Manager

Service registration and HTTP routing via the Orbit app hub.

PermissionAppHubService/*

RegisterWebUI Registers a local HTTP server as the app web UI.

Signature

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

Parameters

Name	Type	Notes
addr	string	e.g. "localhost:8080"
route	string	e.g. "/ui"

Returns

Name	Type	Notes
error	error

Example

err := client.AppHubManager.RegisterWebUI("localhost:8080", "/ui")

AddRoute Adds an HTTP route to the routing table.

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/v1")

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

Returns

Name	Type	Notes
error	error

Example

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

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, filter LogFilter, onEntry func(LogEntry)) error

Parameters

Name	Type	Notes
ctx	Context
filter	LogFilter	{ App, Tag, MinLevel }
onEntry	func(LogEntry)

Returns

Name	Type	Notes
error	error

Example

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

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)

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

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