Debian Codegraph @

dbus/org.freedesktop.UPower.Device.xml

raw
1 <!DOCTYPE node PUBLIC
2 "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
3 "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd" [
4 <!ENTITY ERROR_GENERAL "org.freedesktop.UPower.Device.GeneralError">
5 ]>
6 <node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
7 <interface name="org.freedesktop.UPower.Device">
8 <doc:doc>
9 <doc:description>
10 <doc:para>
11 Objects implementing this interface are usually discovered through
12 the <doc:tt>org.freedesktop.UPower</doc:tt> interface on
13 the <doc:tt>/org/freedesktop/UPower</doc:tt> object on
14 the D-Bus system bus service with the well-known
15 name <doc:tt>org.freedesktop.UPower</doc:tt> using
16 the
17 <doc:ref type="method" to="Power.EnumerateDevices">EnumerateDevices</doc:ref>
18 method.
19 </doc:para>
20 <doc:para>
21 <doc:example language="shell" title="simple example">
22 <doc:code>
23 $ dbus-send --print-reply \
24 --system \
25 --dest=org.freedesktop.UPower \
26 /org/freedesktop/UPower/devices/battery_BAT0 \
27 org.freedesktop.DBus.Properties.GetAll \
28 string:org.freedesktop.UPower.Device
29
30 method return sender=:1.386 -> dest=:1.477 reply_serial=2
31 array [
32 dict entry(
33 string "native-path"
34 variant string "/sys/devices/LNXSYSTM:00/device:00/PNP0A08:00/device:01/PNP0C09:00/PNP0C0A:00/power_supply/BAT0"
35 )
36 dict entry(
37 string "vendor"
38 variant string "SONY"
39 )
40 dict entry(
41 string "model"
42 variant string "42T4568"
43 )
44 dict entry(
45 string "serial"
46 variant string "4179"
47 )
48 dict entry(
49 string "update-time"
50 variant uint64 1226417875
51 )
52 dict entry(
53 string "type"
54 variant uint 2
55 )
56 dict entry(
57 string "power-supply"
58 variant boolean true
59 )
60 dict entry(
61 string "has-history"
62 variant boolean true
63 )
64 dict entry(
65 string "has-statistics"
66 variant boolean true
67 )
68 dict entry(
69 string "online"
70 variant boolean false
71 )
72 dict entry(
73 string "energy"
74 variant double 72.85
75 )
76 dict entry(
77 string "energy-empty"
78 variant double 0
79 )
80 dict entry(
81 string "energy-full"
82 variant double 74.55
83 )
84 dict entry(
85 string "energy-full-design"
86 variant double 74.88
87 )
88 dict entry(
89 string "energy-rate"
90 variant double 0
91 )
92 dict entry(
93 string "voltage"
94 variant double 16.415
95 )
96 dict entry(
97 string "time-to-empty"
98 variant int64 0
99 )
100 dict entry(
101 string "time-to-full"
102 variant int64 0
103 )
104 dict entry(
105 string "percentage"
106 variant double 97.7197
107 )
108 dict entry(
109 string "is-present"
110 variant boolean true
111 )
112 dict entry(
113 string "state"
114 variant uint 3
115 )
116 dict entry(
117 string "is-rechargeable"
118 variant boolean true
119 )
120 dict entry(
121 string "capacity"
122 variant double 100
123 )
124 dict entry(
125 string "technology"
126 variant uint 1
127 )
128 ]
129 </doc:code>
130 </doc:example>
131 </doc:para>
132 <doc:para>
133 Unless otherwise noted, an empty string or the value 0 in a
134 property on this interface means not set.
135 </doc:para>
136 </doc:description>
137 </doc:doc>
138
139
140 <!-- ************************************************************ -->
141 <method name="Refresh">
142 <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
143 <doc:doc>
144 <doc:description>
145 <doc:para>
146 Refreshes the data collected from the power source.
147 </doc:para>
148 </doc:description>
149 <doc:permission>Callers will need to make sure that the daemon was started in debug mode</doc:permission>
150 <doc:errors>
151 <doc:error name="&ERROR_GENERAL;">if an error occurred while refreshing</doc:error>
152 </doc:errors>
153 </doc:doc>
154 </method>
155
156 <!-- ************************************************************ -->
157 <method name="GetHistory">
158 <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
159 <arg name="type" direction="in" type="s">
160 <doc:doc><doc:summary>The type of history.
161 Valid types are <doc:tt>rate</doc:tt>, <doc:tt>charge</doc:tt> and <doc:tt>voltage</doc:tt>.</doc:summary></doc:doc>
162 </arg>
163 <arg name="timespan" direction="in" type="u">
164 <doc:doc><doc:summary>The amount of data to return in seconds, or 0 for all.</doc:summary></doc:doc>
165 </arg>
166 <arg name="resolution" direction="in" type="u">
167 <doc:doc>
168 <doc:summary>
169 The approximate number of points to return.
170 A higher resolution is more accurate, at the expense of plotting speed.
171 </doc:summary>
172 </doc:doc>
173 </arg>
174 <arg name="data" direction="out" type="a(udu)">
175 <doc:doc><doc:summary>
176 The history data for the power device, if the device supports history.
177 Data is ordered from the earliest in time, to the newest data point.
178 Each element contains the following members:
179 <doc:list>
180 <doc:item>
181 <doc:term>time</doc:term>
182 <doc:definition>
183 The time value in seconds from the <doc:tt>gettimeofday()</doc:tt> method.
184 </doc:definition>
185 </doc:item>
186 <doc:item>
187 <doc:term>value</doc:term>
188 <doc:definition>
189 The data value, for instance the rate in W, the charge in % and the voltage in V.
190 </doc:definition>
191 </doc:item>
192 <doc:item>
193 <doc:term>state</doc:term>
194 <doc:definition>
195 The state of the device, for instance <doc:tt>charging</doc:tt> or
196 <doc:tt>discharging</doc:tt>.
197 </doc:definition>
198 </doc:item>
199 </doc:list>
200 </doc:summary></doc:doc>
201 </arg>
202 <doc:doc>
203 <doc:description>
204 <doc:para>
205 Gets history for the power device that is persistent across reboots.
206 </doc:para>
207 </doc:description>
208 </doc:doc>
209 </method>
210
211 <!-- ************************************************************ -->
212 <method name="GetStatistics">
213 <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
214 <arg name="type" direction="in" type="s">
215 <doc:doc><doc:summary>The mode for the statistics.
216 Valid types are <doc:tt>charging</doc:tt> or <doc:tt>discharging</doc:tt>.</doc:summary></doc:doc>
217 </arg>
218 <arg name="data" direction="out" type="a(dd)">
219 <doc:doc><doc:summary>
220 The statistics data for the power device.
221 Each element contains the following members:
222 <doc:list>
223 <doc:item>
224 <doc:term>value</doc:term>
225 <doc:definition>
226 The value of the percentage point, usually in seconds
227 </doc:definition>
228 </doc:item>
229 <doc:item>
230 <doc:term>accuracy</doc:term>
231 <doc:definition>
232 The accuracy of the prediction in percent.
233 </doc:definition>
234 </doc:item>
235 </doc:list>
236 </doc:summary></doc:doc>
237 </arg>
238 <doc:doc>
239 <doc:description>
240 <doc:para>
241 Gets statistics for the power device that may be interesting
242 to show on a graph in the session.
243 </doc:para>
244 </doc:description>
245 </doc:doc>
246 </method>
247
248 <!-- ************************************************************ -->
249 <method name="EnableChargeThreshold">
250 <arg name="chargeThreshold" direction="in" type="b">
251 <doc:doc>
252 <doc:summary>
253 If it is true, the battery charge will be limited to ChargeEndThreshold and start to charge when the battery is lower than ChargeStartThreshold.
254 Moreovere, if ChargeEndThreshold and/or ChargeStartThreshold are not supported, charge limit functionality on the whole may still be supported but the firmware will choose its own thresholds.
255 If it is false, the battery will always be fully charged.
256 </doc:summary>
257 </doc:doc>
258 </arg>
259 <doc:doc>
260 <doc:description>
261 <doc:para>
262 Limiting the battery charge to the configured thresholds ChargeStartThreshold and ChargeEndThreshold.
263 </doc:para>
264 </doc:description>
265 <doc:errors>
266 <doc:error name="&ERROR_GENERAL;">if an error occurred while setting the battery charge limits</doc:error>
267 </doc:errors>
268 </doc:doc>
269 </method>
270
271 <!-- ************************************************************ -->
272 <property name="NativePath" type="s" access="read">
273 <doc:doc>
274 <doc:description>
275 <doc:para>
276 OS specific native path of the power source. On Linux this
277 is the sysfs path, for
278 example <doc:tt>/sys/devices/LNXSYSTM:00/device:00/PNP0C0A:00/power_supply/BAT0</doc:tt>. Is
279 blank if the device is being driven by a user space
280 driver.
281 </doc:para>
282 </doc:description>
283 </doc:doc>
284 </property>
285
286 <property name="Vendor" type="s" access="read">
287 <doc:doc>
288 <doc:description>
289 <doc:para>
290 Name of the vendor of the battery.
291 </doc:para>
292 </doc:description>
293 </doc:doc>
294 </property>
295
296 <property name="Model" type="s" access="read">
297 <doc:doc>
298 <doc:description>
299 <doc:para>
300 Name of the model of this battery.
301 </doc:para>
302 </doc:description>
303 </doc:doc>
304 </property>
305
306 <property name="Serial" type="s" access="read">
307 <doc:doc>
308 <doc:description>
309 <doc:para>
310 Unique serial number of the battery.
311 </doc:para>
312 </doc:description>
313 </doc:doc>
314 </property>
315
316 <property name="UpdateTime" type="t" access="read">
317 <doc:doc>
318 <doc:description>
319 <doc:para>
320 The point in time (seconds since the Epoch Jan 1, 1970
321 0:00 UTC) that data was read from the power source.
322 </doc:para>
323 </doc:description>
324 </doc:doc>
325 </property>
326
327 <property name="Type" type="u" access="read">
328 <doc:doc>
329 <doc:description>
330 <doc:para>
331 Type of power source.
332 </doc:para>
333 <doc:list>
334 <doc:item>
335 <doc:term>0</doc:term><doc:definition>Unknown</doc:definition>
336 </doc:item>
337 <doc:item>
338 <doc:term>1</doc:term><doc:definition>Line Power</doc:definition>
339 </doc:item>
340 <doc:item>
341 <doc:term>2</doc:term><doc:definition>Battery</doc:definition>
342 </doc:item>
343 <doc:item>
344 <doc:term>3</doc:term><doc:definition>Ups</doc:definition>
345 </doc:item>
346 <doc:item>
347 <doc:term>4</doc:term><doc:definition>Monitor</doc:definition>
348 </doc:item>
349 <doc:item>
350 <doc:term>5</doc:term><doc:definition>Mouse</doc:definition>
351 </doc:item>
352 <doc:item>
353 <doc:term>6</doc:term><doc:definition>Keyboard</doc:definition>
354 </doc:item>
355 <doc:item>
356 <doc:term>7</doc:term><doc:definition>Pda</doc:definition>
357 </doc:item>
358 <doc:item>
359 <doc:term>8</doc:term><doc:definition>Phone</doc:definition>
360 </doc:item>
361 <doc:item>
362 <doc:term>9</doc:term><doc:definition>Media Player</doc:definition>
363 </doc:item>
364 <doc:item>
365 <doc:term>10</doc:term><doc:definition>Tablet</doc:definition>
366 </doc:item>
367 <doc:item>
368 <doc:term>11</doc:term><doc:definition>Computer</doc:definition>
369 </doc:item>
370 <doc:item>
371 <doc:term>12</doc:term><doc:definition>Gaming Input</doc:definition>
372 </doc:item>
373 <doc:item>
374 <doc:term>13</doc:term><doc:definition>Pen</doc:definition>
375 </doc:item>
376 <doc:item>
377 <doc:term>14</doc:term><doc:definition>Touchpad</doc:definition>
378 </doc:item>
379 <doc:item>
380 <doc:term>15</doc:term><doc:definition>Modem</doc:definition>
381 </doc:item>
382 <doc:item>
383 <doc:term>16</doc:term><doc:definition>Network</doc:definition>
384 </doc:item>
385 <doc:item>
386 <doc:term>17</doc:term><doc:definition>Headset</doc:definition>
387 </doc:item>
388 <doc:item>
389 <doc:term>18</doc:term><doc:definition>Speakers</doc:definition>
390 </doc:item>
391 <doc:item>
392 <doc:term>19</doc:term><doc:definition>Headphones</doc:definition>
393 </doc:item>
394 <doc:item>
395 <doc:term>20</doc:term><doc:definition>Video</doc:definition>
396 </doc:item>
397 <doc:item>
398 <doc:term>21</doc:term><doc:definition>Other Audio</doc:definition>
399 </doc:item>
400 <doc:item>
401 <doc:term>22</doc:term><doc:definition>Remote Control</doc:definition>
402 </doc:item>
403 <doc:item>
404 <doc:term>23</doc:term><doc:definition>Printer</doc:definition>
405 </doc:item>
406 <doc:item>
407 <doc:term>24</doc:term><doc:definition>Scanner</doc:definition>
408 </doc:item>
409 <doc:item>
410 <doc:term>25</doc:term><doc:definition>Camera</doc:definition>
411 </doc:item>
412 <doc:item>
413 <doc:term>26</doc:term><doc:definition>Wearable</doc:definition>
414 </doc:item>
415 <doc:item>
416 <doc:term>27</doc:term><doc:definition>Toy</doc:definition>
417 </doc:item>
418 <doc:item>
419 <doc:term>28</doc:term><doc:definition>Bluetooth Generic</doc:definition>
420 </doc:item>
421 </doc:list>
422 <doc:para>
423 If the value is set to "Battery", you will need to verify that the
424 property <doc:ref type="property" to="Source:PowerSupply">power-supply</doc:ref>
425 has the value "true" before considering it as a laptop battery. Otherwise it
426 will likely be the battery for a device of an unknown type.
427 </doc:para>
428 </doc:description>
429 </doc:doc>
430 </property>
431
432 <property name="PowerSupply" type="b" access="read">
433 <doc:doc>
434 <doc:description>
435 <doc:para>
436 If the power device is used to supply the system.
437 This would be set TRUE for laptop batteries and UPS devices,
438 but set FALSE for wireless mice or PDAs.
439 </doc:para>
440 </doc:description>
441 </doc:doc>
442 </property>
443
444 <property name="HasHistory" type="b" access="read">
445 <doc:doc>
446 <doc:description>
447 <doc:para>
448 If the power device has history.
449 </doc:para>
450 </doc:description>
451 </doc:doc>
452 </property>
453
454 <property name="HasStatistics" type="b" access="read">
455 <doc:doc>
456 <doc:description>
457 <doc:para>
458 If the power device has statistics.
459 </doc:para>
460 </doc:description>
461 </doc:doc>
462 </property>
463
464 <property name="Online" type="b" access="read">
465 <doc:doc>
466 <doc:description>
467 <doc:para>
468 Whether power is currently being provided through line power.
469 This property is only valid if the property
470 <doc:ref type="property" to="Source:Type">type</doc:ref>
471 has the value "line-power".
472 </doc:para>
473 </doc:description>
474 </doc:doc>
475 </property>
476
477 <property name="Energy" type="d" access="read">
478 <doc:doc>
479 <doc:description>
480 <doc:para>
481 Amount of energy (measured in Wh) currently available in
482 the power source.
483 </doc:para><doc:para>
484 This property is only valid if the property
485 <doc:ref type="property" to="Source:Type">type</doc:ref>
486 has the value "battery".
487 </doc:para>
488 </doc:description>
489 </doc:doc>
490 </property>
491
492 <property name="EnergyEmpty" type="d" access="read">
493 <doc:doc>
494 <doc:description>
495 <doc:para>
496 Amount of energy (measured in Wh) in the power source when
497 it's considered to be empty.
498 </doc:para><doc:para>
499 This property is only valid if the property
500 <doc:ref type="property" to="Source:Type">type</doc:ref>
501 has the value "battery".
502 </doc:para>
503 </doc:description>
504 </doc:doc>
505 </property>
506
507 <property name="EnergyFull" type="d" access="read">
508 <doc:doc>
509 <doc:description>
510 <doc:para>
511 Amount of energy (measured in Wh) in the power source when
512 it's considered full.
513 </doc:para><doc:para>
514 This property is only valid if the property
515 <doc:ref type="property" to="Source:Type">type</doc:ref>
516 has the value "battery".
517 </doc:para>
518 </doc:description>
519 </doc:doc>
520 </property>
521
522 <property name="EnergyFullDesign" type="d" access="read">
523 <doc:doc>
524 <doc:description>
525 <doc:para>
526 Amount of energy (measured in Wh) the power source is
527 designed to hold when it's considered full.
528 </doc:para><doc:para>
529 This property is only valid if the property
530 <doc:ref type="property" to="Source:Type">type</doc:ref>
531 has the value "battery".
532 </doc:para>
533 </doc:description>
534 </doc:doc>
535 </property>
536
537 <property name="EnergyRate" type="d" access="read">
538 <doc:doc>
539 <doc:description>
540 <doc:para>
541 Amount of energy being drained from the source, measured
542 in W. If positive, the source is being discharged, if
543 negative it's being charged.
544 </doc:para><doc:para>
545 This property is only valid if the property
546 <doc:ref type="property" to="Source:Type">type</doc:ref>
547 has the value "battery".
548 </doc:para>
549 </doc:description>
550 </doc:doc>
551 </property>
552
553 <property name="Voltage" type="d" access="read">
554 <doc:doc>
555 <doc:description>
556 <doc:para>
557 Voltage in the Cell or being recorded by the meter.
558 </doc:para>
559 </doc:description>
560 </doc:doc>
561 </property>
562
563 <property name="ChargeCycles" type="i" access="read">
564 <doc:doc>
565 <doc:description>
566 <doc:para>
567 The number of charge cycles as defined by the TCO certification, or -1 if
568 that value is unknown or not applicable.
569 </doc:para>
570 </doc:description>
571 </doc:doc>
572 </property>
573
574 <property name="Luminosity" type="d" access="read">
575 <annotation name="org.freedesktop.DBus.Deprecated" value="true"/>
576 <doc:doc>
577 <doc:description>
578 <doc:para>
579 Luminosity being recorded by the meter.
580 </doc:para>
581 <doc:para>
582 DEPRECATED
583 </doc:para>
584 <doc:para>
585 This property is deprecated since the code it depends on was removed in 0.99.12
586 </doc:para>
587 </doc:description>
588 </doc:doc>
589 </property>
590
591 <property name="TimeToEmpty" type="x" access="read">
592 <doc:doc>
593 <doc:description>
594 <doc:para>
595 Number of seconds until the power source is considered empty.
596 Is set to 0 if unknown.
597 </doc:para><doc:para>
598 This property is only valid if the property
599 <doc:ref type="property" to="Source:Type">type</doc:ref>
600 has the value "battery".
601 </doc:para>
602 </doc:description>
603 </doc:doc>
604 </property>
605
606 <property name="TimeToFull" type="x" access="read">
607 <doc:doc>
608 <doc:description>
609 <doc:para>
610 Number of seconds until the power source is considered full.
611 Is set to 0 if unknown.
612 </doc:para><doc:para>
613 This property is only valid if the property
614 <doc:ref type="property" to="Source:Type">type</doc:ref>
615 has the value "battery".
616 </doc:para>
617 </doc:description>
618 </doc:doc>
619 </property>
620
621 <property name="Percentage" type="d" access="read">
622 <doc:doc>
623 <doc:description>
624 <doc:para>
625 The amount of energy left in the power source expressed as
626 a percentage between 0 and 100. Typically this is the same as
627 (<doc:ref type="property" to="Source:Energy">energy</doc:ref> -
628 <doc:ref type="property" to="Source:EnergyEmpty">energy-empty</doc:ref>) /
629 (<doc:ref type="property" to="Source:EnergyFull">energy-full</doc:ref> -
630 <doc:ref type="property" to="Source:EnergyEmpty">energy-empty</doc:ref>).
631 However, some primitive power sources are capable of only
632 reporting percentages and in this case the energy-*
633 properties will be unset while this property is set.
634 </doc:para><doc:para>
635 This property is only valid if the property
636 <doc:ref type="property" to="Source:Type">type</doc:ref>
637 has the value "battery".
638 </doc:para>
639 <doc:para>
640 The percentage will be an approximation if the <doc:ref type="property" to="BatteryLevel">battery level</doc:ref>
641 is set to something other than None. The percentage is kept for compatibility reasons.
642 </doc:para>
643 </doc:description>
644 </doc:doc>
645 </property>
646
647 <property name="Temperature" type="d" access="read">
648 <doc:doc>
649 <doc:description>
650 <doc:para>
651 The temperature of the device in degrees Celsius. This property is
652 only valid if the property
653 <doc:ref type="property" to="Source:Type">type</doc:ref>
654 has the value "battery".
655 </doc:para>
656 </doc:description>
657 </doc:doc>
658 </property>
659
660 <property name="IsPresent" type="b" access="read">
661 <doc:doc>
662 <doc:description>
663 <doc:para>
664 If the power source is present in the bay.
665 This field is required as some batteries are hot-removable, for example
666 expensive UPS and most laptop batteries.
667 </doc:para><doc:para>
668 This property is only valid if the property
669 <doc:ref type="property" to="Source:Type">type</doc:ref>
670 has the value "battery".
671 </doc:para>
672 </doc:description>
673 </doc:doc>
674 </property>
675
676 <property name="State" type="u" access="read">
677 <doc:doc>
678 <doc:description>
679 <doc:para>
680 The battery power state.
681 </doc:para>
682 <doc:list>
683 <doc:item>
684 <doc:term>0</doc:term><doc:definition>Unknown</doc:definition>
685 </doc:item>
686 <doc:item>
687 <doc:term>1</doc:term><doc:definition>Charging</doc:definition>
688 </doc:item>
689 <doc:item>
690 <doc:term>2</doc:term><doc:definition>Discharging</doc:definition>
691 </doc:item>
692 <doc:item>
693 <doc:term>3</doc:term><doc:definition>Empty</doc:definition>
694 </doc:item>
695 <doc:item>
696 <doc:term>4</doc:term><doc:definition>Fully charged</doc:definition>
697 </doc:item>
698 <doc:item>
699 <doc:term>5</doc:term><doc:definition>Pending charge</doc:definition>
700 </doc:item>
701 <doc:item>
702 <doc:term>6</doc:term><doc:definition>Pending discharge</doc:definition>
703 </doc:item>
704 </doc:list>
705 <doc:para>
706 This property is only valid if the property
707 <doc:ref type="property" to="Source:Type">type</doc:ref>
708 has the value "battery".
709 </doc:para>
710 </doc:description>
711 </doc:doc>
712 </property>
713
714 <property name="IsRechargeable" type="b" access="read">
715 <doc:doc>
716 <doc:description>
717 <doc:para>
718 If the power source is rechargeable.
719 </doc:para><doc:para>
720 This property is only valid if the property
721 <doc:ref type="property" to="Source:Type">type</doc:ref>
722 has the value "battery".
723 </doc:para>
724 </doc:description>
725 </doc:doc>
726 </property>
727
728 <property name="Capacity" type="d" access="read">
729 <doc:doc>
730 <doc:description>
731 <doc:para>
732 The capacity of the power source expressed as a percentage between 0 and 100.
733 The capacity of the battery will reduce with age.
734 A capacity value less than 75% is usually a sign that you should renew your battery.
735 Typically this value is the same as
736 (<doc:ref type="property" to="Source:FullDesign">full-design</doc:ref> /
737 <doc:ref type="property" to="Source:Full">full</doc:ref>) * 100.
738 However, some primitive power sources are not capable reporting capacity
739 and in this case the capacity property will be unset.
740 </doc:para><doc:para>
741 This property is only valid if the property
742 <doc:ref type="property" to="Source:Type">type</doc:ref>
743 has the value "battery".
744 </doc:para>
745 </doc:description>
746 </doc:doc>
747 </property>
748
749 <property name="Technology" type="u" access="read">
750 <doc:doc>
751 <doc:description>
752 <doc:para>
753 Technology used in the battery:
754 </doc:para>
755 <doc:list>
756 <doc:item>
757 <doc:term>0</doc:term><doc:definition>Unknown</doc:definition>
758 </doc:item>
759 <doc:item>
760 <doc:term>1</doc:term><doc:definition>Lithium ion</doc:definition>
761 </doc:item>
762 <doc:item>
763 <doc:term>2</doc:term><doc:definition>Lithium polymer</doc:definition>
764 </doc:item>
765 <doc:item>
766 <doc:term>3</doc:term><doc:definition>Lithium iron phosphate</doc:definition>
767 </doc:item>
768 <doc:item>
769 <doc:term>4</doc:term><doc:definition>Lead acid</doc:definition>
770 </doc:item>
771 <doc:item>
772 <doc:term>5</doc:term><doc:definition>Nickel cadmium</doc:definition>
773 </doc:item>
774 <doc:item>
775 <doc:term>6</doc:term><doc:definition>Nickel metal hydride</doc:definition>
776 </doc:item>
777 </doc:list>
778 <doc:para>
779 This property is only valid if the property
780 <doc:ref type="property" to="Source:Type">type</doc:ref>
781 has the value "battery".
782 </doc:para>
783 </doc:description>
784 </doc:doc>
785 </property>
786
787 <property name="WarningLevel" type="u" access="read">
788 <doc:doc>
789 <doc:description>
790 <doc:para>
791 Warning level of the battery:
792 </doc:para>
793 <doc:list>
794 <doc:item>
795 <doc:term>0</doc:term><doc:definition>Unknown</doc:definition>
796 </doc:item>
797 <doc:item>
798 <doc:term>1</doc:term><doc:definition>None</doc:definition>
799 </doc:item>
800 <doc:item>
801 <doc:term>2</doc:term><doc:definition>Discharging (only for UPSes)</doc:definition>
802 </doc:item>
803 <doc:item>
804 <doc:term>3</doc:term><doc:definition>Low</doc:definition>
805 </doc:item>
806 <doc:item>
807 <doc:term>4</doc:term><doc:definition>Critical</doc:definition>
808 </doc:item>
809 <doc:item>
810 <doc:term>5</doc:term><doc:definition>Action</doc:definition>
811 </doc:item>
812 </doc:list>
813 </doc:description>
814 </doc:doc>
815 </property>
816
817 <property name="BatteryLevel" type="u" access="read">
818 <doc:doc>
819 <doc:description>
820 <doc:para>
821 The level of the battery for devices which do not report a percentage but rather a coarse battery level. If the value
822 is None, then the device does not support coarse battery reporting, and the percentage should be used instead.
823 </doc:para>
824 <doc:list>
825 <doc:item>
826 <doc:term>0</doc:term><doc:definition>Unknown</doc:definition>
827 </doc:item>
828 <doc:item>
829 <doc:term>1</doc:term><doc:definition>None (the battery does not use a coarse level of battery reporting)</doc:definition>
830 </doc:item>
831 <doc:item>
832 <doc:term>3</doc:term><doc:definition>Low</doc:definition>
833 </doc:item>
834 <doc:item>
835 <doc:term>4</doc:term><doc:definition>Critical</doc:definition>
836 </doc:item>
837 <doc:item>
838 <doc:term>6</doc:term><doc:definition>Normal</doc:definition>
839 </doc:item>
840 <doc:item>
841 <doc:term>7</doc:term><doc:definition>High</doc:definition>
842 </doc:item>
843 <doc:item>
844 <doc:term>8</doc:term><doc:definition>Full</doc:definition>
845 </doc:item>
846 </doc:list>
847 </doc:description>
848 </doc:doc>
849 </property>
850
851 <property name="IconName" type="s" access="read">
852 <doc:doc>
853 <doc:description>
854 <doc:para>
855 <p>An icon name, following the <a href="http://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html">Icon Naming Specification</a></p>
856 <p>Note that the icons might not match end-user expectations in terms of presentation relative to the amount of battery left or perceived to be left. It is recommended that front-ends use the BatteryLevel property first, if available, followed by the Percentage, to present a more realistic battery level to the user.</p>
857 </doc:para>
858 </doc:description>
859 </doc:doc>
860 </property>
861
862 <property name="ChargeStartThreshold" type="u" access="read">
863 <doc:doc>
864 <doc:description>
865 <doc:para>
866 <p>When a start charge threshold is set the battery won't get charged until the charge drops under this threshold.</p>
867 <p>In general case, ChargeStartThreshold is between 0 and 100. If it is G_MAXUINT, upower will skip to set charge_control_start_threshold.</p>
868 </doc:para>
869 </doc:description>
870 </doc:doc>
871 </property>
872
873 <property name="ChargeEndThreshold" type="u" access="read">
874 <doc:doc>
875 <doc:description>
876 <doc:para>
877 <p>The end charge threshold stops the battery from getting charged after the set threshold</p>
878 <p>In general case, ChargeEndThreshold is between 0 and 100. If it is G_MAXUINT, upower will skip to set charge_control_end_threshold.</p>
879 </doc:para>
880 </doc:description>
881 </doc:doc>
882 </property>
883
884 <property name="ChargeThresholdEnabled" type="b" access="read">
885 <doc:doc>
886 <doc:description>
887 <doc:para>
888 <p>If battery charge start and end limits are applied.</p>
889 </doc:para>
890 </doc:description>
891 </doc:doc>
892 </property>
893
894 <property name="ChargeThresholdSupported" type="b" access="read">
895 <doc:doc>
896 <doc:description>
897 <doc:para>
898 <p>If setting battery charge limits is supported.</p>
899 </doc:para>
900 </doc:description>
901 </doc:doc>
902 </property>
903
904 <property name="ChargeThresholdSettingsSupported" type="u" access="read">
905 <doc:doc>
906 <doc:description>
907 <doc:para>The types of settings for charge thresholds that are supported. The value is a bitmask value and it is the sum of the supported types.</doc:para>
908 <doc:list>
909 <doc:item>
910 <doc:term>1</doc:term><doc:definition>The system supports charge start threshold. The battery discharges to a percentage, then starts charging.</doc:definition>
911 </doc:item>
912 <doc:item>
913 <doc:term>2</doc:term><doc:definition>The system supports charge end threshold. The battery charges to a percentage, then stops charging.</doc:definition>
914 </doc:item>
915 <doc:item>
916 <doc:term>4</doc:term><doc:definition>The system supports optimized charging behaviors controlled by the system firmware.</doc:definition>
917 </doc:item>
918 </doc:list>
919 <doc:para>Examples:</doc:para>
920 <doc:para>If the system supports charge start threshold and charge end threshold, the value is 3. If the system supports charge end threshold and the battery charging behavior is controlled by the system firmware, the value is 6.</doc:para>
921 </doc:description>
922 </doc:doc>
923 </property>
924 <property name="VoltageMinDesign" type="d" access="read">
925 <doc:doc>
926 <doc:description>
927 <doc:para>
928 The minimum design voltage of the battery, as reported by the kernel.
929 </doc:para>
930 </doc:description>
931 </doc:doc>
932 </property>
933
934 <property name="VoltageMaxDesign" type="d" access="read">
935 <doc:doc>
936 <doc:description>
937 <doc:para>
938 The maximum design voltage of the battery, as reported by the kernel.
939 </doc:para>
940 </doc:description>
941 </doc:doc>
942 </property>
943
944 <property name="CapacityLevel" type="s" access="read">
945 <annotation name="org.freedesktop.DBus.Deprecated" value="true"/>
946 <doc:doc>
947 <doc:description>
948 <doc:para>
949 Coarse representation of battery capacity. The value is one of the following:
950 </doc:para>
951 <doc:list>
952 <doc:item>
953 <doc:term>Unknown</doc:term>
954 </doc:item>
955 <doc:item>
956 <doc:term>Critical</doc:term>
957 </doc:item>
958 <doc:item>
959 <doc:term>Low</doc:term>
960 </doc:item>
961 <doc:item>
962 <doc:term>Normal</doc:term>
963 </doc:item>
964 <doc:item>
965 <doc:term>High</doc:term>
966 </doc:item>
967 <doc:item>
968 <doc:term>Full</doc:term>
969 </doc:item>
970 </doc:list>
971 <doc:para>
972 DEPRECATED
973 </doc:para>
974 <doc:para>
975 This property is deprecated since it is duplicated from the 'BatteryLevel' property.
976 </doc:para>
977 </doc:description>
978 </doc:doc>
979 </property>
980 </interface>
981
982 </node>