add note about MAIN_BUFFER_SIZE

nRF24 · Jul 2, 2021 · 2658760 · 2658760
1 parent 9f2e62b
commit 2658760
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/RF24Network_config.h b/RF24Network_config.h
@@ -44,8 +44,12 @@
             #define MAX_PAYLOAD_SIZE  144
         #endif // MAX_PAYLOAD_SIZE
 
-        /** The size of the main buffer. This is the user-cache, where incoming data is stored.
-         * Data is stored using Frames: Header (8-bytes) + Frame_Size (2-bytes) + Data (?-bytes)
+        /**
+         * @brief The allocated size of the incoming frame buffer.
+         *
+         * This is the user-cache, where incoming data is stored.
+         * Data is stored using Frames: Header (8 bytes) + Message_Size (2 bytes) + Data (? bytes)
+         * @note Over-The-Air (OTA) transmissions don't include the message size in the transmitted packet.
          */
         #define MAIN_BUFFER_SIZE (MAX_PAYLOAD_SIZE + FRAME_HEADER_SIZE)