SensESP 2.7.2
Universal Signal K sensor toolkit ESP32
|
A specialized transform whose primary purpose is to output Signal K data on the Signal K network. More...
#include <sensesp/signalk/signalk_output.h>
Protected Attributes | |
SKMetadata * | meta_ |
Protected Attributes inherited from sensesp::SKEmitter | |
String | sk_path |
Protected Attributes inherited from sensesp::Configurable | |
String | description_ = "" |
int | sort_order_ = 1000 |
Protected Attributes inherited from sensesp::ValueProducer< T > | |
T | output |
Additional Inherited Members | |
Static Public Member Functions inherited from sensesp::SKEmitter | |
static const std::vector< SKEmitter * > & | get_sources () |
Static Public Member Functions inherited from sensesp::TransformBase | |
static const std::set< TransformBase * > & | get_transforms () |
Static Public Member Functions inherited from sensesp::Startable | |
static void | start_all () |
Public Attributes inherited from sensesp::Configurable | |
const String | config_path_ |
Protected Member Functions inherited from sensesp::Configurable | |
virtual void | load_configuration () |
A specialized transform whose primary purpose is to output Signal K data on the Signal K network.
Definition at line 21 of file signalk_output.h.
|
inline |
|
inline |
The constructor
sk_path | The Signal K path the output value of this transform is sent on |
config_path | The optional configuration path that allows an end user to change the configuration of this object. See the Configurable class for more information. |
meta | Optional metadata that is associated with the value output by this class A value specified here will cause the path's metadata to be emitted on the first delta sent to the server. Use NULL if this path has no metadata to report (or if the path is already an official part of the Signal K specification) |
Definition at line 38 of file signalk_output.h.
|
inline |
Definition at line 44 of file signalk_output.h.
|
virtual |
Template specialization for SKOutputPosition::as_signalk()
This specialization allows Position
objects to be output as Signal K deltas.
return String
Reimplemented from sensesp::SKEmitter.
Reimplemented in sensesp::SKOutputRawJson.
Definition at line 16 of file signalk_position.cpp.
|
virtual |
Returns the data to be reported to the server as a Signal K json string.
Reimplemented from sensesp::SKEmitter.
Reimplemented in sensesp::SKOutputRawJson.
|
inlineoverridevirtual |
Returns the data to be reported to the server as a Signal K json string.
Reimplemented from sensesp::SKEmitter.
Reimplemented in sensesp::SKOutputRawJson.
Definition at line 50 of file signalk_output.h.
|
inlineoverridevirtual |
Returns a configuration schema that specifies the key/value pairs that can be expected when calling get_configuration(), or are expected by set_configuration(). The schema will be in JSON Schema format
Reimplemented from sensesp::Configurable.
Definition at line 63 of file signalk_output.h.
|
inlineoverridevirtual |
Returns the current configuration data as a JsonObject. In general, the current state of local member variables are saved to a new object created with JsonDocument::as<JsonObject>() and returned.
Reimplemented from sensesp::Configurable.
Definition at line 59 of file signalk_output.h.
|
inlineoverridevirtual |
Returns a Metadata structure that describes the sk_path this SKEmitter is associated with. If this emitter has no metadata, NULL is returned.
Reimplemented from sensesp::SKEmitter.
Definition at line 81 of file signalk_output.h.
|
inlineoverridevirtual |
Sets the current state of local member variables using the data stored in config.
Reimplemented from sensesp::Configurable.
Definition at line 65 of file signalk_output.h.
|
inlineoverridevirtual |
Used to set an input of this consumer. It is usually called automatically by a ValueProducer.
new_value | the value of the input |
input_channel | Consumers can have one or more inputs feeding them. This parameter allows you to specify which input number the producer is connecting to. For single input consumers, leave the index at zero. |
Reimplemented from sensesp::ValueConsumer< T >.
Definition at line 46 of file signalk_output.h.
|
inlinevirtual |
Used to set the optional metadata that is associated with the Signal K path this transform emits. This is a second method of setting the metadata (the first being a parameter to the constructor).
Definition at line 79 of file signalk_output.h.
|
protected |
Definition at line 84 of file signalk_output.h.