Modules#

Coulomb Counter

Coulomb Counter#

API and Callbacks for the Coulomb Counter Component.

Approximates energy consumption by keeping time spent in different device states. This is used for testing.

API#

uint16_t

emberAfPluginCommandCoulombCounterGetCurrentCoreMode(void)

Return the current core mode.

uint16_t

emberAfPluginCommandCoulombCounterGetAdditiveModesBitfield(void)

Return the current state of all additive modes.

uint32_t

emberAfPluginCommandCoulombCounterGetEnergyUsage(void)

Return the cumulative energy usage metric since last value reset.

void

emberAfPluginCommandCoulombCounterResetEnergyUsage(void)

Reset the energy usage metric.

Enumerations#

enum

EmberAfPluginCoulombCounterCoreMode {

EMBER_AF_PLUGIN_COULOMB_COUNTER_RADIO_MODE_RX_SHIFT = 0

EMBER_AF_PLUGIN_COULOMB_COUNTER_RADIO_MODE_TX_SHIFT = 1

EMBER_AF_PLUGIN_COULOMB_COUNTER_CORE_MODE_SLEEP_SHIFT = 2

EMBER_AF_PLUGIN_COULOMB_COUNTER_CORE_MODE_IDLE_SHIFT = 3

EMBER_AF_PLUGIN_COULOMB_COUNTER_CORE_MODE_AWAKE_SHIFT = 4

EMBER_AF_PLUGIN_COULOMB_COUNTER_EEPROM_STATE_SHIFT = 5

EMBER_AF_PLUGIN_COULOMB_COUNTER_CORE_MODE_MAX = 32

}

Macros#

#define

COULOMB_COUNTER_MAX_NB_USER_DEFINED_ADDITIVE_STATES (16U)

#define

EMBER_AF_PLUGIN_COULOMB_COUNTER_RADIO_MODE_RX (1U << EMBER_AF_PLUGIN_COULOMB_COUNTER_RADIO_MODE_RX_SHIFT)

Radio in Idle state Radio in Receive state

#define

EMBER_AF_PLUGIN_COULOMB_COUNTER_RADIO_MODE_TX (1U << EMBER_AF_PLUGIN_COULOMB_COUNTER_RADIO_MODE_TX_SHIFT)

Radio in Transmit state

#define

EMBER_AF_PLUGIN_COULOMB_COUNTER_CORE_MODE_SLEEP (1U << EMBER_AF_PLUGIN_COULOMB_COUNTER_CORE_MODE_SLEEP_SHIFT)

#define

EMBER_AF_PLUGIN_COULOMB_COUNTER_CORE_MODE_IDLE (1U << EMBER_AF_PLUGIN_COULOMB_COUNTER_CORE_MODE_IDLE_SHIFT)

#define

EMBER_AF_PLUGIN_COULOMB_COUNTER_CORE_MODE_AWAKE (1U << EMBER_AF_PLUGIN_COULOMB_COUNTER_CORE_MODE_AWAKE_SHIFT)

#define

EMBER_AF_PLUGIN_COULOMB_COUNTER_RADIO_EVENT_MASK (0x03U)

A mask representing all Radio state options <bit1:bit0>

#define

EMBER_AF_PLUGIN_COULOMB_COUNTER_EM_MODE_MASK (0x1CU)

A mask representing all EM mode options <bit4:bit2>

#define

EMBER_AF_PLUGIN_COULOMB_COUNTER_EEPROM_MODE_MASK (0x1E0U)

A mask representing all EEPROM mode options <bit8:bit5>

#define

EMBER_AF_PLUGIN_COULOMB_COUNTER_MASK (0xFFFFU)

#define

EMBER_AF_PLUGIN_COULOMB_COUNTER_USER_DEF_STATES undefined

API Documentation#

emberAfPluginCommandCoulombCounterGetCurrentCoreMode#

uint16_t emberAfPluginCommandCoulombCounterGetCurrentCoreMode (void )

Return the current core mode.

Parameters

Type	Direction	Argument Name	Description
void	N/A

Returns the current core mode of the system. The core mode is the basis for energy consumption measurements. Each core mode is mutually exclusive.

Returns

the current core mode.

emberAfPluginCommandCoulombCounterGetAdditiveModesBitfield#

uint16_t emberAfPluginCommandCoulombCounterGetAdditiveModesBitfield (void )

Return the current state of all additive modes.

Parameters

Type	Direction	Argument Name	Description
void	N/A

Returns the current state of all additive modes. All bits raised in the bitfield indicate that the state is current 'On'.

Returns

the current additive modes bitfield.

emberAfPluginCommandCoulombCounterGetEnergyUsage#

uint32_t emberAfPluginCommandCoulombCounterGetEnergyUsage (void )

Return the cumulative energy usage metric since last value reset.

Parameters

Type	Direction	Argument Name	Description
void	N/A

Returns the cumulative energy usage metric since last value reset. This value is in the same unit as all other provided values and is persisted until explicitly reset.

Returns

the currently recorded energy usage.

emberAfPluginCommandCoulombCounterResetEnergyUsage#

void emberAfPluginCommandCoulombCounterResetEnergyUsage (void )

Reset the energy usage metric.

Parameters

Type	Direction	Argument Name	Description
void	N/A

Resets the energy usage metric. This calls clears both the volatile and non volatile values.

Enumeration Documentation#

EmberAfPluginCoulombCounterCoreMode#

EmberAfPluginCoulombCounterCoreMode

Enumerator
EMBER_AF_PLUGIN_COULOMB_COUNTER_RADIO_MODE_RX_SHIFT
EMBER_AF_PLUGIN_COULOMB_COUNTER_RADIO_MODE_TX_SHIFT
EMBER_AF_PLUGIN_COULOMB_COUNTER_CORE_MODE_SLEEP_SHIFT
EMBER_AF_PLUGIN_COULOMB_COUNTER_CORE_MODE_IDLE_SHIFT
EMBER_AF_PLUGIN_COULOMB_COUNTER_CORE_MODE_AWAKE_SHIFT
EMBER_AF_PLUGIN_COULOMB_COUNTER_EEPROM_STATE_SHIFT
EMBER_AF_PLUGIN_COULOMB_COUNTER_CORE_MODE_MAX

Macro Definition Documentation#

COULOMB_COUNTER_MAX_NB_USER_DEFINED_ADDITIVE_STATES#

#define COULOMB_COUNTER_MAX_NB_USER_DEFINED_ADDITIVE_STATES

Value:

(16U)

EMBER_AF_PLUGIN_COULOMB_COUNTER_RADIO_MODE_RX#

#define EMBER_AF_PLUGIN_COULOMB_COUNTER_RADIO_MODE_RX

Value:

(1U << EMBER_AF_PLUGIN_COULOMB_COUNTER_RADIO_MODE_RX_SHIFT)

Radio in Idle state Radio in Receive state

EMBER_AF_PLUGIN_COULOMB_COUNTER_RADIO_MODE_TX#

#define EMBER_AF_PLUGIN_COULOMB_COUNTER_RADIO_MODE_TX

Value:

(1U << EMBER_AF_PLUGIN_COULOMB_COUNTER_RADIO_MODE_TX_SHIFT)

Radio in Transmit state

EMBER_AF_PLUGIN_COULOMB_COUNTER_CORE_MODE_SLEEP#

#define EMBER_AF_PLUGIN_COULOMB_COUNTER_CORE_MODE_SLEEP

Value:

(1U << EMBER_AF_PLUGIN_COULOMB_COUNTER_CORE_MODE_SLEEP_SHIFT)

EMBER_AF_PLUGIN_COULOMB_COUNTER_CORE_MODE_IDLE#

#define EMBER_AF_PLUGIN_COULOMB_COUNTER_CORE_MODE_IDLE

Value:

(1U << EMBER_AF_PLUGIN_COULOMB_COUNTER_CORE_MODE_IDLE_SHIFT)

EMBER_AF_PLUGIN_COULOMB_COUNTER_CORE_MODE_AWAKE#

#define EMBER_AF_PLUGIN_COULOMB_COUNTER_CORE_MODE_AWAKE

Value:

(1U << EMBER_AF_PLUGIN_COULOMB_COUNTER_CORE_MODE_AWAKE_SHIFT)

EMBER_AF_PLUGIN_COULOMB_COUNTER_RADIO_EVENT_MASK#

#define EMBER_AF_PLUGIN_COULOMB_COUNTER_RADIO_EVENT_MASK

Value:

(0x03U)

A mask representing all Radio state options <bit1:bit0>

EMBER_AF_PLUGIN_COULOMB_COUNTER_EM_MODE_MASK#

#define EMBER_AF_PLUGIN_COULOMB_COUNTER_EM_MODE_MASK

Value:

(0x1CU)

A mask representing all EM mode options <bit4:bit2>

EMBER_AF_PLUGIN_COULOMB_COUNTER_EEPROM_MODE_MASK#

#define EMBER_AF_PLUGIN_COULOMB_COUNTER_EEPROM_MODE_MASK

Value:

(0x1E0U)

A mask representing all EEPROM mode options <bit8:bit5>

EMBER_AF_PLUGIN_COULOMB_COUNTER_MASK#

#define EMBER_AF_PLUGIN_COULOMB_COUNTER_MASK

Value:

(0xFFFFU)

EMBER_AF_PLUGIN_COULOMB_COUNTER_USER_DEF_STATES#

#define EMBER_AF_PLUGIN_COULOMB_COUNTER_USER_DEF_STATES

Value:

(EMBER_AF_PLUGIN_COULOMB_COUNTER_MASK \

<< COULOMB_COUNTER_MAX_NB_USER_DEFINED_ADDITIVE_STATES)