Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Typo fixes #1381

Merged
merged 1 commit into from
Jan 8, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/integrate/home_assistant.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The gateway will need an MQTT username and password, you have to create a new us
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 gateway and sensors into your HASS instance automaticaly.
OMG will use the auto discovery functionality of home assistant to create gateway and sensors into your HASS instance automatically.

![](../img/OpenMQTTGateway_auto_discovery_Gateway_Home_Assistant.gif)

Expand Down
4 changes: 2 additions & 2 deletions docs/integrate/jeedom.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Jeedom is free open-source software. [Jeedom Core](https://doc.jeedom.com/en_US/presentation/index) has multiple functionalities: scenario management, historic visualization, curves/graphics generation, text/speech-based interactions… The clear and intuitive interface allows you to set up a complete solution without development knowledge. And using widgets, views and designs, you can build your own interface.

As a modular system, Jeedom provides a Market where "plugins" are available to handle numerous home automation protocols, answer to specific use cases and provide a higher level of integration between the heterogenous device ecosystem.
As a modular system, Jeedom provides a Market where "plugins" are available to handle numerous home automation protocols, answer to specific use cases and provide a higher level of integration between the heterogeneous device ecosystem.

To be able to use MQTT protocol into Jeedom and decode json payloads, [plugin jMQTT](https://domochip.github.io/jMQTT/) is needed first. Then an OMG device will be integrated, as a Jeedom equipment, and finally a BT device will be integrated, also as an equipment.

Expand Down Expand Up @@ -175,4 +175,4 @@ For example:

This has be made using Open MQTT Gateway v0.9.13, Jeedom Core v4.2.20 and jMQTT plugin v2022-07-25.

The original discution is available on [Jeedom Community](https://community.jeedom.com/t/antenne-bluetooth-avec-un-esp32-open-mqtt-gateway-et-jmqtt/87407) (in French).
The original discussion is available on [Jeedom Community](https://community.jeedom.com/t/antenne-bluetooth-avec-un-esp32-open-mqtt-gateway-et-jmqtt/87407) (in French).
8 changes: 4 additions & 4 deletions docs/integrate/openhab2.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ You should have an MQTT broker installed (either mosquitto or the OpenHAB2 embed

In paper UI
* In bindings add the MQTT Things binding
* Inbox > MQTT Things binding > Add manualy >MQTT Broker : configure your borker
* Inbox > MQTT Things binding > Add manualy >Generic MQTT Thing : select your previously configured broker as a bridge and enter your thing definition (example RF plug, weather station, PIR sensor)
* Inbox > MQTT Things binding > Add manually >MQTT Broker : configure your broker
* Inbox > MQTT Things binding > Add manually >Generic MQTT Thing : select your previously configured broker as a bridge and enter your thing definition (example RF plug, weather station, PIR sensor)
* Configuration > Things > "Your thing" : click on + and add one channel for each thing parameter (example for a weather station, you will have one channel for the temperature, one channel for the humidity etc..)
* For a state channel define the MQTT topic like this:

Expand All @@ -42,7 +42,7 @@ In paper UI
* Repeat for each channels and each things
* Configuration > Things > "Your thing" : click on a channel and add 1 or several items per channel defining what you want to display in the sitemap
or
* Define your items in an item file like this by refering to your MQTT things channels:
* Define your items in an item file like this by referring to your MQTT things channels:
For a mi flora and mi jia

```java
Expand Down Expand Up @@ -80,7 +80,7 @@ Number lux_P "Luminiosité plante[%.1f lux]" {channel="mqtt:topic:

* Configuration > Things > "Your thing" : click on a channel and add 1 or several switch per channel
or
* Define your items in an item file like this by refering to your MQTT thing channel:
* Define your items in an item file like this by referring to your MQTT thing channel:

`Switch OMGSwitch "Prise 1" <poweroutlet> {channel="mqtt:topic:08998877:Power1"}`

Expand Down
2 changes: 1 addition & 1 deletion docs/integrate/openhab3.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Integrate OPENHAB3

This tutorial will show how to integrate the BLE gateway to OpenHAB3 leveraging the auto discovery functionnality.
This tutorial will show how to integrate the BLE gateway to OpenHAB3 leveraging the auto discovery functionality.
After this tutorial, you should see your Bluetooth Low Energy devices in OpenHAB3 without any file based manual configuration.

## Prerequisites
Expand Down
2 changes: 1 addition & 1 deletion docs/prerequisites/broker.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ The broker will act as an intermediary between OpenMQTTGateway and your [control

All the events or commands could pass by the broker.

There is many choice of brokers, here is some of the most populars:
There are many choices of brokers, here are some of the most popular:
* [Mosquitto](https://mosquitto.org/) (Open source)
* [Moquette](https://moquette-io.github.io/moquette/) (Open source)
* [HiveMQ](https://www.hivemq.com/hivemq/features/)
Expand Down
2 changes: 1 addition & 1 deletion docs/setitup/rs232.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
## Compatible parts
|Module|Purpose|Where to Buy|
|-|-|-|
|TTL to RS232 module|Transcieving|-|
|TTL to RS232 module|Transceiving|-|


Any module using a MAX232 chip will work. Don't pay extra to get all the signals, we're only using RX and TX.
Expand Down
2 changes: 1 addition & 1 deletion docs/use/ble.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ If you want to change this characteristic:
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.
The gateway will publish only the detected sensors like Mi Flora, Mi jia, LYWSD03MMC... and not the other BLE devices. This is useful if you don't use the gateway for presence detection but only to retrieve sensors data.

## Setting if the gateway use active or passive scanning

Expand Down
4 changes: 2 additions & 2 deletions docs/use/boards.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ The same behaviour apply to M5StickC and M5StickC Plus

### Setting the log output

Per default the log of the M5 boards is going to the LCD display with Errors and Warnings only, if you want to change the ouput at build time you can do it in [config_M5.h](https://github.com/1technophile/OpenMQTTGateway/blob/development/main/config_M5.h).
Per default the log of the M5 boards is going to the LCD display with Errors and Warnings only, if you want to change the output at build time you can do it in [config_M5.h](https://github.com/1technophile/OpenMQTTGateway/blob/development/main/config_M5.h).

You can also change it by MQTT. For example if you want to set to LCD

Expand Down Expand Up @@ -85,7 +85,7 @@ If you are already in low power mode 1 or 2 with M5Stack you can wake up the boa

### Setting the log output

Per default the log of the SSD1306 Display boards is going to the LCD display with Errors and Warnings only, if you want to change the ouput at build time you can do it with the compiler directive `-DLOG_LEVEL_LCD=LOG_LEVEL_NOTICE`.
Per default the log of the SSD1306 Display boards is going to the LCD display with Errors and Warnings only, if you want to change the output at build time you can do it with the compiler directive `-DLOG_LEVEL_LCD=LOG_LEVEL_NOTICE`.

You can also change it by MQTT. For example if you want to set to LCD

Expand Down
4 changes: 2 additions & 2 deletions main/ZgatewayBT.ino
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ void BTConfig_update(JsonObject& data, const char* key, T& var) {
}

void BTConfig_fromJson(JsonObject& BTdata, bool startup = false) {
// Attempts to connect to elligible devices or not
// Attempts to connect to eligible devices or not
BTConfig_update(BTdata, "bleconnect", BTConfig.bleConnect);
// Scan interval set
if (BTdata.containsKey("interval") && BTdata["interval"] != 0)
Expand Down Expand Up @@ -221,7 +221,7 @@ void BTConfig_load() {
return;
}
JsonObject jo = jsonBuffer.as<JsonObject>();
BTConfig_fromJson(jo, true); // Never send mqtt message with config
BTConfig_fromJson(jo, true); // Never send MQTT message with config
Log.notice(F("BT config loaded" CR));
}

Expand Down
6 changes: 3 additions & 3 deletions main/ZgatewayRTL_433.ino
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ void launchRTL_433Discovery(bool overrideDiscovery) {
"", "", (char*)value_template.c_str(), //set availability_topic,device_class,value_template,
"1", "0", parameters[i][2], //set,payload_on,payload_off,unit_of_meas,
0, //set off_delay
"", "", false, "", //set,payload_avalaible,payload_not avalaible ,is a gateway entity, command topic
"", "", false, "", //set,payload_available,payload_not available ,is a gateway entity, command topic
(char*)idWoKey.c_str(), "", pdevice->modelName, (char*)idWoKey.c_str(), false, // device name, device manufacturer, device model, device ID, retain
"" //State Class
);
Expand All @@ -157,7 +157,7 @@ void launchRTL_433Discovery(bool overrideDiscovery) {
"", "", (char*)value_template.c_str(), //set availability_topic,device_class,value_template,
"1", "0", parameters[i][2], //set,payload_on,payload_off,unit_of_meas,
0, //set off_delay
"", "", false, "", //set,payload_avalaible,payload_not avalaible ,is a gateway entity, command topic
"", "", false, "", //set,payload_available,payload_not available ,is a gateway entity, command topic
(char*)idWoKey.c_str(), "", pdevice->modelName, (char*)idWoKey.c_str(), false, // device name, device manufacturer, device model, device ID, retain
stateClassTotalIncreasing //State Class
);
Expand All @@ -167,7 +167,7 @@ void launchRTL_433Discovery(bool overrideDiscovery) {
"", "", (char*)value_template.c_str(), //set availability_topic,device_class,value_template,
"", "", parameters[i][2], //set,payload_on,payload_off,unit_of_meas,
0, //set off_delay
"", "", false, "", //set,payload_avalaible,payload_not avalaible ,is a gateway entity, command topic
"", "", false, "", //set,payload_available,payload_not available ,is a gateway entity, command topic
(char*)idWoKey.c_str(), "", pdevice->modelName, (char*)idWoKey.c_str(), false, // device name, device manufacturer, device model, device ID, retain
stateClassMeasurement //State Class
);
Expand Down
Loading