From 9c96526d92af3dbbc9b7e3e05fcf0048a9083e36 Mon Sep 17 00:00:00 2001 From: Florian <1technophile@users.noreply.github.com> Date: Sat, 2 Dec 2017 14:23:07 +0100 Subject: [PATCH] Update README.md --- docs/README.md | 44 +++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 43 insertions(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 9daeafb..7159fc7 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1 +1,43 @@ -test +[![Build Status](https://travis-ci.org/1technophile/OpenMQTTGateway.svg?branch=master)](https://travis-ci.org/1technophile/OpenMQTTGateway) +[![Gitter chat](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/OpenMQTTGateway/Questions_support) +[![Codacy Badge](https://api.codacy.com/project/badge/Grade/943c9b639b68441dae8e29ee39977ab2)](https://www.codacy.com/app/1technophile/OpenMQTTGateway?utm_source=github.com&utm_medium=referral&utm_content=1technophile/OpenMQTTGateway&utm_campaign=badger) +[![GitLicense](https://gitlicense.com/badge/1technophile/OpenMQTTGateway)](https://gitlicense.com/license/1technophile/OpenMQTTGateway) + +Questions, support please don't open an issue and [click here](https://gitter.im/OpenMQTTGateway/Questions_support) + +# OpenMQTTGateway +[![](https://github.com/1technophile/OpenMQTTGateway/blob/master/img/OpenMQTTGateway.jpg)](https://github.com/1technophile/OpenMQTTGateway/wiki) + +## Overview + +OpenMQTTGateway act as a WIFI or Ethernet gateway between your 433mhz/315mhz/Infrared signal and a MQTT broker. It is compatible with: +Arduino uno(limited)/mega(advised) + W5100 +ESP8266: NodeMCU V1.0 NodeMCU V2.0, NodeMCU V3.0, ESP8266 12F and 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 RFM69 signals corresponding to received MQTT data (MQTT->RFM69) +* Publish MQTT data related to a received RFM69 signal (RFM69-->MQTT) +* Send IR signal corresponding to received MQTT data (MQTT->IR) +* Publish MQTT data related to received IR signal (IR-->MQTT) +* Publish MQTT data related to BLE beacons or Mi flora(BT-->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 broker during a defined time `time_avoid_duplicate`. +* BLE beacons detection, the gateway publish the beacons detected thanks to an HM-10 module and publish the signal strength of each module address. By this way you can easily address presence detection of people, animals or things. +* 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 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 boards compatibility, the gateway has been currently tested with **ESP8266 12F**, **NodeMCU V1**, **NodeMCU V2**, **Wemos D1 mini**, **Arduino Uno** and the **Arduino Mega**. +* Multi protocols handling, the gateway is based on RCSwitch, NewRemoteSwitch, RFM69 and IRRemote libraries, you can define the protocol you want to use by specifying it inside the topic. + +See the [wiki](https://github.com/1technophile/OpenMQTTGateway/wiki) for more information: +https://github.com/1technophile/OpenMQTTGateway/wiki + +A list of supported 433mhz devices is available [here](https://community.home-assistant.io/t/433tomqttto433-gateway-device-list/7819): +https://community.home-assistant.io/t/433tomqttto433-gateway-device-list/7819 +