/usr/share/gtk-doc/html/UPower/Device.html is in upower-doc 0.9.15-3git1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.freedesktop.UPower.Device</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="UPower Reference Manual">
<link rel="up" href="ref-dbus.html" title="D-Bus API Reference">
<link rel="prev" href="UPower.html" title="org.freedesktop.UPower">
<link rel="next" href="QoS.html" title="org.freedesktop.UPower.QoS">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="UPower.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ref-dbus.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">UPower Reference Manual</th>
<td><a accesskey="n" href="QoS.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#Device.synopsis" class="shortcut">Top</a>
|
<a href="#Device.description" class="shortcut">Description</a>
|
<a href="#Device.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#Device.properties" class="shortcut">Properties</a>
|
<a href="#Device.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="Device"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle">org.freedesktop.UPower.Device</span></h2>
<p>org.freedesktop.UPower.Device — Device interface</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Methods</h2>
<pre class="synopsis"><a class="link" href="Device.html#Device.Refresh">Refresh</a> ()
<a class="link" href="Device.html#Device.GetHistory">GetHistory</a> (in 's' type,
in 'u' timespan,
in 'u' resolution,
out 'a(udu)' data)
<a class="link" href="Device.html#Device.GetStatistics">GetStatistics</a> (in 's' type,
out 'a(dd)' data)
</pre>
</div>
<div class="refsect1">
<a name="idp4435400"></a><h2>Signals</h2>
<pre class="synopsis"><a class="link" href="Device.html#Device::Changed">Changed</a> ()
</pre>
</div>
<div class="refsect1">
<a name="idp4952048"></a><h2>Implemented Interfaces</h2>
<p>
Objects implementing org.freedesktop.UPower.Device also implements
org.freedesktop.DBus.Introspectable,
org.freedesktop.DBus.Properties
</p>
</div>
<div class="refsect1">
<a name="idp3663096"></a><h2>Properties</h2>
<pre class="synopsis"><a class="link" href="Device.html#Device:NativePath">'NativePath'</a> read 's'
<a class="link" href="Device.html#Device:Vendor">'Vendor'</a> read 's'
<a class="link" href="Device.html#Device:Model">'Model'</a> read 's'
<a class="link" href="Device.html#Device:Serial">'Serial'</a> read 's'
<a class="link" href="Device.html#Device:UpdateTime">'UpdateTime'</a> read 't'
<a class="link" href="Device.html#Device:Type">'Type'</a> read 'u'
<a class="link" href="Device.html#Device:PowerSupply">'PowerSupply'</a> read 'b'
<a class="link" href="Device.html#Device:HasHistory">'HasHistory'</a> read 'b'
<a class="link" href="Device.html#Device:HasStatistics">'HasStatistics'</a> read 'b'
<a class="link" href="Device.html#Device:Online">'Online'</a> read 'b'
<a class="link" href="Device.html#Device:Energy">'Energy'</a> read 'd'
<a class="link" href="Device.html#Device:EnergyEmpty">'EnergyEmpty'</a> read 'd'
<a class="link" href="Device.html#Device:EnergyFull">'EnergyFull'</a> read 'd'
<a class="link" href="Device.html#Device:EnergyFullDesign">'EnergyFullDesign'</a> read 'd'
<a class="link" href="Device.html#Device:EnergyRate">'EnergyRate'</a> read 'd'
<a class="link" href="Device.html#Device:Voltage">'Voltage'</a> read 'd'
<a class="link" href="Device.html#Device:TimeToEmpty">'TimeToEmpty'</a> read 'x'
<a class="link" href="Device.html#Device:TimeToFull">'TimeToFull'</a> read 'x'
<a class="link" href="Device.html#Device:Percentage">'Percentage'</a> read 'd'
<a class="link" href="Device.html#Device:IsPresent">'IsPresent'</a> read 'b'
<a class="link" href="Device.html#Device:State">'State'</a> read 'u'
<a class="link" href="Device.html#Device:IsRechargeable">'IsRechargeable'</a> read 'b'
<a class="link" href="Device.html#Device:Capacity">'Capacity'</a> read 'd'
<a class="link" href="Device.html#Device:Technology">'Technology'</a> read 'u'
<a class="link" href="Device.html#Device:RecallNotice">'RecallNotice'</a> read 'b'
<a class="link" href="Device.html#Device:RecallVendor">'RecallVendor'</a> read 's'
<a class="link" href="Device.html#Device:RecallUrl">'RecallUrl'</a> read 's'
</pre>
</div>
<div class="refsect1">
<a name="idp5303160"></a><h2>Description</h2>
<p>
</p>
<p>
Objects implementing this interface are usually discovered through
the <code class="literal">org.freedesktop.UPower</code> interface on
the <code class="literal">/org/freedesktop/UPower</code> object on
the D-Bus system bus service with the well-known
name <code class="literal">org.freedesktop.UPower</code> using
the
<code class="function">EnumerateDevices</code>
method.
</p>
<p>
</p>
<p>
</p>
<div class="informalexample"><pre class="programlisting">
$ 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
)
]
</pre></div>
<p>
</p>
<p>
</p>
<p>
Unless otherwise noted, an empty string or the value 0 in a
property on this interface means not set.
</p>
<p>
</p>
</div>
<div class="refsect1">
<a name="idp5309944"></a><h2>Details</h2>
<div class="refsect2">
<a name="idp5310432"></a><h3>
<a name="Device.Refresh"></a>Refresh ()</h3>
<pre class="programlisting">Refresh ()</pre>
</div>
<p>
Refreshes the data collected from the power source.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
<div class="refsect3">
<a name="idp4282544"></a><h4>Errors</h4>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>org.freedesktop.UPower.Device.GeneralError</code></em>:</span></p></td>
<td>if an error occured while refreshing</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="idp4283616"></a><h4>Permissions</h4>
<p class="permission">Callers need the org.freedesktop.upower.refresh-power-source authorization</p>
</div>
<hr>
<div class="refsect2">
<a name="idp4284168"></a><h3>
<a name="Device.GetHistory"></a>GetHistory ()</h3>
<pre class="programlisting">GetHistory (in 's' type,
in 'u' timespan,
in 'u' resolution,
out 'a(udu)' data)</pre>
</div>
<p>
Gets history for the power device that is persistent across reboots.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em>:</span></p></td>
<td>The type of history.
Valid types are <code class="literal">rate</code> or <code class="literal">charge</code>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>timespan</code></em>:</span></p></td>
<td>The amount of data to return in seconds, or 0 for all.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>resolution</code></em>:</span></p></td>
<td>
The approximate number of points to return.
A higher resolution is more accurate, at the expense of plotting speed.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em>:</span></p></td>
<td>
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:
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<span class="bold"><strong>time: </strong></span>
The time value in seconds from the <code class="literal">gettimeofday()</code> method.
</li>
<li class="listitem">
<span class="bold"><strong>value: </strong></span>
The data value, for instance the rate in W or the charge in %.
</li>
<li class="listitem">
<span class="bold"><strong>state: </strong></span>
The state of the device, for instance <code class="literal">charging</code> or
<code class="literal">discharging</code>.
</li>
</ul></div>
</td>
</tr>
</tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp4292936"></a><h3>
<a name="Device.GetStatistics"></a>GetStatistics ()</h3>
<pre class="programlisting">GetStatistics (in 's' type,
out 'a(dd)' data)</pre>
</div>
<p>
Gets statistics for the power device that may be interesting
to show on a graph in the session.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em>:</span></p></td>
<td>The mode for the statistics.
Valid types are <code class="literal">charging</code> or <code class="literal">discharging</code>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em>:</span></p></td>
<td>
The statistics data for the power device.
Each element contains the following members:
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<span class="bold"><strong>value: </strong></span>
The value of the percentage point, usually in seconds
</li>
<li class="listitem">
<span class="bold"><strong>accuracy: </strong></span>
The accuracy of the prediction in percent.
</li>
</ul></div>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="idp3215288"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="idp3215784"></a><h3>
<a name="Device::Changed"></a>The Changed signal</h3>
<pre class="programlisting">Changed ()</pre>
</div>
<p>
Some value on the power source changed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="idp3217784"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="idp3218264"></a><h3>
<a name="Device:NativePath"></a>The "NativePath" property</h3>
<pre class="programlisting">'NativePath' read 's'
</pre>
</div>
<p>
OS specific native path of the power source. On Linux this
is the sysfs path, for
example <code class="literal">/sys/devices/LNXSYSTM:00/device:00/PNP0C0A:00/power_supply/BAT0</code>. Is
blank if the device is being driven by a user space
driver.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp3220752"></a><h3>
<a name="Device:Vendor"></a>The "Vendor" property</h3>
<pre class="programlisting">'Vendor' read 's'
</pre>
</div>
<p>
Name of the vendor of the battery.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp3222624"></a><h3>
<a name="Device:Model"></a>The "Model" property</h3>
<pre class="programlisting">'Model' read 's'
</pre>
</div>
<p>
Name of the model of this battery.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp3224496"></a><h3>
<a name="Device:Serial"></a>The "Serial" property</h3>
<pre class="programlisting">'Serial' read 's'
</pre>
</div>
<p>
Unique serial number of the battery.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp3226376"></a><h3>
<a name="Device:UpdateTime"></a>The "UpdateTime" property</h3>
<pre class="programlisting">'UpdateTime' read 't'
</pre>
</div>
<p>
The point in time (seconds since the Epoch Jan 1, 1970
0:00 UTC) that data was read from the power source.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp3228376"></a><h3>
<a name="Device:Type"></a>The "Type" property</h3>
<pre class="programlisting">'Type' read 'u'
</pre>
</div>
<p>
Type of power source.
</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<span class="bold"><strong>0: </strong></span>Unknown</li>
<li class="listitem">
<span class="bold"><strong>1: </strong></span>Line Power</li>
<li class="listitem">
<span class="bold"><strong>2: </strong></span>Battery</li>
<li class="listitem">
<span class="bold"><strong>3: </strong></span>Ups</li>
<li class="listitem">
<span class="bold"><strong>4: </strong></span>Monitor</li>
<li class="listitem">
<span class="bold"><strong>5: </strong></span>Mouse</li>
<li class="listitem">
<span class="bold"><strong>6: </strong></span>Keyboard</li>
<li class="listitem">
<span class="bold"><strong>7: </strong></span>Pda</li>
<li class="listitem">
<span class="bold"><strong>8: </strong></span>Phone</li>
</ul></div>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp3234272"></a><h3>
<a name="Device:PowerSupply"></a>The "PowerSupply" property</h3>
<pre class="programlisting">'PowerSupply' read 'b'
</pre>
</div>
<p>
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.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp3236328"></a><h3>
<a name="Device:HasHistory"></a>The "HasHistory" property</h3>
<pre class="programlisting">'HasHistory' read 'b'
</pre>
</div>
<p>
If the power device has history.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp3238240"></a><h3>
<a name="Device:HasStatistics"></a>The "HasStatistics" property</h3>
<pre class="programlisting">'HasStatistics' read 'b'
</pre>
</div>
<p>
If the power device has statistics.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp3240152"></a><h3>
<a name="Device:Online"></a>The "Online" property</h3>
<pre class="programlisting">'Online' read 'b'
</pre>
</div>
<p>
Whether power is currently being provided through line power.
This property is only valid if the property
<code class="literal">type</code>
has the value "line-power".
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp3242712"></a><h3>
<a name="Device:Energy"></a>The "Energy" property</h3>
<pre class="programlisting">'Energy' read 'd'
</pre>
</div>
<p>
Amount of energy (measured in Wh) currently available in
the power source.
</p>
<p>
This property is only valid if the property
<code class="literal">type</code>
has the value "battery".
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp3245448"></a><h3>
<a name="Device:EnergyEmpty"></a>The "EnergyEmpty" property</h3>
<pre class="programlisting">'EnergyEmpty' read 'd'
</pre>
</div>
<p>
Amount of energy (measured in Wh) in the power source when
it's considered to be empty.
</p>
<p>
This property is only valid if the property
<code class="literal">type</code>
has the value "battery".
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp3248232"></a><h3>
<a name="Device:EnergyFull"></a>The "EnergyFull" property</h3>
<pre class="programlisting">'EnergyFull' read 'd'
</pre>
</div>
<p>
Amount of energy (measured in Wh) in the power source when
it's considered full.
</p>
<p>
This property is only valid if the property
<code class="literal">type</code>
has the value "battery".
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp3251016"></a><h3>
<a name="Device:EnergyFullDesign"></a>The "EnergyFullDesign" property</h3>
<pre class="programlisting">'EnergyFullDesign' read 'd'
</pre>
</div>
<p>
Amount of energy (measured in Wh) the power source is
designed to hold when it's considered full.
</p>
<p>
This property is only valid if the property
<code class="literal">type</code>
has the value "battery".
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp3253816"></a><h3>
<a name="Device:EnergyRate"></a>The "EnergyRate" property</h3>
<pre class="programlisting">'EnergyRate' read 'd'
</pre>
</div>
<p>
Amount of energy being drained from the source, measured
in W. If positive, the source is being discharged, if
negative it's being charged.
</p>
<p>
This property is only valid if the property
<code class="literal">type</code>
has the value "battery".
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp3256664"></a><h3>
<a name="Device:Voltage"></a>The "Voltage" property</h3>
<pre class="programlisting">'Voltage' read 'd'
</pre>
</div>
<p>
Voltage in the Cell or being recorded by the meter.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp3258552"></a><h3>
<a name="Device:TimeToEmpty"></a>The "TimeToEmpty" property</h3>
<pre class="programlisting">'TimeToEmpty' read 'x'
</pre>
</div>
<p>
Number of seconds until the power source is considered empty.
Is set to 0 if unknown.
</p>
<p>
This property is only valid if the property
<code class="literal">type</code>
has the value "battery".
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp3261336"></a><h3>
<a name="Device:TimeToFull"></a>The "TimeToFull" property</h3>
<pre class="programlisting">'TimeToFull' read 'x'
</pre>
</div>
<p>
Number of seconds until the power source is considered full.
Is set to 0 if unknown.
</p>
<p>
This property is only valid if the property
<code class="literal">type</code>
has the value "battery".
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp3264120"></a><h3>
<a name="Device:Percentage"></a>The "Percentage" property</h3>
<pre class="programlisting">'Percentage' read 'd'
</pre>
</div>
<p>
The amount of energy left in the power source expressed as
a percentage between 0 and 100. Typically this is the same as
(<code class="literal">energy</code> -
<code class="literal">energy-empty</code>) /
(<code class="literal">energy-full</code> -
<code class="literal">energy-empty</code>).
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.
</p>
<p>
This property is only valid if the property
<code class="literal">type</code>
has the value "battery".
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp3269464"></a><h3>
<a name="Device:IsPresent"></a>The "IsPresent" property</h3>
<pre class="programlisting">'IsPresent' read 'b'
</pre>
</div>
<p>
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.
</p>
<p>
This property is only valid if the property
<code class="literal">type</code>
has the value "battery".
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp3272288"></a><h3>
<a name="Device:State"></a>The "State" property</h3>
<pre class="programlisting">'State' read 'u'
</pre>
</div>
<p>
The battery power state.
</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<span class="bold"><strong>0: </strong></span>Unknown</li>
<li class="listitem">
<span class="bold"><strong>1: </strong></span>Charging</li>
<li class="listitem">
<span class="bold"><strong>2: </strong></span>Discharging</li>
<li class="listitem">
<span class="bold"><strong>3: </strong></span>Empty</li>
<li class="listitem">
<span class="bold"><strong>4: </strong></span>Fully charged</li>
<li class="listitem">
<span class="bold"><strong>5: </strong></span>Pending charge</li>
<li class="listitem">
<span class="bold"><strong>6: </strong></span>Pending discharge</li>
</ul></div>
<p>
This property is only valid if the property
<code class="literal">type</code>
has the value "battery".
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp3278240"></a><h3>
<a name="Device:IsRechargeable"></a>The "IsRechargeable" property</h3>
<pre class="programlisting">'IsRechargeable' read 'b'
</pre>
</div>
<p>
If the power source is rechargeable.
</p>
<p>
This property is only valid if the property
<code class="literal">type</code>
has the value "battery".
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp3280968"></a><h3>
<a name="Device:Capacity"></a>The "Capacity" property</h3>
<pre class="programlisting">'Capacity' read 'd'
</pre>
</div>
<p>
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
(<code class="literal">full-design</code> /
<code class="literal">full</code>) * 100.
However, some primitive power sources are not capable reporting capacity
and in this case the capacity property will be unset.
</p>
<p>
This property is only valid if the property
<code class="literal">type</code>
has the value "battery".
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp3285200"></a><h3>
<a name="Device:Technology"></a>The "Technology" property</h3>
<pre class="programlisting">'Technology' read 'u'
</pre>
</div>
<p>
Technology used in the battery:
</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<span class="bold"><strong>0: </strong></span>Unknown</li>
<li class="listitem">
<span class="bold"><strong>1: </strong></span>Lithium ion</li>
<li class="listitem">
<span class="bold"><strong>2: </strong></span>Lithium polymer</li>
<li class="listitem">
<span class="bold"><strong>3: </strong></span>Lithium iron phosphate</li>
<li class="listitem">
<span class="bold"><strong>4: </strong></span>Lead acid</li>
<li class="listitem">
<span class="bold"><strong>5: </strong></span>Nickel cadmium</li>
<li class="listitem">
<span class="bold"><strong>6: </strong></span>Nickel metal hydride</li>
</ul></div>
<p>
This property is only valid if the property
<code class="literal">type</code>
has the value "battery".
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp3291160"></a><h3>
<a name="Device:RecallNotice"></a>The "RecallNotice" property</h3>
<pre class="programlisting">'RecallNotice' read 'b'
</pre>
</div>
<p>
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.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp3293304"></a><h3>
<a name="Device:RecallVendor"></a>The "RecallVendor" property</h3>
<pre class="programlisting">'RecallVendor' read 's'
</pre>
</div>
<p>
The vendor that is handling the hardware recall.
</p>
<p>
This property is only valid if the property recall-notice is true.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp3295544"></a><h3>
<a name="Device:RecallUrl"></a>The "RecallUrl" property</h3>
<pre class="programlisting">'RecallUrl' read 's'
</pre>
</div>
<p>
The URL to visit about the hardware recall.
</p>
<p>
This property is only valid if the property recall-notice is true.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|