ConfigModel

Type: object

root hosts
Type: array
No Additional Items

Each item of this array must be:

root hosts ConfigMqttHost
Type: object

The configuration for a MQTT host

root hosts hosts items auth
Type: object Default: null

The MQTT auth mechanism

root hosts hosts items auth anyOf item 0
Type: null

No authentication
root hosts hosts items auth anyOf User/Password

User/Password

Type: object

Authentication using a username and password

root hosts hosts items buffer_size
Type: integerFormat: uint Default: 1024

The buffer size for each connection

Value must be greater or equal to 0.0

root hosts hosts items host
Type: string

The MQTT host

root hosts hosts items id
Type: string

The MQTT client ID

root hosts hosts items keep_alive_sec
Type: integerFormat: uint64

The MQTT keep alive time in seconds

Value must be greater or equal to 0.0

root hosts hosts items port
Type: integerFormat: uint16

The MQTT port

Value must be greater or equal to 0.0

root hosts hosts items topics
Type: array

All the topics to subscribe/publish

 No Additional Items

Each item of this array must be:

root hosts hosts items topics ConfigTopic
Type: object

The configuration for a MQTT topic

root hosts hosts items topics topics items datapoints
Type: array

A list of datapoints for this topic, which can either be a subscription or publication depending on the mode.

 No Additional Items

Each item of this array must be:

root hosts hosts items topics topics items datapoints ConfigDatapointMode
Type: object

Datapoint mode

root hosts hosts items topics topics items datapoints datapoints items oneOf Publication

Publication

Type: object

The mapping of a datapoint to a MQTT JSON It will send MQTT messages with the following structure: json { "datapoint_name": "some_name", "value": UInt32, "timestamp": 1234567890 }

root hosts hosts items topics topics items datapoints datapoints items oneOf Publication datapoint_name
Type: string

The name of the datapoint This datapoint must be set as a subscriber

root hosts hosts items topics topics items datapoints datapoints items oneOf Publication mode
Type: enum (of string)

Must be one of:

  • "publication"

root hosts hosts items topics topics items datapoints datapoints items oneOf Publication qos

QoS

Type: enum (of string)

The QoS level for the MQTT message

Must be one of:

  • "AtMostOnce"
  • "AtLeastOnce"
  • "ExactlyOnce"

root hosts hosts items topics topics items datapoints datapoints items oneOf Publication retain
Type: boolean

The retain flag for the MQTT message
root hosts hosts items topics topics items datapoints datapoints items oneOf Subscription

Subscription

Type: object

The mapping of a MQTT JSON value to a datapoint

root hosts hosts items topics topics items datapoints datapoints items oneOf Subscription datapoint_name
Type: string

The name of the datapoint This datapoint must be set as a publisher

root hosts hosts items topics topics items datapoints datapoints items oneOf Subscription mode
Type: enum (of string)

Must be one of:

  • "subscription"

root hosts hosts items topics topics items datapoints datapoints items oneOf Subscription mqtt_timestamp_path
Type: string or null

If the MQTT message contains a timestamp, this is the path to the timestamp in nanoseconds. If this field is set to None, the timestamp will be set to the current time.

root hosts hosts items topics topics items datapoints datapoints items oneOf Subscription mqtt_value_path
Type: string

The path to the MQTT JSON value

Example If the MQTT message is: json { "temperature": { "value": [25.0, 10, 20], "unit": "C" } } and we pretend to map the first element of the value array, then the path is temperature.value[0]

root hosts hosts items topics topics items datapoints datapoints items oneOf Subscription mqtt_value_type
Type: enum (of string)

The type of the MQTT value

Must be one of:

  • "Float32"
  • "Float64"
  • "UInt32"
  • "UInt64"
  • "Int32"
  • "Int64"
  • "Timestamp"
  • "Boolean"

root hosts hosts items topics topics items subscription_qos

QoS

Type: enum (of string) Default: "AtMostOnce"

The QoS level for all the subscriptions

Must be one of:

  • "AtMostOnce"
  • "AtLeastOnce"
  • "ExactlyOnce"

root hosts hosts items topics topics items topic_name
Type: string

The name of the topic

root hosts hosts items version
Type: string

The MQTT server version This is used to represent the MQTT version in the configuration. The version is represented as a string, e.g., "3", "v3.1.1", "5", "5.0" , "v4". Any version up to "4" will be treated as "3", and "5" will be treated as "3".