MQTT Device API Reference
Getting started
MQTT basics
MQTT is a lightweight publish-subscribe messaging protocol which probably makes it the most suitable for various IoT devices. You can find more information about MQTT here.
NDU server nodes act as an MQTT Broker that supports QoS levels 0 (at most once) and 1 (at least once) and a set of predefined topics.
Client libraries setup
You can find a large number of MQTT client libraries on the web. Examples in this article will be based on Mosquitto and MQTT.js.
MQTT Connect
We will use access token device credentials in this article and they will be referred to later as $ACCESS_TOKEN.
The application needs to send MQTT CONNECT message with username that contains $ACCESS_TOKEN.
Possible return codes and their reasons during connect sequence:
- 0x00 Connected - Successfully connected to
- 0x04 Connection Refused, bad user name or password - Username is empty.
- 0x05 Connection Refused, not authorized - Username contains invalid $ACCESS_TOKEN.
By default, NDU supports key-value content in JSON. Key is always a string, while value can be either string, boolean, double, long or JSON.
Using custom binary format or some serialization framework is also possible.
For example:
1
2
3
4
5
6
7
8
9
10
11
| {
"stringKey":"value1",
"booleanKey":true,
"doubleKey":42.0,
"longKey":73,
"jsonKey": {
"someNumber": 42,
"someArray": [1,2,3],
"someNestedObject": {"key": "value"}
}
}
|
Telemetry upload API
In order to publish telemetry data to NDU server node, send PUBLISH message to the following topic:
1
| v1/devices/me/telemetry
|
The simplest supported data formats are:
1
| {"key1":"value1", "key2":"value2"}
|
or
1
| [{"key1":"value1"}, {"key2":"value2"}]
|
Please note that in this case, the server-side timestamp will be assigned to uploaded data!
In case your device is able to get the client-side timestamp, you can use following format:
1
| {"ts":1451649600512, "values":{"key1":"value1", "key2":"value2"}}
|
In the example above, we assume that “1451649600512” is a unix timestamp with milliseconds precision.
For example, the value ‘1451649600512’ corresponds to ‘Fri, 01 Jan 2016 12:00:00.512 GMT’
resources/mosquitto-telemetry.sh |
|---|
1
2
3
4
5
6
| # Publish data as an object without timestamp (server-side timestamp will be used)
mosquitto_pub -d -h "smartapp.netcad.com" -t "v1/devices/me/telemetry" -u "$ACCESS_TOKEN" -f "telemetry-data-as-object.json"
# Publish data as an array of objects without timestamp (server-side timestamp will be used)
mosquitto_pub -d -h "smartapp.netcad.com" -t "v1/devices/me/telemetry" -u "$ACCESS_TOKEN" -f "telemetry-data-as-array.json"
# Publish data as an object with timestamp (server-side timestamp will be used)
mosquitto_pub -d -h "smartapp.netcad.com" -t "v1/devices/me/telemetry" -u "$ACCESS_TOKEN" -f "telemetry-data-with-ts.json"
|
|
resources/mqtt-js-telemetry.sh |
|---|
1
2
3
4
5
6
| # Publish data as an object without timestamp (server-side timestamp will be used)
cat telemetry-data-as-object.json | mqtt pub -v -h "smartapp.netcad.com" -t "v1/devices/me/telemetry" -u '$ACCESS_TOKEN' -s
# Publish data as an array of objects without timestamp (server-side timestamp will be used)
cat telemetry-data-as-array.json | mqtt pub -v -h "smartapp.netcad.com" -t "v1/devices/me/telemetry" -u '$ACCESS_TOKEN' -s
# Publish data as an object with timestamp (server-side timestamp will be used)
cat telemetry-data-with-ts.json | mqtt pub -v -h "smartapp.netcad.com" -t "v1/devices/me/telemetry" -u '$ACCESS_TOKEN' -s
|
|
resources/telemetry-data-as-object.json |
|---|
1
2
3
4
5
6
7
8
9
10
11
| {
"stringKey": "value1",
"booleanKey": true,
"doubleKey": 42.0,
"longKey": 73,
"jsonKey": {
"someNumber": 42,
"someArray": [1,2,3],
"someNestedObject": {"key": "value"}
}
}
|
|
resources/telemetry-data-with-ts.json |
|---|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
| {
"ts": 1451649600512,
"values": {
"stringKey": "value1",
"booleanKey": true,
"doubleKey": 42.0,
"longKey": 73,
"jsonKey": {
"someNumber": 42,
"someArray": [1, 2, 3],
"someNestedObject": {
"key": "value"
}
}
}
}
|
|
Attributes API
attributes API allows devices to
- Upload client-side device attributes to the server.
- Request client-side and shared device attributes from the server.
- Subscribe to shared device attributes from the server.
Publish attribute update to the server
In order to publish client-side device attributes to NDU server node, send PUBLISH message to the following topic:
1
| v1/devices/me/attributes
|
resources/mosquitto-attributes-publish.sh |
|---|
1
2
| # Publish client-side attributes update
mosquitto_pub -d -h "smartapp.netcad.com" -t "v1/devices/me/attributes" -u "$ACCESS_TOKEN" -f "new-attributes-values.json"
|
|
resources/mqtt-js-attributes-publish.sh |
|---|
1
2
| # Publish client-side attributes update
cat new-attributes-values.json | mqtt pub -d -h "smartapp.netcad.com" -t "v1/devices/me/attributes" -u '$ACCESS_TOKEN' -s
|
|
resources/new-attributes-values.json |
|---|
1
2
3
4
5
6
7
8
9
10
11
| {
"attribute1": "value1",
"attribute2": true,
"attribute3": 42.0,
"attribute4": 73,
"attribute5": {
"someNumber": 42,
"someArray": [1,2,3],
"someNestedObject": {"key": "value"}
}
}
|
|
Request attribute values from the server
In order to request client-side or shared device attributes to NDU server node, send PUBLISH message to the following topic:
1
| v1/devices/me/attributes/request/$request_id
|
where $request_id is your integer request identifier.
Before sending PUBLISH message with the request, client need to subscribe to
1
| v1/devices/me/attributes/response/+
|
The following example is written in javascript and is based on mqtt.js.
Pure command-line examples are not available because subscribe and publish need to happen in the same mqtt session.
resources/mqtt-js-attributes-request.js |
|---|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
| var mqtt = require('mqtt')
var client = mqtt.connect('smartapp.netcad.com',{
username: process.env.TOKEN
})
client.on('connect', function () {
console.log('connected')
client.subscribe('v1/devices/me/attributes/response/+')
client.publish('v1/devices/me/attributes/request/1', '{"clientKeys":"attribute1,attribute2", "sharedKeys":"shared1,shared2"}')
})
client.on('message', function (topic, message) {
console.log('response.topic: ' + topic)
console.log('response.body: ' + message.toString())
client.end()
})
|
|
Please note, the intersection of client-side and shared device attribute keys is a bad practice!
However, it is still possible to have same keys for client, shared or even server-side attributes.
Subscribe to attribute updates from the server
In order to subscribe to shared device attribute changes, send SUBSCRIBE message to the following topic:
1
| v1/devices/me/attributes
|
When a shared attribute is changed by one of the server-side components (such as the REST API or the Rule Chain), the client will receive the following update:
RPC API
Server-side RPC
In order to subscribe to RPC commands from the server, send SUBSCRIBE message to the following topic:
1
| v1/devices/me/rpc/request/+
|
Once subscribed, the client will receive individual commands as a PUBLISH message to the corresponding topic:
1
| v1/devices/me/rpc/request/$request_id
|
where $request_id is an integer request identifier.
The client should publish the response to the following topic:
1
| v1/devices/me/rpc/response/$request_id
|
The following example is written in javascript and is based on mqtt.js.
Pure command-line examples are not available because subscribe and publish need to happen in the same mqtt session.
resources/mqtt-js-rpc-from-server.js |
|---|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
| var mqtt = require('mqtt');
var client = mqtt.connect('smartapp.netcad.com',{
username: process.env.TOKEN
});
client.on('connect', function () {
console.log('connected');
client.subscribe('v1/devices/me/rpc/request/+')
});
client.on('message', function (topic, message) {
console.log('request.topic: ' + topic);
console.log('request.body: ' + message.toString());
var requestId = topic.slice('v1/devices/me/rpc/request/'.length);
//client acts as an echo service
client.publish('v1/devices/me/rpc/response/' + requestId, message);
});
|
|
Client-side RPC
In order to send RPC commands to server, send PUBLISH message to the following topic:
1
| v1/devices/me/rpc/request/$request_id
|
where $request_id is an integer request identifier.
The response from server will be published to the following topic:
1
| v1/devices/me/rpc/response/$request_id
|
The following example is written in javascript and is based on mqtt.js.
Pure command-line examples are not available because subscribe and publish need to happen in the same mqtt session.
resources/mqtt-js-rpc-from-client.js |
|---|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
| var mqtt = require('mqtt');
var client = mqtt.connect('smartapp.netcad.com', {
username: process.env.TOKEN
});
client.on('connect', function () {
console.log('connected');
client.subscribe('v1/devices/me/rpc/response/+');
var requestId = 1;
var request = {
"method": "getTime",
"params": {}
};
client.publish('v1/devices/me/rpc/request/' + requestId, JSON.stringify(request));
});
client.on('message', function (topic, message) {
console.log('response.topic: ' + topic);
console.log('response.body: ' + message.toString());
});
|
|
Claiming devices
In order to initiate claiming device, send PUBLISH message to the following topic:
The supported data format is:
1
| {"secretKey":"value", "durationMs":60000}
|
Please note that the above fields are optional. In case the secretKey is not specified, the empty string as a default value is used.
In case the durationMs is not specified, the system parameter device.claim.duration is used.
–>