Skip to content

Commit

Permalink
Clarify MY_DEBUG_OTA define (#1331)
Browse files Browse the repository at this point in the history
This fixes #1330
  • Loading branch information
mfalkvidd authored and tekka007 committed Aug 1, 2019
1 parent 79d7977 commit baf4867
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions MyConfig.h
Original file line number Diff line number Diff line change
Expand Up @@ -65,19 +65,21 @@

/**
* @def MY_DEBUG_OTA
* @brief Define MY_DEBUG_OTA to redirect debug prints to given node ID
* @brief Define MY_DEBUG_OTA to (nodeID) to redirect debug prints to given node ID
*
* Example: @code #define MY_DEBUG_OTA (0) @endcode will redirect debug prints to node ID 0.
*
* With this option debugging messages over serial are disabled. It's not possible to send debug
* messages generated by the radio. All other debug messages redirected to the given Node ID.
* The debug messages are sent unsigned.
* The debug messages are sent without signing.
*
* This function allocates some additional memory for radio packet preparation and buffering.
* Debug messages are sent to child ID 255 (NODE_SENSOR_ID) as I_LOG_MESSAGE type.
*
* You have to enable the MY_OTA_LOG_RECEIVER_FEATURE on the target node.
* You have to enable the @ref MY_OTA_LOG_RECEIVER_FEATURE on the target node.
* Look into the LogOTAGateway and LogOTANode examples.
*
* The output buffer can be configured via MY_SERIAL_OUTPUT_SIZE
* The output buffer can be configured via @ref MY_SERIAL_OUTPUT_SIZE
* Transport related debugging is disabled when MY_DEBUG_OTA is enabled.
*
*/
Expand Down

0 comments on commit baf4867

Please sign in to comment.