added GitHub Actions to documentation
This commit is contained in:
1 parent
1e10783a28
commit
95a3f8e0b6
8 files changed
+121
-93
No files matched your search
@@ -3,7 +3,7 @@
|
||||
I 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 of conduct](https://github.com/1technophile/OpenMQTTGateway/blob/master/CODE_OF_CONDUCT.md)
|
||||
|
||||
[code style guide](https://google.github.io/styleguide/cppguide.html#Formatting)
|
||||
|
||||
@@ -16,7 +16,7 @@ Make your modification,
|
||||
|
||||
Review your code, compile it for Arduino Uno and ESP8266
|
||||
|
||||
Test it localy on your hardware config
|
||||
Test it locally on your hardware config
|
||||
|
||||
If you modify `User_config.h` during your developments you need to report your modifications into Test_config.h
|
||||
https://github.com/1technophile/OpenMQTTGateway/blob/master/tests/Test_config.h
|
||||
@@ -25,7 +25,7 @@ Indeed during the continuous integration process `User_config.h` is replaced by
|
||||
|
||||
Emit a pull request
|
||||
|
||||
Verify the travis CI compilation results
|
||||
Verify the GitHub Actions CI compilation results
|
||||
|
||||
Request for review
|
||||
|
||||
|
||||
@@ -1,8 +1,10 @@
|
||||
# Troubleshooting
|
||||
|
||||
## Compilation/build error
|
||||
This badge [](https://travis-ci.com/1technophile/OpenMQTTGateway) show you the state of the compilation of the master and this one [](https://travis-ci.com/1technophile/OpenMQTTGateway) for the development branch. If you see a green badge this means that the code compilation is OK with the configuration given in the docs/platformio.ini. Check your IDE environment version, boards version, libraries version before submitting an issue or a question.
|
||||
Verify especially that the libraries provided into the [the release page](https://github.com/1technophile/OpenMQTTGateway/releases) are located into your "sketchbook folder"/libraries if your are using the Arduino IDE.
|
||||
This badge [](https://github.com/1technophile/OpenMQTTGateway/actions?query=branch%3Amaster+workflow%3ABuild) show you the state of the compilation of the master and this one [](https://github.com/1technophile/OpenMQTTGateway/actions?query=branch%3Adevelopment+workflow%3ABuild) for the development branch.
|
||||
If you see a green badge this means that the code compilation is OK with the configuration given in the `docs/platformio.ini`.
|
||||
Check your IDE environment version, boards version, libraries version before submitting an issue or a question.
|
||||
Verify especially that the libraries provided into the [release page](https://github.com/1technophile/OpenMQTTGateway/releases) are located into your "sketchbook folder"/libraries if your are using the Arduino IDE.
|
||||
|
||||
## ESP32 compilation errors related to wifi
|
||||
If you get one or several of the following errors:
|
||||
@@ -29,10 +31,10 @@ Regarding the IR led emitter you can replace it with a normal led and see if it
|
||||
|
||||
try with D2 instead of D3
|
||||
and put
|
||||
define RF_RECEIVER_PIN 4 // D2 on nodemcu
|
||||
`#define RF_RECEIVER_PIN 4 // D2 on nodemcu`
|
||||
in config_rf.h
|
||||
instead of
|
||||
define RF_RECEIVER_PIN 0 // D3 on nodemcu
|
||||
`#define RF_RECEIVER_PIN 0 // D3 on nodemcu`
|
||||
|
||||
## Exception seen on serial monitor:
|
||||
Hey I got a callback
|
||||
|
||||
Reference in new issue
Block a user