From 0f57eddb01dd3ad14e71d6b6e13a4288d7b037e3 Mon Sep 17 00:00:00 2001 From: DigiH Date: Mon, 18 Jul 2022 18:30:37 +0200 Subject: [PATCH] typo fixes (#1243) --- docs/use/actuators.md | 4 ++-- docs/use/ble.md | 18 +++++++++--------- docs/use/boards.md | 4 ++-- docs/use/gateway.md | 12 ++++++------ docs/use/ir.md | 2 +- docs/use/rfm69.md | 2 +- docs/use/sensors.md | 2 +- 7 files changed, 22 insertions(+), 22 deletions(-) diff --git a/docs/use/actuators.md b/docs/use/actuators.md index d9cd24b..6cda383 100644 --- a/docs/use/actuators.md +++ b/docs/use/actuators.md @@ -51,7 +51,7 @@ Be aware that outputs are OFF by default when the board first start. ### Hardware wiring Theoretically it should be possible to use every free IO pin. But after some tests only pin D2 works at WEMOS D1. Other platforms can work. -The default setting use NEOPIXEL (WS2812B). The simplest wiring is direct connect D2 to data pin of LED stripe and connect VCC/GND to power source. You should also add an capacitor. +The default setting use NEOPIXEL (WS2812B). The simplest wiring is direct connect D2 to data pin of LED stripe and connect VCC/GND to power source. You should also add a capacitor. ## PWM This module allows control over PWM outputs. @@ -65,7 +65,7 @@ You would typically connect a PWM output to a transistor or MOSFET to allow cont ### Configuration In order to use the PWM actuator, you need to configure which pins the PWM output channels will be connected to. -There are a couple of `#define`s that achieve this. +There are a couple of `#defines that achieve this. They can be defined in the `build_flags` section of the env, or by directly editing `config_PWM.h`. ```c diff --git a/docs/use/ble.md b/docs/use/ble.md index 97eef86..77cdd4c 100644 --- a/docs/use/ble.md +++ b/docs/use/ble.md @@ -25,7 +25,7 @@ home/OpenMQTTGateway/BTtoMQTT/C7FaaD132C00 {"id":"c7:fa:ad:13:2c:00","rssi":-68, ``` The subtopic after `home/BTtoMQTT/` is the MAC address of the Bluetooth low energy beacon. The rssi value is the [RSSI signal level](https://www.metageek.com/training/resources/understanding-rssi.html) from which you may deduce the relative distance to the device. -Consider the distance as a beta featuer as currently we are not retrieving the emitting power of the beacon to make it more accurate. +Consider the distance as a beta feature as currently we are not retrieving the emitting power of the beacon to make it more accurate. Note that you can find apps to simulate beacons and do some tests like [Beacon simulator](https://play.google.com/store/apps/details?id=net.alea.beaconsimulator) @@ -67,11 +67,11 @@ OpenMQTTGateway publish the servicedata field of your BLE devices, with HM10 thi ::: ## Setting a white or black list -A black list is a list of mac adresses that will never be published by OMG +A black list is a list of mac addresses that will never be published by OMG to set black list `mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{"black-list":["01:23:14:55:16:15","4C:65:77:88:9C:79","4C:65:A6:66:3C:79"]}'` -A white list is a list of mac adresses permitted to be published by OMG +A white list is a list of mac addresses permitted to be published by OMG to set white list `mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{"white-list":["01:23:14:55:16:15","4C:65:77:88:9C:79","4C:65:A6:66:3C:79"]}'` @@ -126,7 +126,7 @@ If you want to change this characteristic: `mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{"onlysensors":true}'` ::: tip -With Home Assistant, this command is directly avalaible through MQTT auto discovery as a switch into the HASS OpenMQTTGateway device entities list. +With Home Assistant, this command is directly available through MQTT auto discovery as a switch into the HASS OpenMQTTGateway device entities list. ::: The gateway will publish only the detected sensors like Mi Flora, Mi jia, LYWSD03MMC... and not the other BLE devices. This is usefull if you don't use the gateway for presence detection but only to retrieve sensors data. @@ -138,7 +138,7 @@ If you want to change this characteristic: `mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{"bleconnect":false}'` ::: tip -With Home Assistant, this command is directly avalaible through MQTT auto discovery as a switch into the HASS OpenMQTTGateway device entities list. +With Home Assistant, this command is directly available through MQTT auto discovery as a switch into the HASS OpenMQTTGateway device entities list. ::: ## Setting if the gateway publish into Home Assistant Home presence topic @@ -217,15 +217,15 @@ The `ttl` parameter is the number of attempts to connect (defaults to 1), which `value_type` can be one of: STRING, HEX, INT, FLOAT. Default is STRING if omitted in the message. ::: -## Switchbot S1 control (ESP32 only) +## SwitchBot Bot control (ESP32 only) -Switchbot S1 devices are automatically discovered and available as a device in the configuration menu of home assistant. +SwitchBot Bot devices are automatically discovered and available as a device in the configuration menu of home assistant. -::: tip If the switchbot mode is changed the ESP32 must be restarted. ::: +::: tip If the SwitchBot mode is changed the ESP32 must be restarted. ::: The device can also be controlled over MQTT with a simplified BLE write command. -### Example command to set the Switchbot state to ON: +### Example command to set the SwitchBot state to ON: ``` mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoBT/config -m '{ "SBS1":"on", diff --git a/docs/use/boards.md b/docs/use/boards.md index 94588f3..537f155 100644 --- a/docs/use/boards.md +++ b/docs/use/boards.md @@ -24,7 +24,7 @@ OpenMQTTGateway support a low power mode for ESP32, this mode can be set by MQTT ::: 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 automaticaly 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 is published every 2 minutes. +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 is published every 2 minutes. 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 @@ -41,7 +41,7 @@ If you change the default low power mode in config_BT.h to 2 and your credential ### Behaviour -If the connexion of the board to WIFI and MQTT is successfull 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) diff --git a/docs/use/gateway.md b/docs/use/gateway.md index 205d0b5..ef648fa 100644 --- a/docs/use/gateway.md +++ b/docs/use/gateway.md @@ -4,7 +4,7 @@ `mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m '{"cmd":"restart"}'` ::: tip -With Home Assistant, this command is directly avalaible through MQTT auto discovery as a switch into the HASS OpenMQTTGateway device entities list. +With Home Assistant, this command is directly available through MQTT auto discovery as a switch into the HASS OpenMQTTGateway device entities list. ::: ## Erase the ESP settings @@ -12,7 +12,7 @@ With Home Assistant, this command is directly avalaible through MQTT auto discov `mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m '{"cmd":"erase"}'` ::: tip -With Home Assistant, this command is directly avalaible through MQTT auto discovery as a switch into the HASS OpenMQTTGateway device entities list. +With Home Assistant, this command is directly available through MQTT auto discovery as a switch into the HASS OpenMQTTGateway device entities list. ::: ## Retrieve current status of the ESP @@ -20,7 +20,7 @@ With Home Assistant, this command is directly avalaible through MQTT auto discov `mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m '{"cmd":"status"}'` ## Auto discovery -You can deactivate the MQTT auto discovery function, this function enable to create automaticaly devices/entities with Home Assistant convention. +You can deactivate the MQTT auto discovery function, this function enables to automatically create devices/entities with Home Assistant convention. ### Deactivate `mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m '{"discovery":false}'` @@ -77,13 +77,13 @@ mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m }' ``` ::: info -This will change the subscribed and published mqtt_topic/gateway_name that the gateway uses. No parameters are manditory, the current topic or gateway name will be used if not supplied. +This will change the subscribed and published mqtt_topic/gateway_name that the gateway uses. No parameters are mandatory, the current topic or gateway name will be used if not supplied. ::: ## Switching brokers and using self signed and client certificates In the `user_config.h` file it is possible to specify multiple MQTT brokers and client certificates. These are commonly self signed and are supported by defining `MQTT_SECURE_SELF_SIGNED` as true or 1. -Additonally, support for multiple brokers and client certificates has been added. To use this, it is required that the server certificate, client certificate, and client key are provided as their own constatnt string value as demonstrated in the file. +Additionally, support for multiple brokers and client certificates has been added. To use this, it is required that the server certificate, client certificate, and client key are provided as their own constant string value as demonstrated in the file. To add more than one broker and switch between them it is necessary to provide all of the relevant certificates/keys and add their respective variable names in the `certs_array` structure, as shown in `user_config.h`, and changing the array size to the number of different connections -1. To switch between these servers with an MQTT command message, the format is as follows: @@ -111,7 +111,7 @@ To enable this functionality, `MQTT_HTTPS_FW_UPDATE` will need to be defined or ::: tip If using an unsecure MQTT broker it is **highly recommended** to disable the password checking by setting the macro `MQTT_HTTPS_FW_UPDATE_USE_PASSWORD` to 0 (default is 1 (enabled)), otherwise a clear text password may be sent over the network. -The `server_cert` parameter is optional. If the update server has changed or certificate updated or not set in `user_config.h` then you can provide the certifiate here. +The `server_cert` parameter is optional. If the update server has changed or certificate updated or not set in `user_config.h` then you can provide the certificate here. ::: ### Example firmware update message: diff --git a/docs/use/ir.md b/docs/use/ir.md index 5568a1a..913fbf2 100644 --- a/docs/use/ir.md +++ b/docs/use/ir.md @@ -33,7 +33,7 @@ With the IR gateway you need to put on the topic the protocol_name you want to u Exhaustive list [here](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=1910001295) -For example if I want to send a command to a sony TV you can use the following command: +For example if I want to send a command to a Sony TV you can use the following command: `mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoIR -m '{"value":551489775,"protocol_name":"SONY"}'` diff --git a/docs/use/rfm69.md b/docs/use/rfm69.md index 3f1975a..44d7bb3 100644 --- a/docs/use/rfm69.md +++ b/docs/use/rfm69.md @@ -8,7 +8,7 @@ Subscribe to all the messages with mosquitto or open your MQTT client software: ` sudo mosquitto_sub -t +/# -v` -Generate your RF signals with an Moteino on other RFM69 based devices, you will receive : +Generate your RF signals with a Moteino on other RFM69 based devices, you will receive : `home/OpenMQTTGateway/RFM69toMQTT 60,-98,0` diff --git a/docs/use/sensors.md b/docs/use/sensors.md index 738b540..7b575a5 100644 --- a/docs/use/sensors.md +++ b/docs/use/sensors.md @@ -40,7 +40,7 @@ Each sensor will be published under the following topic using each sensors' addr Legacy (removed after release 0.9.5) `home/OpenMQTTGateway/CLIMAtoMQTT/ds1820/0x0000000000000000 {"temp":27.8,"unit":"C","type":"DS18B20","res":"12bit\n","addr":"0x28616411907650bc"}` -The units for temperature readings are sent in Celcius by default can be changed to ferenheight by setting DS1820_FAHRENHEIT = true in in config_DS1820.h +The units for temperature readings are sent in Celsius by default can be changed to Fahrenheit by setting DS1820_FAHRENHEIT = true in in config_DS1820.h If you don't want to resend values that haven't changed you can set DS1820_ALWAYS = false in config_DS1820.h