diff --git a/docs/README.md b/docs/README.md index 34af5e1..924b034 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,5 +1,7 @@ -**Theengs app** is a multi platforms, multi devices application and BLE to MQTT gateway that leverages the [Theengs Decoder library](https://github.com/theengs/decoder). -It retrieves data from a wide range of [BLE sensors](prerequisites/devices); LYWSD03MMC, CGD1, CGP1W, H5072, H5075, H5102, TH1, TH2, BBQ, CGH1, CGDK2, CGPR1, RuuviTag, WS02, WS08, TPMS, MiScale, LYWSD02, LYWSDCGQ, MiFlora... and enables to read the advertised data from these sensors. It also translates this information into a readable JSON format and pushes those to an MQTT broker if you need. +**Theengs app** is a multi platforms, multi devices **application** and BLE to MQTT **gateway** that leverages the [Theengs Decoder library](https://github.com/theengs/decoder). +It retrieves data from a wide range of [BLE sensors](prerequisites/devices) from Xiaomi, Inkbird, Govee, ClearGrass, Qingping, Ruuvi, Switchbot, Thermopro; LYWSD03MMC, CGD1, CGP1W, CGDN1, CGG1, H5055, H5072, H5075, H5102, TH1, TH2, BBQ, CGH1, CGDK2, CGPR1, RuuviTag, WS02, WS08, TPMS, MiScale, LYWSD02, LYWSDCGQ, MiFlora... and enables to read the advertised real time data from these sensors. + +It also translates this information into a readable JSON format and pushes those to an MQTT broker if you need. The Home Assistant MQTT convention is followed so that you can see your add your sensors in a few steps into your favorite controller. The app uses the bluetooth component of your Phone/Tablet to read the sensor data. @@ -20,10 +22,10 @@ Theengs app read data "broadcasted" by the devices and does not connect to them, ::: Features comparison between OS: -| OS | Real time data | MQTT integration | Running in background | -|:-:|:-:|:-:|:-:| -|iOS|☑️|☑️|| -|Android|☑️|☑️|☑️ *experimental*| +| OS | Real time data | MQTT integration | Running in background | Home Assistant Auto Discovery | +|:-:|:-:|:-:|:-:|:-:| +|iOS|☑️|☑️||☑️| +|Android|☑️|☑️|☑️ *experimental*|☑️| #### Third party projects used by Theengs app @@ -40,3 +42,11 @@ Features comparison between OS: *App Store and Apple logo are registered trademarks of Apple Inc.* *Google Play and the Google Play logo are trademarks of Google LLC.* + +::: warning Note +All product and company names are trademarks or registered trademarks of their respective holders. Use of them does not imply any affiliation with or endorsement by them. +::: + +::: slot footer +[GPLv3 Licensed](https://github.com/theengs/home/blob/main/LICENSE) | Copyright © 2022-present Theengs +::: diff --git a/docs/img/Theengs_app_auto_discovery_BLE_Sensor_Home_Assistant.gif b/docs/img/Theengs_app_auto_discovery_BLE_Sensor_Home_Assistant.gif new file mode 100644 index 0000000..1cfe3d2 Binary files /dev/null and b/docs/img/Theengs_app_auto_discovery_BLE_Sensor_Home_Assistant.gif differ diff --git a/docs/use/use.md b/docs/use/use.md index 00921b1..9137d90 100644 --- a/docs/use/use.md +++ b/docs/use/use.md @@ -1,10 +1,10 @@ # Use Features comparison between OS: -| OS | Real time data | MQTT integration | Running in background | -|:-:|:-:|:-:|:-:| -|iOS|☑️|☑️|| -|Android|☑️|☑️|☑️ *experimental*| +| OS | Real time data | MQTT integration | Running in background | Home Assistant Auto Discovery | +|:-:|:-:|:-:|:-:|:-:| +|iOS|☑️|☑️||☑️| +|Android|☑️|☑️|☑️ *experimental*|☑️| ## iOS @@ -79,6 +79,14 @@ Android has drastically reduced the capabilities of apps to run in the backgroun You may also have more regular results when the device is charging. ::: +## Home Assistant Auto Discovery + +Theengs app can publish your sensor definition following Home Assistant MQTT convention, so as to do this you need to activate “Enable discovery” into your MQTT Options and follow the steps below: + +![location](./../img/Theengs_app_auto_discovery_BLE_Sensor_Home_Assistant.gif) + +The sensor definition will be publish when the app connect to the broker. You can retrigger the publication by deactivating and reactivating the MQTT integration from the application. + ## Linux ('live mode' and 'historical data') While reading Flower Care and RoPot historical entry count, the sensors usually freeze for up to a second, and the Linux kernel consider that to be a connection timeout.