Merge branch 'master' of https://github.com/tasmota/docs

Author: blakadder

Bluetooth.md

@@ -1,4 +1,9 @@
+<<<<<<< HEAD
 ?> Presence detection with iBeacons or BLE sensor gateway using HM-1x or nRF24L01(+) peripherals
+=======
+Tasmota provides limited Bluetooth functionality through the use of external hardware. Two different drivers support the use of bluetooth beacons or several BLE sensors from the Mijia/Xiaomi-universe.  
+  
+>>>>>>> 2e65a7b49ad13c05bce0b7d40783d4adb71f0833
 
 ## iBeacon  
 **This feature is included only in tasmota-sensors.bin** 
@@ -50,12 +55,112 @@ Cheap "iTag" beacons with a beeper. The battery on these lasts only about a mont
 - [eBay](https://www.ebay.de/sch/i.html?_from=R40&_trksid=m570.l1313&_nkw=Smart-Tag-GPS-Tracker-Bluetooth-Anti-verlorene-Alarm-Key-Finder-Haustier-Kind&_sacat=0)
 - [Amazon.com](https://www.amazon.com/s?k=itag+tracker+4.0)
 
+<<<<<<< HEAD
 <img src="/_media/bluetooth/itag.png" width=225><img src="/_media/bluetooth/itag2.png" width=225><img src="/_media/bluetooth/itag3.png" width=225>
 
 > [!TIP] 
 You can activate a beacon with a beeper using command `IBEACON_%BEACONID%_RSSI 99` (ID is visible in webUI and SENSOR reports). This command can freeze the Bluetooth moduel and beacon scanning will stop. After a reboot of Tasmota the beacon will start beeping and scanning will resume.
 
 ## BLE Sensors using HM-1x
+=======
+With the arrival of the (cheap) LYWSD03 came the problem of encrypted data in MiBeacons, which to date has only been successfully decrypted in open source projects in a quite complicated way (getting the 16-byte-key with 3rd-party-software while pairing the device with the original Xiaomi-Apps).
+At least the device allows the use of a simple BLE connection without any encrypted authentication and the reading of the sensor data using normal subscription methods to GATT-services. This is more power hungry than the passive reading of BLE advertisements.   
+  
+### Working principle of both Tasmota drivers (>8.2.0.1)
+  
+The idea is to provide drivers with as much automatic functions as possible. Besides the hardware setup, there are zero or very few things to configure. It is not necessary to pair the sensors with any of the vendor apps.  
+The sensor namings are based on the original sensor names and shortened if appropriate (Flower care -> Flora). A part of the MAC will be added to the name as a suffix.  
+All sensors are treated as if they are physically connected to the ESP8266-device.
+
+
+## Tasmota-HM10-driver
+
+### prerequisites:
+-firmware 707 (other versions may work, but this is undefined behavior)  
+-simple serial cable connection  
+-HM-10 is set to default baud rate of 115200  (if not look for HM10BAUD-command)  
+-uncomment #ifdef USE_HM10 in my_user_config.h  
+-select GPIO-pins "HM10 RX" and "HM10 TX"
+
+!> **Most of the self-flashed modules will still have their factory default with a baud rate of 9600 !!**  
+ Please try:  
+` 
+  HM10BAUD 9600`  
+`   
+  HM10AT RENEW
+`  
+Then reboot ESP8266.
+
+
+
+### expected behavior:
+1. The driver will set a few options of the HM-10
+2. A discovery scan will search for known sensors (Mi Flora, MJ_HT_V1, LYWSD02, LYWSD03, CGG1, CGD1)
+3. Supported sensors will be connected at a given interval, a subscription is established for ~5 seconds and temperature/humidity/battery will be read.
+4. After deconnection return to point 3 after the interval.
+
+### command interface:  
++ hm10scan  
+start new discovery scan  
++ hm10period x  
+set or show interval in seconds between sensor read cycles (is set to the value of teleperiod at start). hm10period 1 will trigger one read cycle and not change the period. 
++ hm10baud x   
+set or show the speed of the serial interface of the esp8266, not of the hm10  
++ hm10at xxxx  
+sends AT-commands,e.g. hm10at verr? results in AT+VERR?  
++ hm10time x
+sets the time of sensor x (if it is a LYWSD02) to the system-UTC-time and the timezone of Tasmota. Sensors are ordered from 0 to n in the order of the arrival. 
++ hm10auto x
+start an automatic discovery scan with an interval of x seconds to receive data in BLE-advertisements periodically. This an active scan and it should only be used, if necessary. This might change in the future, if a newer firmware of the HM-10 will support passive scan.  
++ hm10 page x  
+shows a maximum of x sensors at a time in the web UI, if there are more sensors than x, the driver will cycle through multiple pages.  
+
+
+### Features:  
++ RULES
+After a discovery scan the driver will report the number of found sensors. As the driver can not know, how many sensors are to be found, this can be used to force a re-scan.  
+`Rule1 on hm10#found<6 do ADD1 1 endon on Var1#state<=3 do hm10scan endon`  - will re-scan up to 3 times, if less than 6 sensors were found.  
++ DEW POINT  
+Dew point will be calculated.  
+
+
+### Supported sensors:  
+
++ LYWSD02  
+This device has an E-Ink-Display, works with 2 x CR2032-coin-cells and the driver can read temperature, humidity and battery. In addition the clock of the device can be set tot the system-time of Tasmota via command "hm10time".  
+  
+<img src="https://github.com/tasmota/docs/blob/master/_media/peripherals/lywsd02.jpg?raw=true" style="width:200px"></img>  
+ 
+  
++ LYWSD03MMC  
+Small, rectangular form, 1 x CR2032-coin-cell. The driver can read temperature, humidity and battery.
+  
+<img src="https://github.com/tasmota/docs/blob/master/_media/peripherals/lywsd03.png?raw=true" style="width:200px"></img>  
+ 
+ 
++ Flower Care ("Flora")  
+Works with a CR2032-coin-cell and provides temperature, illuminance, (soil-)humidity, (soil-)fertility and battery.  
+  
+<img src="https://github.com/tasmota/docs/blob/master/_media/peripherals/miflora.png?raw=true" style="width:200px"></img>  
+  
++ MJ_HT_V1  
+Model: LYWSDCGQ/01ZM  
+This device works with an AAA-battery for several months and the driver can read temperature, humidity and battery level. Needs HM10AUTO to update sensor data.
+  
+<img src="https://github.com/tasmota/docs/blob/master/_media/peripherals/mj_ht_v1.png?raw=true" style="width:200px"></img>
+ 
+  
++ CGD1 (Alarm clock)  
+The driver can read temperature, humidity and battery. Time or alarm functions are not supported.  
+  
+<img src="https://github.com/tasmota/docs/blob/master/_media/peripherals/CGD1.png?raw=true" style="width:200px"></img>  
+ 
+#### not supported:  
+CGG1 should be found and may give readings via MiBeacons, but is untested.  
+  
+<img src="https://github.com/tasmota/docs/blob/master/_media/peripherals/CGG1.png?raw=true" style="width:200px"></img>  
+ 
+>>>>>>> 2e65a7b49ad13c05bce0b7d40783d4adb71f0833
 
 !> **This feature is included only in tasmota-sensors.bin**
 
@@ -151,6 +256,42 @@ Internally from time to time "fake" sensors will be created, when there was data
 !> **It can not be ruled out, that changes in the device firmware may break the functionality of this driver completely!**  
 
 The naming conventions in the product range of bluetooth sensors in XIAOMI-universe can be a bit confusing. The exact same sensor can be advertised under slightly different names depending on the seller (Mijia, Xiaomi, Cleargrass, ...).
+<<<<<<< HEAD
+=======
+  
+#### MJ_HT_V1:  
+Model: LYWSDCGQ/01ZM  
+This device works with an AAA-battery for several months and the driver can read temperature, humidity and battery level.  
+  
+<img src="https://github.com/tasmota/docs/blob/master/_media/peripherals/mj_ht_v1.png?raw=true" style="width:200px"></img>
+  
+  
+#### Flower Care ("Flora"):  
+Works with a CR2032-coin-cell and provides temperature, illuminance, (soil-)humidity and (soil-)fertility.  
+  
+<img src="https://github.com/tasmota/docs/blob/master/_media/peripherals/miflora.png?raw=true" style="width:200px"></img>  
+  
+  
+#### LYWSD02:  
+This device has an E-Ink-Display, works with 2 x CR2032-coin-cells and the driver can read temperature and humidity.  
+  
+<img src="https://github.com/tasmota/docs/blob/master/_media/peripherals/lywsd02.jpg?raw=true" style="width:200px"></img>  
+  
+  
+#### CGG1:  
+This device has an E-Ink-Display, with CR2430-coin-cell and the driver can read temperature, humidity and battery.  
+  
+<img src="https://github.com/tasmota/docs/blob/master/_media/peripherals/CGG1.png?raw=true" style="width:200px"></img>  
+ 
+  
+#### CGD1:  
+Alarm clock powered by 2 AA-batteries. Driver can read temperature and humidity.  
+  
+<img src="https://github.com/tasmota/docs/blob/master/_media/peripherals/CGD1.png?raw=true" style="width:200px"></img>  
+   
+   
+ 
+>>>>>>> 2e65a7b49ad13c05bce0b7d40783d4adb71f0833
 
  <table>
   <tr>
@@ -178,7 +319,14 @@ The naming conventions in the product range of bluetooth sensors in XIAOMI-unive
 
 #### Unsupported Devices  
 
+<<<<<<< HEAD
 For LYWSD03MMC the sensor data in the advertisements is encrypted. It is highly unlikely to read data with the NRF24L01 out-of-the-box in the future. You can use an HM-1x module for this sensor.
+=======
+The situation for the LYWSD03MMC (small, rectangular form) is different, as the sensor data in the advertisements is encrypted. It is highly unlikely to read data with the NRF24L01 out-of-the-box in the future.  
+  
+<img src="https://github.com/tasmota/docs/blob/master/_media/peripherals/lywsd03.png?raw=true" style="width:200px"></img>  
+
+>>>>>>> 2e65a7b49ad13c05bce0b7d40783d4adb71f0833
 
 ## Getting data from BT Xiaomi Devices