Skip to content

Commit 1be59fa

Browse files
authored
[DOCS] Live BBQ monitoring and readme update (#96)
1 parent c099f1d commit 1be59fa

File tree

7 files changed

+94
-22
lines changed

7 files changed

+94
-22
lines changed

docs/README.md

Lines changed: 31 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,36 +3,51 @@ title: Theengs BLE mobile application
33
---
44
# Theengs BLE mobile application
55

6-
**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).
7-
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.
6+
## 🌟 Local Smart Sensor Integration 🌟
87

9-
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.
10-
11-
The app uses the bluetooth component of your Phone/Tablet to read the sensor data.
8+
Theengs App seamlessly reads a wide array of Bluetooth Low Energy (BLE) sensors, gathering real-time data on environmental parameters such as temperature, humidity, moisture, etc. It displays these readings intuitively and enables integration with your Smart Home setup via MQTT. Compatible with platforms like Home Assistant, Theengs App is a vendor-agnostic reader of [your sensors](https://decoder.theengs.io/devices/devices.html).
129

1310
![Iot](./img/Theengs-app-home-reduced-1280.png)
1411

15-
**Theengs app** can be used as a standalone solution or as a complementary solution to [OpenMQTTGateway](https://docs.openmqttgateway.com/) and/or [Theengs gateway](https://gateway.theengs.io) if you want a continuously running gateway.
12+
## 🔥 Elevate Your Grilling Game
13+
14+
Theengs App now offers a dedicated live monitoring feature for BBQ enthusiasts. Track your cooking with a dynamic chart that displays temperature trends in real time. Set personalized thresholds for different cooking stages and receive instant notifications based on these criteria. Whether you prefer your meat rare, medium, or well-done, Theengs App ensures your grilling is done to perfection.
15+
16+
<div style="text-align:center">
17+
18+
![live bbq monitoring](./img/Theengs-app-live.png)
1619

17-
The app will retrieve data from BLE sensors from Govee, Xiaomi, Inkbird, QingPing, ThermoBeacon, ClearGrass, Blue Maestro and many more.
20+
</div>
1821

19-
For more information view the [documentation](https://app.theengs.io/)
22+
## 🔒Respecting Your Privacy
23+
With Theengs App, your data stays local by default. For more details, please refer to our [privacy policy](https://app.theengs.io/use/privacy.html).
2024

25+
## 🏡 Take control with Smart Home Integration
26+
Theengs App syncs with platforms like Home Assistant via MQTT. Record sensor data on your preferred server - your home, your choice.
27+
28+
## Choose Your Platform and Download Now
29+
30+
<br>
31+
</br>
2132
<center><a href="https://apps.apple.com/us/app/theengs-ble/id6443457651?itsct=apps_box_badge&amp;itscg=30200" style="display: inline-block; overflow: hidden; border-radius: 13px; width: 250px; height: 83px;"><img src="https://tools.applemediaservices.com/api/badges/download-on-the-app-store/black/en-us?size=250x83&amp;releaseDate=1667088000&h=c822551038086181cfac2a32c96cd47e" alt="Download on the App Store" style="border-radius: 13px; width: 250px; height: 83px;"></a></center>
2233

2334
<center><a href='https://play.google.com/store/apps/details?id=com.theengs.app&pcampaignid=pcampaignidMKT-Other-global-all-co-prtnr-py-PartBadge-Mar2515-1'><img alt='Get it on Google Play' src='https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png' width=300px/></a></center>
2435

2536
::: tip Note
26-
Theengs app read data "broadcasted" by the devices and does not connect to them, only the Mi Flora and ThermoBeacon historical data are retrieved through a connection. For the rest of the devices the data is read real time when the device emit it.
37+
The Theengs app reads data that is 'broadcasted' by devices, operating primarily in a passive mode without direct connections, except for Mi Flora and ThermoBeacon, where historical data is accessed through a connection. For all other devices, the app captures data as it is emitted by the sensors.
38+
39+
BBQ Live monitoring and notifications require the app to be active on the sensor screen.
2740
:::
2841

29-
Features comparison between OS:
30-
| OS | Real time data | MQTT integration | Running in background | Home Assistant Auto Discovery |
31-
|:-:|:-:|:-:|:-:|:-:|
32-
|iOS|☑️|☑️||☑️|
33-
|Android|☑️|☑️|☑️ *experimental*|☑️|
42+
## Features comparison between Operating Systems
43+
| OS | Real time data | BBQ monitoring |MQTT integration | Running in background | Home Assistant Auto Discovery |
44+
|:-:|:-:|:-:|:-:|:-:|:-:|
45+
|iOS|☑️|☑️|☑️||☑️|
46+
|Android|☑️|☑️|☑️|☑️ *experimental*|☑️|
47+
48+
**Theengs app** can be used as a standalone solution or as a complementary solution to [OpenMQTTGateway](https://docs.openmqttgateway.com/) and/or [Theengs gateway](https://gateway.theengs.io) if you want a continuously running gateway.
3449

35-
#### Third party projects used by Theengs app
50+
## Third party projects used by Theengs app
3651

3752
* [Qt](https://www.qt.io) ([LGPL 3](https://www.gnu.org/licenses/lgpl-3.0.txt))
3853
* [QtMqtt](https://www.qt.io) ([GPL 3](https://www.gnu.org/licenses/gpl-3.0.txt))
@@ -53,5 +68,5 @@ All product and company names are trademarks or registered trademarks of their r
5368
:::
5469

5570
::: slot footer
56-
[GPLv3 Licensed](https://github.com/theengs/home/blob/main/LICENSE) | Copyright © 2022-present Theengs
71+
[GPLv3 Licensed](https://github.com/theengs/home/blob/main/LICENSE) | Copyright © 2024 Theengs
5772
:::
55.1 KB
Loading

docs/img/Theengs-app-live.png

156 KB
Loading
Loading
30.5 KB
Loading

docs/prerequisites/devices.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ pageClass: table-generated-page
33
---
44
# Devices supported
55

6-
Here is the list of supported devices by the app, more details in the Compatible section of the top nav bar.
6+
Here is the list of supported devices by the app, more details in the Compatible Devices section of the top nav bar.
77

88
|Model_Id|Mobile App|
99
|-|-|
@@ -41,6 +41,8 @@ Here is the list of supported devices by the app, more details in the Compatible
4141
|IBT_4X(S/C)||
4242
|IBT_6X(S)||
4343
|JQJCY01YM||
44+
|K6P||
45+
|K9||
4446
|LYWSD02||
4547
|LYWSD03MMC_ATC/PVVX||
4648
|MJWSD05MMC_ATC/PVVX||
@@ -57,6 +59,10 @@ Here is the list of supported devices by the app, more details in the Compatible
5759
|W110150X||
5860
|THX1(W230150X)||
5961
|SDLS||
62+
|SE_MAG||
63+
|SE_RHT||
64+
|SE_TEMP||
65+
|SE_TPROBE||
6066
|SHT4X||
6167
|SOLIS_6||
6268
|T201||

docs/use/use.md

Lines changed: 56 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Use
22

3-
## Features comparison between OS
4-
| OS | Real time data | MQTT integration | Running in background | Home Assistant Auto Discovery |
5-
|:-:|:-:|:-:|:-:|:-:|
6-
|iOS|☑️|☑️||☑️|
7-
|Android|☑️|☑️|☑️ *experimental*|☑️|
3+
## Features comparison between Operating Systems
4+
| OS | Real time data | BBQ monitoring |MQTT integration | Running in background | Home Assistant Auto Discovery |
5+
|:-:|:-:|:-:|:-:|:-:|:-:|
6+
|iOS|☑️|☑️|☑️||☑️|
7+
|Android|☑️|☑️|☑️|☑️ *experimental*|☑️|
88

99
## Overview
1010

@@ -24,6 +24,57 @@ Why does Theengs App needs the location permission?
2424
Theengs App requires the location permission to access your device Bluetooth and retrieves sensor data. Theengs is not accessing your location with GPS/GLONASS/BAIDU.
2525
:::
2626

27+
## Live BBQ monitoring
28+
29+
### Introduction
30+
Live BBQ Monitoring allows you to track the temperature of your grill in real time, ensuring perfect cooking results. The feature includes different Threshold Settings, a Live Chart, and Notifications for comprehensive monitoring.
31+
This feature requires staying on the BBQ sensor screen to function effectively.
32+
33+
### Compatible devices
34+
This feature is compatible with the following devices:
35+
* Govee H5055
36+
* Inkbird IBT-2X(S)
37+
* Inkbird IBT-4X(S/C)
38+
* Inkbird IBT-6X(S)
39+
* SOLIS_6
40+
41+
### Threshold settings
42+
43+
Access the threshold settings from the hamburger menu.
44+
45+
![Threshold settings](./../img/Theengs-app-threshold-settings.png)
46+
47+
Select '+' to customize temperature ranges for different meats or cooking stages.
48+
49+
![Threshold settings choice](./../img/Theengs-app-threshold-settings-default.png)
50+
51+
Name your preset for easy identification, e.g., 'Poultry', 'Rare Steak'.
52+
Enter your desired temperature range. You can modify these presets anytime.
53+
54+
From the BBQ sensor view you can select the presets of your choice.
55+
56+
::: warning Warning
57+
The cooking temperatures provided in this app are general recommendations. Variations in equipment, ingredients, and conditions can affect cooking outcomes.
58+
Always verify food is cooked to safe temperatures.
59+
The application developer is not liable for any cooking results.
60+
:::
61+
62+
### Live monitoring
63+
The Live Chart displays live temperature data from your BBQ sensor.
64+
To view, tap on your BBQ device from the main screen.
65+
The chart shows temperature changes over time, helping you monitor the cooking process.
66+
67+
![Live monitoring](./../img/Theengs-app-live-monitoring.png)
68+
69+
### Notifications
70+
Enable notifications when prompted. Your phone must not be in silent or do not disturb mode.
71+
Set temperature thresholds based on your meal. When the sensor detects temperatures beyond this range, you'll receive an alert.
72+
73+
::: tip Note
74+
For continuous monitoring and notifications, you must keep the app open on the BBQ sensor screen.
75+
Update frequency and real-time responsiveness depend on your smartphone’s processing capabilities, not the app. For best results, close unnecessary apps and ensure you are not far from the sensor.
76+
:::
77+
2778
## MQTT integration
2879

2980
Prerequisites:

0 commit comments

Comments
 (0)