ALBattery API

Overview | API

See also

Events

Event: "BatteryPowerPluggedChanged"
callback(std::string eventName, bool plugged, std::string subscriberIdentifier)

Raised when the charger is plugged and unplugged.

Parameters:
  • eventName (std::string) – “BatteryPowerPluggedChanged”
  • plugged – True if plugged-in, false otherwise.
  • subscriberIdentifier (std::string) –
Event: "BatteryChargeCellVoltageMinChanged"
callback(std::string eventName, int voltage, std::string subscriberIdentifier)

Raised when the Minimum cell voltage of the battery changes.

Parameters:
  • eventName (std::string) – “BatteryChargeCellVoltageMinChanged”
  • voltage – The minimum cell voltage.
  • subscriberIdentifier (std::string) –
Event: "BatteryChargingFlagChanged"
callback(std::string eventName, bool charging, std::string subscriberIdentifier)

Raised when the flag “battery is charging” changes.

Parameters:
  • eventName (std::string) – “BatteryChargingFlagChanged”
  • charging – True when the battery is charging, false otherwise.
  • subscriberIdentifier (std::string) –
Event: "BatteryFullChargedFlagChanged"
callback(std::string eventName, bool fullyCharged, std::string subscriberIdentifier)

Raised when the flag “battery is fully charged” changes.

Parameters:
  • eventName (std::string) – “BatteryFullChargedFlagChanged”
  • fullyCharged – True when the battery is fully charged, false otherwise.
  • subscriberIdentifier (std::string) –
Event: "BatteryDisChargingFlagChanged"
callback(std::string eventName, bool isDischarging, std::string subscriberIdentifier)

Raised when the flag “battery is discharging” changes.

Parameters:
  • eventName (std::string) – “BatteryDisChargingFlagChanged”
  • isDischarging – True when the battery is discharging, false otherwise.
  • subscriberIdentifier (std::string) –
Event: "BatteryLevelChanged"
callback(std::string eventName, int percentage, std::string subscriberIdentifier)

Raised when the battery level percentage changes.

Parameters:
  • eventName (std::string) – “BatteryLevelChanged”
  • percentage – The percent of the battery that remains.
  • subscriberIdentifier (std::string) –

Methods

No public methods.

See also

« ALBattery | ALBattery | ALFsr »
« previous | up | next »