Skip to content

Commit baf4867

Browse files
mfalkviddtekka007
authored andcommitted
Clarify MY_DEBUG_OTA define (#1331)
This fixes #1330
1 parent 79d7977 commit baf4867

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

MyConfig.h

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -65,19 +65,21 @@
6565

6666
/**
6767
* @def MY_DEBUG_OTA
68-
* @brief Define MY_DEBUG_OTA to redirect debug prints to given node ID
68+
* @brief Define MY_DEBUG_OTA to (nodeID) to redirect debug prints to given node ID
69+
*
70+
* Example: @code #define MY_DEBUG_OTA (0) @endcode will redirect debug prints to node ID 0.
6971
*
7072
* With this option debugging messages over serial are disabled. It's not possible to send debug
7173
* messages generated by the radio. All other debug messages redirected to the given Node ID.
72-
* The debug messages are sent unsigned.
74+
* The debug messages are sent without signing.
7375
*
7476
* This function allocates some additional memory for radio packet preparation and buffering.
7577
* Debug messages are sent to child ID 255 (NODE_SENSOR_ID) as I_LOG_MESSAGE type.
7678
*
77-
* You have to enable the MY_OTA_LOG_RECEIVER_FEATURE on the target node.
79+
* You have to enable the @ref MY_OTA_LOG_RECEIVER_FEATURE on the target node.
7880
* Look into the LogOTAGateway and LogOTANode examples.
7981
*
80-
* The output buffer can be configured via MY_SERIAL_OUTPUT_SIZE
82+
* The output buffer can be configured via @ref MY_SERIAL_OUTPUT_SIZE
8183
* Transport related debugging is disabled when MY_DEBUG_OTA is enabled.
8284
*
8385
*/

0 commit comments

Comments
 (0)