Overview#

You can find the DBus API Specification here. While this was the initial specification that was used for development, the actual implementation may not have been completely faithful to it due to technical issues that had to be resolved. You can find the technical DBus specification https://github.com/Eeems/oxide/tree/master/interfaces, and examples of it’s consumption in some of the embedded applications (e.g. fret)

Further reading:

Options for interacting with the API#

There are a number of options for interacting with the API.

  1. Using the rot command line tool.

  2. Generating classes using the automatic interface xml files.

  3. Making calls using dbus-send.

  4. Making D-Bus calls manually in your language of choice.

For the purposes of this documentation we will document using rot as well as using Qt generated classes.

Liboxide Shared Library#

Oxide also produces a shared library that can be used for application development. This library does not yet fully encompass the full API provide through D-Bus, but will slowly work towards feature parity.

You can find the documentation here