An MQTT interface for DCC++EX
** WARNING ** This is alpha stage code and not for any other use than testing MQTT connections to a DCC command station either from the internet or a local MQTT broker.
- An Arduiono Mega ( preffered not yet tested on anything else )
- A compatible MotorShield
- An EthernetShield
- A MQTT Client App
The first two components make up your command station and should be put together following the guidelines here : DCC++EX You will not need any software from the DCC++EX repo or download from the website. The DCC part is embedded in the MQTT poc here and based on the work from Asbelos
Note: Currently this only works on an Arduino with EthernetShield no WiFi support yet out of the box.
Once having that sorted out you need to make some config modifications:
Fist edit DccMQTT.h and change/add according to your broker after the #ifdef CLOUDBROKER
- #define MQTT_BROKER_PORT 1883 // 1883 is the standard port for mqtt
- #define MQTT_BROKER_DOMAIN "your.mqttbroker.web"
- #define MQTT_BROKER_ADDRESS xx, xx, xx, xx // IP address of the broker"
If you have user/password authentication you have to specify as well :
- #define MQTT_BROKER_USER "username"
- #define MQTT_BROKER_PASSWD "password"
Otherwise do not define those/comment them out
At this point in time only the MQTT_BROKER_ADDRESS, PORT, USER and PASSWD is used. Any broker will do as long as it supports MQTT version 3 which most mqtt implemntations should support.
By setting CLOUDBROKER to 0 the second set will be used looking for a local installation of a mqtt broker
Note: The Arduino unique Id is used for building the topics to subscribe to. On any public broker without any user authentication this ID would be visible. User Authentication shall be added soon !
Second edit Transport/Ethernetwork.h and change according to your network setup
- #define MAC_ADDRESS { 0xAA, 0x11, 0x22, 0xEE, 0xFF, 0x88 } // MAC address of your networking card
- #define IP_ADDRESS 10, 0, 0, 101 // Just in case we don't get an adress from DHCP try a static one; make sure this one is not used elsewhere and corresponds to your network layout
- #define LISTEN_PORT 80 // default listen port for the server
Normally only the MAC address should be set as DHCP from your Router/Modem or ISP provided equipment will provide the proper address. The IP_ADDRESS here is just a fallback in case the DHCP doesn't respond. In this case you will have to find out the network configuration and make sure that the address provided is not used by any other equipment.
Compile in Visual Studio Code and Platform.io and upload. The system will start in a very verbose mode and connect to the Broker. In order to change this edit Diag/Diag.h and set LOGLEVEL accordingly.
Using an MQTT client such as MQTT Explorer or MQTTfx you should be able to send commands as described in the documentation here