v5.12.0h - Add Serial Bridges

5.12.0h * Add support for Software Serial bridge using commands SerialDelimiter, SBaudrate and SSerialSend. Supports 8N1 and text only (#2190) * Add support for Hardware Serial bridge using commands SerialDelimiter, Baudrate and SerialSend. Supports 8N1 and text only (#2182)
arendst · Mar 20, 2018 · 2ba4d6f · 2ba4d6f
1 parent d3ef9ca
commit 2ba4d6f
Show file tree

Hide file tree

Showing 32 changed files with 307 additions and 68 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 ## Sonoff-Tasmota
 Provide ESP8266 based Sonoff by [iTead Studio](https://www.itead.cc/) and ElectroDragon IoT Relay with Serial, Web and MQTT control allowing 'Over the Air' or OTA firmware updates using Arduino IDE.
 
-Current version is **5.12.0g** - See [sonoff/_releasenotes.ino](https://github.com/arendst/Sonoff-Tasmota/blob/development/sonoff/_releasenotes.ino) for change information.
+Current version is **5.12.0h** - See [sonoff/_releasenotes.ino](https://github.com/arendst/Sonoff-Tasmota/blob/development/sonoff/_releasenotes.ino) for change information.
 
 ### ATTENTION All versions
 

diff --git a/lib/TasmotaSerial-1.1.0/README.md → lib/TasmotaSerial-1.2.0/README.md b/lib/TasmotaSerial-1.1.0/README.md → lib/TasmotaSerial-1.2.0/README.md
@@ -1,6 +1,6 @@
 # TasmotaSerial
 
-Implementation of software serial library for the ESP8266 at 9600 baud
+Implementation of software serial library for the ESP8266
 
 Allows for several instances to be active at the same time.
 

diff --git a/...al-1.1.0/examples/swsertest/swsertest.ino → ...al-1.2.0/examples/swsertest/swsertest.ino b/...al-1.1.0/examples/swsertest/swsertest.ino → ...al-1.2.0/examples/swsertest/swsertest.ino
diff --git a/lib/TasmotaSerial-1.1.0/keywords.txt → lib/TasmotaSerial-1.2.0/keywords.txt b/lib/TasmotaSerial-1.1.0/keywords.txt → lib/TasmotaSerial-1.2.0/keywords.txt
diff --git a/lib/TasmotaSerial-1.1.0/library.json → lib/TasmotaSerial-1.2.0/library.json b/lib/TasmotaSerial-1.1.0/library.json → lib/TasmotaSerial-1.2.0/library.json
@@ -1,10 +1,10 @@
 {
     "name": "TasmotaSerial",
-    "version": "1.0.0",
+    "version": "1.2.0",
     "keywords": [
       "serial", "io", "TasmotaSerial"
     ],
-    "description": "Implementation of software serial for ESP8266 at 9600 baud.",
+    "description": "Implementation of software serial for ESP8266.",
     "repository":
     {
         "type": "git",

diff --git a/lib/TasmotaSerial-1.1.0/library.properties → lib/TasmotaSerial-1.2.0/library.properties b/lib/TasmotaSerial-1.1.0/library.properties → lib/TasmotaSerial-1.2.0/library.properties
@@ -1,8 +1,8 @@
 name=TasmotaSerial
-version=1.0
+version=1.2.0
 author=Theo Arends
 maintainer=Theo Arends <[email protected]>
-sentence=Implementation of software serial for ESP8266 at 9600 baud.
+sentence=Implementation of software serial for ESP8266.
 paragraph=
 category=Signal Input/Output
 url=

diff --git a/...TasmotaSerial-1.1.0/src/TasmotaSerial.cpp → ...TasmotaSerial-1.2.0/src/TasmotaSerial.cpp b/...TasmotaSerial-1.1.0/src/TasmotaSerial.cpp → ...TasmotaSerial-1.2.0/src/TasmotaSerial.cpp
@@ -87,9 +87,7 @@ TasmotaSerial::TasmotaSerial(int receive_pin, int transmit_pin)
   m_in_pos = m_out_pos = 0;
   if (m_rx_pin > -1) {
     m_buffer = (uint8_t*)malloc(TM_SERIAL_BUFFER_SIZE);
-    if (m_buffer == NULL) {
-      return;
-    }
+    if (m_buffer == NULL) return;
     // Use getCycleCount() loop to get as exact timing as possible
     m_bit_time = ESP.getCpuFreqMHz() *1000000 /TM_SERIAL_BAUDRATE;
     pinMode(m_rx_pin, INPUT);
@@ -111,7 +109,8 @@ bool TasmotaSerial::isValidGPIOpin(int pin)
 bool TasmotaSerial::begin(long speed) {
   // Use getCycleCount() loop to get as exact timing as possible
   m_bit_time = ESP.getCpuFreqMHz() *1000000 /speed;
-  return m_valid && (speed <= TM_SERIAL_BAUDRATE);
+  m_high_speed = (speed > 9600);
+  return m_valid;
 }
 
 bool TasmotaSerial::begin() {
@@ -123,17 +122,13 @@ void TasmotaSerial::flush() {
 }
 
 int TasmotaSerial::peek() {
-  if ((-1 == m_rx_pin) || (m_in_pos == m_out_pos)) {
-    return -1;
-  }
+  if ((-1 == m_rx_pin) || (m_in_pos == m_out_pos)) return -1;
   return m_buffer[m_out_pos];
 }
 
 int TasmotaSerial::read()
 {
-  if ((-1 == m_rx_pin) || (m_in_pos == m_out_pos)) {
-    return -1;
-  }
+  if ((-1 == m_rx_pin) || (m_in_pos == m_out_pos)) return -1;
   uint8_t ch = m_buffer[m_out_pos];
   m_out_pos = (m_out_pos +1) % TM_SERIAL_BUFFER_SIZE;
   return ch;
@@ -142,23 +137,20 @@ int TasmotaSerial::read()
 int TasmotaSerial::available()
 {
   int avail = m_in_pos - m_out_pos;
-  if (avail < 0) {
-    avail += TM_SERIAL_BUFFER_SIZE;
-  }
+  if (avail < 0) avail += TM_SERIAL_BUFFER_SIZE;
   return avail;
 }
 
 #ifdef TM_SERIAL_USE_IRAM
-#define TM_SERIAL_WAIT { while (ESP.getCycleCount()-start < wait) optimistic_yield(1); wait += m_bit_time; }  // Watchdog timeouts
+#define TM_SERIAL_WAIT { while (ESP.getCycleCount()-start < wait) if (!m_high_speed) optimistic_yield(1); wait += m_bit_time; } // Watchdog timeouts
 #else
 #define TM_SERIAL_WAIT { while (ESP.getCycleCount()-start < wait); wait += m_bit_time; }
 #endif
 
 size_t TasmotaSerial::write(uint8_t b)
 {
-  if (-1 == m_tx_pin) {
-    return 0;
-  }
+  if (-1 == m_tx_pin) return 0;
+  if (m_high_speed) cli();  // Disable interrupts in order to get a clean transmit
   unsigned long wait = m_bit_time;
   digitalWrite(m_tx_pin, HIGH);
   unsigned long start = ESP.getCycleCount();
@@ -173,6 +165,7 @@ size_t TasmotaSerial::write(uint8_t b)
   // Stop bit
   digitalWrite(m_tx_pin, HIGH);
   TM_SERIAL_WAIT;
+  if (m_high_speed) sei();
   return 1;
 }
 
@@ -191,9 +184,7 @@ void TasmotaSerial::rxRead()
   for (int i = 0; i < 8; i++) {
     TM_SERIAL_WAIT;
     rec >>= 1;
-    if (digitalRead(m_rx_pin)) {
-      rec |= 0x80;
-    }
+    if (digitalRead(m_rx_pin)) rec |= 0x80;
   }
   // Stop bit
   TM_SERIAL_WAIT;

diff --git a/lib/TasmotaSerial-1.1.0/src/TasmotaSerial.h → lib/TasmotaSerial-1.2.0/src/TasmotaSerial.h b/lib/TasmotaSerial-1.1.0/src/TasmotaSerial.h → lib/TasmotaSerial-1.2.0/src/TasmotaSerial.h
@@ -20,12 +20,12 @@
 #ifndef TasmotaSerial_h
 #define TasmotaSerial_h
 /*********************************************************************************************\
- * TasmotaSerial supports up to 9600 baud with fixed buffer size of 64 bytes using optional no iram
+ * TasmotaSerial supports up to 115200 baud with fixed buffer size of 64 bytes using optional no iram
  *
  * Based on EspSoftwareSerial v3.3.1 by Peter Lerup (https://github.com/plerup/espsoftwareserial)
 \*********************************************************************************************/
 
-#define TM_SERIAL_BAUDRATE           9600   // Max supported baudrate
+#define TM_SERIAL_BAUDRATE           9600   // Default baudrate
 #define TM_SERIAL_BUFFER_SIZE        64     // Receive buffer size
 
 #include <core_version.h>                   // Arduino_Esp8266 version information (ARDUINO_ESP8266_RELEASE and ARDUINO_ESP8266_RELEASE_2_3_0)
@@ -57,6 +57,7 @@ class TasmotaSerial : public Stream {
 
     // Member variables
     bool m_valid;
+    bool m_high_speed;
     int m_rx_pin;
     int m_tx_pin;
     unsigned long m_bit_time;

diff --git a/sonoff/_releasenotes.ino b/sonoff/_releasenotes.ino
@@ -1,5 +1,6 @@
-/* 5.12.0g
- * Add support for MQTT to hardware serial bridge using commands Baudrate and SerialSend. Currently supports 8N1 and text only (#2182)
+/* 5.12.0h
+ * Add support for Software Serial bridge using commands SerialDelimiter, SBaudrate and SSerialSend. Supports 8N1 and text only (#2190)
+ * Add support for Hardware Serial bridge using commands SerialDelimiter, Baudrate and SerialSend. Supports 8N1 and text only (#2182)
  *
  * 5.12.0f
  * Add compile time support for WS2812 BRG and RBG led configurations to be defined in user_config.h (#1690)

diff --git a/sonoff/i18n.h b/sonoff/i18n.h
@@ -242,6 +242,7 @@
 #define D_CMND_CFGDUMP "CfgDump"
 #define D_CMND_I2CSCAN "I2CScan"
 #define D_CMND_SERIALSEND "SerialSend"
+#define D_CMND_SERIALDELIMITER "SerialDelimiter"
 #define D_CMND_BAUDRATE "Baudrate"
 #define D_CMND_EXCEPTION "Exception"
 
@@ -340,6 +341,11 @@
 #define D_CMND_DISP_SIZE "Size"
 #define D_CMND_DISP_TEXT "Text"
 
+// Commands xdrv_08_serial_bridge.ino
+#define D_CMND_SSERIALSEND "SSerialSend"
+#define D_CMND_SBAUDRATE "SBaudrate"
+  #define D_JSON_SSERIALRECEIVED "SSerialReceived"
+
 /********************************************************************************************/
 
 #ifndef MY_LANGUAGE

diff --git a/sonoff/language/cs-CZ.h b/sonoff/language/cs-CZ.h
@@ -412,6 +412,8 @@
 #define D_SENSOR_BACKLIGHT "BkLight"
 #define D_SENSOR_PMS5003  "PMS5003"
 #define D_SENSOR_SDS0X1   "SDS0X1"
+#define D_SENSOR_SBR_RX   "SerBr Rx"
+#define D_SENSOR_SBR_TX   "SerBr Tx"
 
 // Units
 #define D_UNIT_AMPERE "A"

diff --git a/sonoff/language/de-DE.h b/sonoff/language/de-DE.h
@@ -412,6 +412,8 @@
 #define D_SENSOR_BACKLIGHT "BkLight"
 #define D_SENSOR_PMS5003  "PMS5003"
 #define D_SENSOR_SDS0X1   "SDS0X1"
+#define D_SENSOR_SBR_RX   "SerBr Rx"
+#define D_SENSOR_SBR_TX   "SerBr Tx"
 
 // Units
 #define D_UNIT_AMPERE "A"

diff --git a/sonoff/language/en-GB.h b/sonoff/language/en-GB.h
@@ -412,6 +412,8 @@
 #define D_SENSOR_BACKLIGHT "BkLight"
 #define D_SENSOR_PMS5003  "PMS5003"
 #define D_SENSOR_SDS0X1   "SDS0X1"
+#define D_SENSOR_SBR_RX   "SerBr Rx"
+#define D_SENSOR_SBR_TX   "SerBr Tx"
 
 // Units
 #define D_UNIT_AMPERE "A"

diff --git a/sonoff/language/es-AR.h b/sonoff/language/es-AR.h
@@ -412,6 +412,8 @@
 #define D_SENSOR_BACKLIGHT "BkLight"
 #define D_SENSOR_PMS5003  "PMS5003"
 #define D_SENSOR_SDS0X1   "SDS0X1"
+#define D_SENSOR_SBR_RX   "SerBr Rx"
+#define D_SENSOR_SBR_TX   "SerBr Tx"
 
 // Units
 #define D_UNIT_AMPERE "A"

diff --git a/sonoff/language/fr-FR.h b/sonoff/language/fr-FR.h
@@ -412,6 +412,8 @@
 #define D_SENSOR_BACKLIGHT "BkLight"
 #define D_SENSOR_PMS5003  "PMS5003"
 #define D_SENSOR_SDS0X1   "SDS0X1"
+#define D_SENSOR_SBR_RX   "SerBr Rx"
+#define D_SENSOR_SBR_TX   "SerBr Tx"
 
 // Units
 #define D_UNIT_AMPERE "A"

diff --git a/sonoff/language/hu-HU.h b/sonoff/language/hu-HU.h
@@ -412,6 +412,8 @@
 #define D_SENSOR_BACKLIGHT "Háttérvil"
 #define D_SENSOR_PMS5003  "PMS5003"
 #define D_SENSOR_SDS0X1   "SDS0X1"
+#define D_SENSOR_SBR_RX   "SerBr Rx"
+#define D_SENSOR_SBR_TX   "SerBr Tx"
 
 // Units
 #define D_UNIT_AMPERE "A"

diff --git a/sonoff/language/it-IT.h b/sonoff/language/it-IT.h
@@ -412,6 +412,8 @@
 #define D_SENSOR_BACKLIGHT "BkLight"
 #define D_SENSOR_PMS5003  "PMS5003"
 #define D_SENSOR_SDS0X1   "SDS0X1"
+#define D_SENSOR_SBR_RX   "SerBr Rx"
+#define D_SENSOR_SBR_TX   "SerBr Tx"
 
 // Units
 #define D_UNIT_AMPERE "A"

diff --git a/sonoff/language/nl-NL.h b/sonoff/language/nl-NL.h
@@ -412,6 +412,8 @@
 #define D_SENSOR_BACKLIGHT "BkLight"
 #define D_SENSOR_PMS5003  "PMS5003"
 #define D_SENSOR_SDS0X1   "SDS0X1"
+#define D_SENSOR_SBR_RX   "SerBr Rx"
+#define D_SENSOR_SBR_TX   "SerBr Tx"
 
 // Units
 #define D_UNIT_AMPERE "A"

diff --git a/sonoff/language/pl-PL.h b/sonoff/language/pl-PL.h
@@ -412,6 +412,8 @@
 #define D_SENSOR_BACKLIGHT "BkLight"
 #define D_SENSOR_PMS5003  "PMS5003"
 #define D_SENSOR_SDS0X1   "SDS0X1"
+#define D_SENSOR_SBR_RX   "SerBr Rx"
+#define D_SENSOR_SBR_TX   "SerBr Tx"
 
 // Units
 #define D_UNIT_AMPERE "A"

diff --git a/sonoff/language/pt-PT.h b/sonoff/language/pt-PT.h
@@ -412,6 +412,8 @@
 #define D_SENSOR_BACKLIGHT "Luz negra"
 #define D_SENSOR_PMS5003  "PMS5003"
 #define D_SENSOR_SDS0X1   "SDS0X1"
+#define D_SENSOR_SBR_RX   "SerBr Rx"
+#define D_SENSOR_SBR_TX   "SerBr Tx"
 
 // Units
 #define D_UNIT_AMPERE "A"

diff --git a/sonoff/language/ru-RU.h b/sonoff/language/ru-RU.h
@@ -412,6 +412,8 @@
 #define D_SENSOR_BACKLIGHT "BkLight"
 #define D_SENSOR_PMS5003  "PMS5003"
 #define D_SENSOR_SDS0X1   "SDS0X1"
+#define D_SENSOR_SBR_RX   "SerBr Rx"
+#define D_SENSOR_SBR_TX   "SerBr Tx"
 
 // Units
 #define D_UNIT_AMPERE "А"

diff --git a/sonoff/language/zh-CN.h b/sonoff/language/zh-CN.h
@@ -412,6 +412,8 @@
 #define D_SENSOR_BACKLIGHT "BkLight"
 #define D_SENSOR_PMS5003  "PMS5003"
 #define D_SENSOR_SDS0X1   "SDS0X1"
+#define D_SENSOR_SBR_RX   "SerBr Rx"
+#define D_SENSOR_SBR_TX   "SerBr Tx"
 
 // Units
 #define D_UNIT_AMPERE "安"

diff --git a/sonoff/language/zh-TW.h b/sonoff/language/zh-TW.h
@@ -412,6 +412,8 @@
 #define D_SENSOR_BACKLIGHT "BkLight"
 #define D_SENSOR_PMS5003  "PMS5003"
 #define D_SENSOR_SDS0X1   "SDS0X1"
+#define D_SENSOR_SBR_RX   "SerBr Rx"
+#define D_SENSOR_SBR_TX   "SerBr Tx"
 
 // Units
 #define D_UNIT_AMPERE "安"

diff --git a/sonoff/settings.h b/sonoff/settings.h
@@ -192,9 +192,8 @@ struct SYSCFG {
   uint16_t      ws_wakeup;                 // 3AA Not used since 5.8.0
   char          friendlyname[MAX_FRIENDLYNAMES][33]; // 3AC
   char          switch_topic[33];          // 430
-
-  byte          free_451[2];               // 451
-
+  char          serial_delimiter;          // 451
+  uint8_t       sbaudrate;                 // 452
   uint8_t       sleep;                     // 453
   uint16_t      domoticz_switch_idx[MAX_DOMOTICZ_IDX];      // 454
   uint16_t      domoticz_sensor_idx[MAX_DOMOTICZ_SNS_IDX];  // 45C

diff --git a/sonoff/settings.ino b/sonoff/settings.ino
@@ -458,6 +458,8 @@ void SettingsDefaultSet2()
   Settings.timezone = APP_TIMEZONE;
   strlcpy(Settings.ota_url, OTA_URL, sizeof(Settings.ota_url));
   Settings.baudrate = APP_BAUDRATE / 1200;
+  Settings.sbaudrate = SOFT_BAUDRATE / 1200;
+  Settings.serial_delimiter = 0xff;
 
   Settings.seriallog_level = SERIAL_LOG_LEVEL;
 //  Settings.sta_active = 0;
@@ -903,6 +905,10 @@ void SettingsDelta()
     if (Settings.version < 0x050C0007) {
       Settings.baudrate = APP_BAUDRATE / 1200;
     }
+    if (Settings.version < 0x050C0008) {
+      Settings.sbaudrate = SOFT_BAUDRATE / 1200;
+      Settings.serial_delimiter = 0xff;
+    }
 
     Settings.version = VERSION;
     SettingsSave(1);

diff --git a/sonoff/sonoff.h b/sonoff/sonoff.h
@@ -98,6 +98,7 @@ typedef unsigned long power_t;              // Power (Relay) type
 #define MAX_BACKLOG            16           // Max number of commands in backlog (chk backlog_index and backlog_pointer code)
 #define MIN_BACKLOG_DELAY      2            // Minimal backlog delay in 0.1 seconds
 
+#define SOFT_BAUDRATE          9600         // Default software serial baudrate
 #define APP_BAUDRATE           115200       // Default serial baudrate
 #define SERIAL_POLLING         100          // Serial receive polling in ms
 #define MAX_STATUS             11           // Max number of status lines