/usr/share/dbus-1/interfaces
Edit: /usr/share/dbus-1/interfaces/org.freedesktop.UPower.Device.xml (27251B)
]>
Objects implementing this interface are usually discovered through
the org.freedesktop.UPower interface on
the /org/freedesktop/UPower object on
the D-Bus system bus service with the well-known
name org.freedesktop.UPower using
the
EnumerateDevices
method.
$ 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
)
]
Unless otherwise noted, an empty string or the value 0 in a
property on this interface means not set.
Refreshes the data collected from the power source.
Callers need the org.freedesktop.upower.refresh-power-source authorization
if an error occured while refreshing
The type of history.
Valid types are rate or charge.
The amount of data to return in seconds, or 0 for all.
The approximate number of points to return.
A higher resolution is more accurate, at the expense of plotting speed.
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:
time
The time value in seconds from the gettimeofday() method.
value
The data value, for instance the rate in W or the charge in %.
state
The state of the device, for instance charging or
discharging.
Gets history for the power device that is persistent across reboots.
The mode for the statistics.
Valid types are charging or discharging.
The statistics data for the power device.
Each element contains the following members:
value
The value of the percentage point, usually in seconds
accuracy
The accuracy of the prediction in percent.
Gets statistics for the power device that may be interesting
to show on a graph in the session.
OS specific native path of the power source. On Linux this
is the sysfs path, for
example /sys/devices/LNXSYSTM:00/device:00/PNP0C0A:00/power_supply/BAT0. Is
blank if the device is being driven by a user space
driver.
Name of the vendor of the battery.
Name of the model of this battery.
Unique serial number of the battery.
The point in time (seconds since the Epoch Jan 1, 1970
0:00 UTC) that data was read from the power source.
Type of power source.
0Unknown
1Line Power
2Battery
3Ups
4Monitor
5Mouse
6Keyboard
7Pda
8Phone
If the value is set to "Battery", you will need to verify that the
property power-supply
has the value "true" before considering it as a laptop battery. Otherwise it
will likely be the battery for a device of an unknown type.
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.
If the power device has history.
If the power device has statistics.
Whether power is currently being provided through line power.
This property is only valid if the property
type
has the value "line-power".
Amount of energy (measured in Wh) currently available in
the power source.
This property is only valid if the property
type
has the value "battery".
Amount of energy (measured in Wh) in the power source when
it's considered to be empty.
This property is only valid if the property
type
has the value "battery".
Amount of energy (measured in Wh) in the power source when
it's considered full.
This property is only valid if the property
type
has the value "battery".
Amount of energy (measured in Wh) the power source is
designed to hold when it's considered full.
This property is only valid if the property
type
has the value "battery".
Amount of energy being drained from the source, measured
in W. If positive, the source is being discharged, if
negative it's being charged.
This property is only valid if the property
type
has the value "battery".
Voltage in the Cell or being recorded by the meter.
The number of charge cycles as defined by the TCO certification, or -1 if
that value is unknown or not applicable.
Luminosity being recorded by the meter.
Number of seconds until the power source is considered empty.
Is set to 0 if unknown.
This property is only valid if the property
type
has the value "battery".
Number of seconds until the power source is considered full.
Is set to 0 if unknown.
This property is only valid if the property
type
has the value "battery".
The amount of energy left in the power source expressed as
a percentage between 0 and 100. Typically this is the same as
(energy -
energy-empty) /
(energy-full -
energy-empty).
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.
This property is only valid if the property
type
has the value "battery".
The percentage will be an approximation if the battery level
is set to something other than None. The percentage is kept for compatibility reasons.
The temperature of the device in degrees Celsius. This property is
only valid if the property
type
has the value "battery".
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.
This property is only valid if the property
type
has the value "battery".
The battery power state.
0Unknown
1Charging
2Discharging
3Empty
4Fully charged
5Pending charge
6Pending discharge
This property is only valid if the property
type
has the value "battery".
If the power source is rechargeable.
This property is only valid if the property
type
has the value "battery".
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
(full-design /
full) * 100.
However, some primitive power sources are not capable reporting capacity
and in this case the capacity property will be unset.
This property is only valid if the property
type
has the value "battery".
Technology used in the battery:
0Unknown
1Lithium ion
2Lithium polymer
3Lithium iron phosphate
4Lead acid
5Nickel cadmium
6Nickel metal hydride
This property is only valid if the property
type
has the value "battery".
Warning level of the battery:
0Unknown
1None
2Discharging (only for UPSes)
3Low
4Critical
5Action
The level of the battery for devices which do not report a percentage but rather a coarse battery level. If the value
is None, then the device does not support coarse battery reporting, and the percentage should be used instead.
0Unknown
1None (the battery does not use a coarse level of battery reporting)
3Low
4Critical
6Normal
7High
8Full
An icon name, following the Icon Naming Specification
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.