Skip to content

Commit

Permalink
Bump the rf24-submodules group across 1 directory with 3 updates (#75)
Browse files Browse the repository at this point in the history 
* Bump the rf24-submodules group across 1 directory with 3 updates

Bumps the rf24-submodules group with 3 updates in the / directory: [RF24](https://github.com/nRF24/RF24), [RF24Network](https://github.com/nRF24/RF24Network) and [RF24Mesh](https://github.com/nRF24/RF24Mesh).


Updates `RF24` from `0aac3d5` to `bbffb50`
- [Release notes](https://github.com/nRF24/RF24/releases)
- [Commits](nRF24/RF24@0aac3d5...bbffb50)

Updates `RF24Network` from `219d055` to `bdd05ae`
- [Release notes](https://github.com/nRF24/RF24Network/releases)
- [Commits](nRF24/RF24Network@219d055...bdd05ae)

Updates `RF24Mesh` from `8f030b4` to `2f5aea2`
- [Release notes](https://github.com/nRF24/RF24Mesh/releases)
- [Commits](nRF24/RF24Mesh@8f030b4...2f5aea2)

---
updated-dependencies:
- dependency-name: RF24
  dependency-type: direct:production
  dependency-group: rf24-submodules
- dependency-name: RF24Network
  dependency-type: direct:production
  dependency-group: rf24-submodules
- dependency-name: RF24Mesh
  dependency-type: direct:production
  dependency-group: rf24-submodules
...

Signed-off-by: dependabot[bot] <[email protected]>

* expose binding for new releaseAddress() overload

For master nodes only

* [CMake] add support for new flags

- support RF24MESH_CONN_CHECK_TYPE flag
- support MESH_CONNECTION_CHECK_ATTEMPTS flag

also reviewed using_flags.cmake script

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Brendan <[email protected]>
  • Loading branch information
@dependabot @2bndy5
dependabot[bot] and 2bndy5 authored Jul 5, 2024
1 parent 616cd35 commit 5f740ab
Show file tree
Hide file tree
Showing 6 changed files with 83 additions and 28 deletions.
2 changes: 1 addition & 1 deletion RF24
Submodule RF24 updated 10 files
+1 −1 .github/workflows/doxygen.yml
+6 −2 COMMON_ISSUES.md
+102 −43 docs/doxygen-custom.css
+4 −5 examples_linux/acknowledgement_payloads.py
+4 −5 examples_linux/getting_started.py
+4 −5 examples_linux/interrupt_configure.py
+4 −5 examples_linux/manual_acknowledgements.py
+4 −5 examples_linux/multiceiver_demo.py
+6 −0 examples_linux/scanner.py
+4 −5 examples_linux/streaming_data.py
2 changes: 1 addition & 1 deletion RF24Mesh
Submodule RF24Mesh updated 12 files
+2 −0 .github/workflows/build_arduino.yml
+1 −1 .github/workflows/doxygen.yml
+3 −4 CMakeLists.txt
+49 −10 RF24Mesh.cpp
+22 −1 RF24Mesh.h
+29 −0 RF24Mesh_config.h
+22 −20 cmake/AutoConfig_RF24_DRIVER.cmake
+102 −43 docs/doxygen-custom.css
+5 −11 examples_RPi/CMakeLists.txt
+10 −14 examples_RPi/ncurses/RF24Mesh_Ncurses_Master.cpp
+30 −5 pyRF24Mesh/pyRF24Mesh.cpp
+0 −1 pyRF24Mesh/setup.py
2 changes: 1 addition & 1 deletion RF24Network
Submodule RF24Network updated 12 files
+1 −1 .github/workflows/doxygen.yml
+0 −5 CMakeLists.txt
+3 −1 RF24Network.cpp
+1 −1 RF24Network.h
+6 −6 RF24Network_config.h
+22 −20 cmake/AutoConfig_RF24_DRIVER.cmake
+6 −0 docs/addressing.md
+2 −0 docs/advanced_config.md
+102 −43 docs/doxygen-custom.css
+2 −1 docs/main_page.md
+26 −11 docs/tuning.md
+5 −11 examples_RPi/CMakeLists.txt
58 changes: 39 additions & 19 deletions cmake/using_flags.cmake
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,16 @@ option(RF24MESH_DEBUG_MINIMAL "enable/disable minimal debugging output for RF24M

# ### options with default values:

# RF24MESH_CONN_CHECK_TYPE
# This can be used to control how RF24Mesh.check_connection() behaves.
# By default, check_connection() will simply ping the parent node (if any).
# Setting this to RF24MESH_CONN_CHECK_MASTER will resort to the old behavior
# which verified the assigned address with the master node.
# It is recommended that this be left as default for large mesh networks.

# MESH_CONNECTION_CHECK_ATTEMPTS
# the number of attempts to check_connection() with the mesh. Defaults to 3

# MESH_MAX_CHILDREN
# This can be used to prevent mesh child nodes from occupying all available pipes on network layers.
# Only recommended if combining RF24Network nodes w/ RF24Mesh nodes on the same network.
Expand Down Expand Up @@ -65,99 +75,109 @@ option(RF24MESH_DEBUG_MINIMAL "enable/disable minimal debugging output for RF24M
function(apply_flags target)
# apply RF24 flags to cpp_rf24 target
if(RF24_DEBUG)
message(STATUS "RF24_DEBUG asserted for ${target}")
target_compile_definitions(${target} PUBLIC SERIAL_DEBUG)
message(STATUS "RF24_DEBUG asserted")
target_compile_definitions(${target} PUBLIC RF24_DEBUG)
endif()

# pass driver used to expose as a constant in rf24 module.
target_compile_definitions(${target} PUBLIC RF24_DRIVER="${RF24_DRIVER}")

# apply RF24Network flags to cpp_rf24_network target
if(RF24NETWORK_DEBUG)
message(STATUS "RF24NETWORK_DEBUG asserted for ${target}")
message(STATUS "RF24NETWORK_DEBUG asserted")
target_compile_definitions(${target} PUBLIC RF24NETWORK_DEBUG)
endif()

if(RF24NETWORK_DEBUG_MINIMAL)
message(STATUS "RF24NETWORK_DEBUG_MINIMAL asserted for ${target}")
message(STATUS "RF24NETWORK_DEBUG_MINIMAL asserted")
target_compile_definitions(${target} PUBLIC RF24NETWORK_DEBUG_MINIMAL)
endif()

if(RF24NETWORK_DEBUG_ROUTING)
message(STATUS "RF24NETWORK_DEBUG_ROUTING asserted for ${target}")
message(STATUS "RF24NETWORK_DEBUG_ROUTING asserted")
target_compile_definitions(${target} PUBLIC RF24NETWORK_DEBUG_ROUTING)
endif()

if(RF24NETWORK_DEBUG_FRAGMENTATION)
message(STATUS "RF24NETWORK_DEBUG_FRAGMENTATION asserted for ${target}")
message(STATUS "RF24NETWORK_DEBUG_FRAGMENTATION asserted")
target_compile_definitions(${target} PUBLIC RF24NETWORK_DEBUG_FRAGMENTATION)
endif()

if(RF24NETWORK_DEBUG_FRAGMENTATION_L2)
message(STATUS "RF24NETWORK_DEBUG_FRAGMENTATION_L2 asserted for ${target}")
message(STATUS "RF24NETWORK_DEBUG_FRAGMENTATION_L2 asserted")
target_compile_definitions(${target} PUBLIC RF24NETWORK_DEBUG_FRAGMENTATION_L2)
endif()

if(DISABLE_FRAGMENTATION)
message(STATUS "DISABLE_FRAGMENTATION asserted for ${target}")
message(STATUS "DISABLE_FRAGMENTATION asserted")
target_compile_definitions(${target} PUBLIC DISABLE_FRAGMENTATION)
endif()

# for MAX_PAYLOAD_SIZE, we let the default be configured in source code
if(DEFINED MAX_PAYLOAD_SIZE) # don't use CMake's `option()` for this one
message(STATUS "MAX_PAYLOAD_SIZE set to ${MAX_PAYLOAD_SIZE} for ${target}")
message(STATUS "MAX_PAYLOAD_SIZE set to ${MAX_PAYLOAD_SIZE}")
target_compile_definitions(${target} PUBLIC MAX_PAYLOAD_SIZE=${MAX_PAYLOAD_SIZE})
endif()

if(DEFINED SLOW_ADDR_POLL_RESPONSE)
message(STATUS "SLOW_ADDR_POLL_RESPONSE set to ${SLOW_ADDR_POLL_RESPONSE} for ${target}")
message(STATUS "SLOW_ADDR_POLL_RESPONSE set to ${SLOW_ADDR_POLL_RESPONSE}")
target_compile_definitions(${target} PUBLIC SLOW_ADDR_POLL_RESPONSE=${SLOW_ADDR_POLL_RESPONSE})
endif()

# apply RF24Mesh flags to cpp_rf24_mesh target
if(MESH_NOMASTER)
message(STATUS "MESH_NOMASTER asserted for ${target}")
message(STATUS "MESH_NOMASTER asserted")
target_compile_definitions(${target} PUBLIC MESH_NOMASTER)
endif()

if(RF24MESH_DEBUG)
message(STATUS "RF24MESH_DEBUG asserted for ${target}")
message(STATUS "RF24MESH_DEBUG asserted")
target_compile_definitions(${target} PUBLIC RF24MESH_DEBUG)
endif()

if(RF24MESH_DEBUG_MINIMAL)
message(STATUS "RF24MESH_DEBUG_MINIMAL asserted for ${target}")
message(STATUS "RF24MESH_DEBUG_MINIMAL asserted")
target_compile_definitions(${target} PUBLIC RF24MESH_DEBUG_MINIMAL)
endif()

# for the following, we let the default be configured in source code
if(DEFINED MESH_MAX_CHILDREN)
message(STATUS "MESH_MAX_CHILDREN set to ${MESH_MAX_CHILDREN} for ${target}")
message(STATUS "MESH_MAX_CHILDREN set to ${MESH_MAX_CHILDREN}")
target_compile_definitions(${target} PUBLIC MESH_MAX_CHILDREN=${MESH_MAX_CHILDREN})
endif()

if(DEFINED MESH_DEFAULT_CHANNEL)
message(STATUS "MESH_DEFAULT_CHANNEL set to ${MESH_DEFAULT_CHANNEL} for ${target}")
message(STATUS "MESH_DEFAULT_CHANNEL set to ${MESH_DEFAULT_CHANNEL}")
target_compile_definitions(${target} PUBLIC MESH_DEFAULT_CHANNEL=${MESH_DEFAULT_CHANNEL})
endif()

if(DEFINED MESH_RENEWAL_TIMEOUT)
message(STATUS "MESH_RENEWAL_TIMEOUT set to ${MESH_RENEWAL_TIMEOUT} for ${target}")
message(STATUS "MESH_RENEWAL_TIMEOUT set to ${MESH_RENEWAL_TIMEOUT}")
target_compile_definitions(${target} PUBLIC MESH_RENEWAL_TIMEOUT=${MESH_RENEWAL_TIMEOUT})
endif()

if(DEFINED MESH_MEM_ALLOC_SIZE)
message(STATUS "MESH_MEM_ALLOC_SIZE set to ${MESH_MEM_ALLOC_SIZE} for ${target}")
message(STATUS "MESH_MEM_ALLOC_SIZE set to ${MESH_MEM_ALLOC_SIZE}")
target_compile_definitions(${target} PUBLIC MESH_MEM_ALLOC_SIZE=${MESH_MEM_ALLOC_SIZE})
endif()

if(DEFINED MESH_LOOKUP_TIMEOUT)
message(STATUS "MESH_LOOKUP_TIMEOUT set to ${MESH_LOOKUP_TIMEOUT} for ${target}")
message(STATUS "MESH_LOOKUP_TIMEOUT set to ${MESH_LOOKUP_TIMEOUT}")
target_compile_definitions(${target} PUBLIC MESH_LOOKUP_TIMEOUT=${MESH_LOOKUP_TIMEOUT})
endif()

if(DEFINED MESH_WRITE_TIMEOUT)
message(STATUS "MESH_WRITE_TIMEOUT set to ${MESH_WRITE_TIMEOUT} for ${target}")
message(STATUS "MESH_WRITE_TIMEOUT set to ${MESH_WRITE_TIMEOUT}")
target_compile_definitions(${target} PUBLIC MESH_WRITE_TIMEOUT=${MESH_WRITE_TIMEOUT})
endif()

if(DEFINED RF24MESH_CONN_CHECK_TYPE)
message(STATUS "RF24MESH_CONN_CHECK_TYPE set to &{RF24MESH_CONN_CHECK_TYPE}")
target_compile_definitions(${target} PUBLIC RF24MESH_CONN_CHECK_TYPE=${RF24MESH_CONN_CHECK_TYPE})
endif()

if(DEFINED MESH_CONNECTION_CHECK_ATTEMPTS)
message(STATUS "MESH_CONNECTION_CHECK_ATTEMPTS set to &{MESH_CONNECTION_CHECK_ATTEMPTS}")
target_compile_definitions(${target} PUBLIC MESH_CONNECTION_CHECK_ATTEMPTS=${MESH_CONNECTION_CHECK_ATTEMPTS})
endif()
endfunction()
41 changes: 35 additions & 6 deletions src/pyRF24Mesh.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -281,22 +281,51 @@ void init_rf24mesh(py::module& m)

// *****************************************************************************

.def("release_address", &RF24MeshWrapper::releaseAddress, R"docstr(
release_address() -> bool
.def("release_address", static_cast<bool (RF24MeshWrapper::*)()>(&RF24MeshWrapper::releaseAddress), R"docstr(
release_address() -> bool \
release_address(address: int) -> bool
Use this function to manually expire a leased `Logical Address <logical_address>` from the mesh network's master node.
Use this function from a child node (without a parameter) to manually expire a leased `Logical Address <logical_address>`
from the mesh network's master node.
.. tip:: This function allows re-use of the assigned address for other mesh network nodes.
Call this function from mesh network nodes that are going offline (or to sleep).
:Returns: `True` if the mesh network's master node received the request to de-allocate
the assigned address. `False` means the wireless transaction did not complete.
:Returns:
- `True` if the mesh network's master node received the request to de-allocate
the assigned address.
- `False` means the wireless transaction did not complete.
)docstr")

.def("releaseAddress", &RF24MeshWrapper::releaseAddress, R"docstr(
.def("releaseAddress", static_cast<bool (RF24MeshWrapper::*)()>(&RF24MeshWrapper::releaseAddress), R"docstr(
releaseAddress() -> bool
)docstr")

// *****************************************************************************
#ifndef MESH_NOMASTER

.def("release_address", static_cast<bool (RF24MeshWrapper::*)(uint16_t)>(&RF24MeshWrapper::releaseAddress), R"docstr(
When called from the master node, this function takes a parameter and returns
without using wireless transactions.
.. hint::
This overloaded function signature is specific to master nodes,
so network administrators can manage assigned `Logical Addresses <logical_address>`
without notifying the nodes that might be appropriating them.
:param address: The `Logical Address <logical_address>` to release from any mesh node.
:Returns:
- `True` if successfully released the specified ``address``.
- `False` if the specified ``address`` was not assigned to any child node.
)docstr",
py::arg("address"))

.def("releaseAddress", static_cast<bool (RF24MeshWrapper::*)(uint16_t)>(&RF24MeshWrapper::releaseAddress), R"docstr(
releaseAddress(address: int) -> bool
)docstr",
py::arg("address"))

#endif
// *****************************************************************************

.def("get_address", &RF24MeshWrapper::getAddress, R"docstr(
Expand Down
6 changes: 6 additions & 0 deletions src/pyrf24/pyrf24.pyi
View file
Original file line number Diff line number Diff line change
Expand Up @@ -424,8 +424,14 @@ class RF24Mesh:
def setNodeID(self) -> None: ...
def get_node_id(self, address: int) -> int: ...
def getNodeID(self, address: int) -> int: ...
@overload
def release_address(self) -> bool: ...
@overload
def release_address(self, address: int) -> bool: ...
@overload
def releaseAddress(self) -> bool: ...
@overload
def releaseAddress(self, address: int) -> bool: ...
def renew_address(self, timeout: int = 7500) -> int: ...
def renewAddress(self, timeout: int = 7500) -> int: ...
def set_channel(self, channel: int) -> None: ...
Expand Down

0 comments on commit 5f740ab

Please sign in to comment.