esp32 builds and changing compilation define

formatting

Author: blakadder

docs/A4988-Stepper-Motor-Controller.md

@@ -1,12 +1,12 @@
-!!! failure "This feature is not included in precompiled binaries"
+??? failure "This feature is not included in precompiled binaries"  
+
+    When [compiling your build](Compile-your-build) add the following to `user_config_override.h`:
+    ```c++
+    #ifndef USE_A4988_STEPPER
+    #define USE_A4988_STEPPER    // A4988/DRV8825 stepper motor (+10k5 code)
+    #endif
+    ```
 
-To use it you must [compile your build](Compile-your-build). Add the following to `user_config_override.h`:
-```
-#ifndef USE_A4988_STEPPER
-#define USE_A4988_STEPPER    // A4988/DRV8825 stepper motor (+10k5 code)
-#endif
-```
-----
 This driver is used to control stepper-motors such as [NEMA 17](https://reprap.org/wiki/NEMA_17_Stepper_motor).   
 
 ## Configuration

docs/AHT1x.md

@@ -1,33 +1,32 @@
 # AHT1x/AHT2x and compatible temperature and humidity sensor
-!!! failure "This feature is not included in precompiled binaries"  
 
-To use it you must [compile your build](Compile-your-build). Add the following to `user_config_override.h` to add support for AHT10 or AHT15:
-```
-#ifndef USE_AHT1x
-#define USE_AHT1x       // [I2cDriver43] Enable AHT10/15 humidity and temperature sensor (I2C address 0x38 or 0x39)
-#endif
-```
-or those lines for AHT20 or AM2301B:
-```
-#ifndef USE_AHT2x
-#define USE_AHT2x       Enable AHT20 instead of AHT1x humidity and temperature sensor (I2C address 0x38)
-#endif
-```
+??? failure "This feature is not included in precompiled binaries"  
 
-----
+    When [compiling your build](Compile-your-build) add the following to `user_config_override.h`:
+    ```c++
+    #ifndef USE_AHT1x
+    #define USE_AHT1x       // [I2cDriver43] Enable AHT10/15 humidity and temperature sensor (I2C address 0x38, 0x39) (+0k8 code)
+    #endif
+    ```
+    or those lines for AHT2x or AM2301B:
+    ```
+    #ifndef USE_AHT2x
+    #define USE_AHT2x       // [I2cDriver43] Enable AHT20/AM2301B instead of AHT1x humidity and temperature sensor (I2C address 0x38) (+0k8 code)
+    #endif
+    ```
 
-AHT10 or AH15 are an I<sup>2</sup>C temperature and humidity sensor.
-AHT20 or AM2301B are upgraded versions.
+AHT1x are an I<sup>2</sup>C temperature and humidity sensor.
+AHT2x or AM2301B are upgraded versions.
 
 ## Configuration
 
 !!! failure "This sensor is incompatible with other I^2^C devices on I^2^C bus"
     Sensor datasheet implicitly says:
     **Only a single** AHT10 can be connected to the I^2^C bus and no other I^2^C devices can be connected.
-    The AHT20/AM2301B do not suffer from this problem.
+    The AHT2x/AM2301B does not suffer from this problem.
 
 ### Wiring
-| AHT1x   | ESP8266 |
+| AHT   | ESP |
 |---|---|
 |VCC   |3.3V
 |GND   |GND   
@@ -38,8 +37,8 @@ AHT20 or AM2301B are upgraded versions.
 ### Tasmota Settings 
 In the **_Configuration -> Configure Module_** page assign:
 
-1. GPIOx to `I2C SDA (6)`
-2. GPIOy to `I2C SCL (5)`
+1. GPIOx to `I2C SDA`
+2. GPIOy to `I2C SCL`
 
 After a reboot the driver will detect AHT1x automatically and display sensor readings.
 

docs/AM2301.md

@@ -1,6 +1,12 @@
 # AM2301/AM2302 (DHT21/DHT22) temperature and humidity sensor
 
-!!! info "This feature is included only in tasmota-sensors.bin" 
+??? tip "This feature is included in `tasmota`, `tasmota32`, `tasmota-knx` and `tasmota-display` binaries" 
+    When [compiling your build](Compile-your-build) add the following to `user_config_override.h`:
+    ```c++
+    #ifndef USE_DHT
+    #define USE_DHT     // Add support for DHT11, AM2301 (DHT21, DHT22, AM2302, AM2321) and SI7021 Temperature and Humidity sensor (1k6 code)
+    #endif
+    ```
 
 AM2301 driver supports [AM2301 (DHT21)](http://www.haoyuelectronics.com/Attachment/AM2301/AM2301.pdf), [AM2302 (DHT22)](https://www.sparkfun.com/datasheets/Sensors/Temperature/DHT22.pdf) and [AM2321](http://akizukidenshi.com/download/ds/aosong/AM2321_e.pdf) temperature and humidity sensors. Introduced in Tasmota through [Sonoff AM2301](https://sonoff.tech/product/accessories/am2301) accessory for [Sonoff TH](/devices/Sonoff-TH).
 
@@ -11,7 +17,7 @@ For AM2301B I^2^C model, please refer to [AHT1x/AHT2x](AHT1x) driver.
 ## Configuration
 
 ### Wiring
-| AM2301   | ESP266 |
+| AM2301   | ESP |
 |---|---|
 |-   |GND   |
 |OUT   |GPIOx   |

docs/APDS-9960.md

@@ -1,19 +1,23 @@
 # APDS-9960 light and gesture sensor
 
-!!! failure "This feature is not included in precompiled binaries"  
+??? failure "This feature is not included in precompiled binaries"  
+
+    When [compiling your build](Compile-your-build) add the following to `user_config_override.h`:
+    ```c++
+    #ifndef USE_APDS9960
+    #define USE_APDS9960                // [I2cDriver21] Enable APDS9960 Proximity Sensor (I2C address 0x39). Disables SHT and VEML6070 (+4k7 code)
+      #define USE_APDS9960_GESTURE        // Enable APDS9960 Gesture feature (+2k code)
+      #define USE_APDS9960_PROXIMITY      // Enable APDS9960 Proximity feature (>50 code)
+      #define USE_APDS9960_COLOR          // Enable APDS9960 Color feature (+0.8k code)
+      #define USE_APDS9960_STARTMODE  0   // Default to enable Gesture mode
+    #endif
+    ```
 
-To use it you must [compile your build](Compile-your-build). Add the following to `user_config_override.h`:
-```
-#ifndef USE_APDS9960
-#define USE_APDS9960     // Enable APDS9960 Proximity Sensor (+4k7 code)
-#endif
-```
-----
 Broadcom APDS-9960 is a digital RGB, ambient light, proximity and gesture sensor device in a single 8-pin package. The device has an I2C compatible interface providing red, green, blue, clear (RGBC), proximity and gesture sensing with IR LED. The RGB and ambient light sensing feature detects light intensity under various lighting conditions and through various attentuation materials including darkened glass. In addition, the integrated UV-IR blocking filter enables accurate ambient light and correlated color temperature sensing.
 
 ## Configuration
 #### Wiring
-| Breakout | ESP8266   |
+| Breakout | ESP   |
 |----------|-----------|
 | VCC/VIN  | +3.3VDC   |
 | GND      | GND       |
@@ -24,8 +28,8 @@ Broadcom APDS-9960 is a digital RGB, ambient light, proximity and gesture sensor
 #### Tasmota Settings
 In the **_Configuration -> Configure Module_** page assign:
 
-1. GPIOx to `I2C SDA (6)`
-2. GPIOy to `I2C SCL (5)`
+1. GPIOx to `I2C SDA`
+2. GPIOy to `I2C SCL`
 
 After configuring the GPIO's the driver will detect the APDS-9960 automatically.
 On first boot sensor will start in gesture mode. It will not appear in the webUI but it can be observed via MQTT messages in console:

docs/AS3935.md

@@ -1,7 +1,13 @@
 # AS3935 Franklin Lightning sensor
 
-!!! info "This feature is included only in tasmota-sensors.bin"
+??? tip "This feature is included only in `tasmota-sensors` and `tasmota32` binaries" 
 
+    When [compiling your build](Compile-your-build) add the following to `user_config_override.h`:
+    ```c++
+    #ifndef USE_AS3935 
+    #define USE_AS3935      // [I2cDriver48] Enable AS3935 Franklin Lightning Sensor (I2C address 0x03) (+5k4 code)
+    #endif
+    ```
 
 The AS3935 is a programmable fully integrated Lightning
 Sensor IC that detects the presence and approach of potentially
@@ -21,7 +27,7 @@ Tasmota driver includes:
 ## Configuration
 
 ### Wiring
-| AS3935   | ESP8266 |
+| AS3935   | ESP |
 |---|---|
 |GND   |GND
 |VCC   |3.3V
@@ -35,11 +41,11 @@ Tasmota driver includes:
 ### Tasmota Settings
 In the **_Configuration -> Configure Module_** page assign:
 
-1. GPIOx to `I2C SDA (6)`
-2. GPIOy to `I2C SCL (5)`
-3. GPIOz to `AS3935 (202)`
+1. GPIOx to `I2C SDA`
+2. GPIOy to `I2C SCL`
+3. GPIOz to `AS3935`
 
-!!! tip "Note for I2C Use"
+!!! tip "Note for I^2^C Use"
 You will need to wire up all of the associated pins for the different boards.<br>
 - Always connect CS and MISO to GND.<br>
 - If "SI" is present, you need to connect to VCC.<br>

docs/AZ-7798.md

@@ -1,13 +1,13 @@
 # AZ7798 CO~2~ meter
 
-!!! failure "This feature is not included in precompiled binaries"     
-To use it you must [compile your build](Compile-your-build). Add the following to `user_config_override.h`:
-```
-#ifndef USE_AZ7798
-#define USE_AZ7798          // Add support for AZ-Instrument 7798 CO2 datalogger (+1k6 code)
-#endif
-```
-----
+??? failure "This feature is not included in precompiled binaries"  
+
+    When [compiling your build](Compile-your-build) add the following to `user_config_override.h`:
+    ```c++
+    #ifndef USE_AZ7798
+    #define USE_AZ7798      // Add support for AZ-Instrument 7798 CO2 datalogger (+1k6 code)
+    #endif
+    ```
 
 <img src="https://raw.githubusercontent.com/wiki/adebeun/Sonoff-Tasmota/az7798-front.jpg" align=right width=240>
 
@@ -16,7 +16,7 @@ The AZ7798 CO~2~ Meter/Datalogger appears to be made by [AZ Instrument](https://
 The CO~2~ meter is already provided with a PC interface in the form of a logic-level (3V3) serial port, accessible through a 2.5mm stereo jack on the back. The Wemos D1 Mini is connected to this serial port instead, and the PC interface is no longer available.
 
 ## Configuration
-### Connecting the AZ7798 to a Wemos D1 Mini
+#### Connecting the AZ7798 to a Wemos D1 Mini
 
 The Wemos D1 Mini is fitted inside the meter enclosure. This requires the enclosure to be opened. There are four screws. Two of the screws are hidden behind the type label. Use the tip of a small knife to cut holes in the label.
 
@@ -43,8 +43,8 @@ Make a small right-angle bracket for mounting the Wemos D1 Mini to the meter boa
 
 In the **_Configuration -> Configure Module_** page assign:
 
-1. D1 TX to `AZ Tx (117)`
-2. D3 RX to `AZ Rx (118)`
+1. D1 TX to `AZ Tx`
+2. D3 RX to `AZ Rx`
 
 ![](https://raw.githubusercontent.com/wiki/adebeun/Sonoff-Tasmota/az7798-configure.png)
 

docs/Alexa.md

@@ -1,17 +1,12 @@
-!!! info "This feature is included only in builds: tasmota and tasmota-sensors"
+??? tip "This feature is included only in `tasmota`, `tasmota32`, `tasmota-lite` and `tasmota-sensors` binaries" 
 
-To use in other builds you must [compile your own build](Compile-your-build). Add the following to `user_config_override.h`:
-```
-#ifndef EMULATION
-#define EMULATION       EMUL_NONE       // [Emulation] Select Belkin WeMo (single relay/light) or Hue Bridge emulation (multi relay/light) (EMUL_NONE, EMUL_WEMO or EMUL_HUE)
-#endif
-```
+    When [compiling your build](Compile-your-build) add the following to `user_config_override.h`:
+    ```c++
+     #define USE_EMULATION              // Enable Wemo or Hue emulation
+     #define USE_EMULATION_HUE          // Enable Hue Bridge emulation for Alexa (+14k code, +2k mem common)
+     #define USE_EMULATION_WEMO         // Enable Belkin WeMo emulation for Alexa (+6k code, +2k mem common)
+     ```
 
-`EMUL_NONE` = disables emulation   
-`EMUL_WEMO` = enables Belking WeMo emulation   
-`EMUL_HUE` = enables Hue Bridge emulation   
-
-----
 ## Connecting to Alexa
 
 You can interact with Tasmota using Amazon Alexa through its Echo devices . 

docs/BH1750.md

@@ -1,24 +1,31 @@
 # BH1750 ambient light sensor
 
-!!! info "This feature is included only in tasmota-sensors.bin" 
+??? tip "This feature is included only in `tasmota32` and `tasmota-sensors` binaries" 
+
+    When [compiling your build](Compile-your-build) add the following to `user_config_override.h`:
+    ```c++
+    #ifndef USE_BH1750
+    #define USE_BH1750      // [I2cDriver11] Enable BH1750 sensor (I2C address 0x23 or 0x5C) (+0k5 code)
+    #endif
+    ```
 
 The BH1750 is a digital ambient light sensor module which uses I<sup>2</sup>C to communicate. The BH1750 provides you with a digital value in lux (Lx) over a range of 1 - 65535 lx. See [datasheet](https://www.mouser.com/datasheet/2/348/bh1750fvi-e-186247.pdf) for more information.
 
 ## Configuration
 
 ### Wiring
-| BH1750   | ESP8266 |
+| BH1750   | ESP |
 |---|---|
-|GND   |GND   
-|VCC   |3.3V
+|GND   | GND   
+|VCC   | 3.3V
 |SDA   | GPIOx
 |SCL   | GPIOy
 
 ### Tasmota Settings 
 In the **_Configuration -> Configure Module_** page assign:
 
-1. GPIOx to `I2C SDA (6)`
-2. GPIOy to `I2C SCL (5)`
+1. GPIOx to `I2C SDA`
+2. GPIOy to `I2C SCL`
 
 After a reboot the driver will detect BH1750 automatically and display Illuminance.
 

docs/BME280.md

@@ -1,20 +1,33 @@
 # BME280 temperature, humidity and pressure sensor
-!!! info "This feature is included only in tasmota-sensors.bin" 
+
+??? tip "This feature is included only in `tasmota-sensors` and `tasmota32` binaries" 
+
+    When [compiling your build](Compile-your-build) add the following to `user_config_override.h`:
+    ```c++
+    #ifndef USE_BMP
+    #define USE_BMP     // [I2cDriver10] Enable BMP085/BMP180/BMP280/BME280 sensors (I2C addresses 0x76 and 0x77) (+4k4 code)
+    #endif
+    ```
 
 BME280 sensor, an environmental sensor with temperature, barometric pressure and humidity" See [BME280 Temperature, Humidity and Pressure Sensor](https://www.adafruit.com/product/2652) for more information.
 
-BME280 driver also supports [BMP085](https://learn.adafruit.com/bmp085), [BMP180](https://www.bosch-sensortec.com/bst/products/all_products/bmp180) and [BMP280](https://www.bosch-sensortec.com/bst/products/all_products/bmp280) sensors.
+BME280 driver also supports [BMP085](https://learn.adafruit.com/bmp085), [BMP180](https://www.bosch-sensortec.com/bst/products/all_products/bmp180) and [BMP280](https://www.bosch-sensortec.com/bst/products/all_products/bmp280) pressure sensors.
 
 ## Configuration
 
 ### Wiring
-| BME280 | ESP8266
+| BME280 | ESP
 |   ---|    ---
 |GND   | GND
 |VCC   | 3.3V 
 |SDA   | GPIOx
 |SCL   | GPIOy
 
+### Tasmota Settings 
+In the **_Configuration -> Configure Module_** page assign:
+
+1. GPIOx to `I2C SDA`
+2. GPIOy to `I2C SCL`
 
 !!! note
     If you are using breakout boards which break out pins CSB please ensure that you connect this pin to VCC to ensure that the chip stays in I<sup>2</sup>C mode. This is due to some manufacturers of breakout boards add pull-up resistors to allow for SPI compatibility (some would default to SPI, others to I<sup>2</sup>C)_

docs/BME680.md

@@ -1,13 +1,13 @@
 # BME680 temperature, humidity, pressure and gas sensor
-!!! info "This feature is included only in tasmota-sensors.bin"
+??? tip "This feature is included only in `tasmota-sensors` and `tasmota32` binaries" 
+
+    When [compiling your build](Compile-your-build) add the following to `user_config_override.h`:
+    ```c++
+    #ifndef USE_BME68X
+    #define USE_BME68X      // Enable support for BME680/BME688 sensor using Bosch BME68x library (+6k9 code)
+    #endif
+    ```
 
-Otherwise you must [compile your build](Compile-your-build). Add the following to `user_config_override.h`:
-```
-#ifndef USE_BME680
-#define USE_BME680    // Enable support for BME680 sensor using Bosch BME680 library (+4k code)
-#endif
-```
-----
 BME680 sensor, an environmental I<sup>2</sup>C sensor with temperature, humidity, barometric pressure and gas.
 
 _The BME680 takes those sensors to the next step in that it contains a small MOX sensor. The heated metal oxide **changes resistance** based on the volatile organic compounds (VOC) in the air, so it can be used to detect gasses & alcohols such as Ethanol, Alcohol and Carbon Monoxide, and perform air quality measurements. Note it will give you one resistance value, with overall VOC content, but it cannot differentiate gasses or alcohols._
@@ -18,7 +18,7 @@ See [BME680 - Temperature, Humidity, Pressure and Gas Sensor](https://www.adafru
 ## Configuration
 
 ### Wiring
-| BME680   | ESP8266 |
+| BME680   | ESP |
 |---|---|
 |GND   |GND   
 |VCC   |3.3V   
@@ -28,8 +28,8 @@ See [BME680 - Temperature, Humidity, Pressure and Gas Sensor](https://www.adafru
 ### Tasmota Settings 
 In the **_Configuration -> Configure Module_** page assign:
 
-- GPIOx to `I2C SDA (6)`   
-- GPIOy to `I2C SCL (5)`
+- GPIOx to `I2C SDA`   
+- GPIOy to `I2C SCL`
 
 After a reboot the driver will detect BME680 automatically and display temperature, humidity, dew point, pressure and gas resistance measured.