Reduxi MQTT specification 1.5 documentation

Reduxi MQTT specification 1.5

application/json

Requires controller software version 20260421084600.

Generated on studio.asyncapi.com with YAML file .

Operations

PUB controllers/{controllerId}/identifier

General information about controller

Operation IDpublishIdentifier

object

controllerIdany

required

object

Accepts the following message:

Information about controller

application/json

object

Examples

{
  "unitId": "XRKPF0Q5JHPCST79",
  "unitIdFormatted": "XRKP-F0Q5-JHPC-ST79",
  "boardModel": "REDUXI_1",
  "CPUSerial": "1651660b0b01d4fc",
  "EMMCSerial": "45010044473430303801b1e6d22579af",
  "ethernetMAC": "d8:47:8f:9c:83:1a",
  "ethernetIp": "192.168.1.202",
  "eth0Ip": "192.168.1.202",
  "eth0MAC": "d8:47:8f:9c:83:1a",
  "eth1Ip": "",
  "eth1MAC": "",
  "wirelessMAC": "30:eb:1f:57:52:63",
  "wirelessIp": "",
  "mobileIp": "",
  "osVersion": "20240229105406",
  "softwareVersion": "20250623082652000",
  "hwVersion": "2",
  "hasWifiModule": true,
  "hasMobileModule": true,
  "openVpnIp": "10.4.9.218",
  "dso": {
    "entity": null
  },
  "brand": {
    "type": {
      "id": 1,
      "name": "Reduxi",
      "enumeration": "REDUXI"
    },
    "controllerName": "Reduxi",
    "controllerHostname": "reduxi"
  },
  "timezone": "Europe/London",
  "settings": {
    "init": true,
    "location": "London UK",
    "locationLat": null,
    "locationLng": null,
    "gridFuseL1": 1,
    "gridFuseL2": 2,
    "gridFuseL3": 3,
    "importPowerActiveLimit": 4000,
    "exportPowerActiveLimit": 5000
  },
  "uptime": 258340978
}

This example has been generated automatically.

PUB controllers/{controllerId}/keepAlive
Controller periodically sends keep alive ad unix timestamp in milliseconds

Operation IDpublishKeepAlive
object
controllerIdany
required
object
Accepts the following message:
application/number
Payloadnumber
Examples
12345678
This example has been generated automatically.
PUB controllers/{controllerId}/settings/interval/readout
Readout interval in milliseconds

Operation IDpublishSettingsIntervalReadout
object
controllerIdany
required
object
Accepts the following message:
application/number
Payloadnumber
Examples
12345678
This example has been generated automatically.
SUB controllers/{controllerId}/settings/interval/readout/set
Set readout interval in milliseconds

Operation IDsubscribeSettingsIntervalReadout
object
controllerIdany
required
object
Accepts the following message:
application/number
Payloadnumber
Examples
12345678
This example has been generated automatically.
PUB controllers/{controllerId}/settings/interval/keepAlive
Keep alive interval in milliseconds

Operation IDpublishSettingsIntervalKeepAlive
object
controllerIdany
required
object
Accepts the following message:
application/number
Payloadnumber
Examples
12345678
This example has been generated automatically.
SUB controllers/{controllerId}/settings/interval/keepAlive/set
Set keep alive interval in milliseconds

Operation IDsubscribeSettingsIntervalKeepAlive
object
controllerIdany
required
object
Accepts the following message:
application/number
Payloadnumber
Examples
12345678
This example has been generated automatically.
SUB controllers/{controllerId}/settings/grid/set
Set controller grid settings

Operation IDsubscribeSettingsGrid
object
controllerIdany
required
object
Accepts the following message:
Controller grid settings
application/json
object
Examples
{ "location": "someName", "gridFuseL1": 10, "gridFuseL2": 20, "gridFuseL3": 30, "importPowerActiveLimit": 4000, "exportPowerActiveLimit": 5000 }

This example has been generated automatically.
SUB controllers/{controllerId}/commands/refresh
Re-publish all metadata from controller to MQTT

Operation IDsubscribeCommandsRefresh
object
controllerIdany
required
object
Accepts the following message:
application/string
Payloadstring
Examples
This example has been generated automatically.
SUB controllers/{controllerId}/commands/reboot
Reboot the controller

Operation IDsubscribeCommandsReboot
object
controllerIdany
required
object
Accepts the following message:
application/string
Payloadstring
Examples
This example has been generated automatically.

PUB controllers/{controllerId}/devices/list

List of all devices on controller

Operation IDpublishDeviceList

object

controllerIdany

required

object

Accepts the following message:

Information about devices

application/json

array<object>

Examples

[
  {
    "id": 1,
    "name": "Electricity meter",
    "typeId": 2033,
    "type": {
      "id": 1,
      "categoryId": 1,
      "category": {
        "id": 1,
        "name": "Electricity meter",
        "enumeration": "ELECTRICITY_METER",
        "config": {
          "hide": true
        }
      },
      "name": "Iskraemeco WM3x6",
      "enumeration": "ELECTRICITY_METER"
    },
    "energyLocationId": 1,
    "energyLocation": {
      "id": 1,
      "name": "Main",
      "enumeration": "MAIN"
    },
    "energyDirectionId": 3,
    "energyDirection": {
      "id": 3,
      "name": "Consumption and production",
      "enumeration": "CONSUMPTION_AND_PRODUCTION"
    },
    "pollingDelayRead": 1000,
    "pollingDelayWrite": 1000,
    "persistSchedule": "*/5 * * * *",
    "timeoutDevice": 5000,
    "timeoutPacket": 5000,
    "importExportInvert": false,
    "categories": [
      {
        "id": 1,
        "name": "Electricity meter",
        "enumeration": "ELECTRICITY_METER"
      }
    ],
    "categoryIds": [
      1
    ],
    "categoryId": 1,
    "category": {
      "id": 1,
      "name": "Electricity meter",
      "enumeration": "ELECTRICITY_METER"
    },
    "dataTypes": [
      {
        "id": 0,
        "name": "Current L1",
        "unit": "A",
        "valueType": "FLOAT",
        "measurementType": "PERIODIC",
        "extType": "NORMAL",
        "aggregationType": "NONE",
        "enumeration": "CURRENT_L1",
        "parameter": false
      }
    ]
  }
]

This example has been generated automatically.

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

Information about device on controller

Operation IDpublishDeviceInfo

object

controllerIdany

required

deviceIdany

required

object

Accepts the following message:

Information about device

application/json

object

Examples

{
  "id": 1,
  "name": "Electricity meter",
  "typeId": 2033,
  "type": {
    "id": 1,
    "categoryId": 1,
    "category": {
      "id": 1,
      "name": "Electricity meter",
      "enumeration": "ELECTRICITY_METER",
      "config": {
        "hide": true
      }
    },
    "name": "Iskraemeco WM3x6",
    "enumeration": "ELECTRICITY_METER"
  },
  "energyLocationId": 1,
  "energyLocation": {
    "id": 1,
    "name": "Main",
    "enumeration": "MAIN"
  },
  "energyDirectionId": 3,
  "energyDirection": {
    "id": 3,
    "name": "Consumption and production",
    "enumeration": "CONSUMPTION_AND_PRODUCTION"
  },
  "pollingDelayRead": 1000,
  "pollingDelayWrite": 1000,
  "persistSchedule": "*/5 * * * *",
  "timeoutDevice": 5000,
  "timeoutPacket": 5000,
  "importExportInvert": false,
  "categories": [
    {
      "id": 1,
      "name": "Electricity meter",
      "enumeration": "ELECTRICITY_METER"
    }
  ],
  "categoryIds": [
    1
  ],
  "categoryId": 1,
  "category": {
    "id": 1,
    "name": "Electricity meter",
    "enumeration": "ELECTRICITY_METER"
  },
  "dataTypes": [
    {
      "id": 0,
      "name": "Current L1",
      "unit": "A",
      "valueType": "FLOAT",
      "measurementType": "PERIODIC",
      "extType": "NORMAL",
      "aggregationType": "NONE",
      "enumeration": "CURRENT_L1",
      "parameter": false
    }
  ]
}

This example has been generated automatically.

PUB controllers/{controllerId}/devices/{deviceId}/readout
Readout of measurements from device

Operation IDpublishDeviceReadout
object
controllerIdany
required
deviceIdany
required
object
Accepts the following message:
Readout of measurements from device
application/json
object
Examples
{ "time": "1674129782728", "values": [ { "deviceId": 0, "dataTypeId": 0, "dataTypeEnum": "IMPORT_ENERGY_ACTIVE", "time": "1674129782728", "value": 0 } ] }

This example has been generated automatically.
PUB controllers/{controllerId}/devices/{deviceId}/setpoint
Setpoints for device

Operation IDpublishDeviceSetpoint
object
controllerIdany
required
deviceIdany
required
object
Accepts the following message:
Setpoint for device
application/json
object
Examples
{ "values": [ { "action": "SET", "type": "POWER_ACTIVE", "location": "DEFAULT", "target": "MIN", "phaseType": "L1", "value": 1000, "priority": 0, "validForTime": 0 } ] }

This example has been generated automatically.
SUB controllers/{controllerId}/devices/{deviceId}/setpoint/set
Set setpoints for device

Operation IDsubscribeDeviceSetpoint
object
controllerIdany
required
deviceIdany
required
object
Accepts the following message:
Setpoint for device
application/json
object
Examples
{ "values": [ { "action": "SET", "type": "POWER_ACTIVE", "location": "DEFAULT", "target": "MIN", "phaseType": "L1", "value": 1000, "priority": 0, "validForTime": 0 } ] }

This example has been generated automatically.

PUB controllers/{controllerId}/strategies/list

List of all strategies on controller

Operation IDpublishStrategyList

object

controllerIdany

required

object

Accepts the following message:

Information about strategies

application/json

array<object>

Examples

[
  {
    "id": 1,
    "typeId": 1,
    "type": {
      "id": 1,
      "name": "Solar power plant production management",
      "enumeration": "UMBRELLA"
    },
    "name": "Limit solar power plant grid export",
    "persistSchedule": "*/5 * * * *",
    "priority": 100,
    "active": true,
    "isDefault": true,
    "dataTypes": [
      {
        "id": 0,
        "name": "Solar plant - export active power",
        "unit": "W",
        "valueType": "FLOAT",
        "measurementType": "PERIODIC",
        "extType": "NORMAL",
        "enumeration": "CURRENT_L1",
        "parameter": false
      }
    ],
    "devices": [
      {
        "id": 1,
        "deviceId": 1,
        "categoryId": 1,
        "energyLocationId": 1
      }
    ]
  }
]

This example has been generated automatically.

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

Information about strategies on controller

Operation IDpublishStrategyInfo

object

controllerIdany

required

strategyIdany

required

object

Accepts the following message:

Information about strategy

application/json

object

Examples

{
  "id": 1,
  "typeId": 1,
  "type": {
    "id": 1,
    "name": "Solar power plant production management",
    "enumeration": "UMBRELLA"
  },
  "name": "Limit solar power plant grid export",
  "persistSchedule": "*/5 * * * *",
  "priority": 100,
  "active": true,
  "isDefault": true,
  "dataTypes": [
    {
      "id": 0,
      "name": "Solar plant - export active power",
      "unit": "W",
      "valueType": "FLOAT",
      "measurementType": "PERIODIC",
      "extType": "NORMAL",
      "enumeration": "CURRENT_L1",
      "parameter": false
    }
  ],
  "devices": [
    {
      "id": 1,
      "deviceId": 1,
      "categoryId": 1,
      "energyLocationId": 1
    }
  ]
}

This example has been generated automatically.

PUB controllers/{controllerId}/strategies/{strategyId}/readout
Readout of measurements from strategy

Operation IDpublishStrategyReadout
object
controllerIdany
required
strategyIdany
required
object
Accepts the following message:
Readout of measurements from strategy
application/json
object
Examples
{ "time": "1674129782728", "values": [ { "strategyId": 0, "dataTypeId": 0, "dataTypeEnum": "MAIN_CURRENT_L1", "time": "1674129782728", "value": 0 } ] }

This example has been generated automatically.
PUB controllers/{controllerId}/strategies/{strategyId}/parameters/{parameterId}/value
Parameters for strategy

Operation IDpublishStrategyParameterValue
object
controllerIdany
required
strategyIdany
required
parameterIdany
required
object
Accepts the following message:
application/number
Payloadnumber
Examples
12345678
This example has been generated automatically.
SUB controllers/{controllerId}/strategies/{strategyId}/parameters/{parameterId}/value/set
Set value for strategy parameter

Operation IDsubscribeStrategyParameterValue
object
controllerIdany
required
strategyIdany
required
parameterIdany
required
object
Accepts the following message:
application/number
Payloadnumber
Examples
12345678
This example has been generated automatically.
PUB controllers/{controllerId}/strategies/{strategyId}/parameters/{parameterId}/info
Parameters for strategy

Operation IDpublishStrategyParameterInfo
object
controllerIdany
required
strategyIdany
required
parameterIdany
required
object
Accepts the following message:
Readout of measurements from strategy
application/json
object
Examples
{ "id": 0, "name": "Solar plant - export active power", "unit": "W", "valueType": "FLOAT", "measurementType": "PERIODIC", "extType": "NORMAL", "enumeration": "CURRENT_L1", "parameter": false }

This example has been generated automatically.
PUB controllers/{controllerId}/strategies/{strategyId}/active
Status of strategy (active/inactive)

Operation IDpublishStrategyActive
object
controllerIdany
required
strategyIdany
required
object
Accepts the following message:
application/string
Payloadstring
Examples values:
"true"
"false"
Examples
#1 Example
true

#2 Example
false
SUB controllers/{controllerId}/strategies/{strategyId}/active/set
Status of strategy (active/inactive)

Operation IDsubscribeStrategyActive
object
controllerIdany
required
strategyIdany
required
object
Accepts the following message:
application/string
Payloadstring
Examples values:
"true"
"false"
Examples
#1 Example
true

#2 Example
false
PUB controllers/{controllerId}/strategies/{strategyId}/externalEMS/{externalEMSType}
External EMS settings

Operation IDpublishStrategyExternalEMS
object
controllerIdstring
required
strategyIdinteger
required
string
required
object
Accepts the following message:
Information about external EMS settings
application/json
object
Examples
{ "schedule": [ { "start": "1674129782728", "end": "1674129782728", "value": "1000 for 1 kW charge power active setpoint, -1000 for 1 kW discharge power active setpoint, OFF/REDUCE_1/ON/BOOST_1 for HVAC setpoint" } ] }

This example has been generated automatically.
SUB controllers/{controllerId}/strategies/{strategyId}/externalEMS/{externalEMSType}/refresh
Refresh external EMS settings

Operation IDsubscribeStrategyExternalEMSRefresh
object
controllerIdstring
required
strategyIdinteger
required
string
required
object
Accepts the following message:
application/string
Payloadstring
Examples
This example has been generated automatically.
SUB controllers/{controllerId}/strategies/{strategyId}/externalEMS/{externalEMSType}/set
Set external EMS settings

Operation IDsubscribeStrategyExternalEMSSet
object
controllerIdstring
required
strategyIdinteger
required
string
required
object
Accepts the following message:
Information about external EMS settings
application/json
object
Examples
{ "schedule": [ { "start": "1674129782728", "end": "1674129782728", "value": "1000 for 1 kW charge power active setpoint, -1000 for 1 kW discharge power active setpoint, OFF/REDUCE_1/ON/BOOST_1 for HVAC setpoint" } ] }

This example has been generated automatically.

Messages

#1Information about controller
- application/json
Message IDidentifier
object
#2Controller grid settings
- application/json
Message IDgridSettings
object
#3
- application/number
Message IDnumber
Payloadnumber
#4
- application/string
Message IDempty
Payloadstring
#5
- application/string
Message IDboolean
Payloadstring
Examples values:
"true"
"false"
#6Information about device
- application/json
Message IDdevice
object
#7Information about devices
- application/json
Message IDdeviceList
array<object>
#8Information about device types
- application/json
Message IDdeviceTypes
array<object>
#9Readout of measurements from device
- application/json
Message IDdeviceReadout
object
#10Setpoint for device
- application/json
Message IDdeviceSetpoint
object
#11Information about strategy
- application/json
Message IDstrategy
object
#12Information about strategies
- application/json
Message IDstrategyList
array<object>
#13Information about strategy types
- application/json
Message IDstrategyTypes
array<object>
#14Readout of measurements from strategy
- application/json
Message IDstrategyReadout
object
#15Readout of measurements from strategy
- application/json
Message IDstrategyParameterInfo
object
#16Information about external EMS settings
- application/json
Message IDstrategyExternalEMS
object

Schemas

timeinteger
Unix timestamp in milliseconds
object
object
object
object
integer
Device category: 1 - Electricity meter 2 - Solar power plant 3 - EV charger 4 - Battery 5 - HVAC/Heat pump 6 - Other 7 - Hybrid inverter 8 - Emulator
object
object
object
object
object
object
object
object
object
object
object
object
string
Strategy type enumeration: UNKNOWN - Unknown type LIMIT_DYNAMIC - Dynamic limit LIMIT_STATIC - Static limit LIMIT_SOLAR - Solar limit BATTERY - Battery DISCRETE_POWER - Discrete power DISCRETE_CURRENT_PHASE_1 - Discrete current phase 1 DISCRETE_CURRENT_PHASE_3 - Discrete current phase 3 UMBRELLA - Umbrella
object

Reduxi MQTT specification 1.5

Operations

PUB controllers/{controllerId}/identifier

Examples

This example has been generated automatically.

PUB controllers/{controllerId}/keepAlive

Examples

This example has been generated automatically.

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

Examples

This example has been generated automatically.

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

Examples

This example has been generated automatically.

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

Examples

This example has been generated automatically.

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

Examples

This example has been generated automatically.

SUB controllers/{controllerId}/settings/grid/set

Examples

This example has been generated automatically.

SUB controllers/{controllerId}/commands/refresh

Examples

This example has been generated automatically.

SUB controllers/{controllerId}/commands/reboot

Examples

This example has been generated automatically.

PUB controllers/{controllerId}/devices/list

Examples

This example has been generated automatically.

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

Examples

This example has been generated automatically.

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

Examples

This example has been generated automatically.

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

Examples

This example has been generated automatically.

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

Examples

This example has been generated automatically.

PUB controllers/{controllerId}/strategies/list

Examples

This example has been generated automatically.

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

Examples

This example has been generated automatically.

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

Examples

This example has been generated automatically.

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

Examples

This example has been generated automatically.

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

Examples

This example has been generated automatically.

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

Examples

This example has been generated automatically.

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

Examples

#1 Example

#2 Example

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

Examples

#1 Example

#2 Example

PUB controllers/{controllerId}/strategies/{strategyId}/externalEMS/{externalEMSType}

Examples

This example has been generated automatically.

SUB controllers/{controllerId}/strategies/{strategyId}/externalEMS/{externalEMSType}/refresh

Examples

This example has been generated automatically.

SUB controllers/{controllerId}/strategies/{strategyId}/externalEMS/{externalEMSType}/set

Examples

This example has been generated automatically.

Messages