@@ -263,6 +263,9 @@ class RF24
263
263
* timeout, and return 1 or 0 respectively. From a user perspective, just
264
264
* keep trying to send the same data. The library will keep auto retrying
265
265
* the current payload using the built in functionality.
266
+ * @warning It is important to never keep the nRF24L01 in TX mode for more than 4ms at a time. If the auto
267
+ * retransmit is enabled, the nRF24L01 is never in TX mode long enough to disobey this rule. Allow the FIFO
268
+ * to clear by issuing txStandBy() or ensure appropriate time between transmissions.
266
269
*
267
270
* ONLY max retry interrupt flags will be cleared when writeFast is called
268
271
*
@@ -292,6 +295,9 @@ class RF24
292
295
* It will not block until the 3 FIFO buffers are filled with data.
293
296
* If so the library will auto retry until a new payload is written
294
297
* or the user specified timeout period is reached.
298
+ * @warning It is important to never keep the nRF24L01 in TX mode for more than 4ms at a time. If the auto
299
+ * retransmit is enabled, the nRF24L01 is never in TX mode long enough to disobey this rule. Allow the FIFO
300
+ * to clear by issuing txStandBy() or ensure appropriate time between transmissions.
295
301
*
296
302
* ONLY max retry interrupt flags will be cleared when writeBlocking is called
297
303
* @code
@@ -409,6 +415,9 @@ class RF24
409
415
* @note Optimization: This function now leaves the CE pin high, so the radio
410
416
* will remain in TX or STANDBY-II Mode until a txStandBy() command is issued.
411
417
* This allows the chip to be used to its full potential in TX mode.
418
+ * @warning It is important to never keep the nRF24L01 in TX mode for more than 4ms at a time. If the auto
419
+ * retransmit is enabled, the nRF24L01 is never in TX mode long enough to disobey this rule. Allow the FIFO
420
+ * to clear by issuing txStandBy() or ensure appropriate time between transmissions.
412
421
*
413
422
* @see write()
414
423
* @see writeFast()
@@ -500,7 +509,20 @@ class RF24
500
509
bool isValid () { return ce_pin != 0xff && csn_pin != 0xff ; }
501
510
502
511
/* *
512
+ * The radio will generate interrupt signals when a transmission is complete,
513
+ * a transmission fails, or a payload is received. This allows users to mask
514
+ * those interrupts to prevent them from generating a signal on the interrupt
515
+ * pin.
503
516
*
517
+ * @code
518
+ * Mask all interrupts except the receive interrupt:
519
+ *
520
+ * radio.maskIRQ(1,1,0);
521
+ * @endcode
522
+ *
523
+ * @param tx_ok Mask transmission complete interrupts
524
+ * @param tx_fail Mask transmit failure interrupts
525
+ * @param rx_ready Mask payload received interrupts
504
526
*/
505
527
void maskIRQ (bool tx_ok,bool tx_fail,bool rx_ready);
506
528
@@ -995,7 +1017,8 @@ class RF24
995
1017
* - Changes to read() functionality have increased reliability and response
996
1018
* - Extended timeout periods have been added to aid in noisy or otherwise unreliable environments
997
1019
* - Delays have been removed where possible to ensure maximum efficiency
998
- * - Untested: Arduino Due and ATTiny 84/85 support: Do NOT #include <SPI.h> with ATTiny.
1020
+ * - Full Due support with extended SPI functions
1021
+ * - Initial ATTiny support added (Untested)
999
1022
* - More! See the links below and class documentation for more info.
1000
1023
*
1001
1024
* If issues are discovered with the documentation, please report them here: <a href="https://github.com/TMRh20/tmrh20.github.io/issues"> here</a>
@@ -1013,6 +1036,15 @@ class RF24
1013
1036
* This chip uses the SPI bus, plus two chip control pins. Remember that pin 10 must still remain an output, or
1014
1037
* the SPI hardware will go into 'slave' mode.
1015
1038
*
1039
+ * @section BoardSupport Board Support
1040
+ *
1041
+ * Most standard Arduino based boards are supported:
1042
+ * - ATMega 328 based boards (Uno, Nano, etc)
1043
+ * - Mega Boards (1280, 2560, etc)
1044
+ * - ARM based boards (Arduino Due) Note: Do not include printf.h or use printf begin. This functionality is already present. Must use one of the
1045
+ * hardware SS/CSN pins.
1046
+ * - ATTiny boards (Not fully tested) Note: Do not include SPI.h. The SPI functions for ATTiny are already included.
1047
+ *
1016
1048
* @section More More Information
1017
1049
*
1018
1050
* @section Info and Projects
0 commit comments