diff options
Diffstat (limited to '')
| -rw-r--r-- | data/dbus-interfaces/net.hadess.PowerProfiles.xml | 76 |
1 files changed, 76 insertions, 0 deletions
diff --git a/data/dbus-interfaces/net.hadess.PowerProfiles.xml b/data/dbus-interfaces/net.hadess.PowerProfiles.xml new file mode 100644 index 0000000..fce04a8 --- /dev/null +++ b/data/dbus-interfaces/net.hadess.PowerProfiles.xml @@ -0,0 +1,76 @@ +<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" +"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd"> + +<node> + + <!-- + net.hadess.PowerProfiles: + @short_description: Power Profiles daemon + + The power-profiles-daemon API is meant to be used by parts of the OS or + desktop environment to switch system power profiles based on user choice, + or user intent. + + OS components would typically use the "Profiles" property to construct + their UI (2 or 3 profiles available), and monitor the "ActiveProfile" + and the "PerformanceInhibited" properties to update that UI. The UI + would try to set the "ActiveProfile" property if the user selected + a different one. + + Note that the reason why the project exists and how it is different from + existing projects is explained <ulink href=" https://gitlab.freedesktop.org/hadess/power-profiles-daemon/-/blob/master/README.md"> + in the project's README file</ulink>. + + The object path will be "/net/hadess/PowerProfiles". + --> + <interface name="net.hadess.PowerProfiles"> + <!-- + ActiveProfile: + + The type of the currently active profile. It might change automatically + if the "performance" profile was selected but it got inhibited, in which + case the "PerformanceInhibited" property will reflect the reason. + --> + <property name="ActiveProfile" type="s" access="readwrite"/> + + <!-- + PerformanceInhibited: + + This will be set if the performance power profile is unavailable, with + the value being used to identify the reason for unavailability. As new + reasons can be added, it is recommended that front-ends show a generic + reason if they do not recognise the value. Possible values are: + - "lap-detected" (the computer is sitting on the user's lap) + - "high-operating-temperature" (the computer is close to overheating) + - "" (the empty string, if not inhibited) + --> + <property name="PerformanceInhibited" type="s" access="read"/> + + <!-- + Profiles: + + An array of key-pair values representing each profile. The key named + "Driver" (s) identifies the power-profiles-daemon backend code used to + implement the profile. + + The key named "Profile" (s) will be one of: + - "power-saver" (battery saving profile) + - "balanced" (the default profile) + - "performance" (a profile that does not care about noise or battery consumption) + + Only one of each type of profile will be listed, with the daemon choosing the + more appropriate "driver" for each profile type. + --> + <property name="Profiles" type="aa{sv}" access="read"/> + + <!-- + Actions: + + An array of strings listing each one of the "actions" implemented in + the running daemon. This is used by API users to figure out whether + particular functionality is available in a version of the daemon. + --> + <property name="Actions" type="as" access="read"/> + + </interface> +</node> |