sensesp::SKZone Struct Reference

A single Signal K metadata zone. More...

#include <sensesp/signalk/signalk_metadata_listener.h>

Public Attributes
bool	has_lower = false
float	lower = 0.0f
bool	has_upper = false
float	upper = 0.0f
String	state
	e.g. "nominal", "alarm", "warn", "alert", "emergency"
String	message
	optional human-readable message

Detailed Description

A single Signal K metadata zone.

Zones describe value ranges and the alarm state associated with each (used e.g. to colour a gauge). A path may define several. has_lower/has_upper distinguish an open-ended zone (no bound) from one bounded at 0.

See also

https://signalk.org/specification/1.7.0/doc/data_model_metadata.html

Definition at line 24 of file signalk_metadata_listener.h.

Member Data Documentation

has_lower

bool sensesp::SKZone::has_lower = false

Definition at line 25 of file signalk_metadata_listener.h.

has_upper

bool sensesp::SKZone::has_upper = false

Definition at line 27 of file signalk_metadata_listener.h.

lower

float sensesp::SKZone::lower = 0.0f

Definition at line 26 of file signalk_metadata_listener.h.

message

String sensesp::SKZone::message

optional human-readable message

Definition at line 30 of file signalk_metadata_listener.h.

state

String sensesp::SKZone::state

e.g. "nominal", "alarm", "warn", "alert", "emergency"

Definition at line 29 of file signalk_metadata_listener.h.

upper

float sensesp::SKZone::upper = 0.0f

Definition at line 28 of file signalk_metadata_listener.h.

---

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

• src/sensesp/signalk/signalk_metadata_listener.h