kyberpunk / openthread-mqttsn Goto Github PK

This repository contains examples using MQTT-SN client implementation for Thread network based on OpenThread SDK.

License: BSD 3-Clause "New" or "Revised" License

openthread thread-network mqtt-sn thread mqtt

openthread-mqttsn's Introduction

OpenThread MQTT-SN Examples

This repository contains C/C++ examples of using MQTT-SN client on Thread network. Feature is implemented in fork of OpenThread SDK released by Google.

Before using MQTT-SN client in Thread network you must install OpenThread Border Router and MQTT-SN Gateway. For more information about building and running CLI application with MQTT-SN client see kyberpunk/openthread.

Border Router and MQTT-SN gateway setup

It is recommended to use all examples including SEARCHGW and ADVERTISE messages with IPv6 MQTT-SN gateway. Gateway is attached directly to Border Router wpan0 interface and can receive and send broadcast messages directly to Thread network. Border Router and MQTT-SN gateway may be run as Docker images. See full guide for more information about required services.

Run OpenThread border router container. No custom network is needed in this case:

sudo docker run -d --name otbr --sysctl "net.ipv6.conf.all.disable_ipv6=0 \
        net.ipv4.conf.all.forwarding=1 net.ipv6.conf.all.forwarding=1" -p 80:8080 \
        --dns=127.0.0.1 -v --radio-url spinel+hdlc+uart:///dev/ttyACM0 --privileged \
        openthread/otbr --ncp-path /dev/ttyACM0

If needed replace /dev/ttyACM0 in -v and --ncp-path parameter with name under which appear NCP device in your system (/dev/ttyS0, /dev/ttyUSB0 etc.).

Then run IPv6 MQTT-SN gateway:

sudo docker run -d --name paho --net "service:otbr" kyberpunk/paho6 \
        --broker-name <mqtt-broker> --broker-port 1883

Replace <mqtt-broker> with MQTT broker IPv4 address or hostname. Gateway container uses the same network stack as Border Router container and is able to listen to wpan0 interface.

C API Examples

C++ Examples

openthread-mqttsn's People

Contributors

Stargazers

Watchers

Forkers

arne-sandberg uttaravadina pearson haitao52198

openthread-mqttsn's Issues

Implement client PINGREQ messages

Implement peridical client PINGREQ messages with CONNACK duration interval.

Can not subscribe and publish

I have finished mqtt connection between my mqtt-sn client device and mqtt-sn gateway, everything is ok but when I tried to make my cli device publish "sensors" message, it failed.
Logs are below.

Verify sender address on UDP receive

Verify sender address on UDP receive to gateway on specific message types.

Add register and subscribe callback specific for request.

Link callback to specific request and add timeouts.

Implement MQTT-SN sleeping device functionality

Setting up MQTT_SN gateway failed

Hi there,

I am trying to setup Thread network with MQTT-SN over it and I came across your docker for paho. I've been trying to follow instructions provided here https://github.com/kyberpunk/openthread/blob/master/README.md#Trying-MQTT-SN-client-with-CLI-application-example, however I fail at the step when I want to run MQTT_SN Gateway docker. I correctly run OTBR through docker and started mosquitto docker as 172.18.0.8. When I run the command:
sudo docker run --name paho --net test --ip 172.18.0.8 kyberpunk/paho --broker-name 172.18.0.7 --broker-port 1883
I receive the error:
exec /app/paho/MQTTSNGateway/docker_entrypoint.sh: exec format error

If i decide to choose binding to container:otbr I am not able to specify neither broker port nor ip address.

I have been trying to use gateway from official paho repository, but I am struggling to understand: To connect to a gateway through a client I need its ip address, but I can see only multicast adresses to configure in .conf file.

I'd appreciate help from you. I would not bother but it's crucial for my studies.

Remove dependencies to STL library

Remove dependencies to STL library for better portability. Use for example OT String class instead.

Add automatic connection feature

Maintain gateways list automatically with ADVERTISE and GWINFO messages and optionally perform connection without explicit gw address.

Implement QoS for PUBLISH messages

Implement QoS 1, 2, 3(-1) for PUBLISH messages.

Can't get gateway advertising working

I've been having all sorts of problems trying to get the gateway advertising example working. I suspect I am doing somethng wrong here but I can't for the life of me work out what it is.

I can build and run the example - I've added a WIP version into my build here

https://github.com/DynamicDevices/openthread/blob/ajl/adding-examples/examples/apps/mqtt-snsearchgw/main.c

Now when I run this up I can see the SEARCHGW coming into the UDP6 MQTT-SNGATEWAY via the OTBR. I see the application sending the response but I never get that back into the application.

I've looked into PAHO and found some weird things. There's a bug which prevents it setting the remote multicast port correctly which I have fixed here (although I've not really fixed it properly - it should use the string ctor)

DynamicDevices/paho.mqtt-sn.embedded-c@db235f7

I thought multicast still used ports so I am not sure how this would have ever worked?

I should say I can ping the multicast IPv6 address and I get a response from the CLI

With debugging on the CLI the packets I get are a bit odd as they involve "hops". Not sure if these are the data UDP packets or something else

Any help or signposting would be much appreciated !!!

Remove MCUXpresso project

Remove MCUXpresso project from openthread-mqttsn and make code able to be built by make or automake.

Support OTA DFU firmwate update

Add support for DFU firmware update over Thread network: https://infocenter.nordicsemi.com/index.jsp?topic=%2Fsdk_tz_v3.1.0%2Fthread_example_dfu.html

Integrate library to OpenThread CLI example

Integrate library to OpenThread code, so it can be used in CLI example.

Create Proof of Concept sample for Azure IoT Hub connection

Create Proof of Concept sample for direct Azure IoT Hub connection with MQTT-SN gateway (without Azure IoT Edge).

Code samples for library usage

Provide code samples for OpenThread MQTT-SN library usage.

Consider adding makefiles for nrf52840 platform

Add support for all topic id types

Support all topic id types - short, long and id.

Add doxygen documentation

Add documentation to source code.

Make library independent on platform

For test purposes is MQTT-SN library included in KW41Z MCUXpresso project, it should be independent on specific platform and work only with openthread SDK.

How to build examples?

First of all, thank you for all of the great work you've done. Of all the Nordic sdk examples, other tutorials, your MQTTSN over docker is the only example that I've been able to get to working consistently.

I was hoping to explore your SED mqttsn cpp example, but I'm not exactly sure what the build and flash process is. For context, I'm using the NRF52840 dongles (PCA10059).

I tried a few shots in the dark: make/cmake from the openthread/src directory, gcc the .cpp, but the build references seem off. Not sure what the build context is supposed to be.