Add experimental (untested) TM1638 support

Add experimental (untested) TM1638 switch support (#2226)

sonoff/_releasenotes.ino

@@ -1,4 +1,5 @@
 /* 6.0.0b
+ * Add experimental (untested) TM1638 switch support (#2226)
  * Change number of switches from 4 to 8 (#2885, #3086)
  *
  * 6.0.0a

sonoff/language/bg-BG.h

@@ -471,6 +471,9 @@
 #define D_SENSOR_SDM120_RX "SDM120 Rx"
 #define D_SENSOR_SDM630_TX "SDM630 Tx"
 #define D_SENSOR_SDM630_RX "SDM630 Rx"
+#define D_SENSOR_TM1638_CLK "TM16 CLK"
+#define D_SENSOR_TM1638_DIO "TM16 DIO"
+#define D_SENSOR_TM1638_STB "TM16 STB"
 
 // Units
 #define D_UNIT_AMPERE "A"

sonoff/language/cs-CZ.h

@@ -471,6 +471,9 @@
 #define D_SENSOR_SDM120_RX "SDM120 Rx"
 #define D_SENSOR_SDM630_TX "SDM630 Tx"
 #define D_SENSOR_SDM630_RX "SDM630 Rx"
+#define D_SENSOR_TM1638_CLK "TM16 CLK"
+#define D_SENSOR_TM1638_DIO "TM16 DIO"
+#define D_SENSOR_TM1638_STB "TM16 STB"
 
 // Units
 #define D_UNIT_AMPERE "A"

sonoff/language/de-DE.h

@@ -471,6 +471,9 @@
 #define D_SENSOR_SDM120_RX "SDM120 Rx"
 #define D_SENSOR_SDM630_TX "SDM630 Tx"
 #define D_SENSOR_SDM630_RX "SDM630 Rx"
+#define D_SENSOR_TM1638_CLK "TM16 CLK"
+#define D_SENSOR_TM1638_DIO "TM16 DIO"
+#define D_SENSOR_TM1638_STB "TM16 STB"
 
 // Units
 #define D_UNIT_AMPERE "A"

sonoff/language/el-GR.h

@@ -471,6 +471,9 @@
 #define D_SENSOR_SDM120_RX "SDM120 Rx"
 #define D_SENSOR_SDM630_TX "SDM630 Tx"
 #define D_SENSOR_SDM630_RX "SDM630 Rx"
+#define D_SENSOR_TM1638_CLK "TM16 CLK"
+#define D_SENSOR_TM1638_DIO "TM16 DIO"
+#define D_SENSOR_TM1638_STB "TM16 STB"
 
 // Units
 #define D_UNIT_AMPERE "A"

sonoff/language/en-GB.h

@@ -471,6 +471,9 @@
 #define D_SENSOR_SDM120_RX "SDM120 Rx"
 #define D_SENSOR_SDM630_TX "SDM630 Tx"
 #define D_SENSOR_SDM630_RX "SDM630 Rx"
+#define D_SENSOR_TM1638_CLK "TM16 CLK"
+#define D_SENSOR_TM1638_DIO "TM16 DIO"
+#define D_SENSOR_TM1638_STB "TM16 STB"
 
 // Units
 #define D_UNIT_AMPERE "A"

sonoff/language/es-AR.h

@@ -471,6 +471,9 @@
 #define D_SENSOR_SDM120_RX "SDM120 Rx"
 #define D_SENSOR_SDM630_TX "SDM630 Tx"
 #define D_SENSOR_SDM630_RX "SDM630 Rx"
+#define D_SENSOR_TM1638_CLK "TM16 CLK"
+#define D_SENSOR_TM1638_DIO "TM16 DIO"
+#define D_SENSOR_TM1638_STB "TM16 STB"
 
 // Units
 #define D_UNIT_AMPERE "A"

sonoff/language/fr-FR.h

@@ -471,6 +471,9 @@
 #define D_SENSOR_SDM120_RX "SDM120 Rx"
 #define D_SENSOR_SDM630_TX "SDM630 Tx"
 #define D_SENSOR_SDM630_RX "SDM630 Rx"
+#define D_SENSOR_TM1638_CLK "TM16 CLK"
+#define D_SENSOR_TM1638_DIO "TM16 DIO"
+#define D_SENSOR_TM1638_STB "TM16 STB"
 
 // Units
 #define D_UNIT_AMPERE "A"

sonoff/language/hu-HU.h

@@ -471,6 +471,9 @@
 #define D_SENSOR_SDM120_RX "SDM120 Rx"
 #define D_SENSOR_SDM630_TX "SDM630 Tx"
 #define D_SENSOR_SDM630_RX "SDM630 Rx"
+#define D_SENSOR_TM1638_CLK "TM16 CLK"
+#define D_SENSOR_TM1638_DIO "TM16 DIO"
+#define D_SENSOR_TM1638_STB "TM16 STB"
 
 // Units
 #define D_UNIT_AMPERE "A"

sonoff/language/it-IT.h

@@ -471,6 +471,9 @@
 #define D_SENSOR_SDM120_RX "SDM120 Rx"
 #define D_SENSOR_SDM630_TX "SDM630 Tx"
 #define D_SENSOR_SDM630_RX "SDM630 Rx"
+#define D_SENSOR_TM1638_CLK "TM16 CLK"
+#define D_SENSOR_TM1638_DIO "TM16 DIO"
+#define D_SENSOR_TM1638_STB "TM16 STB"
 
 // Units
 #define D_UNIT_AMPERE "A"

sonoff/language/nl-NL.h

@@ -471,6 +471,9 @@
 #define D_SENSOR_SDM120_RX "SDM120 Rx"
 #define D_SENSOR_SDM630_TX "SDM630 Tx"
 #define D_SENSOR_SDM630_RX "SDM630 Rx"
+#define D_SENSOR_TM1638_CLK "TM16 CLK"
+#define D_SENSOR_TM1638_DIO "TM16 DIO"
+#define D_SENSOR_TM1638_STB "TM16 STB"
 
 // Units
 #define D_UNIT_AMPERE "A"

sonoff/language/pl-PL.h

@@ -471,6 +471,9 @@
 #define D_SENSOR_SDM120_RX "SDM120 Rx"
 #define D_SENSOR_SDM630_TX "SDM630 Tx"
 #define D_SENSOR_SDM630_RX "SDM630 Rx"
+#define D_SENSOR_TM1638_CLK "TM16 CLK"
+#define D_SENSOR_TM1638_DIO "TM16 DIO"
+#define D_SENSOR_TM1638_STB "TM16 STB"
 
 // Units
 #define D_UNIT_AMPERE "A"

sonoff/language/pt-BR.h

@@ -471,6 +471,9 @@
 #define D_SENSOR_SDM120_RX "SDM120 Rx"
 #define D_SENSOR_SDM630_TX "SDM630 Tx"
 #define D_SENSOR_SDM630_RX "SDM630 Rx"
+#define D_SENSOR_TM1638_CLK "TM16 CLK"
+#define D_SENSOR_TM1638_DIO "TM16 DIO"
+#define D_SENSOR_TM1638_STB "TM16 STB"
 
 // Units
 #define D_UNIT_AMPERE "A"

sonoff/language/pt-PT.h

@@ -471,6 +471,9 @@
 #define D_SENSOR_SDM120_RX "SDM120 Rx"
 #define D_SENSOR_SDM630_TX "SDM630 Tx"
 #define D_SENSOR_SDM630_RX "SDM630 Rx"
+#define D_SENSOR_TM1638_CLK "TM16 CLK"
+#define D_SENSOR_TM1638_DIO "TM16 DIO"
+#define D_SENSOR_TM1638_STB "TM16 STB"
 
 // Units
 #define D_UNIT_AMPERE "A"

sonoff/language/ru-RU.h

@@ -471,6 +471,9 @@
 #define D_SENSOR_SDM120_RX "SDM120 Rx"
 #define D_SENSOR_SDM630_TX "SDM630 Tx"
 #define D_SENSOR_SDM630_RX "SDM630 Rx"
+#define D_SENSOR_TM1638_CLK "TM16 CLK"
+#define D_SENSOR_TM1638_DIO "TM16 DIO"
+#define D_SENSOR_TM1638_STB "TM16 STB"
 
 // Units
 #define D_UNIT_AMPERE "А"

sonoff/language/uk-UK.h

@@ -471,6 +471,9 @@
 #define D_SENSOR_SDM120_RX "SDM120 Rx"
 #define D_SENSOR_SDM630_TX "SDM630 Tx"
 #define D_SENSOR_SDM630_RX "SDM630 Rx"
+#define D_SENSOR_TM1638_CLK "TM16 CLK"
+#define D_SENSOR_TM1638_DIO "TM16 DIO"
+#define D_SENSOR_TM1638_STB "TM16 STB"
 
 // Units
 #define D_UNIT_AMPERE "А"

sonoff/language/zh-CN.h

@@ -471,6 +471,9 @@
 #define D_SENSOR_SDM120_RX "SDM120 Rx"
 #define D_SENSOR_SDM630_TX "SDM630 Tx"
 #define D_SENSOR_SDM630_RX "SDM630 Rx"
+#define D_SENSOR_TM1638_CLK "TM16 CLK"
+#define D_SENSOR_TM1638_DIO "TM16 DIO"
+#define D_SENSOR_TM1638_STB "TM16 STB"
 
 // Units
 #define D_UNIT_AMPERE "安"

sonoff/language/zh-TW.h

@@ -471,6 +471,9 @@
 #define D_SENSOR_SDM120_RX "SDM120 Rx"
 #define D_SENSOR_SDM630_TX "SDM630 Tx"
 #define D_SENSOR_SDM630_RX "SDM630 Rx"
+#define D_SENSOR_TM1638_CLK "TM16 CLK"
+#define D_SENSOR_TM1638_DIO "TM16 DIO"
+#define D_SENSOR_TM1638_STB "TM16 STB"
 
 // Units
 #define D_UNIT_AMPERE "安"

sonoff/sonoff.ino

@@ -167,6 +167,7 @@ uint8_t multiwindow[MAX_KEYS] = { 0 };      // Max time between button presses t
 uint8_t multipress[MAX_KEYS] = { 0 };       // Number of button presses within multiwindow
 uint8_t lastwallswitch[MAX_SWITCHES];       // Last wall switch states
 uint8_t holdwallswitch[MAX_SWITCHES] = { 0 };  // Timer for wallswitch push button hold
+uint8_t virtualswitch[MAX_SWITCHES] = { 0 };   // Virtual switch states
 
 mytmplt my_module;                          // Active copy of Module name and GPIOs
 uint8_t pin[GPIO_MAX];                      // Possible pin configurations
@@ -1431,7 +1432,11 @@ boolean MqttShowSensor()
   snprintf_P(mqtt_data, sizeof(mqtt_data), PSTR("%s{\"" D_JSON_TIME "\":\"%s\""), mqtt_data, GetDateAndTime(DT_LOCAL).c_str());
   int json_data_start = strlen(mqtt_data);
   for (byte i = 0; i < MAX_SWITCHES; i++) {
+#ifdef USE_TM1638
+    if ((pin[GPIO_SWT1 +i] < 99) || ((pin[GPIO_TM16CLK] < 99) && (pin[GPIO_TM16DIO] < 99) && (pin[GPIO_TM16STB] < 99))) {
+#else
     if (pin[GPIO_SWT1 +i] < 99) {
+#endif  // USE_TM1638
       boolean swm = ((FOLLOW_INV == Settings.switchmode[i]) || (PUSHBUTTON_INV == Settings.switchmode[i]) || (PUSHBUTTONHOLD_INV == Settings.switchmode[i]));
       snprintf_P(mqtt_data, sizeof(mqtt_data), PSTR("%s,\"" D_JSON_SWITCH "%d\":\"%s\""), mqtt_data, i +1, GetStateText(swm ^ lastwallswitch[i]));
     }
@@ -1664,7 +1669,7 @@ void ButtonHandler()
  * Switch handler
 \*********************************************************************************************/
 
-void SwitchHandler()
+void SwitchHandler(byte mode)
 {
   uint8_t button = NOT_PRESSED;
   uint8_t switchflag;
@@ -1679,7 +1684,12 @@ void SwitchHandler()
         }
       }
 
+      if (mode) {
+        button = virtualswitch[i];
+      } else {
         button = digitalRead(pin[GPIO_SWT1 +i]);
+      }
+
       if (button != lastwallswitch[i]) {
         switchflag = 3;
         switch (Settings.switchmode[i]) {
@@ -1813,7 +1823,7 @@ void StateLoop()
 \*-------------------------------------------------------------------------------------------*/
 
   ButtonHandler();
-  SwitchHandler();
+  SwitchHandler(0);
 
   XdrvCall(FUNC_EVERY_50_MSECOND);
   XsnsCall(FUNC_EVERY_50_MSECOND);

sonoff/sonoff_template.h

@@ -101,6 +101,9 @@ enum UserSelectablePins {
   GPIO_SDM120_RX,      // SDM120 Serial interface
   GPIO_SDM630_TX,      // SDM630 Serial interface
   GPIO_SDM630_RX,      // SDM630 Serial interface
+  GPIO_TM16CLK,        // TM1638 Clock
+  GPIO_TM16DIO,        // TM1638 Data I/O
+  GPIO_TM16STB,        // TM1638 Strobe
   GPIO_SENSOR_END };
 
 // Programmer selectable GPIO functionality offset by user selectable GPIOs
@@ -146,7 +149,8 @@ const char kSensorNames[] PROGMEM =
   D_SENSOR_SBR_TX "|" D_SENSOR_SBR_RX "|"
   D_SENSOR_SR04_TRIG "|" D_SENSOR_SR04_ECHO "|"
   D_SENSOR_SDM120_TX "|" D_SENSOR_SDM120_RX "|"
-  D_SENSOR_SDM630_TX "|" D_SENSOR_SDM630_RX;
+  D_SENSOR_SDM630_TX "|" D_SENSOR_SDM630_RX "|"
+  D_SENSOR_TM1638_CLK "|" D_SENSOR_TM1638_DIO "|" D_SENSOR_TM1638_STB;
 
 /********************************************************************************************/
 

sonoff/support.ino

@@ -567,6 +567,11 @@ boolean GetUsedInModule(byte val, uint8_t *arr)
 #ifndef USE_SDM630
   if (GPIO_SDM630_TX == val) { return true; }
   if (GPIO_SDM630_RX == val) { return true; }
+#endif
+#ifndef USE_TM1638
+  if (GPIO_TM16CLK == val) { return true; }
+  if (GPIO_TM16DIO == val) { return true; }
+  if (GPIO_TM16STB == val) { return true; }
 #endif
   if ((val >= GPIO_REL1) && (val < GPIO_REL1 + MAX_RELAYS)) {
     offset = (GPIO_REL1_INV - GPIO_REL1);

sonoff/user_config.h

@@ -312,6 +312,8 @@
 
 #define USE_SR04                                 // Add support for HC-SR04 ultrasonic devices (+1k code)
 
+//#define USE_TM1638                               // Add support for TM1638 switches copying Switch1 .. Switch8 (+1k code)
+
 #define USE_RF_FLASH                             // Add support for flashing the EFM8BB1 chip on the Sonoff RF Bridge. C2CK must be connected to GPIO4, C2D to GPIO5 on the PCB
 
 /*********************************************************************************************\

sonoff/xsns_28_tm1638.ino

@@ -0,0 +1,219 @@
+/*
+  xsns_28_tm1638.ino - TM1638 8 switch, led and 7 segment unit support for Sonoff-Tasmota
+
+  Copyright (C) 2018  Theo Arends
+
+  This program 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.
+
+  This program 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/>.
+*/
+
+#ifdef USE_TM1638
+/*********************************************************************************************\
+ * TM1638 8 switch, led and 7 segment
+ *
+ * Uses GPIO TM16 DIO, TM16 CLK and TM16 STB
+\*********************************************************************************************/
+
+#define TM1638_COLOR_NONE   0
+#define TM1638_COLOR_RED    1
+#define TM1638_COLOR_GREEN  2
+
+uint8_t tm1638_type = 1;
+uint8_t tm1638_clock_pin = 0;
+uint8_t tm1638_data_pin = 0;
+uint8_t tm1638_strobe_pin = 0;
+uint8_t tm1638_displays = 8;
+uint8_t tm1638_active_display = 0;
+uint8_t tm1638_intensity = 0;
+
+/*********************************************************************************************\
+ * Pieces from library https://github.com/rjbatista/tm1638-library
+\*********************************************************************************************/
+
+void Tm16XXSend(byte data)
+{
+  for (int i = 0; i < 8; i++) {
+    digitalWrite(tm1638_clock_pin, LOW);
+    digitalWrite(tm1638_data_pin, data & 1 ? HIGH : LOW);
+    data >>= 1;
+    digitalWrite(tm1638_clock_pin, HIGH);
+  }
+}
+
+void Tm16XXSendCommand(byte cmd)
+{
+  digitalWrite(tm1638_strobe_pin, LOW);
+  Tm16XXSend(cmd);
+  digitalWrite(tm1638_strobe_pin, HIGH);
+}
+
+void TM16XXSendData(byte address, byte data)
+{
+  Tm16XXSendCommand(0x44);
+  digitalWrite(tm1638_strobe_pin, LOW);
+  Tm16XXSend(0xC0 | address);
+  Tm16XXSend(data);
+  digitalWrite(tm1638_strobe_pin, HIGH);
+}
+
+byte Tm16XXReceive()
+{
+  byte temp = 0;
+
+  // Pull-up on
+  pinMode(tm1638_data_pin, INPUT);
+  digitalWrite(tm1638_data_pin, HIGH);
+
+  for (int i = 0; i < 8; i++) {
+    temp >>= 1;
+    digitalWrite(tm1638_clock_pin, LOW);
+    if (digitalRead(tm1638_data_pin)) {
+      temp |= 0x80;
+    }
+    digitalWrite(tm1638_clock_pin, HIGH);
+  }
+
+  // Pull-up off
+  pinMode(tm1638_data_pin, OUTPUT);
+  digitalWrite(tm1638_data_pin, LOW);
+
+  return temp;
+}
+
+/*********************************************************************************************/
+
+void Tm16XXClearDisplay()
+{
+  for (int i = 0; i < tm1638_displays; i++) {
+    TM16XXSendData(i << 1, 0);
+  }
+}
+
+void Tm1638SetLED(byte color, byte pos)
+{
+  TM16XXSendData((pos << 1) + 1, color);
+}
+
+void Tm1638SetLEDs(word leds)
+{
+  for (int i = 0; i < tm1638_displays; i++) {
+    byte color = 0;
+
+    if ((leds & (1 << i)) != 0) {
+      color |= TM1638_COLOR_RED;
+    }
+
+    if ((leds & (1 << (i + 8))) != 0) {
+      color |= TM1638_COLOR_GREEN;
+    }
+
+    Tm1638SetLED(color, i);
+  }
+}
+
+byte Tm1638GetButtons()
+{
+  byte keys = 0;
+
+  digitalWrite(tm1638_strobe_pin, LOW);
+  Tm16XXSend(0x42);
+  for (int i = 0; i < 4; i++) {
+    keys |= Tm16XXReceive() << i;
+  }
+  digitalWrite(tm1638_strobe_pin, HIGH);
+
+  return keys;
+}
+
+/*********************************************************************************************/
+
+void TmInit()
+{
+  tm1638_type = 0;
+  if ((pin[GPIO_TM16CLK] < 99) && (pin[GPIO_TM16DIO] < 99) && (pin[GPIO_TM16STB] < 99)) {
+    tm1638_clock_pin = pin[GPIO_TM16CLK];
+    tm1638_data_pin = pin[GPIO_TM16DIO];
+    tm1638_strobe_pin = pin[GPIO_TM16STB];
+
+    pinMode(tm1638_data_pin, OUTPUT);
+    pinMode(tm1638_clock_pin, OUTPUT);
+    pinMode(tm1638_strobe_pin, OUTPUT);
+
+    digitalWrite(tm1638_strobe_pin, HIGH);
+    digitalWrite(tm1638_clock_pin, HIGH);
+
+    Tm16XXSendCommand(0x40);
+    Tm16XXSendCommand(0x80 | (tm1638_active_display ? 8 : 0) | min(7, tm1638_intensity));
+
+    digitalWrite(tm1638_strobe_pin, LOW);
+    Tm16XXSend(0xC0);
+    for (int i = 0; i < 16; i++) {
+      Tm16XXSend(0x00);
+    }
+    digitalWrite(tm1638_strobe_pin, HIGH);
+
+    tm1638_type = 1;
+  }
+}
+
+void TmLoop()
+{
+  byte buttons = Tm1638GetButtons();
+  for (byte i = 0; i < 8; i++) {
+    virtualswitch[i] = buttons &1;
+    byte color = virtualswitch[i] ? TM1638_COLOR_RED : TM1638_COLOR_NONE;
+    Tm1638SetLED(color, i);
+    buttons >>= 1;
+  }
+  SwitchHandler(1);
+}
+
+void TmShow(boolean json)
+{
+
+}
+
+/*********************************************************************************************\
+ * Interface
+\*********************************************************************************************/
+
+#define XSNS_28
+
+boolean Xsns28(byte function)
+{
+  boolean result = false;
+
+  if (tm1638_type) {
+    switch (function) {
+      case FUNC_INIT:
+        TmInit();
+        break;
+      case FUNC_EVERY_50_MSECOND:
+        TmLoop();
+        break;
+/*
+      case FUNC_JSON_APPEND:
+        TmShow(1);
+        break;
+#ifdef USE_WEBSERVER
+      case FUNC_WEB_APPEND:
+        TmShow(0);
+        break;
+#endif  // USE_WEBSERVER
+*/
+    }
+  }
+  return result;
+}
+
+#endif  // USE_TM1638