Skip to content

Commit 81c315a

Browse files
committed
publicly expose ce() for advanced uses.
1 parent 034be34 commit 81c315a

1 file changed

Lines changed: 19 additions & 11 deletions

File tree

RF24.h

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -617,17 +617,33 @@ class RF24
617617
*/
618618
/**@{*/
619619

620+
/**
621+
* Set radio's CE (Chip Enable) pin state.
622+
*
623+
* @warning Please see the datasheet for a much more detailed description of this pin.
624+
*
625+
* @note This is only publicly exposed for advanced use cases such as complex networking or
626+
* streaming consecutive payloads without robust error handling.
627+
* Typical uses are satisfied by simply using `startListening()` for RX mode or
628+
* `stopListening()` and `write()` for TX mode.
629+
*
630+
* @param level In RX mode, `HIGH` causes the radio to begin actively listening.
631+
* In TX mode, `HIGH` (+ 130 microsecond delay) causes the radio to begin transmitting.
632+
* Setting this to `LOW` will cause the radio to stop transmitting or receiving in any mode.
633+
*/
634+
void ce(bool level);
635+
620636
/**
621637
* Print a giant block of debugging information to stdout
622638
*
623639
* @warning Does nothing if stdout is not defined. See fdevopen in stdio.h
624640
* The printf.h file is included with the library for Arduino.
625641
* @code
626642
* #include <printf.h>
627-
* setup(){
643+
* setup() {
628644
* Serial.begin(115200);
629645
* printf_begin();
630-
* ...
646+
* // ...
631647
* }
632648
* @endcode
633649
*/
@@ -644,7 +660,7 @@ class RF24
644660
* The printf.h file is included with the library for Arduino.
645661
* @code
646662
* #include <printf.h>
647-
* setup(){
663+
* setup() {
648664
* Serial.begin(115200);
649665
* printf_begin();
650666
* // ...
@@ -1958,14 +1974,6 @@ class RF24
19581974
*/
19591975
void csn(bool mode);
19601976

1961-
/**
1962-
* Set chip enable
1963-
*
1964-
* @param level HIGH to actively begin transmission or LOW to put in standby. Please see data sheet
1965-
* for a much more detailed description of this pin.
1966-
*/
1967-
void ce(bool level);
1968-
19691977
/**
19701978
* Write a chunk of data to a register
19711979
*

0 commit comments

Comments
 (0)