SensESP 3.5.1-alpha
Universal Signal K sensor toolkit ESP32
Loading...
Searching...
No Matches
sensesp::SKValueListener< T > Class Template Reference

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

#include <sensesp/signalk/signalk_value_listener.h>

Inheritance diagram for sensesp::SKValueListener< T >:
[legend]

Public Member Functions

 SKValueListener (String sk_path, int listen_delay=1000, String config_path="")
 
void parse_value (const JsonObject &json) override
 
- Public Member Functions inherited from sensesp::SKListener
 SKListener (const String &sk_path, int listen_delay, const String &config_path="")
 
virtual ~SKListener ()
 
String & get_sk_path ()
 
int get_listen_delay ()
 
virtual bool matches (const String &path) const
 
virtual bool wants_meta () const
 
virtual void parse_meta (const std::shared_ptr< const JsonDocument > &meta_doc)
 
- Public Member Functions inherited from sensesp::Observable
 Observable ()
 
 Observable (Observable &&other)
 Move constructor.
 
void notify ()
 
int attach (std::function< void()> observer)
 Attach an observer callback.
 
void detach (int id)
 Remove a previously attached observer by its ID.
 
- 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::ValueProducer< T >
 ValueProducer ()
 
 ValueProducer (const T &initial_value)
 
virtual const T & get () const
 
template<typename VConsumer >
std::enable_if< std::is_base_of< ValueConsumer< typenameVConsumer::input_type >, VConsumer >::value &&std::is_convertible< T, typenameVConsumer::input_type >::value, std::shared_ptr< VConsumer > >::type connect_to (std::shared_ptr< VConsumer > consumer)
 Connect a producer to a transform with a different input type.
 
template<typename VConsumer >
std::enable_if< std::is_base_of< ValueConsumer< typenameVConsumer::input_type >, VConsumer >::value &&std::is_convertible< T, typenameVConsumer::input_type >::value, VConsumer * >::type connect_to (VConsumer *consumer)
 
template<typename VConsumer >
std::enable_if< std::is_base_of< ValueConsumer< typenameVConsumer::input_type >, VConsumer >::value &&std::is_convertible< T, typenameVConsumer::input_type >::value, VConsumer * >::type connect_to (VConsumer &consumer)
 
void emit (const T &new_value)
 

Additional Inherited Members

- Static Public Member Functions inherited from sensesp::SKListener
static const std::vector< SKListener * > & get_listeners ()
 
static void clear_registry ()
 
static bool take_semaphore (uint64_t timeout_ms=0)
 
static void release_semaphore ()
 
- Protected Attributes inherited from sensesp::SKListener
String sk_path {}
 
- Protected Attributes inherited from sensesp::Saveable
const String config_path_
 
- Protected Attributes inherited from sensesp::ValueProducer< T >
output_
 

Detailed Description

template<class T>
class sensesp::SKValueListener< T >

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

Definition at line 17 of file signalk_value_listener.h.

Constructor & Destructor Documentation

◆ SKValueListener()

template<class T >
sensesp::SKValueListener< T >::SKValueListener ( String  sk_path,
int  listen_delay = 1000,
String  config_path = "" 
)
inline
Parameters
sk_pathThe Signal K path you want to listen to for value changes
listen_delayThe minimum interval between updates in ms

Definition at line 23 of file signalk_value_listener.h.

Member Function Documentation

◆ parse_value()

template<class T >
void sensesp::SKValueListener< T >::parse_value ( const JsonObject &  json)
inlineoverridevirtual

Reimplemented from sensesp::SKListener.

Definition at line 32 of file signalk_value_listener.h.

Here is the call graph for this function:

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