Mirrors/OpenMQTTGateway
2
0
Fork 0
mirror of https://github.com/1technophile/OpenMQTTGateway.git synced 2026-02-20 00:32:04 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add hass auto discovery gif and img (#916)

Browse Source 
and update M5Stack docs
This commit is contained in:
Florian
2021-04-04 14:53:00 -05:00
committed by GitHub
parent 6c8ba53276
commit adc5f157cd
5 changed files with 10 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/img/OpenMQTTGateway-Configuration-Home-Assistant-Discovery-Integration.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 139 KiB

BIN
docs/img/OpenMQTTGateway_auto_discovery_BLE_Sensor_Home_Assistant.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 671 KiB

BIN
docs/img/OpenMQTTGateway_auto_discovery_Gateway_Home_Assistant.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.2 MiB

14
docs/integrate/home_assistant.md
View File

@@ -2,9 +2,11 @@
## Auto discovery
Home Assistant discovery is enabled by default on all binaries and platformio configurations except for UNO. With Arduino IDE please read the [advanced configuration section](../upload/advanced-configuration#auto-discovery) of the documentation.
Once done, enable discovery on your MQTT integration definition in HASS.
First enable discovery on your MQTT integration in HASS.
So as to create the MQTT username and password, you have to create a new user(recommended) into Home Assistant->Configuration->Users (available in admin mode) or use an existing username/pwd combination (not recommended). This user doesn't need to be an administrator.
![](../img/OpenMQTTGateway-Configuration-Home-Assistant-Discovery-Integration.png)
The gateway will need an MQTT username and password, you have to create a new user(recommended) into Home Assistant->Configuration->Users (available in admin mode) or use an existing username/pwd combination (not recommended). This user doesn't need to be an administrator.
![](../img/OpenMQTTGateway-Configuration-Home-Assistant.png)
@@ -12,11 +14,11 @@ So as to create the MQTT username and password, you have to create a new user(re
The max size of the username is 30 and 60 for the password.
:::
OMG will use the auto discovery functionality of home assistant to create sensors and gateways into your HASS instance automaticaly.
OMG will use the auto discovery functionality of home assistant to create gateway and sensors into your HASS instance automaticaly.
::: tip
The gateway device will be available into Configuration->Devices section of Home Assistant.
:::
![](../img/OpenMQTTGateway_auto_discovery_Gateway_Home_Assistant.gif)
![](../img/OpenMQTTGateway_auto_discovery_BLE_Sensor_Home_Assistant.gif)
![](../img/OpenMQTTGateway_Home_Assistant_MQTT_discovery.png)

4
docs/use/boards.md
View File

@@ -6,12 +6,11 @@
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:
On M5Stack boards you may do a long press to these buttons in low power mode 0 (see below how to go to low power mode 0):
* Button B on M5StickC and M5StickC Plus (GPIO 37)
* Button C on M5Stack (GPIO 37)
* Button lateral on M5stick (GPIO 35)
### Low power mode for ESP32
OpenMQTTGateway support a low power mode for ESP32, this mode can be set by MQTT:
@@ -78,3 +77,4 @@ OpenMQTTGateway support a low power mode for ESP32, this mode can be set by MQTT
`mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoBT/config" -m '{"lowpowermode":2}'`
The low power mode can be changed also with a push to button B when the board is processing (top button on M5stickC, M5stickC Plus and middle button of M5stack).
If you are already in low power mode 1 or 2 with M5Stack you can wake up the board by pressing the red button.