Docs vuepress (#476)

Convert docs to vuepress
This commit is contained in:
Florian authored and GitHub committed 2019-10-30 22:15:40 +01:00
1 parent 1fa5d48e74
commit aa263dc559
114 files changed
+1739 -64

No files matched your search

+37
View File
@@ -0,0 +1,37 @@
# Board
OpenMQTTGateway is not closed to one board or type of board, by using the power of the Arduino framework and libraries that are cross compatibles it let you many choice of hardware, from an Arduino UNO to an ESP32.
You can take a look to the components sheet to have a view of [supported boards and components](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=1323184277)
Moreover it supports also sensors; DHT, HC SR501, ADC, I2C bus, INA226, TSL2561
Or can actutate things (LED chipsets, relays).
Here is some information to find the board suitable for your need, you have the choice between wifi, ethernet and off the shelves devices:
Off the shelves wifi
* SONOFF RF Bridge
* Sonoff RFR3
* Sonoff Basic
* Wifi RF Gateway
![boards](../img/OpenMQTTGateway_boards_sonoff.png)
Wifi/Ethernet:
* ESP8266
* ESP32
* Arduino Mega with an ethernet shield
* Arduino Uno with an ethernet shield
![boards](../img/OpenMQTTGateway_boards.png)
Arduino + ethernet shields enables faster responsiveness of the gateway and a reliable connection.
The ESP platform is more flexible in term of installation (no need of an ethernet cable) but is less reliable in term of communication. Thanks to its higher memory and processing power it has more modules or possibilities compared to arduino Uno & Mega.
Choosing your board depends heavily on the technologies you want to use with it.
To have a good overview of the compatibilities per board you can refer to [this sheet](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=1098440301).
The choice between these boards will depend on your knowledge and your requirements in terms of reliability, situation, modules wanted and devices you already have.
+20
View File
@@ -0,0 +1,20 @@
# Broker
The broker will act as an intermediary between OpenMQTTGateway and your [controller](/prerequisites/controller), it can be seen as a centralized hub at the heart of your automation system. It carry on messages following a publish / subscribe mechanism.
All the events or commands could pass by the broker.
There is many choice of brokers, here is some of the most populars:
* [Mosquitto](https://mosquitto.org/) (Open source)
* [Moquette](https://moquette-io.github.io/moquette/) (Open source)
* [HiveMQ](https://www.hivemq.com/hivemq/features/)
* Embedded MQTT brokers (Home Assistant and OpenHAB)
This [wikipedia list](https://en.wikipedia.org/wiki/Comparison_of_MQTT_implementations) gives you more details about the different choices you have.
This [github list](https://github.com/mqtt/mqtt.github.io/wiki/libraries) seems to be the most exhaustive ones.
Here is also some [idea of criterias](https://www.hivemq.com/blog/top-10-mqtt-broker-criteria/) from HiveMQ.
Once your broker installed it can be interesting to see the traffic passing to it and to publish data, so as to do that there is several tools available:
* [MQTT Explorer](http://mqtt-explorer.com/)
* [HIVE MQ Web client](https://github.com/hivemq/hivemq-mqtt-web-client)
* [MQTT FX](https://mqttfx.jensd.de/)
+15
View File
@@ -0,0 +1,15 @@
# Controller
MQTT enables you to connect easily a controller so as to monitor, control and automate scenarios.
The following controllers (and many other software) are compatible with MQTT:
![controllers](../img/OpenMQTTGateway_controllers.png)
OpenMQTTGateway is independant from these projets, you have the liberty of choice among all the compatibles software.
* [OpenHAB2](https://www.openhab.org)
* [Home Assistant](https://www.home-assistant.io)
* [Domoticz](https://www.domoticz.com)
* [Jeedom](https://www.jeedom.com)
* [Node Red](https://nodered.org)
* [FHEM](https://fhem.de)
+22
View File
@@ -0,0 +1,22 @@
# Devices
A list of verified compatible devices is maintained [here](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit?usp=sharing).
Added to that is an overview of devices supported by OpenMQTTGateway:
* For radio frequency devices OpenMQTTGateway can support a wide range of 433mhz/315mhz devices, all the ones with SC5262 / SC5272, HX2262 / HX2272, PT2262 / PT2272, EV1527, RT1527, FP1527, HS1527 chipset are supported by the RF gateway. Added to that RF2 support Kaku and Pilight an [huge list](https://wiki.pilight.org/devices). Note that for the moment RF, RF2 and Pilight can not be activated on the same boards together.
![boards](../img/OpenMQTTGateway_devices_rf1.png ':size=250%')
![boards](../img/OpenMQTTGateway_devices_rf2.png ':size=250%')
![boards](../img/OpenMQTTGateway_devices_rf3.png ':size=250%')
* For BLE devices OpenMQTTGateway is able to scan all the BLE devices that advertise their data so as to do presence detection. Added to that it reads values coming from :
** Mi Flora (temperature/moisture/luminance/fertility)
** Mi Jia (temperature/humidity)
** Clear Grass (temperature/humidity)
** LYWDS02 Clock (temperature/humidity)
** Mi Scale (weight)
![boards](../img/OpenMQTTGateway_devices_ble.png ':size=250%')
* For infrared IR devices the list of supported brand is [here](https://github.com/1technophile/OpenMQTTGateway/blob/d2dd6138558909b71cc44f69665340247bd5f356/main/config_IR.h#L52), as there is also the possibility of using raw and global caché sending the possibilities of this gateway is huge!
* LORA is more dedicated at this moment for tinkering and DIY and there is no Off the shelves devices compatible to my knowledge with this gateway.