Merge remote-tracking branch 'upstream/development' into WebUIPR

NorthernMan54 · Apr 12, 2023 · d514332 · d514332
2 parents 9b6a211 + 479ac5d
commit d514332
Show file tree

Hide file tree

Showing 10 changed files with 375 additions and 198 deletions.
diff --git a/docs/setitup/rf.md b/docs/setitup/rf.md
@@ -1,5 +1,6 @@
 # RF gateway (433mhz/315mhz)
-Protocols, modules and library
+
+## Protocols, modules and library
 
 RTL_433 covers OOK protocols detailed [here](../use/rf#supported-decoders) and supports auto-discovery following Home Assistant convention. The other libraries/modules are more for advanced users.
 
@@ -16,20 +17,19 @@ RTL_433 covers OOK protocols detailed [here](../use/rf#supported-decoders) and s
 :::tip
 If you want to try the RTL_433 module with a combination or a board outside of this list, verify that it has an SX1278 or a SX1276
 :::
+
 Heltec LORA V3 is not compatible with RTL_433 library as it is based on an SX1262 module.
 
 ## Assembly/soldering required parts
 |Module|Purpose|Compatible modules|Receiver Switching|Where to Buy|
 |-|-|-|-|-|
-|SRX882 (recommended)|433Mhz Receiver|RF(RCSwitch), RF2(KaKu), Pilight|Supported|[compatible parts list](https://compatible.openmqttgateway.com/index.php/parts)|
+|SRX882 or SRX882S (recommended)|433Mhz Receiver|RF(RCSwitch), RF2(KaKu), Pilight|Supported|[compatible parts list](https://compatible.openmqttgateway.com/index.php/parts)|
 |STX882 (recommended)|433Mhz Transmitter|RF(RCSwitch), RF2(KaKu), Pilight|Supported|[compatible parts list](https://compatible.openmqttgateway.com/index.php/parts)|
-|XD RF 5V|433Mhz Receiver|RF(RCSwitch), RF2(KaKu), Pilight|Supported|[compatible parts list](https://compatible.openmqttgateway.com/index.php/parts)|
-|FS1000A|433Mhz Transmitter|RF(RCSwitch), RF2(KaKu), Pilight|Supported|[compatible parts list](https://compatible.openmqttgateway.com/index.php/parts)|
 |CC1101|433Mhz Transceiver|[RTL_433](../use/rf#supported-decoders), RF(RCSwitch), RF2(KaKu), Pilight|Supported|[compatible parts list](https://compatible.openmqttgateway.com/index.php/parts)|
 |SX1276/SX1278|433Mhz Transceiver|[RTL_433](../use/rf#supported-decoders)|Not Supported|[compatible parts list](https://compatible.openmqttgateway.com/index.php/parts)|
 |LilyGo/Heltec|433Mhz Transceiver|[RTL_433](../use/rf#supported-decoders)|Not Supported|[compatible parts list](https://compatible.openmqttgateway.com/index.php/parts)|
 
-## Pinout
+### SRX STX Pinout
 |Board| Receiver Pin| Emitter Pin|
 |-|:-:|:-:|
 |Arduino UNO|D3|D4|
@@ -42,6 +42,10 @@ Heltec LORA V3 is not compatible with RTL_433 library as it is based on an SX126
 
 Connect the Emitter and Receiver to a 5V or 3.3V supply source, check datasheet of your modules to confirm (**3.3V** for CC1101), and the ground of your supply source to the ground of your board.
 
+:::tip
+With SRX882S receiver connect the CS pin to 3.3V
+:::
+
 ### CC1101 Pinout
 |Board|Receiver Pin(GDO2)|Emitter Pin(GDO0)|SCK|VCC|MOSI|MISO|CSN|GND
 |-|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|
@@ -51,8 +55,8 @@ Connect the Emitter and Receiver to a 5V or 3.3V supply source, check datasheet
 To use the CC1101 module, `ZradioCC1101` must be uncomment in the `User_config.h` or added to the `build_flags`.
 More information about the [CC1101 wiring](https://github.com/LSatan/SmartRC-CC1101-Driver-Lib#wiring). ( Please note that with OMG we are recommending CC1101 GDO2 to be connected to ESP32 D27 and GDO0 to be connected to D12, this is different than the LSatan diagram. This is due to the ESP32 using D2 as part of the boot process. )
 
-## Arduino Hardware setup
-![RF](../img/OpenMQTTgateway_Arduino_Addon_RF.png)
+## ESP32 Hardware setup
+![Addon_RF](../img/OpenMQTTgateway_ESP32_Addon_RF.png)
 
 ## ESP8266 Hardware setup
 If the gateway works only when serial monitor is connected don't use D3 use D2 instead (gpio 4) and modify config_RF.h accordingly.
@@ -61,8 +65,8 @@ With SRX882 some users reported that D3 is not working use D1 instead in this ca
 
 ![Addon_RF](../img/OpenMQTTgateway_ESP8266_Addon_RF.png)
 
-## ESP32 Hardware setup
-![Addon_RF](../img/OpenMQTTgateway_ESP32_Addon_RF.png)
+## Arduino Hardware setup
+![RF](../img/OpenMQTTgateway_Arduino_Addon_RF.png)
 
 ## SONOFF RF Bridge Hardware setup
 Per default there is no need on modifying the RF Bridge hardware, unless you don't want to use the provided RF controller (EFM8BB1). Indeed if you want to extend the protocols supported by the bridge you can [bypass this controller](https://github.com/xoseperez/espurna/wiki/Hardware-Itead-Sonoff-RF-Bridge---Direct-Hack) and use the ESP8255 capacities to decode RF Signal.

diff --git a/docs/use/boards.md b/docs/use/boards.md
@@ -91,3 +91,20 @@ OpenMQTTGateway support a low power mode for ESP32, this mode can be set by MQTT
 
 The low power mode can be changed also with a push to button B when the board is processing (top button on M5stickC, M5stickC Plus and middle button of M5stack).
 If you are already in low power mode 1 or 2 with M5Stack you can wake up the board by pressing the red button.
+
+### Low power mode (deepSleep) for ESP8266 boards
+In certain use cases where power is severly limited you can use the ESP8266 deep sleep capability.
+
+* e.g. measuring a pool temperature every 5 minutes using an ESP8266 and DS18B20 probe where the ESP8266 is powered by very limited battery backed solar power.
+
+During deep sleep everything is off and (almost) all execution state is lost. 
+
+Consumption is about 20 µA.
+
+Use this when you want the device to sleep for minutes or hours.
+
+You only have to define the macro `ESP8266_DEEP_SLEEP_IN_US` with the number of microseconds.
+
+A hardware jumper is required connecting RST to a GPIO (not to CH_PD) defined by the macro `ESP8266_DEEP_SLEEP_WAKE_PIN` and defaulted to D0.
+
+And the sensor code must set variable `ready_to_sleep` to true after publishing the measurement to MQTT and the main loop will then enter deep sleep.