SensESP 2.7.2
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 (String sk_path, int listen_delay, String config_path="")
 
Stringget_sk_path ()
 
int get_listen_delay ()
 
- 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::Configurable
 Configurable (String config_path="", String description="", int sort_order=1000)
 
String get_description ()
 
void set_description (String description)
 Set the description of the Configurable.
 
int get_sort_order ()
 
void set_sort_order (int sort_order)
 
virtual void save_configuration ()
 
- Public Member Functions inherited from sensesp::ValueProducer< T >
 ValueProducer ()
 
virtual const T & get () const
 
void connect_to (ValueConsumer< T > *consumer, uint8_t input_channel=0)
 
template<typename CT >
void connect_to (ValueConsumer< CT > *consumer, uint8_t input_channel=0)
 Connect a producer to a consumer of a different type.
 
template<typename T2 >
Transform< T, T2 > * connect_to (Transform< T, T2 > *consumer_producer, uint8_t input_channel=0)
 
template<typename TT , typename T2 >
Transform< TT, T2 > * connect_to (Transform< TT, T2 > *consumer_producer, uint8_t input_channel=0)
 Connect a producer to a transform with a different input type.
 
void emit (T new_value)
 

Additional Inherited Members

- Static Public Member Functions inherited from sensesp::SKListener
static const std::vector< SKListener * > & get_listeners ()
 
static bool take_semaphore (unsigned long int timeout_ms=0)
 
static void release_semaphore ()
 
- Public Attributes inherited from sensesp::Configurable
const String config_path_
 
- Protected Member Functions inherited from sensesp::Configurable
virtual void load_configuration ()
 
- Protected Attributes inherited from sensesp::SKListener
String sk_path
 
- Protected Attributes inherited from sensesp::Configurable
String description_ = ""
 
int sort_order_ = 1000
 
- 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 31 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: