Skip to content

Commit

Permalink
[DOCS] Live BBQ monitoring and readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
1technophile committed Jan 18, 2024
1 parent c099f1d commit c4763c7
Show file tree
Hide file tree
Showing 7 changed files with 94 additions and 22 deletions.
47 changes: 31 additions & 16 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,36 +3,51 @@ title: Theengs BLE mobile application
---
# Theengs BLE mobile application

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

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.
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).

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

**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.
## 🔥 Elevate Your Grilling Game

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.

<div style="text-align:center">

![live bbq monitoring](./img/Theengs-app-live.png)

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

For more information view the [documentation](https://app.theengs.io/)
## 🔒Respecting Your Privacy
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).

## 🏡 Take control with Smart Home Integration
Theengs App syncs with platforms like Home Assistant via MQTT. Record sensor data on your preferred server - your home, your choice.

## Choose Your Platform and Download Now

<br>
</br>
<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>

<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>

::: tip Note
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.
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.

BBQ Live monitoring and notifications require the app to be active on the sensor screen.
:::

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

**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.

#### Third party projects used by Theengs app
## Third party projects used by Theengs app

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

::: slot footer
[GPLv3 Licensed](https://github.com/theengs/home/blob/main/LICENSE) | Copyright © 2022-present Theengs
[GPLv3 Licensed](https://github.com/theengs/home/blob/main/LICENSE) | Copyright © 2024 Theengs
:::
Binary file added docs/img/Theengs-app-live-monitoring.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/Theengs-app-live.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/Theengs-app-threshold-settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 7 additions & 1 deletion docs/prerequisites/devices.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ pageClass: table-generated-page
---
# Devices supported

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

|Model_Id|Mobile App|
|-|-|
Expand Down Expand Up @@ -41,6 +41,8 @@ Here is the list of supported devices by the app, more details in the Compatible
|IBT_4X(S/C)||
|IBT_6X(S)||
|JQJCY01YM||
|K6P||
|K9||
|LYWSD02||
|LYWSD03MMC_ATC/PVVX||
|MJWSD05MMC_ATC/PVVX||
Expand All @@ -57,6 +59,10 @@ Here is the list of supported devices by the app, more details in the Compatible
|W110150X||
|THX1(W230150X)||
|SDLS||
|SE_MAG||
|SE_RHT||
|SE_TEMP||
|SE_TPROBE||
|SHT4X||
|SOLIS_6||
|T201||
Expand Down
61 changes: 56 additions & 5 deletions docs/use/use.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Use

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

## Overview

Expand All @@ -24,6 +24,57 @@ Why does Theengs App needs the location permission?
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.
:::

## Live BBQ monitoring

### Introduction
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.
This feature requires staying on the BBQ sensor screen to function effectively.

### Compatible devices
This feature is compatible with the following devices:
* Govee H5055
* Inkbird IBT-2X(S)
* Inkbird IBT-4X(S/C)
* Inkbird IBT-6X(S)
* SOLIS_6

### Threshold settings

Access the threshold settings from the hamburger menu.

![Threshold settings](./../img/Theengs-app-threshold-settings.png)

Select '+' to customize temperature ranges for different meats or cooking stages.

![Threshold settings choice](./../img/Theengs-app-threshold-settings-default.png)

Name your preset for easy identification, e.g., 'Poultry', 'Rare Steak'.
Enter your desired temperature range. You can modify these presets anytime.

From the BBQ sensor view you can select the presets of your choice.

::: warning Warning
The cooking temperatures provided in this app are general recommendations. Variations in equipment, ingredients, and conditions can affect cooking outcomes.
Always verify food is cooked to safe temperatures.
The application developer is not liable for any cooking results.
:::

### Live monitoring
The Live Chart displays live temperature data from your BBQ sensor.
To view, tap on your BBQ device from the main screen.
The chart shows temperature changes over time, helping you monitor the cooking process.

![Live monitoring](./../img/Theengs-app-live-monitoring.png)

### Notifications
Enable notifications when prompted. Your phone must not be in silent or do not disturb mode.
Set temperature thresholds based on your meal. When the sensor detects temperatures beyond this range, you'll receive an alert.

::: tip Note
For continuous monitoring and notifications, you must keep the app open on the BBQ sensor screen.
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.
:::

## MQTT integration

Prerequisites:
Expand Down

0 comments on commit c4763c7

Please sign in to comment.