Gjsify LogoGjsify Logo

Hierarchy

Index

Properties

capacity?: number

The percentage capacity of the device where 100% means the device has the same charge potential as when it was manufactured.

energy?: number

The energy left in the device. Measured in mWh.

energy_empty?: number

The energy the device will have when it is empty. This is usually zero. Measured in mWh.

energy_full?: number

The amount of energy when the device is fully charged. Measured in mWh.

energy_full_design?: number

The amount of energy when the device was brand new. Measured in mWh.

energy_rate?: number

The rate of discharge or charge. Measured in mW.

has_history?: boolean

If the device has history data that might be useful.

has_statistics?: boolean

If the device has statistics data that might be useful.

icon_name?: string

The icon name, following the Icon Naming Speficiation

is_present?: boolean

If the device is present, as some devices like laptop batteries can be removed, leaving an empty bay that is still technically a device.

is_rechargeable?: boolean

If the device has a rechargable battery.

kind?: number

The device kind, e.g. %UP_DEVICE_KIND_KEYBOARD.

luminosity?: number

The current luminosity of the device.

model?: string

The model of the device.

native_path?: string

The native path of the device, useful for direct device access.

online?: boolean

If the device is online, i.e. connected.

percentage?: number

The percentage charge of the device.

power_supply?: boolean

If the device is powering the system.

serial?: string

The serial number of the device.

state?: number

The state the device is in at this time, e.g. %UP_DEVICE_STATE_EMPTY.

technology?: number

The battery technology e.g. %UP_DEVICE_TECHNOLOGY_LITHIUM_ION.

temperature?: number

The temperature of the device in degrees Celsius.

time_to_empty?: number

The amount of time until the device is empty.

time_to_full?: number

The amount of time until the device is fully charged.

update_time?: number

The last time the device was updated.

vendor?: string

The vendor of the device.

voltage?: number

The current voltage of the device.

warning_level?: number

The warning level e.g. %UP_DEVICE_LEVEL_WARNING.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method