[SERIAL][BREAKING] RS232 change to SERIAL GATEWAY (#2008)
Make the RS232 more generic by converting it to a Serial Gateway Add the capability to decode BLE data coming through Serial
This commit is contained in:
Florian authored and GitHub committed
1 parent
25c3da7ee9
commit
8a28bb2cf8
12 files changed
+419
-379
No files matched your search
@@ -0,0 +1,246 @@
|
||||
/*
|
||||
Theengs OpenMQTTGateway - We Unite Sensors in One Open-Source Interface
|
||||
|
||||
Act as a wifi or ethernet gateway between your SERIAL device and a MQTT broker
|
||||
Send and receiving command by MQTT
|
||||
|
||||
This gateway enables to:
|
||||
- receive MQTT data from a topic and send SERIAL signal corresponding to the received MQTT data
|
||||
- publish MQTT data to a different topic related to received SERIAL signal
|
||||
|
||||
Copyright: (c)Florian ROBERT
|
||||
|
||||
This file is part of OpenMQTTGateway.
|
||||
|
||||
OpenMQTTGateway is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
OpenMQTTGateway is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
#include "User_config.h"
|
||||
|
||||
#ifdef ZgatewaySERIAL
|
||||
|
||||
# ifndef SERIAL_UART // software serial mode
|
||||
# include <SoftwareSerial.h>
|
||||
SoftwareSerial SERIALSoftSerial(SERIAL_RX_GPIO, SERIAL_TX_GPIO); // RX, TX
|
||||
# endif
|
||||
|
||||
// use pointer to stream class for serial communication to make code
|
||||
// compatible with both softwareSerial as hardwareSerial.
|
||||
Stream* SERIALStream = NULL;
|
||||
|
||||
void setupSERIAL() {
|
||||
//Initalize serial port
|
||||
# ifdef SERIAL_UART // Hardware serial
|
||||
# if SERIAL_UART == 0 // init UART0
|
||||
Serial.end(); // stop if already initialized
|
||||
# ifdef ESP32
|
||||
Serial.begin(SERIALBaud, SERIAL_8N1, SERIAL_RX_GPIO, SERIAL_TX_GPIO);
|
||||
# else
|
||||
Serial.begin(SERIALBaud, SERIAL_8N1);
|
||||
# endif
|
||||
# if defined(ESP8266) && defined(SERIAL_UART0_SWAP)
|
||||
Serial.swap(); // swap UART0 ports from (GPIO1,GPIO3) to (GPIO15,GPIO13)
|
||||
# endif
|
||||
SERIALStream = &Serial;
|
||||
Log.notice(F("SERIAL HW UART0" CR));
|
||||
|
||||
# elif SERIAL_UART == 1 // init UART1
|
||||
Serial1.end(); // stop if already initialized
|
||||
# ifdef ESP32
|
||||
Serial1.begin(SERIALBaud, SERIAL_8N1, SERIAL_RX_GPIO, SERIAL_TX_GPIO);
|
||||
# else
|
||||
Serial1.begin(SERIALBaud, SERIAL_8N1);
|
||||
# endif
|
||||
SERIALStream = &Serial1;
|
||||
Log.notice(F("SERIAL HW UART1" CR));
|
||||
|
||||
# elif SERIAL_UART == 2 // init UART2
|
||||
Serial2.end(); // stop if already initialized
|
||||
# ifdef ESP32
|
||||
Serial2.begin(SERIALBaud, SERIAL_8N1, SERIAL_RX_GPIO, SERIAL_TX_GPIO);
|
||||
# else
|
||||
Serial2.begin(SERIALBaud, SERIAL_8N1);
|
||||
# endif
|
||||
SERIALStream = &Serial2;
|
||||
Log.notice(F("SERIAL HW UART2" CR));
|
||||
|
||||
# elif SERIAL_UART == 3 // init UART3
|
||||
Serial3.end(); // stop if already initialized
|
||||
Serial3.begin(SERIALBaud, SERIAL_8N1);
|
||||
SERIALStream = &Serial3;
|
||||
Log.notice(F("SERIAL HW UART3" CR));
|
||||
# endif
|
||||
|
||||
# else // Software serial
|
||||
// define pin modes for RX, TX:
|
||||
pinMode(SERIAL_RX_GPIO, INPUT);
|
||||
pinMode(SERIAL_TX_GPIO, OUTPUT);
|
||||
SERIALSoftSerial.begin(SERIALBaud);
|
||||
SERIALStream = &SERIALSoftSerial; // get stream of serial
|
||||
|
||||
Log.notice(F("SERIAL_RX_GPIO: %d" CR), SERIAL_RX_GPIO);
|
||||
Log.notice(F("SERIAL_TX_GPIO: %d" CR), SERIAL_TX_GPIO);
|
||||
# endif
|
||||
|
||||
// Flush all bytes in the "link" serial port buffer
|
||||
while (SERIALStream->available() > 0)
|
||||
SERIALStream->read();
|
||||
|
||||
Log.notice(F("SERIALBaud: %d" CR), SERIALBaud);
|
||||
Log.trace(F("ZgatewaySERIAL setup done" CR));
|
||||
}
|
||||
|
||||
# if SERIALtoMQTTmode == 0 // Convert received data to single MQTT topic
|
||||
void SERIALtoMQTT() {
|
||||
// Send all SERIAL output (up to SERIALInPost char revieved) as MQTT message
|
||||
//This function is Blocking, but there should only ever be a few bytes, usually an ACK or a NACK.
|
||||
if (SERIALStream->available()) {
|
||||
Log.trace(F("SERIALtoMQTT" CR));
|
||||
static char SERIALdata[MAX_INPUT];
|
||||
static unsigned int input_pos = 0;
|
||||
static char inChar;
|
||||
do {
|
||||
if (SERIALStream->available()) {
|
||||
inChar = SERIALStream->read();
|
||||
SERIALdata[input_pos] = inChar;
|
||||
input_pos++;
|
||||
}
|
||||
} while (inChar != SERIALInPost && input_pos < MAX_INPUT);
|
||||
SERIALdata[input_pos] = 0;
|
||||
input_pos = 0;
|
||||
|
||||
char* output = SERIALdata + sizeof(SERIALPre) - 1;
|
||||
Log.notice(F("SERIAL data: %s" CR), output);
|
||||
pub(subjectSERIALtoMQTT, output);
|
||||
}
|
||||
}
|
||||
|
||||
# elif SERIALtoMQTTmode == 1 // Convert recievee JSON data to multiple MQTT topics based (nested) keys
|
||||
void SERIALtoMQTT() {
|
||||
// Assumes valid JSON data at SERIAL interface. Use (nested) keys to split JSON data in separate
|
||||
// sub-MQTT-topics up to the defined nesting level.
|
||||
if (SERIALStream->available()) {
|
||||
Log.trace(F("SERIALtoMQTT" CR));
|
||||
|
||||
// Allocate the JSON document
|
||||
StaticJsonDocument<JSON_MSG_BUFFER> SERIALBuffer;
|
||||
JsonObject SERIALdata = SERIALBuffer.to<JsonObject>();
|
||||
|
||||
// JSON validation
|
||||
StaticJsonDocument<0> emptyDoc;
|
||||
StaticJsonDocument<0> filter;
|
||||
DeserializationError validationError = deserializeJson(emptyDoc, *SERIALStream, DeserializationOption::Filter(filter));
|
||||
if (validationError == DeserializationError::Ok) {
|
||||
Log.trace(F("SERIAL data is valid JSON" CR));
|
||||
} else {
|
||||
Log.error(F("SERIAL data is not valid JSON" CR));
|
||||
return;
|
||||
}
|
||||
|
||||
// Read the JSON document from the "link" serial port
|
||||
DeserializationError err = deserializeJson(SERIALBuffer, *SERIALStream);
|
||||
|
||||
// Check if the JSON object is empty
|
||||
if (SERIALBuffer.isNull() || SERIALBuffer.size() == 0) {
|
||||
Log.error(F("SERIAL data is empty JSON object" CR));
|
||||
return;
|
||||
}
|
||||
|
||||
if (err == DeserializationError::Ok) {
|
||||
// JSON received
|
||||
# if jsonPublishing
|
||||
// send as json
|
||||
if (SERIALdata.containsKey("origin")) {
|
||||
if (SERIALdata["origin"] == "BT") {
|
||||
//Decode the BT data
|
||||
# ifdef ZgatewayBT
|
||||
SERIALdata.remove("origin");
|
||||
PublishDeviceData(SERIALdata);
|
||||
# endif
|
||||
}
|
||||
} else {
|
||||
SERIALdata["origin"] = subjectSERIALtoMQTT;
|
||||
handleJsonEnqueue(SERIALdata);
|
||||
}
|
||||
|
||||
# endif
|
||||
# if simplePublishing
|
||||
// send as MQTT topics
|
||||
char topic[mqtt_topic_max_size + 1] = subjectSERIALtoMQTT;
|
||||
sendMQTTfromNestedJson(SERIALBuffer.as<JsonVariant>(), topic, 0, SERIALmaxJSONlevel);
|
||||
# endif
|
||||
} else {
|
||||
// Print error to serial log
|
||||
Log.error(F("Error in SERIALJSONtoMQTT, deserializeJson() returned %s" CR), err.c_str());
|
||||
|
||||
// Flush all bytes in the "link" serial port buffer
|
||||
while (SERIALStream->available() > 0)
|
||||
SERIALStream->read();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
void sendMQTTfromNestedJson(JsonVariant obj, char* topic, int level, int maxLevel) {
|
||||
// recursively step through JSON data and send MQTT messages
|
||||
if (level < maxLevel && obj.is<JsonObject>()) {
|
||||
int topicLength = strlen(topic);
|
||||
// loop over fields
|
||||
for (JsonPair pair : obj.as<JsonObject>()) {
|
||||
// check if new key still fits in topic cstring
|
||||
const char* key = pair.key().c_str();
|
||||
Log.trace(F("level=%d, key='%s'" CR), level, pair.key().c_str());
|
||||
if (topicLength + 2 + strlen(key) <= mqtt_topic_max_size) {
|
||||
// add new level to existing topic cstring
|
||||
topic[topicLength] = '/'; // add slash
|
||||
topic[topicLength + 1] = '\0'; // terminate
|
||||
strncat(topic + topicLength, key, mqtt_topic_max_size - topicLength - 2);
|
||||
|
||||
// step recursively into next level
|
||||
sendMQTTfromNestedJson(pair.value(), topic, level + 1, maxLevel);
|
||||
|
||||
// restore topic
|
||||
topic[topicLength] = '\0';
|
||||
} else {
|
||||
Log.error(F("Nested key '%s' at level %d does not fit within max topic length of %d, skipping"),
|
||||
key, level, mqtt_topic_max_size);
|
||||
}
|
||||
}
|
||||
|
||||
} else {
|
||||
// output value at current json level
|
||||
char output[MAX_INPUT + 1];
|
||||
serializeJson(obj, output, MAX_INPUT);
|
||||
Log.notice(F("level=%d, topic=%s, value: %s\n"), level, topic, output);
|
||||
|
||||
// send MQTT message
|
||||
pub(topic, &output[0]);
|
||||
}
|
||||
}
|
||||
# endif
|
||||
|
||||
void MQTTtoSERIAL(char* topicOri, JsonObject& SERIALdata) {
|
||||
Log.trace(F("json" CR));
|
||||
if (cmpToMainTopic(topicOri, subjectMQTTtoSERIAL)) {
|
||||
Log.trace(F("MQTTtoSERIAL json" CR));
|
||||
const char* data = SERIALdata["value"];
|
||||
const char* prefix = SERIALdata["prefix"] | SERIALPre;
|
||||
const char* postfix = SERIALdata["postfix"] | SERIALPost;
|
||||
Log.trace(F("Value set: %s" CR), data);
|
||||
Log.trace(F("Prefix set: %s" CR), prefix);
|
||||
Log.trace(F("Postfix set: %s" CR), postfix);
|
||||
SERIALStream->print(prefix);
|
||||
SERIALStream->print(data);
|
||||
SERIALStream->print(postfix);
|
||||
}
|
||||
}
|
||||
#endif
|
||||
Reference in new issue
Block a user