* Fix cppcheck issues
Fixes the following cppcheck issues:
examples/SecretKnockSensor/SecretKnockSensor.ino
305 variableScope 398 style
The scope of the variable 'timeDiff' can be reduced.
examples/SensebenderGatewaySerial/SensebenderGatewaySerial.ino
127 variableScope 398 style
The scope of the variable 'led_state' can be reduced.
* Doxygenize MyMessage / Message manipulation
This should replace the static documentation at
http://korturl.nu/stupid
I have enabled existing comments and added new comments where
necessary. Feedback on syntax and contents is welcome.
Fixes the following cppcheck issues:
examples/SecretKnockSensor/SecretKnockSensor.ino
305 variableScope 398 style
The scope of the variable 'timeDiff' can be reduced.
examples/SensebenderGatewaySerial/SensebenderGatewaySerial.ino
127 variableScope 398 style
The scope of the variable 'led_state' can be reduced.
The guide we are referring to
( https://chris.beams.io/posts/git-commit/ )
says:
shoot for 50 characters, but consider 72 the hard limit
so let Gitler consider 72 the hard limit (instead of 50).
This log message makes the Serial gateway print the serial port path,
similar to how the Ethernet gateway prints IP and port.
Example log output:
mysgw: Serial port /dev/MyCoolTTY (115200 baud) created
As mentioned by per1234 in
https://github.com/mysensors/MySensors/pull/1008
we should make it easier to find the full code contribution
guidelines.
Since we have multiple git repos, we don't want to duplicate the
guidelines in each repo. Instead, we link to the canonical source
on mysensors.org.
* Add MY_DEBUGDEVICE to redirect debug output
MY_DEBUGDEVICE, if defined, will replace MY_SERIALDEVICE
for the purpose of printing debug messages. This only
applies to debugging.
Documentation is now generated by invoking a shell script
which takes care of all the plumbing.
There is now also support of inlineing PlantUML syntax with
Doxygen. This inlining takes the form of
@startuml{imagename.png}
'PlantUML specific syntax'
@enduml
The inlineing can be made in C syntax comment blocks.
Doxygen will then include the generated UML diagram when
rendering the HTML documentation.
All generated images will be placed under Documentation/img
which is the default search path for Doxygen.
As discussed in
http://korturl.nu/gitler-is-a-stubborn-bastard-1
and numerous other forum threads, many people don't understand
that id generation is done by the controller.
Many new users start out their first MySensors network with a
gateway, a single sensor node and no controller. Since MySensors
defaults to AUTO node id, the node gets stuck on TSM:ID:FAIL,
like this:
TSM:ID
TSM:ID:REQ
TSF:MSG:SEND,255-255-0-0,s=255,c=3,t=3,pt=0,l=0,sg=0,ft=0,st=OK:
TSM:ID
TSM:ID:REQ
TSF:MSG:SEND,255-255-0-0,s=255,c=3,t=3,pt=0,l=0,sg=0,ft=0,st=OK:
TSM:ID
TSM:ID:REQ
TSF:MSG:SEND,255-255-0-0,s=255,c=3,t=3,pt=0,l=0,sg=0,ft=0,st=OK:
TSM:ID
TSM:ID:REQ
TSF:MSG:SEND,255-255-0-0,s=255,c=3,t=3,pt=0,l=0,sg=0,ft=0,st=OK:
!TSM:ID:FAIL
This change adds a clarifying note about the controller in the
doxygen documentation.
* Fix bug with toll-gate validation against master
* Change cppcheck to not attempt to validate headers directly and
to run on the entire codebase in the pipeline.
* Support running Arduino test and examples build in parallel