1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
|
<!DOCTYPE node PUBLIC
"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd" [
<!ENTITY ERROR_GENERAL "org.freedesktop.DeviceKit.Power.Device.GeneralError">
]>
<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
<interface name="org.freedesktop.DeviceKit.Power.Device">
<doc:doc>
<doc:description>
<doc:para>
TODO: some explanatory text etc. etc. Mention that we
collect history to provide more precise values of
time-to-empty, time-to-full. Go into detail
with the algorithms.
</doc:para>
<doc:para>
Unless otherwise noted, an empty string or the value 0 in a
property means not set.
</doc:para>
</doc:description>
</doc:doc>
<!-- ************************************************************ -->
<method name="Refresh">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<doc:doc>
<doc:description>
<doc:para>
Refreshes the data collected from the power source.
</doc:para>
</doc:description>
<doc:permission>Callers need the org.freedesktop.devicekit.power.refresh-power-source authorization</doc:permission>
<doc:errors>
<doc:error name="&ERROR_GENERAL;">if an error occured while refreshing</doc:error>
</doc:errors>
</doc:doc>
</method>
<!-- ************************************************************ -->
<signal name="Changed">
<doc:doc>
<doc:description>
<doc:para>
Some value on the power source changed.
</doc:para>
</doc:description>
</doc:doc>
</signal>
<!-- ************************************************************ -->
<method name="GetHistory">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="type" direction="in" type="s">
<doc:doc><doc:summary>The type of history.
Valid types are <doc:tt>rate</doc:tt> or <doc:tt>charge</doc:tt>.</doc:summary></doc:doc>
</arg>
<arg name="timespan" direction="in" type="u">
<doc:doc><doc:summary>The amount of data to return in seconds, or 0 for all.</doc:summary></doc:doc>
</arg>
<arg name="resolution" direction="in" type="u">
<doc:doc>
<doc:summary>
The approximate number of points to return.
A higher resolution is more accurate, at the expense of plotting speed.
</doc:summary>
</doc:doc>
</arg>
<arg name="data" direction="out" type="a(uds)">
<doc:doc><doc:summary>
The history data for the power device, if the device supports history.
Data is ordered from the earliest in time, to the newest data point.
Each element contains the following members:
<doc:list>
<doc:item>
<doc:term>time</doc:term>
<doc:definition>
The time value in seconds from the <doc:tt>gettimeofday()</doc:tt> 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 <doc:tt>charging</doc:tt> or
<doc:tt>discharging</doc:tt>.
</doc:definition>
</doc:item>
</doc:list>
</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Gets history for the power device that is persistent across reboots.
</doc:para>
</doc:description>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="GetStatistics">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="type" direction="in" type="s">
<doc:doc><doc:summary>The mode for the statistics.
Valid types are <doc:tt>charging</doc:tt> or <doc:tt>discharging</doc:tt>.</doc:summary></doc:doc>
</arg>
<arg name="data" direction="out" type="a(dd)">
<doc:doc><doc:summary>
The statistics data for the power device.
Each element contains the following members:
<doc:list>
<doc:item>
<doc:term>value</doc:term>
<doc:definition>
The value of the percentage point, usually in seconds
</doc:definition>
</doc:item>
<doc:item>
<doc:term>accuracy</doc:term>
<doc:definition>
The accuracy of the prediction in percent.
</doc:definition>
</doc:item>
</doc:list>
</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Gets statistics for the power device that may be interesting
to show on a graph in the session.
</doc:para>
</doc:description>
</doc:doc>
</method>
<!-- ************************************************************ -->
<property name="native-path" type="s" access="read">
<doc:doc><doc:description><doc:para>
OS specific native path of the power source. On Linux this
is the sysfs path, for
example <doc:tt>/sys/devices/LNXSYSTM:00/device:00/PNP0C0A:00/power_supply/BAT0</doc:tt>. Is
blank if the device is being driven by a user space
driver.
</doc:para></doc:description></doc:doc>
</property>
<property name="vendor" type="s" access="read">
<doc:doc><doc:description><doc:para>
Name of the vendor of the battery.
</doc:para></doc:description></doc:doc>
</property>
<property name="model" type="s" access="read">
<doc:doc><doc:description><doc:para>
Name of the model of this battery.
</doc:para></doc:description></doc:doc>
</property>
<property name="serial" type="s" access="read">
<doc:doc><doc:description><doc:para>
Unique serial number of the battery.
</doc:para></doc:description></doc:doc>
</property>
<property name="update-time" type="t" access="read">
<doc:doc><doc:description><doc:para>
The point in time (seconds since the Epoch Jan 1, 1970
0:00 UTC) that data was read from the power source.
</doc:para></doc:description></doc:doc>
</property>
<property name="type" type="s" access="read">
<doc:doc><doc:description><doc:para>
Type of power source. Known values are "battery" and "line-power".
</doc:para></doc:description></doc:doc>
</property>
<property name="power-supply" type="b" access="read">
<doc:doc><doc:description><doc:para>
If the power device is used to supply the system.
This would be set TRUE for laptop batteries and UPS devices,
but set FALSE for wireless mice or PDAs.
</doc:para></doc:description></doc:doc>
</property>
<property name="has-history" type="b" access="read">
<doc:doc><doc:description><doc:para>
If the power device has history.
</doc:para></doc:description></doc:doc>
</property>
<property name="has-statistics" type="b" access="read">
<doc:doc><doc:description><doc:para>
If the power device has statistics.
</doc:para></doc:description></doc:doc>
</property>
<property name="online" type="b" access="read">
<doc:doc><doc:description><doc:para>
Whether power is currently being provided through line power.
This property is only valid if the property
<doc:ref type="property" to="Source:type">type</doc:ref>
has the value "line-power".
</doc:para></doc:description></doc:doc>
</property>
<property name="energy" type="d" access="read">
<doc:doc><doc:description><doc:para>
Amount of energy (measured in Wh) currently available in
the power source.
</doc:para><doc:para>
This property is only valid if the property
<doc:ref type="property" to="Source:type">type</doc:ref>
has the value "battery".
</doc:para></doc:description></doc:doc>
</property>
<property name="energy-empty" type="d" access="read">
<doc:doc><doc:description><doc:para>
Amount of energy (measured in Wh) in the power source when
it's considered to be empty.
</doc:para><doc:para>
This property is only valid if the property
<doc:ref type="property" to="Source:type">type</doc:ref>
has the value "battery".
</doc:para></doc:description></doc:doc>
</property>
<property name="energy-full" type="d" access="read">
<doc:doc><doc:description><doc:para>
Amount of energy (measured in Wh) in the power source when
it's considered full.
</doc:para><doc:para>
This property is only valid if the property
<doc:ref type="property" to="Source:type">type</doc:ref>
has the value "battery".
</doc:para></doc:description></doc:doc>
</property>
<property name="energy-full-design" type="d" access="read">
<doc:doc><doc:description><doc:para>
Amount of energy (measured in Wh) the power source is
designed to hold when it's considered full.
</doc:para><doc:para>
This property is only valid if the property
<doc:ref type="property" to="Source:type">type</doc:ref>
has the value "battery".
</doc:para></doc:description></doc:doc>
</property>
<property name="energy-rate" type="d" access="read">
<doc:doc><doc:description><doc:para>
Amount of energy being drained from the source, measured
in W. If positive, the source is being discharged, if
negative it's being charged.
</doc:para><doc:para>
This property is only valid if the property
<doc:ref type="property" to="Source:type">type</doc:ref>
has the value "battery".
</doc:para></doc:description></doc:doc>
</property>
<property name="voltage" type="d" access="read">
<doc:doc><doc:description><doc:para>
Voltage in the Cell or being recorded by the meter.
</doc:para></doc:description></doc:doc>
</property>
<property name="time-to-empty" type="x" access="read">
<doc:doc><doc:description><doc:para>
Number of seconds until the power source is considered empty.
Is set to 0 if unknown.
</doc:para><doc:para>
This property is only valid if the property
<doc:ref type="property" to="Source:type">type</doc:ref>
has the value "battery".
</doc:para></doc:description></doc:doc>
</property>
<property name="time-to-full" type="x" access="read">
<doc:doc><doc:description><doc:para>
Number of seconds until the power source is considered full.
Is set to 0 if unknown.
</doc:para><doc:para>
This property is only valid if the property
<doc:ref type="property" to="Source:type">type</doc:ref>
has the value "battery".
</doc:para></doc:description></doc:doc>
</property>
<property name="percentage" type="d" access="read">
<doc:doc><doc:description><doc:para>
The amount of energy left in the power source expressed as
a percentage between 0 and 100. Typically this is the same as
(<doc:ref type="property" to="Source:energy">energy</doc:ref> -
<doc:ref type="property" to="Source:energy-empty">energy-empty</doc:ref>) /
(<doc:ref type="property" to="Source:energy-full">energy-full</doc:ref> -
<doc:ref type="property" to="Source:energy-empty">energy-empty</doc:ref>).
However, some primitive power sources are capable of only
reporting percentages and in this case the energy-*
properties will be unset while this property is set.
</doc:para><doc:para>
This property is only valid if the property
<doc:ref type="property" to="Source:type">type</doc:ref>
has the value "battery".
</doc:para></doc:description></doc:doc>
</property>
<property name="is-present" type="b" access="read">
<doc:doc><doc:description><doc:para>
If the power source is present in the bay.
This field is required as some batteries are hot-removable, for example
expensive UPS and most laptop batteries.
</doc:para><doc:para>
This property is only valid if the property
<doc:ref type="property" to="Source:type">type</doc:ref>
has the value "battery".
</doc:para></doc:description></doc:doc>
</property>
<property name="state" type="s" access="read">
<doc:doc><doc:description><doc:para>
The battery power state.
Known values are "fully-charged", "empty", "charging",
"discharging" or "unknown".
</doc:para><doc:para>
This property is only valid if the property
<doc:ref type="property" to="Source:type">type</doc:ref>
has the value "battery".
</doc:para></doc:description></doc:doc>
</property>
<property name="is-rechargeable" type="b" access="read">
<doc:doc><doc:description><doc:para>
If the power source is rechargeable.
</doc:para><doc:para>
This property is only valid if the property
<doc:ref type="property" to="Source:type">type</doc:ref>
has the value "battery".
</doc:para></doc:description></doc:doc>
</property>
<property name="capacity" type="d" access="read">
<doc:doc><doc:description><doc:para>
The capacity of the power source expressed as a percentage between 0 and 100.
The capacity of the battery will reduce with age.
A capacity value less than 75% is usually a sign that you should renew your battery.
Typically this value is the same as
(<doc:ref type="property" to="Source:full-design">full-design</doc:ref> /
<doc:ref type="property" to="Source:full">full</doc:ref>) * 100.
However, some primitive power sources are not capable reporting capacity
and in this case the capacity property will be unset.
</doc:para><doc:para>
This property is only valid if the property
<doc:ref type="property" to="Source:type">type</doc:ref>
has the value "battery".
</doc:para></doc:description></doc:doc>
</property>
<property name="technology" type="s" access="read">
<doc:doc><doc:description><doc:para>
Technology used in the battery; known values are "lithium-ion", "lead-acid",
"lithium-polymer", "nickel-metal-hydride", "lithium-iron-phosphate" or "unknown".
</doc:para><doc:para>
This property is only valid if the property
<doc:ref type="property" to="Source:type">type</doc:ref>
has the value "battery".
</doc:para></doc:description></doc:doc>
</property>
</interface>
</node>
|
