IoT Open MQTT API Specification 2.0 documentation

IoT Open MQTT API Specification 2.0

application/json

Description

Servers

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

Operations

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

Operation IDpublishEvents
client_id
required
number
uid: client_id
The client-id for installation

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

value
required
number
uid: value
The reported value

msg
string
uid: msg
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.
SUB {client_id}/evt/{subsystem}/#
Receive events
Receive event updates for specified subsystem on client-id.

Operation IDreceiveEvents
client_id
required
number
uid: client_id
The client-id for installation

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

value
required
number
uid: value
The reported value

msg
string
uid: msg
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.
PUB {client_id}/obj/{subsystem}/#
Publish values
Publish values to other listeners

Operation IDpublishObject
client_id
required
number
uid: client_id
The client-id for installation

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

value
required
number
uid: value
The reported value

msg
string
uid: msg
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.
SUB {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
client_id
required
number
uid: client_id
The client-id for installation

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

value
required
number
uid: value
The reported value

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

object
New value has been requested but not yet confirmed

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

value
required
number
uid: value
The reported value

msg
string
uid: msg
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.
PUB {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
client_id
required
number
uid: client_id
The client-id for installation

subsystem
required
string
uid: subsystem
The subsystems unique identifier
Accepts the following message:
Value MessagevalueMessage
The topic/message define what type of value has been sent
application/json
object
uid: valuePayload
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.
PUB {client_id}/cmd/{subsystem}/#
Publish command
Publish a command to a subsystem

Operation IDpublishCommand
client_id
required
number
uid: client_id
The client-id for installation

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

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

Operation IDreceiveCommands
client_id
required
number
uid: client_id
The client-id for installation

subsystem
required
string
uid: subsystem
The subsystems unique identifier
Accepts the following message:
Undefined messageundefinedMessage
Message where no parameters are specified
object
uid: undefinedPayload
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
object
uid: valuePayload
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 MessagevalueMessage
The topic/message define what type of value has been sent
- application/json
object
uid: valueTimePayload
timestamp
required
number
uid: timestamp
The timestamp for this message, may be with decimal milliseconds

value
required
number
uid: value
The reported value

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

Additional properties are NOT allowed.
#3Pending messagependingMessage
Pending value after a set operation
object
uid: pendingPayload
timestamp
required
number
uid: timestamp
The timestamp for this message, may be with decimal milliseconds

value
required
number
uid: value
The reported value

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

object
New value has been requested but not yet confirmed

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

value
required
number
uid: value
The reported value

msg
string
uid: msg
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
object
uid: undefinedPayload
Additional properties are allowed.

Schemas

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

value
required
number
uid: value
The reported value

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

object
New value has been requested but not yet confirmed

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

value
required
number
uid: value
The reported value

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

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

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

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

value
required
number
uid: value
The reported value

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

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

IoT Open MQTT API Specification 2.0

Servers

Security:

Security:

Operations

PUB {client_id}/evt/{subsystem}/#

Examples

This example has been generated automatically.

SUB {client_id}/evt/{subsystem}/#

Examples

This example has been generated automatically.

PUB {client_id}/obj/{subsystem}/#

Examples

This example has been generated automatically.

SUB {client_id}/obj/{subsystem}/#

Examples

This example has been generated automatically.

PUB {client_id}/set/{subsystem}/#

Examples

This example has been generated automatically.

PUB {client_id}/cmd/{subsystem}/#

Examples

This example has been generated automatically.

SUB {client_id}/cmd/{subsystem}/#

Examples

This example has been generated automatically.

Messages

Schemas