fdo-mirrors/upower
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/upower/upower.git synced 2025-12-20 05:30:03 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
upower/dbus/org.freedesktop.UPower.xml

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

226 lines
8.4 KiB
XML
Raw Normal View History

initial commit
2008-05-08 22:29:38 -04:00
<!DOCTYPE node PUBLIC
"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
Rename the DBus service from org.freedesktop.DeviceKit.Power to org.freedesktop.UPower
2010-01-18 16:53:12 +00:00
<interface name="org.freedesktop.UPower">
document how to access the D-Bus service with examples
2008-11-11 11:36:25 -05:00
<doc:doc>
<doc:description>
<doc:para>
trivial: Rename a few 'DeviceKit-power' strings we missed
2010-05-28 15:00:07 +01:00
The UPower service is available via the system message
document how to access the D-Bus service with examples
2008-11-11 11:36:25 -05:00
bus. To access the service, use
Rename the DBus service from org.freedesktop.DeviceKit.Power to org.freedesktop.UPower
2010-01-18 16:53:12 +00:00
the <doc:tt>org.freedesktop.UPower</doc:tt> interface on
the <doc:tt>/org/freedesktop/UPower</doc:tt> object on
document how to access the D-Bus service with examples
2008-11-11 11:36:25 -05:00
the D-Bus system bus service with the well-known
Rename the DBus service from org.freedesktop.DeviceKit.Power to org.freedesktop.UPower
2010-01-18 16:53:12 +00:00
name <doc:tt>org.freedesktop.UPower</doc:tt>.
document how to access the D-Bus service with examples
2008-11-11 11:36:25 -05:00
</doc:para>
<doc:para>
<doc:example language="shell" title="simple example">
<doc:code>
$ dbus-send --print-reply \
--system \
Rename the DBus service from org.freedesktop.DeviceKit.Power to org.freedesktop.UPower
2010-01-18 16:53:12 +00:00
--dest=org.freedesktop.UPower \
/org/freedesktop/UPower \
org.freedesktop.UPower.EnumerateDevices
document how to access the D-Bus service with examples
2008-11-11 11:36:25 -05:00
method return sender=:1.386 -> dest=:1.451 reply_serial=2
array [
Rename the DBus service from org.freedesktop.DeviceKit.Power to org.freedesktop.UPower
2010-01-18 16:53:12 +00:00
object path "/org/freedesktop/UPower/devices/line_power_AC"
object path "/org/freedesktop/UPower/devices/battery_BAT0"
document how to access the D-Bus service with examples
2008-11-11 11:36:25 -05:00
]
</doc:code>
</doc:example>
</doc:para>
</doc:description>
</doc:doc>
initial commit
2008-05-08 22:29:38 -04:00
<!-- ************************************************************ -->
<method name="EnumerateDevices">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="devices" direction="out" type="ao">
<doc:doc><doc:summary>An array of object paths for devices.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
fixup a few places where we mention a disk daemon to a power daemon
2008-07-24 17:39:00 +01:00
Enumerate all power objects on the system.
initial commit
2008-05-08 22:29:38 -04:00
</doc:para>
</doc:description>
</doc:doc>
</method>
dbus: org.freedesktop.UPower: Enumerate kbd backlight LEDs Enumerate all keyboard backlight LED objects on the system.
2025-03-13 13:39:21 +08:00
<method name="EnumerateKbdBacklights">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="KbdBacklight" direction="out" type="ao">
<doc:doc><doc:summary>An array of object paths for keyboard backlight LEDs.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Enumerate all keyboard backlight LED objects on the system.
</doc:para>
</doc:description>
</doc:doc>
</method>
daemon: Add GetDisplayDevice method And export a DisplayDevice object which can be used by desktop shells to show/hide the status icon.
2013-10-16 13:42:34 +02:00
<method name="GetDisplayDevice">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="device" direction="out" type="o">
<doc:doc><doc:summary>An object path for the "display device.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Get the object to the "display device", a composite device that represents the
daemon: Mention hard-coded display device object path /org/freedesktop/UPower/devices/DisplayDevice is a stable object path.
2013-10-16 15:58:13 +02:00
status icon to show in desktop environments. You can also access the object directly
as its path is guaranteed to be /org/freedesktop/UPower/devices/DisplayDevice.
The following standard org.freedesktop.UPower.Device
daemon: Add GetDisplayDevice method And export a DisplayDevice object which can be used by desktop shells to show/hide the status icon.
2013-10-16 13:42:34 +02:00
properties will be defined (only <doc:ref type="property" to="Source:IsPresent">IsPresent</doc:ref> takes a special meaning):
<doc:list>
<doc:item>
<doc:term>Type</doc:term><doc:definition>the type of the display device, UPS or Battery. Note that this value can change, as opposed to real devices.</doc:definition>
</doc:item>
<doc:item>
<doc:term>State</doc:term><doc:definition>the power state of the display device, such as Charging or Discharging.</doc:definition>
</doc:item>
<doc:item>
<doc:term>Percentage</doc:term><doc:definition>the amount of energy left on the device.</doc:definition>
</doc:item>
<doc:item>
<doc:term>Energy</doc:term><doc:definition>Amount of energy (measured in Wh) currently available in the power source.</doc:definition>
</doc:item>
<doc:item>
<doc:term>EnergyFull</doc:term><doc:definition>Amount of energy (measured in Wh) in the power source when it's considered full.</doc:definition>
</doc:item>
<doc:item>
dbus: org.freedesktop.UPower: EnergyRate is a positive value The EnergyRate is a positive value since most of the laptops are ACPI based system and report the power status through power_now sysfs attribute. Moreover, the ACPI specification mention that the battery power status is a positive value, measured in watt. https://learn.microsoft.com/en-us/windows-hardware/design/component-guidelines/acpi-battery-and-power-subsystem-firmware-implementation Fix: https://gitlab.freedesktop.org/upower/upower/-/issues/252 Signed-off-by: Kate Hsuan <hpa@redhat.com>
2023-12-18 14:52:25 +08:00
<doc:term>EnergyRate</doc:term><doc:definition>Discharging/charging rate of the source, measured in Watt.</doc:definition>
daemon: Add GetDisplayDevice method And export a DisplayDevice object which can be used by desktop shells to show/hide the status icon.
2013-10-16 13:42:34 +02:00
</doc:item>
<doc:item>
<doc:term>TimeToEmpty</doc:term><doc:definition>Number of seconds until the power source is considered empty.</doc:definition>
</doc:item>
<doc:item>
<doc:term>TimeToFull</doc:term><doc:definition>Number of seconds until the power source is considered full.</doc:definition>
</doc:item>
<doc:item>
<doc:term>IsPresent</doc:term><doc:definition>Whether a status icon using this information should be presented.</doc:definition>
</doc:item>
daemon: Add documentation for computed properties Those are also part of the display device properties that we will update.
2013-10-16 15:58:39 +02:00
<doc:item>
<doc:term>IconName</doc:term><doc:definition>An icon name representing the device state.</doc:definition>
</doc:item>
<doc:item>
<doc:term>WarningLevel</doc:term><doc:definition>The same as the overall <doc:ref type="property" to="Source:WarningLevel">WarningLevel</doc:ref></doc:definition>
</doc:item>
daemon: Add GetDisplayDevice method And export a DisplayDevice object which can be used by desktop shells to show/hide the status icon.
2013-10-16 13:42:34 +02:00
</doc:list>
</doc:para>
</doc:description>
</doc:doc>
</method>
all: Add GetCriticalAction daemon method This allows desktop front-ends to get which action will actually be taken when we hit critical battery. This is not a property as availability of actions might change over the course of the run of the system, and we didn't want to make unnecessary D-Bus calls on startup.
2013-10-17 09:04:03 +02:00
<method name="GetCriticalAction">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="action" direction="out" type="s">
<doc:doc><doc:summary>A string representing the critical action configured and available.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
When the system's power supply is critical (critically low batteries or UPS),
the system will take this action. Possible values are:
<doc:list>
<doc:item>
<doc:term>HybridSleep</doc:term>
</doc:item>
<doc:item>
<doc:term>Hibernate</doc:term>
</doc:item>
<doc:item>
<doc:term>PowerOff</doc:term>
</doc:item>
dbus: UPower.xml: Update GetCriticalAction Values UPower now supports Suspend and Ignore as possible actions. Update the documentation accordingly.
2025-02-06 10:46:33 +02:00
<doc:item>
<doc:term>Suspend</doc:term>
</doc:item>
<doc:item>
<doc:term>Ignore</doc:term>
</doc:item>
all: Add GetCriticalAction daemon method This allows desktop front-ends to get which action will actually be taken when we hit critical battery. This is not a property as availability of actions might change over the course of the run of the system, and we didn't want to make unnecessary D-Bus calls on startup.
2013-10-17 09:04:03 +02:00
</doc:list>
</doc:para>
</doc:description>
</doc:doc>
</method>
initial commit
2008-05-08 22:29:38 -04:00
<!-- ************************************************************ -->
<signal name="DeviceAdded">
<arg name="device" type="o">
<doc:doc><doc:summary>Object path of device that was added.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Emitted when a device is added.
</doc:para>
</doc:description>
</doc:doc>
</signal>
<!-- ************************************************************ -->
<signal name="DeviceRemoved">
<arg name="device" type="o">
<doc:doc><doc:summary>Object path of device that was removed.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Emitted when a device is removed.
</doc:para>
</doc:description>
</doc:doc>
</signal>
<!-- ************************************************************ -->
Convert the property names to be FirstLetterCaps rather than dash-dash so KDE people can use the DBus interface
2009-09-18 18:28:53 +01:00
<property name="DaemonVersion" type="s" access="read">
turn some methods into properties GetOnBattery() -> :on-battery (bool) GetLowBattery() -> :on-low-battery (bool) CanSuspend() -> :can-suspend (bool) CanHibernate() -> :can-hibernate (bool) also add a new property for the daemon version :daemon-version (string) introduce a new Changed() signal that replaces ::LowBatteryChanged() ::OnBatteryChanged() Also fix a few bugs - we need to compute ::on-battery and ::on-low-battery *after* the actual device is updated - need to fire Device::Changed() before Power::DeviceChanged() otherwise devkit-power --monitor-detail lies also fix up libdevkit-power and devkit-power(1) to use these changes.
2008-11-11 13:58:26 -05:00
<doc:doc><doc:description><doc:para>
Version of the running daemon, e.g. <doc:tt>002</doc:tt>.
</doc:para></doc:description></doc:doc>
</property>
Convert the property names to be FirstLetterCaps rather than dash-dash so KDE people can use the DBus interface
2009-09-18 18:28:53 +01:00
<property name="OnBattery" type="b" access="read">
turn some methods into properties GetOnBattery() -> :on-battery (bool) GetLowBattery() -> :on-low-battery (bool) CanSuspend() -> :can-suspend (bool) CanHibernate() -> :can-hibernate (bool) also add a new property for the daemon version :daemon-version (string) introduce a new Changed() signal that replaces ::LowBatteryChanged() ::OnBatteryChanged() Also fix a few bugs - we need to compute ::on-battery and ::on-low-battery *after* the actual device is updated - need to fire Device::Changed() before Power::DeviceChanged() otherwise devkit-power --monitor-detail lies also fix up libdevkit-power and devkit-power(1) to use these changes.
2008-11-11 13:58:26 -05:00
<doc:doc><doc:description><doc:para>
Indicates whether the system is running on battery power.
This property is provided for convenience.
</doc:para></doc:description></doc:doc>
</property>
Revert "all: Remove Lid handling" This reverts commit 07565ef6a1aa4a115f8ce51e259e408edbaed4cc. In the current systemd stable release 255 org.freedesktop.login1 does not emit a LidisClosed event, this has added in systemd `main` and will be availble in the next release. As GNOME control panel still uses UPower's `LidIsclosed` property and many other DE's such as Xfce/LXQt/Deepin as well revert this until the systemd changes are available in all Distributions. https://github.com/systemd/systemd/pull/30706 Resolve: https://gitlab.freedesktop.org/upower/upower/-/issues/260
2024-01-17 16:17:08 +01:00
<property name="LidIsClosed" type="b" access="read">
<doc:doc>
<doc:description>
<doc:para>
Indicates if the laptop lid is closed where the display cannot be seen.
</doc:para>
</doc:description>
</doc:doc>
</property>
<property name="LidIsPresent" type="b" access="read">
<doc:doc>
<doc:description>
<doc:para>
If the system has a lid device.
</doc:para>
</doc:description>
</doc:doc>
</property>
initial commit
2008-05-08 22:29:38 -04:00
</interface>
</node>
Reference in a new issue Copy permalink