Skip to content

Commit

Permalink
add reference to new config macro in checkConnection() doc.
Browse files Browse the repository at this point in the history
  • Loading branch information
2bndy5 committed Jun 28, 2024
1 parent 458e964 commit 8c494ae
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions RF24Mesh.h
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,13 @@ class ESBMesh
/**
* Tests connectivity of this node to the mesh.
* @note If this function fails, address renewal should typically be done.
*
* The current behavior will only ping this node's parent to validate connection to mesh.
* Previously, this function would validate connection by looking up this node's assigned address with
* the master node's `RF24Mesh::addrList`.
* The old behavior can be mandated by changing @ref RF24MESH_CONN_CHECK_TYPE in RF24Mesh_config.h,
* although a large mesh network might suffer a performance cost using the old behavior.
*
* @return
* - True if connected.
* - False if not connected, mesh is not responding, or this node is the master node.
Expand Down

0 comments on commit 8c494ae

Please sign in to comment.