DeviceNameHelperRK
Data Fields
DeviceNameHelperData Struct Reference

Data typically stored in retained memory or EEPROM to avoid having to fetch the name so often. More...

#include <DeviceNameHelperRK.h>

Data Fields

uint32_t magic
 Magic bytes, DeviceNameHelper::DATA_MAGIC. More...
 
uint8_t size
 Size of this structure, currently 44 bytes. Used to detect when it changes to invalidate the old version.
 
uint8_t flags
 Flag bits, not currently used. Currently 0.
 
uint16_t reserved
 Reserved for future use, currently 0.
 
long lastCheck
 Last time the name was checked from Time.now() (seconds past January 1, 1970, UTC).
 
char name [DEVICENAMEHELPER_MAX_NAME_LEN+1]
 The device name.
 

Detailed Description

Data typically stored in retained memory or EEPROM to avoid having to fetch the name so often.

This structure is currently 44 bytes. It cannot be larger than 255 bytes because the length is stored in a uint8_t. If the structure size is changed, any previously saved data will be discarded and the name fetched again.

Also note that DEVICENAMEHELPER_MAX_NAME_LEN affects the size of this structure.

Field Documentation

◆ magic

uint32_t DeviceNameHelperData::magic

Magic bytes, DeviceNameHelper::DATA_MAGIC.

This value (0x7787a2f2) is used to see if the structure has been initialized


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