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
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
|
<!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.UPower.Device.GeneralError">
]>
<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
<interface name="org.freedesktop.UPower.Device">
<doc:doc>
<doc:description>
<doc:para>
Objects implementing this interface are usually discovered through
the <doc:tt>org.freedesktop.UPower</doc:tt> interface on
the <doc:tt>/org/freedesktop/UPower</doc:tt> object on
the D-Bus system bus service with the well-known
name <doc:tt>org.freedesktop.UPower</doc:tt> using
the
<doc:ref type="method" to="Power.EnumerateDevices">EnumerateDevices</doc:ref>
method.
</doc:para>
<doc:para>
<doc:example language="shell" title="simple example">
<doc:code>
$ dbus-send --print-reply \
--system \
--dest=org.freedesktop.UPower \
/org/freedesktop/UPower/devices/battery_BAT0 \
org.freedesktop.DBus.Properties.GetAll \
string:org.freedesktop.UPower.Device
method return sender=:1.386 -> dest=:1.477 reply_serial=2
array [
dict entry(
string "native-path"
variant string "/sys/devices/LNXSYSTM:00/device:00/PNP0A08:00/device:01/PNP0C09:00/PNP0C0A:00/power_supply/BAT0"
)
dict entry(
string "vendor"
variant string "SONY"
)
dict entry(
string "model"
variant string "42T4568"
)
dict entry(
string "serial"
variant string "4179"
)
dict entry(
string "update-time"
variant uint64 1226417875
)
dict entry(
string "type"
variant uint 2
)
dict entry(
string "power-supply"
variant boolean true
)
dict entry(
string "has-history"
variant boolean true
)
dict entry(
string "has-statistics"
variant boolean true
)
dict entry(
string "online"
variant boolean false
)
dict entry(
string "energy"
variant double 72.85
)
dict entry(
string "energy-empty"
variant double 0
)
dict entry(
string "energy-full"
variant double 74.55
)
dict entry(
string "energy-full-design"
variant double 74.88
)
dict entry(
string "energy-rate"
variant double 0
)
dict entry(
string "voltage"
variant double 16.415
)
dict entry(
string "time-to-empty"
variant int64 0
)
dict entry(
string "time-to-full"
variant int64 0
)
dict entry(
string "percentage"
variant double 97.7197
)
dict entry(
string "is-present"
variant boolean true
)
dict entry(
string "state"
variant uint 3
)
dict entry(
string "is-rechargeable"
variant boolean true
)
dict entry(
string "capacity"
variant double 100
)
dict entry(
string "technology"
variant uint 1
)
]
</doc:code>
</doc:example>
</doc:para>
<doc:para>
Unless otherwise noted, an empty string or the value 0 in a
property on this interface 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.upower.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(udu)">
<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="NativePath" 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="UpdateTime" 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="u" access="read">
<doc:doc>
<doc:description>
<doc:para>
Type of power source.
</doc:para>
<doc:list>
<doc:item>
<doc:term>0</doc:term><doc:definition>Unknown</doc:definition>
</doc:item>
<doc:item>
<doc:term>1</doc:term><doc:definition>Line Power</doc:definition>
</doc:item>
<doc:item>
<doc:term>2</doc:term><doc:definition>Battery</doc:definition>
</doc:item>
<doc:item>
<doc:term>3</doc:term><doc:definition>Ups</doc:definition>
</doc:item>
<doc:item>
<doc:term>4</doc:term><doc:definition>Monitor</doc:definition>
</doc:item>
<doc:item>
<doc:term>5</doc:term><doc:definition>Mouse</doc:definition>
</doc:item>
<doc:item>
<doc:term>6</doc:term><doc:definition>Keyboard</doc:definition>
</doc:item>
<doc:item>
<doc:term>7</doc:term><doc:definition>Pda</doc:definition>
</doc:item>
<doc:item>
<doc:term>8</doc:term><doc:definition>Phone</doc:definition>
</doc:item>
</doc:list>
</doc:description>
</doc:doc>
</property>
<property name="PowerSupply" 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="HasHistory" 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="HasStatistics" 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="EnergyEmpty" 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="EnergyFull" 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="EnergyFullDesign" 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="EnergyRate" 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="TimeToEmpty" 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="TimeToFull" 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:EnergyEmpty">energy-empty</doc:ref>) /
(<doc:ref type="property" to="Source:EnergyFull">energy-full</doc:ref> -
<doc:ref type="property" to="Source:EnergyEmpty">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="IsPresent" 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="u" access="read">
<doc:doc>
<doc:description>
<doc:para>
The battery power state.
</doc:para>
<doc:list>
<doc:item>
<doc:term>0</doc:term><doc:definition>Unknown</doc:definition>
</doc:item>
<doc:item>
<doc:term>1</doc:term><doc:definition>Charging</doc:definition>
</doc:item>
<doc:item>
<doc:term>2</doc:term><doc:definition>Discharging</doc:definition>
</doc:item>
<doc:item>
<doc:term>3</doc:term><doc:definition>Empty</doc:definition>
</doc:item>
<doc:item>
<doc:term>4</doc:term><doc:definition>Fully charged</doc:definition>
</doc:item>
<doc:item>
<doc:term>5</doc:term><doc:definition>Pending charge</doc:definition>
</doc:item>
<doc:item>
<doc:term>6</doc:term><doc:definition>Pending discharge</doc:definition>
</doc:item>
</doc:list>
<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="IsRechargeable" 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:FullDesign">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="u" access="read">
<doc:doc>
<doc:description>
<doc:para>
Technology used in the battery:
</doc:para>
<doc:list>
<doc:item>
<doc:term>0</doc:term><doc:definition>Unknown</doc:definition>
</doc:item>
<doc:item>
<doc:term>1</doc:term><doc:definition>Lithium ion</doc:definition>
</doc:item>
<doc:item>
<doc:term>2</doc:term><doc:definition>Lithium polymer</doc:definition>
</doc:item>
<doc:item>
<doc:term>3</doc:term><doc:definition>Lithium iron phosphate</doc:definition>
</doc:item>
<doc:item>
<doc:term>4</doc:term><doc:definition>Lead acid</doc:definition>
</doc:item>
<doc:item>
<doc:term>5</doc:term><doc:definition>Nickel cadmium</doc:definition>
</doc:item>
<doc:item>
<doc:term>6</doc:term><doc:definition>Nickel metal hydride</doc:definition>
</doc:item>
</doc:list>
<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="RecallNotice" type="b" access="read">
<doc:doc>
<doc:description>
<doc:para>
If the device may have been recalled by the vendor due to a suspected
fault.
This key does not imply the device is faulty, only that it approximatly
matches the description from the vendor of units that were recalled.
</doc:para>
</doc:description>
</doc:doc>
</property>
<property name="RecallVendor" type="s" access="read">
<doc:doc>
<doc:description>
<doc:para>
The vendor that is handling the hardware recall.
</doc:para>
<doc:para>
This property is only valid if the property recall-notice is true.
</doc:para>
</doc:description>
</doc:doc>
</property>
<property name="RecallUrl" type="s" access="read">
<doc:doc>
<doc:description>
<doc:para>
The URL to visit about the hardware recall.
</doc:para>
<doc:para>
This property is only valid if the property recall-notice is true.
</doc:para>
</doc:description>
</doc:doc>
</property>
</interface>
</node>
|
