-
Notifications
You must be signed in to change notification settings - Fork 10
/
W5500_mqtt.ino
401 lines (320 loc) · 11.4 KB
/
W5500_mqtt.ino
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
/*
Author: Eric Tsai, 2017
License: CC-BY-SA, https://creativecommons.org/licenses/by-sa/2.0/
Purpose: Gateway for JSON serial data to MQTT via hardwired W5500 ethernet module
Input: Expected JSON format via uart
{"mac":"c2f154bb0af9","rssi":-55,"volt":3.05,"sensor":1, "key":value}
{"mac":"cow2","rssi":-109,"volt":3.61,"lat":45.055761, "long":-92.980961}
Output:
Iterates through the key:value pairs and publishes in this form:
/BLE/<loc>/<mac>/<key>/ <value>
/ble/livingroom/c2f154bb0af9/volt 3.05
/ble/livingroom/c2f154bb0af9/rssi/ -55
/LORA/farmhouse/cow2/lat 45.055761
/LORA/farmhouse/cow2/long -92.980961
Hardware:
Tested on Uno and Nano
Uart RX & TX on default Serial pins 0 & 1
W5500 ethernet module wire to standard SPI pins 10, 11, 12, 13 (Uno)
Increase serial buffer size from 64 to 128 bytes in
C:\Program Files (x86)\Arduino\hardware\arduino\avr\cores\arduino\HardwareSerial.h
Changes: ctrl-F "**CHANGE**"
1) IP address of MQTT broker
2) <loc> designation, persumably unique per gateway
3) IP address of W5500
3) Remember to compile with larger serial buffer board definition
Notes: To test by subscribing to all topics
mosquitto_sub -h localhost -v -t '#'
*/
#include <SPI.h>
#include <Ethernet2.h>
#include <PubSubClient.h>
#include <ArduinoJson.h>
//"**CHANGE**" W5500 MAC address (i.e. used for static DHCP on router)
//Must be unique per gateway. You'll see MQTT connection issues if not.
//byte mac[] = {0x00, 0xAA, 0xBB, 0xCC, 0xDE, 0x03}; //nano2 test
byte mac[] = {0x00, 0xAA, 0xBB, 0xCC, 0xDE, 0x01}; //nano1 livingroom
//byte mac[] = {0x00, 0xAA, 0xBB, 0xCC, 0xDE, 0x02}; //uno1 basement
/*
//"**CHANGE**" mqtt_name[] used as part of topic name
/ble/MQTT_NAME/mac/rssi
/ble/MQTT_NAME/mac/volt
*/
//const char mqtt_name[]="nano_02";
const char mqtt_name[]="nano_01";
//const char mqtt_name[]="uno_01";
//const char mqtt_name[]="livingroom";
//const char mqtt_name[]="basement";
const int pinHandShake = 6; //handshake, serial-to-mqtt flow control
//"**CHANGE**" MQTT server IP address
IPAddress server(192, 168, 2, 24); //mqtt server server 2.3
unsigned long heartbeat_millis=0;
int heartbeat_cnt=0;
//"**CHANGE**" debug output
#define MyDebug 0 //0=no debug, 1=deeebug
//"**CHANGE**" BLE, LORA, etc...
#define RF_TYPE BLE
//#define RF_TYPE LORA
//buffer for char[] used in mqtt publishes, size at least as big as topic + msg length
char mqtt_buf[60]; // e.g "/ble/esp1/d76dcd1b3720/volt" is 30 chars long
bool conn_status;
// Callback function header
void callback(char* topic, byte* payload, unsigned int length);
// Initialize the Ethernet client library with the IP address and port of MQTT server
EthernetClient ethclient;
PubSubClient mqttclient(server, 1883, callback, ethclient);
/*
Increase serial buffer size so we can capture at least the entire JSON string in serial buffer
Needed for Arduino Uno, Nano, etc that only have 64byte serial buffer
Increase serial buffer size in Arduino core to 128
C:\Program Files (x86)\Arduino\hardware\arduino\avr\cores\arduino\HardwareSerial.h
#define SERIAL_RX_BUFFER_SIZE 64
C:\Program Files (x86)\Arduino\hardware\arduino\avr\cores\arduino\USBAPI.h
#define SERIAL_BUFFER_SIZE 64
*
*/
const int serialBufSize = 100; //size for at least the size of incoming JSON string
static char serialbuffer[serialBufSize]; // {"mac":"c2f154bb0af9","rssi":-71,"volt":2.93,"tmr":230,"xmit_cnt":1,"mag/p":1}
static char mytopic[120]; //MQTT topic string size, must be less than size declared
// Callback function for mqtt subscribes
void callback(char* topic, byte* payload, unsigned int length) {
}
void setup() {
// Open serial communications and wait for port to open:
Serial.begin(9600);
// this check is only needed on the Leonardo:
while (!Serial) {
; // wait for serial port to connect. Needed for Leonardo only
}
#if MyDebug
Serial.println("startup...");
#endif
pinMode(pinHandShake, OUTPUT);
// start the Ethernet connection:
if (Ethernet.begin(mac) == 0) {
Serial.println("Failed to configure Ethernet using DHCP");
// no point in carrying on, so do nothing forevermore:
for (;;)
;
}
// print your local IP address:
Serial.print("My IP address: ");
for (byte thisByte = 0; thisByte < 4; thisByte++) {
// print the value of each byte of the IP address:
Serial.print(Ethernet.localIP()[thisByte], DEC);
Serial.print(".");
}
Serial.println();
//MQTT
if (mqttclient.connect(mqtt_name)) {
mqttclient.publish("hello",mqtt_name);
//mqttclient.subscribe("inTopic");
}
else
{
Serial.print("could not connect to MQTT client");
}
}//end setup()
//stealing this code from
//https://hackingmajenkoblog.wordpress.com/2016/02/01/reading-serial-on-the-arduino/
//non-blocking serial readline routine, very nice. Allows mqtt loop to run.
int readline(int readch, char *buffer, int len)
{
static int pos = 0;
int rpos;
if (readch > 0) {
switch (readch) {
case '\n': // Ignore new-lines
break;
case '\r': // Return on CR
rpos = pos;
pos = 0; // Reset position index ready for next time
return rpos;
default:
if (pos < len-1) {
buffer[pos++] = readch; //first buffer[pos]=readch; then pos++;
buffer[pos] = (char)0;
}
}
}
// No end of line has been found, so return -1.
return -1;
}//end readline()
//json iterator that parses char* and publish each key-value pair as mqtt data
void localParseJson(char *mybuf)
{
//JSON parsing
//JSON object exists in this scope, routine should execute atomatically no interrupts
//If software serial is used, and parsing is interrupted, json object still be valid? not sure.
StaticJsonBuffer<150> jsonBuffer;
JsonObject& object = jsonBuffer.parseObject(mybuf);
/*
Incoming uart:
mac:c2f154bb0af9,rssi:-55,volt:3.05,mag:1
Iterate and publish as
/ble/livingroom/c2f154bb0af9/rssi -55
/ble/livingroom/c2f154bb0af9/volt 3
/ble/livingroom/c2f154bb0af9/mag 1
1) count # fields in after MAC
2) concat "ble"/"MAC"/+iterate field
3) capture data to publish
*/
if (object.success())
{
//todo: it's too easy to forget mytopic size, not checking for size when string being assembled.
// add error checking and improve readability
int topic_char_index=0;
// mytopic[i] = '\0'; make sure null terminate mytopic
//construct the first part of the topic name, which is just /BLE or /LORA
mytopic[0]='/'; topic_char_index++;
mytopic[1]='y'; topic_char_index++;
mytopic[2]='y'; topic_char_index++;
mytopic[3]='y'; topic_char_index++;
mytopic[4]='/'; topic_char_index++; //topic_char_index is 5;
//add gateway location name, /ble/LIVINGROOM
int mqtt_name_len = sizeof(mqtt_name);
for (int i=0; i<(mqtt_name_len-1); i++)
{
mytopic[topic_char_index] = mqtt_name[i];
topic_char_index++;
}
mytopic[topic_char_index] = '/'; topic_char_index++;
//set string pointer to JSON Value containing the key "mac"
// so it's pointing to "mac":c2f154bb0af9
const char* mac_name = object["mac"];
#if MyDebug
Serial.println("mac name is");
Serial.println(mac_name);
#endif
int sizeofff = strlen(mac_name);
#if MyDebug
Serial.print("size of macname: ");
Serial.println(sizeofff);
#endif
// /ble/livingroom/c2f154bb0af9/
//fill mac address into topic name string
for (int i=0; i<sizeofff; i++)
{
mytopic[topic_char_index]= mac_name[i];
topic_char_index++;
}
mytopic[topic_char_index] = '/'; topic_char_index++;
#if MyDebug
Serial.println("mytopic");
Serial.println(mytopic);
#endif
/*
iterate through sensor topics portions
/ble/livingroom/c2f154bb0af9/????
/ble/livingroom/c2f154bb0af9/rssi
/ble/livingroom/c2f154bb0af9/volt
/ble/livingroom/c2f154bb0af9/sensor
*/
//as we iterate through the keys in json, need a marker for char[] index
//up to the MAC address: "/ble/livingroom/c2f154bb0af9/" <---- here
int topic_char_index_marker = topic_char_index; //place holder for last / after mac
for (JsonObject::iterator i=object.begin(); i!=object.end(); ++i)
{
topic_char_index = topic_char_index_marker; //reset index to just after MAC location
/*
/ble/livingroom/c2f154bb0af9/ <---- here
*/
#if MyDebug
Serial.print("iterator::");
Serial.print(i->key);
Serial.print(",");
Serial.println(i->value.asString());
#endif
//mqttclient.publish(i->key,i->value.asString());
//copy string for key into the prepared topic string
const char* key_name = i->key;
int keysize = strlen(key_name); //returns size of keyname, not 1+size like sizeof()
#if MyDebug
Serial.print("key size: ");
Serial.print(keysize);
Serial.print(", topic_char_index: ");
Serial.println(topic_char_index);
#endif
for (int j=0; j<keysize; j++)
{
mytopic[topic_char_index] = key_name[j]; topic_char_index++;
}
/* note that topic_char_index is sitting at position after rss"i"
* /ble/c2f154bb0af9/rssi <----- rssi, volt, etc...
*/
mytopic[topic_char_index] = '\0'; //terminate string w/ null
#if MyDebug
Serial.print("topic_char_index of null char");
Serial.println(topic_char_index);
Serial.println("printing entire mytopic:");
Serial.print(mytopic);
#endif
//mqtt publish relies a null terminated string for topic names
mqttclient.publish(mytopic,i->value.asString());
}//end iterator
}//end if json parsed successful
else
{
mqttclient.publish(mqtt_name, "bad json format");
mqttclient.publish(mqtt_name, mybuf);
Serial.println("--->bad json:");
Serial.println(mybuf);
} //failed json parse
} //end routine localParseJson
//*****************************
// main loop
//
//*****************************
void loop() {
mqttclient.loop();
//buffer for reading serial, must be writable
if (Serial.available() > 0)
{
//received serial line of json
if (readline(Serial.read(), serialbuffer, serialBufSize) > 0)
{
digitalWrite(pinHandShake, HIGH);
#if MyDebug
Serial.print("You entered: >");
Serial.print(serialbuffer);
Serial.println("<");
#endif
localParseJson(serialbuffer); //call JSON iterator on this line from serial
//delete this, not needed.
for (int i=0; i<serialBufSize; i++)
{
serialbuffer[i] = (char)0;
}
digitalWrite(pinHandShake, LOW);
}
}//end seria.available
//every X seconds, publish mqtt heartbeat
if ((millis() - heartbeat_millis > 20000) || ((millis() - heartbeat_millis) < 0))
{
heartbeat_millis = millis();
heartbeat_cnt++;
conn_status = mqttclient.connected();
Serial.print("20 second heartbeat: ");
if (conn_status == 0)
{
Serial.print("mqtt dead, attempting to connect...");
mqttclient.disconnect();
delay(2000);
if (mqttclient.connect(mqtt_name))
{
Serial.println("failed to reconnect MQTT");
}
else
Serial.println("reconnected succesful");
}
else
{
Serial.println("mqtt alive");
}
if (conn_status == 0)
{
mqttclient.publish(mqtt_name, "had to reconnect");
}
mqttclient.publish(mqtt_name,itoa(heartbeat_cnt, mqtt_buf, 10));
} //end heartbeat
} //end loop