1#if !defined(_RADIOLIB_NRF24_H) && !RADIOLIB_EXCLUDE_NRF24
2#define _RADIOLIB_NRF24_H
4#include "../../Module.h"
5#include "../../TypeDef.h"
7#include "../../protocols/PhysicalLayer/PhysicalLayer.h"
10#define RADIOLIB_NRF24_FREQUENCY_STEP_SIZE 1000000.0
11#define RADIOLIB_NRF24_MAX_PACKET_LENGTH 32
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
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
55#define RADIOLIB_NRF24_MASK_RX_DR_IRQ_OFF 0b01000000
56#define RADIOLIB_NRF24_MASK_RX_DR_IRQ_ON 0b00000000
57#define RADIOLIB_NRF24_MASK_TX_DS_IRQ_OFF 0b00100000
58#define RADIOLIB_NRF24_MASK_TX_DS_IRQ_ON 0b00000000
59#define RADIOLIB_NRF24_MASK_MAX_RT_IRQ_OFF 0b00010000
60#define RADIOLIB_NRF24_MASK_MAX_RT_IRQ_ON 0b00000000
61#define RADIOLIB_NRF24_CRC_OFF 0b00000000
62#define RADIOLIB_NRF24_CRC_ON 0b00001000
63#define RADIOLIB_NRF24_CRC_8 0b00000000
64#define RADIOLIB_NRF24_CRC_16 0b00000100
65#define RADIOLIB_NRF24_POWER_UP 0b00000010
66#define RADIOLIB_NRF24_POWER_DOWN 0b00000000
67#define RADIOLIB_NRF24_PTX 0b00000000
68#define RADIOLIB_NRF24_PRX 0b00000001
71#define RADIOLIB_NRF24_AA_ALL_OFF 0b00000000
72#define RADIOLIB_NRF24_AA_ALL_ON 0b00111111
73#define RADIOLIB_NRF24_AA_P5_OFF 0b00000000
74#define RADIOLIB_NRF24_AA_P5_ON 0b00100000
75#define RADIOLIB_NRF24_AA_P4_OFF 0b00000000
76#define RADIOLIB_NRF24_AA_P4_ON 0b00010000
77#define RADIOLIB_NRF24_AA_P3_OFF 0b00000000
78#define RADIOLIB_NRF24_AA_P3_ON 0b00001000
79#define RADIOLIB_NRF24_AA_P2_OFF 0b00000000
80#define RADIOLIB_NRF24_AA_P2_ON 0b00000100
81#define RADIOLIB_NRF24_AA_P1_OFF 0b00000000
82#define RADIOLIB_NRF24_AA_P1_ON 0b00000010
83#define RADIOLIB_NRF24_AA_P0_OFF 0b00000000
84#define RADIOLIB_NRF24_AA_P0_ON 0b00000001
87#define RADIOLIB_NRF24_P5_OFF 0b00000000
88#define RADIOLIB_NRF24_P5_ON 0b00100000
89#define RADIOLIB_NRF24_P4_OFF 0b00000000
90#define RADIOLIB_NRF24_P4_ON 0b00010000
91#define RADIOLIB_NRF24_P3_OFF 0b00000000
92#define RADIOLIB_NRF24_P3_ON 0b00001000
93#define RADIOLIB_NRF24_P2_OFF 0b00000000
94#define RADIOLIB_NRF24_P2_ON 0b00000100
95#define RADIOLIB_NRF24_P1_OFF 0b00000000
96#define RADIOLIB_NRF24_P1_ON 0b00000010
97#define RADIOLIB_NRF24_P0_OFF 0b00000000
98#define RADIOLIB_NRF24_P0_ON 0b00000001
101#define RADIOLIB_NRF24_ADDRESS_2_BYTES 0b00000000
102#define RADIOLIB_NRF24_ADDRESS_3_BYTES 0b00000001
103#define RADIOLIB_NRF24_ADDRESS_4_BYTES 0b00000010
104#define RADIOLIB_NRF24_ADDRESS_5_BYTES 0b00000011
107#define RADIOLIB_NRF24_ARD 0b00000000
108#define RADIOLIB_NRF24_ARC_OFF 0b00000000
109#define RADIOLIB_NRF24_ARC 0b00000011
112#define RADIOLIB_NRF24_RF_CH 0b00000010
115#define RADIOLIB_NRF24_CONT_WAVE_OFF 0b00000000
116#define RADIOLIB_NRF24_CONT_WAVE_ON 0b10000000
117#define RADIOLIB_NRF24_DR_250_KBPS 0b00100000
118#define RADIOLIB_NRF24_DR_1_MBPS 0b00000000
119#define RADIOLIB_NRF24_DR_2_MBPS 0b00001000
120#define RADIOLIB_NRF24_PLL_LOCK_ON 0b00010000
121#define RADIOLIB_NRF24_PLL_LOCK_OFF 0b00000000
122#define RADIOLIB_NRF24_RF_PWR_18_DBM 0b00000000
123#define RADIOLIB_NRF24_RF_PWR_12_DBM 0b00000010
124#define RADIOLIB_NRF24_RF_PWR_6_DBM 0b00000100
125#define RADIOLIB_NRF24_RF_PWR_0_DBM 0b00000110
128#define RADIOLIB_NRF24_RX_DR 0b01000000
129#define RADIOLIB_NRF24_TX_DS 0b00100000
130#define RADIOLIB_NRF24_MAX_RT 0b00010000
131#define RADIOLIB_NRF24_RX_FIFO_EMPTY 0b00001110
132#define RADIOLIB_NRF24_RX_P_NO 0b00000000
133#define RADIOLIB_NRF24_TX_FIFO_FULL 0b00000001
136#define RADIOLIB_NRF24_PLOS_CNT 0b00000000
137#define RADIOLIB_NRF24_ARC_CNT 0b00000000
140#define RADIOLIB_NRF24_RP_BELOW_64_DBM 0b00000000
141#define RADIOLIB_NRF24_RP_ABOVE_64_DBM 0b00000001
144#define RADIOLIB_NRF24_TX_REUSE 0b01000000
145#define RADIOLIB_NRF24_TX_FIFO_FULL_FLAG 0b00100000
146#define RADIOLIB_NRF24_TX_FIFO_EMPTY_FLAG 0b00010000
147#define RADIOLIB_NRF24_RX_FIFO_FULL_FLAG 0b00000010
148#define RADIOLIB_NRF24_RX_FIFO_EMPTY_FLAG 0b00000001
151#define RADIOLIB_NRF24_DPL_P5_OFF 0b00000000
152#define RADIOLIB_NRF24_DPL_P5_ON 0b00100000
153#define RADIOLIB_NRF24_DPL_P4_OFF 0b00000000
154#define RADIOLIB_NRF24_DPL_P4_ON 0b00010000
155#define RADIOLIB_NRF24_DPL_P3_OFF 0b00000000
156#define RADIOLIB_NRF24_DPL_P3_ON 0b00001000
157#define RADIOLIB_NRF24_DPL_P2_OFF 0b00000000
158#define RADIOLIB_NRF24_DPL_P2_ON 0b00000100
159#define RADIOLIB_NRF24_DPL_P1_OFF 0b00000000
160#define RADIOLIB_NRF24_DPL_P1_ON 0b00000010
161#define RADIOLIB_NRF24_DPL_P0_OFF 0b00000000
162#define RADIOLIB_NRF24_DPL_P0_ON 0b00000001
163#define RADIOLIB_NRF24_DPL_ALL_OFF 0b00000000
164#define RADIOLIB_NRF24_DPL_ALL_ON 0b00111111
167#define RADIOLIB_NRF24_DPL_OFF 0b00000000
168#define RADIOLIB_NRF24_DPL_ON 0b00000100
169#define RADIOLIB_NRF24_ACK_PAY_OFF 0b00000000
170#define RADIOLIB_NRF24_ACK_PAY_ON 0b00000010
171#define RADIOLIB_NRF24_DYN_ACK_OFF 0b00000000
172#define RADIOLIB_NRF24_DYN_ACK_ON 0b00000001
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
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);
218 int16_t
sleep()
override;
231 int16_t
standby(uint8_t mode)
override;
241 int16_t
transmit(
const uint8_t* data,
size_t len, uint8_t addr)
override;
250 int16_t
receive(uint8_t* data,
size_t len)
override;
308 int16_t
startTransmit(
const uint8_t* data,
size_t len, uint8_t addr)
override;
330 int16_t
startReceive(uint32_t timeout, uint32_t irqFlags, uint32_t irqMask,
size_t len)
override;
339 int16_t
readData(uint8_t* data,
size_t len)
override;
452 int16_t
setAutoAck(uint8_t pipeNum,
bool autoAckOn);
468#if !RADIOLIB_GODMODE && !RADIOLIB_LOW_LEVEL
471 Module* getMod()
override;
473 void SPIreadRxPayload(uint8_t* data, uint8_t numBytes);
474 void SPIwriteTxPayload(
const uint8_t* data, uint8_t numBytes);
475 void SPItransfer(uint8_t cmd,
bool write =
false,
const uint8_t* dataOut = NULL, uint8_t* dataIn = NULL, uint8_t numBytes = 0);
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;
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition Module.h:73
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition PhysicalLayer.h:151
virtual int16_t readData(uint8_t *data, size_t len)
Reads data that was received after calling startReceive method.
Definition PhysicalLayer.cpp:206
int16_t transmit(const char *str, uint8_t addr=0)
C-string transmit method.
Definition PhysicalLayer.cpp:53
int16_t startTransmit(const char *str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition PhysicalLayer.cpp:148
virtual int16_t receive(uint8_t *data, size_t len)
Binary receive method. Must be implemented in module class.
Definition PhysicalLayer.cpp:111
Control class for nRF24 module.
Definition nRF24.h:184
int16_t setEncoding(uint8_t encoding) override
Dummy encoding configuration method, to ensure PhysicalLayer compatibility.
Definition nRF24.cpp:557
int16_t transmitDirect(uint32_t frf=0) override
Starts direct mode transmission.
Definition nRF24.cpp:133
int16_t setDataShaping(uint8_t sh) override
Dummy data shaping configuration method, to ensure PhysicalLayer compatibility.
Definition nRF24.cpp:550
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
int16_t setFrequency(float freq) override
Sets carrier frequency. Allowed values range from 2400 MHz to 2525 MHz.
Definition nRF24.cpp:281
int16_t receive(uint8_t *data, size_t len) override
Blocking binary receive method. Overloads for string-based transmissions are implemented in PhysicalL...
Definition nRF24.cpp:111
size_t getPacketLength(bool update=true) override
Query modem for the packet length of received payload.
Definition nRF24.cpp:503
void setPacketSentAction(void(*func)(void)) override
Sets interrupt service routine to call when a packet is sent.
Definition nRF24.cpp:170
int16_t startReceive() override
Interrupt-driven receive method. IRQ will be activated when full packet is received.
Definition nRF24.cpp:226
int16_t setCrcFiltering(bool crcOn=true)
Enable CRC filtering and generation.
Definition nRF24.cpp:510
int16_t getStatus(uint8_t mask=0xFF)
Gets nRF24 status register.
Definition nRF24.cpp:488
int16_t readData(uint8_t *data, size_t len) override
Reads data received after calling startReceive method. When the packet length is not known in advance...
Definition nRF24.cpp:260
void clearPacketSentAction() override
Clears interrupt service routine to call when a packet is sent.
Definition nRF24.cpp:174
int16_t receiveDirect() override
Dummy direct mode reception method, to ensure PhysicalLayer compatibility.
Definition nRF24.cpp:148
int16_t disablePipe(uint8_t pipeNum)
Disables specified receive pipe.
Definition nRF24.cpp:457
int16_t setOutputPower(int8_t pwr) override
Sets output power. Allowed values are -18, -12, -6 or 0 dBm.
Definition nRF24.cpp:323
int16_t setFrequencyDeviation(float freqDev) override
Dummy configuration method, to ensure PhysicalLayer compatibility.
Definition nRF24.cpp:496
void clearPacketReceivedAction() override
Clears interrupt service routine to call when a packet is received.
Definition nRF24.cpp:166
int16_t standby() override
Sets the module to standby mode.
Definition nRF24.cpp:71
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
void setPacketReceivedAction(void(*func)(void)) override
Sets interrupt service routine to call when a packet is received.
Definition nRF24.cpp:162
int16_t sleep() override
Sets the module to sleep mode.
Definition nRF24.cpp:67
int16_t setBitRate(float br) override
Sets bit rate. Allowed values are 2000, 1000 or 250 kbps.
Definition nRF24.cpp:295
int16_t startTransmit(const uint8_t *data, size_t len, uint8_t addr) override
Interrupt-driven binary transmit method. IRQ will be activated when full packet is transmitted....
Definition nRF24.cpp:178
int16_t setTransmitPipe(const 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
void clearIrqAction()
Clears interrupt service routine .
Definition nRF24.cpp:158
void setIrqAction(void(*func)(void))
Sets interrupt service routine to call when IRQ activates.
Definition nRF24.cpp:154
int16_t setReceivePipe(uint8_t pipeNum, const 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
int16_t setAutoAck(bool autoAckOn=true)
Enable or disable auto-acknowledge packets on all pipes.
Definition nRF24.cpp:521
bool isCarrierDetected()
Checks if carrier was detected during last RX.
Definition nRF24.cpp:492
int16_t finishTransmit() override
Clean up after transmission is done.
Definition nRF24.cpp:218
int16_t transmit(const uint8_t *data, size_t len, uint8_t addr) override
Blocking binary transmit method. Overloads for string-based transmissions are implemented in Physical...
Definition nRF24.cpp:85