From c06a6c9ceb889ab8f6abf988e17822c6d37586b1 Mon Sep 17 00:00:00 2001 From: Florian <1technophile@users.noreply.github.com> Date: Sun, 18 Jul 2021 14:18:40 -0500 Subject: [PATCH] [DOCS] Add new devices, parameters and LORA tutorial (#1028) * Add new devices and parameters * Update readme and lora use --- docs/README.md | 12 ++++++++---- docs/use/ble.md | 4 +++- docs/use/lora.md | 4 ++++ 3 files changed, 15 insertions(+), 5 deletions(-) diff --git a/docs/README.md b/docs/README.md index b706b33..9953d3e 100644 --- a/docs/README.md +++ b/docs/README.md @@ -12,14 +12,16 @@ With MQTT you can connect the compatible software you want, integrating in home # Use cases With OpenMQTTGateway and a controller you can for example: -* 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, +* Monitor a garden with a Mi Flora BLE 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 BLE sensor, * 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 -* Detect water leakage or smoke +* Detect opened door or windows through 433mhz or BLE and alert yourself when leaving +* Detect water leakage or smoke remotely * Actionate a siren if something is going wrong +* Detect if your far mailbox has been opened by the postman with LORA +* Make smart your old TV or AC system through infrared control The limit is your imagination 😀 @@ -31,6 +33,8 @@ Behind the scene you will find functionalities dedicated to gateways like: * Signal forward/repeat * First configuration with web portal * Whitelist & Blacklist management +* Secure connections +* Over the air updates ::: warning Note The material and information contained in this documentation is for general information purposes only. You should not rely upon the material or information on this documentation as a basis for making any business, legal or any other decisions. There is no warranty given on this documentation content. If you decide to follow the information and materials given it is at your own risk. I will not be liable for any false, inaccurate, inappropriate or incomplete information presented on this website. diff --git a/docs/use/ble.md b/docs/use/ble.md index 60ee8da..583658f 100644 --- a/docs/use/ble.md +++ b/docs/use/ble.md @@ -32,7 +32,7 @@ Note that you can find apps to simulate beacons and do some tests like [Beacon s IOS version >=10 devices advertise without an extra app a mac address, nevertheless this address [changes randomly](https://github.com/1technophile/OpenMQTTGateway/issues/71) and cannot be used for presence detection. You must install an app to advertise a fixed MAC address. -## Receiving signals Mi Flora/ Mi jia device/ LYWDS02, ClearGrass or Mi scale +## Receiving signals from BLE devices Mi Flora, Mi jia, LYWDS02, LYWSD03MMC, ClearGrass, Mi scale and [many more](https://compatible.openmqttgateway.com/index.php/devices/ble-devices/) So as to receive BLE sensors data you need either a simple ESP32 either an ESP8266/arduino + HM10/11 with firmware >= v601 The mi flora supported firmware is >3.1.8 @@ -52,6 +52,8 @@ Note that the gateway return one or two measurement value each time. The differe * Impedance * Battery * Voltage +* Open +* Presence The infos will appear like this on your MQTT broker: diff --git a/docs/use/lora.md b/docs/use/lora.md index 227c88f..ee45c19 100644 --- a/docs/use/lora.md +++ b/docs/use/lora.md @@ -1,4 +1,8 @@ # LORA gateway + +Tutorial on how to leverage LORA for a mailbox sensor: + + ## Receiving data from LORA signal Subscribe to all the messages with mosquitto or open your MQTT client software: