RadioLib Universal wireless communication library for Arduino

nRF24.h
1 #if !defined(_RADIOLIB_NRF24_H) && !RADIOLIB_EXCLUDE_NRF24
2 #define _RADIOLIB_NRF24_H
3
4 #include "../../Module.h"
5 #include "../../TypeDef.h"
6
7 #include "../../protocols/PhysicalLayer/PhysicalLayer.h"
8
9 // nRF24 physical layer properties
10 #define RADIOLIB_NRF24_FREQUENCY_STEP_SIZE 1000000.0
11 #define RADIOLIB_NRF24_MAX_PACKET_LENGTH 32
12
13 // nRF24 SPI commands
14 #define RADIOLIB_NRF24_CMD_READ 0b00000000
15 #define RADIOLIB_NRF24_CMD_WRITE 0b00100000
16 #define RADIOLIB_NRF24_CMD_READ_RX_PAYLOAD 0b01100001
17 #define RADIOLIB_NRF24_CMD_WRITE_TX_PAYLOAD 0b10100000
18 #define RADIOLIB_NRF24_CMD_FLUSH_TX 0b11100001
19 #define RADIOLIB_NRF24_CMD_FLUSH_RX 0b11100010
20 #define RADIOLIB_NRF24_CMD_REUSE_TX_PAXLOAD 0b11100011
21 #define RADIOLIB_NRF24_CMD_READ_RX_PAYLOAD_WIDTH 0b01100000
22 #define RADIOLIB_NRF24_CMD_WRITE_ACK_PAYLOAD 0b10101000
23 #define RADIOLIB_NRF24_CMD_WRITE_TX_PAYLOAD_NOACK 0b10110000
24 #define RADIOLIB_NRF24_CMD_NOP 0b11111111
25
26 // nRF24 register map
27 #define RADIOLIB_NRF24_REG_CONFIG 0x00
28 #define RADIOLIB_NRF24_REG_EN_AA 0x01
29 #define RADIOLIB_NRF24_REG_EN_RXADDR 0x02
30 #define RADIOLIB_NRF24_REG_SETUP_AW 0x03
31 #define RADIOLIB_NRF24_REG_SETUP_RETR 0x04
32 #define RADIOLIB_NRF24_REG_RF_CH 0x05
33 #define RADIOLIB_NRF24_REG_RF_SETUP 0x06
34 #define RADIOLIB_NRF24_REG_STATUS 0x07
35 #define RADIOLIB_NRF24_REG_OBSERVE_TX 0x08
36 #define RADIOLIB_NRF24_REG_RPD 0x09
37 #define RADIOLIB_NRF24_REG_RX_ADDR_P0 0x0A
38 #define RADIOLIB_NRF24_REG_RX_ADDR_P1 0x0B
39 #define RADIOLIB_NRF24_REG_RX_ADDR_P2 0x0C
40 #define RADIOLIB_NRF24_REG_RX_ADDR_P3 0x0D
41 #define RADIOLIB_NRF24_REG_RX_ADDR_P4 0x0E
42 #define RADIOLIB_NRF24_REG_RX_ADDR_P5 0x0F
43 #define RADIOLIB_NRF24_REG_TX_ADDR 0x10
44 #define RADIOLIB_NRF24_REG_RX_PW_P0 0x11
45 #define RADIOLIB_NRF24_REG_RX_PW_P1 0x12
46 #define RADIOLIB_NRF24_REG_RX_PW_P2 0x13
47 #define RADIOLIB_NRF24_REG_RX_PW_P3 0x14
48 #define RADIOLIB_NRF24_REG_RX_PW_P4 0x15
49 #define RADIOLIB_NRF24_REG_RX_PW_P5 0x16
50 #define RADIOLIB_NRF24_REG_FIFO_STATUS 0x17
51 #define RADIOLIB_NRF24_REG_DYNPD 0x1C
52 #define RADIOLIB_NRF24_REG_FEATURE 0x1D
53
54 // RADIOLIB_NRF24_REG_CONFIG MSB LSB DESCRIPTION
55 #define RADIOLIB_NRF24_MASK_RX_DR_IRQ_OFF 0b01000000 // 6 6 RX_DR will not be reflected on IRQ pin
56 #define RADIOLIB_NRF24_MASK_RX_DR_IRQ_ON 0b00000000 // 6 6 RX_DR will be reflected on IRQ pin as active low (default)
57 #define RADIOLIB_NRF24_MASK_TX_DS_IRQ_OFF 0b00100000 // 5 5 TX_DS will not be reflected on IRQ pin
58 #define RADIOLIB_NRF24_MASK_TX_DS_IRQ_ON 0b00000000 // 5 5 TX_DS will be reflected on IRQ pin as active low (default)
59 #define RADIOLIB_NRF24_MASK_MAX_RT_IRQ_OFF 0b00010000 // 4 4 MAX_RT will not be reflected on IRQ pin
60 #define RADIOLIB_NRF24_MASK_MAX_RT_IRQ_ON 0b00000000 // 4 4 MAX_RT will be reflected on IRQ pin as active low (default)
61 #define RADIOLIB_NRF24_CRC_OFF 0b00000000 // 3 3 CRC calculation: disabled
62 #define RADIOLIB_NRF24_CRC_ON 0b00001000 // 3 3 enabled (default)
63 #define RADIOLIB_NRF24_CRC_8 0b00000000 // 2 2 CRC scheme: CRC8 (default)
64 #define RADIOLIB_NRF24_CRC_16 0b00000100 // 2 2 CRC16
65 #define RADIOLIB_NRF24_POWER_UP 0b00000010 // 1 1 power up
66 #define RADIOLIB_NRF24_POWER_DOWN 0b00000000 // 1 1 power down
67 #define RADIOLIB_NRF24_PTX 0b00000000 // 0 0 enable primary Tx
68 #define RADIOLIB_NRF24_PRX 0b00000001 // 0 0 enable primary Rx
69
70 // RADIOLIB_NRF24_REG_EN_AA
71 #define RADIOLIB_NRF24_AA_ALL_OFF 0b00000000 // 5 0 auto-ACK on all pipes: disabled
72 #define RADIOLIB_NRF24_AA_ALL_ON 0b00111111 // 5 0 enabled (default)
73 #define RADIOLIB_NRF24_AA_P5_OFF 0b00000000 // 5 5 auto-ACK on pipe 5: disabled
74 #define RADIOLIB_NRF24_AA_P5_ON 0b00100000 // 5 5 enabled (default)
75 #define RADIOLIB_NRF24_AA_P4_OFF 0b00000000 // 4 4 auto-ACK on pipe 4: disabled
76 #define RADIOLIB_NRF24_AA_P4_ON 0b00010000 // 4 4 enabled (default)
77 #define RADIOLIB_NRF24_AA_P3_OFF 0b00000000 // 3 3 auto-ACK on pipe 3: disabled
78 #define RADIOLIB_NRF24_AA_P3_ON 0b00001000 // 3 3 enabled (default)
79 #define RADIOLIB_NRF24_AA_P2_OFF 0b00000000 // 2 2 auto-ACK on pipe 2: disabled
80 #define RADIOLIB_NRF24_AA_P2_ON 0b00000100 // 2 2 enabled (default)
81 #define RADIOLIB_NRF24_AA_P1_OFF 0b00000000 // 1 1 auto-ACK on pipe 1: disabled
82 #define RADIOLIB_NRF24_AA_P1_ON 0b00000010 // 1 1 enabled (default)
83 #define RADIOLIB_NRF24_AA_P0_OFF 0b00000000 // 0 0 auto-ACK on pipe 0: disabled
84 #define RADIOLIB_NRF24_AA_P0_ON 0b00000001 // 0 0 enabled (default)
85
86 // RADIOLIB_NRF24_REG_EN_RXADDR
87 #define RADIOLIB_NRF24_P5_OFF 0b00000000 // 5 5 receive pipe 5: disabled (default)
88 #define RADIOLIB_NRF24_P5_ON 0b00100000 // 5 5 enabled
89 #define RADIOLIB_NRF24_P4_OFF 0b00000000 // 4 4 receive pipe 4: disabled (default)
90 #define RADIOLIB_NRF24_P4_ON 0b00010000 // 4 4 enabled
91 #define RADIOLIB_NRF24_P3_OFF 0b00000000 // 3 3 receive pipe 3: disabled (default)
92 #define RADIOLIB_NRF24_P3_ON 0b00001000 // 3 3 enabled
93 #define RADIOLIB_NRF24_P2_OFF 0b00000000 // 2 2 receive pipe 2: disabled (default)
94 #define RADIOLIB_NRF24_P2_ON 0b00000100 // 2 2 enabled
95 #define RADIOLIB_NRF24_P1_OFF 0b00000000 // 1 1 receive pipe 1: disabled
96 #define RADIOLIB_NRF24_P1_ON 0b00000010 // 1 1 enabled (default)
97 #define RADIOLIB_NRF24_P0_OFF 0b00000000 // 0 0 receive pipe 0: disabled
98 #define RADIOLIB_NRF24_P0_ON 0b00000001 // 0 0 enabled (default)
99
100 // RADIOLIB_NRF24_REG_SETUP_AW
101 #define RADIOLIB_NRF24_ADDRESS_2_BYTES 0b00000000 // 1 0 address width: 2 bytes
102 #define RADIOLIB_NRF24_ADDRESS_3_BYTES 0b00000001 // 1 0 3 bytes
103 #define RADIOLIB_NRF24_ADDRESS_4_BYTES 0b00000010 // 1 0 4 bytes
104 #define RADIOLIB_NRF24_ADDRESS_5_BYTES 0b00000011 // 1 0 5 bytes (default)
105
106 // RADIOLIB_NRF24_REG_SETUP_RETR
107 #define RADIOLIB_NRF24_ARD 0b00000000 // 7 4 auto retransmit delay: t[us] = (NRF24_ARD + 1) * 250 us
108 #define RADIOLIB_NRF24_ARC_OFF 0b00000000 // 3 0 auto retransmit count: auto retransmit disabled
109 #define RADIOLIB_NRF24_ARC 0b00000011 // 3 0 up to 3 retransmits on AA fail (default)
110
111 // RADIOLIB_NRF24_REG_RF_CH
112 #define RADIOLIB_NRF24_RF_CH 0b00000010 // 6 0 RF channel: f_CH[MHz] = 2400 MHz + NRF24_RF_CH
113
114 // RADIOLIB_NRF24_REG_RF_SETUP
115 #define RADIOLIB_NRF24_CONT_WAVE_OFF 0b00000000 // 7 7 continuous carrier transmit: disabled (default)
116 #define RADIOLIB_NRF24_CONT_WAVE_ON 0b10000000 // 7 7 enabled
117 #define RADIOLIB_NRF24_DR_250_KBPS 0b00100000 // 5 5 data rate: 250 kbps
118 #define RADIOLIB_NRF24_DR_1_MBPS 0b00000000 // 3 3 1 Mbps (default)
119 #define RADIOLIB_NRF24_DR_2_MBPS 0b00001000 // 3 3 2 Mbps
120 #define RADIOLIB_NRF24_PLL_LOCK_ON 0b00010000 // 4 4 force PLL lock: enabled
121 #define RADIOLIB_NRF24_PLL_LOCK_OFF 0b00000000 // 4 4 disabled (default)
122 #define RADIOLIB_NRF24_RF_PWR_18_DBM 0b00000000 // 2 1 output power: -18 dBm
123 #define RADIOLIB_NRF24_RF_PWR_12_DBM 0b00000010 // 2 1 -12 dBm
124 #define RADIOLIB_NRF24_RF_PWR_6_DBM 0b00000100 // 2 1 -6 dBm
125 #define RADIOLIB_NRF24_RF_PWR_0_DBM 0b00000110 // 2 1 0 dBm (default)
126
127 // RADIOLIB_NRF24_REG_STATUS
128 #define RADIOLIB_NRF24_RX_DR 0b01000000 // 6 6 Rx data ready
129 #define RADIOLIB_NRF24_TX_DS 0b00100000 // 5 5 Tx data sent
130 #define RADIOLIB_NRF24_MAX_RT 0b00010000 // 4 4 maximum number of retransmits reached (must be cleared to continue)
131 #define RADIOLIB_NRF24_RX_FIFO_EMPTY 0b00001110 // 3 1 Rx FIFO is empty
132 #define RADIOLIB_NRF24_RX_P_NO 0b00000000 // 3 1 number of data pipe that received data
133 #define RADIOLIB_NRF24_TX_FIFO_FULL 0b00000001 // 0 0 Tx FIFO is full
134
135 // RADIOLIB_NRF24_REG_OBSERVE_TX
136 #define RADIOLIB_NRF24_PLOS_CNT 0b00000000 // 7 4 number of lost packets
137 #define RADIOLIB_NRF24_ARC_CNT 0b00000000 // 3 0 number of retransmitted packets
138
139 // RADIOLIB_NRF24_REG_RPD
140 #define RADIOLIB_NRF24_RP_BELOW_64_DBM 0b00000000 // 0 0 received power in the current channel: less than -64 dBm
141 #define RADIOLIB_NRF24_RP_ABOVE_64_DBM 0b00000001 // 0 0 more than -64 dBm
142
143 // RADIOLIB_NRF24_REG_FIFO_STATUS
144 #define RADIOLIB_NRF24_TX_REUSE 0b01000000 // 6 6 reusing last transmitted payload
145 #define RADIOLIB_NRF24_TX_FIFO_FULL_FLAG 0b00100000 // 5 5 Tx FIFO is full
146 #define RADIOLIB_NRF24_TX_FIFO_EMPTY_FLAG 0b00010000 // 4 4 Tx FIFO is empty
147 #define RADIOLIB_NRF24_RX_FIFO_FULL_FLAG 0b00000010 // 1 1 Rx FIFO is full
148 #define RADIOLIB_NRF24_RX_FIFO_EMPTY_FLAG 0b00000001 // 0 0 Rx FIFO is empty
149
150 // RADIOLIB_NRF24_REG_DYNPD
151 #define RADIOLIB_NRF24_DPL_P5_OFF 0b00000000 // 5 5 dynamic payload length on pipe 5: disabled (default)
152 #define RADIOLIB_NRF24_DPL_P5_ON 0b00100000 // 5 5 enabled
153 #define RADIOLIB_NRF24_DPL_P4_OFF 0b00000000 // 4 4 dynamic payload length on pipe 4: disabled (default)
154 #define RADIOLIB_NRF24_DPL_P4_ON 0b00010000 // 4 4 enabled
155 #define RADIOLIB_NRF24_DPL_P3_OFF 0b00000000 // 3 3 dynamic payload length on pipe 3: disabled (default)
156 #define RADIOLIB_NRF24_DPL_P3_ON 0b00001000 // 3 3 enabled
157 #define RADIOLIB_NRF24_DPL_P2_OFF 0b00000000 // 2 2 dynamic payload length on pipe 2: disabled (default)
158 #define RADIOLIB_NRF24_DPL_P2_ON 0b00000100 // 2 2 enabled
159 #define RADIOLIB_NRF24_DPL_P1_OFF 0b00000000 // 1 1 dynamic payload length on pipe 1: disabled (default)
160 #define RADIOLIB_NRF24_DPL_P1_ON 0b00000010 // 1 1 enabled
161 #define RADIOLIB_NRF24_DPL_P0_OFF 0b00000000 // 0 0 dynamic payload length on pipe 0: disabled (default)
162 #define RADIOLIB_NRF24_DPL_P0_ON 0b00000001 // 0 0 enabled
163 #define RADIOLIB_NRF24_DPL_ALL_OFF 0b00000000 // 5 0 disable all dynamic payloads
164 #define RADIOLIB_NRF24_DPL_ALL_ON 0b00111111 // 5 0 enable all dynamic payloads
165
166 // RADIOLIB_NRF24_REG_FEATURE
167 #define RADIOLIB_NRF24_DPL_OFF 0b00000000 // 2 2 dynamic payload length: disabled (default)
168 #define RADIOLIB_NRF24_DPL_ON 0b00000100 // 2 2 enabled
169 #define RADIOLIB_NRF24_ACK_PAY_OFF 0b00000000 // 1 1 payload with ACK packets: disabled (default)
170 #define RADIOLIB_NRF24_ACK_PAY_ON 0b00000010 // 1 1 enabled
171 #define RADIOLIB_NRF24_DYN_ACK_OFF 0b00000000 // 0 0 payloads without ACK: disabled (default)
172 #define RADIOLIB_NRF24_DYN_ACK_ON 0b00000001 // 0 0 enabled
173
174 // RadioLib defaults
175 #define RADIOLIB_NRF24_DEFAULT_FREQ 2400
176 #define RADIOLIB_NRF24_DEFAULT_DR 1000
177 #define RADIOLIB_NRF24_DEFAULT_POWER -12
178 #define RADIOLIB_NRF24_DEFAULT_ADDRWIDTH 5
179
184 class nRF24: public PhysicalLayer {
185 public:
186 // introduce PhysicalLayer overloads
187 using PhysicalLayer::transmit;
188 using PhysicalLayer::receive;
189 using PhysicalLayer::startTransmit;
190 using PhysicalLayer::readData;
191
196 nRF24(Module* mod);
197
198 // basic methods
199
208 int16_t begin(
209 int16_t freq = RADIOLIB_NRF24_DEFAULT_FREQ,
210 int16_t dr = RADIOLIB_NRF24_DEFAULT_DR,
211 int8_t pwr = RADIOLIB_NRF24_DEFAULT_POWER,
212 uint8_t addrWidth = RADIOLIB_NRF24_DEFAULT_ADDRWIDTH);
213
218 int16_t sleep();
219
224 int16_t standby() override;
225
231 int16_t standby(uint8_t mode) override;
232
241 int16_t transmit(uint8_t* data, size_t len, uint8_t addr) override;
242
250 int16_t receive(uint8_t* data, size_t len) override;
251
257 int16_t transmitDirect(uint32_t frf = 0) override;
258
263 int16_t receiveDirect() override;
264
265 // interrupt methods
266
271 void setIrqAction(void (*func)(void));
272
276 void clearIrqAction();
277
282 void setPacketReceivedAction(void (*func)(void));
283
287 void clearPacketReceivedAction();
288
293 void setPacketSentAction(void (*func)(void));
294
298 void clearPacketSentAction();
299
308 int16_t startTransmit(uint8_t* data, size_t len, uint8_t addr) override;
309
314 int16_t finishTransmit() override;
315
320 int16_t startReceive();
321
330 int16_t startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len);
331
339 int16_t readData(uint8_t* data, size_t len) override;
340
341 // configuration methods
342
348 int16_t setFrequency(float freq);
349
355 int16_t setBitRate(float br);
356
362 int16_t setOutputPower(int8_t pwr);
363
369 int16_t setAddressWidth(uint8_t addrWidth);
370
377 int16_t setTransmitPipe(uint8_t* addr);
378
387 int16_t setReceivePipe(uint8_t pipeNum, uint8_t* addr);
388
396 int16_t setReceivePipe(uint8_t pipeNum, uint8_t addrByte);
397
403 int16_t disablePipe(uint8_t pipeNum);
404
410 int16_t getStatus(uint8_t mask = 0xFF);
411
416 bool isCarrierDetected();
417
423 int16_t setFrequencyDeviation(float freqDev) override;
424
430 size_t getPacketLength(bool update = true) override;
431
437 int16_t setCrcFiltering(bool crcOn = true);
438
444 int16_t setAutoAck(bool autoAckOn = true);
445
452 int16_t setAutoAck(uint8_t pipeNum, bool autoAckOn);
453
459 int16_t setDataShaping(uint8_t sh) override;
460
466 int16_t setEncoding(uint8_t encoding) override;
467
468 #if !RADIOLIB_GODMODE && !RADIOLIB_LOW_LEVEL
469 protected:
470 #endif
471 Module* getMod();
472
473 void SPIreadRxPayload(uint8_t* data, uint8_t numBytes);
474 void SPIwriteTxPayload(uint8_t* data, uint8_t numBytes);
475 void SPItransfer(uint8_t cmd, bool write = false, uint8_t* dataOut = NULL, uint8_t* dataIn = NULL, uint8_t numBytes = 0);
476
477 #if !RADIOLIB_GODMODE
478 private:
479 #endif
480 Module* mod;
481
482 int16_t frequency = RADIOLIB_NRF24_DEFAULT_FREQ;
483 int16_t dataRate = RADIOLIB_NRF24_DEFAULT_DR;
484 int8_t power = RADIOLIB_NRF24_DEFAULT_POWER;
485 uint8_t addressWidth = RADIOLIB_NRF24_DEFAULT_ADDRWIDTH;
486
487 int16_t config();
488 void clearIRQ();
489 };
490
491 #endif
Module
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:68
PhysicalLayer
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:54
PhysicalLayer::readData
virtual int16_t readData(uint8_t *data, size_t len)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:209
PhysicalLayer::transmit
int16_t transmit(const char *str, uint8_t addr=0)
C-string transmit method.
Definition: PhysicalLayer.cpp:52
PhysicalLayer::startTransmit
int16_t startTransmit(const char *str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:149
PhysicalLayer::receive
virtual int16_t receive(uint8_t *data, size_t len)
Binary receive method. Must be implemented in module class.
Definition: PhysicalLayer.cpp:112
nRF24
Control class for nRF24 module.
Definition: nRF24.h:184
nRF24::sleep
int16_t sleep()
Sets the module to sleep mode.
Definition: nRF24.cpp:67
nRF24::setEncoding
int16_t setEncoding(uint8_t encoding) override
Dummy encoding configuration method, to ensure PhysicalLayer compatibility.
Definition: nRF24.cpp:557
nRF24::setBitRate
int16_t setBitRate(float br)
Sets bit rate. Allowed values are 2000, 1000 or 250 kbps.
Definition: nRF24.cpp:295
nRF24::setPacketReceivedAction
void setPacketReceivedAction(void(*func)(void))
Sets interrupt service routine to call when a packet is received.
Definition: nRF24.cpp:162
nRF24::transmitDirect
int16_t transmitDirect(uint32_t frf=0) override
Starts direct mode transmission.
Definition: nRF24.cpp:133
nRF24::setDataShaping
int16_t setDataShaping(uint8_t sh) override
Dummy data shaping configuration method, to ensure PhysicalLayer compatibility.
Definition: nRF24.cpp:550
nRF24::begin
int16_t begin(int16_t freq=RADIOLIB_NRF24_DEFAULT_FREQ, int16_t dr=RADIOLIB_NRF24_DEFAULT_DR, int8_t pwr=RADIOLIB_NRF24_DEFAULT_POWER, uint8_t addrWidth=RADIOLIB_NRF24_DEFAULT_ADDRWIDTH)
Initialization method.
Definition: nRF24.cpp:9
nRF24::getPacketLength
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition: nRF24.cpp:503
nRF24::setReceivePipe
int16_t setReceivePipe(uint8_t pipeNum, uint8_t *addr)
Sets address of receive pipes 0 or 1. The address width must be the same as the same as the configure...
Definition: nRF24.cpp:405
nRF24::readData
virtual int16_t readData(uint8_t *data, size_t len)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:209
nRF24::setCrcFiltering
int16_t setCrcFiltering(bool crcOn=true)
Enable CRC filtering and generation.
Definition: nRF24.cpp:510
nRF24::getStatus
int16_t getStatus(uint8_t mask=0xFF)
Gets nRF24 status register.
Definition: nRF24.cpp:488
nRF24::setFrequency
int16_t setFrequency(float freq)
Sets carrier frequency. Allowed values range from 2400 MHz to 2525 MHz.
Definition: nRF24.cpp:281
nRF24::receiveDirect
int16_t receiveDirect() override
Dummy direct mode reception method, to ensure PhysicalLayer compatibility.
Definition: nRF24.cpp:148
nRF24::clearPacketReceivedAction
void clearPacketReceivedAction()
Clears interrupt service routine to call when a packet is received.
Definition: nRF24.cpp:166
nRF24::transmit
int16_t transmit(const char *str, uint8_t addr=0)
C-string transmit method.
Definition: PhysicalLayer.cpp:52
nRF24::disablePipe
int16_t disablePipe(uint8_t pipeNum)
Disables specified receive pipe.
Definition: nRF24.cpp:457
nRF24::setFrequencyDeviation
int16_t setFrequencyDeviation(float freqDev) override
Dummy configuration method, to ensure PhysicalLayer compatibility.
Definition: nRF24.cpp:496
nRF24::standby
int16_t standby() override
Sets the module to standby mode.
Definition: nRF24.cpp:71
nRF24::clearPacketSentAction
void clearPacketSentAction()
Clears interrupt service routine to call when a packet is sent.
Definition: nRF24.cpp:174
nRF24::setAddressWidth
int16_t setAddressWidth(uint8_t addrWidth)
Sets address width of transmit and receive pipes in bytes. Allowed values are 3, 4 or 5 bytes.
Definition: nRF24.cpp:357
nRF24::setPacketSentAction
void setPacketSentAction(void(*func)(void))
Sets interrupt service routine to call when a packet is sent.
Definition: nRF24.cpp:170
nRF24::startTransmit
int16_t startTransmit(const char *str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:149
nRF24::setTransmitPipe
int16_t setTransmitPipe(uint8_t *addr)
Sets address of transmit pipe. The address width must be the same as the same as the configured in se...
Definition: nRF24.cpp:390
nRF24::clearIrqAction
void clearIrqAction()
Clears interrupt service routine .
Definition: nRF24.cpp:158
nRF24::nRF24
nRF24(Module *mod)
Default constructor.
Definition: nRF24.cpp:5
nRF24::receive
virtual int16_t receive(uint8_t *data, size_t len)
Binary receive method. Must be implemented in module class.
Definition: PhysicalLayer.cpp:112
nRF24::setIrqAction
void setIrqAction(void(*func)(void))
Sets interrupt service routine to call when IRQ activates.
Definition: nRF24.cpp:154
nRF24::setAutoAck
int16_t setAutoAck(bool autoAckOn=true)
Enable or disable auto-acknowledge packets on all pipes.
Definition: nRF24.cpp:521
nRF24::isCarrierDetected
bool isCarrierDetected()
Checks if carrier was detected during last RX.
Definition: nRF24.cpp:492
nRF24::setOutputPower
int16_t setOutputPower(int8_t pwr)
Sets output power. Allowed values are -18, -12, -6 or 0 dBm.
Definition: nRF24.cpp:323
nRF24::finishTransmit
int16_t finishTransmit() override
Clean up after transmission is done.
Definition: nRF24.cpp:218
nRF24::startReceive
int16_t startReceive()
Interrupt-driven receive method. IRQ will be activated when full packet is received.
Definition: nRF24.cpp:226