sensesp::SensorConfig Class Reference

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

#include <sensesp/sensors/sensor.h>

Inheritance diagram for sensesp::SensorConfig:

Public Member Functions
	SensorConfig (const String &config_path)
Public Member Functions inherited from sensesp::Observable
	Observable ()
	Observable (Observable &&other)
	Move constructor.
void	notify ()
void	attach (std::function< void()> observer)
Public Member Functions inherited from sensesp::FileSystemSaveable
	FileSystemSaveable (const String &config_path)
virtual bool	load () override
	Load and populate the object from a persistent storage.
virtual bool	save () override
	Save the object to a persistent storage.
virtual bool	clear () override
	Delete the data from a persistent storage.
bool	find_config_file (const String &config_path, String &filename)
Public Member Functions inherited from sensesp::Saveable
	Saveable (const String &config_path)
virtual bool	refresh ()
	Refresh the object. This may or may not access the persistent storage but is not expected to overwrite the object's state.
const String &	get_config_path () const
Public Member Functions inherited from sensesp::Serializable
virtual bool	to_json (JsonObject &root)
virtual bool	from_json (const JsonObject &root)

Additional Inherited Members
Protected Attributes inherited from sensesp::Saveable
const String	config_path_

Detailed Description

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

In SensESP, a sensor is something that takes a measurement outside of the SensESP / SignalK environment and brings it into SensESP. Look at the list of files in https://github.com/SignalK/SensESP/tree/master/src/sensors for all the already-defined sensors.

Parameters

config_path

The path that defines the place in the hierarchy of variables, in the Config UI, that are configurable at run-time. If a class has no configurable variables, or if you simply don't want any particular variable to be configurable at run-time in your project, don't provide a config_path when you construct the class.

Definition at line 29 of file sensor.h.

Constructor & Destructor Documentation

SensorConfig()

sensesp::SensorConfig::SensorConfig ( const String & config_path )

inline

Definition at line 31 of file sensor.h.

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• src/sensesp/sensors/sensor.h