All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

2.0.2 - 2024-10-06

🚀 Added

Enhance checkConnection() function by @TMRh20 in #240
Expose releaseAddress() for master node by @2bndy5 in #244
Address build warnings about ncurses example by @2bndy5 in #243
Mesh.checkConnection via parent not master by @TMRh20 in #250
Add pyproject.toml by @2bndy5 in #252

🛠️ Fixed

Fix spelling of MESH_NOMASTER in py wrapper by @2bndy5 in 2fb4d25
Fix spelling of MESH_NOMASTER in RF24Mesh.cpp by @2bndy5 in a8c63bc

📝 Documentation

Remove sphinx and update RTD config by @2bndy5 in #253

🗨️ Changed

Change MESH_DEBUG into RF24MESH_DEBUG by @2bndy5 in #239
Update doxygen CSS and use v1.11.0 by @2bndy5 in #245

Full commit diff: v2.0.1...v2.0.2

2.0.1 - 2024-06-11

🚀 Added

Enhance requestAddress by looping through poll responses by @TMRh20 in #238

📝 Documentation

Nrf52x - docs & library files by @TMRh20 in #234
Minor doc updates by @2bndy5 in #236

🗨️ Changed

Update clang format by @2bndy5 in #231
Update Doxyfile 2024 by @TMRh20 in #235
Bump version to v2.0.1 by @2bndy5 in 79078c4

Full commit diff: v2.0.0...v2.0.1

2.0.0 - 2023-06-21

📝 Documentation

Template layer for radio HW abstraction by @2bndy5 in #223

🗨️ Changed

Limit Mesh v2.x to Network v2.x tags by @2bndy5 in 38ee022

Full commit diff: v1.1.9...v2.0.0

1.1.9 - 2023-06-06

🚀 Added

Support NRF52x by @TMRh20 in 03e73fb
Add deploy-release arg to PIO reusable CI call by @2bndy5 in 673a76f

🗑️ Removed

Remove nrf_to_nrf support by @TMRh20 in 85a372f

📝 Documentation

Manually trigger docs CI by @2bndy5 in 607f227
Doc updates and reusable CI by @2bndy5 in #217

🗨️ Changed

Update examples for min PA by @TMRh20 in #216
Update for nrf52 by @TMRh20 in b774f03
Update version for release by @TMRh20 in e0ba23c

Full commit diff: v1.1.8...v1.1.9

1.1.8 - 2022-07-10

🛠️ Fixed

Fix mesh.begin() by @TMRh20 in #214

🗨️ Changed

Minor version bump by @2bndy5 in 105386b

Full commit diff: v1.1.7...v1.1.8

1.1.7 - 2022-07-09

🚀 Added

Add missing semi-colon from last commit by @2bndy5 in 1dada5f
Add topology to ncurses example by @TMRh20 in 9936933
Merge pull request #207 from nRF24/Topology by @TMRh20 in #207
Add clang-format config by @2bndy5 in 4ed33df

🗑️ Removed

Remove rogue documented return for a void function by @2bndy5 in ccb1b5f
Remove comment about eeprom by @TMRh20 in 8bf14f9

🛠️ Fixed

Fix python wrappers linking order by @2bndy5 in 559bf57
Fix setup.py for no IRQ support by @2bndy5 in 3a5cdb7

📝 Documentation

[docs] clarify renewAddress return val on failure by @2bndy5 in 804f7e6
Various improvments to docs by @2bndy5 in #209
Update .readthedocs.yaml by @2bndy5 in afe7ce5
Update sphinx doc config by @2bndy5 in a61b390

🗨️ Changed

Only run linux CI on "created release" events by @2bndy5 in 6f8091e
Clean up ncurses example by @TMRh20 in 0e739e0
Astyle formatting ncurses example by @TMRh20 in 49fd7da
Initialize meshStarted as false by @2bndy5 in 10e3961
Properly init addrMemAllocated by @2bndy5 in aacb9dc
Modify examples by @2bndy5 in a9a7fc0
More reconnecting loops; fix a use of renewAddress by @2bndy5 in 1123f19
Use do while (duh) by @2bndy5 in 59985d5
Merge pull request #205 from nRF24/better-arduino-example-setup by @TMRh20 in #205
[CMake] link Linux examples to pigpio if detected by @2bndy5 in 2269f5e
[cmake] build examples w/ a specified driver by @2bndy5 in 206ce59
[cmake] forgot the ncurses example by @2bndy5 in 26fa1a6
-DRF24_NO_IRQ when no pigpio while building lib by @2bndy5 in 02d772a
Allow RF24_NO_IRQ for building examples by @2bndy5 in e4021ab
Merge branch 'pigpio-support' by @TMRh20 in f6aec9f
Improve doxygen CI by @2bndy5 in 7fd7d0f
Resolve #211 by @2bndy5 in a3bc47d
Update python examples per testing by @2bndy5 in 1851ff4
Merge pull request #212 from nRF24/update-py-examples by @TMRh20 in #212
Ran clang-format on all C++ sources by @2bndy5 in f40a116
Arduino CI make PR size delta reports by @2bndy5 in 9f6ac9b
Update workflows by @2bndy5 in 7f6c717
MESH_CALLBACK macro must be 2 lines by @2bndy5 in 5cc0967
Update build_linux.yml by @2bndy5 in c785a09
Update build_rp2xxx.yml by @2bndy5 in 35d1135
Only check pico examples in rp2xxx CI by @2bndy5 in 557dac5
Merge pull request #213 from nRF24/clang-format by @TMRh20 in #213
Disable latex builds on RTD by @2bndy5 in 250ccc1
Minor version bump by @2bndy5 in 3b6c2e0

Full commit diff: v1.1.6...v1.1.7

1.1.6 - 2021-11-27

🚀 Added

Add GPLv2 license; this builds locally by @2bndy5 in a90920a
Add CMake user preset json to ignore by @2bndy5 in b10b4b5
Add while(!Serial) and if(!mesh.begin()) by @2bndy5 in 2e76b79
Add comment about double check by @2bndy5 in 6f8285f
Add MESH_SLOW_ADDRESS_RESPONSE; by @2bndy5 in 2d6c1ca
Address #195 by @2bndy5 in af43cb2
Add PicoSDK CI workflow by @2bndy5 in 2ee51d3
Merge pull request #188 from nRF24/CMake-4-Linux by @TMRh20 in #188

🗑️ Removed

Remove artifact; resolves #190 by @2bndy5 in 656bca1

🛠️ Fixed

Fix code fmt; add ncurses example to cmake targets by @2bndy5 in 20bb320
Fix docs about addrList by @2bndy5 in 819eb30
Fix problem in last commit by @2bndy5 in fc48984
Fix broken links on docs main pg by @2bndy5 in 578e541
Fix compile for examples by @TMRh20 in e1eb4a9
Fix example compilation by @TMRh20 in b6c6f1c

📝 Documentation

Ready for docs hosting on RTD by @2bndy5 in 0981279
Small docs update by @2bndy5 in 9b94c34
[docs] fix multiline API signatures by @2bndy5 in a8a7f21
Update for Docs by @TMRh20 in c9a691d

🗨️ Changed

Initial CMake files for pico-sdk by @kripton in #185
[no ci] preliminary CMake implementation by @2bndy5 in 7387ea1
Avoid duplicate triggers when PR is open by @2bndy5 in 2fa51c5
No need for –target with make cmd by @2bndy5 in 4ee2e51
Automate building of ncurses example by @2bndy5 in d1c3217
Default BUILD_TYPE to Release by @2bndy5 in a1ecabc
Update CONTRIBUTING.md by @2bndy5 in 1452062
Manually trigger CI workflows by @2bndy5 in 903c6d7
Doxygen CI triggers on push & PR for all branches by @2bndy5 in ff92d8e
Try new Arduino CI workflow by @2bndy5 in 0902b49
Forgot to add arduino examples fmt conf file by @2bndy5 in 4471b05
RF24Mesh_Example_Master is incompatible w/ non-AVR by @2bndy5 in f0bc5e1
Gimme them badges by @2bndy5 in f2e3167
Try new PlatformIO CI by @2bndy5 in 69b1548
Oops use linux FS delimiter by @2bndy5 in e16f600
Gimme a badge by @2bndy5 in a9f8313
Polish library.json by @2bndy5 in 0a98838
[PIO CI] validate library.json & save as artifact by @2bndy5 in 85ad20c
[PIO CI] fix path to pio pkg by @2bndy5 in 29f7294
Exclude linux stuff from PIO by @2bndy5 in 31d7ece
Exclude more useless stuff from PIO pkg by @2bndy5 in 76f99b0
Use CMake CLI to change RF24Mesh_config.h macros by @2bndy5 in f0dc453
[no ci] adjust some whitespace by @2bndy5 in ea7746c
Use new macro propsed in nRF24/RF24Network#179 by @2bndy5 in a47b242
Following NASA C style guide by @2bndy5 in d79fec3
Uniform MESH_DEBUG* calls by @2bndy5 in 10ce90e
Alias NET_MULTICAST_ADDR by @2bndy5 in 6d130d8
Trigger Arduino CI workflow by @2bndy5 in 057a2e5
Trigger PlatformIO CI by @2bndy5 in 31039cf
[Arduino CI] url option must end in .git by @2bndy5 in ce300b6
Use iu instead of ui by @2bndy5 in 9af7858
Use just u by @2bndy5 in aaed824
[py wrapper] augment setup.py by @2bndy5 in fcf70ab
Use an OR condition instead by @2bndy5 in be5d66c
Revert to nested if statements by @2bndy5 in 3a776de
Merge branch 'CMake-4-Linux' of https://github.com/nRF24/RF24Mesh into CMake-4-Linux by @2bndy5 in 928ed19
Py pkgs from apt are very out-of-date by @2bndy5 in 61a7f91
[py wrapper] ammend license info by @2bndy5 in b78d5cd
Move new mcro up 1 OSI lvl by @2bndy5 in 95c75b1
Revert SLOW_ADDR_POLL_RESPONSE by @2bndy5 in 4afe8c8
Revert "revert SLOW_ADDR_POLL_RESPONSE" by @2bndy5 in 3b69930
Relative CMakeLists.txt by @2bndy5 in 0160dd2
[CMake] distinguish project_option/warnings by @2bndy5 in 951bbde
Allow pybind11 to build in source by @2bndy5 in f01e3bb
Introduce undefined macro USE_RF24_LIB_SRC by @2bndy5 in c88e79d
Further the utility of USE_RF24_LIB_SRC macro by @2bndy5 in 0e9af67
[CMakeLists.txt] fix last commit by @2bndy5 in 42cd430
Auto-publish new releases to PIO by @2bndy5 in 51e9e8b
Use –non-interactive option in PIO CI by @2bndy5 in 91198db
[linux CI] use RF24 master branch by @2bndy5 in f19b503
Review pico examples by @2bndy5 in a20bf32
Pico examples should wait until Serial is active by @2bndy5 in e38cc31
[pico examples] use milliseconds not microseconds by @2bndy5 in 4db1ab4
Node ID max is 255 by @2bndy5 in 9e34e87
Gimme that RTD badge by @2bndy5 in e73cca0
Use RF24Network master branch in linux workflow by @2bndy5 in 67d25b9
Use RF24Network master branch in arduino workflow by @2bndy5 in 0df592e
Use RF24Network master branch in PIO workflow by @2bndy5 in 13cae65
Use RF24* master branch in rp2xxx workflow by @2bndy5 in a33695b
Update pyRF24Mesh.cpp by @RasmusHRAAU in #179
MESH_CALLBACK and eliminate delay in renewAddress() by @BCsabaEngine in 804c68f
Merge pull request #194 from BCsabaEngine/master by @TMRh20 in #194
Merge branch 'master' of https://github.com/nRF24/RF24Mesh by @TMRh20 in 3f60d8b
Merge branch 'master' into CMake-4-Linux by @2bndy5 in b3915b2

Full commit diff: v1.1.5...v1.1.6

New Contributors

@BCsabaEngine made their first contribution
@RasmusHRAAU made their first contribution in #179

1.1.5 - 2021-04-13

📝 Documentation

Docs abstraction & code formating by @2bndy5 in #181

🗨️ Changed

Merge branch 'master' into master by @2bndy5 in 749c56a
Merge pull request #152 from positron96/master by @TMRh20 in #152
Make most #defines in RF24Mesh_config.h conditional so they can be set from project code or compiler command line. by @kripton in #183
Version bump (patch+1) by @2bndy5 in 3acca6e

Full commit diff: v1.1.4...v1.1.5

1.1.4 - 2020-12-14

🛠️ Fixed

Fix warning by @2bndy5 in e75fc07
Fix missing images by @2bndy5 in 50712c8

📝 Documentation

Redirect doc links to nRF24 org by @2bndy5 in 3e6e5a8
Merge pull request #177 from 2bndy5/master by @TMRh20 in #177

🗨️ Changed

Create CONTRIBUTING.md by @Avamander in 870a31d
Edit doxyfile OUTPUT_DIR & add workflow by @2bndy5 in 6f1b126
Format doxygen css file & include latest changes by @2bndy5 in 44bde34
Only run doxygen on master branch by @2bndy5 in 60ceaa8
Merge pull request #178 from 2bndy5/master by @2bndy5 in #178
Update library.properties by @TMRh20 in 8442df9
Update library.json by @TMRh20 in f098df0

Full commit diff: v1.1.3...v1.1.4

1.1.3 - 2020-08-17

🚀 Added

Add ability to set call-back function by @TMRh20 in c2354ff

🗑️ Removed

Many bug fixes by @TMRh20 in f445630

🗨️ Changed

Doc update by @TMRh20 in 43f8445
Adjust setAddress function by @TMRh20 in 7a4a8e5
Update for release by @TMRh20 in fce5235

Full commit diff: v1.1.2...v1.1.3

1.1.2 - 2020-08-08

🚀 Added

Address request/renew improvement by @TMRh20 in 2af9653
Address one more issue by @TMRh20 in 9516910

🗑️ Removed

Fixes,cleanup and improvements by @TMRh20 in 8be00fd
Minor correction on master nodes by @TMRh20 in bbc996b
More minor cleanup by @TMRh20 in c957217
Adjust for RF24Network change by @TMRh20 in 18d14e7

🗨️ Changed

One little adjustment by @TMRh20 in 7c7947c
Update for release by @TMRh20 in b1430b1

Full commit diff: v1.1.1...v1.1.2

1.1.1 - 2020-08-01

🗑️ Removed

BIg cleanup and some fixes by @TMRh20 in ea116be

🛠️ Fixed

Issue with renewAddress() by @TMRh20 in e00a9d5

🗨️ Changed

Dynamic memory allocation & fixes by @TMRh20 in b30b182
Update version & architectures by @TMRh20 in e0fd05c
Update version for release by @TMRh20 in 7e5e920

Full commit diff: v1.1.0...v1.1.1

1.1.0 - 2020-06-08

🗨️ Changed

Update versioning to fix problems by @TMRh20 in 5563474

Full commit diff: v1.0.8...v1.1.0

1.0.8 - 2020-06-08

🚦 Tests

CheckConnection verify connection both ways by @TMRh20 in eacd24f

🗨️ Changed

Update library.properties by @TMRh20 in 409e409
Update version for release by @TMRh20 in d4c8e68

Full commit diff: v1.0.7...v1.0.8

1.0.7 - 2019-05-26

🚀 Added

Add mesh.begin() after failed renewal of address by @TMRh20 in 4b036ce
Add one more step to address renewal by @TMRh20 in c992646
Add a second lookup to the end of address renewal by @TMRh20 in c27604a

🗑️ Removed

Remove address confirmations from address renewal by @TMRh20 in 92a03c0

📝 Documentation

Update RF24Mesh.h documentation by @TMRh20 in 6252c3a

🗨️ Changed

Correct debug output by @TMRh20 in c7f64a6
Change timeout for nodeID lookups by @TMRh20 in e7f90d8
Update readme by @TMRh20 in 67bc9ab
Update version for release by @TMRh20 in 7760101

Full commit diff: v1.0.6...v1.0.7

1.0.6 - 2019-05-08

🚀 Added

Adds back the delay in DHCP as without address renewal fails by @MAKOMO in 79ac487
Added compiler variable into makefiles for easy compiler switching by @igormp in 2022b93
Added compiler variable into ncurses makefile by @igormp in 63da607
Added default initialization value for bool by @igormp in c31387a
Added .gitignore by @igormp in 8502bc4
Adds boost python wrapper by @joernesdohr in e228902
Adds namespace by @joernesdohr in d601161
Adds python example for master node by @joernesdohr in d3a17b3
Adds missing function by @joernesdohr in 9c2de0f
Added missing throw_ba_exception() function by @joernesdohr in 4a1b9a8
Adds rf24network library reference to setup; fixes typo in setNodeId() function name by @joernesdohr in 68cce8d

🗑️ Removed

Removed unnecessary EEPROM include. Autoformat. by @Avamander in 9a4682f
Merge pull request #93 from Avamander/master by @Avamander in #93
Code Styling in 8f20094
Removes static_cast agains; adds [return_internal_reference<>()] as seen on http://www.boost.org/doc/libs/1_38_0/libs/python/doc/v2/overloads.html by @joernesdohr in 8121fda
Remove [bp::return_internal_reference<>()] because those functions don't actually return any internal references... by @joernesdohr in 93046a9

🛠️ Fixed

Fixed issue described in #86 by @Avamander in 836aa76
Fixes arguments by @joernesdohr in d2381c8

🗨️ Changed

Refactor if(nodeID()) in a990593
Merge pull request #94 from ciberkids/master by @TMRh20 in #94
Links MESH_DEFAULT_ADDRESS NETWORK_DEFAULT_ADDRESS by @MAKOMO in 359b226
Extends debug logging by @MAKOMO in 187f4d0
Merge pull request #139 from MAKOMO/master by @TMRh20 in #139
Check value of radio.begin by @positron96 in e96477e
Merge pull request #153 from igormp/makeupdate by @Avamander in #153
Split increment and assignment in order to avoid UB by @igormp in 33aad0b
Merge pull request #154 from igormp/clangwarning by @Avamander in #154
Examples' makefiles now create a bin dir by @igormp in 37e0626
Merge pull request #155 from igormp/master by @TMRh20 in #155
Static_cast the overoaded wrappers by @joernesdohr in faa87ee
Single bp:arg() instead of args by @joernesdohr in f87bdfd
Back to bp::args; moves [bp::return_internal_reference<>()] into correct position by @joernesdohr in 3f79b2c
Trying manual wrapper functions by @joernesdohr in 27c3f47
Wrapper functions for byte buffer parameters by @joernesdohr in ebbe80d
Example doesn't need to be a class by @joernesdohr in 0625000
Adopts correct capitalization of ID by @joernesdohr in e3f833d
Clean up by @joernesdohr in 7bbece9
Typo in comment by @joernesdohr in d228ce6
Files moved to standard structure by @filipek92 in c783fdb
Python example RF24Mesh_Example_Master.py rewrited to work as C++ example by @filipek92 in e628d65
Mesh node example in Python 3 by @filipek92 in 7708cfc
Merge pull request #1 from nRF24/master by @filipek92 in 30d9fa2
Merge pull request #123 from filipek92/master by @TMRh20 in #123
Update library.json by @Avamander in 4ed90d3
Update library.properties by @Avamander in 5a1ec37
Update version for release by @TMRh20 in c76ab82

Full commit diff: v1.0.51...v1.0.6

New Contributors

@igormp made their first contribution
@positron96 made their first contribution
@filipek92 made their first contribution
@MAKOMO made their first contribution
@joernesdohr made their first contribution

1.0.51 - 2016-06-04

🗑️ Removed

Fix for use with RF24Ethernet by @TMRh20 in 73b7971

Full commit diff: v1.0.5...v1.0.51

1.0.5 - 2016-03-27

🚀 Added

Add library.json for PlatformIO registry in fbd486c
Add deps to library.json for PlatformIO in c599c52
Additional child node, fix warning, spidev issue by @TMRh20 in a58a257

🗑️ Removed

Remove examples from library.json in 09e2a96

🛠️ Fixed

Fix for address renewal confirmation by @TMRh20 in adabf7d
Last change causing segfaults on non-master by @TMRh20 in c874003

🗨️ Changed

RPI2 autodetection by @yozik04 in 91c0ba3
RPI2 autodetection in ncurses example by @yozik04 in 5e9c030
Merge pull request #54 from yozik04/master by @TMRh20 in 62a4fa5
Initlialize addrListTop to 0 by @julianpas in eff2775
Merge pull request #56 from julianpas/patch-1 by @Avamander in 601c605
Merge pull request #68 from harmon25/master by @Avamander in 206b733
Use tagged source code from repo; fix include/exclude fields by @ivankravets in aa17378
Merge pull request #69 from ivankravets/patch-1 by @Avamander in e573ebb
Major Bugfix: Buffer overrun in renewAddress by @TMRh20 in 0450c5c
Update version due to major bugfix by @TMRh20 in b420fbc