Reduxi MQTT specification 1.2

Requires controller software version 20240917122343.

Generated on studio.asyncapi.com with YAML file.

Operations

  • PUB controllers/{controllerId}/identifier

    Information about controller

    Operation IDpublishIdentifier
    controllerId
    required
    any

    Accepts the following message:

    Information about controlleridentifier
    object
    uid: identifier

    Examples

  • PUB controllers/{controllerId}/keepAlive

    Controller periodically sends keep alive ad unix timestamp in milliseconds

    Operation IDpublishKeepAlive
    controllerId
    required
    any

    Accepts the following message:

    Number
    Payload
    number

    Examples

  • PUB controllers/{controllerId}/settings/interval/readout

    Readout interval in milliseconds

    Operation IDpublishSettingsIntervalReadout
    controllerId
    required
    any

    Accepts the following message:

    Number
    Payload
    number

    Examples

  • SUB controllers/{controllerId}/settings/interval/readout/set

    Set readout interval in milliseconds

    Operation IDsubscribeSettingsIntervalReadout
    controllerId
    required
    any

    Accepts the following message:

    Number
    Payload
    number

    Examples

  • PUB controllers/{controllerId}/settings/interval/keepAlive

    Keep alive interval in milliseconds

    Operation IDpublishSettingsIntervalKeepAlive
    controllerId
    required
    any

    Accepts the following message:

    Number
    Payload
    number

    Examples

  • SUB controllers/{controllerId}/settings/interval/keepAlive/set

    Set keep alive interval in milliseconds

    Operation IDsubscribeSettingsIntervalKeepAlive
    controllerId
    required
    any

    Accepts the following message:

    Number
    Payload
    number

    Examples

  • SUB controllers/{controllerId}/commands/refresh

    Re-publish all metadata from controller to MQTT

    Operation IDsubscribeCommandsRefresh
    controllerId
    required
    any

    Accepts the following message:

    Empty
    Payload
    string

    Examples

  • SUB controllers/{controllerId}/commands/reboot

    Reboot the controller

    Operation IDsubscribeCommandsReboot
    controllerId
    required
    any

    Accepts the following message:

    Empty
    Payload
    string

    Examples

  • PUB controllers/{controllerId}/devices/list

    List of all devices on controller

    Operation IDpublishDeviceList
    controllerId
    required
    any

    Accepts the following message:

    Information about devicesDevice list
    array<object>

    Examples

  • PUB controllers/{controllerId}/devices/{deviceId}/info

    Information about device on controller

    Operation IDpublishDeviceInfo
    controllerId
    required
    any
    deviceId
    required
    any

    Accepts the following message:

    Information about deviceDevice
    object
    uid: device

    Examples

  • PUB controllers/{controllerId}/devices/{deviceId}/readout

    Readout of measurements from device

    Operation IDpublishDeviceReadout
    controllerId
    required
    any
    deviceId
    required
    any

    Accepts the following message:

    Readout of measurements from deviceDevice readout
    object
    uid: deviceReadout

    Examples

  • PUB controllers/{controllerId}/devices/{deviceId}/setpoint

    Setpoints for device

    Operation IDpublishDeviceSetpoint
    controllerId
    required
    any
    deviceId
    required
    any

    Accepts the following message:

    Setpoint for deviceDevice setpoint
    object
    uid: deviceSetpoint

    Examples

  • SUB controllers/{controllerId}/devices/{deviceId}/setpoint/set

    Set setpoints for device

    Operation IDsubscribeDeviceSetpoint
    controllerId
    required
    any
    deviceId
    required
    any

    Accepts the following message:

    Setpoint for deviceDevice setpoint
    object
    uid: deviceSetpoint

    Examples

  • PUB controllers/{controllerId}/strategies/list

    List of all strategies on controller

    Operation IDpublishStrategyList
    controllerId
    required
    any

    Accepts the following message:

    Information about strategiesStrategy list
    array<object>

    Examples

  • PUB controllers/{controllerId}/strategies/{strategyId}/info

    Information about strategies on controller

    Operation IDpublishStrategyInfo
    controllerId
    required
    any
    strategyId
    required
    any

    Accepts the following message:

    Information about strategyStrategy
    object
    uid: strategy

    Examples

  • PUB controllers/{controllerId}/strategies/{strategyId}/readout

    Readout of measurements from strategy

    Operation IDpublishStrategyReadout
    controllerId
    required
    any
    strategyId
    required
    any

    Accepts the following message:

    Readout of measurements from strategyStrategy readout
    object
    uid: strategyReadout

    Examples

  • PUB controllers/{controllerId}/strategies/{strategyId}/parameters/{parameterId}/value

    Parameters for strategy

    Operation IDpublishStrategyParameterValue
    controllerId
    required
    any
    strategyId
    required
    any
    parameterId
    required
    any

    Accepts the following message:

    Number
    Payload
    number

    Examples

  • SUB controllers/{controllerId}/strategies/{strategyId}/parameters/{parameterId}/value/set

    Set value for strategy parameter

    Operation IDsubscribeStrategyParameterValue
    controllerId
    required
    any
    strategyId
    required
    any
    parameterId
    required
    any

    Accepts the following message:

    Number
    Payload
    number

    Examples

  • PUB controllers/{controllerId}/strategies/{strategyId}/parameters/{parameterId}/info

    Parameters for strategy

    Operation IDpublishStrategyParameterInfo
    controllerId
    required
    any
    strategyId
    required
    any
    parameterId
    required
    any

    Accepts the following message:

    Readout of measurements from strategyStrategy parameter info
    object
    uid: strategyDataType

    Examples

  • PUB controllers/{controllerId}/strategies/{strategyId}/active

    Status of strategy (active/inactive)

    Operation IDpublishStrategyActive
    controllerId
    required
    any
    strategyId
    required
    any

    Accepts the following message:

    Boolean
    Payload
    string
      Examples values:
    • "true"
    • "false"

    Examples

  • SUB controllers/{controllerId}/strategies/{strategyId}/active/set

    Status of strategy (active/inactive)

    Operation IDsubscribeStrategyActive
    controllerId
    required
    any
    strategyId
    required
    any

    Accepts the following message:

    Boolean
    Payload
    string
      Examples values:
    • "true"
    • "false"

    Examples

Messages

  • #1Information about controlleridentifier
    object
    uid: identifier
  • #2Number
    Payload
    number
  • #3Empty
    Payload
    string
  • #4Boolean
    Payload
    string
      Examples values:
    • "true"
    • "false"
  • #5Information about deviceDevice
    object
    uid: device
  • #6Information about devicesDevice list
    array<object>
  • #7Information about device typesDevice type list
    array<object>
  • #8Readout of measurements from deviceDevice readout
    object
    uid: deviceReadout
  • #9Setpoint for deviceDevice setpoint
    object
    uid: deviceSetpoint
  • #10Information about strategyStrategy
    object
    uid: strategy
  • #11Information about strategiesStrategy list
    array<object>
  • #12Information about strategy typesStrategy types
    array<object>
  • #13Readout of measurements from strategyStrategy readout
    object
    uid: strategyReadout
  • #14Readout of measurements from strategyStrategy parameter info
    object
    uid: strategyDataType

Schemas

  • time
    integer
    uid: time

    Unix timestamp in milliseconds

  • object
    uid: identifier
  • object
    uid: device
  • object
    uid: deviceType
  • object
    uid: deviceDataType
  • object
    uid: deviceReadout
  • object
    uid: deviceReadoutValue
  • object
    uid: deviceSetpoint
  • object
    uid: deviceSetpointValue
  • object
    uid: strategyReadout
  • object
    uid: strategyReadoutValue
  • object
    uid: strategy
  • object
    uid: strategyType
  • object
    uid: strategyDataType