Docs improvements (#742)

and link to https://compatible.openmqttgateway.com instead off spreadsheet
2020-08-25 05:42:53 -05:00
1 parent 1d7b569c6a
commit 605da549b9
@@ -1,12 +1,12 @@
 # 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)
+You can take a look to the [OpenMQTTGateway compatible website](https://compatible.openmqttgateway.com) to have a view of the [supported boards](https://compatible.openmqttgateway.com/index.php/boards/).

-Moreover it supports also sensors; DHT, HC SR501, ADC, I2C bus, INA226, TSL2561
+Moreover it supports also sensors; DHT, HC SR501, ADC, I2C bus, INA226, TSL2561, BME280, HTU21D
 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.
+Here is some information to find the board suitable for your need, you have the choice between off the shelves boards and DIY setup.

 ## Off the shelves boards
 The boards below doesn't need hardware modification (or a lite one).
@@ -18,6 +18,7 @@ The boards below doesn't need hardware modification (or a lite one).
 |[M5Stack Basic](M5)|![](../img/OpenMQTTgateway_M5_Stack_Board_Display_Text.png)|-|-|X|-|X|X|X|
 |M5Stick|-|-|send|X|-|X|-|X|
 |[M5Stick C](M5)|![](../img/OpenMQTTgateway_M5_StickC_Board_Display_Text.png)|-|send|X|-|X|X|X|
+|[M5Atom](M5)||-|send|X|-|X|X|X|
 |TTGO LORA32|![](../img/OpenMQTTGateway_TTGO32_LORA_Send.jpg)|-|-|-|X|-|-|-|
 |Sonoff RFR3|![](../img/OpenMQTTGateway_boards_sonoff_rfr3.png)|[receiving](https://1technophile.blogspot.com/2019/08/new-sonoff-rfr3-as-433tomqtt-gateway.html)|-|-|-|X|-|-|
 |Sonoff Basic|-|-|-|-|-|X|-|-|
@@ -26,7 +27,7 @@ The boards below doesn't need hardware modification (or a lite one).
 '(*)' *So as to extend the number of RF protocols supported by the Sonoff RF Bridge you can apply an [hardware hack](https://1technophile.blogspot.com/2019/04/sonoff-rf-bridge-pilight-or-how-to.html), this way you will be able to use Pilight or RF2 gateway.*

 ## DIY boards
-The boards below need hardware modifications and electronic/hardware competencies. You have more possibilities of gateways combination compared to off the shelves ones.
+The boards below need hardware [parts](parts.md) and electronic/hardware competencies. You have more possibilities of gateways combination, compared to off the shelves ones.
 |DIY boards|RF|IR|BLE|LORA|GSM|Button|Relay|
 |-|:-:|:-:|:-:|:-:|:-:|:-:|:-:|
 |Arduino UNO|X|X(limited compared to ESP)|-|-|X|X|
@@ -38,7 +39,6 @@ The boards below need hardware modifications and electronic/hardware competencie
 Pilight is only supported on ESP, Arduino UNO handle only 32bits values in our context.
 Setup based on HM10 doesn't support some BLE [devices](devices.md#for-ble-devices).
 :::
-*Note that *

 ![boards](../img/OpenMQTTGateway_boards.png)

@@ -47,7 +47,7 @@ Arduino + ethernet shields enables faster responsiveness of the gateway and a re
 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).
+To have a good overview of the compatibilities per board you can refer to the compatible modules attributes of each [board](https://compatible.openmqttgateway.com/index.php/boards/).

 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.

@@ -12,4 +12,4 @@ OpenMQTTGateway is independant from these projets, you have the liberty of choic
 * [Domoticz](https://www.domoticz.com)
 * [Jeedom](https://www.jeedom.com)
 * [Node Red](https://nodered.org)
-* [FHEM](https://fhem.de)
+* [FHEM](https://fhem.de)
@@ -1,7 +1,9 @@
 # Devices
-**A list of verified compatible devices is maintained [here](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit?usp=sharing).**
+
+You can take a look to the [OpenMQTTGateway compatible website](https://compatible.openmqttgateway.com) to have a view of the [supported devices](https://compatible.openmqttgateway.com/index.php/devices/).

 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 chipsets 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.
@@ -33,14 +35,16 @@ OpenMQTTGateway is able to scan all the BLE devices that advertise their data so
 | XIAOMI Mi Scale v2 *|XMTZC05HM|weight|
 | XIAOMI Mi band * ||steps|

+Exhaustive list [here](https://compatible.openmqttgateway.com/index.php/devices/ble-devices/)
+
 ::: INFO
 (*)Not supported with HM10.
 :::

-![boards](../img/OpenMQTTGateway_devices_ble.png ':size=250%')
+![devices](../img/OpenMQTTGateway_devices_ble.png ':size=250%')

 ## For infrared IR devices 
-the list of supported devices for ESP is [here](https://github.com/crankyoldgit/IRremoteESP8266/blob/master/SupportedProtocols.md), and [here](https://github.com/1technophile/OpenMQTTGateway/blob/6f73160d1421bebf2c1bbc9b8017978ff5b16520/main/config_IR.h#L123) for Arduino boards, as there is also the possibility of using raw and global caché (ESP)  sending possibilities of this gateway is huge!
+The list of supported devices for ESP is [here](https://github.com/crankyoldgit/IRremoteESP8266/blob/master/SupportedProtocols.md), and [here](https://github.com/1technophile/OpenMQTTGateway/blob/6f73160d1421bebf2c1bbc9b8017978ff5b16520/main/config_IR.h#L123) for Arduino boards, as there is also the possibility of using raw and global caché (ESP)  sending 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.
+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.
@@ -0,0 +1,20 @@
+# Parts
+Depending on the gateway you would like to setup and your board, you may need extra parts/module to add.
+
+You can take a look to the [OpenMQTTGateway compatible website](https://compatible.openmqttgateway.com) to have a view of the [supported parts](https://compatible.openmqttgateway.com/index.php/parts/).
+
+Here is below the main parts reference.
+
+## Main parts 
+|Parts|RF|IR|BLE|LORA|GSM|
+|-|:-:|:-:|:-:|:-:|:-:|
+|SRX882 / STX882|X|-||-|-|
+|CC1101|X|-|-|-|-|
+|HM10|-|-|X|-|-|
+|38KHz IR emitter and receiver|-|X|-|-|-|
+|SX1276|-|-|-|X|-|
+|A6/A7|-|-|-|-|X|
+
+::: INFO
+There is a wide range of parts available that may be compatible with OpenMQTTGateway, the ones [listed](https://compatible.openmqttgateway.com/index.php/parts/) are the ones tested and for which you can ask for support. Indeed for other parts we may not have it so as to reproduce the issue, or in the worst case they may not be compatible.
+:::