Add support for HC-SR04

5.12.0m * Add support for sensor HC-SR04 ultrasonic (arendst#113, arendst#1964, arendst#2444)
curzon01 · Apr 20, 2018 · 50d902f · 50d902f
1 parent fec3901
commit 50d902f
Show file tree

Hide file tree

Showing 20 changed files with 289 additions and 142 deletions.
diff --git a/sonoff/_releasenotes.ino b/sonoff/_releasenotes.ino
@@ -3,7 +3,8 @@
  * Add random window to timers (#2447)
  * Add optional KNX IP Protocol Support (#2402)
  * Add Greek language file (#2491)
- * Fix compile error when using ESP/Arduino library v2.3.0 by reverting KNX async UDP library to default UDP library (#2488,#2492,#2493)
+ * Add support for sensor HC-SR04 ultrasonic (#113, #1964, #2444)
+ * Fix compile error when using ESP/Arduino library v2.3.0 by reverting KNX async UDP library to default UDP library (#2488, #2492, #2493)
  * Fix configuration filename truncation when it contains spaces (#2484, #2490)
  *
  * 5.12.0l

diff --git a/sonoff/i18n.h b/sonoff/i18n.h
@@ -46,6 +46,7 @@
 #define D_JSON_COUNTER "Counter"
 #define D_JSON_CURRENT "Current"         // As in Voltage and Current
 #define D_JSON_DATA "Data"
+#define D_JSON_DISTANCE "Distance"
 #define D_JSON_DNSSERVER "DNSServer"
 #define D_JSON_DONE "Done"
 #define D_JSON_ECO2 "eCO2"

diff --git a/sonoff/language/cs-CZ.h b/sonoff/language/cs-CZ.h
@@ -75,6 +75,7 @@
 #define D_DARKLIGHT "Tmavý"
 #define D_DEBUG "Debug"
 #define D_DISABLED "Zablokováno"
+#define D_DISTANCE "Distance"
 #define D_DNS_SERVER "Server DNS"
 #define D_DONE "Provedeno"
 #define D_DST_TIME "DST"
@@ -450,9 +451,12 @@
 #define D_SENSOR_SDS0X1   "SDS0X1"
 #define D_SENSOR_SBR_RX   "SerBr Rx"
 #define D_SENSOR_SBR_TX   "SerBr Tx"
+#define D_SENSOR_SR04_TRIG "SR04 Tri"
+#define D_SENSOR_SR04_ECHO "SR04 Ech"
 
 // Units
 #define D_UNIT_AMPERE "A"
+#define D_UNIT_CENTIMETER "cm"
 #define D_UNIT_HOUR "hod"
 #define D_UNIT_KILOOHM "kOhm"
 #define D_UNIT_KILOWATTHOUR "kWh"

diff --git a/sonoff/language/de-DE.h b/sonoff/language/de-DE.h
@@ -75,6 +75,7 @@
 #define D_DARKLIGHT "dunkel"
 #define D_DEBUG "debug"
 #define D_DISABLED "deaktiviert"
+#define D_DISTANCE "Abstand"
 #define D_DNS_SERVER "DNS-Server"
 #define D_DONE "erledigt"
 #define D_DST_TIME "DST"
@@ -450,9 +451,12 @@
 #define D_SENSOR_SDS0X1   "SDS0X1"
 #define D_SENSOR_SBR_RX   "SerBr Rx"
 #define D_SENSOR_SBR_TX   "SerBr Tx"
+#define D_SENSOR_SR04_TRIG "SR04 Tri"
+#define D_SENSOR_SR04_ECHO "SR04 Ech"
 
 // Units
 #define D_UNIT_AMPERE "A"
+#define D_UNIT_CENTIMETER "cm"
 #define D_UNIT_HOUR "h"
 #define D_UNIT_KILOOHM "kOhm"
 #define D_UNIT_KILOWATTHOUR "kWh"

diff --git a/sonoff/language/el-GR.h b/sonoff/language/el-GR.h
@@ -75,6 +75,7 @@
 #define D_DARKLIGHT "Σκούρο"
 #define D_DEBUG "Debug"
 #define D_DISABLED "Απενεργοποιημένο"
+#define D_DISTANCE "Distance"
 #define D_DNS_SERVER "Διακομιστής DNS"
 #define D_DONE "Εγινε"
 #define D_DST_TIME "DST"
@@ -450,9 +451,12 @@
 #define D_SENSOR_SDS0X1   "SDS0X1"
 #define D_SENSOR_SBR_RX   "SerBr Rx"
 #define D_SENSOR_SBR_TX   "SerBr Tx"
+#define D_SENSOR_SR04_TRIG "SR04 Tri"
+#define D_SENSOR_SR04_ECHO "SR04 Ech"
 
 // Units
 #define D_UNIT_AMPERE "A"
+#define D_UNIT_CENTIMETER "cm"
 #define D_UNIT_HOUR "Hr"
 #define D_UNIT_KILOOHM "kOhm"
 #define D_UNIT_KILOWATTHOUR "kWh"

diff --git a/sonoff/language/en-GB.h b/sonoff/language/en-GB.h
@@ -75,6 +75,7 @@
 #define D_DARKLIGHT "Dark"
 #define D_DEBUG "Debug"
 #define D_DISABLED "Disabled"
+#define D_DISTANCE "Distance"
 #define D_DNS_SERVER "DNS Server"
 #define D_DONE "Done"
 #define D_DST_TIME "DST"
@@ -450,9 +451,12 @@
 #define D_SENSOR_SDS0X1   "SDS0X1"
 #define D_SENSOR_SBR_RX   "SerBr Rx"
 #define D_SENSOR_SBR_TX   "SerBr Tx"
+#define D_SENSOR_SR04_TRIG "SR04 Tri"
+#define D_SENSOR_SR04_ECHO "SR04 Ech"
 
 // Units
 #define D_UNIT_AMPERE "A"
+#define D_UNIT_CENTIMETER "cm"
 #define D_UNIT_HOUR "Hr"
 #define D_UNIT_KILOOHM "kOhm"
 #define D_UNIT_KILOWATTHOUR "kWh"

diff --git a/sonoff/language/es-AR.h b/sonoff/language/es-AR.h
@@ -75,6 +75,7 @@
 #define D_DARKLIGHT "Oscura"
 #define D_DEBUG "Debug"
 #define D_DISABLED "Deshabilitado"
+#define D_DISTANCE "Distance"
 #define D_DNS_SERVER "DNS Server"
 #define D_DONE "Listo"
 #define D_DST_TIME "DST"
@@ -450,9 +451,12 @@
 #define D_SENSOR_SDS0X1   "SDS0X1"
 #define D_SENSOR_SBR_RX   "SerBr Rx"
 #define D_SENSOR_SBR_TX   "SerBr Tx"
+#define D_SENSOR_SR04_TRIG "SR04 Tri"
+#define D_SENSOR_SR04_ECHO "SR04 Ech"
 
 // Units
 #define D_UNIT_AMPERE "A"
+#define D_UNIT_CENTIMETER "cm"
 #define D_UNIT_HOUR "Hr"
 #define D_UNIT_KILOOHM "kOhm"
 #define D_UNIT_KILOWATTHOUR "kWh"

diff --git a/sonoff/language/fr-FR.h b/sonoff/language/fr-FR.h
@@ -75,6 +75,7 @@
 #define D_DARKLIGHT "Sombre"
 #define D_DEBUG "Debug"
 #define D_DISABLED "Désactivé"
+#define D_DISTANCE "Distance"
 #define D_DNS_SERVER "Serveur DNS"
 #define D_DONE "Fait"
 #define D_DST_TIME "DST"
@@ -450,9 +451,12 @@
 #define D_SENSOR_SDS0X1   "SDS0X1"
 #define D_SENSOR_SBR_RX   "SerBr Rx"
 #define D_SENSOR_SBR_TX   "SerBr Tx"
+#define D_SENSOR_SR04_TRIG "SR04 Tri"
+#define D_SENSOR_SR04_ECHO "SR04 Ech"
 
 // Units
 #define D_UNIT_AMPERE "A"
+#define D_UNIT_CENTIMETER "cm"
 #define D_UNIT_HOUR "h"
 #define D_UNIT_KILOOHM "kΩ"
 #define D_UNIT_KILOWATTHOUR "kWh"

diff --git a/sonoff/language/hu-HU.h b/sonoff/language/hu-HU.h
@@ -75,6 +75,7 @@
 #define D_DARKLIGHT "Min. fényerő"
 #define D_DEBUG "Debug"
 #define D_DISABLED "Letiltva"
+#define D_DISTANCE "Distance"
 #define D_DNS_SERVER "DNS Szerver"
 #define D_DONE "Kész"
 #define D_DST_TIME "DST"
@@ -450,9 +451,12 @@
 #define D_SENSOR_SDS0X1   "SDS0X1"
 #define D_SENSOR_SBR_RX   "SerBr Rx"
 #define D_SENSOR_SBR_TX   "SerBr Tx"
+#define D_SENSOR_SR04_TRIG "SR04 Tri"
+#define D_SENSOR_SR04_ECHO "SR04 Ech"
 
 // Units
 #define D_UNIT_AMPERE "A"
+#define D_UNIT_CENTIMETER "cm"
 #define D_UNIT_HOUR "ó"
 #define D_UNIT_KILOOHM "kOhm"
 #define D_UNIT_KILOWATTHOUR "kWh"

diff --git a/sonoff/language/it-IT.h b/sonoff/language/it-IT.h
@@ -75,6 +75,7 @@
 #define D_DARKLIGHT "Scuro"
 #define D_DEBUG "Debug"
 #define D_DISABLED "Disabilitato"
+#define D_DISTANCE "Distance"
 #define D_DNS_SERVER "DNS Server"
 #define D_DONE "Fatto"
 #define D_DST_TIME "DST"
@@ -450,9 +451,12 @@
 #define D_SENSOR_SDS0X1   "SDS0X1"
 #define D_SENSOR_SBR_RX   "SerBr Rx"
 #define D_SENSOR_SBR_TX   "SerBr Tx"
+#define D_SENSOR_SR04_TRIG "SR04 Tri"
+#define D_SENSOR_SR04_ECHO "SR04 Ech"
 
 // Units
 #define D_UNIT_AMPERE "A"
+#define D_UNIT_CENTIMETER "cm"
 #define D_UNIT_HOUR "Hr"
 #define D_UNIT_KILOOHM "kOhm"
 #define D_UNIT_KILOWATTHOUR "kWh"

diff --git a/sonoff/language/nl-NL.h b/sonoff/language/nl-NL.h
@@ -75,6 +75,7 @@
 #define D_DARKLIGHT "Donker"
 #define D_DEBUG "Debug"
 #define D_DISABLED "Uitgeschakeld"
+#define D_DISTANCE "Afstand"
 #define D_DNS_SERVER "DNS Server"
 #define D_DONE "Klaar"
 #define D_DST_TIME "ZT"
@@ -450,9 +451,12 @@
 #define D_SENSOR_SDS0X1   "SDS0X1"
 #define D_SENSOR_SBR_RX   "SerBr Rx"
 #define D_SENSOR_SBR_TX   "SerBr Tx"
+#define D_SENSOR_SR04_TRIG "SR04 Tri"
+#define D_SENSOR_SR04_ECHO "SR04 Ech"
 
 // Units
 #define D_UNIT_AMPERE "A"
+#define D_UNIT_CENTIMETER "cm"
 #define D_UNIT_HOUR "h"
 #define D_UNIT_KILOOHM "kOhm"
 #define D_UNIT_KILOWATTHOUR "kWh"

diff --git a/sonoff/language/pl-PL.h b/sonoff/language/pl-PL.h
@@ -75,6 +75,7 @@
 #define D_DARKLIGHT "Ciemny"
 #define D_DEBUG "Debug"
 #define D_DISABLED "Zablokowany"
+#define D_DISTANCE "Distance"
 #define D_DNS_SERVER "Server DNS"
 #define D_DONE "Wykonane"
 #define D_DST_TIME "DST"
@@ -450,9 +451,12 @@
 #define D_SENSOR_SDS0X1   "SDS0X1"
 #define D_SENSOR_SBR_RX   "SerBr Rx"
 #define D_SENSOR_SBR_TX   "SerBr Tx"
+#define D_SENSOR_SR04_TRIG "SR04 Tri"
+#define D_SENSOR_SR04_ECHO "SR04 Ech"
 
 // Units
 #define D_UNIT_AMPERE "A"
+#define D_UNIT_CENTIMETER "cm"
 #define D_UNIT_HOUR "Godz"
 #define D_UNIT_KILOOHM "kOhm"
 #define D_UNIT_KILOWATTHOUR "kWh"

diff --git a/sonoff/language/pt-PT.h b/sonoff/language/pt-PT.h
@@ -75,6 +75,7 @@
 #define D_DARKLIGHT "Luz Escura"
 #define D_DEBUG "Depurar"
 #define D_DISABLED "Disabilitado"
+#define D_DISTANCE "Distance"
 #define D_DNS_SERVER "Servidor DNS"
 #define D_DONE "Concluído"
 #define D_DST_TIME "DST"
@@ -450,9 +451,12 @@
 #define D_SENSOR_SDS0X1   "SDS0X1"
 #define D_SENSOR_SBR_RX   "SerBr Rx"
 #define D_SENSOR_SBR_TX   "SerBr Tx"
+#define D_SENSOR_SR04_TRIG "SR04 Tri"
+#define D_SENSOR_SR04_ECHO "SR04 Ech"
 
 // Units
 #define D_UNIT_AMPERE "A"
+#define D_UNIT_CENTIMETER "cm"
 #define D_UNIT_HOUR "Hr"
 #define D_UNIT_KILOOHM "kOhm"
 #define D_UNIT_KILOWATTHOUR "kWh"

diff --git a/sonoff/language/ru-RU.h b/sonoff/language/ru-RU.h
@@ -75,6 +75,7 @@
 #define D_DARKLIGHT "Темный"
 #define D_DEBUG "Отладка"
 #define D_DISABLED "Блокирован"
+#define D_DISTANCE "Distance"
 #define D_DNS_SERVER "DNS Сервер"
 #define D_DONE "Выполнено"
 #define D_DST_TIME "DST"
@@ -450,9 +451,12 @@
 #define D_SENSOR_SDS0X1   "SDS0X1"
 #define D_SENSOR_SBR_RX   "SerBr Rx"
 #define D_SENSOR_SBR_TX   "SerBr Tx"
+#define D_SENSOR_SR04_TRIG "SR04 Tri"
+#define D_SENSOR_SR04_ECHO "SR04 Ech"
 
 // Units
 #define D_UNIT_AMPERE "А"
+#define D_UNIT_CENTIMETER "cm"
 #define D_UNIT_HOUR "Ч"
 #define D_UNIT_KILOOHM "кОм"
 #define D_UNIT_KILOWATTHOUR "кВт"

diff --git a/sonoff/language/zh-CN.h b/sonoff/language/zh-CN.h
@@ -75,6 +75,7 @@
 #define D_DARKLIGHT "Dark"
 #define D_DEBUG "调试"
 #define D_DISABLED "禁用"
+#define D_DISTANCE "Distance"
 #define D_DNS_SERVER "DNS服务器"
 #define D_DONE "完成"
 #define D_DST_TIME "DST"
@@ -450,9 +451,12 @@
 #define D_SENSOR_SDS0X1   "SDS0X1"
 #define D_SENSOR_SBR_RX   "SerBr Rx"
 #define D_SENSOR_SBR_TX   "SerBr Tx"
+#define D_SENSOR_SR04_TRIG "SR04 Tri"
+#define D_SENSOR_SR04_ECHO "SR04 Ech"
 
 // Units
 #define D_UNIT_AMPERE "安"
+#define D_UNIT_CENTIMETER "cm"
 #define D_UNIT_HOUR "时"
 #define D_UNIT_KILOOHM "千欧"
 #define D_UNIT_KILOWATTHOUR "千瓦时"

diff --git a/sonoff/language/zh-TW.h b/sonoff/language/zh-TW.h
@@ -75,6 +75,7 @@
 #define D_DARKLIGHT "Dark"
 #define D_DEBUG "除錯"
 #define D_DISABLED "停用"
+#define D_DISTANCE "Distance"
 #define D_DNS_SERVER "DNS伺服器"
 #define D_DONE "完成"
 #define D_DST_TIME "DST"
@@ -450,9 +451,12 @@
 #define D_SENSOR_SDS0X1   "SDS0X1"
 #define D_SENSOR_SBR_RX   "SerBr Rx"
 #define D_SENSOR_SBR_TX   "SerBr Tx"
+#define D_SENSOR_SR04_TRIG "SR04 Tri"
+#define D_SENSOR_SR04_ECHO "SR04 Ech"
 
 // Units
 #define D_UNIT_AMPERE "安"
+#define D_UNIT_CENTIMETER "cm"
 #define D_UNIT_HOUR "時"
 #define D_UNIT_KILOOHM "千歐"
 #define D_UNIT_KILOWATTHOUR "千瓦時"

diff --git a/sonoff/sonoff_template.h b/sonoff/sonoff_template.h
@@ -91,6 +91,8 @@ enum UserSelectablePins {
   GPIO_SDS0X1,         // Nova Fitness SDS011 Serial interface
   GPIO_SBR_TX,         // Serial Bridge Serial interface
   GPIO_SBR_RX,         // Serial Bridge Serial interface
+  GPIO_SR04_TRIG,      // SR04 Trigger pin
+  GPIO_SR04_ECHO,      // SR04 Echo pin
   GPIO_SENSOR_END };
 
 // Programmer selectable GPIO functionality offset by user selectable GPIOs
@@ -133,7 +135,8 @@ const char kSensorNames[] PROGMEM =
   D_SENSOR_SAIR_TX "|" D_SENSOR_SAIR_RX "|"
   D_SENSOR_SPI_CS "|" D_SENSOR_SPI_DC "|" D_SENSOR_BACKLIGHT "|"
   D_SENSOR_PMS5003 "|" D_SENSOR_SDS0X1 "|"
-  D_SENSOR_SBR_TX "|" D_SENSOR_SBR_RX;
+  D_SENSOR_SBR_TX "|" D_SENSOR_SBR_RX "|"
+  D_SENSOR_SR04_TRIG "|" D_SENSOR_SR04_ECHO;
 
 /********************************************************************************************/
 

diff --git a/sonoff/user_config.h b/sonoff/user_config.h
@@ -285,6 +285,8 @@
 
 #define USE_ARILUX_RF                            // Add support for Arilux RF remote controller (+0k8 code, 252 iram (non 2.3.0))
 
+#define USE_SR04                                 // Add support for HC-SR04 ultrasonic devices (+1k code)
+
 /*********************************************************************************************\
  * Select all sensors - overrides above undefines!!
 \*********************************************************************************************/