Sygaldry
•All Classes Functions Variables Typedefs Enumerations Modules Pages Concepts
Static Public Member Functions | List of all members
sygaldry::range_< _min, _max, _init > Struct Template Reference
sygah: Sygaldry Helpers | sygah: Sygaldry Helpers » sygah-endpoints: Endpoints Helpers » sygah-endpoints: Endpoints Bases

Document the expected minimum, maximum, and initial value of an endpoint. More...

Inheritance diagram for sygaldry::range_< _min, _max, _init >:
sygaldry::array_message<"sensor to global quaternion", 4, "quaternion representation of the orientation of the sensor in the global frame", float, -1.0f, 1.0f > sygaldry::array_message<"global to sensor quaternion", 4, "quaternion representation of the orientation of the global bases in the sensor frame", float, -1.0f, 1.0f > sygaldry::array_message<"sensor to global matrix", 9, "special orthogonal matrix of the sensor basis vectors expressed in the global frame", float, -1.0f, 1.0f > sygaldry::array_message<"global to sensor matrix", 9, "special orthogonal matrix of the global basis vectors expressed in the sensor frame", float, -1.0f, 1.0f > sygaldry::slider<"instantaneous current", "mA", float > sygaldry::slider<"average current", "mA", float > sygaldry::slider<"capacity", "current capacity (mAh)", int > sygaldry::slider<"full capacity", "full capacity of the battery (mAh)", int > sygaldry::slider<"norm of gravity", "estimated strength of gravity relative to one standard gravity (9.80665 m/s/s)", float, 0.995f, 1.002f > sygaldry::slider<"magnetometer sensitivity", "uT/LSB", float, 0.15f, 0.15f > sygaldry::tag_session_data > sygaldry::toggle<"sygaldry::sygbe::WiFi connected", "Indicates when sygaldry::sygbe::WiFi is successfully connected"> sygaldry::toggle<"AP running", "Indicates when the device-hosted network is running"> sygaldry::toggle<"server running"> sygaldry::toggle<"output running"> sygaldry::toggle<"present", "Shows if battery is present"> sygaldry::toggle<"running", "Indicitor for if the fuel gauge is running"> sygaldry::toggle<"debounced state", "updates only when the sygaldry::button state has changed since the last tick"> sygaldry::toggle<"calibrate magnetometer", "enable tracking magnetometer data to estimate and remove sensor bias; " "the previous bias estimate is reset when compensation is enabled" > sygaldry::toggle<"stationary", "boolean indication of whether the sensor is stationary (1) or movement is detected (0)" > sygaldry::toggle<"running"> sygaldry::array< name_str, N, desc, T, min, max, init, Tags > sygaldry::array_message< name_str, N, desc, T, min, max, init, Tags > sygaldry::button< name_str, desc, init, Tags > sygaldry::slider< name_str, desc, T, min, max, init, Tags > sygaldry::slider_message< name_str, desc, T, min, max, init, Tags > sygaldry::toggle< name_str, desc, init, Tags >

Static Public Member Functions

static _consteval auto range ()
 Returns a struct with min, max, and init members containing the range.
 
static _consteval auto min ()
 Returns the minimum value of the range.
 
static _consteval auto max ()
 Returns the maximum value of the range.
 
static _consteval auto init ()
 Returns the initial value of the range.
 

Detailed Description

template<num_literal _min, num_literal _max, num_literal _init = _min>
struct sygaldry::range_< _min, _max, _init >

Document the expected minimum, maximum, and initial value of an endpoint.

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