SensESP 3.4.1-alpha
Universal Signal K sensor toolkit ESP32
Loading...
Searching...
No Matches
sensesp::SKOutputRawJson Class Reference

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

#include <sensesp/signalk/signalk_output.h>

Inheritance diagram for sensesp::SKOutputRawJson:
[legend]

Public Member Functions

 SKOutputRawJson (String sk_path, String config_path="", SKMetadata *meta=NULL)
 
virtual void as_signalk_json (JsonDocument &doc) override
 
- Public Member Functions inherited from sensesp::SKOutput< String >
 SKOutput ()
 
 SKOutput (String sk_path, String config_path="", SKMetadata *meta=nullptr)
 
 SKOutput (String sk_path, String config_path, std::shared_ptr< SKMetadata > meta)
 
 SKOutput (String sk_path, SKMetadata *meta)
 
virtual void set (const String &new_value) override
 
virtual bool to_json (JsonObject &root) override
 
virtual bool from_json (const JsonObject &config) override
 
virtual void set_metadata (SKMetadata *meta)
 
virtual SKMetadataget_metadata () override
 
- Public Member Functions inherited from sensesp::SKEmitter
 SKEmitter (const String &sk_path)
 
virtual ~SKEmitter ()
 
virtual void add_metadata (JsonArray &meta)
 
String & get_sk_path ()
 
void set_sk_path (const String &path)
 
- 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::SymmetricTransform< T >
 SymmetricTransform (String config_path="")
 
- Public Member Functions inherited from sensesp::Transform< T, T >
 Transform (String config_path="")
 
Transform< T, T > * connect_from (ValueProducer< T > *producer0, ValueProducer< T > *producer1=NULL, ValueProducer< T > *producer2=NULL, ValueProducer< T > *producer3=NULL, ValueProducer< T > *producer4=NULL)
 
- Public Member Functions inherited from sensesp::TransformBase
 TransformBase (const String &config_path)
 
virtual ~TransformBase ()
 
- 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::ValueConsumer< T >
virtual void set (const T &new_value)
 
virtual void set_input (const T &new_value)
 
void connect_from (ValueProducer< T > *producer)
 
- 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

- Public Types inherited from sensesp::ValueConsumer< T >
using input_type = T
 
- Static Public Member Functions inherited from sensesp::SKEmitter
static const std::vector< SKEmitter * > & get_sources ()
 
static void clear_registry ()
 
- Static Public Member Functions inherited from sensesp::TransformBase
static const std::set< TransformBase * > & get_transforms ()
 
static void clear_registry ()
 
- Protected Attributes inherited from sensesp::SKOutput< String >
std::shared_ptr< SKMetadatameta_
 
- Protected Attributes inherited from sensesp::SKEmitter
String sk_path_ {}
 
- Protected Attributes inherited from sensesp::Saveable
const String config_path_
 
- Protected Attributes inherited from sensesp::ValueProducer< T >
output_
 

Detailed Description

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

Definition at line 95 of file signalk_output.h.

Constructor & Destructor Documentation

◆ SKOutputRawJson()

sensesp::SKOutputRawJson::SKOutputRawJson ( String  sk_path,
String  config_path = "",
SKMetadata meta = NULL 
)
inline

Definition at line 97 of file signalk_output.h.

Member Function Documentation

◆ as_signalk_json()

virtual void sensesp::SKOutputRawJson::as_signalk_json ( JsonDocument &  doc)
inlineoverridevirtual

Returns the data to be reported to the server as a Signal K json object.

Reimplemented from sensesp::SKOutput< String >.

Definition at line 101 of file signalk_output.h.

Here is the call graph for this function:

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