https://github.com/nrf24/rf24network

OSI Layer 3 Networking for nRF24L01(+) and nRF52x on Arduino and Raspberry Pi
https://github.com/nrf24/rf24network

arduino arduino-library c-plus-plus hacktoberfest nrf24l01 rf24

Last synced: 5 days ago
JSON representation

OSI Layer 3 Networking for nRF24L01(+) and nRF52x on Arduino and Raspberry Pi

• Host: GitHub
• URL: https://github.com/nrf24/rf24network
• Owner: nRF24
• License: gpl-2.0
• Created: 2014-04-02T05:37:27.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2025-01-10T22:14:58.000Z (13 days ago)
• Last Synced: 2025-01-12T00:05:22.984Z (12 days ago)
• Topics: arduino, arduino-library, c-plus-plus, hacktoberfest, nrf24l01, rf24
• Language: C++
• Homepage: https://nrf24.github.io/RF24Network/
• Size: 4.39 MB
• Stars: 360
• Watchers: 41
• Forks: 164
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        

[![Linux build](https://github.com/nRF24/RF24Network/actions/workflows/build_linux.yml/badge.svg)](https://github.com/nRF24/RF24Network/actions/workflows/build_linux.yml)

[![Arduino CLI build](https://github.com/nRF24/RF24Network/actions/workflows/build_arduino.yml/badge.svg)](https://github.com/nRF24/RF24Network/actions/workflows/build_arduino.yml)

[![PlatformIO build](https://github.com/nRF24/RF24Network/actions/workflows/build_platformIO.yml/badge.svg)](https://github.com/nRF24/RF24Network/actions/workflows/build_platformIO.yml)

[![Pico SDK build](https://github.com/nRF24/RF24Network/actions/workflows/build_rp2xxx.yml/badge.svg)](https://github.com/nRF24/RF24Network/actions/workflows/build_rp2xxx.yml)

[![Documentation Status](https://readthedocs.org/projects/rf24network/badge/?version=latest)](https://rf24network.readthedocs.io/en/latest/?badge=latest)

# TMRh20 2014-2024 - Optimized Network Layer for nRF24L01(+) & nRF52x radios

Introducing **RF24Network & RF24Mesh v2.0** with some *significant API changes*, adding the use of C++ Templates in order to support a

range of ESB enabled radios, most recently NRF52x radios.

**Important Notes:**

- Any network layer that uses v2 needs to have RF24Network/RF24Mesh dependencies of v2 or newer. RF24 v1.x is an exception here.

- General usage should remain backward compatible, see the included examples of the related libraries for more info

- Any third party libs that extend the network/mesh layer may also need to be updated to incorporate the new templated class prototypes:

```cpp

template

class ESBNetwork;

  

template

class ESBMesh;

```

- Third party libs should also be able to use the backward-compatible typedef in their template:

  - ESBGateway.h:

  ```cpp

  template

  class ESBGateway

  ```

  and inform the compiler what types they intend to support:

  - ESBGateway.cpp:

  ```cpp

  template class ESBGateway;

  ```  

- The auto installers do not perform a version check like package managers, so having the correct versions of the software is important.

- We *will* be maintaining the v1.x versions with bugfixes etc for those who cannot or do not wish to migrate to the newer template approach.

Please see the full documentation at http://nRF24.github.io/RF24Network/ for more information

See http://nRF24.github.io/RF24/index.html for general RF24 configuration and setup

See [Linux Installation](http://nRF24.github.io/RF24/md_docs_linux_install.html) and [General Linux/RPi configuration and setup](http://nRF24.github.io/RF24/md_docs_rpi_general.html)