[DOCS] Theengs Plug highlight and SEO improvements (#1730)

* [DOCS] Theengs Plug highlight

* Add alt content for images and description
This commit is contained in:
Florian authored and GitHub committed 2023-08-11 13:04:52 -05:00
1 parent 79a8591b83
commit 7a2bb04a1b
19 files changed
+138 -109

No files matched your search

+26 -10
View File
@@ -1,14 +1,30 @@
---
title: ESP32 BLE MQTT Gateway
description: Versatile BLE gateway that scans and decodes data from various Bluetooth devices. It integrates seamlessly with MQTT brokers and controllers like Home Assistant and OpenHAB. Monitor temperature, humidity, pressure, and more for smarter control.
---
# BLE gateway
The manufacturer agnostic BLE gateway acts as a powerful BLE scanner of devices and decoder, allowing you to visualize and analyze information from a wide range of BLE devices.
It can also act as a presence detection gateway by reading the nearby BLE tags or tracker devices.
The manufacturer agnostic BLE gateway acts as a powerful BLE scanner and decoder of [Bluetooth devices](https://compatible.openmqttgateway.com/index.php/devices/ble-devices/), allowing you to visualize and analyze information from a wide range of sensors.
It can also act as a presence detection gateway by reading the nearby BLE tags or tracker.
Data are transmitted to an MQTT broker, where it can be used to trigger events and rules, as well as displayed, stored and processed in your favorite controller.
Data are transmitted to an MQTT broker, where it can be used to trigger events and rules, as well as displayed, stored and processed in your favorite controller (Home Assistant, OpenHAB, Jeedom, Domoticz, ioBroker or any MQTT compatible software).
With the ability to monitor and analyze data such as temperature, humidity, moisture, luminance, weight, pressure, fine particles, and more, the BLE gateway provides a flexible and customizable solution for integrating BLE technology into your control and monitoring systems.
![](../img/OpenMQTTGateway-sensors-ble.png)
![BLE sensors and devices](../img/OpenMQTTGateway-sensors-ble.png)
## The first plug-and-play OpenMQTTGateway BLE gateway and Smart Plug!
[Theengs plug](https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumption) is available flashed with OpenMQTTGateway, and brings the functions below:
* BLE to MQTT gateway, tens of [Bluetooth devices](https://compatible.openmqttgateway.com/index.php/devices/ble-devices/) supported thanks to Theengs Decoder library. The plug uses an ESP32 acting as a BLE to Wifi gateway to scan, decode and forward the data of the nearby sensors,
* Smart plug that can be controlled remotely,
* Energy consumption monitoring,
* Presence detection (beta).
[![Theengs plug view](../img/Theengs-Plug-OpenMQTTGateway.png)](https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumption)
Support the project by purchasing the [Theengs plug](https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumption)
The plug is available in North America only, other regions are planned.
## Receiving signals from [compatible BLE sensors](https://decoder.theengs.io/devices/devices_by_brand.html) to publish it to an MQTT broker.
To receive data from BLE sensors you can use an ESP32-based device with a programming USB port or use a Serial adapter.
@@ -21,11 +37,11 @@ OpenMQTTGateway is also available preloaded and configured with the [Theengs plu
1. You should see data coming in your broker.
![](../img/OpenMQTTGateway-mqtt-explorer-lywsd03mmc-atc.png)
![LYWSD03MMC MQTT data view](../img/OpenMQTTGateway-mqtt-explorer-lywsd03mmc-atc.png)
Once the data has been transmitted to the MQTT broker, it can be easily integrated with your preferred controller. For example, the data can be automatically discovered and made available within popular controllers, example below with Home Assistant.
![](../img/OpenMQTTGateway-home-assistant-chart.png)
![Home Assistant chart](../img/OpenMQTTGateway-home-assistant-chart.png)
Examples of compatible sensors among [our list](https://decoder.theengs.io/devices/devices_by_brand.html: Mi Flora, Mi jia, LYWDS02, LYWSD03MMC, ClearGrass, Mi scale, iBBQ, TPMS
@@ -35,8 +51,8 @@ To do this activate the "BT: Publish HASS presence" switch in your controller or
`mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{"hasspresence":true}'`
The entity created can be attached to a person to leverage presence detection. The `away` or `not home` state is triggered if the BLE tracker is not detected during the timer defined by `presenceawaytimer`.
![](../img/OpenMQTTGateway-BLE-tracker-Home-Assistant.png)
![Away home Home assistant view](../img/OpenMQTTGateway-BLE-tracker-Home-Assistant.png)
If you have multiple gateways, your BLE trackers may not be detected temporary by one gateway but still by the others. In this case you will see the tracker appears offline briefly and online again once it is detected by the others gateways.
@@ -65,9 +81,9 @@ To ensure proper functionality, configure the beacon using the KBeacon or KBeaco
* In the General tab, set the Trigger Command to "motion".
* In the Slot tab, enable advertisement with the Beacon Type set to "KSensor", the Trigger Only Advertisement option set to "YES", and the Sensor Axis set to "ON".
![](../img/KBeacon-app-configuration-moving.jpg)
![KBeacon trigger settings](../img/KBeacon-app-configuration-moving.jpg)
![](../img/KBeacon-app-configuration-moving2.jpg)
![KBeacon details](../img/KBeacon-app-configuration-moving2.jpg)
## Setting a white or black list
A black list is a list of MAC addresses that will never be published by OMG
+1 -1
View File
@@ -128,7 +128,7 @@ It can be used with version 1.5.0 and above.
Note that this update option is also autodiscovered through Home Assistant convention, you can update directly from the device page with 2 clicks.
![](../img/OpenMQTTGateway-OTA-Update-Home-Assistant.png)
![Home Assistant OTA Update](../img/OpenMQTTGateway-OTA-Update-Home-Assistant.png)
You can also indicate the target version to update:
```
+6 -1
View File
@@ -1,3 +1,8 @@
---
title: Infrared MQTT Gateway
description: Unlock the potential of Infrared technology with our universal gateway. Decode signals from various devices, and integrate seamlessly with MQTT systems abd controllers like Home Assistant and OpenHAB.
---
# IR gateway
There is two methods for finding the IR codes you want to replicate:
1. Point the remote control to an IR receiver see [Receiving data from IR signal](#receiving-data-from-ir-signal) & [Send data by MQTT to convert it on IR signal](#send-data-by-mqtt-to-convert-it-on-ir-signal)
@@ -24,7 +29,7 @@ To receive big dump of raw data you need first to modify the [config_IR.h](https
Unknown protocols are filtered by default, if you want to see the unknown protocols set into [config_IR.h](https://github.com/1technophile/OpenMQTTGateway/blob/master/config_IR.h)
`#define pubIRunknownPrtcl true` instead of false
![](https://github.com/1technophile/OpenMQTTGateway/blob/master/img/OpenMQTTGateway_serial3.jpg)
![IR serial](../img/OpenMQTTGateway_serial3.jpg)
You can take this code and try to reproduce it with the gateway either by using [decimal value](#send-data-by-mqtt-to-convert-it-on-ir-signal) or the [raw value](#send-raw-ir-data-by-mqtt).
+6 -2
View File
@@ -1,3 +1,7 @@
---
title: LORA MQTT Gateway
description: Explore the LORA MQTT gateway, designed for integration with devices utilizing LORA technology, including the MakerFab soil and moisture sensor. Unlock long range communication with the power of LORA..
---
# LORA gateway
Tutorial on how to leverage LORA for a mailbox sensor from [PricelessToolkit](https://www.youtube.com/channel/UCz75N6inuLHXnRC5tqagNLw):
@@ -11,7 +15,7 @@ Subscribe to all the messages with mosquitto or open your MQTT client software:
Generate your LORA signals by using another TTGO LORA module, you can flash the sender program from [this repository](https://github.com/LilyGO/TTGO-LORA32-V2.0) and the SSD1306 library [there](https://github.com/ThingPulse/esp8266-oled-ssd1306)
![](../img/OpenMQTTGateway_TTGO32_LORA_Send.jpg)
![TTGO Lora sending packets](../img/OpenMQTTGateway_TTGO32_LORA_Send.jpg)
Once one board flashed with OMG and the other with the sender program you should receive regular packets into `home/OpenMQTTGateway_ESP32_LORA_TEST/LORAtoMQTT` like below:
@@ -34,7 +38,7 @@ And from a supported device (in this case, a WiPhone), looks like this:
This command will send by LORA the message "hello OMG1" and use the default parameters defined in [config_LORA.h](https://github.com/1technophile/OpenMQTTGateway/blob/4b8d28179b63ae3f3d454da57ec8c109c159c386/config_LORA.h#L32)
![](../img/OpenMQTTGateway_TTGO32_LORA_Receive.jpg)
![TTGO Lora receiving packets](../img/OpenMQTTGateway_TTGO32_LORA_Receive.jpg)
If you want to test that your sending works you can use another TTGO LORA module, you can flash the receiver program from [this repository](https://github.com/LilyGO/TTGO-LORA32-V2.0) and the SSD1306 library [there](https://github.com/ThingPulse/esp8266-oled-ssd1306)
+7 -3
View File
@@ -1,3 +1,7 @@
---
title: 433Mhz MQTT Gateway
description: Unlock the potential of RF 433 MHz technology with our universal gateway. Decode signals from various devices, and integrate seamlessly with MQTT systems and controllers like Home Assistant and OpenHAB.
---
# RF gateways (433mhz/315mhz)
@@ -197,13 +201,13 @@ This command will send by RF the code 1315156 and use the default parameters (pr
Arduino IDE serial data received when publishing data by MQTT
![](../img/OpenMQTTGateway_serial1.jpg)
![Serial data](../img/OpenMQTTGateway_serial1.jpg)
We see that the Arduino receive the value 1315156 on the MQTT subject "MQTTto433" and send the data by RF
Arduino IDE serial data received when receiving data by 433Mhz
![](../img/OpenMQTTGateway_serial2.jpg)
![Serial data 2](../img/OpenMQTTGateway_serial2.jpg)
### Send data by MQTT with advanced RF parameters
@@ -261,7 +265,7 @@ Subscribe to all the messages with mosquitto or open your MQTT client software:
Generate your RF signals by pressing a remote button or other and you will see :
![](../img/OpenMQTTGateway_Pilight_Digoo-DG-R8S.png)
![Digoo DG R8S data](../img/OpenMQTTGateway_Pilight_Digoo-DG-R8S.png)
#### Enabling RAW packet return support
First, you need to compile a binary with `Pilight_rawEnabled true` uncommented in config_RF.h.