From 0e71262245f45d60e3ac2a8102f5251b862bf207 Mon Sep 17 00:00:00 2001 From: Florian <1technophile@users.noreply.github.com> Date: Tue, 11 Apr 2017 23:01:32 +0200 Subject: [PATCH 1/3] Update README.md --- README.md | 27 +++++++++++++++++++++++---- 1 file changed, 23 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 131c4de..d8f645c 100644 --- a/README.md +++ b/README.md @@ -5,10 +5,29 @@ https://github.com/1technophile/OpenMQTTGateway/wiki ![](https://github.com/1technophile/OpenMQTTGateway/blob/master/img/OpenMQTTGateway.jpg) -The gateway can be integrated with home automation systems like Openhab or Home assistant thanks to the MQTT protocol. - A list of supported 433mhz devices is available here: https://community.home-assistant.io/t/433tomqttto433-gateway-device-list/7819 -examples_with_gpio_usage/433toMQTTto433nFan_ESP8266 - ESP8266 gateway between 433mhz and a fan's remote control, from MQTT to the fan only. -Tutorial is here https://github.com/rickybrent/433toMQTTto433_ESP8266/wiki/Flower-Angel-18R-ST6 +# Overview + +OpenMQTTGateway act as a wifi or ethernet gateway between your 433mhz/infrared IR signal and a MQTT broker. It is compatible with : +Arduino boards + W5100 +ESP8266: nodemcu V1.0, nodemcu V3.0, Wemos D1 + + It enables to: +* Send RF signals corresponding to received MQTT data (MQTT->RF) +* Publish MQTT data related to a received 433Mhz signal (RF-->MQTT) +* Send IR signal corresponding to received MQTT data (MQTT->IR) +* Publish MQTT data related to received IR signal (IR-->MQTT) + +You can add extra sensors directly to the gateway if you like! + +Functions: +* Bidirectional, the gateway can send and receive signals, for example if you have RF wall plug you can either control them with your home automation software (MQTT-->RF) or the physical remote control. When you press a button on the physical remote the wall plug will switch ON and the button in your home automation software (RF-->MQTT) will be updated. +* Signal duplicate removal, with RF of IR we get a lot of duplication, to avoid this the gateway is able to filter the number of code sent to the MQTT borker during a defined time “time_avoid_duplicate” +* Addons possibility, you could add directly to the gateway any sensor you want, just create a new Z .ino file into the gateway folder with your code and call it after client.loop(); into OpenMQTTGateway.ino. The program is provided with a DHT sensor addon implementation (ZaddonDHT.ino) +* Advanced signal details publication, so as to know the details of what the gateway receive it publish to subject433toMQTTAdvanced for RF and subjectIRtoMQTTAdvanced for IR the details of the signal received (this signal has to be compatible with RCSwitch and IRRemote libraries to be read). +* Acknowledgement, to be sure that the gateway received the payload from MQTT it sends an acknowledgement on a user_defined topic "subjectGTWRFtoMQTT" for RF or "subjectGTWIRtoMQTT" for IR enabling to update the state of your switch or other component into your home automation +* Multi platforms compatibility, the gateway has been currently tested ok with ESP8266 12F, NodeMCU V1, NodeMCU V2, Wemos D1 mini, Arduino Uno, Arduino Mega +* Multi protocols handling, the gateway is based on RCSwitch and IRRemote libraries, you can define the protocol you want to use by specifying it inside the topic. + From b5c891d27da12db08232a72fe1aad6092cd01945 Mon Sep 17 00:00:00 2001 From: Florian <1technophile@users.noreply.github.com> Date: Tue, 11 Apr 2017 23:02:23 +0200 Subject: [PATCH 2/3] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index d8f645c..f2c63d1 100644 --- a/README.md +++ b/README.md @@ -31,3 +31,5 @@ Functions: * Multi platforms compatibility, the gateway has been currently tested ok with ESP8266 12F, NodeMCU V1, NodeMCU V2, Wemos D1 mini, Arduino Uno, Arduino Mega * Multi protocols handling, the gateway is based on RCSwitch and IRRemote libraries, you can define the protocol you want to use by specifying it inside the topic. +-examples_with_gpio_usage/433toMQTTto433nFan_ESP8266 - ESP8266 gateway between 433mhz and a fan's remote control, from MQTT to the fan only. + -Tutorial is here https://github.com/rickybrent/433toMQTTto433_ESP8266/wiki/Flower-Angel-18R-ST6 From 568c8f0d3076d1ed71c4d0b4312dd09a2323d90d Mon Sep 17 00:00:00 2001 From: Florian <1technophile@users.noreply.github.com> Date: Tue, 11 Apr 2017 23:03:34 +0200 Subject: [PATCH 3/3] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f2c63d1..d1da923 100644 --- a/README.md +++ b/README.md @@ -26,9 +26,9 @@ Functions: * Bidirectional, the gateway can send and receive signals, for example if you have RF wall plug you can either control them with your home automation software (MQTT-->RF) or the physical remote control. When you press a button on the physical remote the wall plug will switch ON and the button in your home automation software (RF-->MQTT) will be updated. * Signal duplicate removal, with RF of IR we get a lot of duplication, to avoid this the gateway is able to filter the number of code sent to the MQTT borker during a defined time “time_avoid_duplicate” * Addons possibility, you could add directly to the gateway any sensor you want, just create a new Z .ino file into the gateway folder with your code and call it after client.loop(); into OpenMQTTGateway.ino. The program is provided with a DHT sensor addon implementation (ZaddonDHT.ino) -* Advanced signal details publication, so as to know the details of what the gateway receive it publish to subject433toMQTTAdvanced for RF and subjectIRtoMQTTAdvanced for IR the details of the signal received (this signal has to be compatible with RCSwitch and IRRemote libraries to be read). +* Advanced signal details publication, so as to know the details of what the gateway receive it publish by MQTT to subject433toMQTTAdvanced for RF and subjectIRtoMQTTAdvanced for IR the details of the signal received (this signal has to be compatible with RCSwitch and IRRemote libraries to be read). * Acknowledgement, to be sure that the gateway received the payload from MQTT it sends an acknowledgement on a user_defined topic "subjectGTWRFtoMQTT" for RF or "subjectGTWIRtoMQTT" for IR enabling to update the state of your switch or other component into your home automation -* Multi platforms compatibility, the gateway has been currently tested ok with ESP8266 12F, NodeMCU V1, NodeMCU V2, Wemos D1 mini, Arduino Uno, Arduino Mega +* Multi boards compatibility, the gateway has been currently tested ok with ESP8266 12F, NodeMCU V1, NodeMCU V2, Wemos D1 mini, Arduino Uno, Arduino Mega * Multi protocols handling, the gateway is based on RCSwitch and IRRemote libraries, you can define the protocol you want to use by specifying it inside the topic. -examples_with_gpio_usage/433toMQTTto433nFan_ESP8266 - ESP8266 gateway between 433mhz and a fan's remote control, from MQTT to the fan only.