output.mqtt

Mqtt output

type

object

properties

  • brokerId

List of the broker to link with this value

type

string

  • generator

The generator used to create the payload

Default value is [{“publishError”:false,”type”:”STANDARD”}]

default

publishError

False

type

STANDARD

MqttGeneratorConfigurationEntity

  • isTemplateGeneratedByOspComposer

Name of the playbook that generated this file. If present, the file is managed by the Composer and may be overwritten on regeneration. Used for selective clean. Do not edit or set manually.

type

string

  • qos

The qos to use when publishing

Default value is [“AT_LEAST_ONCE”]

type

string

enum

AT_MOST_ONCE, AT_LEAST_ONCE, EXACTLY_ONCE

default

AT_LEAST_ONCE

  • retain

The retain to use when publishing

Default value is [false]

type

boolean

default

False

  • templateId

The id of the template to use for this file

type

string

  • templateVariables

The variables and their values to be replaced from the template

type

object

additionalProperties

  • topic

The topic to use when publishing the value

type

string

  • variablesFiles

The variables files to use to replace the variables. The first file of the list will take precedence over the following one. Template variables take precedence over the contents of the files.

type

array

items

type

string

additionalProperties

False

MqttGeneratorConfigurationEntity

type

object

properties

  • publishError

Flag to enable the publish of the error of the value

Default value is [false]

type

boolean

default

False

  • template

The json template to fill. “$value” will be replace by the content of the value or null when there is a error and the publication must be done. “$timestamp” will be replaced by the timestamp in nanoseconds. “$error” will be replaced by the error message.

  • type

The parser to use

type

string

enum

STANDARD, JSON, STANDARD_WITH_TOPIC

additionalProperties

False