org.freedesktop.DeviceKit.Power.Device

org.freedesktop.DeviceKit.Power.Device — Device interface

Methods

Refresh       ()
GetHistory    (in  's'      type,
               in  'u'      timespan,
               out 'a(uds)' data)
GetStatistics (in  's'      type,
               out 'a(dd)'  data)

Signals

Changed ()

Implemented Interfaces

Objects implementing org.freedesktop.DeviceKit.Power.Device also implements org.freedesktop.DBus.Introspectable, org.freedesktop.DBus.Properties

Properties

'native-path'        read      's'
'vendor'             read      's'
'model'              read      's'
'serial'             read      's'
'update-time'        read      't'
'type'               read      's'
'power-supply'       read      'b'
'online'             read      'b'
'energy'             read      'd'
'energy-empty'       read      'd'
'energy-full'        read      'd'
'energy-full-design' read      'd'
'energy-rate'        read      'd'
'time-to-empty'      read      'x'
'time-to-full'       read      'x'
'percentage'         read      'd'
'is-present'         read      'b'
'state'              read      's'
'is-rechargeable'    read      'b'
'capacity'           read      'd'
'technology'         read      's'

Description

TODO: some explanatory text etc. etc. Mention that we collect history to provide more precise values of time-to-empty, time-to-full. Go into detail with the algorithms.

Unless otherwise noted, an empty string or the value 0 in a property means not set.

Details

Refresh ()

Refresh ()

Refreshes the data collected from the power source.

Errors

org.freedesktop.DeviceKit.Power.Device.GeneralError:

 if an error occured while refreshing

Permissions

Callers need the org.freedesktop.devicekit.power.refresh-power-source authorization

GetHistory ()

GetHistory (in  's'      type,
            in  'u'      timespan,
            out 'a(uds)' data)

Gets history for the power device that is persistent across reboots.

type:

 The type of history. Valid types are rate or charge.

timespan:

 The amount of data to return in seconds, or 0 for all.

data:

 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.

GetStatistics ()

GetStatistics (in  's'     type,
               out 'a(dd)' data)

Gets statistics for the power device that may be interesting to show on a graph in the session.

type:

 The mode for the statistics. Valid types are charging or discharging.

data:

 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.

Signal Details

The Changed signal

Changed ()

Some value on the power source changed.

Property Details

The "native-path" property

'native-path'  read      's'

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.

The "vendor" property

'vendor'  read      's'

Name of the vendor of the battery.

The "model" property

'model'  read      's'

Name of the model of this battery.

The "serial" property

'serial'  read      's'

Unique serial number of the battery.

The "update-time" property

'update-time'  read      't'

The point in time (seconds since the Epoch Jan 1, 1970 0:00 UTC) that data was read from the power source.

The "type" property

'type'  read      's'

Type of power source. Known values are "battery" and "line-power".

The "power-supply" property

'power-supply'  read      'b'

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.

The "online" property

'online'  read      'b'

Whether power is currently being provided through line power. This property is only valid if the property type has the value "line-power".

The "energy" property

'energy'  read      'd'

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".

The "energy-empty" property

'energy-empty'  read      'd'

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".

The "energy-full" property

'energy-full'  read      'd'

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".

The "energy-full-design" property

'energy-full-design'  read      'd'

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".

The "energy-rate" property

'energy-rate'  read      'd'

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".

The "time-to-empty" property

'time-to-empty'  read      'x'

Number of seconds until the power source is considered empty. Is set to -1 if unknown.

This property is only valid if the property type has the value "battery".

The "time-to-full" property

'time-to-full'  read      'x'

Number of seconds until the power source is considered full. Is set to -1 if unknown.

This property is only valid if the property type has the value "battery".

The "percentage" property

'percentage'  read      'd'

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 "is-present" property

'is-present'  read      'b'

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 "state" property

'state'  read      's'

The battery power state. Known values are "fully-charged", "empty", "charging", "discharging" or "unknown".

This property is only valid if the property type has the value "battery".

The "is-rechargeable" property

'is-rechargeable'  read      'b'

If the power source is rechargeable.

This property is only valid if the property type has the value "battery".

The "capacity" property

'capacity'  read      'd'

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".

The "technology" property

'technology'  read      's'

Technology used in the battery; known values are "lithium-ion", "lead-acid", "lithium-polymer", "nickel-metal-hydride", "lithium-iron-phosphate" or "unknown".

This property is only valid if the property type has the value "battery".

Generated by GTK-Doc V1.10