API Documentation

This chapter contains API documentation specific to the Librem 5 as well as links to upstream documentation.

API documentation for the underlying GNOME platform can be found in GTK+/GNOME Resources. This list is currently being filled in.

See also the Software Reference for detailed information about the Librem 5 software stack.

Phone/Messaging APIs

• Modem/Sim card access is provided via the ModemManager DBBus APIs
• Access to network connections is provided via NetworkManager DBus APIs

Shell APIs

DBus APIs provided by the Phone Shell (Phosh):

• org.gnome.Mutter.DisplayConfig provides display information and configuration:

  • Retrieve information about conntected displays,
  • Set gamma curve (used for e.g. nightlight)
  • Set primary monitor
  • Backlight brightness
  • Lacks changing displays

  Mostly used by gnome-settings-daemon.

• org.gnome.Mutter.IdleMonitor to detect if the session is idle (for e.g. screen lock or power saving). Used by e.g. gnome-session for idle detection.

• org.gnome.keyring.SystemPrompter provides System modal authentication dialogs (used by e.g. gnupg’s pinentry, SIM card pin entry, etc.)

Mobile Widgets

• libhandy reference manual