Oxygen-MQTT Configuration

Type: object

The configuration for Oxygen MQTT plugin.

root version
Type: enum (of string)

The version of the config-file-schema. Must be supported by the plugin-release.

Must be one of:

  • "0.1"

root servers
Type: array of object

Servers the plugin will try to connect to in given order.

Must contain a minimum of 1 items

All items must be unique

Each item of this array must be:

root servers servers items
Type: object

root servers servers items url
Type: string

The Server-URL

root topics
Type: object

All property whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^/
root topics topic-item
Type: object

root topics ^/ oneOf item 0
Type: object

The following properties are required:

  • publish
root topics ^/ oneOf item 1
Type: object

The following properties are required:

  • subscribe

root topics ^/ publish
Type: object

root topics ^/ publish sampling
Type: object

root topics ^/ publish sampling type
Type: enum (of string)

The sampling mode of the Oxygen-Channel to publish

Must be one of:

  • "sync"
  • "async"

root topics ^/ publish sampling downsampling-factor
Type: integer

Downsample Oxygen-Sync channels by given factor.

root topics ^/ publish payload
Type: object

root topics ^/ publish payload type
Type: enum (of string)

The datatype of the Oxygen-Channel.

Must be one of:

  • "number"
  • "integer"
  • "string"

root topics ^/ publish payload samples-per-packet
Type: integer

The number of samples within every MQTT payload packet. Only used for sampling-mode sync.

root topics ^/ subscribe
Type: object

root topics ^/ subscribe sampling
Type: object

root topics ^/ subscribe sampling oneOf item 0
Type: object

root topics ^/ subscribe sampling oneOf item 0 type
Type: enum (of string)

Must be one of:

  • "async"
root topics ^/ subscribe sampling oneOf item 1
Type: object

The following properties are required:

  • sample-rate

root topics ^/ subscribe sampling oneOf item 1 type
Type: enum (of string)

Must be one of:

  • "sync"

root topics ^/ subscribe sampling type
Type: enum (of string)

The sampling mode of the subscription - corresponds to the underlying payload protocol

Must be one of:

  • "async"
  • "sync"

root topics ^/ subscribe sampling sample-rate
Type: number

Sampling rate for sync-channels - corresponds to the underlying payload protocol.

root topics ^/ subscribe sampling clock
Type: string

Synced channels can share a common clock domain (depending on the procol). This domains are identified by their clock name

root topics ^/ subscribe payload
Type: object

root topics ^/ subscribe payload oneOf item 0
Type: object

The following properties are required:

  • text/json
root topics ^/ subscribe payload oneOf item 1
Type: object

The following properties are required:

  • text/plain
root topics ^/ subscribe payload oneOf item 2
Type: object

The following properties are required:

  • cbor/json/sync

root topics ^/ subscribe payload text/json
Type: object

Interpreting payload as JSON-Data. Every property in schema becomes a channel in Oxygen grouped by the Topic.

root topics ^/ subscribe payload text/json schema
Type: object

All property whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[A-Za-z][A-Za-z0-9_-]*$
root topics ^/ subscribe payload text/json schema json-schema
Type: object

root topics ^/ subscribe payload text/json schema ^[A-Za-z][A-Za-z0-9_-]*$ anyOf item 0
Type: object

The following properties are required:

  • properties

root topics ^/ subscribe payload text/json schema ^[A-Za-z][A-Za-z0-9_-]*$ anyOf item 0 type
Type: enum (of string)

Must be one of:

  • "object"
root topics ^/ subscribe payload text/json schema ^[A-Za-z][A-Za-z0-9_-]*$ anyOf item 1
Type: object

root topics ^/ subscribe payload text/json schema ^[A-Za-z][A-Za-z0-9_-]*$ anyOf item 1 type
Type: enum (of string)

Must be one of:

  • "integer"
  • "number"
  • "string"

root topics ^/ subscribe payload text/json schema ^[A-Za-z][A-Za-z0-9_-]*$ type
Type: enum (of string)

If type is object, then JSON-Payload is nested, else this will become a channel in Oxygen.

Must be one of:

  • "object"
  • "integer"
  • "number"

root topics ^/ subscribe payload text/json schema ^[A-Za-z][A-Za-z0-9_-]*$ range
Type: object

root topics ^/ subscribe payload text/json schema ^[A-Za-z][A-Za-z0-9_-]*$ range min
Type: number

Minimum value of range

root topics ^/ subscribe payload text/json schema ^[A-Za-z][A-Za-z0-9_-]*$ range max
Type: number

Maximum value of range

root topics ^/ subscribe payload text/json schema ^[A-Za-z][A-Za-z0-9_-]*$ range unit
Type: string

Unit of range

root topics ^/ subscribe payload text/json schema ^[A-Za-z][A-Za-z0-9_-]*$ properties
Type: object

All property whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[A-Za-z][A-Za-z0-9_-]*$
root topics ^/ subscribe payload text/json schema ^[A-Za-z][A-Za-z0-9_-]*$ properties json-schema
Type: object
Same definition as topics_pattern1_subscribe_payload_text_json_schema_pattern1

root topics ^/ subscribe payload text/plain
Type: object

Interpreting payload as plain text. E.g.: my/mqtt/topic/1.25

root topics ^/ subscribe payload text/plain schema
Type: object

The schema of the payload

root topics ^/ subscribe payload text/plain schema type
Type: enum (of string)

The datatype of the payload: how payload as ASCII should be interpreted by the plugin.

Must be one of:

  • "number"
  • "integer"
  • "string"

root topics ^/ subscribe payload text/plain schema range
Type: object
Same definition as range

root topics ^/ subscribe payload cbor/json/sync
Type: object

Interpreting payload as CBOR JSON complying to sync-protocol. TODO: Write specification.

root topics ^/ subscribe payload cbor/json/sync schema
Type: object

root topics ^/ subscribe payload cbor/json/sync schema type
Type: enum (of string)

Datatype used within the cbor-sync protocol.

Must be one of:

  • "number"
  • "integer"

root topics ^/ QoS
Type: integer

The MQTT Quality of Service for operations done on this topic