diff --git a/README.md b/README.md index 6f1cc9c..36aeb27 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,10 @@ ![Build](https://github.com/1technophile/OpenMQTTGateway/workflows/Build/badge.svg?branch=development) ![Check Code Format](https://github.com/1technophile/OpenMQTTGateway/workflows/Check%20Code%20Format/badge.svg?branch=development) -[![Percentage of issues still open](http://isitmaintained.com/badge/open/1technophile/openmqttgateway.svg)](http://isitmaintained.com/project/1technophile/openmqttgateway "Percentage of issues still open") [![OpenMQTTGateway capabilities](https://github.com/1technophile/OpenMQTTGateway/blob/development/docs/img/OpenMQTTGateway.png)](https://community.openmqttgateway.com) -OpenMQTTGateway project goal is to concentrate in one firmware different technologies and protocols, decreasing by the way the number of physical bridges needed, and hiding the different technologies singularity behind a simple & wide spread communication protocol; MQTT. +OpenMQTTGateway aims to unify various technologies and protocols into a single firmware. This reduces the need for multiple physical bridges and streamlines diverse technologies under the widely-used [MQTT](http://mqtt.org/) protocol. ## Sponsors diff --git a/docs/README.md b/docs/README.md index 9698293..6111417 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,9 +1,22 @@ -OpenMQTTGateway project goal is to concentrate in one firmware different technologies and protocols, decreasing by the way the number of physical bridges needed, and hiding the different technologies singularity behind a simple & wide spread communication protocol; [MQTT](http://mqtt.org/). +OpenMQTTGateway aims to unify various technologies and protocols into a single firmware. This reduces the need for multiple physical bridges and streamlines diverse technologies under the widely-used [MQTT](http://mqtt.org/) protocol. ![Overview](./img/OpenMQTTGateway.png) -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. +# What is an MQTT Gateway or Bridge ? + +MQTT, short for Message Queuing Telemetry Transport, is a lightweight messaging protocol ideal for IoT devices. + +An MQTT Gateway or Bridge plays a pivotal role in the MQTT ecosystem: +* Protocol Translation: It converts non-MQTT protocols (like Zigbee or Bluetooth) into MQTT, enabling broader network communication. +* Data Aggregation: Combines data from multiple devices into single messages, optimizing network use. +* Security: Incorporates features like SSL/TLS encryption to safeguard data during transmission. +* Device Management: Handles tasks like firmware updates and remote configuration changes. + +In essence, an MQTT Gateway ensures smooth communication between devices and MQTT brokers, enhancing the efficiency and security of IoT systems. + +# What OpenMQTTGateway can do ? + +OpenMQTTGateway integrates with established technologies, such as 433mhz/315mhz protocols and infrared (IR), allowing you to upgrade and repurpose older devices. Additionally, OMG is compatible with modern technologies like Bluetooth Low Energy (BLE) and LORA. 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) @@ -11,10 +24,10 @@ To have an overview of the supported PIR, door, water, temperature, smoke sensor You can run OpenMQTTGateway on a wide variety of [boards](https://compatible.openmqttgateway.com/index.php/boards/), ESP32, ESP8266, Arduino MEGA, UNO (with limitation). BLE to MQTT gateway can also run on Raspberry Pi, Windows or Unix computers thanks to [Theengs Gateway](https://theengs.github.io/gateway/). -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. +Using MQTT, you can seamlessly integrate with home automation platforms such as OpenHAB, Home Assistant, and others, or with IoT software like Node-Red. # Use cases -With OpenMQTTGateway and a controller you can for example: +Leveraging OpenMQTTGateway with a controller allows you to: * 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/LYWSD03MMC BLE sensor, * Follow your meat temperature when cooking with an Inkbird IBBQ @@ -31,15 +44,17 @@ With OpenMQTTGateway and a controller you can for example: The limit is your imagination 😀 # Functions -Behind the scene you will find functionalities dedicated to gateways like: +Under the hood, OpenMQTTGateway offers features such as: * Deduplication * Simple and lite API * Strong integrations with libraries used * Signal forward/repeat -* First configuration with web portal +* Wifi web portal onboarding +* Web portal configuration * Whitelist & Blacklist management * Secure connections * Over the air updates +* Local or cloud, your choice ## The first plug-and-play OpenMQTTGateway BLE gateway and Smart Plug !