Fix for large payloads with NRF52 (#244)

TMRh20 · 2bndy5 · web-flow · commit 32e78d2df321 · 2025-02-27T04:56:16.000-06:00
* Fix for large payloads with NRF52 * Specify nrf_to_nrf or RF24 behavior in the overloaded write() functions * modify doc comment * add CI for nrf_to_nrf * disambiguate examples in docs - Add intermediate function write() and change the old write() function to main_write() * Make main_write() function inline Co-authored-by: Brendan <2bndy5@gmail.com> * Remove max_frame_size var Per @2bndy5 in #244 * Remove setting max_frame_payload_size in RF24 write function * Missing bracket... --------- Co-authored-by: Brendan <2bndy5@gmail.com>
diff --git a/.github/workflows/build_nrf_to_nrf.yml b/.github/workflows/build_nrf_to_nrf.yml
@@ -0,0 +1,25 @@
+name: nRF52840 build
+
+on:
+  pull_request:
+    branches: [master]
+  push:
+    branches: [master]
+
+jobs:
+  build:
+    uses: nRF24/.github/.github/workflows/build_platformio.yaml@main
+    with:
+      example-path: ${{ matrix.example }}
+      board-id: ${{ matrix.board }}
+      lib-deps: -l https://github.com/TMRh20/nrf_to_nrf.git
+    strategy:
+      fail-fast: false
+      matrix:
+        example:
+          - "examples/nrf_to_nrf/helloworld_rx/helloworld_rx.ino"
+          - "examples/nrf_to_nrf/helloworld_tx/helloworld_tx.ino"
+          - "examples/nrf_to_nrf/helloworld_rxEncryption/helloworld_rxEncryption.ino"
+          - "examples/nrf_to_nrf/helloworld_txEncryption/helloworld_txEncryption.ino"
+        board:
+          - "adafruit_feather_nrf52840"
diff --git a/RF24Network.cpp b/RF24Network.cpp
@@ -696,14 +696,37 @@ bool ESBNetwork<radio_t>::write(RF24NetworkHeader& header, const void* message,
 
 /******************************************************************/
 
+template<>
+bool ESBNetwork<RF24>::write(RF24NetworkHeader& header, const void* message, uint16_t len, uint16_t writeDirect)
+{
+    return main_write(header, message, len, writeDirect);
+}
+
+/******************************************************************/
+#if defined NRF52_RADIO_LIBRARY
+template<>
+bool ESBNetwork<nrf_to_nrf>::write(RF24NetworkHeader& header, const void* message, uint16_t len, uint16_t writeDirect)
+{
+    max_frame_payload_size = (uint8_t)NRF_RADIO->PCNF1 - sizeof(RF24NetworkHeader);
+    if (radio.enableEncryption == true) {
+        max_frame_payload_size -= CCM_IV_SIZE + CCM_COUNTER_SIZE + CCM_MIC_SIZE;
+    }
+    return main_write(header, message, len, writeDirect);
+}
+#endif
+/******************************************************************/
+
 template<class radio_t>
-bool ESBNetwork<radio_t>::write(RF24NetworkHeader& header, const void* message, uint16_t len, uint16_t writeDirect)
+bool ESBNetwork<radio_t>::main_write(RF24NetworkHeader& header, const void* message, uint16_t len, uint16_t writeDirect)
 {
 
 #if defined(DISABLE_FRAGMENTATION)
-    frame_size = rf24_min(len + sizeof(RF24NetworkHeader), MAX_FRAME_SIZE);
+
+    frame_size = rf24_min(len + sizeof(RF24NetworkHeader), max_frame_payload_size + sizeof(RF24NetworkHeader));
     return _write(header, message, rf24_min(len, max_frame_payload_size), writeDirect);
+
 #else // !defined(DISABLE_FRAGMENTATION)
+
     if (len <= max_frame_payload_size) {
         //Normal Write (Un-Fragmented)
         frame_size = len + sizeof(RF24NetworkHeader);
diff --git a/RF24Network.h b/RF24Network.h
@@ -192,7 +192,12 @@
 #define USER_TX_TO_LOGICAL_ADDRESS  3 // network ACK
 #define USER_TX_MULTICAST           4
 
-#define MAX_FRAME_SIZE    32 // Size of individual radio frames
+#if defined NRF52_RADIO_LIBRARY
+    #define MAX_FRAME_SIZE 123 // Size of individual radio frames is larger with NRF52
+#else
+    #define MAX_FRAME_SIZE 32 // Size of individual radio frames
+#endif
+
 #define FRAME_HEADER_SIZE 10 // Size of RF24Network frames - data
 
 /**
@@ -902,6 +907,11 @@ class ESBNetwork
      */
     bool _write(RF24NetworkHeader& header, const void* message, uint16_t len, uint16_t writeDirect);
 
+    /*
+     * The main write function where fragmentation and processing of the payload is initiated
+     */
+    inline bool main_write(RF24NetworkHeader& header, const void* message, uint16_t len, uint16_t writeDirect);
+
     struct logicalToPhysicalStruct
     {
         /** The immediate destination (1 hop) of an outgoing frame */
@@ -934,8 +944,9 @@ class ESBNetwork
 
     radio_t& radio; /** Underlying radio driver, provides link/physical layers */
 
-    uint8_t frame_size;                                                                            /* The outgoing frame's total size including the header info. Ranges [8, MAX_PAYLOAD_SIZE] */
-    const static unsigned int max_frame_payload_size = MAX_FRAME_SIZE - sizeof(RF24NetworkHeader); /* always 24 bytes to compensate for the frame's header */
+    uint8_t frame_size; /* The outgoing frame's total size including the header info. Ranges [8, MAX_PAYLOAD_SIZE] */
+
+    unsigned int max_frame_payload_size = MAX_FRAME_SIZE - sizeof(RF24NetworkHeader); /* always 24 bytes to compensate for the frame's header */
 
 #if defined(RF24_LINUX)
     std::queue<RF24NetworkFrame> frame_queue;
@@ -995,15 +1006,15 @@ typedef ESBNetwork<nrf_to_nrf> RF52Network;
 #endif
 
 /**
- * @example helloworld_tx.ino
+ * @example examples/helloworld_tx/helloworld_tx.ino
  *
  * Simplest possible example of using RF24Network. Put this sketch
  * on one node, and helloworld_rx.pde on the other. Tx will send
  * Rx a nice message every 2 seconds which rx will print out for us.
  */
 
 /**
- * @example helloworld_rx.ino
+ * @example examples/helloworld_rx/helloworld_rx.ino
  *
  * Simplest possible example of using RF24Network. Put this sketch
  * on one node, and helloworld_tx.pde on the other. Tx will send
@@ -1063,4 +1074,36 @@ typedef ESBNetwork<nrf_to_nrf> RF52Network;
  * An example of handling/prioritizing different types of data passing through the RF24Network
  */
 
+/**
+ * @example examples/nrf_to_nrf/helloworld_tx/helloworld_tx.ino
+ *
+ * Simplest possible example of using RF24Network with nrf_to_nrf library (instead of RF24).
+ * Put this sketch on one node, and helloworld_tx.pde on the other. Tx will send
+ * Rx a nice message every 2 seconds which rx will print out for us.
+ */
+
+/**
+ * @example examples/nrf_to_nrf/helloworld_rx/helloworld_rx.ino
+ *
+ * Simplest possible example of using RF24Network with nrf_to_nrf library (instead of RF24).
+ * Put this sketch on one node, and helloworld_tx.pde on the other. Tx will send
+ * Rx a nice message every 2 seconds which rx will print out for us.
+ */
+
+/**
+ * @example examples/nrf_to_nrf/helloworld_txEncryption/helloworld_txEncryption.ino
+ *
+ * Simplest possible example of using RF24Network with nrf_to_nrf library (instead of RF24) with encryption.
+ * Put this sketch on one node, and helloworld_tx.pde on the other. Tx will send
+ * Rx a nice message every 2 seconds which rx will print out for us.
+ */
+
+/**
+ * @example examples/nrf_to_nrf/helloworld_rxEncryption/helloworld_rxEncryption.ino
+ *
+ * Simplest possible example of using RF24Network with nrf_to_nrf library (instead of RF24) with encryption.
+ * Put this sketch on one node, and helloworld_tx.pde on the other. Tx will send
+ * Rx a nice message every 2 seconds which rx will print out for us.
+ */
+
 #endif // __RF24NETWORK_H__
diff --git a/examples/nrf_to_nrf/helloworld_rx/helloworld_rx.ino b/examples/nrf_to_nrf/helloworld_rx/helloworld_rx.ino
@@ -0,0 +1,65 @@
+/**
+ * Copyright (C) 2012 James Coliz, Jr. <maniacbug@ymail.com>
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * version 2 as published by the Free Software Foundation.
+ *
+ * Update 2014 - TMRh20
+ */
+
+/**
+ * Simplest possible example of using RF24Network,
+ *
+ * RECEIVER NODE
+ * Listens for messages from the transmitter and prints them out.
+ */
+
+#include <nrf_to_nrf.h>
+#include <RF24Network.h>
+
+
+nrf_to_nrf radio;  // nRF24L01(+) radio attached using Getting Started board
+
+RF52Network network(radio);      // Network uses that radio
+const uint16_t this_node = 00;   // Address of our node in Octal format (04, 031, etc)
+const uint16_t other_node = 01;  // Address of the other node in Octal format
+
+struct payload_t {  // Structure of our payload
+  unsigned long ms;
+  unsigned long counter;
+};
+
+
+void setup(void) {
+  Serial.begin(115200);
+  while (!Serial) {
+    // some boards need this because of native USB capability
+  }
+  Serial.println(F("RF24Network/examples/helloworld_rx/"));
+
+  if (!radio.begin()) {
+    Serial.println(F("Radio hardware not responding!"));
+    while (1) {
+      // hold in infinite loop
+    }
+  }
+  radio.setChannel(90);
+  network.begin(/*node address*/ this_node);
+}
+
+void loop(void) {
+
+  network.update();  // Check the network regularly
+
+  while (network.available()) {  // Is there anything ready for us?
+
+    RF24NetworkHeader header;  // If so, grab it and print it out
+    payload_t payload;
+    network.read(header, &payload, sizeof(payload));
+    Serial.print(F("Received packet: counter="));
+    Serial.print(payload.counter);
+    Serial.print(F(", origin timestamp="));
+    Serial.println(payload.ms);
+  }
+}
diff --git a/examples/nrf_to_nrf/helloworld_rxEncryption/helloworld_rxEncryption.ino b/examples/nrf_to_nrf/helloworld_rxEncryption/helloworld_rxEncryption.ino
@@ -0,0 +1,72 @@
+/**
+ * Copyright (C) 2012 James Coliz, Jr. <maniacbug@ymail.com>
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * version 2 as published by the Free Software Foundation.
+ *
+ * Update 2014 - TMRh20
+ */
+
+/**
+ * Simplest possible example of using RF24Network,
+ *
+ * RECEIVER NODE
+ * Listens for messages from the transmitter and prints them out.
+ */
+
+#include <nrf_to_nrf.h>
+#include <RF24Network.h>
+
+//Set up our encryption key
+uint8_t myKey[16] = { 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, 1, 2, 3, 4, 5, 6 };
+
+nrf_to_nrf radio;  // nRF24L01(+) radio attached using Getting Started board
+
+RF52Network network(radio);      // Network uses that radio
+const uint16_t this_node = 00;   // Address of our node in Octal format (04, 031, etc)
+const uint16_t other_node = 01;  // Address of the other node in Octal format
+
+struct payload_t {  // Structure of our payload
+  unsigned long ms;
+  unsigned long counter;
+};
+
+
+void setup(void) {
+  Serial.begin(115200);
+  while (!Serial) {
+    // some boards need this because of native USB capability
+  }
+  Serial.println(F("RF24Network/examples/helloworld_rx/"));
+
+  if (!radio.begin()) {
+    Serial.println(F("Radio hardware not responding!"));
+    while (1) {
+      // hold in infinite loop
+    }
+  }
+
+  radio.setKey(myKey);               // Set our key and IV
+  radio.enableEncryption = true;     // Enable encryption
+  radio.enableDynamicPayloads(123);  //This is important to call so the encryption overhead will not be included in the 32-byte limit
+                                     //To overcome the 32-byte limit, edit RF24Network.h and set MAX_FRAME_SIZE to 111
+  radio.setChannel(90);
+  network.begin(/*node address*/ this_node);
+}
+
+void loop(void) {
+
+  network.update();  // Check the network regularly
+
+  while (network.available()) {  // Is there anything ready for us?
+
+    RF24NetworkHeader header;  // If so, grab it and print it out
+    payload_t payload;
+    network.read(header, &payload, sizeof(payload));
+    Serial.print(F("Received packet: counter="));
+    Serial.print(payload.counter);
+    Serial.print(F(", origin timestamp="));
+    Serial.println(payload.ms);
+  }
+}
diff --git a/examples/nrf_to_nrf/helloworld_tx/helloworld_tx.ino b/examples/nrf_to_nrf/helloworld_tx/helloworld_tx.ino
@@ -0,0 +1,72 @@
+/**
+ * Copyright (C) 2012 James Coliz, Jr. <maniacbug@ymail.com>
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * version 2 as published by the Free Software Foundation.
+ *
+ * Update 2014 - TMRh20
+ */
+
+/**
+ * Simplest possible example of using RF24Network
+ *
+ * TRANSMITTER NODE
+ * Every 2 seconds, send a payload to the receiver node.
+ */
+
+#include <nrf_to_nrf.h>
+#include <RF24Network.h>
+
+nrf_to_nrf radio;  // nRF24L01(+) radio attached using Getting Started board
+
+RF52Network network(radio);  // Network uses that radio
+
+const uint16_t this_node = 01;   // Address of our node in Octal format
+const uint16_t other_node = 00;  // Address of the other node in Octal format
+
+const unsigned long interval = 2000;  // How often (in ms) to send 'hello world' to the other unit
+
+unsigned long last_sent;     // When did we last send?
+unsigned long packets_sent;  // How many have we sent already
+
+
+struct payload_t {  // Structure of our payload
+  unsigned long ms;
+  unsigned long counter;
+};
+
+void setup(void) {
+  Serial.begin(115200);
+  while (!Serial) {
+    // some boards need this because of native USB capability
+  }
+  Serial.println(F("RF24Network/examples/helloworld_tx/"));
+
+  if (!radio.begin()) {
+    Serial.println(F("Radio hardware not responding!"));
+    while (1) {
+      // hold in infinite loop
+    }
+  }
+  radio.setChannel(90);
+  network.begin(/*node address*/ this_node);
+}
+
+void loop() {
+
+  network.update();  // Check the network regularly
+
+  unsigned long now = millis();
+
+  // If it's time to send a message, send it!
+  if (now - last_sent >= interval) {
+    last_sent = now;
+
+    Serial.print(F("Sending... "));
+    payload_t payload = { millis(), packets_sent++ };
+    RF24NetworkHeader header(/*to node*/ other_node);
+    bool ok = network.write(header, &payload, sizeof(payload));
+    Serial.println(ok ? F("ok.") : F("failed."));
+  }
+}
diff --git a/examples/nrf_to_nrf/helloworld_txEncryption/helloworld_txEncryption.ino b/examples/nrf_to_nrf/helloworld_txEncryption/helloworld_txEncryption.ino
