Skip to content

Commit 38e42c7

Browse files
Copilot2bndy5
Copilot
and
2bndy5
committed
refactor: namespace nRF24L01.h on master base, rename CONFIG/STATUS, revert #1065 changes
Agent-Logs-Url: https://github.com/nRF24/RF24/sessions/f6f20af3-c294-4719-be64-cc4df041d703 Co-authored-by: 2bndy5 <14963867+2bndy5@users.noreply.github.com>
1 parent cd9784c commit 38e42c7

File tree

3 files changed

+71
-71
lines changed

3 files changed

+71
-71
lines changed

‎RF24.cpp‎

Lines changed: 42 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -720,7 +720,7 @@ void RF24::printDetails(void)
720720
print_byte_register(PSTR("EN_RXADDR"), EN_RXADDR);
721721
print_byte_register(PSTR("RF_CH\t"), RF_CH);
722722
print_byte_register(PSTR("RF_SETUP"), RF_SETUP);
723-
print_byte_register(PSTR("CONFIG\t"), NRF_CONFIG);
723+
print_byte_register(PSTR("CONFIG\t"), CONFIG);
724724
print_byte_register(PSTR("DYNPD/FEATURE"), DYNPD, 2);
725725

726726
printf_P(PSTR("Data Rate\t" PRIPSTR
@@ -783,7 +783,7 @@ void RF24::printPrettyDetails(void)
783783
printf_P(PSTR("Packets lost on\n current channel\t= %d\r\n"), observeTx >> 4);
784784
printf_P(PSTR("Retry attempts made for\n last transmission\t= %d\r\n"), observeTx & 0x0F);
785785

786-
uint8_t features = read_register(RF24_FEATURE);
786+
uint8_t features = read_register(FEATURE);
787787
printf_P(PSTR("Multicast\t\t" PRIPSTR
788788
"\r\n"),
789789
(char*)(pgm_read_ptr(&rf24_feature_e_str_P[static_cast<uint8_t>(static_cast<bool>(features & _BV(EN_DYN_ACK)) * 2)])));
@@ -814,7 +814,7 @@ void RF24::printPrettyDetails(void)
814814
static_cast<char>(static_cast<bool>(autoAck & _BV(ENAA_P0)) + 48));
815815
}
816816

817-
config_reg = read_register(NRF_CONFIG);
817+
config_reg = read_register(CONFIG);
818818
printf_P(PSTR("Primary Mode\t\t= %cX\r\n"), config_reg & _BV(PRIM_RX) ? 'R' : 'T');
819819
print_address_register(PSTR("TX address\t"), TX_ADDR);
820820

@@ -873,9 +873,9 @@ uint16_t RF24::sprintfPrettyDetails(char* debugging_information)
873873
((read_register(SETUP_RETR) >> ARD) * 250 + 250),
874874
(read_register(SETUP_RETR) & 0x0F), (read_register(OBSERVE_TX) >> 4),
875875
(read_register(OBSERVE_TX) & 0x0F),
876-
(char*)(pgm_read_ptr(&rf24_feature_e_str_P[static_cast<uint8_t>(static_cast<bool>(read_register(RF24_FEATURE) & _BV(EN_DYN_ACK)) * 2)])),
877-
(char*)(pgm_read_ptr(&rf24_feature_e_str_P[static_cast<uint8_t>(static_cast<bool>(read_register(RF24_FEATURE) & _BV(EN_ACK_PAY)) * 1)])),
878-
(char*)(pgm_read_ptr(&rf24_feature_e_str_P[static_cast<uint8_t>((read_register(DYNPD) && (read_register(RF24_FEATURE) & _BV(EN_DPL))) * 1)])));
876+
(char*)(pgm_read_ptr(&rf24_feature_e_str_P[static_cast<uint8_t>(static_cast<bool>(read_register(FEATURE) & _BV(EN_DYN_ACK)) * 2)])),
877+
(char*)(pgm_read_ptr(&rf24_feature_e_str_P[static_cast<uint8_t>(static_cast<bool>(read_register(FEATURE) & _BV(EN_ACK_PAY)) * 1)])),
878+
(char*)(pgm_read_ptr(&rf24_feature_e_str_P[static_cast<uint8_t>((read_register(DYNPD) && (read_register(FEATURE) & _BV(EN_DPL))) * 1)])));
879879
uint8_t autoAck = read_register(EN_AA);
880880
if (autoAck == 0x3F || autoAck == 0) {
881881
// all pipes have the same configuration about auto-ack feature
@@ -896,7 +896,7 @@ uint16_t RF24::sprintfPrettyDetails(char* debugging_information)
896896
}
897897
offset += sprintf_P(
898898
debugging_information + offset, format_str2,
899-
(read_register(NRF_CONFIG) & _BV(PRIM_RX) ? 'R' : 'T'));
899+
(read_register(CONFIG) & _BV(PRIM_RX) ? 'R' : 'T'));
900900
offset += sprintf_address_register(debugging_information + offset, TX_ADDR);
901901
uint8_t openPipes = read_register(EN_RXADDR);
902902
for (uint8_t i = 0; i < 6; ++i) {
@@ -920,8 +920,8 @@ uint16_t RF24::sprintfPrettyDetails(char* debugging_information)
920920

921921
void RF24::encodeRadioDetails(uint8_t* encoded_details)
922922
{
923-
uint8_t end = RF24_FEATURE + 1;
924-
for (uint8_t i = NRF_CONFIG; i < end; ++i) {
923+
uint8_t end = FEATURE + 1;
924+
for (uint8_t i = CONFIG; i < end; ++i) {
925925
if (i == RX_ADDR_P0 || i == RX_ADDR_P1 || i == TX_ADDR) {
926926
// get 40-bit registers
927927
read_register(i, encoded_details, 5);
@@ -1078,17 +1078,17 @@ bool RF24::_init_radio()
10781078
setDataRate(RF24_1MBPS);
10791079

10801080
// detect if is a plus variant & use old toggle features command accordingly
1081-
uint8_t before_toggle = read_register(RF24_FEATURE);
1081+
uint8_t before_toggle = read_register(FEATURE);
10821082
toggle_features();
1083-
uint8_t after_toggle = read_register(RF24_FEATURE);
1083+
uint8_t after_toggle = read_register(FEATURE);
10841084
_is_p_variant = before_toggle == after_toggle;
10851085
if (after_toggle) {
10861086
if (_is_p_variant) {
10871087
// module did not experience power-on-reset (#401)
10881088
toggle_features();
10891089
}
10901090
// allow use of multicast parameter and dynamic payloads by default
1091-
write_register(RF24_FEATURE, 0);
1091+
write_register(FEATURE, 0);
10921092
}
10931093
ack_payloads_enabled = false; // ack payloads disabled by default
10941094
write_register(DYNPD, 0); // disable dynamic payloads by default (for all pipes)
@@ -1105,7 +1105,7 @@ bool RF24::_init_radio()
11051105

11061106
// Reset current status
11071107
// Notice reset and flush is the last thing we do
1108-
write_register(NRF_STATUS, RF24_IRQ_ALL);
1108+
write_register(STATUS, RF24_IRQ_ALL);
11091109

11101110
// Flush buffers
11111111
flush_rx();
@@ -1118,8 +1118,8 @@ bool RF24::_init_radio()
11181118
// 16-bit CRC (CRC required by auto-ack)
11191119
// Do not write CE high so radio will remain in standby I mode
11201120
// PTX should use only 22uA of power
1121-
write_register(NRF_CONFIG, (_BV(EN_CRC) | _BV(CRCO) | _BV(MASK_RX_DR) | _BV(MASK_TX_DS) | _BV(MASK_MAX_RT)));
1122-
config_reg = read_register(NRF_CONFIG);
1121+
write_register(CONFIG, (_BV(EN_CRC) | _BV(CRCO) | _BV(MASK_RX_DR) | _BV(MASK_TX_DS) | _BV(MASK_MAX_RT)));
1122+
config_reg = read_register(CONFIG);
11231123

11241124
powerUp();
11251125

@@ -1149,8 +1149,8 @@ void RF24::startListening(void)
11491149
powerUp();
11501150
#endif
11511151
config_reg |= _BV(PRIM_RX);
1152-
write_register(NRF_CONFIG, config_reg);
1153-
write_register(NRF_STATUS, RF24_IRQ_ALL);
1152+
write_register(CONFIG, config_reg);
1153+
write_register(STATUS, RF24_IRQ_ALL);
11541154
ce(HIGH);
11551155

11561156
// Restore the pipe0 address, if exists
@@ -1178,7 +1178,7 @@ void RF24::stopListening(void)
11781178
}
11791179

11801180
config_reg = static_cast<uint8_t>(config_reg & ~_BV(PRIM_RX));
1181-
write_register(NRF_CONFIG, config_reg);
1181+
write_register(CONFIG, config_reg);
11821182

11831183
#if defined(RF24_TINY) || defined(LITTLEWIRE)
11841184
// for 3 pins solution TX mode is only left with additional powerDown/powerUp cycle
@@ -1215,7 +1215,7 @@ void RF24::powerDown(void)
12151215
{
12161216
ce(LOW); // Guarantee CE is low on powerDown
12171217
config_reg = static_cast<uint8_t>(config_reg & ~_BV(PWR_UP));
1218-
write_register(NRF_CONFIG, config_reg);
1218+
write_register(CONFIG, config_reg);
12191219
}
12201220

12211221
/****************************************************************************/
@@ -1226,7 +1226,7 @@ void RF24::powerUp(void)
12261226
// if not powered up then power up and wait for the radio to initialize
12271227
if (!(config_reg & _BV(PWR_UP))) {
12281228
config_reg |= _BV(PWR_UP);
1229-
write_register(NRF_CONFIG, config_reg);
1229+
write_register(CONFIG, config_reg);
12301230

12311231
// For nRF24L01+ to go from power down mode to TX or RX mode it must first pass through stand-by mode.
12321232
// There must be a delay of Tpd2stby (see Table 16.) after the nRF24L01+ leaves power down mode before
@@ -1325,7 +1325,7 @@ bool RF24::write(const void* buf, uint8_t len, const bool multicast)
13251325

13261326
ce(LOW);
13271327

1328-
write_register(NRF_STATUS, RF24_IRQ_ALL);
1328+
write_register(STATUS, RF24_IRQ_ALL);
13291329

13301330
//Max retries exceeded
13311331
if (status & RF24_TX_DF) {
@@ -1399,7 +1399,7 @@ bool RF24::writeBlocking(const void* buf, uint8_t len, uint32_t timeout)
13991399
void RF24::reUseTX()
14001400
{
14011401
ce(LOW);
1402-
write_register(NRF_STATUS, RF24_TX_DF); //Clear max retry flag
1402+
write_register(STATUS, RF24_TX_DF); //Clear max retry flag
14031403
read_register(REUSE_TX_PL, (uint8_t*)nullptr, 0);
14041404
IF_RF24_DEBUG(printf_P("[Reusing payload in TX FIFO]"););
14051405
ce(HIGH); //Re-Transfer packet
@@ -1526,7 +1526,7 @@ bool RF24::txStandBy()
15261526
#endif
15271527
while (!(read_register(FIFO_STATUS) & _BV(TX_EMPTY))) {
15281528
if (status & RF24_TX_DF) {
1529-
write_register(NRF_STATUS, RF24_TX_DF);
1529+
write_register(STATUS, RF24_TX_DF);
15301530
ce(LOW);
15311531
flush_tx(); //Non blocking, flush the data
15321532
#if defined(FAILURE_HANDLING)
@@ -1562,7 +1562,7 @@ bool RF24::txStandBy(uint32_t timeout, bool startTx)
15621562

15631563
while (!(read_register(FIFO_STATUS) & _BV(TX_EMPTY))) {
15641564
if (status & RF24_TX_DF) {
1565-
write_register(NRF_STATUS, RF24_TX_DF);
1565+
write_register(STATUS, RF24_TX_DF);
15661566
ce(LOW); // Set re-transmit
15671567
ce(HIGH);
15681568
if (millis() - start >= timeout) {
@@ -1597,7 +1597,7 @@ void RF24::maskIRQ(bool tx, bool fail, bool rx)
15971597
config_reg = static_cast<uint8_t>(config_reg & ~(1 << MASK_MAX_RT | 1 << MASK_TX_DS | 1 << MASK_RX_DR));
15981598
/* set the specified interrupt flags */
15991599
config_reg = static_cast<uint8_t>(config_reg | fail << MASK_MAX_RT | tx << MASK_TX_DS | rx << MASK_RX_DR);
1600-
write_register(NRF_CONFIG, config_reg);
1600+
write_register(CONFIG, config_reg);
16011601
}
16021602

16031603
/****************************************************************************/
@@ -1640,7 +1640,7 @@ void RF24::read(void* buf, uint8_t len)
16401640
read_payload(buf, len);
16411641

16421642
//Clear the only applicable interrupt flags
1643-
write_register(NRF_STATUS, RF24_RX_DR);
1643+
write_register(STATUS, RF24_RX_DR);
16441644
}
16451645

16461646
/****************************************************************************/
@@ -1649,7 +1649,7 @@ void RF24::whatHappened(bool& tx_ok, bool& tx_fail, bool& rx_ready)
16491649
{
16501650
// Read the status & reset the status in one easy call
16511651
// Or is that such a good idea?
1652-
write_register(NRF_STATUS, RF24_IRQ_ALL);
1652+
write_register(STATUS, RF24_IRQ_ALL);
16531653

16541654
// Report to the user what happened
16551655
tx_ok = status & RF24_TX_DS;
@@ -1661,7 +1661,7 @@ void RF24::whatHappened(bool& tx_ok, bool& tx_fail, bool& rx_ready)
16611661

16621662
uint8_t RF24::clearStatusFlags(uint8_t flags)
16631663
{
1664-
write_register(NRF_STATUS, flags & RF24_IRQ_ALL);
1664+
write_register(STATUS, flags & RF24_IRQ_ALL);
16651665
return status;
16661666
}
16671667

@@ -1671,7 +1671,7 @@ void RF24::setStatusFlags(uint8_t flags)
16711671
{
16721672
// flip the `flags` to translate from "human understanding"
16731673
config_reg = (config_reg & ~RF24_IRQ_ALL) | (~flags & RF24_IRQ_ALL);
1674-
write_register(NRF_CONFIG, config_reg);
1674+
write_register(CONFIG, config_reg);
16751675
}
16761676

16771677
/****************************************************************************/
@@ -1822,9 +1822,9 @@ void RF24::enableDynamicPayloads(void)
18221822
// Enable dynamic payload throughout the system
18231823

18241824
//toggle_features();
1825-
write_register(RF24_FEATURE, read_register(RF24_FEATURE) | _BV(EN_DPL));
1825+
write_register(FEATURE, read_register(FEATURE) | _BV(EN_DPL));
18261826

1827-
IF_RF24_DEBUG(printf_P("FEATURE=%i\r\n", read_register(RF24_FEATURE)));
1827+
IF_RF24_DEBUG(printf_P("FEATURE=%i\r\n", read_register(FEATURE)));
18281828

18291829
// Enable dynamic payload on all pipes
18301830
//
@@ -1842,9 +1842,9 @@ void RF24::disableDynamicPayloads(void)
18421842
// Disables dynamic payload throughout the system. Also disables Ack Payloads
18431843

18441844
//toggle_features();
1845-
write_register(RF24_FEATURE, 0);
1845+
write_register(FEATURE, 0);
18461846

1847-
IF_RF24_DEBUG(printf_P("FEATURE=%i\r\n", read_register(RF24_FEATURE)));
1847+
IF_RF24_DEBUG(printf_P("FEATURE=%i\r\n", read_register(FEATURE)));
18481848

18491849
// Disable dynamic payload on all pipes
18501850
//
@@ -1863,9 +1863,9 @@ void RF24::enableAckPayload(void)
18631863
// enable ack payloads and dynamic payload features
18641864

18651865
if (!ack_payloads_enabled) {
1866-
write_register(RF24_FEATURE, read_register(RF24_FEATURE) | _BV(EN_ACK_PAY) | _BV(EN_DPL));
1866+
write_register(FEATURE, read_register(FEATURE) | _BV(EN_ACK_PAY) | _BV(EN_DPL));
18671867

1868-
IF_RF24_DEBUG(printf_P("FEATURE=%i\r\n", read_register(RF24_FEATURE)));
1868+
IF_RF24_DEBUG(printf_P("FEATURE=%i\r\n", read_register(FEATURE)));
18691869

18701870
// Enable dynamic payload on pipes 0 & 1
18711871
write_register(DYNPD, read_register(DYNPD) | _BV(DPL_P1) | _BV(DPL_P0));
@@ -1880,9 +1880,9 @@ void RF24::disableAckPayload(void)
18801880
{
18811881
// disable ack payloads (leave dynamic payload features as is)
18821882
if (ack_payloads_enabled) {
1883-
write_register(RF24_FEATURE, static_cast<uint8_t>(read_register(RF24_FEATURE) & ~_BV(EN_ACK_PAY)));
1883+
write_register(FEATURE, static_cast<uint8_t>(read_register(FEATURE) & ~_BV(EN_ACK_PAY)));
18841884

1885-
IF_RF24_DEBUG(printf_P("FEATURE=%i\r\n", read_register(RF24_FEATURE)));
1885+
IF_RF24_DEBUG(printf_P("FEATURE=%i\r\n", read_register(FEATURE)));
18861886

18871887
ack_payloads_enabled = false;
18881888
}
@@ -1896,9 +1896,9 @@ void RF24::enableDynamicAck(void)
18961896
// enable dynamic ack features
18971897
//
18981898
//toggle_features();
1899-
write_register(RF24_FEATURE, read_register(RF24_FEATURE) | _BV(EN_DYN_ACK));
1899+
write_register(FEATURE, read_register(FEATURE) | _BV(EN_DYN_ACK));
19001900

1901-
IF_RF24_DEBUG(printf_P("FEATURE=%i\r\n", read_register(RF24_FEATURE)));
1901+
IF_RF24_DEBUG(printf_P("FEATURE=%i\r\n", read_register(FEATURE)));
19021902
}
19031903

19041904
/****************************************************************************/
@@ -2061,7 +2061,7 @@ void RF24::setCRCLength(rf24_crclength_e length)
20612061
config_reg |= _BV(EN_CRC);
20622062
config_reg |= _BV(CRCO);
20632063
}
2064-
write_register(NRF_CONFIG, config_reg);
2064+
write_register(CONFIG, config_reg);
20652065
}
20662066

20672067
/****************************************************************************/
@@ -2070,7 +2070,7 @@ rf24_crclength_e RF24::getCRCLength(void)
20702070
{
20712071
rf24_crclength_e result = RF24_CRC_DISABLED;
20722072
uint8_t AA = read_register(EN_AA);
2073-
config_reg = read_register(NRF_CONFIG);
2073+
config_reg = read_register(CONFIG);
20742074

20752075
if (config_reg & _BV(EN_CRC) || AA) {
20762076
if (config_reg & _BV(CRCO)) {
@@ -2089,7 +2089,7 @@ rf24_crclength_e RF24::getCRCLength(void)
20892089
void RF24::disableCRC(void)
20902090
{
20912091
config_reg = static_cast<uint8_t>(config_reg & ~_BV(EN_CRC));
2092-
write_register(NRF_CONFIG, config_reg);
2092+
write_register(CONFIG, config_reg);
20932093
}
20942094

20952095
/****************************************************************************/

‎RF24.h‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ class RF24
183183
uint8_t payload_size; /* Fixed size of payloads */
184184
uint8_t pipe0_reading_address[5]; /* Last address set on pipe 0 for reading. */
185185
uint8_t pipe0_writing_address[5]; /* Last address set on pipe 0 for writing. */
186-
uint8_t config_reg; /* For storing the value of the NRF_CONFIG register */
186+
uint8_t config_reg; /* For storing the value of the CONFIG register */
187187
bool _is_p_variant; /* For storing the result of testing the toggleFeatures() affect */
188188
bool _is_p0_rx; /* For keeping track of pipe 0's usage in user-triggered RX mode. */
189189

@@ -760,14 +760,14 @@ class RF24
760760
* Registers names and/or data corresponding to the index of the `encoded_details` array:
761761
* | index | register/data |
762762
* |------:|:--------------|
763-
* | 0 | NRF_CONFIG |
763+
* | 0 | CONFIG |
764764
* | 1 | EN_AA |
765765
* | 2 | EN_RXADDR |
766766
* | 3 | SETUP_AW |
767767
* | 4 | SETUP_RETR |
768768
* | 5 | RF_CH |
769769
* | 6 | RF_SETUP |
770-
* | 7 | NRF_STATUS |
770+
* | 7 | STATUS |
771771
* | 8 | OBSERVE_TX |
772772
* | 9 | CD (aka RPD) |
773773
* | 10-14 | RX_ADDR_P0 |

‎nRF24L01.h‎

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -31,32 +31,32 @@
3131
namespace nRF24L01 {
3232

3333
/* Memory Map */
34-
constexpr uint8_t NRF_CONFIG = 0x00;
35-
constexpr uint8_t EN_AA = 0x01;
36-
constexpr uint8_t EN_RXADDR = 0x02;
37-
constexpr uint8_t SETUP_AW = 0x03;
38-
constexpr uint8_t SETUP_RETR = 0x04;
39-
constexpr uint8_t RF_CH = 0x05;
40-
constexpr uint8_t RF_SETUP = 0x06;
41-
constexpr uint8_t NRF_STATUS = 0x07;
42-
constexpr uint8_t OBSERVE_TX = 0x08;
43-
constexpr uint8_t CD = 0x09;
44-
constexpr uint8_t RX_ADDR_P0 = 0x0A;
45-
constexpr uint8_t RX_ADDR_P1 = 0x0B;
46-
constexpr uint8_t RX_ADDR_P2 = 0x0C;
47-
constexpr uint8_t RX_ADDR_P3 = 0x0D;
48-
constexpr uint8_t RX_ADDR_P4 = 0x0E;
49-
constexpr uint8_t RX_ADDR_P5 = 0x0F;
50-
constexpr uint8_t TX_ADDR = 0x10;
51-
constexpr uint8_t RX_PW_P0 = 0x11;
52-
constexpr uint8_t RX_PW_P1 = 0x12;
53-
constexpr uint8_t RX_PW_P2 = 0x13;
54-
constexpr uint8_t RX_PW_P3 = 0x14;
55-
constexpr uint8_t RX_PW_P4 = 0x15;
56-
constexpr uint8_t RX_PW_P5 = 0x16;
57-
constexpr uint8_t FIFO_STATUS = 0x17;
58-
constexpr uint8_t DYNPD = 0x1C;
59-
constexpr uint8_t RF24_FEATURE = 0x1D;
34+
constexpr uint8_t CONFIG = 0x00;
35+
constexpr uint8_t EN_AA = 0x01;
36+
constexpr uint8_t EN_RXADDR = 0x02;
37+
constexpr uint8_t SETUP_AW = 0x03;
38+
constexpr uint8_t SETUP_RETR = 0x04;
39+
constexpr uint8_t RF_CH = 0x05;
40+
constexpr uint8_t RF_SETUP = 0x06;
41+
constexpr uint8_t STATUS = 0x07;
42+
constexpr uint8_t OBSERVE_TX = 0x08;
43+
constexpr uint8_t CD = 0x09;
44+
constexpr uint8_t RX_ADDR_P0 = 0x0A;
45+
constexpr uint8_t RX_ADDR_P1 = 0x0B;
46+
constexpr uint8_t RX_ADDR_P2 = 0x0C;
47+
constexpr uint8_t RX_ADDR_P3 = 0x0D;
48+
constexpr uint8_t RX_ADDR_P4 = 0x0E;
49+
constexpr uint8_t RX_ADDR_P5 = 0x0F;
50+
constexpr uint8_t TX_ADDR = 0x10;
51+
constexpr uint8_t RX_PW_P0 = 0x11;
52+
constexpr uint8_t RX_PW_P1 = 0x12;
53+
constexpr uint8_t RX_PW_P2 = 0x13;
54+
constexpr uint8_t RX_PW_P3 = 0x14;
55+
constexpr uint8_t RX_PW_P4 = 0x15;
56+
constexpr uint8_t RX_PW_P5 = 0x16;
57+
constexpr uint8_t FIFO_STATUS = 0x17;
58+
constexpr uint8_t DYNPD = 0x1C;
59+
constexpr uint8_t FEATURE = 0x1D;
6060

6161
/* Bit Mnemonics */
6262
constexpr uint8_t MASK_RX_DR = 6;

0 commit comments

Comments
 (0)