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

Docs vuepress (#476)

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/setitup/actuators.md
+17
View File
@@ -0,0 +1,17 @@
# Actuators
## 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)|
## Pinout
|Module| Boards|
|-|-|
|RELAY|all output compatible pins|
|FASTLED|all output compatible pins|
Vcc pin of the board and the Module to a 5V supply source
Ground pins of the board and the Module to the ground of the supply source.
docs/setitup/ble.md
+27
View File
@@ -0,0 +1,27 @@
# BLE gateway
## Compatible parts
The ESP32 has an integrated BLE module, with this board the BLE gateway don't need any additional hardware. Making it the **advised board for BLE**.
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)|
## Pinout
|Module Pin|Board RX Pin|Board TX Pin|
|-|:-:|:-:|
|Arduino|D6 to HM10 TX|D5 to HM10 RX|
|ESP8266|D6 to HM10 TX|D7 to HM10 RX|
Vcc pin of the board and the HM10 Module to a 5V supply source.
Ground pins of the board and the HM10 Module to the ground of the supply source.
The HM10/11 firmware version must be >= v601.
The baud rate of the HM10/11 module must be set to 9600 bauds.
## Arduino Hardware setup
![BLE Arduino](../img/OpenMQTTgateway_Arduino_Addon_BT.png)
## ESP8266 Hardware setup
![BLE ESP8266](../img/OpenMQTTgateway_ESP8266_Addon_BT.png)
docs/setitup/gsm.md
+24
View File
@@ -0,0 +1,24 @@
# GSM 2G gateway
## Compatible parts
|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)|
## Hardware setup
|Module Pin|NodeMCU / ESP8266 Pin|
|-|:-:|
|H_RXD|D6|
|H_TXD|D7|
|GND|GND|
|VCC5|MOSFET driven by D5|
For VCC5 you can power it directly all the time with an USB cable or use a MOSFET like [here](https://gitlab.com/stavros/A6-ESP8266-breakout/raw/master/images/schematic.png)
Don't use the nodemcu/wemos 5V pin for the A6/7 power, use a dedicated power supply for both or dedicated to the A6/7 with at least 2 amps ability.
So as to start your A6/7 module press the red button for 4 seconds, or link the PWR_KEY pin to VCC5.0 for the same time.
![Addon_2G](../img/OpenMQTTgateway_ESP8266_Addon_2G.png)
docs/setitup/ir.md
+29
View File
@@ -0,0 +1,29 @@
# IR gateway
## 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)|
|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)|
The IR setup can work with bc547 and a 4x3 LED-Matrix.
## Pinout
|Board| Receiver Pin| Emitter Pin|
|-|:-:|:-:|
|Arduino UNO|D2|D9|
|ESP8266|D4|D0|
|ESP32|27/**26**|14|
Connect the Emitter and Receiver to a 5V supply source, and the ground of your supply source to the ground of your board.
## Arduino Hardware setup
![IR](../img/OpenMQTTgateway_Arduino_Addon_IR.png)
## ESP8266 Hardware setup
![IR](../img/OpenMQTTgateway_ESP8266_Addon_IR.png)
## ESP32 Hardware setup
![IR](../img/OpenMQTTgateway_ESP32_Addon_IR.png)
docs/setitup/lora.md
+6
View File
@@ -0,0 +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)
With this kind of board there is no hadware modification needed.
docs/setitup/rf.md
+44
View File
@@ -0,0 +1,44 @@
# RF gateway (433mhz/315mhz)
## 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)|
## Pinout
|Board| Receiver Pin| Emitter Pin|
|-|:-:|:-:|
|Arduino UNO|D3|D4|
|ESP8266|D2/**D3**/D1/D8|**RX**/D2|
|ESP32|**27**/26|12|
|RF BRIDGE|-|-|
|RF BRIDGE [DIRECT HACK](https://github.com/xoseperez/espurna/wiki/Hardware-Itead-Sonoff-RF-Bridge---Direct-Hack)|4|5|
|SONOFF RFR3|4|-|
|RF WIFI GATEWAY|5|-|
Connect the Emitter and Receiver to a 5V supply source, and the ground of your supply source to the ground of your board.
## Arduino Hardware setup
![RF](../img/OpenMQTTgateway_Arduino_Addon_RF.png)
## ESP8266 Hardware setup
If the gateway works only when serial monitor is connected don't use D3 use D2 instead (gpio 4) and modify config_RF.h accordingly.
With SRX882 some users reported that D3 is not working use D1 instead in this case and modify config_RF.h accordingly.
![Addon_RF](../img/OpenMQTTgateway_ESP8266_Addon_RF.png)
## ESP32 Hardware setup
![Addon_RF](../img/OpenMQTTgateway_ESP32_Addon_RF.png)
## SONOFF RF Bridge Hardware setup
Per default there is no need on modifying the RF Bridge hardware, unless you don't want to use the provided RF controller (EFM8BB1). Indeed if you want to extend the protocols supported by the bridge you can [bypass this controller](https://github.com/xoseperez/espurna/wiki/Hardware-Itead-Sonoff-RF-Bridge---Direct-Hack) and use the ESP8255 capacities to decode RF Signal.
The RF processing can be achieved after the modification by either RF, RF2 or Pilight gateways.
## SONOFF RFR3 Hardware setup
[Connect GPIO4 of the ESP8255 to the pin D0 of SYN470](https://1technophile.blogspot.com/2019/08/new-sonoff-rfr3-as-433tomqtt-gateway.html)
## WIFI RF GATEWAY Hardware setup
This board doesn't require any hardware modifications.
docs/setitup/sensors.md
+31
View File
@@ -0,0 +1,31 @@
# Sensors
## 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)|
|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)|
## Pinout
|Module|Arduino Pin| ESP8266 Pin|ESP32 Pin|
|-|-|-|-|
|DHT11/22|<a href="img/OpenMQTTgateway_Arduino_Addon_DHT.png" target="_blank">D8</a>|<a href="img/OpenMQTTgateway_ESP8266_Addon_DHT.png" target="_blank">D1</a>|16|
|HC-SR501/HC-SR505|7|D5|5|
|Analog reading|A0|A0|A0|
|BH1750 SDA|A4|D2|21|
|BH1750 SCL|A5|D1|22|
|BME280 SDA|A4|D2|21|
|BME280 SCL|A5|D1|22|
|INA226 SDA|A4|D2|21|
|INA226 SCL|A5|D1|22|
|TSL2561 SDA|A4|D2|21|
|TSL2561 SCL|A5|D1|22|
Vcc pin of the board and the Module to a 5V supply source
Ground pins of the board and the Module to the ground of the supply source.