chriz/OpenMQTT-Gateway
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 5 Wiki Activity

Docs improvements (#742)

Browse Source 
and link to https://compatible.openmqttgateway.com
instead off spreadsheet
This commit is contained in:
Florian authored and GitHub committed 2020-08-25 05:42:53 -05:00
1 parent 1d7b569c6a
commit 605da549b9
14 files changed
+66 -40
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/.vuepress/config.js
+3 -1
View File
@@ -28,7 +28,8 @@ module.exports = {
{ text: 'Blog', link: 'https://1technophile.blogspot.com'},
{ text: 'Docs', link: '/'},
{ text: 'Community', link: 'https://community.openmqttgateway.com', target:'_self', rel:''},
{ text: 'Devices', link: 'https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=2126158079'}
{ text: 'Devices', link: 'https://compatible.openmqttgateway.com/index.php/devices'},
{ text: 'Boards', link: 'https://compatible.openmqttgateway.com/index.php/boards'}
],
sidebar: [
['/','0 - What is it for 🏠'],
@@ -39,6 +40,7 @@ module.exports = {
children: [
'prerequisites/devices',
'prerequisites/board',
'prerequisites/parts',
'prerequisites/broker',
'prerequisites/controller']
},
docs/README.md
+1 -1
View File
@@ -6,7 +6,7 @@ OpenMQTTGateway support very mature technologies like basic 433mhz/315mhz protoc
OMG support also up to date technologies like Bluetooth Low Energy (BLE) or LORA.
To have an overview of the supported PIR, door, water, smoke sensors, sirens, rings, beacons, switchs & weather stations you can take a look to the
[compatible devices list](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=2126158079)
[compatible devices list](https://compatible.openmqttgateway.com/index.php/devices)
With MQTT you can connect the compatible software you want, it can be an home automation controller (OpenHAB, Home Assistant, Jeedom, FHEM, Domoticz...) or another software like Node-Red.
docs/participate/support.md
+1 -1
View File
@@ -1,6 +1,6 @@
If you like the project and/or used it please consider supporting it! It can be done in different ways:
* Helping other users in the [community](https://community.openmqttgateway.com)
* [Contribute](development) to the [code](https://github.com/1technophile/OpenMQTTGateway) or the [documentation](https://docs.openmqttgateway.com)
* Buy devices or parts from the [devices list](https://docs.google.com/spreadsheets/u/1/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=2126158079=), the devices and parts linked use affiliated links.
* Buy devices, boards or parts from the [compatible web site](https://compatible.openmqttgateway.com), the devices and parts linked use affiliated links.
* Donate or sponsor the project [developpers](https://github.com/1technophile/OpenMQTTGateway/graphs/contributors)
* Make a video or a blog article about what you have done with [OpenMQTTGateway](https://docs.openmqttgateway.com) and share it.
docs/prerequisites/board.md
+6 -6
View File
@@ -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.
docs/prerequisites/controller.md
+1 -1
View File
@@ -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)
docs/prerequisites/devices.md
+8 -4
View File
@@ -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.
docs/prerequisites/parts.md
+20
View File
@@ -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.
:::
docs/setitup/actuators.md
+4 -4
View File
@@ -2,10 +2,10 @@
## Compatible parts
|Module|Purpose|Where to Buy|
|-|-|-|
|LED|Basic led|[parts list](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=1323184277)|
|FASTLED|RGB Leds management|[parts list](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=1323184277)|
|BUZZER|-|[parts list](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=1323184277)|
|RELAY|Switch power circuit|[parts list](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=1323184277)|
|LED|Basic led|[parts list](https://compatible.openmqttgateway.com/index.php/parts)|
|FASTLED|RGB Leds management|[parts list](https://compatible.openmqttgateway.com/index.php/parts)|
|BUZZER|-|[parts list](https://compatible.openmqttgateway.com/index.php/parts)|
|RELAY|Switch power circuit|[parts list](https://compatible.openmqttgateway.com/index.php/parts)|
## Pinout
|Module| Boards|
docs/setitup/ble.md
+1 -1
View File
@@ -5,7 +5,7 @@
For Arduino and ESP8266 you can use an HM10 or HM11 below.
|Module|Purpose|Where to Buy|
|-|-|-|
|HM 10 Keyes bluetooth module|Bluetooth|[compatible parts list](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=1323184277)|
|HM 10 Keyes bluetooth module|Bluetooth|[compatible parts list](https://compatible.openmqttgateway.com/index.php/parts)|
## Pinout
|Module Pin|Board RX Pin|Board TX Pin|
docs/setitup/gsm.md
+2 -2
View File
@@ -3,8 +3,8 @@
|Module|Purpose|Where to Buy|
|-|-|-|
|A6|GSM GPRS module|[compatible parts list](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=1323184277)|
|A7|GSM GPRS module with GPS|[compatible parts list](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=1323184277)|
|A6|GSM GPRS module|[compatible parts list](https://compatible.openmqttgateway.com/index.php/parts)|
|A7|GSM GPRS module with GPS|[compatible parts list](https://compatible.openmqttgateway.com/index.php/parts)|
## Hardware setup
docs/setitup/ir.md
+4 -4
View File
@@ -2,11 +2,11 @@
## Compatible parts
|Module|Purpose|Where to Buy|
|-|-|-|
|IR diode|Emitting|[compatible parts list](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=1323184277)|
|IR receiver|Receiving|[compatible parts list](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=1323184277)|
|IR diode|Emitting|[compatible parts list](https://compatible.openmqttgateway.com/index.php/parts)|
|IR receiver|Receiving|[compatible parts list](https://compatible.openmqttgateway.com/index.php/parts)|
|transistor 2N2222|Amplify uC signal for the IR diode|-|
|330 ohms resistor|-|[compatible parts list](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=1323184277)|
|220 ohms resistor|limit current to LED|[compatible parts list](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=1323184277)|
|330 ohms resistor|-|[compatible parts list](https://compatible.openmqttgateway.com/index.php/parts)|
|220 ohms resistor|limit current to LED|[compatible parts list](https://compatible.openmqttgateway.com/index.php/parts)|
The IR setup can work with bc547 and a 4x3 LED-Matrix.
docs/setitup/lora.md
+1 -1
View File
@@ -1,6 +1,6 @@
# LORA gateway
## Compatible parts
An ESP32 board with a LORA module.
Idealy a TTGO board with LORA module included see [compatible parts list](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=1323184277)
Idealy a TTGO board with LORA module included see [compatible parts list](https://compatible.openmqttgateway.com/index.php/parts)
With this kind of board there is no hadware modification needed.
docs/setitup/rf.md
+5 -5
View File
@@ -2,11 +2,11 @@
## Compatible parts
|Module|Purpose|Where to Buy|
|-|-|-|
|SRX882 (recommended)|433Mhz Receiver|[compatible parts list](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=1323184277)|
|STX882 (recommended)|433Mhz Transmitter|[compatible parts list](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=1323184277)|
|XD RF 5V|433Mhz Receiver|[compatible parts list](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=1323184277)|
|FS1000A|433Mhz Transmitter|[compatible parts list](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=1323184277)|
|CC1101|433Mhz Transceiver|[compatible parts list](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=1323184277)|
|SRX882 (recommended)|433Mhz Receiver|[compatible parts list](https://compatible.openmqttgateway.com/index.php/parts)|
|STX882 (recommended)|433Mhz Transmitter|[compatible parts list](https://compatible.openmqttgateway.com/index.php/parts)|
|XD RF 5V|433Mhz Receiver|[compatible parts list](https://compatible.openmqttgateway.com/index.php/parts)|
|FS1000A|433Mhz Transmitter|[compatible parts list](https://compatible.openmqttgateway.com/index.php/parts)|
|CC1101|433Mhz Transceiver|[compatible parts list](https://compatible.openmqttgateway.com/index.php/parts)|
## Pinout
|Board| Receiver Pin| Emitter Pin|
docs/setitup/sensors.md
+9 -9
View File
@@ -2,16 +2,16 @@
## Compatible sensors
|Module|Purpose|Where to Buy|
|-|-|-|
|DHT11|Temperature and Humidity|[parts list](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=1323184277)|
|DHT22|Temperature and Humidity|[parts list](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=1323184277)|
|HCSR501|PIR|[parts list](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=1323184277)|
|BH1750|Digital light|[parts list](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=1323184277)|
|BME280|Temperature, Humidity and pressure|[parts list](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=1323184277)|
|HTU21|Temperature, Humidity|[parts list](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=1323184277)|
|DHT11|Temperature and Humidity|[parts list](https://compatible.openmqttgateway.com/index.php/parts)|
|DHT22|Temperature and Humidity|[parts list](https://compatible.openmqttgateway.com/index.php/parts)|
|HCSR501|PIR|[parts list](https://compatible.openmqttgateway.com/index.php/parts)|
|BH1750|Digital light|[parts list](https://compatible.openmqttgateway.com/index.php/parts)|
|BME280|Temperature, Humidity and pressure|[parts list](https://compatible.openmqttgateway.com/index.php/parts)|
|HTU21|Temperature, Humidity|[parts list](https://compatible.openmqttgateway.com/index.php/parts)|
|GPIO Input|Inputs|-|
|GPIO KeyCode|Keycode|[parts list](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=1323184277)|
|INA226|Current and voltage|[parts list](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=1323184277)|
|TSL2561|Luminiosity|[parts list](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=1323184277)|
|GPIO KeyCode|Keycode|[parts list](https://compatible.openmqttgateway.com/index.php/parts)|
|INA226|Current and voltage|[parts list](https://compatible.openmqttgateway.com/index.php/parts)|
|TSL2561|Luminiosity|[parts list](https://compatible.openmqttgateway.com/index.php/parts)|
## Pinout
|Module|Arduino Pin| ESP8266 Pin|ESP32 Pin|