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

DOCS improvements

Browse Source
This commit is contained in:
Florian committed 2020-09-17 13:43:05 -05:00
1 parent 7f1cafba61
commit 4b265384b2
5 files changed
+26 -25
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/prerequisites/board.md
+4 -3
View File
@@ -3,8 +3,8 @@ OpenMQTTGateway is not closed to one board or type of board, by using the power
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/). 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, BME280, HTU21D Moreover the gateways capacities can be extended with sensors; DHT, HC SR501, ADC, I2C bus, INA226, TSL2561, BME280, HTU21D, AHTx0, DS1820
Or can actutate things (LED chipsets, relays). or actuators; LED, relays, PWM.
Here is some information to find the board suitable for your need, you have the choice between off the shelves boards and DIY setup. Here is some information to find the board suitable for your need, you have the choice between off the shelves boards and DIY setup.
@@ -15,6 +15,7 @@ The boards below doesn't need hardware modification (or a lite one).
|AVATTO / BAKEEY|![](../img/OpenMQTTGateway_boards_avatto_s06.png)|-|[X](https://1technophile.blogspot.com/2020/07/avatto-s06-ir-gateway-compatible-with.html)|-|-|-|-|-| |AVATTO / BAKEEY|![](../img/OpenMQTTGateway_boards_avatto_s06.png)|-|[X](https://1technophile.blogspot.com/2020/07/avatto-s06-ir-gateway-compatible-with.html)|-|-|-|-|-|
|Sonoff RF Bridge (*) |![](../img/OpenMQTTGateway_boards_sonoff_rfbridge.png)|X|[mod](https://1technophile.blogspot.com/2018/02/adding-infrared-emitter-to-sonoff-rf.html)|-|-|-|-|-| |Sonoff RF Bridge (*) |![](../img/OpenMQTTGateway_boards_sonoff_rfbridge.png)|X|[mod](https://1technophile.blogspot.com/2018/02/adding-infrared-emitter-to-sonoff-rf.html)|-|-|-|-|-|
|All bare ESP32|-|-|-|X|-|X|-|X| |All bare ESP32|-|-|-|X|-|X|-|X|
|OLIMEX ESP32 Ethernet|-|-|-|X|-|X|-|X|
|[M5Stack Basic](M5)|![](../img/OpenMQTTgateway_M5_Stack_Board_Display_Text.png)|-|-|X|-|X|X|X| |[M5Stack Basic](M5)|![](../img/OpenMQTTgateway_M5_Stack_Board_Display_Text.png)|-|-|X|-|X|X|X|
|M5Stick|-|-|send|X|-|X|-|X| |M5Stick|-|-|send|X|-|X|-|X|
|[M5Stick C](M5)|![](../img/OpenMQTTgateway_M5_StickC_Board_Display_Text.png)|-|send|X|-|X|X|X| |[M5Stick C](M5)|![](../img/OpenMQTTgateway_M5_StickC_Board_Display_Text.png)|-|send|X|-|X|X|X|
@@ -24,7 +25,7 @@ The boards below doesn't need hardware modification (or a lite one).
|Sonoff Basic|-|-|-|-|-|X|-|-| |Sonoff Basic|-|-|-|-|-|X|-|-|
|RF WIFI GATEWAY|![](../img/OpenMQTTGateway_board_wifi_rf_gateway.png)|[receiving](https://1technophile.blogspot.com/2019/09/hack-of-rf-wifi-gateway-usb-stick.html)|-|-|-|-|-|-| |RF WIFI GATEWAY|![](../img/OpenMQTTGateway_board_wifi_rf_gateway.png)|[receiving](https://1technophile.blogspot.com/2019/09/hack-of-rf-wifi-gateway-usb-stick.html)|-|-|-|-|-|-|
'(*)' *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.* '(*)' *So as to extend the number of RF protocols supported by the Sonoff RF Bridge you can apply a [hardware hack](https://1technophile.blogspot.com/2019/04/sonoff-rf-bridge-pilight-or-how-to.html), this way you will be able to use RFm Pilight or RF2 gateway.*
## DIY boards ## DIY boards
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. 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.
docs/prerequisites/devices.md
+10 -10
View File
@@ -22,26 +22,26 @@ OpenMQTTGateway is able to scan all the BLE devices that advertise their data so
| Vegtrug ||temperature/moisture/luminance/fertility| | Vegtrug ||temperature/moisture/luminance/fertility|
| XIAOMI Mi Flora |HHCCJCY01HHCC|temperature/moisture/luminance/fertility| | XIAOMI Mi Flora |HHCCJCY01HHCC|temperature/moisture/luminance/fertility|
| XIAOMI Mi Jia |LYWSDCGO|temperature/humidity/battery| | XIAOMI Mi Jia |LYWSDCGO|temperature/humidity/battery|
| XIAOMI Mi Jia 2 *|LYWSD03MMC|temperature/humidity/battery/volt| | XIAOMI Mi Jia 2 (1)|LYWSD03MMC|temperature/humidity/battery/volt|
| XIAOMI Mi Jia 2 custom firmware **|LYWSD03MMC ATC|temperature/humidity/battery/volt| | XIAOMI Mi Jia 2 custom firmware (2)|LYWSD03MMC ATC|temperature/humidity/battery/volt|
| XIAOMI MHO-C401 *|MHO-C401|temperature/humidity/battery/volt| | XIAOMI MHO-C401 (1)|MHO-C401|temperature/humidity/battery/volt|
| XIAOMI Mi Lamp |MUE4094RT|presence| | XIAOMI Mi Lamp |MUE4094RT|presence|
| HONEYWELL |JQJCY01YM|formaldehyde/temperature/humidity/battery| | HONEYWELL |JQJCY01YM|formaldehyde/temperature/humidity/battery|
| INKBIRD *|IBS-TH1|temperature/humidity/battery| | INKBIRD (1)|IBS-TH1|temperature/humidity/battery|
| ClearGrass |CGG1|temperature/humidity/battery| | ClearGrass |CGG1|temperature/humidity/battery|
| ClearGrass alarm clock|CGD1|temperature/humidity| | ClearGrass alarm clock|CGD1|temperature/humidity|
| ClearGrass with atmospheric pressure |CGP1W|temperature/humidity/air pressure| | ClearGrass with atmospheric pressure |CGP1W|temperature/humidity/air pressure|
| Clock |LYWDS02|temperature/humidity| | Clock |LYWDS02|temperature/humidity|
| XIAOMI Mi Scale v1 *|XMTZC04HM|weight| | XIAOMI Mi Scale v1 (1)|XMTZC04HM|weight|
| XIAOMI Mi Scale v2 *|XMTZC05HM|weight| | XIAOMI Mi Scale v2 (1)|XMTZC05HM|weight|
| XIAOMI Mi band * ||steps| | XIAOMI Mi band (1)||steps|
| iNode Energy Meter * ||power,energy,battery| | iNode Energy Meter (1)||power,energy,battery|
Exhaustive list [here](https://compatible.openmqttgateway.com/index.php/devices/ble-devices/) Exhaustive list [here](https://compatible.openmqttgateway.com/index.php/devices/ble-devices/)
::: INFO ::: INFO
(*) Not supported with HM10. (1) Not supported with HM10.
(**) See https://github.com/atc1441/ATC_MiThermometer (2) See https://github.com/atc1441/ATC_MiThermometer
::: :::
![devices](../img/OpenMQTTGateway_devices_ble.png ':size=250%') ![devices](../img/OpenMQTTGateway_devices_ble.png ':size=250%')
docs/setitup/ble.md
+1 -1
View File
@@ -21,7 +21,7 @@ So as to communicate directly with the HM10 you may use [this program](https://g
The baud rate of the HM10/11 module must be set to 9600 bauds , the command `AT+BAUD?` enables to know at which speed the module is set. The baud rate of the HM10/11 module must be set to 9600 bauds , the command `AT+BAUD?` enables to know at which speed the module is set.
So as to set it to 9600 that you may use `AT+BAUD0` command. So as to set it to 9600 that you may use `AT+BAUD0` command.
The HM10/11 firmware version must be >= v601, the command `AT+VERS?` enables to know the firmware version. The HM10/11 firmware version must be >= V709 the command `AT+VERS?` enables to know the firmware version.
## Arduino Hardware setup ## Arduino Hardware setup
![BLE Arduino](../img/OpenMQTTgateway_Arduino_Addon_BT.png) ![BLE Arduino](../img/OpenMQTTgateway_Arduino_Addon_BT.png)
docs/use/ble.md
+3 -2
View File
@@ -44,7 +44,8 @@ Note that the gateway return one or two measurement value each time. The differe
* Steps * Steps
* Weight * Weight
* Impedance * Impedance
* Battery (mi jia only) * Battery
* Voltage
The infos will appear like this on your MQTT broker: The infos will appear like this on your MQTT broker:
@@ -116,7 +117,7 @@ If you want to change the minimum RSSI value accepted for a device to be publish
you can also accept all the devices by the following command: you can also accept all the devices by the following command:
`mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{"minrssi":0}'` `mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{"minrssi":-200}'`
The default value is set into config_BT.h The default value is set into config_BT.h
docs/use/boards.md
+8 -9
View File
@@ -4,10 +4,16 @@
### Erasing the flash ### Erasing the flash
So as to erase the flash memory on ESP boards you may do a long press to TRIGGER_GPIO button or connect the pin to the ground. So as to erase the flash memory on ESP boards you may do a long press to TRIGGER_GPIO button or connect the pin TRIGGER_GPIO to the ground during several seconds.
On M5Stack boards you may do a long press to these buttons:
* Button B on M5StickC (GPIO 37)
* Button C on M5Stack (GPIO 37)
* Button lateral on M5stick (GPIO 35)
### Low power mode for ESP32 ### Low power mode for ESP32
OpenMQTTGateway support a low power mode for ESP32, this mode can be set by MQTT on a barebone ESP32: OpenMQTTGateway support a low power mode for ESP32, this mode can be set by MQTT:
* Normal mode (per default) * Normal mode (per default)
@@ -65,10 +71,3 @@ OpenMQTTGateway support a low power mode for ESP32, this mode can be set by MQTT
`mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoBT/config" -m '{"low_power_mode":2}'` `mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoBT/config" -m '{"low_power_mode":2}'`
The low power mode can be changed also with a push to button B when the board is processing (top button on M5stickC and middle button of M5stack). The low power mode can be changed also with a push to button B when the board is processing (top button on M5stickC and middle button of M5stack).
### Erasing the flash
So as to erase the flash memory on M5Stack boards you may do a long press to TRIGGER_GPIO button:
* Button B on M5StickC (GPIO 37)
* Button C on M5Stack (GPIO 37)
* Button lateral on M5stick (GPIO 35)