From 561de90c949bdd8257c289bbf83e6d35433679cf Mon Sep 17 00:00:00 2001 From: DigiH Date: Fri, 16 Jun 2023 20:45:31 +0200 Subject: [PATCH] [DOCS] Typo fixes (#1688) --- docs/integrate/aws_iot.md | 2 +- docs/integrate/home_assistant.md | 2 +- docs/upload/troubleshoot.md | 4 ++-- docs/upload/web-install.md | 2 +- docs/use/ble.md | 4 ++-- docs/use/boards.md | 12 ++++++------ 6 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/integrate/aws_iot.md b/docs/integrate/aws_iot.md index 178b8b746e..8948b14efc 100644 --- a/docs/integrate/aws_iot.md +++ b/docs/integrate/aws_iot.md @@ -93,7 +93,7 @@ With PlatformIO you can directly leverage the environment `esp32dev-ble-aws` ## Build and upload -## Connect to a wifi Access point [see portal](../upload/portal) +## Connect to a WiFi Access point [see portal](../upload/portal) Enter your credentials and verify that Secure connection is marked. ## Verify that you receive data in AWS diff --git a/docs/integrate/home_assistant.md b/docs/integrate/home_assistant.md index 95be8b3023..56aef8312d 100644 --- a/docs/integrate/home_assistant.md +++ b/docs/integrate/home_assistant.md @@ -37,7 +37,7 @@ OMG will use the auto discovery functionality of home assistant to create gatewa The Bluetooth and the RTL_433 gateway will create automatically devices and entities, the RF gateway will create DeviceTrigger. The OpenMQTTGateway will also be available as a device to monitor its parameters and control it. The sensors (DHT for example) and actuators (relays) are attached to the gateway. -30 minutes after its activation the auto discovery will be automaticaly deactivated, you can reactivate it from the gateway controls. +30 minutes after its activation the auto discovery will be automatically deactivated, you can reactivate it from the gateway controls. Some devices may require a button push or motion/contact event to trigger a message and generate the auto discovery. ::: diff --git a/docs/upload/troubleshoot.md b/docs/upload/troubleshoot.md index 396f9ac95d..97a31b7ffb 100644 --- a/docs/upload/troubleshoot.md +++ b/docs/upload/troubleshoot.md @@ -6,7 +6,7 @@ If you see a green badge this means that the code compilation is OK with the con Check your IDE environment version, boards version, libraries version before submitting an issue or a question. Verify especially that the libraries provided into the [release page](https://github.com/1technophile/OpenMQTTGateway/releases) are located into your "sketchbook folder"/libraries if your are using the Arduino IDE. -## ESP32 compilation errors related to wifi +## ESP32 compilation errors related to WiFi If you get one or several of the following errors: `error: 'WIFI_STA' was not declared in this scope` @@ -15,7 +15,7 @@ If you get one or several of the following errors: `error: no matching function for call to 'WiFiClass::macAddress()` -You have a conflict between Arduino default wifi library and ESP32 one. So as to resolve this issue you should move or remove the Arduino wifi library (Arduino Sketchbook folder\libraries\WiFi) in order to enable the IDE to take the one from ESP32 (Arduino Sketchbook folder\hardware\espressif\arduino-esp32\libraries\WiFi) +You have a conflict between Arduino default WiFi library and ESP32 one. So as to resolve this issue you should move or remove the Arduino WiFi library (Arduino Sketchbook folder\libraries\WiFi) in order to enable the IDE to take the one from ESP32 (Arduino Sketchbook folder\hardware\espressif\arduino-esp32\libraries\WiFi) More info on [this topic](https://community.openmqttgateway.com/t/esp32-compilation-error/144/5?u=1technophile) ## Not able to send or receive RF or IR diff --git a/docs/upload/web-install.md b/docs/upload/web-install.md index c35faa45dd..2f39215333 100644 --- a/docs/upload/web-install.md +++ b/docs/upload/web-install.md @@ -18,7 +18,7 @@ You can upload the firmware to your ESP device directly from here. 2. Select the firmware in the box below. 3. Click the install button and choose the port that the ESP is connected to. 4. Wait until the process is complete. -5. Once completed you can configure your [Wifi and MQTT credentials](portal.md) +5. Once completed you can configure your [WiFi and MQTT credentials](portal.md) diff --git a/docs/use/ble.md b/docs/use/ble.md index 753ba83c6f..bcb0ac26eb 100644 --- a/docs/use/ble.md +++ b/docs/use/ble.md @@ -30,8 +30,8 @@ Once the data has been transmitted to the MQTT broker, it can be easily integrat Examples of compatible sensors among [our list](https://decoder.theengs.io/devices/devices_by_brand.html: Mi Flora, Mi jia, LYWDS02, LYWSD03MMC, ClearGrass, Mi scale, iBBQ, TPMS ## Receiving signals from BLE tracker devices for Presence detection -The gateway can detect the BLE trackers from Tile, NUT, TAGIT, ITAG, MiBand, Amazfit and RuuviTag and create automaticaly a device tracker entity following the Home Assistant discovery convention (if the auto discovery is activated). -To do this activate the "BT: Publish HASS presence" switch in your controller or send the followng MQTT command to your broker: +The gateway can detect the BLE trackers from Tile, NUT, TAGIT, ITAG, MiBand, Amazfit and RuuviTag and create automatically a device tracker entity following the Home Assistant discovery convention (if the auto discovery is activated). +To do this activate the "BT: Publish HASS presence" switch in your controller or send the following MQTT command to your broker: `mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{"hasspresence":true}'` The entity created can be attached to a person to leverage presence detection. The `away` or `not home` state is triggered if the BLE tracker is not detected during the timer defined by `presenceawaytimer`. diff --git a/docs/use/boards.md b/docs/use/boards.md index 5c15493320..8d3cef5e6c 100644 --- a/docs/use/boards.md +++ b/docs/use/boards.md @@ -13,8 +13,8 @@ On M5Stack boards you may do a long press to these buttons in low power mode 0 ( You can also do a long press when powering the board to reset it, this press must be done during the first 5 seconds after the start. -### Wifi interference on ESP32 ### -Certain sensors like HC-SR501 is prone to generate false signals / triggers when used on a ESP32 with Wifi enabled. To reduce or elimate the effect the board must be put into Wifi B/G with lower TX power. +### WiFi interference on ESP32 ### +Certain sensors like HC-SR501 is prone to generate false signals / triggers when used on a ESP32 with WiFi enabled. To reduce or eliminate the effect the board must be put into WiFi B/G with lower TX power. This can be achieved with the following macro, `WifiGMode` defined true and `WifiPower` to e.g. WIFI_POWER_11dBm. @@ -37,7 +37,7 @@ The interval between the ESP32 wake up is defined at build time by the macro `Ti ::: tip When coming back from mode 2 to mode 0 you may publish the command with a retain flag so as to enable the gateway to retrieve it when reconnecting. -A low power mode switch is automatically created by discovery with Home Assistant, you may experience a delay between the command and the state update due to the fact that the update will be revceived and acknowledged when the device woke up. +A low power mode switch is automatically created by discovery with Home Assistant, you may experience a delay between the command and the state update due to the fact that the update will be received and acknowledged when the device woke up. In low power mode you should use ESPWifiManualSetup so as to rely on the credentials entered into User_config.h. So as to do that uncomment the line below in User_config.h ``` c @@ -54,7 +54,7 @@ If you change the default low power mode in config_BT.h to 2 and your credential ### Behaviour -If the connection of the board to WIFI and MQTT is successful you will see the logo with text like below: +If the connection of the board to WiFi and MQTT is successful you will see the logo with text like below: ![boards](../img/OpenMQTTgateway_M5_Stack_Board_Display_Text.png) @@ -93,7 +93,7 @@ The low power mode can be changed also with a push to button B when the board is If you are already in low power mode 1 or 2 with M5Stack you can wake up the board by pressing the red button. ### Low power mode (deepSleep) for ESP8266 & ESP32 boards -In certain use cases where power is severly limited you can use the ESP8266 or ESP32 deep sleep capability. +In certain use cases where power is severely limited you can use the ESP8266 or ESP32 deep sleep capability. * e.g. measuring a pool temperature every 5 minutes using an ESP8266 and DS18B20 probe where the ESP8266 is powered by very limited battery backed solar power. * e.g. as a water/leak detector which wake-up based on sensor state an ESP32 and C-37 YL-83 HM-RD sensor where the ESP32 is powered by very limited battery power. @@ -110,4 +110,4 @@ For an ESP8266 a hardware jumper is required connecting RST to a GPIO (not to CH On an ESP32 we can also use an external sensor state to wake-up the ESP and this is defined by macro `ESP32_EXT0_WAKE_PIN` and which state it must toggle to by macro `ESP32_EXT0_WAKE_PIN_STATE` defaulted to 1 (high). -And the sensor code must set variable `ready_to_sleep` to true after publishing the measurement to MQTT and the main loop will then enter deep sleep. \ No newline at end of file +And the sensor code must set variable `ready_to_sleep` to true after publishing the measurement to MQTT and the main loop will then enter deep sleep.