Classes
class	AirDensity
	Transforms temperature, relative humidity and pressure in air density. More...

class	AnalogInput
	Sensor for reading the MCU analog input pins. More...

class	AnalogVoltage
	A transform that takes the output of an analog-to-digital converter and outputs the voltage that went into it. (This can be the built-in ADC on the ESP, or it can be an external ADC like the ADS1015/1115.) More...

class	AngleCorrection
	Add a value to an angle input (in radians). The output value is wrapped to a range between [0, 2*pi]. This transform is useful for correcting e.g. a heading or a wind direction reading. More...

class	BaseAnalogReader
	Used by AnalogInput as a hardware abstraction layer. More...

class	BaseBlinker
	A base class for LED blinker classes. More...

class	BaseButtonHandler
	Base class for button handlers. More...

class	ButtonHandler
	Default Button Handler for SensESPApp applications. More...

class	ChangeFilter
	A float passthrough transform that will only pass that value through if it is "sufficiently different" from the last value passed through. More...

class	ClickType
	ClickType is a transform that consumes button clicks and translates them as events of type `ClickTypes`. More...

class	Configurable
	An object that is capable of having configuration data that can be set remotely using a RESTful API, and can be persisted to the local file system. More...

class	ConstantSensor
	Base class for constant value sensors. More...

class	CurveInterpolator
	Implement a piecewise linear interpolation transform. More...

class	DebounceTemplate
	Implements debounce code for a button or switch. More...

class	DebugOutput
	Initialize logging/debug output. More...

class	DewPoint
	Transforms temperature and relative humidity in dew point temperature. More...

class	Difference

class	DigitalInput
	DigitalInput is the base class for reading a digital GPIO pin. More...

class	DigitalInputChange
	DigitalInputChange provides output whenever a digital pin changes its state. More...

class	DigitalInputCounter
	DigitalInputCounter counts interrupts and reports the count every read_delay ms. More...

class	DigitalInputDebounceCounter
	DigitalInputDebounceCounter counts interrupts and reports the count every read_delay ms, but ignores events that happen within ignore_interval_ms. More...

class	DigitalInputState
	DigitalInputState polls the state of an input pin every read_delay ms. More...

class	DigitalOutput
	Sets a GPIO pin to whatever the input is (true = HIGH, false = LOW), and passes the value on to the next ValueConsumer. More...

class	Enable
	On/off switch for signals: input is emitted as-is if the enable flag is set in the web UI. More...

struct	ENUVector
	Container for local tangent plane coordinates. More...

class	ESP32AnalogReader

class	EvenBlinker
	An LED blinker class that blinks the LED 50% off, 50% on, at a given period. More...

class	Filesystem

class	FloatThreshold
	Translates a float value into a boolean value, which depends on whether the float value is "in range" or "out of range". More...

class	FreeMem
	Reports the current amount of unused memory of the ESP. More...

class	Frequency
	Transforms its input into frequency (Hz: cycles per second) More...

class	HeatIndexEffect
	Transforms heat index temperature to heat index effect. More...

class	HeatIndexTemperature
	Transforms temperature and relative humidity in heat index temperature. More...

class	HTTPServer
	Handles external interactions with the device via the web interface. More...

class	Hysteresis
	Hysteresis function. More...

class	IntegratorT
	Integrator integrates (accumulates) the incoming values. More...

class	IntThreshold
	Translates an integer value into a boolean value, which depends on whether the integer value is "in range" or "out of range". More...

class	IPAddrDev
	Reports the IP address of the ESP once it's connected to wifi. More...

class	LambdaConsumer
	Provides an easy way of calling a function based on the output of any ValueProducer. More...

class	LambdaTransform
	Construct a new transform based on a single function. More...

class	Linear
	Performs a linear transform on the input value: output = (input * multiplier) + offset. More...

class	LocalDebug

class	MDNSDiscovery

class	Median
	Outputs the median value of sample_size inputs. More...

class	MinimalButtonHandler
	Minimal Button Handler. More...

class	MovingAverage
	Outputs the moving average of the last sample_size inputs. More...

class	Networking
	Manages the ESP's connection to the Wifi network. More...

class	Observable
	A base class which allow observers to attach callbacks to themselves. The callbacks will be called when the observable needs to notify the observers about some state change. More...

class	ObservableValue
	A value that notifies its observers if it gets changed. More...

class	OTA

struct	ParamInfo

class	PatternBlinker
	A blinker that blinks the LED according to a defined repeating pattern. More...

class	PeriodicBlinker
	A base class for periodic blinkers. More...

struct	Position
	Position data container. More...

class	PressRepeater
	A transform that takes boolean inputs and adds button behaviors familiar to many device end users. More...

class	PWMOutput
	Provides a cross platform mechanism for generating Pulse Width Modulation signals over one or more GPIO pins on the MCU. More...

class	RatioBlinker
	A periodic blinker that defines both the on-ratio and the period length. More...

class	RepeatReport
	Ensures that values that do not change frequently are still reported at a specified maximum silence interval. If the value has not changed in max_silence_interval milliseconds, the current value is emmitted again. More...

class	RepeatSensor

class	Resettable
	Automatic calling of the reset() method when the device needs to be reset. More...

class	ResettableCompare

class	RgbLed
	A special device object that can be used to control a multi-channel color rgb LED light using up to 3 digital output channels. A "color" is defined using the standard 24 bit color depth numbers composed of three 8 bit channels for Red, Green, and Blue (see https://techterms.com/definition/rgb) More...

class	RoundToInt
	Takes as its input a float, rounds it to the nearest whole number, then outputs it as an int. More...

class	SensESPApp

class	SensESPAppBuilder
	A class for quickly configuring a SensESP application object before wiring up your sensors. More...

class	SensESPBaseApp
	The base class for SensESP applications. More...

class	SensESPBaseAppBuilder
	Abstract base class for other SensESP*AppBuilder classes. More...

class	SensESPMinimalApp

class	SensESPMinimalAppBuilder

class	Sensor
	The base class for all sensors. Used only as a base class - never instantiated directly in a project. More...

class	SensorT
	Sensor template class for any sensor producing actual values. More...

class	SKDeltaQueue
	Signal K delta queue. More...

class	SKEmitter
	A class that produces Signal K output to be forwarded to the Signal K server (if the system is connected to one). Signal K is reported via the as_signalK() method. More...

class	SKListener
	An Obervable class that listens for Signal K stream deltas and notifies any observers of value changes. This serves as a base class for code that needs to listen to the stream, with the most common descendant being `SKValueListener` More...

class	SKMetadata
	Holds Signal K meta data that is associated with the sk_path an SKEmitter class may optionally send to the server. According to the official Signal K specification: "All keys in the Signal K specification must have a <tt>description</tt>, and where the key is a numeric value it must have <tt>units</tt>". Thus, any paths that you output that are not already part of the official Signal K specification should have these two fields defined as metadata. More...

class	SKOutput
	A specialized transform whose primary purpose is to output Signal K data on the Signal K network. More...

class	SKOutputNumeric
	A special class for sending numeric values to the Signal K server on a specific Signal K path. More...

class	SKOutputRawJson
	Class for sending raw Json strings on a specific Signal K path. More...

class	SKOutputTime

class	SKPutListener
	An Obervable class that listens for Signal K PUT requests coming over the websocket connection and notifies observers of the change. More...

class	SKPutRequest
	Used to send requests to the server to change the value of the specified path to a specific value according to the specification at https://signalk.org/specification/1.5.0/doc/put.html. More...

class	SKPutRequestBase
	A base class for all template variations of the PUT request class SKPutRequest. This base class keeps the compiler from generating reduntant object code for common functionality of each template version. More...

class	SKPutRequestListener
	An object that listens for PUT requests to come in for the specified SignalK path. The value is then emitted for further processing. More...

class	SKRequest
	A base class for all objects that are capable of sending "requests" to the SignalK server (and optionally receiving the responses) according to the specification located at https://signalk.org/specification/1.5.0/doc/request_response.html. More...

class	SKValueListener
	An ValueProducer that listens to specific Signal K paths and emits its value whenever it changes. More...

class	SmartSwitchController
	A high level transform designed to control a digital output (such as a relay) via manual button presses or programatic commands. More...

class	Startable
	Automatic calling of the start() method at startup. More...

class	StartableCompare

class	SymmetricTransform
	A common type of transform that consumes, transforms, then outputs values of the same data type. More...

class	SystemHz
	Reports the current clock speed of the ESP. More...

class	SystemStatusController
	Base class for a controller that can react to system status events. More...

class	SystemStatusLed
	Consumes the networking and websocket states and delta counts and updates the device LED accordingly. Inherit this class and override the methods to customize the behavior. More...

class	TaskQueueProducer
	Producer class that works across task boundaries. More...

class	TextToTruth
	Consumes a string and outputs boolean "true" if the text represents a human readable version of "true". More...

class	ThresholdTransform
	A Transform base class that translates the value of type C into value of type P. Base class for classes FloatThreshold and IntThreshold. More...

class	TimeCounter
	A transform that outputs the duration of the input value being true or non-null. More...

class	TimeString
	Consumes a time_t time object and produces a human readable string of the time for UTC in ISO 8601 format. More...

class	Transform
	The main Transform class. A transform is identified primarily by the type of value that is produces (i.e. a Transform<float> is a ValueProducer<float> that generates float values) More...

class	TransformBase
	The base class for all transforms. A transforms takes a value in, transforms it in some way, and outputs the transformed value. More...

class	TruthToText
	Consumes a boolean value and outputs one the appropriate truth string specified in the constructor. This is the inverse of TextToTruth. More...

class	Typecast
	Converts input from one data type to another, then outputs the new type. More...

class	UIButton
	UIButton implements a button interface on the web UI. More...

class	UILambdaOutput

class	UIOutput

class	UIOutputBase

class	Uptime
	Reports the number of seconds since the last restart of the ESP. More...

class	ValueConsumer
	A base class for piece of code (like a transform) that accepts data for input. ValueConsumers can accept one or more input values via the set_input() method. They are connected to `ValueProducers` via the `connect_to()` method. More...

class	ValueProducer
	A base class for any sensor or piece of code that outputs a value for consumption elsewhere. More...

class	VoltageDividerR1
	Uses the voltage divider formula to calculate (and output) the resistance of R1 in the circuit. More...

class	VoltageDividerR2
	Uses the voltage divider formula to calculate (and output) the resistance of R2 in the circuit. More...

class	VoltageMultiplier
	OBSOLETE: Since you can now apply an "output_scale" to the AnalogInput sensor, you don't need this transform anymore. See the description of "output_scale" in analog_input.h. More...

class	WiFiSignal
	Reports the current strength of the wifi signal that the ESP is connected to. More...

class	WiFiStateProducer
	Provide information about the current WiFi state. More...

class	WSClient
	The websocket connection to the Signal K server. More...

Typedefs
typedef std::function< void()>	void_cb_func

using	WifiState = WiFiState

typedef ESP32AnalogReader	AnalogReader

typedef ConstantSensor< float >	FloatConstantSensor

typedef ConstantSensor< int >	IntConstantSensor

typedef ConstantSensor< bool >	BoolConstantSensor

typedef ConstantSensor< String >	StringConstantSensor

typedef SensorT< float >	FloatSensor

typedef SensorT< int >	IntSensor

typedef SensorT< bool >	BoolSensor

typedef SensorT< String >	StringSensor

typedef SKOutputNumeric< float >	SKOutputFloat

typedef SKOutputNumeric< int >	SKOutputInt

typedef SKOutput< bool >	SKOutputBool

typedef SKOutput< String >	SKOutputString

typedef SKOutput< Position >	SKOutputPosition

typedef SKPutRequest< float >	FloatSKPutRequest

typedef SKPutRequest< int >	IntSKPutRequest

typedef SKPutRequest< bool >	BoolSKPutRequest

typedef SKPutRequest< String >	StringSKPutRequest

typedef SKPutRequestListener< float >	FloatSKPutRequestListener

typedef SKPutRequestListener< int >	IntSKPutRequestListener

typedef SKPutRequestListener< bool >	BoolSKPutRequestListener

typedef SKPutRequestListener< String >	StringSKPutRequestListener

typedef SKValueListener< float >	FloatSKListener

typedef SKValueListener< int >	IntSKListener

typedef SKValueListener< bool >	BoolSKListener

typedef SKValueListener< String >	StringSKListener

typedef ValueConsumer< float >	FloatConsumer

typedef ValueConsumer< int >	IntConsumer

typedef ValueConsumer< bool >	BoolConsumer

typedef ValueConsumer< String >	StringConsumer

typedef ValueProducer< float >	FloatProducer

typedef ValueProducer< int >	IntProducer

typedef ValueProducer< bool >	BoolProducer

typedef ValueProducer< String >	StringProducer

typedef DebounceTemplate< bool >	DebounceBool

typedef DebounceTemplate< bool >	Debounce

typedef DebounceTemplate< int >	DebounceInt

typedef DebounceTemplate< float >	DebounceFloat

typedef IntegratorT< float, float >	Integrator

typedef IntegratorT< int, int >	Accumulator

typedef SymmetricTransform< float >	FloatTransform

typedef SymmetricTransform< int >	IntegerTransform

typedef SymmetricTransform< bool >	BooleanTransform

typedef SymmetricTransform< String >	StringTransform

typedef Typecast< int, bool >	IntToBool

typedef Typecast< bool, int >	BoolToInt

typedef Typecast< int, float >	IntToFloat

typedef Typecast< float, int >	FloatToInt

Enumerations
enum class	SystemStatus { kWifiNoAP = 100 , kWifiDisconnected , kWifiManagerActivated , kWSDisconnected , kWSAuthorizing , kWSConnecting , kWSConnected }

enum class	WiFiState { kWifiNoAP = 0 , kWifiDisconnected , kWifiConnectedToAP , kWifiManagerActivated , kWifiAPModeActivated }

enum class	WSConnectionState { kWSDisconnected , kWSAuthorizing , kWSConnecting , kWSConnected }

enum class	ClickTypes { ButtonPress , ButtonRelease , SingleClick , LongSingleClick , UltraLongSingleClick , DoubleClick }

Functions
void	SetupSerialDebug (uint32_t baudrate)

void	ExecuteWebSocketTask (void *parameter)

void	webSocketClientEvent (WStype_t type, uint8_t *payload, size_t length)
	WebSocket event handler.

template<typename T >
void	connect_system_info_sensor (SensorT< T > *sensor, String prefix, String name)
	Connect a system information sensor to SKOutput.

template<class T >
bool	operator== (ObservableValue< T > const &lhs, T const &rhs)

template<class T >
bool	operator!= (ObservableValue< T > const &lhs, T const &rhs)

String	generate_uuid4 ()
	Generate a random UUIDv4 string.

template<>
const char *	get_schema_type_string (const int dummy)

template<>
const char *	get_schema_type_string (const float dummy)

template<>
const char *	get_schema_type_string (const String dummy)

template<>
const char *	get_schema_type_string (const bool dummy)

template<class T >
const char *	get_schema_type_string (const T dummy)

template<>
const char *	get_schema_type_string (const int dummy)

template<>
const char *	get_schema_type_string (const float dummy)

template<>
const char *	get_schema_type_string (const String dummy)

template<>
const char *	get_schema_type_string (const bool dummy)

void	convertFromJson (JsonVariantConst src, Position &dst)
	Adds support in ArduinoJson to deserialize Position type data.

bool	canConvertFromJson (JsonVariantConst src, const Position &)
	Tells ArduinoJson whether the given JSON is a Position or not.

Variables
DEBUG_CLASS	Debug

constexpr int	ws_client_task_stack_size = 8192

WSClient *	ws_client

const char *const	kSensESPVersion = "2.7.2"

ReactESP	app

std::map< String, Configurable * >	configurables

int	no_ap_pattern [] = {50, 950, PATTERN_END}

int	wifi_disconnected_pattern [] = {300, 700, PATTERN_END}

int	wifi_connected_pattern [] = {700, 300, PATTERN_END}

int	ws_connecting_pattern [] = {650, 50, 50, 50, 50, 50, 50, 50, PATTERN_END}

int	wifimanager_pattern [] = {1000, 0, PATTERN_END}

int	ws_connected_pattern [] = {900, 100, PATTERN_END}

int	ws_disconnected_pattern [] = {50, 50, 50, 50, 50, 50, 50, 650, PATTERN_END}

int	ws_authorizing_pattern [] = {200, 200, PATTERN_END}

const ParamInfo	hysteresis_param_info [4]

constexpr float	kPositionInvalidAltitude = std::numeric_limits<float>::lowest()
	Value used to indicate an invalid or missing altitude.

constexpr char	kUIOutputDefaultGroup [] = "Default"

constexpr int	kUIOutputDefaultOrder = 1000

std::map< String, UIOutputBase * >	ui_outputs

SensESPApp *	sensesp_app

constexpr auto	kDefaultHostname = "SensESP"

Typedef Documentation

◆ Accumulator

typedef IntegratorT<int, int> sensesp::Accumulator

Definition at line 76 of file integrator.h.

◆ AnalogReader

typedef ESP32AnalogReader sensesp::AnalogReader

Definition at line 64 of file analog_reader.h.

◆ BoolConstantSensor

typedef ConstantSensor<bool> sensesp::BoolConstantSensor

Definition at line 97 of file constant_sensor.h.

◆ BoolConsumer

typedef ValueConsumer<bool> sensesp::BoolConsumer

Definition at line 51 of file valueconsumer.h.

◆ BooleanTransform

typedef SymmetricTransform<bool> sensesp::BooleanTransform

Definition at line 102 of file transform.h.

◆ BoolProducer

typedef ValueProducer<bool> sensesp::BoolProducer

Definition at line 124 of file valueproducer.h.

◆ BoolSensor

typedef SensorT<bool> sensesp::BoolSensor

Definition at line 53 of file sensor.h.

◆ BoolSKListener

typedef SKValueListener<bool> sensesp::BoolSKListener

Definition at line 38 of file signalk_value_listener.h.

◆ BoolSKPutRequest

typedef SKPutRequest<bool> sensesp::BoolSKPutRequest

Definition at line 173 of file signalk_put_request.h.

◆ BoolSKPutRequestListener

typedef SKPutRequestListener<bool> sensesp::BoolSKPutRequestListener

Definition at line 68 of file signalk_put_request_listener.h.

◆ BoolToInt

typedef Typecast<bool, int> sensesp::BoolToInt

Definition at line 43 of file typecast.h.

◆ Debounce

typedef DebounceTemplate<bool> sensesp::Debounce

Definition at line 92 of file debounce.h.

◆ DebounceBool

typedef DebounceTemplate<bool> sensesp::DebounceBool

Definition at line 90 of file debounce.h.

◆ DebounceFloat

typedef DebounceTemplate<float> sensesp::DebounceFloat

Definition at line 95 of file debounce.h.

◆ DebounceInt

typedef DebounceTemplate<int> sensesp::DebounceInt

Definition at line 93 of file debounce.h.

◆ FloatConstantSensor

typedef ConstantSensor<float> sensesp::FloatConstantSensor

Definition at line 95 of file constant_sensor.h.

◆ FloatConsumer

typedef ValueConsumer<float> sensesp::FloatConsumer

Definition at line 49 of file valueconsumer.h.

◆ FloatProducer

typedef ValueProducer<float> sensesp::FloatProducer

Definition at line 122 of file valueproducer.h.

◆ FloatSensor

typedef SensorT<float> sensesp::FloatSensor

Definition at line 51 of file sensor.h.

◆ FloatSKListener

typedef SKValueListener<float> sensesp::FloatSKListener

Definition at line 36 of file signalk_value_listener.h.

◆ FloatSKPutRequest

typedef SKPutRequest<float> sensesp::FloatSKPutRequest

Definition at line 171 of file signalk_put_request.h.

◆ FloatSKPutRequestListener

typedef SKPutRequestListener<float> sensesp::FloatSKPutRequestListener

Definition at line 66 of file signalk_put_request_listener.h.

◆ FloatToInt

typedef Typecast<float, int> sensesp::FloatToInt

Definition at line 46 of file typecast.h.

◆ FloatTransform

typedef SymmetricTransform<float> sensesp::FloatTransform

Definition at line 100 of file transform.h.

◆ IntConstantSensor

typedef ConstantSensor<int> sensesp::IntConstantSensor

Definition at line 96 of file constant_sensor.h.

◆ IntConsumer

typedef ValueConsumer<int> sensesp::IntConsumer

Definition at line 50 of file valueconsumer.h.

◆ IntegerTransform

typedef SymmetricTransform<int> sensesp::IntegerTransform

Definition at line 101 of file transform.h.

◆ Integrator

typedef IntegratorT<float, float> sensesp::Integrator

Definition at line 75 of file integrator.h.

◆ IntProducer

typedef ValueProducer<int> sensesp::IntProducer

Definition at line 123 of file valueproducer.h.

◆ IntSensor

typedef SensorT<int> sensesp::IntSensor

Definition at line 52 of file sensor.h.

◆ IntSKListener

typedef SKValueListener<int> sensesp::IntSKListener

Definition at line 37 of file signalk_value_listener.h.

◆ IntSKPutRequest

typedef SKPutRequest<int> sensesp::IntSKPutRequest

Definition at line 172 of file signalk_put_request.h.

◆ IntSKPutRequestListener

typedef SKPutRequestListener<int> sensesp::IntSKPutRequestListener

Definition at line 67 of file signalk_put_request_listener.h.

◆ IntToBool

typedef Typecast<int, bool> sensesp::IntToBool

Definition at line 42 of file typecast.h.

◆ IntToFloat

typedef Typecast<int, float> sensesp::IntToFloat

Definition at line 45 of file typecast.h.

◆ SKOutputBool

typedef SKOutput<bool> sensesp::SKOutputBool

Definition at line 134 of file signalk_output.h.

◆ SKOutputFloat

typedef SKOutputNumeric<float> sensesp::SKOutputFloat

Definition at line 132 of file signalk_output.h.

◆ SKOutputInt

typedef SKOutputNumeric<int> sensesp::SKOutputInt

Definition at line 133 of file signalk_output.h.

◆ SKOutputPosition

typedef SKOutput<Position> sensesp::SKOutputPosition

Definition at line 15 of file signalk_position.h.

◆ SKOutputString

typedef SKOutput<String> sensesp::SKOutputString

Definition at line 135 of file signalk_output.h.

◆ StringConstantSensor

typedef ConstantSensor<String> sensesp::StringConstantSensor

Definition at line 98 of file constant_sensor.h.

◆ StringConsumer

typedef ValueConsumer<String> sensesp::StringConsumer

Definition at line 52 of file valueconsumer.h.

◆ StringProducer

typedef ValueProducer<String> sensesp::StringProducer

Definition at line 125 of file valueproducer.h.

◆ StringSensor

typedef SensorT<String> sensesp::StringSensor

Definition at line 54 of file sensor.h.

◆ StringSKListener

typedef SKValueListener<String> sensesp::StringSKListener

Definition at line 39 of file signalk_value_listener.h.

◆ StringSKPutRequest

typedef SKPutRequest<String> sensesp::StringSKPutRequest

Definition at line 174 of file signalk_put_request.h.

◆ StringSKPutRequestListener

typedef SKPutRequestListener<String> sensesp::StringSKPutRequestListener

Definition at line 69 of file signalk_put_request_listener.h.

◆ StringTransform

typedef SymmetricTransform<String> sensesp::StringTransform

Definition at line 103 of file transform.h.

◆ void_cb_func

typedef std::function<void()> sensesp::void_cb_func

Definition at line 29 of file sensesp.h.

◆ WifiState

using sensesp::WifiState = typedef WiFiState

Definition at line 15 of file wifi_state.h.

Enumeration Type Documentation

◆ ClickTypes

enum class sensesp::ClickTypes

strong

ClickTypes defines the types of clicks and button presses a ClickType transform can detect

Enumerator
ButtonPress
ButtonRelease
SingleClick
LongSingleClick
UltraLongSingleClick
DoubleClick

Definition at line 14 of file click_type.h.

◆ SystemStatus

enum class sensesp::SystemStatus

strong

Enumerator
kWifiNoAP
kWifiDisconnected
kWifiManagerActivated
kWSDisconnected
kWSAuthorizing
kWSConnecting
kWSConnected

Definition at line 10 of file system_status_controller.h.

◆ WiFiState

enum class sensesp::WiFiState

strong

Enumerator
kWifiNoAP
kWifiDisconnected
kWifiConnectedToAP
kWifiManagerActivated
kWifiAPModeActivated

Definition at line 6 of file wifi_state.h.

◆ WSConnectionState

enum class sensesp::WSConnectionState

strong

Enumerator
kWSDisconnected
kWSAuthorizing
kWSConnecting
kWSConnected

Definition at line 20 of file ws_client.h.

Function Documentation

◆ canConvertFromJson()

bool sensesp::canConvertFromJson	(	JsonVariantConst	src,
		const Position &
	)

Tells ArduinoJson whether the given JSON is a Position or not.

This function is automatically called by ArduinoJson whenever it has to convert a JSON to a Position struct.

Parameters

src	A JSON document

Returns: true if the given JSON contains "latitude" and "longitude" keys; false if the given JSON doesn't contain "latitude" or "longitude" keys

Definition at line 16 of file position.cpp.

◆ connect_system_info_sensor()

template<typename T >

void sensesp::connect_system_info_sensor	(	SensorT< T > *	sensor,
		String	prefix,
		String	name
	)

Connect a system information sensor to SKOutput.

Definition at line 17 of file system_info.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ convertFromJson()

void sensesp::convertFromJson	(	JsonVariantConst	src,
		Position &	dst
	)

Adds support in ArduinoJson to deserialize Position type data.

This is an ArduinoJson custom converter to convert position type data from JSON into a Postion struct. The JSON data must at least contain "latitude" and "longitude", "altitude" is optional. ArduinoJson will automatically call this function whenever it has to convert a JSON to a Position struct. More info here: https://arduinojson.org/news/2021/05/04/version-6-18-0/

Parameters

src	The JSON document containing the position data
dst	The address to a Position struct to write the data to

Definition at line 7 of file position.cpp.

◆ ExecuteWebSocketTask()

void sensesp::ExecuteWebSocketTask ( void * parameter )

Definition at line 24 of file ws_client.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generate_uuid4()

String sensesp::generate_uuid4 ( )

Generate a random UUIDv4 string.

Returns: Formatted UUID string.

Definition at line 5 of file uuid.cpp.

Here is the caller graph for this function:

◆ get_schema_type_string() [1/9]

template<>

const char * sensesp::get_schema_type_string ( const bool dummy )

Definition at line 21 of file lambda_transform.cpp.

◆ get_schema_type_string() [2/9]

template<>

const char * sensesp::get_schema_type_string ( const bool dummy )

Definition at line 21 of file lambda_transform.cpp.

◆ get_schema_type_string() [3/9]

template<>

const char * sensesp::get_schema_type_string ( const float dummy )

Definition at line 11 of file lambda_transform.cpp.

◆ get_schema_type_string() [4/9]

template<>

const char * sensesp::get_schema_type_string ( const float dummy )

Definition at line 11 of file lambda_transform.cpp.

◆ get_schema_type_string() [5/9]

template<>

const char * sensesp::get_schema_type_string ( const int dummy )

Definition at line 6 of file lambda_transform.cpp.

Here is the caller graph for this function:

◆ get_schema_type_string() [6/9]

template<>

const char * sensesp::get_schema_type_string ( const int dummy )

Definition at line 6 of file lambda_transform.cpp.

Here is the caller graph for this function:

◆ get_schema_type_string() [7/9]

template<>

const char * sensesp::get_schema_type_string ( const String dummy )

Definition at line 16 of file lambda_transform.cpp.

◆ get_schema_type_string() [8/9]

template<>

const char * sensesp::get_schema_type_string ( const String dummy )

Definition at line 16 of file lambda_transform.cpp.

◆ get_schema_type_string() [9/9]

template<class T >

const char * sensesp::get_schema_type_string ( const T dummy )

Convert the variable type to a string representation of the type using template specializations.

Definition at line 25 of file lambda_transform.h.

◆ operator!=()

template<class T >

bool sensesp::operator!=	(	ObservableValue< T > const &	lhs,
		T const &	rhs
	)

Definition at line 19 of file observablevalue.h.

◆ operator==()

template<class T >

bool sensesp::operator==	(	ObservableValue< T > const &	lhs,
		T const &	rhs
	)

Definition at line 14 of file observablevalue.h.

◆ SetupSerialDebug()

void sensesp::SetupSerialDebug ( uint32_t baudrate )

Definition at line 5 of file sensesp_base_app.cpp.

Here is the caller graph for this function:

◆ webSocketClientEvent()

void sensesp::webSocketClientEvent	(	WStype_t	type,
		uint8_t *	payload,
		size_t	length
	)

WebSocket event handler.

This function will be called in the websocket task.

Parameters

type
payload
length

Definition at line 57 of file ws_client.cpp.

Here is the call graph for this function:

Variable Documentation

◆ app

ReactESP sensesp::app

extern

◆ configurables

std::map< String, Configurable * > sensesp::configurables

Definition at line 12 of file configurable.cpp.

◆ Debug

DEBUG_CLASS sensesp::Debug

Definition at line 14 of file debug_output.cpp.

◆ hysteresis_param_info

const ParamInfo sensesp::hysteresis_param_info[4]

Initial value:

= {
    {"lower_threshold", "Lower threshold"},
    {"upper_threshold", "Upper threshold"},
    {"low_output", "Low output"},
    {"high_output", "High output"}}

Definition at line 9 of file hysteresis.h.

◆ kDefaultHostname

constexpr auto sensesp::kDefaultHostname = "SensESP"

constexpr

Definition at line 19 of file sensesp_base_app.h.

◆ kPositionInvalidAltitude

constexpr float sensesp::kPositionInvalidAltitude = std::numeric_limits<float>::lowest()

constexpr

Value used to indicate an invalid or missing altitude.

Definition at line 11 of file position.h.

◆ kSensESPVersion

const char* const sensesp::kSensESPVersion = "2.7.2"

Definition at line 6 of file sensesp_version.h.

◆ kUIOutputDefaultGroup

constexpr char sensesp::kUIOutputDefaultGroup[] = "Default"

constexpr

Definition at line 15 of file ui_output.h.

◆ kUIOutputDefaultOrder

constexpr int sensesp::kUIOutputDefaultOrder = 1000

constexpr

Definition at line 16 of file ui_output.h.

◆ no_ap_pattern

int sensesp::no_ap_pattern[] = {50, 950, PATTERN_END}

Definition at line 12 of file system_status_led.cpp.

◆ sensesp_app

SensESPApp * sensesp::sensesp_app

Definition at line 89 of file sensesp_app.cpp.

◆ ui_outputs

std::map<String, UIOutputBase*> sensesp::ui_outputs

extern

◆ wifi_connected_pattern

int sensesp::wifi_connected_pattern[] = {700, 300, PATTERN_END}

Definition at line 18 of file system_status_led.cpp.

◆ wifi_disconnected_pattern

int sensesp::wifi_disconnected_pattern[] = {300, 700, PATTERN_END}

Definition at line 15 of file system_status_led.cpp.

◆ wifimanager_pattern

int sensesp::wifimanager_pattern[] = {1000, 0, PATTERN_END}

Definition at line 24 of file system_status_led.cpp.

◆ ws_authorizing_pattern

int sensesp::ws_authorizing_pattern[] = {200, 200, PATTERN_END}

Definition at line 33 of file system_status_led.cpp.

◆ ws_client

WSClient* sensesp::ws_client

Definition at line 20 of file ws_client.cpp.

◆ ws_client_task_stack_size

constexpr int sensesp::ws_client_task_stack_size = 8192

constexpr

Definition at line 18 of file ws_client.cpp.

◆ ws_connected_pattern

int sensesp::ws_connected_pattern[] = {900, 100, PATTERN_END}

Definition at line 27 of file system_status_led.cpp.

◆ ws_connecting_pattern

int sensesp::ws_connecting_pattern[] = {650, 50, 50, 50, 50, 50, 50, 50, PATTERN_END}

Definition at line 21 of file system_status_led.cpp.

◆ ws_disconnected_pattern

int sensesp::ws_disconnected_pattern[] = {50, 50, 50, 50, 50, 50, 50, 650, PATTERN_END}

Definition at line 30 of file system_status_led.cpp.

Classes

Typedefs

Enumerations

Functions

Variables

Typedef Documentation

◆ Accumulator

◆ AnalogReader

◆ BoolConstantSensor

◆ BoolConsumer

◆ BooleanTransform

◆ BoolProducer

◆ BoolSensor

◆ BoolSKListener

◆ BoolSKPutRequest

◆ BoolSKPutRequestListener

◆ BoolToInt

◆ Debounce

◆ DebounceBool

◆ DebounceFloat

◆ DebounceInt

◆ FloatConstantSensor

◆ FloatConsumer

◆ FloatProducer

◆ FloatSensor

◆ FloatSKListener

◆ FloatSKPutRequest

◆ FloatSKPutRequestListener

◆ FloatToInt

◆ FloatTransform

◆ IntConstantSensor

◆ IntConsumer

◆ IntegerTransform

◆ Integrator

◆ IntProducer

◆ IntSensor

◆ IntSKListener

◆ IntSKPutRequest

◆ IntSKPutRequestListener

◆ IntToBool

◆ IntToFloat

◆ SKOutputBool

◆ SKOutputFloat

◆ SKOutputInt

◆ SKOutputPosition

◆ SKOutputString

◆ StringConstantSensor

◆ StringConsumer

◆ StringProducer

◆ StringSensor

◆ StringSKListener

◆ StringSKPutRequest

◆ StringSKPutRequestListener

◆ StringTransform

◆ void_cb_func

◆ WifiState

Enumeration Type Documentation

◆ ClickTypes

◆ SystemStatus

◆ WiFiState

◆ WSConnectionState

Function Documentation

◆ canConvertFromJson()

◆ connect_system_info_sensor()

◆ convertFromJson()

◆ ExecuteWebSocketTask()

◆ generate_uuid4()

◆ get_schema_type_string() [1/9]

◆ get_schema_type_string() [2/9]

◆ get_schema_type_string() [3/9]

◆ get_schema_type_string() [4/9]

◆ get_schema_type_string() [5/9]

◆ get_schema_type_string() [6/9]

◆ get_schema_type_string() [7/9]

◆ get_schema_type_string() [8/9]

◆ get_schema_type_string() [9/9]

◆ operator!=()

◆ operator==()

◆ SetupSerialDebug()

◆ webSocketClientEvent()