Frame content for this beacon. More...

#include <nrfcxx/sd/beacon.hpp>

Data Fields
frame_prefix_s	prefix
	Common prefix for all infrastructure beacons.

uint16_t	pwr_mV
	Measured system power source voltage in millivolts. More...

uint32_t	adv_cnt
	Number of beacons sent since system reset or installation. More...

uint32_t	sec_cnt
	Time since system system reset or installation. More...

uint16_t	reset_cnt
	Low bits of a low-level ARM event counter. More...

uint16_t	sleep_n16
	Relative time spent in sleep mode since reset. More...

uint16_t	radio_n16
	Relative time spent with radio on since reset. More...

uint8_t	optional [0]
	Storage for optional content, presense indicated by the following flags, in this order: More...

Detailed Description

Frame content for this beacon.

Field Documentation

◆ adv_cnt

uint32_t nrfcxx::sd::TelemetryBeacon::frame_s::adv_cnt

Number of beacons sent since system reset or installation.

This value is retained across controlled resets, and is compatible with the Eddystone ADV_CNT field.

See also: FT_FLAG_AGGREGATE_UPTIME

◆ optional

uint8_t nrfcxx::sd::TelemetryBeacon::frame_s::optional[0]

Storage for optional content, presense indicated by the following flags, in this order:

FT_FLAG_HAS_POWER_LEVEL. This flag will be added or not based on FT_FLAG_MAINS_POWER and the availability of a non-zero pwr_mV and a power_level converter.

◆ pwr_mV

uint16_t nrfcxx::sd::TelemetryBeacon::frame_s::pwr_mV

Measured system power source voltage in millivolts.

The value is intended to be compatible with the Eddystone VBATT field. As such, it should be zero on any device that is always mains-powered (FT_FLAG_MAINS_POWER). It should be non-zero on battery-powered devices that are connected to a charging power source.

Note: The value provided here may be the system Vdd measurement, rather than a battery, as indicated by the value of FT_FLAG_PWR_IS_Vdd.

◆ radio_n16

uint16_t nrfcxx::sd::TelemetryBeacon::frame_s::radio_n16

Relative time spent with radio on since reset.

The value is interpreted as the numerator of a fraction with denominator 65536, and represents a multipler of the time since system reset (not power-up) to produce the time spent in a mode with systemState::OM_RADIO set. Values below 0.05% are expected in the steady state.

◆ reset_cnt

uint16_t nrfcxx::sd::TelemetryBeacon::frame_s::reset_cnt

Low bits of a low-level ARM event counter.

This provides the low bits of systemState::wfe_count(), identifying activity that is hard to see in the duty cycle.

◆ sec_cnt

uint32_t nrfcxx::sd::TelemetryBeacon::frame_s::sec_cnt

Time since system system reset or installation.

This value is maintained across controlled resets, and is compatible with the Eddystone SEC_CNT field.

Note: The time is measured in deciseconds.

See also: FT_FLAG_AGGREGATE_UPTIME

◆ sleep_n16

uint16_t nrfcxx::sd::TelemetryBeacon::frame_s::sleep_n16

Relative time spent in sleep mode since reset.

The value is interpreted as the numerator of a fraction with denominator 65536, and represents a multipler of the time since system reset (not power-up) to produce the time spent in a mode with systemState::OM_SLEEP set. Values in excess of 99.5% are expected.

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

nrfcxx/sd/beacon.hpp

Data Fields