fdo-mirrors/upower
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/upower/upower.git synced 2026-02-04 22:20:27 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

document the output of the Device.GetStatistics() method

Browse source
This commit is contained in:
Richard Hughes 2008-08-15 11:40:57 +01:00
parent 35e91c0d96
commit 9c19c1437f
1 changed files with 25 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
src/org.freedesktop.DeviceKit.Power.Device.xml
View file

@ -59,7 +59,31 @@
<doc:doc><doc:summary>The amount of data to return in seconds, or 0 for all.</doc:summary></doc:doc>
</arg>
<arg name="data" direction="out" type="a(uds)">
<doc:doc><doc:summary>The data for the power device.</doc:summary></doc:doc>
<doc:doc><doc:summary>
The statistics data for the power device. Each element contains
the following members:
<doc:list>
<doc:item>
<doc:term>time</doc:term>
<doc:definition>
The time value in seconds from the <literal>gettimeofday()</literal> method.
</doc:definition>
</doc:item>
<doc:item>
<doc:term>value</doc:term>
<doc:definition>
The data value, for instance the rate in W or the charge in %.
</doc:definition>
</doc:item>
<doc:item>
<doc:term>state</doc:term>
<doc:definition>
The state of the device, for instance <literal>charging</literal> or
<literal>discharging</literal>.
</doc:definition>
</doc:item>
</doc:list>
</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>