IoT Open MQTT API Specification 2.0

Operations

IoT Open MQTT API Specification 2.0

Description

Servers

aam.iotopen.se:8883 MQTT-TLS

IoT Open main server

Security:
  • User / Password:

    API-Key as password and random username
aam.iotopen.se/mqtt MQTT-Websocket

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

Parameters
client_id
required
number
subsystem
required
string

Accepts the following message:

Value Time Message valueMessage

The topic/message define what type of value has been sent

Payload
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.

Sub {client_id}/evt/{subsystem}/#

Receive events

Receive event updates for specified subsystem on client-id.

Parameters
client_id
required
number
subsystem
required
string

Accepts the following message:

Value Time Message valueMessage

The topic/message define what type of value has been sent

Payload
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.

Pub {client_id}/obj/{subsystem}/#

Publish values

Publish values to other listeners

Parameters
client_id
required
number
subsystem
required
string

Accepts the following message:

Value Time Message valueMessage

The topic/message define what type of value has been sent

Payload
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.

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.

Parameters
client_id
required
number
subsystem
required
string

Accepts the following message:

Pending message pendingMessage

Pending value after a set operation

Payload
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

pending
object

New value has been requested but not yet confirmed

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.

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.

Parameters
client_id
required
number
subsystem
required
string

Accepts the following message:

Value Message valueMessage

The topic/message define what type of value has been sent

Payload
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.

Pub {client_id}/cmd/{subsystem}/#

Publish command

Publish a command to a subsystem

Parameters
client_id
required
number
subsystem
required
string

Accepts the following message:

Undefined message undefinedMessage

Message where no parameters are specified

Payload
object

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

Parameters
client_id
required
number
subsystem
required
string

Accepts the following message:

Undefined message undefinedMessage

Message where no parameters are specified

Payload
object

Additional properties are allowed.

Examples

{}
This example has been generated automatically.