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}/#
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 MessagepublishEvents.message
The topic/message define what type of value has been sent
application/json
Message IDpublishEvents.message
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}/#
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 MessagepublishEvents.message
The topic/message define what type of value has been sent
application/json
Message IDpublishEvents.message
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}/#
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 MessagepublishEvents.message
The topic/message define what type of value has been sent
application/json
Message IDpublishEvents.message
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}/#
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 messagereceiveObject.message
Pending value after a set operation
application/json
Message IDreceiveObject.message
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}/#
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 MessagepublishSetObject.message
The topic/message define what type of value has been sent
application/json
Message IDpublishSetObject.message
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}/#
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 messagepublishCommand.message
Message where no parameters are specified
application/json
Message IDpublishCommand.message
object
Additional properties are allowed.
Examples
{}

This example has been generated automatically.
SEND {client_id}/cmd/{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 messagepublishCommand.message
Message where no parameters are specified
application/json
Message IDpublishCommand.message
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