Documentation update (#723)

-add JQJCY01YM
-add protocol add guidelines
-minor changes

docs/.vuepress/config.js

@@ -98,6 +98,7 @@ module.exports = {
           children: [
             'participate/support',
             'participate/development',
+            'participate/adding-protocols',
             'participate/community',
             ['https://github.com/1technophile/OpenMQTTGateway/blob/development/LICENSE.txt','License']
           ]

docs/participate/adding-protocols.md

@@ -0,0 +1,12 @@
+# Adding protocols
+
+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.
+
+## BLE
+For BLE devices you can do a pull request directly to the [OpenMQTTGateway](https://github.com/1technophile/OpenMQTTGateway) repository.
+
+Currently we support the reading of advertizing BLE devices, advertizing means that the BLE device broadcast regularly its sensor data without the need of a BLE connection.
+

docs/participate/development.md

@@ -1,12 +1,12 @@
 # Development contributions
 
-I like pull requests from everyone. By participating in this project, you
+We like pull requests from everyone. By participating in this project, you
 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 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".
 
 Fork the [development branch](https://github.com/1technophile/OpenMQTTGateway/tree/development), then clone the repo
 
@@ -15,7 +15,7 @@ Make your modification,
 * If you want to add a new sensor, name it `ZsensorYYY`, `YYY` replaced by your sensor type, can be more than three letters
 * If you want to add a new actuator, name it `ZactuatorZZZ`, `ZZZ` replaced by your actuator type, can be more than three letters
 
-Review your code, compile it for Arduino Uno and ESP8266
+Review your code, compile it for Arduino Uno, ESP32 and ESP8266
 
 Test it locally on your hardware config
 
@@ -25,11 +25,11 @@ Verify the GitHub Actions CI compilation results
 
 Request for review
 
-I may suggest some changes or improvements or alternatives.
+We may suggest some changes, improvements or alternatives.
 
 Some things that will increase the chance that your pull request is accepted:
-* Comment your code
-* Ask eventually for design guidelines
+* Comment your code,
+* Ask eventually for design guidelines,
 * Write a [good commit message][commit].
 
 [commit]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html

docs/participate/support.md

@@ -3,4 +3,4 @@ If you like the project and/or used it please consider supporting it! It can be
 * [Contribute](development) to the [code](https://github.com/1technophile/OpenMQTTGateway) or the [documentation](https://docs.openmqttgateway.com)
 * Buy devices or parts from the [devices list](https://docs.google.com/spreadsheets/u/1/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=2126158079=), the devices and parts linked use affiliated links.
 * Donate or sponsor the project [developpers](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)
+* Make a video or a blog article about what you have done with [OpenMQTTGateway](https://docs.openmqttgateway.com) and share it.

docs/prerequisites/devices.md

@@ -21,6 +21,7 @@ OpenMQTTGateway is able to scan all the BLE devices that advertise their data so
 | XIAOMI Mi Flora |HHCCJCY01HHCC|temperature/moisture/luminance/fertility|
 | XIAOMI Mi Jia |LYWSDCGO|temperature/humidity/battery|
 | XIAOMI Mi Lamp |MUE4094RT|presence|
+| HONEYWELL |JQJCY01YM|formaldehyde/temperature/humidity/battery|
 | INKBIRD *|IBS-TH1|temperature/humidity/battery|
 | ClearGrass |CGG1|temperature/humidity/battery|
 | ClearGrass alarm clock|CGD1|temperature/humidity|

docs/upload/pio.md

@@ -25,12 +25,12 @@ default_envs = esp32dev-rf
 ;default_envs = ttgo-lora32-v1
 ```
 
-If you don't know which env to activate you can refer to [devices](../prerequisites/devices).
+If you don't know which `env` to activate you can refer to [devices](../prerequisites/devices).
 
-The different listed configurations represents some standard environments, to overload them with special parameters or modules you can modify the config files. The definitions coming from [platformio.ini](https://github.com/1technophile/OpenMQTTGateway/blob/development/platformio.ini) file and config files are cumulative.
+The different listed configurations represents some standard environments and boards, to overload them with special parameters or modules you can modify the config files ([config_RF.h](https://github.com/1technophile/OpenMQTTGateway/blob/development/main/config_RF.h) for example). The definitions coming from [platformio.ini](https://github.com/1technophile/OpenMQTTGateway/blob/development/platformio.ini) file and config files are cumulative.
 The main config file is [User_config.h](https://github.com/1technophile/OpenMQTTGateway/blob/development/main/User_config.h), added to it you have one config file per gateway, sensor or actuator, you will find them in the [main](https://github.com/1technophile/OpenMQTTGateway/tree/development/main) folder.
 
-If you want to add more sensors or gateways to one `default_envs` you can uncomment them into [User_config.h](https://github.com/1technophile/OpenMQTTGateway/blob/d2dd6138558909b71cc44f69665340247bd5f356/main/User_config.h#L84) or add the modules directly into your environment definition of your .ini files.
+If you want to add more sensors or gateways to one `default_envs` you can add the modules directly into your environment definition of your .ini files or uncomment them into [User_config.h](https://github.com/1technophile/OpenMQTTGateway/blob/d2dd6138558909b71cc44f69665340247bd5f356/main/User_config.h#L84).
 
 Example to add IR to `esp32dev-rf` add the `build_flags` below to the env definition:
 ``` ini
@@ -68,6 +68,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.
 
 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:
 ```