Docs improvements/corrections (#1018)

This commit is contained in:
Florian authored and GitHub committed 2021-07-13 17:27:04 -05:00
1 parent e244decbed
commit 7564cf082b
5 files changed
+13 -7

No files matched your search

+6 -6
View File
@@ -5,19 +5,19 @@ OpenMQTTGateway project goal is to concentrate in one gateway different technolo
OpenMQTTGateway supports very mature technologies like basic 433mhz/315mhz protocols & infrared (IR) so you can make your old dumb devices "smart" and avoid throwing them away. These devices also have the advantages of having a lower cost compared to Zwave or more sophisticated protocols.
OMG also supports up to date technologies like Bluetooth Low Energy (BLE) or LORA.
To have an overview of the supported PIR, door, water, smoke sensors, sirens, rings, beacons, switches & weather stations you can take a look to the
To have an overview of the supported PIR, door, water, temperature, smoke sensors, sirens, rings, beacons, switches & weather stations you can take a look to the
[compatible devices list](https://compatible.openmqttgateway.com/index.php/devices)
With MQTT you can connect the compatible software you want, integrating in home automation controllers like (OpenHAB, Home Assistant, Jeedom, FHEM, Domoticz...) or another software like Node-Red.
With MQTT you can connect the compatible software you want, integrating in home automation controllers like (OpenHAB, Home Assistant, Jeedom, FHEM, Domoticz...) or Internet of Things software like Node-Red.
# Use cases
With OpenMQTTGateway and a controller you can for example:
* Monitor your garden with a Mi Flora sensor and control an irrigation valve depending on the soil moisture,
* Monitor a garden with a Mi Flora sensor and control an irrigation valve depending on the soil moisture,
* Trigger a fan depending on the temperature and humidity thanks to a Mi Jia sensor,
* Alert yourself by a controller notification if the temperature of your fridge is too high,
* Detect your beacon/smartwatch so as to trigger a special scenario when you come home,
* Alert yourself by a controller notification if the temperature of a fridge is too high,
* Detect a beacon/smartwatch so as to trigger a special scenario when you come home,
* [Lose weight with the help of a complete log system](https://www.youtube.com/watch?v=noUROhtf0E0&t=18s), video from [@Andreas Spiess](https://www.youtube.com/channel/UCu7_D0o48KbfhpEohoP7YSQ)
* Detect opened door or windows and alert yourself when leaving home
* Detect opened door or windows and alert yourself when leaving
* Detect water leakage or smoke
* Actionate a siren if something is going wrong
Binary file not shown.

After

Width:  |  Height:  |  Size: 211 KiB

+1 -1
View File
@@ -31,7 +31,7 @@ The boards below doesn't need hardware modification (or a lite one).
The boards below need hardware [parts](parts.md) and electronic/hardware competencies. You have more possibilities of gateways combination, compared to off the shelves ones.
|DIY boards|RF|IR|BLE|LORA|GSM|Button|Relay|
|-|:-:|:-:|:-:|:-:|:-:|:-:|:-:|
|Arduino UNO|X|X(limited compared to ESP)|-|-|X|X|
|Arduino UNO|X|X(limited compared to ESP)|-|-|-|X|X|
|Arduino MEGA|X|X(limited compared to ESP)|X|-|-|X|X|
|ESP32|X|X|X|X|not tested|X|X|
|ESP8266|X|X|X|not tested|X|X|X|
+1
View File
@@ -46,6 +46,7 @@ Added to that it retrieves the measures from the devices below. By default the d
| Thermobeacon|WS02|temperature/humidity/volt|
| ATorch Battery Capacity Monitor (c)|DT24|volt/amp/watt|
| Eddystone TLM|protocol|temperature/count/volt/time|
| Ibeacon|protocol|UUID/MFID/Major/Minor/Power|
| Mokosmart (1)|M1|x_axis/y_axis/z_axis/battery|
| Mokosmart (1)|H4|temperature/humidity/volt|
+5
View File
@@ -2,6 +2,11 @@
## Compatible parts
**The ESP32 has an integrated BLE module**, with this board the BLE gateway don't need any additional hardware. Making it the **advised board for BLE**.
You can use a barebone ESP32 or some nice looking products like the ones below (from M5Stack):
![](../img/OpenMQTTgateway_M5_Atom_Board.png)
![](../img/OpenMQTTgateway_M5_Stack_Board_Display_Text.png)
For Arduino and ESP8266 you can use an HM10 or HM11 below.
|Module|Purpose|Where to Buy|
|-|-|-|