IoT Open MQTT API Specification 2.0 documentation

IoT Open MQTT API Specification 2.0

application/json

Description

Servers

MQTT-TLS://lynx.iotopen.se:8883/MQTT-TLSMQTT
IoT Open main server
Security:
User/Password
API-Key as password and random username
MQTT-Websocket://lynx.iotopen.se/mqttMQTT-WebsocketWebsocket
Websocket interface for IoT Open main server.
Security:
User/Password
API-Key as password and random username

Operations

RECEIVE {client_id}/evt/{subsystem}/#
Publish events
Publish events to other listeners

Operation IDpublishEvents
Available only on servers:
- MQTT
- Websocket
object
client_id
required
string
The client-id for installation

subsystem
required
string
The subsystems unique identifier
Accepts the following message:
Value Time Message
The topic/message define what type of value has been sent
application/json
object
timestamp
required
number
The timestamp for this message, may be with decimal milliseconds

value
required
number
The reported value

msg
string
Optional extra information that may be used in other applications

Additional properties are NOT allowed.
Examples
{ "timestamp": 0, "value": 0, "msg": "string" }

This example has been generated automatically.
SEND {client_id}/evt/{subsystem}/#
Receive events
Receive event updates for specified subsystem on client-id.

Operation IDreceiveEvents
Available only on servers:
- MQTT
- Websocket
object
client_id
required
string
The client-id for installation

subsystem
required
string
The subsystems unique identifier
Accepts the following message:
Value Time Message
The topic/message define what type of value has been sent
application/json
object
timestamp
required
number
The timestamp for this message, may be with decimal milliseconds

value
required
number
The reported value

msg
string
Optional extra information that may be used in other applications

Additional properties are NOT allowed.
Examples
{ "timestamp": 0, "value": 0, "msg": "string" }

This example has been generated automatically.
RECEIVE {client_id}/obj/{subsystem}/#
Publish values
Publish values to other listeners

Operation IDpublishObject
Available only on servers:
- MQTT
- Websocket
object
client_id
required
string
The client-id for installation

subsystem
required
string
The subsystems unique identifier
Accepts the following message:
Value Time Message
The topic/message define what type of value has been sent
application/json
object
timestamp
required
number
The timestamp for this message, may be with decimal milliseconds

value
required
number
The reported value

msg
string
Optional extra information that may be used in other applications

Additional properties are NOT allowed.
Examples
{ "timestamp": 0, "value": 0, "msg": "string" }

This example has been generated automatically.
SEND {client_id}/obj/{subsystem}/#
Receive values
Receive object values, objects path is defined by the sub-topic in that subsystem. Objects report the value when it's confirmed by the device or subsystem. Eg. Z-wave values are published here only if the device reports the final value.

Operation IDreceiveObject
Available only on servers:
- MQTT
- Websocket
object
client_id
required
string
The client-id for installation

subsystem
required
string
The subsystems unique identifier
Accepts the following message:
Pending message
Pending value after a set operation
application/json
object
timestamp
required
number
The timestamp for this message, may be with decimal milliseconds

value
required
number
The reported value

msg
string
Optional extra information that may be used in other applications

object
timestamp
required
number
The timestamp for this message, may be with decimal milliseconds

value
required
number
The reported value

msg
string
Optional extra information that may be used in other applications

Additional properties are NOT allowed.
Additional properties are NOT allowed.
Examples
{ "timestamp": 0, "value": 0, "msg": "string", "pending": { "timestamp": 0, "value": 0, "msg": "string" } }

This example has been generated automatically.
RECEIVE {client_id}/set/{subsystem}/#
Set value
Ask a system to set a object to a new value. Eg. Ask a lamp to turn on.

Operation IDpublishSetObject
Available only on servers:
- MQTT
- Websocket
object
client_id
required
string
The client-id for installation

subsystem
required
string
The subsystems unique identifier
Accepts the following message:
Value Message
The topic/message define what type of value has been sent
application/json
object
value
required
number
The reported value

msg
string
Optional extra information that may be used in other applications

Additional properties are NOT allowed.
Examples
{ "value": 0, "msg": "string" }

This example has been generated automatically.
RECEIVE {client_id}/cmd/{subsystem}/#
Publish command
Publish a command to a subsystem

Operation IDpublishCommand
Available only on servers:
- MQTT
- Websocket
object
client_id
required
string
The client-id for installation

subsystem
required
string
The subsystems unique identifier
Accepts the following message:
Undefined message
Message where no parameters are specified
application/json
object
Additional properties are allowed.
Examples
{}

This example has been generated automatically.
SEND {client_id}/cmd/{subsystem}/#
Receive commands
Receive commands to control operations for a specific subsystem

Operation IDreceiveCommands
Available only on servers:
- MQTT
- Websocket
object
client_id
required
string
The client-id for installation

subsystem
required
string
The subsystems unique identifier
Accepts the following message:
Undefined message
Message where no parameters are specified
application/json
object
Additional properties are allowed.
Examples
{}

This example has been generated automatically.

Messages

#1Value MessagevalueMessage
The topic/message define what type of value has been sent
- application/json
Message IDvalueMessage
object
value
required
number
The reported value

msg
string
Optional extra information that may be used in other applications

Additional properties are NOT allowed.
#2Value Time MessagevalueTimeMessage
The topic/message define what type of value has been sent
- application/json
Message IDvalueTimeMessage
object
timestamp
required
number
The timestamp for this message, may be with decimal milliseconds

value
required
number
The reported value

msg
string
Optional extra information that may be used in other applications

Additional properties are NOT allowed.
#3Pending messagependingMessage
Pending value after a set operation
- application/json
Message IDpendingMessage
object
timestamp
required
number
The timestamp for this message, may be with decimal milliseconds

value
required
number
The reported value

msg
string
Optional extra information that may be used in other applications

object
timestamp
required
number
The timestamp for this message, may be with decimal milliseconds

value
required
number
The reported value

msg
string
Optional extra information that may be used in other applications

Additional properties are NOT allowed.
Additional properties are NOT allowed.
#4Undefined messageundefinedMessage
Message where no parameters are specified
- application/json
Message IDundefinedMessage
object
Additional properties are allowed.

Schemas

object
timestamp
required
number
The timestamp for this message, may be with decimal milliseconds

value
required
number
The reported value

msg
string
Optional extra information that may be used in other applications

object
timestamp
required
number
The timestamp for this message, may be with decimal milliseconds

value
required
number
The reported value

msg
string
Optional extra information that may be used in other applications

Additional properties are NOT allowed.
Additional properties are NOT allowed.
object
value
required
number
The reported value

msg
string
Optional extra information that may be used in other applications

Additional properties are NOT allowed.
object
timestamp
required
number
The timestamp for this message, may be with decimal milliseconds

value
required
number
The reported value

msg
string
Optional extra information that may be used in other applications

Additional properties are NOT allowed.
value
number
The reported value
msg
string
Optional extra information that may be used in other applications
timestamp
number
The timestamp for this message, may be with decimal milliseconds
object
Additional properties are allowed.

IoT Open MQTT API Specification 2.0

Servers

Security:

Security:

Operations

RECEIVE {client_id}/evt/{subsystem}/#

Examples

This example has been generated automatically.

SEND {client_id}/evt/{subsystem}/#

Examples

This example has been generated automatically.

RECEIVE {client_id}/obj/{subsystem}/#

Examples

This example has been generated automatically.

SEND {client_id}/obj/{subsystem}/#

Examples

This example has been generated automatically.

RECEIVE {client_id}/set/{subsystem}/#

Examples

This example has been generated automatically.

RECEIVE {client_id}/cmd/{subsystem}/#

Examples

This example has been generated automatically.

SEND {client_id}/cmd/{subsystem}/#

Examples

This example has been generated automatically.

Messages

Schemas