-
Notifications
You must be signed in to change notification settings - Fork 157
Stream Configuration
Configuration of stream inputs and outputs is done by configuring a stream module, then configuring some inputs and/or outputs.
List of dictionary values which will contain the following options. Further options may be added by the stream module itself.
TODO: Add the options for all of the individual modules
Name of this module configuration. This is an arbitrary string that is used by the stream_reads and stream_writes configurations to specify which stream module is being used.
Name of the class of stream module used (currently only streamserial) for this configuration.
Whether to run the 'cleanup' functions for this module when the software exits. Defaults to true.
List of dictionary values which will contain the following options. Further options may be added by the stream module itself.
TODO: Add the options for all of the individual modules
Name of this stream. This will be used as part of the MQTT topic when data is read from the stream and an MQTT message is sent with its value. For example: <topic_prefix>/stream/<name>.
Name of the module configuration to use for this input. This is the name used in the stream_modules section documented above.
Boolean value that specifies whether to use the retain flag when publishing MQTT messages for data received on this stream.
How the data read from the stream should be encoded before publishing it to the relevant MQTT topic. By default, the data are left as bytes.
Number of seconds to wait between polling the stream for new data. Default is 60.
List of dictionary values which will contain the following options. Further options may be added by the stream module itself.
TODO: Add the options for all of the individual modules
Name of this stream. This must be used as part of the MQTT topic when sending data to this stream. For example, to send data, you'd publish your payload to the <topic_prefix>/stream/<name> topic.
Name of the module configuration to use for this output. This is the name used in the stream_modules section documented above.