D-Bus API Documentation¶
VeeaHub services are accessed through D-Bus APIs. D-Bus is a Linux standard for interprocess communication (IPC). More information can be found on the D-Bus Tutorial page. Libraries exist for most common programming languages. For example:
- C/C++ - libdbus
- Python - pydbus and dbus-next
- Golang - godbus
See D-Bus Data Types for the type codes used in the API signatures.
API Reference Links¶
| Interface | Description |
|---|---|
| io.veea.VeeaHub.BluetoothConfig | This service provides methods to configure Linux kernel Bluetooth parameters. (This is only available on VeeaHub platform firmware 2.32.5 and newer.) |
| io.veea.VeeaHub.BluetoothMonitor | This service provides methods to start and stop btmon instances on HCI interfaces. (This is only available on VeeaHub platform firmware 2.32.3 and newer.) |
| io.veea.VeeaHub.Cellular.Status | Provides methods to obtain status and statistics for the cellular interface. |
| io.veea.VeeaHub.ContainerControl | Provides methods and signals for container backup and restore. |
| io.veea.VeeaHub.DateTime | This interface allows the client to enable/disable the NTP Service (auto start the NTP process at boot), start/stop the NTP Process, set the date/time when the NTP process is not running, and set the timezone. |
| io.veea.VeeaHub.HardwareControl.SerialPort | This allows access to host hardware control and configuration. |
| io.veea.VeeaHub.HardwareMonitoringDaemon.Container | This is the API that communicates with the containers. Any container can communicate with HMD. HMD will use the caller user ID and process information to determine which container the call was made from. |
| io.veea.VeeaHub.Info | This interface allows the client to retrieve VeeaHub information. |
| io.veea.VeeaHub.Licenses | This allows the client to determine the licenses on the VeeaHub. |
| io.veea.VeeaHub.MqttControl | Provides methods for managing the platform MQTT and access to it from containers. |
| io.veea.VeeaHub.NetworkControl.WiFi | Provides methods to create and query WiFi Aps. |
| io.veea.VeeaHub.Networking | Provides methods for accessing platform networking services. |
| io.veea.VeeaHub.ReverseProxy | Provides methods for managing Reverse Proxy services on the host and the cloud. |
| io.veea.VeeaHub.SystemConfiguration.Containers | This allows access to general configuration parameters for how the unit runs containers. Container-specific parameters are not managed here. |
| io.veea.VeeaHub.WiFi.DataElements | Provides methods to obtain status and statistics for the WiFi interfaces. |
| io.veea.VeeaHub.Wireless.Stats | Provides methods to obtain WiFi status and statistics. |