giomba
/
nes-proj
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update example README

This commit is contained in:
George Oikonomou 2018-04-27 22:23:31 +01:00
parent b012392ba4
commit 5fc521af56
1 changed files with 26 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
examples/mqtt-client/README.md
View File

@ -13,25 +13,34 @@ The demo will give some visual feedback with a LED (configurable):
This example is known to work with all platforms that support the new button This example is known to work with all platforms that support the new button
API. API.
This example can operate in two modes: A default mode to be used with the
mosquitto MQTT broker and a second mode to be used with the IBM Watson IoT
platform.
To enable Watson mode, define `MQTT_CLIENT_CONF_WITH_IBM_WATSON` as 1 in the
example's `project-conf.h`.
Publishing Publishing
---------- ----------
By default the example will attempt to publish readings to an MQTT broker By default the example will attempt to publish readings to an MQTT broker
running on the IPv6 address specified as `MQTT_DEMO_BROKER_IP_ADDR` in running on the IPv6 address specified as `MQTT_CLIENT_CONF_BROKER_IP_ADDR` in
`project-conf.h`. This functionality was tested successfully with `project-conf.h`. This functionality was tested successfully with
[mosquitto](http://mosquitto.org/). [mosquitto](http://mosquitto.org/). This define will be ignored in IBM Watson
mode.
The publish messages include sensor readings but also some other information, The publish messages include sensor readings but also some other information,
such as device uptime in seconds and a message sequence number. The demo will such as device uptime in seconds and a message sequence number. The demo will
publish to topic `iot-2/evt/status/fmt/json`. The device will connect using publish to topic `iot-2/evt/status/fmt/json`. The device will connect using
client-id `d:contiki-ng:mqtt-client:<device-id>`, where `<device-id>` gets client-id `d:<org-id>:mqtt-client:<device-id>`, where `<device-id>` gets
constructed from the device's IEEE address. constructed from the device's IEEE address. `<org-id>` can be controlled
through the `MQTT_CLIENT_CONF_ORG_ID` define.
Subscribing Subscribing
----------- -----------
You can also subscribe to topics and receive commands, but this will only You can also subscribe to topics and receive commands, but this will only
work if you use "Org ID" != 'quickstart'. To achieve this, you will need to work if you use "Org ID" != 'quickstart'. To achieve this, you will need to
change 'Org ID' (`DEFAULT_ORG_ID`). In this scenario, the device will subscribe change `MQTT_CLIENT_CONF_ORG_ID` in `project-conf.h`. In this scenario, the
to: device will subscribe to:
`iot-2/cmd/+/fmt/json` `iot-2/cmd/+/fmt/json`
@ -53,13 +62,18 @@ messages, outgoing publish messages use proper json payload.
IBM Quickstart Service IBM Quickstart Service
---------------------- ----------------------
It is also possible to publish to IBM's quickstart service. To do so, you need It is also possible to publish to IBM's quickstart service. To do so, you need
to undefine `MQTT_DEMO_BROKER_IP_ADDR`. to enable this mode by setting `MQTT_CLIENT_CONF_WITH_IBM_WATSON` to 1 in
`project-conf.h`.
The device will then try to connect to IBM's quickstart over NAT64, so you will The device will then try to connect to IBM's quickstart over NAT64, so you will
need a NAT64 gateway in your network to make this work. A guide on how to need a NAT64 gateway in your network to make this work. A guide on how to
setup NAT64 is out of scope here. setup NAT64 is out of scope here, but you can find one in the
[Contiki-NG wiki](https://github.com/contiki-ng/contiki-ng/wiki/NAT64-for-Contiki%E2%80%90NG).
If you want to use IBM's cloud service with a registered device, change If you want to use IBM's cloud service with a registered device, you will need
'Org ID' (`DEFAULT_ORG_ID`) and provide the 'Auth Token' (`DEFAULT_AUTH_TOKEN`), to set `MQTT_CLIENT_CONF_ORG_ID` and then also to provide the 'Auth Token'
which acts as a 'password', but bear in mind that it gets transported in clear (`MQTT_CLIENT_CONF_AUTH_TOKEN`), which acts as a 'password'. You will also
text. need to configure your Organisation / Registered device on Watson such that
TLS is optional.
Note: The token will be transported in cleartext.