Documentation update (#723)
-add JQJCY01YM -add protocol add guidelines -minor changes
This commit is contained in:
1 parent
da63fd3606
commit
519eb73dee
6 files changed
+25
-10
No files matched your search
@@ -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.
|
||||
|
||||
@@ -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
|
||||
@@ -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.
|
||||
Reference in new issue
Block a user