Commit Graph
24 Commits
Author SHA1 Message Date
Mikael Falkvidd 0b9af6d713 Update cast in msg.set (#1130)
A while ago, MySensors changed to use int32_t
instead of long int (and similar for other data
types). This change was not applied to all examples,
causing some examples to fail compilation for
ESP8266 with the following message:

call of overloaded 'set(long int)' is ambiguous

This update changes the casts to match the new style.
This fixes
https://github.com/mysensors/MySensors/issues/1129
Thanks to https://github.com/henfri for reporting.
2018-05-14 21:32:11 +02:00
Mikael Falkvidd e0988e6d9e Add more missing keywords (#1111)
This fixes
https://github.com/mysensors/MySensors/issues/1089
and also adds Doxygen and syntax highlighting
for the following keywords:
MY_GATEWAY_MQTT_CLIENT
MY_GATEWAY_SERIAL
MY_IP_GATEWAY_ADDRESS
MY_IP_SUBNET_ADDRESS
MY_MQTT_CLIENT_ID
MY_MQTT_PUBLISH_TOPIC_PREFIX
MY_MQTT_SUBSCRIBE_TOPIC_PREFIX
2018-04-10 20:22:39 +02:00
Mikael Falkvidd a8429868e7 Clarify default defines (#1106)
Moved example values after the @brief portion of Doxygen,
so the default (empty/undefined) values are visible
in Doxygen.
2018-04-10 14:58:11 +02:00
Mikael Falkvidd df1bb7fcc5 Add Doxygen for MQTT_USER and MQTT_PASSWORD (#1105)
This fixes
https://github.com/mysensors/MySensors/issues/1088
2018-04-10 07:56:17 +02:00
Mikael Falkvidd f2d9f72cf4 Fix spelling mistakes (#1104) 2018-04-09 23:31:50 +02:00
Mikael Falkvidd bb80732ead Add keywords that already have Doxygen (#1108)
Found some keywords that already have Doxygen comments
but were not present in keywords.txt
2018-04-09 23:27:19 +02:00
Mikael Falkvidd d1aa419efe Remove faulty wiring instructions from ESP gateways (#1100)
This fixes
https://github.com/mysensors/MySensors/issues/1096

https://www.mysensors.org/build/connect_radio
has been updated to include GPIOn instructions
(in addition to the existing Dn instructions).

Thanks to RWoerz for reporting this discrepancy.

Also, the "barebone" boot wiring has been moved to
http://bit.do/stupidurl
2018-04-07 10:42:52 +02:00
Mikael Falkvidd 9809eb6270 Add missing keywords 2 (#1087)
* Add missing keywords and blacklist

These keywords already exist in Doxygen and should be highlighted
in the Arduino IDE.

Some keywords should not be highlighed and are therefore added
to the blacklists at end of keywords.txt

* Sort keywords in each section

* Add blacklist of MY_MQTT_TOPIC_PREFIX
2018-04-05 22:25:05 +02:00
Mikael Falkvidd 06f8d2b7e5 Add detection of missing keywords to gitler (#1085) 2018-03-22 08:26:27 +01:00
Mikael Falkvidd c9c461846a Add missing keywords (#1084)
A blacklist is available at the end of keywords.txt

I decided to blacklist all the LINUX keywords. I guess people
could use the Arduino IDE to edit the sketch for the raspberry
pi gateway, but I'm not sure we should encourage that.

I'll add gitler support for auto-detecting missing keywords
in a separate PR.
2018-03-21 15:08:02 +01:00
Mikael Falkvidd 7a33082eaf Simplify doxygen for ./configure (#1080)
No need to grep when we have a command that outputs
exactly what we want.
2018-03-12 11:47:39 +01:00
Mikael Falkvidd 599c0bada6 ESP8266 Gateway examples: clarify inclusion pin (#1065)
The comment for inclusion mode pin and the definition of
MY_INCLUSION_MODE_BUTTON_PIN did not match.

GPIO5 should be safe to use, while GPIO3 is used for the
UART which might result in conflict.

This fixes
https://github.com/mysensors/MySensors/issues/993
2018-02-22 12:04:03 +01:00
Mikael Falkvidd 8fbdca4452 Doxygenize MyMessage / Message manipulation (#1035)
* 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.
2018-01-30 20:47:11 +01:00
Mikael Falkvidd 06269dd949 Fix cppcheck issues (#1036)
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.
2018-01-28 09:31:19 +01:00
Mikael Falkvidd 467b7e000a Add MY_INCLUSION_LED_PIN (#1030)
Thanks to @TokTias for this idea and a starting point for the code.

This PR replaces https://github.com/mysensors/MySensors/pull/1029
2018-01-23 10:26:01 +01:00
Mikael Falkvidd d9059d7bd5 Relax Gitler on commit headline length (#1031)
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).
2018-01-19 17:52:07 +01:00
Mikael Falkvidd ca73ae20d6 Linux/SerialPort: Log success message (#1021)
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
2018-01-07 14:52:08 +01:00
Mikael Falkvidd 27b0177d26 Update reference to Code Contribution Guidelines (#1011)
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.
2017-12-09 10:08:43 +01:00
Mikael Falkvidd 506d23581d Update RelayActuator example (#973)
Based on feedback from skywatch,
https://forum.mysensors.org/post/78896

We'll need to update the wiring instructions on
https://www.mysensors.org/build/relay as well.
2017-11-17 21:18:15 +01:00
Mikael Falkvidd 1e3305959e BCM driver: include inttypes (#983)
This makes it possible to compile the Raspberry Pi gateway on
Raspbian 9 (stretch), even without adding
--extra-cxxflags="-D__STDC_FORMAT_MACROS"
(as was suggested in
https://github.com/mysensors/MySensors/issues/955 but was
insufficient for remediating this problem)

The compile problem was inadvertently introduced in
2d5404de9.

This change fixes the problem discussed in
https://github.com/mysensors/MySensors/issues/980
2017-11-17 21:16:01 +01:00
Mikael Falkvidd a23ab14494 Clarify TSM:ID:FAIL message (#984)
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.
2017-11-11 10:41:09 +01:00
Mikael Falkvidd 3ebeb4fea1 Add MY_ESP8266_BSSID parameter (#953)
To use this feature, add the following to a sketch, for example
GatewayESP8266MQTTClient:
  const uint8_t bssid[] = {0x00, 0xDE, 0xAD, 0xBE, 0xEF, 0x00};
  #define MY_ESP8266_BSSID bssid

This feature was requested in
https://github.com/mysensors/MySensors/issues/947
2017-10-27 18:52:21 +02:00
Mikael Falkvidd adfd9f36f1 Generate Doxygen from configure (#952)
* Generate Doxygen from configure

Use case: view the ./configure help text on the web.
This has been requested in
https://forum.mysensors.org/post/77751

Manually putting the help text in the forum or on mysensors.org
would lead to diverging documentation, no version management and
extra maintenance burden. This commit attempts to auto-generate
the documentation and use existing Doxygen infrastructure to
add the help text to the rest of the MySensors documentation.
2017-10-27 18:39:25 +02:00
Mikael Falkvidd a941827157 Use bool instead of boolean in drivers (#888)
In the Arduino IDE, boolean is an alias for bool.
The Arduino IDE might deprecate boolean in the future. See
https://github.com/arduino/Arduino/issues/4673 for details.

Command:
find drivers -type f | xargs sed -i 's/boolean/bool/g'
2017-07-05 16:23:27 +02:00