ra8_batt_monitor_t Struct Reference

Caller-owned nag state carried across ra8_batt_update calls. More...

#include <ra8_batt.h>

Data Fields
bool	low_raised
	Low nag raised and not yet re-armed.
bool	critical_raised
	Critical nag raised and not yet re-armed.

Detailed Description

Caller-owned nag state carried across ra8_batt_update calls.

Zero-initialise with ra8_batt_monitor_init before the first update. The two flags record which bands have already nagged and not yet re-armed, so each warning is one-shot per descent into its band.

Invariant

A flag is true only between the band's nag and its re-arm.

Definition at line 85 of file ra8_batt.h.

Field Documentation

critical_raised

bool ra8_batt_monitor_t::critical_raised

Critical nag raised and not yet re-armed.

Definition at line 87 of file ra8_batt.h.

Referenced by ra8_batt_monitor_init(), and ra8_batt_update().

low_raised

bool ra8_batt_monitor_t::low_raised

Low nag raised and not yet re-armed.

Definition at line 86 of file ra8_batt.h.

Referenced by ra8_batt_monitor_init(), and ra8_batt_update().

---

The documentation for this struct was generated from the following file:

• libs/ra8_batt/inc/ra8_batt.h