Differential D20655 Diff 56501 src/solid/devices/backends/upower/dbus/org.freedesktop.UPower.Device.xml
Changeset View
Changeset View
Standalone View
Standalone View
src/solid/devices/backends/upower/dbus/org.freedesktop.UPower.Device.xml
- This file was added.
| 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 need the org.freedesktop.upower.refresh-power-source authorization</doc:permission> | ||||
| 150 | <doc:errors> | ||||
| 151 | <doc:error name="&ERROR_GENERAL;">if an error occured while refreshing</doc:error> | ||||
| 152 | </doc:errors> | ||||
| 153 | </doc:doc> | ||||
| 154 | </method> | ||||
| 155 | | ||||
| 156 | <!-- GetHistory and GetStatistics removed from this file | ||||
| 157 | as they are not used by Solid and would require us to add | ||||
| 158 | custom marshalling structs "a(udu)" that we wouldn't use anyway --> | ||||
| 159 | | ||||
| 160 | <!-- ************************************************************ --> | ||||
| 161 | <property name="NativePath" type="s" access="read"> | ||||
| 162 | <doc:doc> | ||||
| 163 | <doc:description> | ||||
| 164 | <doc:para> | ||||
| 165 | OS specific native path of the power source. On Linux this | ||||
| 166 | is the sysfs path, for | ||||
| 167 | example <doc:tt>/sys/devices/LNXSYSTM:00/device:00/PNP0C0A:00/power_supply/BAT0</doc:tt>. Is | ||||
| 168 | blank if the device is being driven by a user space | ||||
| 169 | driver. | ||||
| 170 | </doc:para> | ||||
| 171 | </doc:description> | ||||
| 172 | </doc:doc> | ||||
| 173 | </property> | ||||
| 174 | | ||||
| 175 | <property name="Vendor" type="s" access="read"> | ||||
| 176 | <doc:doc> | ||||
| 177 | <doc:description> | ||||
| 178 | <doc:para> | ||||
| 179 | Name of the vendor of the battery. | ||||
| 180 | </doc:para> | ||||
| 181 | </doc:description> | ||||
| 182 | </doc:doc> | ||||
| 183 | </property> | ||||
| 184 | | ||||
| 185 | <property name="Model" type="s" access="read"> | ||||
| 186 | <doc:doc> | ||||
| 187 | <doc:description> | ||||
| 188 | <doc:para> | ||||
| 189 | Name of the model of this battery. | ||||
| 190 | </doc:para> | ||||
| 191 | </doc:description> | ||||
| 192 | </doc:doc> | ||||
| 193 | </property> | ||||
| 194 | | ||||
| 195 | <property name="Serial" type="s" access="read"> | ||||
| 196 | <doc:doc> | ||||
| 197 | <doc:description> | ||||
| 198 | <doc:para> | ||||
| 199 | Unique serial number of the battery. | ||||
| 200 | </doc:para> | ||||
| 201 | </doc:description> | ||||
| 202 | </doc:doc> | ||||
| 203 | </property> | ||||
| 204 | | ||||
| 205 | <property name="UpdateTime" type="t" access="read"> | ||||
| 206 | <doc:doc> | ||||
| 207 | <doc:description> | ||||
| 208 | <doc:para> | ||||
| 209 | The point in time (seconds since the Epoch Jan 1, 1970 | ||||
| 210 | 0:00 UTC) that data was read from the power source. | ||||
| 211 | </doc:para> | ||||
| 212 | </doc:description> | ||||
| 213 | </doc:doc> | ||||
| 214 | </property> | ||||
| 215 | | ||||
| 216 | <property name="Type" type="u" access="read"> | ||||
| 217 | <doc:doc> | ||||
| 218 | <doc:description> | ||||
| 219 | <doc:para> | ||||
| 220 | Type of power source. | ||||
| 221 | </doc:para> | ||||
| 222 | <doc:list> | ||||
| 223 | <doc:item> | ||||
| 224 | <doc:term>0</doc:term><doc:definition>Unknown</doc:definition> | ||||
| 225 | </doc:item> | ||||
| 226 | <doc:item> | ||||
| 227 | <doc:term>1</doc:term><doc:definition>Line Power</doc:definition> | ||||
| 228 | </doc:item> | ||||
| 229 | <doc:item> | ||||
| 230 | <doc:term>2</doc:term><doc:definition>Battery</doc:definition> | ||||
| 231 | </doc:item> | ||||
| 232 | <doc:item> | ||||
| 233 | <doc:term>3</doc:term><doc:definition>Ups</doc:definition> | ||||
| 234 | </doc:item> | ||||
| 235 | <doc:item> | ||||
| 236 | <doc:term>4</doc:term><doc:definition>Monitor</doc:definition> | ||||
| 237 | </doc:item> | ||||
| 238 | <doc:item> | ||||
| 239 | <doc:term>5</doc:term><doc:definition>Mouse</doc:definition> | ||||
| 240 | </doc:item> | ||||
| 241 | <doc:item> | ||||
| 242 | <doc:term>6</doc:term><doc:definition>Keyboard</doc:definition> | ||||
| 243 | </doc:item> | ||||
| 244 | <doc:item> | ||||
| 245 | <doc:term>7</doc:term><doc:definition>Pda</doc:definition> | ||||
| 246 | </doc:item> | ||||
| 247 | <doc:item> | ||||
| 248 | <doc:term>8</doc:term><doc:definition>Phone</doc:definition> | ||||
| 249 | </doc:item> | ||||
| 250 | </doc:list> | ||||
| 251 | </doc:description> | ||||
| 252 | </doc:doc> | ||||
| 253 | </property> | ||||
| 254 | | ||||
| 255 | <property name="PowerSupply" type="b" access="read"> | ||||
| 256 | <doc:doc> | ||||
| 257 | <doc:description> | ||||
| 258 | <doc:para> | ||||
| 259 | If the power device is used to supply the system. | ||||
| 260 | This would be set TRUE for laptop batteries and UPS devices, | ||||
| 261 | but set FALSE for wireless mice or PDAs. | ||||
| 262 | </doc:para> | ||||
| 263 | </doc:description> | ||||
| 264 | </doc:doc> | ||||
| 265 | </property> | ||||
| 266 | | ||||
| 267 | <property name="HasHistory" type="b" access="read"> | ||||
| 268 | <doc:doc> | ||||
| 269 | <doc:description> | ||||
| 270 | <doc:para> | ||||
| 271 | If the power device has history. | ||||
| 272 | </doc:para> | ||||
| 273 | </doc:description> | ||||
| 274 | </doc:doc> | ||||
| 275 | </property> | ||||
| 276 | | ||||
| 277 | <property name="HasStatistics" type="b" access="read"> | ||||
| 278 | <doc:doc> | ||||
| 279 | <doc:description> | ||||
| 280 | <doc:para> | ||||
| 281 | If the power device has statistics. | ||||
| 282 | </doc:para> | ||||
| 283 | </doc:description> | ||||
| 284 | </doc:doc> | ||||
| 285 | </property> | ||||
| 286 | | ||||
| 287 | <property name="Online" type="b" access="read"> | ||||
| 288 | <doc:doc> | ||||
| 289 | <doc:description> | ||||
| 290 | <doc:para> | ||||
| 291 | Whether power is currently being provided through line power. | ||||
| 292 | This property is only valid if the property | ||||
| 293 | <doc:ref type="property" to="Source:Type">type</doc:ref> | ||||
| 294 | has the value "line-power". | ||||
| 295 | </doc:para> | ||||
| 296 | </doc:description> | ||||
| 297 | </doc:doc> | ||||
| 298 | </property> | ||||
| 299 | | ||||
| 300 | <property name="Energy" type="d" access="read"> | ||||
| 301 | <doc:doc> | ||||
| 302 | <doc:description> | ||||
| 303 | <doc:para> | ||||
| 304 | Amount of energy (measured in Wh) currently available in | ||||
| 305 | the power source. | ||||
| 306 | </doc:para><doc:para> | ||||
| 307 | This property is only valid if the property | ||||
| 308 | <doc:ref type="property" to="Source:Type">type</doc:ref> | ||||
| 309 | has the value "battery". | ||||
| 310 | </doc:para> | ||||
| 311 | </doc:description> | ||||
| 312 | </doc:doc> | ||||
| 313 | </property> | ||||
| 314 | | ||||
| 315 | <property name="EnergyEmpty" type="d" access="read"> | ||||
| 316 | <doc:doc> | ||||
| 317 | <doc:description> | ||||
| 318 | <doc:para> | ||||
| 319 | Amount of energy (measured in Wh) in the power source when | ||||
| 320 | it's considered to be empty. | ||||
| 321 | </doc:para><doc:para> | ||||
| 322 | This property is only valid if the property | ||||
| 323 | <doc:ref type="property" to="Source:Type">type</doc:ref> | ||||
| 324 | has the value "battery". | ||||
| 325 | </doc:para> | ||||
| 326 | </doc:description> | ||||
| 327 | </doc:doc> | ||||
| 328 | </property> | ||||
| 329 | | ||||
| 330 | <property name="EnergyFull" type="d" access="read"> | ||||
| 331 | <doc:doc> | ||||
| 332 | <doc:description> | ||||
| 333 | <doc:para> | ||||
| 334 | Amount of energy (measured in Wh) in the power source when | ||||
| 335 | it's considered full. | ||||
| 336 | </doc:para><doc:para> | ||||
| 337 | This property is only valid if the property | ||||
| 338 | <doc:ref type="property" to="Source:Type">type</doc:ref> | ||||
| 339 | has the value "battery". | ||||
| 340 | </doc:para> | ||||
| 341 | </doc:description> | ||||
| 342 | </doc:doc> | ||||
| 343 | </property> | ||||
| 344 | | ||||
| 345 | <property name="EnergyFullDesign" type="d" access="read"> | ||||
| 346 | <doc:doc> | ||||
| 347 | <doc:description> | ||||
| 348 | <doc:para> | ||||
| 349 | Amount of energy (measured in Wh) the power source is | ||||
| 350 | designed to hold when it's considered full. | ||||
| 351 | </doc:para><doc:para> | ||||
| 352 | This property is only valid if the property | ||||
| 353 | <doc:ref type="property" to="Source:Type">type</doc:ref> | ||||
| 354 | has the value "battery". | ||||
| 355 | </doc:para> | ||||
| 356 | </doc:description> | ||||
| 357 | </doc:doc> | ||||
| 358 | </property> | ||||
| 359 | | ||||
| 360 | <property name="EnergyRate" type="d" access="read"> | ||||
| 361 | <doc:doc> | ||||
| 362 | <doc:description> | ||||
| 363 | <doc:para> | ||||
| 364 | Amount of energy being drained from the source, measured | ||||
| 365 | in W. If positive, the source is being discharged, if | ||||
| 366 | negative it's being charged. | ||||
| 367 | </doc:para><doc:para> | ||||
| 368 | This property is only valid if the property | ||||
| 369 | <doc:ref type="property" to="Source:Type">type</doc:ref> | ||||
| 370 | has the value "battery". | ||||
| 371 | </doc:para> | ||||
| 372 | </doc:description> | ||||
| 373 | </doc:doc> | ||||
| 374 | </property> | ||||
| 375 | | ||||
| 376 | <property name="Voltage" type="d" access="read"> | ||||
| 377 | <doc:doc> | ||||
| 378 | <doc:description> | ||||
| 379 | <doc:para> | ||||
| 380 | Voltage in the Cell or being recorded by the meter. | ||||
| 381 | </doc:para> | ||||
| 382 | </doc:description> | ||||
| 383 | </doc:doc> | ||||
| 384 | </property> | ||||
| 385 | | ||||
| 386 | <property name="Luminosity" type="d" access="read"> | ||||
| 387 | <doc:doc> | ||||
| 388 | <doc:description> | ||||
| 389 | <doc:para> | ||||
| 390 | Luminosity being recorded by the meter. | ||||
| 391 | </doc:para> | ||||
| 392 | </doc:description> | ||||
| 393 | </doc:doc> | ||||
| 394 | </property> | ||||
| 395 | | ||||
| 396 | <property name="TimeToEmpty" type="x" access="read"> | ||||
| 397 | <doc:doc> | ||||
| 398 | <doc:description> | ||||
| 399 | <doc:para> | ||||
| 400 | Number of seconds until the power source is considered empty. | ||||
| 401 | Is set to 0 if unknown. | ||||
| 402 | </doc:para><doc:para> | ||||
| 403 | This property is only valid if the property | ||||
| 404 | <doc:ref type="property" to="Source:Type">type</doc:ref> | ||||
| 405 | has the value "battery". | ||||
| 406 | </doc:para> | ||||
| 407 | </doc:description> | ||||
| 408 | </doc:doc> | ||||
| 409 | </property> | ||||
| 410 | | ||||
| 411 | <property name="TimeToFull" type="x" access="read"> | ||||
| 412 | <doc:doc> | ||||
| 413 | <doc:description> | ||||
| 414 | <doc:para> | ||||
| 415 | Number of seconds until the power source is considered full. | ||||
| 416 | Is set to 0 if unknown. | ||||
| 417 | </doc:para><doc:para> | ||||
| 418 | This property is only valid if the property | ||||
| 419 | <doc:ref type="property" to="Source:Type">type</doc:ref> | ||||
| 420 | has the value "battery". | ||||
| 421 | </doc:para> | ||||
| 422 | </doc:description> | ||||
| 423 | </doc:doc> | ||||
| 424 | </property> | ||||
| 425 | | ||||
| 426 | <property name="Percentage" type="d" access="read"> | ||||
| 427 | <doc:doc> | ||||
| 428 | <doc:description> | ||||
| 429 | <doc:para> | ||||
| 430 | The amount of energy left in the power source expressed as | ||||
| 431 | a percentage between 0 and 100. Typically this is the same as | ||||
| 432 | (<doc:ref type="property" to="Source:Energy">energy</doc:ref> - | ||||
| 433 | <doc:ref type="property" to="Source:EnergyEmpty">energy-empty</doc:ref>) / | ||||
| 434 | (<doc:ref type="property" to="Source:EnergyFull">energy-full</doc:ref> - | ||||
| 435 | <doc:ref type="property" to="Source:EnergyEmpty">energy-empty</doc:ref>). | ||||
| 436 | However, some primitive power sources are capable of only | ||||
| 437 | reporting percentages and in this case the energy-* | ||||
| 438 | properties will be unset while this property is set. | ||||
| 439 | </doc:para><doc:para> | ||||
| 440 | This property is only valid if the property | ||||
| 441 | <doc:ref type="property" to="Source:Type">type</doc:ref> | ||||
| 442 | has the value "battery". | ||||
| 443 | </doc:para> | ||||
| 444 | <doc:para> | ||||
| 445 | The percentage will be an approximation if the <doc:ref type="property" to="BatteryLevel">battery level</doc:ref> | ||||
| 446 | is set to something other than None. The percentage is kept for compatibility reasons. | ||||
| 447 | </doc:para> | ||||
| 448 | </doc:description> | ||||
| 449 | </doc:doc> | ||||
| 450 | </property> | ||||
| 451 | | ||||
| 452 | <property name="Temperature" type="d" access="read"> | ||||
| 453 | <doc:doc> | ||||
| 454 | <doc:description> | ||||
| 455 | <doc:para> | ||||
| 456 | The temperature of the device in degrees Celsius. This property is | ||||
| 457 | only valid if the property | ||||
| 458 | <doc:ref type="property" to="Source:Type">type</doc:ref> | ||||
| 459 | has the value "battery". | ||||
| 460 | </doc:para> | ||||
| 461 | </doc:description> | ||||
| 462 | </doc:doc> | ||||
| 463 | </property> | ||||
| 464 | | ||||
| 465 | <property name="IsPresent" type="b" access="read"> | ||||
| 466 | <doc:doc> | ||||
| 467 | <doc:description> | ||||
| 468 | <doc:para> | ||||
| 469 | If the power source is present in the bay. | ||||
| 470 | This field is required as some batteries are hot-removable, for example | ||||
| 471 | expensive UPS and most laptop batteries. | ||||
| 472 | </doc:para><doc:para> | ||||
| 473 | This property is only valid if the property | ||||
| 474 | <doc:ref type="property" to="Source:Type">type</doc:ref> | ||||
| 475 | has the value "battery". | ||||
| 476 | </doc:para> | ||||
| 477 | </doc:description> | ||||
| 478 | </doc:doc> | ||||
| 479 | </property> | ||||
| 480 | | ||||
| 481 | <property name="State" type="u" access="read"> | ||||
| 482 | <doc:doc> | ||||
| 483 | <doc:description> | ||||
| 484 | <doc:para> | ||||
| 485 | The battery power state. | ||||
| 486 | </doc:para> | ||||
| 487 | <doc:list> | ||||
| 488 | <doc:item> | ||||
| 489 | <doc:term>0</doc:term><doc:definition>Unknown</doc:definition> | ||||
| 490 | </doc:item> | ||||
| 491 | <doc:item> | ||||
| 492 | <doc:term>1</doc:term><doc:definition>Charging</doc:definition> | ||||
| 493 | </doc:item> | ||||
| 494 | <doc:item> | ||||
| 495 | <doc:term>2</doc:term><doc:definition>Discharging</doc:definition> | ||||
| 496 | </doc:item> | ||||
| 497 | <doc:item> | ||||
| 498 | <doc:term>3</doc:term><doc:definition>Empty</doc:definition> | ||||
| 499 | </doc:item> | ||||
| 500 | <doc:item> | ||||
| 501 | <doc:term>4</doc:term><doc:definition>Fully charged</doc:definition> | ||||
| 502 | </doc:item> | ||||
| 503 | <doc:item> | ||||
| 504 | <doc:term>5</doc:term><doc:definition>Pending charge</doc:definition> | ||||
| 505 | </doc:item> | ||||
| 506 | <doc:item> | ||||
| 507 | <doc:term>6</doc:term><doc:definition>Pending discharge</doc:definition> | ||||
| 508 | </doc:item> | ||||
| 509 | </doc:list> | ||||
| 510 | <doc:para> | ||||
| 511 | This property is only valid if the property | ||||
| 512 | <doc:ref type="property" to="Source:Type">type</doc:ref> | ||||
| 513 | has the value "battery". | ||||
| 514 | </doc:para> | ||||
| 515 | </doc:description> | ||||
| 516 | </doc:doc> | ||||
| 517 | </property> | ||||
| 518 | | ||||
| 519 | <property name="IsRechargeable" type="b" access="read"> | ||||
| 520 | <doc:doc> | ||||
| 521 | <doc:description> | ||||
| 522 | <doc:para> | ||||
| 523 | If the power source is rechargeable. | ||||
| 524 | </doc:para><doc:para> | ||||
| 525 | This property is only valid if the property | ||||
| 526 | <doc:ref type="property" to="Source:Type">type</doc:ref> | ||||
| 527 | has the value "battery". | ||||
| 528 | </doc:para> | ||||
| 529 | </doc:description> | ||||
| 530 | </doc:doc> | ||||
| 531 | </property> | ||||
| 532 | | ||||
| 533 | <property name="Capacity" type="d" access="read"> | ||||
| 534 | <doc:doc> | ||||
| 535 | <doc:description> | ||||
| 536 | <doc:para> | ||||
| 537 | The capacity of the power source expressed as a percentage between 0 and 100. | ||||
| 538 | The capacity of the battery will reduce with age. | ||||
| 539 | A capacity value less than 75% is usually a sign that you should renew your battery. | ||||
| 540 | Typically this value is the same as | ||||
| 541 | (<doc:ref type="property" to="Source:FullDesign">full-design</doc:ref> / | ||||
| 542 | <doc:ref type="property" to="Source:Full">full</doc:ref>) * 100. | ||||
| 543 | However, some primitive power sources are not capable reporting capacity | ||||
| 544 | and in this case the capacity property will be unset. | ||||
| 545 | </doc:para><doc:para> | ||||
| 546 | This property is only valid if the property | ||||
| 547 | <doc:ref type="property" to="Source:Type">type</doc:ref> | ||||
| 548 | has the value "battery". | ||||
| 549 | </doc:para> | ||||
| 550 | </doc:description> | ||||
| 551 | </doc:doc> | ||||
| 552 | </property> | ||||
| 553 | | ||||
| 554 | <property name="Technology" type="u" access="read"> | ||||
| 555 | <doc:doc> | ||||
| 556 | <doc:description> | ||||
| 557 | <doc:para> | ||||
| 558 | Technology used in the battery: | ||||
| 559 | </doc:para> | ||||
| 560 | <doc:list> | ||||
| 561 | <doc:item> | ||||
| 562 | <doc:term>0</doc:term><doc:definition>Unknown</doc:definition> | ||||
| 563 | </doc:item> | ||||
| 564 | <doc:item> | ||||
| 565 | <doc:term>1</doc:term><doc:definition>Lithium ion</doc:definition> | ||||
| 566 | </doc:item> | ||||
| 567 | <doc:item> | ||||
| 568 | <doc:term>2</doc:term><doc:definition>Lithium polymer</doc:definition> | ||||
| 569 | </doc:item> | ||||
| 570 | <doc:item> | ||||
| 571 | <doc:term>3</doc:term><doc:definition>Lithium iron phosphate</doc:definition> | ||||
| 572 | </doc:item> | ||||
| 573 | <doc:item> | ||||
| 574 | <doc:term>4</doc:term><doc:definition>Lead acid</doc:definition> | ||||
| 575 | </doc:item> | ||||
| 576 | <doc:item> | ||||
| 577 | <doc:term>5</doc:term><doc:definition>Nickel cadmium</doc:definition> | ||||
| 578 | </doc:item> | ||||
| 579 | <doc:item> | ||||
| 580 | <doc:term>6</doc:term><doc:definition>Nickel metal hydride</doc:definition> | ||||
| 581 | </doc:item> | ||||
| 582 | </doc:list> | ||||
| 583 | <doc:para> | ||||
| 584 | This property is only valid if the property | ||||
| 585 | <doc:ref type="property" to="Source:Type">type</doc:ref> | ||||
| 586 | has the value "battery". | ||||
| 587 | </doc:para> | ||||
| 588 | </doc:description> | ||||
| 589 | </doc:doc> | ||||
| 590 | </property> | ||||
| 591 | | ||||
| 592 | <property name="WarningLevel" type="u" access="read"> | ||||
| 593 | <doc:doc> | ||||
| 594 | <doc:description> | ||||
| 595 | <doc:para> | ||||
| 596 | Warning level of the battery: | ||||
| 597 | </doc:para> | ||||
| 598 | <doc:list> | ||||
| 599 | <doc:item> | ||||
| 600 | <doc:term>0</doc:term><doc:definition>Unknown</doc:definition> | ||||
| 601 | </doc:item> | ||||
| 602 | <doc:item> | ||||
| 603 | <doc:term>1</doc:term><doc:definition>None</doc:definition> | ||||
| 604 | </doc:item> | ||||
| 605 | <doc:item> | ||||
| 606 | <doc:term>2</doc:term><doc:definition>Discharging (only for UPSes)</doc:definition> | ||||
| 607 | </doc:item> | ||||
| 608 | <doc:item> | ||||
| 609 | <doc:term>3</doc:term><doc:definition>Low</doc:definition> | ||||
| 610 | </doc:item> | ||||
| 611 | <doc:item> | ||||
| 612 | <doc:term>4</doc:term><doc:definition>Critical</doc:definition> | ||||
| 613 | </doc:item> | ||||
| 614 | <doc:item> | ||||
| 615 | <doc:term>5</doc:term><doc:definition>Action</doc:definition> | ||||
| 616 | </doc:item> | ||||
| 617 | </doc:list> | ||||
| 618 | </doc:description> | ||||
| 619 | </doc:doc> | ||||
| 620 | </property> | ||||
| 621 | | ||||
| 622 | <property name="BatteryLevel" type="u" access="read"> | ||||
| 623 | <doc:doc> | ||||
| 624 | <doc:description> | ||||
| 625 | <doc:para> | ||||
| 626 | The level of the battery for devices which do not report a percentage but rather a coarse battery level. If the value | ||||
| 627 | is None, then the device does not support coarse battery reporting, and the percentage should be used instead. | ||||
| 628 | </doc:para> | ||||
| 629 | <doc:list> | ||||
| 630 | <doc:item> | ||||
| 631 | <doc:term>0</doc:term><doc:definition>Unknown</doc:definition> | ||||
| 632 | </doc:item> | ||||
| 633 | <doc:item> | ||||
| 634 | <doc:term>1</doc:term><doc:definition>None (the battery does not use a coarse level of battery reporting)</doc:definition> | ||||
| 635 | </doc:item> | ||||
| 636 | <doc:item> | ||||
| 637 | <doc:term>3</doc:term><doc:definition>Low</doc:definition> | ||||
| 638 | </doc:item> | ||||
| 639 | <doc:item> | ||||
| 640 | <doc:term>4</doc:term><doc:definition>Critical</doc:definition> | ||||
| 641 | </doc:item> | ||||
| 642 | <doc:item> | ||||
| 643 | <doc:term>6</doc:term><doc:definition>Normal</doc:definition> | ||||
| 644 | </doc:item> | ||||
| 645 | <doc:item> | ||||
| 646 | <doc:term>7</doc:term><doc:definition>High</doc:definition> | ||||
| 647 | </doc:item> | ||||
| 648 | <doc:item> | ||||
| 649 | <doc:term>8</doc:term><doc:definition>Full</doc:definition> | ||||
| 650 | </doc:item> | ||||
| 651 | </doc:list> | ||||
| 652 | </doc:description> | ||||
| 653 | </doc:doc> | ||||
| 654 | </property> | ||||
| 655 | | ||||
| 656 | <property name="IconName" type="s" access="read"> | ||||
| 657 | <doc:doc> | ||||
| 658 | <doc:description> | ||||
| 659 | <doc:para> | ||||
| 660 | <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> | ||||
| 661 | <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> | ||||
| 662 | </doc:para> | ||||
| 663 | </doc:description> | ||||
| 664 | </doc:doc> | ||||
| 665 | </property> | ||||
| 666 | </interface> | ||||
| 667 | | ||||
| 668 | </node> | ||||