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 tls
Type: object Default: null

Whether or not to use TLS encryption

root hosts hosts items tls anyOf item 0
Type: null

No encryption
root hosts hosts items tls anyOf TLS Certificate

TLS Certificate

Type: object

Encryption using a custom TLS certificate

root hosts hosts items tls anyOf TLS Certificate enabled
Type: boolean or null

Whether or not to use TLS encryption (default = true)

root hosts hosts items tls anyOf TLS Certificate verify_server
Type: boolean or null

Whether or not to verify the server's certificate using the provided CA Certificate (default = true)

root hosts hosts items tls anyOf TLS Certificate versions
Type: array of string or null

Which TLS versions are accepted (default = all versions are accepted)

 No Additional Items

Each item of this array must be:

root hosts hosts items tls anyOf TLS Certificate versions versions items
Type: string

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 MQTT Publication

MQTT 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 MQTT 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 MQTT Publication mode
Type: enum (of string)

Must be one of:

  • "mqtt_publication"

root hosts hosts items topics topics items datapoints datapoints items oneOf MQTT 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 MQTT Subscription

MQTT Subscription

Type: object

The mapping of a MQTT JSON value to a datapoint

root hosts hosts items topics topics items datapoints datapoints items oneOf MQTT 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 MQTT Subscription mode
Type: enum (of string)

Must be one of:

  • "mqtt_subscription"

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

If the MQTT message contains a timestamp, this is the path to the timestamp. 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 MQTT Subscription mqtt_timestamp_type

If the MQTT timestamp path is set, this is the type used to convert that path into a timestamp value. If this field is set to None, the timestamp will use unix timestamps in nanoseconds.

root hosts hosts items topics topics items datapoints datapoints items oneOf MQTT Subscription mqtt_timestamp_type anyOf ConfigTimestampType
Type: object

Supported types for the MQTT timestamp. Custom formatting based on https://docs.rs/chrono/0.4.45/chrono/format/strftime/

root hosts hosts items topics topics items datapoints datapoints items oneOf MQTT Subscription mqtt_timestamp_type anyOf item 0 oneOf item 0
Type: enum (of string)

Must be one of:

  • "UnixSeconds"
  • "UnixMilliseconds"
  • "UnixNanoseconds"
  • "FloatingUnixSeconds"
  • "FloatingUnixMilliseconds"
  • "FloatingUnixNanoseconds"
  • "Iso8601"
  • "Rfc3339"
  • "Rfc2822"
root hosts hosts items topics topics items datapoints datapoints items oneOf MQTT Subscription mqtt_timestamp_type anyOf item 0 oneOf item 1
Type: object

Custom formatting string with timezone

 No Additional Properties
root hosts hosts items topics topics items datapoints datapoints items oneOf MQTT Subscription mqtt_timestamp_type anyOf item 0 oneOf item 2
Type: object

Custom formatting string without timezone (will use local timezone)

 No Additional Properties
root hosts hosts items topics topics items datapoints datapoints items oneOf MQTT Subscription mqtt_timestamp_type anyOf item 1
Type: null

root hosts hosts items topics topics items datapoints datapoints items oneOf MQTT 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 MQTT 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

MQTT Version

Type: object

The MQTT server version

root hosts hosts items version oneOf item 0
Type: enum (of string)

For MQTT server with versions up to and including 4

Must be one of:

  • "3"
root hosts hosts items version oneOf item 1
Type: enum (of string)

For MQTT server with version 5

Must be one of:

  • "5"