ModularSensors > Classes > Variable > Modem_BatteryState
ModularSensors > Modules > Modem Variables > Modem_BatteryState


Modem_BatteryState class

The Variable sub-class used for the battery charge state measured by a modem.

Whether or not this value is meaningful depends on the specific modem subclass and the wiring of the logger setup.

The value is dimensionless and has a resolution of 1.

Base classes

class Variable
The variable class for a value and related metadata.

Constructors, destructors, conversion operators

Modem_BatteryState(loggerModem* parentModem, const char* uuid = "", const char* varCode = MODEM_BATTERY_STATE_DEFAULT_CODE) explicit
Construct a new Modem_BatteryState object.
~Modem_BatteryState()
Destroy the Modem_BatteryState object - no action needed.

Function documentation

Modem_BatteryState(loggerModem* parentModem, const char* uuid = "", const char* varCode = MODEM_BATTERY_STATE_DEFAULT_CODE) explicit

Construct a new Modem_BatteryState object.

Parameters
parentModem The parent modem providing the result values.
uuid A universally unique identifier (UUID or GUID) for the variable; optional with the default value of an empty string.
varCode A short code to help identify the variable in files; optional with a default value of "modemBatteryCS".