Typo-fixes (#1244)
This commit is contained in:
DigiH authored and GitHub committed
1 parent
612c3f6322
commit
1c62d74e56
19 files changed
+38
-38
No files matched your search
@@ -3,7 +3,7 @@
|
||||
Adding your device protocol to OpenMQTTGateway enable to increase interoperability and to create new use cases with your device. You will find below some guidance to do that.
|
||||
|
||||
## RF or IR
|
||||
For adding RF and IR propotocols to OpenMQTTGateway the best way is to do a pull request to [RCSwitch](https://github.com/1technophile/rc-switch), [Pilight](https://github.com/pilight/pilight) for RF and [IRRemoteESP8266](https://github.com/crankyoldgit/IRremoteESP8266) for IR.
|
||||
For adding RF and IR protocols to OpenMQTTGateway the best way is to do a pull request to [RCSwitch](https://github.com/1technophile/rc-switch), [Pilight](https://github.com/pilight/pilight) for RF and [IRRemoteESP8266](https://github.com/crankyoldgit/IRremoteESP8266) for IR.
|
||||
|
||||
## BLE
|
||||
For BLE devices you can do a pull request directly to the [OpenMQTTGateway](https://github.com/1technophile/OpenMQTTGateway) repository.
|
||||
|
||||
@@ -6,7 +6,7 @@ agree to follow the code of conduct below
|
||||
[code of conduct](https://github.com/1technophile/OpenMQTTGateway/blob/master/CODE_OF_CONDUCT.md)
|
||||
|
||||
[code style guide](https://google.github.io/styleguide/cppguide.html#Formatting)
|
||||
So as to format automaticaly your document you have to add the "clang-Format" extension to VSCode, once done, you can format the code by doing a right click into the code file window and clicking "Format document".
|
||||
So as to format automatically your document you have to add the "clang-Format" extension to VSCode, once done, you can format the code by doing a right click into the code file window and clicking "Format document".
|
||||
|
||||
Fork the [development branch](https://github.com/1technophile/OpenMQTTGateway/tree/development), then clone the repo
|
||||
|
||||
|
||||
@@ -4,5 +4,5 @@ If you like the project and/or used it please consider supporting it! It can be
|
||||
* Helping other users in the [community](https://community.openmqttgateway.com)
|
||||
* [Contribute](development) to the [code](https://github.com/1technophile/OpenMQTTGateway) or the [documentation](https://docs.openmqttgateway.com)
|
||||
* Buy devices, boards or parts from the [compatible web site](https://compatible.openmqttgateway.com), the devices and parts linked use affiliated links.
|
||||
* Donate or sponsor the project [developpers](https://github.com/1technophile/OpenMQTTGateway/graphs/contributors)
|
||||
* Donate or sponsor the project [developers](https://github.com/1technophile/OpenMQTTGateway/graphs/contributors)
|
||||
* Make a video or a blog article about what you have done with [OpenMQTTGateway](https://docs.openmqttgateway.com) and share it.
|
||||
@@ -53,7 +53,7 @@ Setup based on HM10 doesn't support some BLE [devices](devices.md#for-ble-device
|
||||
|
||||
Arduino + ethernet shields enables faster responsiveness of the gateway and a reliable connection.
|
||||
|
||||
The ESP platform is more flexible in term of installation (no need of an ethernet cable) but is less reliable in term of communication. Thanks to its higher memory and processing power it has more modules or possibilities compared to arduino Uno & Mega.
|
||||
The ESP platform is more flexible in term of installation (no need of an ethernet cable) but is less reliable in term of communication. Thanks to its higher memory and processing power it has more modules or possibilities compared to Arduino Uno & Mega.
|
||||
|
||||
Choosing your board depends heavily on the technologies you want to use with it.
|
||||
To have a good overview of the compatibilities per board you can refer to the compatible modules attributes of each [board](https://compatible.openmqttgateway.com/index.php/boards/).
|
||||
|
||||
@@ -11,9 +11,9 @@ There is many choice of brokers, here is some of the most populars:
|
||||
|
||||
This [wikipedia list](https://en.wikipedia.org/wiki/Comparison_of_MQTT_implementations) gives you more details about the different choices you have.
|
||||
This [github list](https://github.com/mqtt/mqtt.github.io/wiki/libraries) seems to be the most exhaustive ones.
|
||||
Here is also some [idea of criterias](https://www.hivemq.com/blog/top-10-mqtt-broker-criteria/) from HiveMQ.
|
||||
Here is also some [ideas of criteria](https://www.hivemq.com/blog/top-10-mqtt-broker-criteria/) from HiveMQ.
|
||||
|
||||
Once your broker installed it can be interesting to see the traffic passing to it and to publish data, so as to do that there is several tools available:
|
||||
Once your broker is installed it can be interesting to see the traffic passing to it and to publish data, so as to do that there are several tools available:
|
||||
* [MQTT Explorer](http://mqtt-explorer.com/)
|
||||
* [HIVE MQ Web client](https://github.com/hivemq/hivemq-mqtt-web-client)
|
||||
* [MQTT FX](https://mqttfx.jensd.de/)
|
||||
|
||||
@@ -5,9 +5,9 @@ The following controllers (and many other software) are compatible with MQTT:
|
||||
|
||||
|
||||
|
||||
OpenMQTTGateway is independant from these projets, you have the liberty of choice among all the compatibles software.
|
||||
OpenMQTTGateway is independent from these projects, you have the liberty of choice among all the compatible software.
|
||||
|
||||
* [OpenHAB2](https://www.openhab.org)
|
||||
* [OpenHAB](https://www.openhab.org)
|
||||
* [Home Assistant](https://www.home-assistant.io)
|
||||
* [Domoticz](https://www.domoticz.com)
|
||||
* [Jeedom](https://www.jeedom.com)
|
||||
|
||||
@@ -75,7 +75,7 @@ Exhaustive list [here](https://compatible.openmqttgateway.com/index.php/devices/
|
||||
|
||||
|
||||
## For infrared IR devices
|
||||
The list of supported devices for ESP is [here](https://github.com/crankyoldgit/IRremoteESP8266/blob/master/SupportedProtocols.md), and [here](https://github.com/1technophile/OpenMQTTGateway/blob/6f73160d1421bebf2c1bbc9b8017978ff5b16520/main/config_IR.h#L123) for Arduino boards, as there is also the possibility of using raw and global caché (ESP) sending possibilities of this gateway is huge!
|
||||
The list of supported devices for ESP is [here](https://github.com/crankyoldgit/IRremoteESP8266/blob/master/SupportedProtocols.md), and [here](https://github.com/1technophile/OpenMQTTGateway/blob/6f73160d1421bebf2c1bbc9b8017978ff5b16520/main/config_IR.h#L123) for Arduino boards, as there is also the possibility of using raw and global cache (ESP) sending possibilities of this gateway is huge!
|
||||
|
||||
## LORA
|
||||
LORA is more dedicated at this moment for tinkering and DIY and there is no Off the shelves devices compatible to my knowledge with this gateway.
|
||||
+1
-1
@@ -29,4 +29,4 @@ Connect the Emitter and Receiver to a 5V supply source, and the ground of your s
|
||||
|
||||
|
||||
## Credits
|
||||
This gateway exists thanks to the work done on [IRRemote](https://github.com/z3t0/Arduino-IRremote) and [IRremoteESP8266](https://github.com/crankyoldgit/IRremoteESP8266) libraries. Thanks for the works of contributors and especialy [@crankyoldgit](https://github.com/crankyoldgit) for its active contributions.
|
||||
This gateway exists thanks to the work done on [IRRemote](https://github.com/z3t0/Arduino-IRremote) and [IRremoteESP8266](https://github.com/crankyoldgit/IRremoteESP8266) libraries. Thanks for the works of contributors and especially [@crankyoldgit](https://github.com/crankyoldgit) for its active contributions.
|
||||
@@ -1,6 +1,6 @@
|
||||
# LORA gateway
|
||||
## Compatible parts
|
||||
An ESP32 board with a LORA module.
|
||||
Idealy a TTGO board with LORA module included see [compatible parts list](https://compatible.openmqttgateway.com/index.php/parts)
|
||||
Ideally a TTGO board with LORA module included see [compatible parts list](https://compatible.openmqttgateway.com/index.php/parts)
|
||||
|
||||
With this kind of board there is no hadware modification needed.
|
||||
With this kind of board there is no hardware modification needed.
|
||||
@@ -11,7 +11,7 @@
|
||||
|GPIO Input|Inputs|-|
|
||||
|GPIO KeyCode|Keycode|[parts list](https://compatible.openmqttgateway.com/index.php/parts)|
|
||||
|INA226|Current and voltage|[parts list](https://compatible.openmqttgateway.com/index.php/parts)|
|
||||
|TSL2561|Luminiosity|[parts list](https://compatible.openmqttgateway.com/index.php/parts)|
|
||||
|TSL2561|Luminosity|[parts list](https://compatible.openmqttgateway.com/index.php/parts)|
|
||||
|
||||
## Pinout
|
||||
|Module|Arduino Pin| ESP8266 Pin|ESP32 Pin|
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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:
|
||||
|
||||
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
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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|-|
|
||||
|
||||
+1
-1
@@ -33,7 +33,7 @@ IOS version >=10 devices advertise without an extra app a mac address, neverthel
|
||||
|
||||
|
||||
## Receiving signals from BLE devices Mi Flora, Mi jia, LYWDS02, LYWSD03MMC, ClearGrass, Mi scale and [many more](https://compatible.openmqttgateway.com/index.php/devices/ble-devices/)
|
||||
So as to receive BLE sensors data you need either a simple ESP32 either an ESP8266/arduino + HM10/11 with firmware >= v601
|
||||
So as to receive BLE sensors data you need either a simple ESP32 either an ESP8266/Arduino + HM10/11 with firmware >= v601
|
||||
The mi flora supported firmware is >3.1.8
|
||||
|
||||
Verify that your sensor is working with the App and update it with the last software version.
|
||||
|
||||
+3
-3
@@ -50,7 +50,7 @@ If you don’t want to use special parameters for IR just use value key, the pro
|
||||
|
||||
`mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoIR -m '{"value":551489775}'`
|
||||
|
||||
NOTE: on arduino Uno most of the protocols are not enable per default due to memory constraints (it is not the case for MEGA), to enable them go to [User_config.h](https://github.com/1technophile/OpenMQTTGateway/blob/master/main/User_config.h) and uncomment the #define corresponding the protocols you want:
|
||||
NOTE: on Arduino Uno most of the protocols are not enable per default due to memory constraints (it is not the case for MEGA), to enable them go to [User_config.h](https://github.com/1technophile/OpenMQTTGateway/blob/master/main/User_config.h) and uncomment the #define corresponding the protocols you want:
|
||||
|
||||
```cpp
|
||||
//#define IR_COOLIX
|
||||
@@ -85,14 +85,14 @@ You should be able to command your devices without having listened with the IR r
|
||||
## Send data by MQTT with advanced IR parameters
|
||||
IR sending support two advanced parameters; bits length and repeat number.
|
||||
|
||||
The example below will send the following advanced parameters bits: 14 and repeat:4 times for a sony protocol:
|
||||
The example below will send the following advanced parameters bits: 14 and repeat:4 times for a Sony protocol:
|
||||
```
|
||||
mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoIR -m '{"value":551489775,"protocol_name":"NEC","repeat":4,"bits":14}'
|
||||
```
|
||||
|
||||
## Send raw IR data by MQTT
|
||||
|
||||
2) If you use an arduino UNO enable `IR_Raw` by uncommenting the line 129 in User_config.h
|
||||
2) If you use an Arduino UNO enable `IR_Raw` by uncommenting the line 129 in User_config.h
|
||||
`#define IR_Raw`
|
||||
If you are using the uno you will have to comment other gateway like ZgatewayRF, ZgatewayBT and ZgatewayIR to keep enough memory
|
||||
|
||||
|
||||
+1
-1
@@ -241,7 +241,7 @@ Once you get the infos publish the parameters with mqtt like that for off:
|
||||
|
||||
for on:
|
||||
|
||||
`mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoRF2 -m "{"unit":0,"groupBit":0,"period":273,"adress":8233228,"switchType":1}"`
|
||||
`mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoRF2 -m "{"unit":0,"groupBit":0,"period":273,"address":8233228,"switchType":1}"`
|
||||
|
||||
## rtl_433 device decoders
|
||||
|
||||
|
||||
+1
-1
@@ -4,7 +4,7 @@ Subscribe to all the messages with mosquitto or open your MQTT client software:
|
||||
` sudo mosquitto_sub -t +/# -v`
|
||||
|
||||
### ADC
|
||||
The value is between 0 and 1024 and is tranmitted via Mqtt when it changes.
|
||||
The value is between 0 and 1024 and is transmitted via Mqtt when it changes.
|
||||
`home/OpenMQTTGateway/ADCtoMQTT {"value":543}`
|
||||
|
||||
### DHT
|
||||
|
||||
Reference in new issue
Block a user