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

Typo-fixes (#1244)

Browse Source
This commit is contained in:
DigiH authored and GitHub committed 2022-07-19 07:53:38 +02:00
1 parent 612c3f6322
commit 1c62d74e56
19 files changed
+38 -38
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/upload/advanced-configuration.md
+3 -3
View File
@@ -30,7 +30,7 @@ const char* certificate CERT_ATTRIBUTE = R"EOF("
You can know compile and upload to your board and the gateway should connect with TLS to your broker.
## Add the reveived "value" at the end of the topic
## Add the received "value" at the end of the topic
For the gateways that publish a "value" parameter on the json (RF, IR...), it is possible to concatenate this parameter at the end of the topic.
So as to activate this function you need to uncomment the line below in User_config.h
@@ -48,7 +48,7 @@ With the line uncommented you will see:
home/OpenMQTTGateway/SRFBtoMQTT/59365 {"raw":"2B660186042E00E7E5","value":"59365","delay":"1111","val_Thigh":"390","val_Tlow":"1070"}
```
It can be usefull to avoid warning or errors on certain controllers.
It can be useful to avoid warning or errors on certain controllers.
## Auto discovery
Home Assistant discovery is enabled by default on all binaries and platformio configurations except for UNO. With Arduino IDE you have to uncomment [ZmqttDiscovery](https://github.com/1technophile/OpenMQTTGateway/blob/0180a0dbd55ed8e0799e30ee84f68070a6f478fa/User_config.h#L99) in User_config.h.
@@ -71,7 +71,7 @@ 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 sensors and gateways into your HASS instance automatically.
The gateway device will be available into Configuration->Devices section of Home Assistant.
docs/upload/binaries.md
+2 -2
View File
@@ -11,11 +11,11 @@ Download the binary corresponding to your board and gateway [here](https://githu
https://www.espressif.com/en/products/hardware/esp32/resources
* Uncompress the package
* Execute `flash_download_tools`
* Choose Developper mode
* Choose Developer mode
* Choose ESP32 DownloadTool
* Set the files and the address as below:
![Flash download tool](../img/OpenMQTTgateway_ESP32_binary_flash.png)
And set the parameters used by arduino IDE, we are able to upload to ESP32 a binary file containing OpenMQTTGateway.
And set the parameters used by Arduino IDE, we are able to upload to ESP32 a binary file containing OpenMQTTGateway.
* Set the config as above
* Connect your ESP32 board and select the COM port
* Click on erase if it is your first upload
docs/upload/builds.md
+8 -8
View File
@@ -161,7 +161,7 @@ With some ESP it could be necessary to push the reset button when the upload beg
If you want to erase the settings stored in the ESP memory use:
`pio run --target erase`
This can be usefull especialy before the first upload or when you change the board partitions sizing.
This can be useful especially before the first upload or when you change the board partitions sizing.
Once done the gateway should connect to your network and your broker, you should see it into the broker in the form of the following messages:
```
@@ -169,7 +169,7 @@ home/OpenMQTTGateway/LWT Online
home/OpenMQTTGateway/version
```
With PIO you can also upload the firmware through Over the Air, so as to do that you can add the upload options flags used below, `upload_port` is the IP adress of your ESP:
With PIO you can also upload the firmware through Over the Air, so as to do that you can add the upload options flags used below, `upload_port` is the IP address of your ESP:
``` ini
[env:esp32-ble]
@@ -193,13 +193,13 @@ upload_flags =
## Configure & Upload with Arduino IDE
* Download the [CODE](https://github.com/1technophile/OpenMQTTGateway/releases) from github
* First download the last version of the Arduino IDE from the arduino [website](https://www.arduino.cc/en/Main/Software)
* First download the last version of the Arduino IDE from the Arduino [website](https://www.arduino.cc/en/Main/Software)
* Add ESP32 boards by following this [tutorial](https://github.com/espressif/arduino-esp32/blob/master/docs/arduino-ide/boards_manager.md)
* Add ESP8266 boards by following this [tutorial](https://github.com/esp8266/Arduino#installing-with-boards-manager)
* Download the libraries package corresponding to your board and module wished into the same page (example esp32-m5stick-c-ble-libraries.zip)
* Unzip the libraries into your arduino libraries folder (example D:/Users/XXXX/Documents/Arduino/libraries)
* Unzip the libraries into your Arduino libraries folder (example D:/Users/XXXX/Documents/Arduino/libraries)
* If necessary replace the spaces into each library folder by _: example rename “ESP32 BLE Arduino” folder to “ESP32_BLE_Arduino”
* Open the file main.ino from OpenMQTTGateway/main folder with the arduino IDE
* Open the file main.ino from OpenMQTTGateway/main folder with the Arduino IDE
* Change the settings and the desired gateways into `User_config.h` (uncomment the modules you want)
*Example for the use of RF gateway:*
@@ -212,13 +212,13 @@ upload_flags =
//#define ZgatewayBT "BT" //ESP8266, ESP32
```
* Change the pins or parameters corresponding to the modules choosen, for RF you can change the pins into config_RF.h
* Change the pins or parameters corresponding to the modules chosen, for RF you can change the pins in config_RF.h
* Choose the board on the Arduino IDE
* Select the port corresponding to the board
* Note that for using BLE on ESP32 you will need to select *Minimal SPIFFS* into Tools->Partition Scheme
* Open the serial monitor and set 115200 bauds
* Upload ➡️
* You should see the logs into the serial monitor
* You should see the logs in the serial monitor
With an ESP if you did not set your network and mqtt parameters manually you can now open the [web portal configuration](portal.md).
@@ -259,7 +259,7 @@ If you want to use HASS MQTT discovery you need to have
uncommented.
Added to that auto discovery box should be selected into your Home Assistant MQTT integration configuration.
With an ESP if you did not set your network and mqtt parameters manualy you can now open the [web portal configuration](portal.md).
With an ESP if you did not set your network and mqtt parameters manually you can now open the [web portal configuration](portal.md).
::: warning Note
simpleReceiving on Arduino boards doesn't accept 64 bits MQTT values, you can only send 32bits values from the MQTT broker.
docs/upload/portal.md
+1 -1
View File
@@ -16,7 +16,7 @@ From your smartphone search for your OpenMQTTGateway wifi network and connect to
* Set your MQTT Server IP
* Set your MQTT Server Port
* Set the MQTT secure connection box to select whether or not the connection should be secure
* Copy/paste the MQTT server certificate in the MQTT server cert box (only required if using a secure connection), be sure to include the `-----BEGIN CERIFICATE-----` and `-----END CERTIFICATE-----` markers
* Copy/paste the MQTT server certificate in the MQTT server cert box (only required if using a secure connection), be sure to include the `-----BEGIN CERTIFICATE-----` and `-----END CERTIFICATE-----` markers
* Set your MQTT Server username (facultative)
* Set your MQTT Server password (facultative)
* Set your MQTT base topic if you need to change it (you must keep the / at the end)
docs/upload/web-install.md
+5 -5
View File
@@ -15,11 +15,11 @@ The table below describes the libraries and the modules of each board configurat
|**ESP32**|
|esp32-lolin32lite-ble|ESP32 Lolin lite|Suitable for low power with BLE gateway, [tutorial](https://1technophile.blogspot.com/2021/04/low-power-esp32-ble-gateway.html)|-|-|X|-|
|esp32-m5atom|M5Atom|Compact enclosure ESP32 with BLE gateway|-|(Emit)|X|-|
|esp32-m5stack-ble|M5Stack Core|Expandable mobule with BLE gateway, display, and little IR emitter|-|-|X|-|
|esp32-m5stick-ble|M5Stick Grey|Expandable mobule with BLE gateway and little IR emitter|-|(Emit)|X|-|
|esp32-m5stick-c-ble|M5Stick C Orange|Expandable mobule with BLE gateway, display, and little IR emitter|-|(Emit)|X|-|
|esp32-m5stick-cp-ble|M5Stick C Plus Orange|Expandable mobule with BLE gateway, display, and little IR emitter|-|(Emit)|X|-|
|esp32-m5tough-ble|M5Tough rugged|Expandable mobule with BLE gateway and display, suitable for outdoor|-|-|X|-|
|esp32-m5stack-ble|M5Stack Core|Expandable module with BLE gateway, display, and little IR emitter|-|-|X|-|
|esp32-m5stick-ble|M5Stick Grey|Expandable module with BLE gateway and little IR emitter|-|(Emit)|X|-|
|esp32-m5stick-c-ble|M5Stick C Orange|Expandable module with BLE gateway, display, and little IR emitter|-|(Emit)|X|-|
|esp32-m5stick-cp-ble|M5Stick C Plus Orange|Expandable module with BLE gateway, display, and little IR emitter|-|(Emit)|X|-|
|esp32-m5tough-ble|M5Tough rugged|Expandable module with BLE gateway and display, suitable for outdoor|-|-|X|-|
|esp32-olimex-gtw-ble-eth|Olimex Ethernet Gateway (non POE)|BLE gateway with external antenna as an option|-|-|X|-|
|esp32-olimex-gtw-ble-poe|Olimex Ethernet Gateway (POE)|BLE gateway with external antenna as an option|-|-|X|-|
|esp32-olimex-gtw-ble-poe-iso|Olimex Ethernet Gateway (POE + ISO)|BLE gateway with external antenna as an option|-|-|X|-|