TMRh20 ported to MBED
Fork of TMRh20 by
RF24.h@6:15a3bbf90fe9, 2017-10-06 (annotated)
- Committer:
- gume
- Date:
- Fri Oct 06 20:20:33 2017 +0000
- Revision:
- 6:15a3bbf90fe9
- Parent:
- 3:13e43d3101a5
Initial release
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
gume | 0:163155b607df | 1 | /* |
gume | 0:163155b607df | 2 | Copyright (C) 2011 J. Coliz <maniacbug@ymail.com> |
gume | 0:163155b607df | 3 | |
gume | 0:163155b607df | 4 | This program is free software; you can redistribute it and/or |
gume | 0:163155b607df | 5 | modify it under the terms of the GNU General Public License |
gume | 0:163155b607df | 6 | version 2 as published by the Free Software Foundation. |
gume | 0:163155b607df | 7 | */ |
gume | 0:163155b607df | 8 | |
gume | 0:163155b607df | 9 | /** |
gume | 0:163155b607df | 10 | * @file RF24.h |
gume | 0:163155b607df | 11 | * |
gume | 0:163155b607df | 12 | * Class declaration for RF24 and helper enums |
gume | 0:163155b607df | 13 | */ |
gume | 0:163155b607df | 14 | |
gume | 0:163155b607df | 15 | #ifndef __RF24_H__ |
gume | 0:163155b607df | 16 | #define __RF24_H__ |
gume | 0:163155b607df | 17 | |
gume | 6:15a3bbf90fe9 | 18 | #include "RF24_config.h" |
gume | 0:163155b607df | 19 | #include "mbed.h" |
gume | 0:163155b607df | 20 | |
gume | 0:163155b607df | 21 | /** |
gume | 0:163155b607df | 22 | * Power Amplifier level. |
gume | 0:163155b607df | 23 | * |
gume | 0:163155b607df | 24 | * For use with setPALevel() |
gume | 0:163155b607df | 25 | */ |
gume | 0:163155b607df | 26 | typedef enum { RF24_PA_MIN = 0,RF24_PA_LOW, RF24_PA_HIGH, RF24_PA_MAX, RF24_PA_ERROR } rf24_pa_dbm_e ; |
gume | 0:163155b607df | 27 | |
gume | 0:163155b607df | 28 | /** |
gume | 0:163155b607df | 29 | * Data rate. How fast data moves through the air. |
gume | 0:163155b607df | 30 | * |
gume | 0:163155b607df | 31 | * For use with setDataRate() |
gume | 0:163155b607df | 32 | */ |
gume | 0:163155b607df | 33 | typedef enum { RF24_1MBPS = 0, RF24_2MBPS, RF24_250KBPS } rf24_datarate_e; |
gume | 0:163155b607df | 34 | |
gume | 0:163155b607df | 35 | /** |
gume | 0:163155b607df | 36 | * CRC Length. How big (if any) of a CRC is included. |
gume | 0:163155b607df | 37 | * |
gume | 0:163155b607df | 38 | * For use with setCRCLength() |
gume | 0:163155b607df | 39 | */ |
gume | 0:163155b607df | 40 | typedef enum { RF24_CRC_DISABLED = 0, RF24_CRC_8, RF24_CRC_16 } rf24_crclength_e; |
gume | 0:163155b607df | 41 | |
gume | 0:163155b607df | 42 | /** |
gume | 0:163155b607df | 43 | * Driver for nRF24L01(+) 2.4GHz Wireless Transceiver |
gume | 0:163155b607df | 44 | */ |
gume | 0:163155b607df | 45 | |
gume | 0:163155b607df | 46 | class RF24 |
gume | 0:163155b607df | 47 | { |
gume | 0:163155b607df | 48 | private: |
gume | 0:163155b607df | 49 | |
gume | 6:15a3bbf90fe9 | 50 | SPI *spi; |
gume | 0:163155b607df | 51 | |
gume | 6:15a3bbf90fe9 | 52 | DigitalOut ce_pin; /**< "Chip Enable" pin, activates the RX or TX role */ |
gume | 6:15a3bbf90fe9 | 53 | DigitalOut csn_pin; /**< SPI Chip select */ |
gume | 0:163155b607df | 54 | |
gume | 6:15a3bbf90fe9 | 55 | bool p_variant; /* False for RF24L01 and true for RF24L01P */ |
gume | 6:15a3bbf90fe9 | 56 | uint8_t payload_size; /**< Fixed size of payloads */ |
gume | 6:15a3bbf90fe9 | 57 | bool dynamic_payloads_enabled; /**< Whether dynamic payloads are enabled. */ |
gume | 6:15a3bbf90fe9 | 58 | uint8_t pipe0_reading_address[5]; /**< Last address set on pipe 0 for reading. */ |
gume | 6:15a3bbf90fe9 | 59 | uint8_t addr_width; /**< The address width to use - 3,4 or 5 bytes. */ |
gume | 6:15a3bbf90fe9 | 60 | |
gume | 0:163155b607df | 61 | |
gume | 0:163155b607df | 62 | protected: |
gume | 6:15a3bbf90fe9 | 63 | /** |
gume | 6:15a3bbf90fe9 | 64 | * SPI transactions |
gume | 6:15a3bbf90fe9 | 65 | * |
gume | 6:15a3bbf90fe9 | 66 | * Common code for SPI transactions including CSN toggle |
gume | 6:15a3bbf90fe9 | 67 | * |
gume | 6:15a3bbf90fe9 | 68 | */ |
gume | 6:15a3bbf90fe9 | 69 | inline void beginTransaction(); |
gume | 0:163155b607df | 70 | |
gume | 6:15a3bbf90fe9 | 71 | inline void endTransaction(); |
gume | 0:163155b607df | 72 | |
gume | 0:163155b607df | 73 | public: |
gume | 0:163155b607df | 74 | |
gume | 6:15a3bbf90fe9 | 75 | /** |
gume | 6:15a3bbf90fe9 | 76 | * @name Primary public interface |
gume | 6:15a3bbf90fe9 | 77 | * |
gume | 6:15a3bbf90fe9 | 78 | * These are the main methods you need to operate the chip |
gume | 6:15a3bbf90fe9 | 79 | */ |
gume | 6:15a3bbf90fe9 | 80 | /**@{*/ |
gume | 6:15a3bbf90fe9 | 81 | |
gume | 6:15a3bbf90fe9 | 82 | /** |
gume | 6:15a3bbf90fe9 | 83 | * MBED Constructor |
gume | 6:15a3bbf90fe9 | 84 | * |
gume | 6:15a3bbf90fe9 | 85 | * Creates a new instance of this driver. Before using, you create an instance |
gume | 6:15a3bbf90fe9 | 86 | * and send in the unique pins that this chip is connected to. |
gume | 6:15a3bbf90fe9 | 87 | * |
gume | 6:15a3bbf90fe9 | 88 | * @param _cepin The pin attached to Chip Enable on the RF module |
gume | 6:15a3bbf90fe9 | 89 | * @param _cspin The pin attached to Chip Select |
gume | 6:15a3bbf90fe9 | 90 | * @param spispeed For RPi, the SPI speed in MHZ ie: BCM2835_SPI_SPEED_8MHZ |
gume | 6:15a3bbf90fe9 | 91 | */ |
gume | 6:15a3bbf90fe9 | 92 | |
gume | 6:15a3bbf90fe9 | 93 | RF24(SPI *spi, PinName _cepin, PinName _cspin); |
gume | 0:163155b607df | 94 | |
gume | 6:15a3bbf90fe9 | 95 | /** |
gume | 6:15a3bbf90fe9 | 96 | * Begin operation of the chip |
gume | 6:15a3bbf90fe9 | 97 | * |
gume | 6:15a3bbf90fe9 | 98 | * Call this in setup(), before calling any other methods. |
gume | 6:15a3bbf90fe9 | 99 | * @code radio.begin() @endcode |
gume | 6:15a3bbf90fe9 | 100 | */ |
gume | 6:15a3bbf90fe9 | 101 | bool begin(void); |
gume | 0:163155b607df | 102 | |
gume | 6:15a3bbf90fe9 | 103 | /** |
gume | 6:15a3bbf90fe9 | 104 | * Checks if the chip is connected to the SPI bus |
gume | 6:15a3bbf90fe9 | 105 | */ |
gume | 6:15a3bbf90fe9 | 106 | bool isChipConnected(); |
gume | 0:163155b607df | 107 | |
gume | 6:15a3bbf90fe9 | 108 | /** |
gume | 6:15a3bbf90fe9 | 109 | * Start listening on the pipes opened for reading. |
gume | 6:15a3bbf90fe9 | 110 | * |
gume | 6:15a3bbf90fe9 | 111 | * 1. Be sure to call openReadingPipe() first. |
gume | 6:15a3bbf90fe9 | 112 | * 2. Do not call write() while in this mode, without first calling stopListening(). |
gume | 6:15a3bbf90fe9 | 113 | * 3. Call available() to check for incoming traffic, and read() to get it. |
gume | 6:15a3bbf90fe9 | 114 | * |
gume | 6:15a3bbf90fe9 | 115 | * @code |
gume | 6:15a3bbf90fe9 | 116 | * Open reading pipe 1 using address CCCECCCECC |
gume | 6:15a3bbf90fe9 | 117 | * |
gume | 6:15a3bbf90fe9 | 118 | * byte address[] = { 0xCC,0xCE,0xCC,0xCE,0xCC }; |
gume | 6:15a3bbf90fe9 | 119 | * radio.openReadingPipe(1,address); |
gume | 6:15a3bbf90fe9 | 120 | * radio.startListening(); |
gume | 6:15a3bbf90fe9 | 121 | * @endcode |
gume | 6:15a3bbf90fe9 | 122 | */ |
gume | 6:15a3bbf90fe9 | 123 | void startListening(void); |
gume | 0:163155b607df | 124 | |
gume | 6:15a3bbf90fe9 | 125 | /** |
gume | 6:15a3bbf90fe9 | 126 | * Stop listening for incoming messages, and switch to transmit mode. |
gume | 6:15a3bbf90fe9 | 127 | * |
gume | 6:15a3bbf90fe9 | 128 | * Do this before calling write(). |
gume | 6:15a3bbf90fe9 | 129 | * @code |
gume | 6:15a3bbf90fe9 | 130 | * radio.stopListening(); |
gume | 6:15a3bbf90fe9 | 131 | * radio.write(&data,sizeof(data)); |
gume | 6:15a3bbf90fe9 | 132 | * @endcode |
gume | 6:15a3bbf90fe9 | 133 | */ |
gume | 6:15a3bbf90fe9 | 134 | void stopListening(void); |
gume | 6:15a3bbf90fe9 | 135 | |
gume | 6:15a3bbf90fe9 | 136 | /** |
gume | 6:15a3bbf90fe9 | 137 | * Check whether there are bytes available to be read |
gume | 6:15a3bbf90fe9 | 138 | * @code |
gume | 6:15a3bbf90fe9 | 139 | * if(radio.available()){ |
gume | 6:15a3bbf90fe9 | 140 | * radio.read(&data,sizeof(data)); |
gume | 6:15a3bbf90fe9 | 141 | * } |
gume | 6:15a3bbf90fe9 | 142 | * @endcode |
gume | 6:15a3bbf90fe9 | 143 | * @return True if there is a payload available, false if none is |
gume | 6:15a3bbf90fe9 | 144 | */ |
gume | 6:15a3bbf90fe9 | 145 | bool available(void); |
gume | 0:163155b607df | 146 | |
gume | 6:15a3bbf90fe9 | 147 | /** |
gume | 6:15a3bbf90fe9 | 148 | * Read the available payload |
gume | 6:15a3bbf90fe9 | 149 | * |
gume | 6:15a3bbf90fe9 | 150 | * The size of data read is the fixed payload size, see getPayloadSize() |
gume | 6:15a3bbf90fe9 | 151 | * |
gume | 6:15a3bbf90fe9 | 152 | * @note I specifically chose 'void*' as a data type to make it easier |
gume | 6:15a3bbf90fe9 | 153 | * for beginners to use. No casting needed. |
gume | 6:15a3bbf90fe9 | 154 | * |
gume | 6:15a3bbf90fe9 | 155 | * @note No longer boolean. Use available to determine if packets are |
gume | 6:15a3bbf90fe9 | 156 | * available. Interrupt flags are now cleared during reads instead of |
gume | 6:15a3bbf90fe9 | 157 | * when calling available(). |
gume | 6:15a3bbf90fe9 | 158 | * |
gume | 6:15a3bbf90fe9 | 159 | * @param buf Pointer to a buffer where the data should be written |
gume | 6:15a3bbf90fe9 | 160 | * @param len Maximum number of bytes to read into the buffer |
gume | 6:15a3bbf90fe9 | 161 | * |
gume | 6:15a3bbf90fe9 | 162 | * @code |
gume | 6:15a3bbf90fe9 | 163 | * if(radio.available()){ |
gume | 6:15a3bbf90fe9 | 164 | * radio.read(&data,sizeof(data)); |
gume | 6:15a3bbf90fe9 | 165 | * } |
gume | 6:15a3bbf90fe9 | 166 | * @endcode |
gume | 6:15a3bbf90fe9 | 167 | * @return No return value. Use available(). |
gume | 6:15a3bbf90fe9 | 168 | */ |
gume | 6:15a3bbf90fe9 | 169 | void read( void* buf, uint8_t len ); |
gume | 0:163155b607df | 170 | |
gume | 6:15a3bbf90fe9 | 171 | /** |
gume | 6:15a3bbf90fe9 | 172 | * Be sure to call openWritingPipe() first to set the destination |
gume | 6:15a3bbf90fe9 | 173 | * of where to write to. |
gume | 6:15a3bbf90fe9 | 174 | * |
gume | 6:15a3bbf90fe9 | 175 | * This blocks until the message is successfully acknowledged by |
gume | 6:15a3bbf90fe9 | 176 | * the receiver or the timeout/retransmit maxima are reached. In |
gume | 6:15a3bbf90fe9 | 177 | * the current configuration, the max delay here is 60-70ms. |
gume | 6:15a3bbf90fe9 | 178 | * |
gume | 6:15a3bbf90fe9 | 179 | * The maximum size of data written is the fixed payload size, see |
gume | 6:15a3bbf90fe9 | 180 | * getPayloadSize(). However, you can write less, and the remainder |
gume | 6:15a3bbf90fe9 | 181 | * will just be filled with zeroes. |
gume | 6:15a3bbf90fe9 | 182 | * |
gume | 6:15a3bbf90fe9 | 183 | * TX/RX/RT interrupt flags will be cleared every time write is called |
gume | 6:15a3bbf90fe9 | 184 | * |
gume | 6:15a3bbf90fe9 | 185 | * @param buf Pointer to the data to be sent |
gume | 6:15a3bbf90fe9 | 186 | * @param len Number of bytes to be sent |
gume | 6:15a3bbf90fe9 | 187 | * |
gume | 6:15a3bbf90fe9 | 188 | * @code |
gume | 6:15a3bbf90fe9 | 189 | * radio.stopListening(); |
gume | 6:15a3bbf90fe9 | 190 | * radio.write(&data,sizeof(data)); |
gume | 6:15a3bbf90fe9 | 191 | * @endcode |
gume | 6:15a3bbf90fe9 | 192 | * @return True if the payload was delivered successfully false if not |
gume | 6:15a3bbf90fe9 | 193 | */ |
gume | 6:15a3bbf90fe9 | 194 | bool write( const void* buf, uint8_t len ); |
gume | 6:15a3bbf90fe9 | 195 | |
gume | 6:15a3bbf90fe9 | 196 | /** |
gume | 6:15a3bbf90fe9 | 197 | * New: Open a pipe for writing via byte array. Old addressing format retained |
gume | 6:15a3bbf90fe9 | 198 | * for compatibility. |
gume | 6:15a3bbf90fe9 | 199 | * |
gume | 6:15a3bbf90fe9 | 200 | * Only one writing pipe can be open at once, but you can change the address |
gume | 6:15a3bbf90fe9 | 201 | * you'll write to. Call stopListening() first. |
gume | 6:15a3bbf90fe9 | 202 | * |
gume | 6:15a3bbf90fe9 | 203 | * Addresses are assigned via a byte array, default is 5 byte address length |
gume | 6:15a3bbf90fe9 | 204 | s * |
gume | 6:15a3bbf90fe9 | 205 | * @code |
gume | 6:15a3bbf90fe9 | 206 | * uint8_t addresses[][6] = {"1Node","2Node"}; |
gume | 6:15a3bbf90fe9 | 207 | * radio.openWritingPipe(addresses[0]); |
gume | 6:15a3bbf90fe9 | 208 | * @endcode |
gume | 6:15a3bbf90fe9 | 209 | * @code |
gume | 6:15a3bbf90fe9 | 210 | * uint8_t address[] = { 0xCC,0xCE,0xCC,0xCE,0xCC }; |
gume | 6:15a3bbf90fe9 | 211 | * radio.openWritingPipe(address); |
gume | 6:15a3bbf90fe9 | 212 | * address[0] = 0x33; |
gume | 6:15a3bbf90fe9 | 213 | * radio.openReadingPipe(1,address); |
gume | 6:15a3bbf90fe9 | 214 | * @endcode |
gume | 6:15a3bbf90fe9 | 215 | * @see setAddressWidth |
gume | 6:15a3bbf90fe9 | 216 | * |
gume | 6:15a3bbf90fe9 | 217 | * @param address The address of the pipe to open. Coordinate these pipe |
gume | 6:15a3bbf90fe9 | 218 | * addresses amongst nodes on the network. |
gume | 6:15a3bbf90fe9 | 219 | */ |
gume | 6:15a3bbf90fe9 | 220 | |
gume | 6:15a3bbf90fe9 | 221 | void openWritingPipe(const uint8_t *address); |
gume | 0:163155b607df | 222 | |
gume | 6:15a3bbf90fe9 | 223 | /** |
gume | 6:15a3bbf90fe9 | 224 | * Open a pipe for reading |
gume | 6:15a3bbf90fe9 | 225 | * |
gume | 6:15a3bbf90fe9 | 226 | * Up to 6 pipes can be open for reading at once. Open all the required |
gume | 6:15a3bbf90fe9 | 227 | * reading pipes, and then call startListening(). |
gume | 6:15a3bbf90fe9 | 228 | * |
gume | 6:15a3bbf90fe9 | 229 | * @see openWritingPipe |
gume | 6:15a3bbf90fe9 | 230 | * @see setAddressWidth |
gume | 6:15a3bbf90fe9 | 231 | * |
gume | 6:15a3bbf90fe9 | 232 | * @note Pipes 0 and 1 will store a full 5-byte address. Pipes 2-5 will technically |
gume | 6:15a3bbf90fe9 | 233 | * only store a single byte, borrowing up to 4 additional bytes from pipe #1 per the |
gume | 6:15a3bbf90fe9 | 234 | * assigned address width. |
gume | 6:15a3bbf90fe9 | 235 | * @warning Pipes 1-5 should share the same address, except the first byte. |
gume | 6:15a3bbf90fe9 | 236 | * Only the first byte in the array should be unique, e.g. |
gume | 6:15a3bbf90fe9 | 237 | * @code |
gume | 6:15a3bbf90fe9 | 238 | * uint8_t addresses[][6] = {"1Node","2Node"}; |
gume | 6:15a3bbf90fe9 | 239 | * openReadingPipe(1,addresses[0]); |
gume | 6:15a3bbf90fe9 | 240 | * openReadingPipe(2,addresses[1]); |
gume | 6:15a3bbf90fe9 | 241 | * @endcode |
gume | 6:15a3bbf90fe9 | 242 | * |
gume | 6:15a3bbf90fe9 | 243 | * @warning Pipe 0 is also used by the writing pipe. So if you open |
gume | 6:15a3bbf90fe9 | 244 | * pipe 0 for reading, and then startListening(), it will overwrite the |
gume | 6:15a3bbf90fe9 | 245 | * writing pipe. Ergo, do an openWritingPipe() again before write(). |
gume | 6:15a3bbf90fe9 | 246 | * |
gume | 6:15a3bbf90fe9 | 247 | * @param number Which pipe# to open, 0-5. |
gume | 6:15a3bbf90fe9 | 248 | * @param address The 24, 32 or 40 bit address of the pipe to open. |
gume | 6:15a3bbf90fe9 | 249 | */ |
gume | 6:15a3bbf90fe9 | 250 | |
gume | 6:15a3bbf90fe9 | 251 | void openReadingPipe(uint8_t number, const uint8_t *address); |
gume | 0:163155b607df | 252 | |
gume | 6:15a3bbf90fe9 | 253 | /**@}*/ |
gume | 6:15a3bbf90fe9 | 254 | /** |
gume | 6:15a3bbf90fe9 | 255 | * @name Advanced Operation |
gume | 6:15a3bbf90fe9 | 256 | * |
gume | 6:15a3bbf90fe9 | 257 | * Methods you can use to drive the chip in more advanced ways |
gume | 6:15a3bbf90fe9 | 258 | */ |
gume | 6:15a3bbf90fe9 | 259 | /**@{*/ |
gume | 0:163155b607df | 260 | |
gume | 6:15a3bbf90fe9 | 261 | /** |
gume | 6:15a3bbf90fe9 | 262 | * Print a giant block of debugging information to stdout |
gume | 6:15a3bbf90fe9 | 263 | * |
gume | 6:15a3bbf90fe9 | 264 | * @warning Does nothing if stdout is not defined. See fdevopen in stdio.h |
gume | 6:15a3bbf90fe9 | 265 | * The printf.h file is included with the library for Arduino. |
gume | 6:15a3bbf90fe9 | 266 | * @code |
gume | 6:15a3bbf90fe9 | 267 | * #include <printf.h> |
gume | 6:15a3bbf90fe9 | 268 | * setup(){ |
gume | 6:15a3bbf90fe9 | 269 | * Serial.begin(115200); |
gume | 6:15a3bbf90fe9 | 270 | * printf_begin(); |
gume | 6:15a3bbf90fe9 | 271 | * ... |
gume | 6:15a3bbf90fe9 | 272 | * } |
gume | 6:15a3bbf90fe9 | 273 | * @endcode |
gume | 6:15a3bbf90fe9 | 274 | */ |
gume | 6:15a3bbf90fe9 | 275 | void printDetails(void); |
gume | 6:15a3bbf90fe9 | 276 | |
gume | 6:15a3bbf90fe9 | 277 | /** |
gume | 6:15a3bbf90fe9 | 278 | * Test whether there are bytes available to be read in the |
gume | 6:15a3bbf90fe9 | 279 | * FIFO buffers. |
gume | 6:15a3bbf90fe9 | 280 | * |
gume | 6:15a3bbf90fe9 | 281 | * @param[out] pipe_num Which pipe has the payload available |
gume | 6:15a3bbf90fe9 | 282 | * |
gume | 6:15a3bbf90fe9 | 283 | * @code |
gume | 6:15a3bbf90fe9 | 284 | * uint8_t pipeNum; |
gume | 6:15a3bbf90fe9 | 285 | * if(radio.available(&pipeNum)){ |
gume | 6:15a3bbf90fe9 | 286 | * radio.read(&data,sizeof(data)); |
gume | 6:15a3bbf90fe9 | 287 | * Serial.print("Got data on pipe"); |
gume | 6:15a3bbf90fe9 | 288 | * Serial.println(pipeNum); |
gume | 6:15a3bbf90fe9 | 289 | * } |
gume | 6:15a3bbf90fe9 | 290 | * @endcode |
gume | 6:15a3bbf90fe9 | 291 | * @return True if there is a payload available, false if none is |
gume | 6:15a3bbf90fe9 | 292 | */ |
gume | 6:15a3bbf90fe9 | 293 | bool available(uint8_t* pipe_num); |
gume | 0:163155b607df | 294 | |
gume | 6:15a3bbf90fe9 | 295 | /** |
gume | 6:15a3bbf90fe9 | 296 | * Check if the radio needs to be read. Can be used to prevent data loss |
gume | 6:15a3bbf90fe9 | 297 | * @return True if all three 32-byte radio buffers are full |
gume | 6:15a3bbf90fe9 | 298 | */ |
gume | 6:15a3bbf90fe9 | 299 | bool rxFifoFull(); |
gume | 6:15a3bbf90fe9 | 300 | |
gume | 6:15a3bbf90fe9 | 301 | /** |
gume | 6:15a3bbf90fe9 | 302 | * Enter low-power mode |
gume | 6:15a3bbf90fe9 | 303 | * |
gume | 6:15a3bbf90fe9 | 304 | * To return to normal power mode, call powerUp(). |
gume | 6:15a3bbf90fe9 | 305 | * |
gume | 6:15a3bbf90fe9 | 306 | * @note After calling startListening(), a basic radio will consume about 13.5mA |
gume | 6:15a3bbf90fe9 | 307 | * at max PA level. |
gume | 6:15a3bbf90fe9 | 308 | * During active transmission, the radio will consume about 11.5mA, but this will |
gume | 6:15a3bbf90fe9 | 309 | * be reduced to 26uA (.026mA) between sending. |
gume | 6:15a3bbf90fe9 | 310 | * In full powerDown mode, the radio will consume approximately 900nA (.0009mA) |
gume | 6:15a3bbf90fe9 | 311 | * |
gume | 6:15a3bbf90fe9 | 312 | * @code |
gume | 6:15a3bbf90fe9 | 313 | * radio.powerDown(); |
gume | 6:15a3bbf90fe9 | 314 | * avr_enter_sleep_mode(); // Custom function to sleep the device |
gume | 6:15a3bbf90fe9 | 315 | * radio.powerUp(); |
gume | 6:15a3bbf90fe9 | 316 | * @endcode |
gume | 6:15a3bbf90fe9 | 317 | */ |
gume | 6:15a3bbf90fe9 | 318 | void powerDown(void); |
gume | 6:15a3bbf90fe9 | 319 | |
gume | 6:15a3bbf90fe9 | 320 | /** |
gume | 6:15a3bbf90fe9 | 321 | * Leave low-power mode - required for normal radio operation after calling powerDown() |
gume | 6:15a3bbf90fe9 | 322 | * |
gume | 6:15a3bbf90fe9 | 323 | * To return to low power mode, call powerDown(). |
gume | 6:15a3bbf90fe9 | 324 | * @note This will take up to 5ms for maximum compatibility |
gume | 6:15a3bbf90fe9 | 325 | */ |
gume | 6:15a3bbf90fe9 | 326 | void powerUp(void) ; |
gume | 0:163155b607df | 327 | |
gume | 6:15a3bbf90fe9 | 328 | /** |
gume | 6:15a3bbf90fe9 | 329 | * Write for single NOACK writes. Optionally disables acknowledgements/autoretries for a single write. |
gume | 6:15a3bbf90fe9 | 330 | * |
gume | 6:15a3bbf90fe9 | 331 | * @note enableDynamicAck() must be called to enable this feature |
gume | 6:15a3bbf90fe9 | 332 | * |
gume | 6:15a3bbf90fe9 | 333 | * Can be used with enableAckPayload() to request a response |
gume | 6:15a3bbf90fe9 | 334 | * @see enableDynamicAck() |
gume | 6:15a3bbf90fe9 | 335 | * @see setAutoAck() |
gume | 6:15a3bbf90fe9 | 336 | * @see write() |
gume | 6:15a3bbf90fe9 | 337 | * |
gume | 6:15a3bbf90fe9 | 338 | * @param buf Pointer to the data to be sent |
gume | 6:15a3bbf90fe9 | 339 | * @param len Number of bytes to be sent |
gume | 6:15a3bbf90fe9 | 340 | * @param multicast Request ACK (0), NOACK (1) |
gume | 6:15a3bbf90fe9 | 341 | */ |
gume | 6:15a3bbf90fe9 | 342 | bool write( const void* buf, uint8_t len, const bool multicast ); |
gume | 0:163155b607df | 343 | |
gume | 6:15a3bbf90fe9 | 344 | /** |
gume | 6:15a3bbf90fe9 | 345 | * This will not block until the 3 FIFO buffers are filled with data. |
gume | 6:15a3bbf90fe9 | 346 | * Once the FIFOs are full, writeFast will simply wait for success or |
gume | 6:15a3bbf90fe9 | 347 | * timeout, and return 1 or 0 respectively. From a user perspective, just |
gume | 6:15a3bbf90fe9 | 348 | * keep trying to send the same data. The library will keep auto retrying |
gume | 6:15a3bbf90fe9 | 349 | * the current payload using the built in functionality. |
gume | 6:15a3bbf90fe9 | 350 | * @warning It is important to never keep the nRF24L01 in TX mode and FIFO full for more than 4ms at a time. If the auto |
gume | 6:15a3bbf90fe9 | 351 | * retransmit is enabled, the nRF24L01 is never in TX mode long enough to disobey this rule. Allow the FIFO |
gume | 6:15a3bbf90fe9 | 352 | * to clear by issuing txStandBy() or ensure appropriate time between transmissions. |
gume | 6:15a3bbf90fe9 | 353 | * |
gume | 6:15a3bbf90fe9 | 354 | * @code |
gume | 6:15a3bbf90fe9 | 355 | * Example (Partial blocking): |
gume | 6:15a3bbf90fe9 | 356 | * |
gume | 6:15a3bbf90fe9 | 357 | * radio.writeFast(&buf,32); // Writes 1 payload to the buffers |
gume | 6:15a3bbf90fe9 | 358 | * txStandBy(); // Returns 0 if failed. 1 if success. Blocks only until MAX_RT timeout or success. Data flushed on fail. |
gume | 6:15a3bbf90fe9 | 359 | * |
gume | 6:15a3bbf90fe9 | 360 | * radio.writeFast(&buf,32); // Writes 1 payload to the buffers |
gume | 6:15a3bbf90fe9 | 361 | * txStandBy(1000); // Using extended timeouts, returns 1 if success. Retries failed payloads for 1 seconds before returning 0. |
gume | 6:15a3bbf90fe9 | 362 | * @endcode |
gume | 6:15a3bbf90fe9 | 363 | * |
gume | 6:15a3bbf90fe9 | 364 | * @see txStandBy() |
gume | 6:15a3bbf90fe9 | 365 | * @see write() |
gume | 6:15a3bbf90fe9 | 366 | * @see writeBlocking() |
gume | 6:15a3bbf90fe9 | 367 | * |
gume | 6:15a3bbf90fe9 | 368 | * @param buf Pointer to the data to be sent |
gume | 6:15a3bbf90fe9 | 369 | * @param len Number of bytes to be sent |
gume | 6:15a3bbf90fe9 | 370 | * @return True if the payload was delivered successfully false if not |
gume | 6:15a3bbf90fe9 | 371 | */ |
gume | 6:15a3bbf90fe9 | 372 | bool writeFast( const void* buf, uint8_t len ); |
gume | 0:163155b607df | 373 | |
gume | 6:15a3bbf90fe9 | 374 | /** |
gume | 6:15a3bbf90fe9 | 375 | * WriteFast for single NOACK writes. Disables acknowledgements/autoretries for a single write. |
gume | 6:15a3bbf90fe9 | 376 | * |
gume | 6:15a3bbf90fe9 | 377 | * @note enableDynamicAck() must be called to enable this feature |
gume | 6:15a3bbf90fe9 | 378 | * @see enableDynamicAck() |
gume | 6:15a3bbf90fe9 | 379 | * @see setAutoAck() |
gume | 6:15a3bbf90fe9 | 380 | * |
gume | 6:15a3bbf90fe9 | 381 | * @param buf Pointer to the data to be sent |
gume | 6:15a3bbf90fe9 | 382 | * @param len Number of bytes to be sent |
gume | 6:15a3bbf90fe9 | 383 | * @param multicast Request ACK (0) or NOACK (1) |
gume | 6:15a3bbf90fe9 | 384 | */ |
gume | 6:15a3bbf90fe9 | 385 | bool writeFast( const void* buf, uint8_t len, const bool multicast ); |
gume | 0:163155b607df | 386 | |
gume | 6:15a3bbf90fe9 | 387 | /** |
gume | 6:15a3bbf90fe9 | 388 | * This function extends the auto-retry mechanism to any specified duration. |
gume | 6:15a3bbf90fe9 | 389 | * It will not block until the 3 FIFO buffers are filled with data. |
gume | 6:15a3bbf90fe9 | 390 | * If so the library will auto retry until a new payload is written |
gume | 6:15a3bbf90fe9 | 391 | * or the user specified timeout period is reached. |
gume | 6:15a3bbf90fe9 | 392 | * @warning It is important to never keep the nRF24L01 in TX mode and FIFO full for more than 4ms at a time. If the auto |
gume | 6:15a3bbf90fe9 | 393 | * retransmit is enabled, the nRF24L01 is never in TX mode long enough to disobey this rule. Allow the FIFO |
gume | 6:15a3bbf90fe9 | 394 | * to clear by issuing txStandBy() or ensure appropriate time between transmissions. |
gume | 6:15a3bbf90fe9 | 395 | * |
gume | 6:15a3bbf90fe9 | 396 | * @code |
gume | 6:15a3bbf90fe9 | 397 | * Example (Full blocking): |
gume | 6:15a3bbf90fe9 | 398 | * |
gume | 6:15a3bbf90fe9 | 399 | * radio.writeBlocking(&buf,32,1000); //Wait up to 1 second to write 1 payload to the buffers |
gume | 6:15a3bbf90fe9 | 400 | * txStandBy(1000); //Wait up to 1 second for the payload to send. Return 1 if ok, 0 if failed. |
gume | 6:15a3bbf90fe9 | 401 | * //Blocks only until user timeout or success. Data flushed on fail. |
gume | 6:15a3bbf90fe9 | 402 | * @endcode |
gume | 6:15a3bbf90fe9 | 403 | * @note If used from within an interrupt, the interrupt should be disabled until completion, and sei(); called to enable millis(). |
gume | 6:15a3bbf90fe9 | 404 | * @see txStandBy() |
gume | 6:15a3bbf90fe9 | 405 | * @see write() |
gume | 6:15a3bbf90fe9 | 406 | * @see writeFast() |
gume | 6:15a3bbf90fe9 | 407 | * |
gume | 6:15a3bbf90fe9 | 408 | * @param buf Pointer to the data to be sent |
gume | 6:15a3bbf90fe9 | 409 | * @param len Number of bytes to be sent |
gume | 6:15a3bbf90fe9 | 410 | * @param timeout User defined timeout in milliseconds. |
gume | 6:15a3bbf90fe9 | 411 | * @return True if the payload was loaded into the buffer successfully false if not |
gume | 6:15a3bbf90fe9 | 412 | */ |
gume | 6:15a3bbf90fe9 | 413 | bool writeBlocking( const void* buf, uint8_t len, uint32_t timeout ); |
gume | 0:163155b607df | 414 | |
gume | 6:15a3bbf90fe9 | 415 | /** |
gume | 6:15a3bbf90fe9 | 416 | * This function should be called as soon as transmission is finished to |
gume | 6:15a3bbf90fe9 | 417 | * drop the radio back to STANDBY-I mode. If not issued, the radio will |
gume | 6:15a3bbf90fe9 | 418 | * remain in STANDBY-II mode which, per the data sheet, is not a recommended |
gume | 6:15a3bbf90fe9 | 419 | * operating mode. |
gume | 6:15a3bbf90fe9 | 420 | * |
gume | 6:15a3bbf90fe9 | 421 | * @note When transmitting data in rapid succession, it is still recommended by |
gume | 6:15a3bbf90fe9 | 422 | * the manufacturer to drop the radio out of TX or STANDBY-II mode if there is |
gume | 6:15a3bbf90fe9 | 423 | * time enough between sends for the FIFOs to empty. This is not required if auto-ack |
gume | 6:15a3bbf90fe9 | 424 | * is enabled. |
gume | 6:15a3bbf90fe9 | 425 | * |
gume | 6:15a3bbf90fe9 | 426 | * Relies on built-in auto retry functionality. |
gume | 6:15a3bbf90fe9 | 427 | * |
gume | 6:15a3bbf90fe9 | 428 | * @code |
gume | 6:15a3bbf90fe9 | 429 | * Example (Partial blocking): |
gume | 6:15a3bbf90fe9 | 430 | * |
gume | 6:15a3bbf90fe9 | 431 | * radio.writeFast(&buf,32); |
gume | 6:15a3bbf90fe9 | 432 | * radio.writeFast(&buf,32); |
gume | 6:15a3bbf90fe9 | 433 | * radio.writeFast(&buf,32); //Fills the FIFO buffers up |
gume | 6:15a3bbf90fe9 | 434 | * bool ok = txStandBy(); //Returns 0 if failed. 1 if success. |
gume | 6:15a3bbf90fe9 | 435 | * //Blocks only until MAX_RT timeout or success. Data flushed on fail. |
gume | 6:15a3bbf90fe9 | 436 | * @endcode |
gume | 6:15a3bbf90fe9 | 437 | * @see txStandBy(unsigned long timeout) |
gume | 6:15a3bbf90fe9 | 438 | * @return True if transmission is successful |
gume | 6:15a3bbf90fe9 | 439 | * |
gume | 6:15a3bbf90fe9 | 440 | */ |
gume | 6:15a3bbf90fe9 | 441 | bool txStandBy(); |
gume | 0:163155b607df | 442 | |
gume | 6:15a3bbf90fe9 | 443 | /** |
gume | 6:15a3bbf90fe9 | 444 | * This function allows extended blocking and auto-retries per a user defined timeout |
gume | 6:15a3bbf90fe9 | 445 | * @code |
gume | 6:15a3bbf90fe9 | 446 | * Fully Blocking Example: |
gume | 6:15a3bbf90fe9 | 447 | * |
gume | 6:15a3bbf90fe9 | 448 | * radio.writeFast(&buf,32); |
gume | 6:15a3bbf90fe9 | 449 | * radio.writeFast(&buf,32); |
gume | 6:15a3bbf90fe9 | 450 | * radio.writeFast(&buf,32); //Fills the FIFO buffers up |
gume | 6:15a3bbf90fe9 | 451 | * bool ok = txStandBy(1000); //Returns 0 if failed after 1 second of retries. 1 if success. |
gume | 6:15a3bbf90fe9 | 452 | * //Blocks only until user defined timeout or success. Data flushed on fail. |
gume | 6:15a3bbf90fe9 | 453 | * @endcode |
gume | 6:15a3bbf90fe9 | 454 | * @note If used from within an interrupt, the interrupt should be disabled until completion, and sei(); called to enable millis(). |
gume | 6:15a3bbf90fe9 | 455 | * @param timeout Number of milliseconds to retry failed payloads |
gume | 6:15a3bbf90fe9 | 456 | * @return True if transmission is successful |
gume | 6:15a3bbf90fe9 | 457 | * |
gume | 6:15a3bbf90fe9 | 458 | */ |
gume | 6:15a3bbf90fe9 | 459 | bool txStandBy(uint32_t timeout, bool startTx = 0); |
gume | 6:15a3bbf90fe9 | 460 | |
gume | 6:15a3bbf90fe9 | 461 | /** |
gume | 6:15a3bbf90fe9 | 462 | * Write an ack payload for the specified pipe |
gume | 6:15a3bbf90fe9 | 463 | * |
gume | 6:15a3bbf90fe9 | 464 | * The next time a message is received on @p pipe, the data in @p buf will |
gume | 6:15a3bbf90fe9 | 465 | * be sent back in the acknowledgement. |
gume | 6:15a3bbf90fe9 | 466 | * @see enableAckPayload() |
gume | 6:15a3bbf90fe9 | 467 | * @see enableDynamicPayloads() |
gume | 6:15a3bbf90fe9 | 468 | * @warning Only three of these can be pending at any time as there are only 3 FIFO buffers.<br> Dynamic payloads must be enabled. |
gume | 6:15a3bbf90fe9 | 469 | * @note Ack payloads are handled automatically by the radio chip when a payload is received. Users should generally |
gume | 6:15a3bbf90fe9 | 470 | * write an ack payload as soon as startListening() is called, so one is available when a regular payload is received. |
gume | 6:15a3bbf90fe9 | 471 | * @note Ack payloads are dynamic payloads. This only works on pipes 0&1 by default. Call |
gume | 6:15a3bbf90fe9 | 472 | * enableDynamicPayloads() to enable on all pipes. |
gume | 6:15a3bbf90fe9 | 473 | * |
gume | 6:15a3bbf90fe9 | 474 | * @param pipe Which pipe# (typically 1-5) will get this response. |
gume | 6:15a3bbf90fe9 | 475 | * @param buf Pointer to data that is sent |
gume | 6:15a3bbf90fe9 | 476 | * @param len Length of the data to send, up to 32 bytes max. Not affected |
gume | 6:15a3bbf90fe9 | 477 | * by the static payload set by setPayloadSize(). |
gume | 6:15a3bbf90fe9 | 478 | */ |
gume | 6:15a3bbf90fe9 | 479 | void writeAckPayload(uint8_t pipe, const void* buf, uint8_t len); |
gume | 6:15a3bbf90fe9 | 480 | |
gume | 6:15a3bbf90fe9 | 481 | /** |
gume | 6:15a3bbf90fe9 | 482 | * Determine if an ack payload was received in the most recent call to |
gume | 6:15a3bbf90fe9 | 483 | * write(). The regular available() can also be used. |
gume | 6:15a3bbf90fe9 | 484 | * |
gume | 6:15a3bbf90fe9 | 485 | * Call read() to retrieve the ack payload. |
gume | 6:15a3bbf90fe9 | 486 | * |
gume | 6:15a3bbf90fe9 | 487 | * @return True if an ack payload is available. |
gume | 6:15a3bbf90fe9 | 488 | */ |
gume | 6:15a3bbf90fe9 | 489 | bool isAckPayloadAvailable(void); |
gume | 6:15a3bbf90fe9 | 490 | |
gume | 6:15a3bbf90fe9 | 491 | /** |
gume | 6:15a3bbf90fe9 | 492 | * Call this when you get an interrupt to find out why |
gume | 6:15a3bbf90fe9 | 493 | * |
gume | 6:15a3bbf90fe9 | 494 | * Tells you what caused the interrupt, and clears the state of |
gume | 6:15a3bbf90fe9 | 495 | * interrupts. |
gume | 6:15a3bbf90fe9 | 496 | * |
gume | 6:15a3bbf90fe9 | 497 | * @param[out] tx_ok The send was successful (TX_DS) |
gume | 6:15a3bbf90fe9 | 498 | * @param[out] tx_fail The send failed, too many retries (MAX_RT) |
gume | 6:15a3bbf90fe9 | 499 | * @param[out] rx_ready There is a message waiting to be read (RX_DS) |
gume | 6:15a3bbf90fe9 | 500 | */ |
gume | 6:15a3bbf90fe9 | 501 | void whatHappened(bool& tx_ok,bool& tx_fail,bool& rx_ready); |
gume | 0:163155b607df | 502 | |
gume | 6:15a3bbf90fe9 | 503 | /** |
gume | 6:15a3bbf90fe9 | 504 | * Non-blocking write to the open writing pipe used for buffered writes |
gume | 6:15a3bbf90fe9 | 505 | * |
gume | 6:15a3bbf90fe9 | 506 | * @note Optimization: This function now leaves the CE pin high, so the radio |
gume | 6:15a3bbf90fe9 | 507 | * will remain in TX or STANDBY-II Mode until a txStandBy() command is issued. Can be used as an alternative to startWrite() |
gume | 6:15a3bbf90fe9 | 508 | * if writing multiple payloads at once. |
gume | 6:15a3bbf90fe9 | 509 | * @warning It is important to never keep the nRF24L01 in TX mode with FIFO full for more than 4ms at a time. If the auto |
gume | 6:15a3bbf90fe9 | 510 | * retransmit/autoAck is enabled, the nRF24L01 is never in TX mode long enough to disobey this rule. Allow the FIFO |
gume | 6:15a3bbf90fe9 | 511 | * to clear by issuing txStandBy() or ensure appropriate time between transmissions. |
gume | 6:15a3bbf90fe9 | 512 | * |
gume | 6:15a3bbf90fe9 | 513 | * @see write() |
gume | 6:15a3bbf90fe9 | 514 | * @see writeFast() |
gume | 6:15a3bbf90fe9 | 515 | * @see startWrite() |
gume | 6:15a3bbf90fe9 | 516 | * @see writeBlocking() |
gume | 6:15a3bbf90fe9 | 517 | * |
gume | 6:15a3bbf90fe9 | 518 | * For single noAck writes see: |
gume | 6:15a3bbf90fe9 | 519 | * @see enableDynamicAck() |
gume | 6:15a3bbf90fe9 | 520 | * @see setAutoAck() |
gume | 6:15a3bbf90fe9 | 521 | * |
gume | 6:15a3bbf90fe9 | 522 | * @param buf Pointer to the data to be sent |
gume | 6:15a3bbf90fe9 | 523 | * @param len Number of bytes to be sent |
gume | 6:15a3bbf90fe9 | 524 | * @param multicast Request ACK (0) or NOACK (1) |
gume | 6:15a3bbf90fe9 | 525 | * @return True if the payload was delivered successfully false if not |
gume | 6:15a3bbf90fe9 | 526 | */ |
gume | 6:15a3bbf90fe9 | 527 | void startFastWrite( const void* buf, uint8_t len, const bool multicast, bool startTx = 1 ); |
gume | 0:163155b607df | 528 | |
gume | 6:15a3bbf90fe9 | 529 | /** |
gume | 6:15a3bbf90fe9 | 530 | * Non-blocking write to the open writing pipe |
gume | 6:15a3bbf90fe9 | 531 | * |
gume | 6:15a3bbf90fe9 | 532 | * Just like write(), but it returns immediately. To find out what happened |
gume | 6:15a3bbf90fe9 | 533 | * to the send, catch the IRQ and then call whatHappened(). |
gume | 6:15a3bbf90fe9 | 534 | * |
gume | 6:15a3bbf90fe9 | 535 | * @see write() |
gume | 6:15a3bbf90fe9 | 536 | * @see writeFast() |
gume | 6:15a3bbf90fe9 | 537 | * @see startFastWrite() |
gume | 6:15a3bbf90fe9 | 538 | * @see whatHappened() |
gume | 6:15a3bbf90fe9 | 539 | * |
gume | 6:15a3bbf90fe9 | 540 | * For single noAck writes see: |
gume | 6:15a3bbf90fe9 | 541 | * @see enableDynamicAck() |
gume | 6:15a3bbf90fe9 | 542 | * @see setAutoAck() |
gume | 6:15a3bbf90fe9 | 543 | * |
gume | 6:15a3bbf90fe9 | 544 | * @param buf Pointer to the data to be sent |
gume | 6:15a3bbf90fe9 | 545 | * @param len Number of bytes to be sent |
gume | 6:15a3bbf90fe9 | 546 | * @param multicast Request ACK (0) or NOACK (1) |
gume | 6:15a3bbf90fe9 | 547 | * |
gume | 6:15a3bbf90fe9 | 548 | */ |
gume | 6:15a3bbf90fe9 | 549 | void startWrite( const void* buf, uint8_t len, const bool multicast ); |
gume | 6:15a3bbf90fe9 | 550 | |
gume | 6:15a3bbf90fe9 | 551 | /** |
gume | 6:15a3bbf90fe9 | 552 | * This function is mainly used internally to take advantage of the auto payload |
gume | 6:15a3bbf90fe9 | 553 | * re-use functionality of the chip, but can be beneficial to users as well. |
gume | 6:15a3bbf90fe9 | 554 | * |
gume | 6:15a3bbf90fe9 | 555 | * The function will instruct the radio to re-use the data in the FIFO buffers, |
gume | 6:15a3bbf90fe9 | 556 | * and instructs the radio to re-send once the timeout limit has been reached. |
gume | 6:15a3bbf90fe9 | 557 | * Used by writeFast and writeBlocking to initiate retries when a TX failure |
gume | 6:15a3bbf90fe9 | 558 | * occurs. Retries are automatically initiated except with the standard write(). |
gume | 6:15a3bbf90fe9 | 559 | * This way, data is not flushed from the buffer until switching between modes. |
gume | 6:15a3bbf90fe9 | 560 | * |
gume | 6:15a3bbf90fe9 | 561 | * @note This is to be used AFTER auto-retry fails if wanting to resend |
gume | 6:15a3bbf90fe9 | 562 | * using the built-in payload reuse features. |
gume | 6:15a3bbf90fe9 | 563 | * After issuing reUseTX(), it will keep reending the same payload forever or until |
gume | 6:15a3bbf90fe9 | 564 | * a payload is written to the FIFO, or a flush_tx command is given. |
gume | 6:15a3bbf90fe9 | 565 | */ |
gume | 6:15a3bbf90fe9 | 566 | void reUseTX(); |
gume | 6:15a3bbf90fe9 | 567 | |
gume | 6:15a3bbf90fe9 | 568 | /** |
gume | 6:15a3bbf90fe9 | 569 | * Empty the transmit buffer. This is generally not required in standard operation. |
gume | 6:15a3bbf90fe9 | 570 | * May be required in specific cases after stopListening() , if operating at 250KBPS data rate. |
gume | 6:15a3bbf90fe9 | 571 | * |
gume | 6:15a3bbf90fe9 | 572 | * @return Current value of status register |
gume | 6:15a3bbf90fe9 | 573 | */ |
gume | 6:15a3bbf90fe9 | 574 | uint8_t flush_tx(void); |
gume | 6:15a3bbf90fe9 | 575 | |
gume | 6:15a3bbf90fe9 | 576 | /** |
gume | 6:15a3bbf90fe9 | 577 | * Test whether there was a carrier on the line for the |
gume | 6:15a3bbf90fe9 | 578 | * previous listening period. |
gume | 6:15a3bbf90fe9 | 579 | * |
gume | 6:15a3bbf90fe9 | 580 | * Useful to check for interference on the current channel. |
gume | 6:15a3bbf90fe9 | 581 | * |
gume | 6:15a3bbf90fe9 | 582 | * @return true if was carrier, false if not |
gume | 6:15a3bbf90fe9 | 583 | */ |
gume | 6:15a3bbf90fe9 | 584 | bool testCarrier(void); |
gume | 0:163155b607df | 585 | |
gume | 6:15a3bbf90fe9 | 586 | /** |
gume | 6:15a3bbf90fe9 | 587 | * Test whether a signal (carrier or otherwise) greater than |
gume | 6:15a3bbf90fe9 | 588 | * or equal to -64dBm is present on the channel. Valid only |
gume | 6:15a3bbf90fe9 | 589 | * on nRF24L01P (+) hardware. On nRF24L01, use testCarrier(). |
gume | 6:15a3bbf90fe9 | 590 | * |
gume | 6:15a3bbf90fe9 | 591 | * Useful to check for interference on the current channel and |
gume | 6:15a3bbf90fe9 | 592 | * channel hopping strategies. |
gume | 6:15a3bbf90fe9 | 593 | * |
gume | 6:15a3bbf90fe9 | 594 | * @code |
gume | 6:15a3bbf90fe9 | 595 | * bool goodSignal = radio.testRPD(); |
gume | 6:15a3bbf90fe9 | 596 | * if(radio.available()){ |
gume | 6:15a3bbf90fe9 | 597 | * Serial.println(goodSignal ? "Strong signal > 64dBm" : "Weak signal < 64dBm" ); |
gume | 6:15a3bbf90fe9 | 598 | * radio.read(0,0); |
gume | 6:15a3bbf90fe9 | 599 | * } |
gume | 6:15a3bbf90fe9 | 600 | * @endcode |
gume | 6:15a3bbf90fe9 | 601 | * @return true if signal => -64dBm, false if not |
gume | 6:15a3bbf90fe9 | 602 | */ |
gume | 6:15a3bbf90fe9 | 603 | bool testRPD(void) ; |
gume | 6:15a3bbf90fe9 | 604 | |
gume | 6:15a3bbf90fe9 | 605 | /** |
gume | 6:15a3bbf90fe9 | 606 | * Test whether this is a real radio, or a mock shim for |
gume | 6:15a3bbf90fe9 | 607 | * debugging. Setting either pin to 0xff is the way to |
gume | 6:15a3bbf90fe9 | 608 | * indicate that this is not a real radio. |
gume | 6:15a3bbf90fe9 | 609 | * |
gume | 6:15a3bbf90fe9 | 610 | * @return true if this is a legitimate radio |
gume | 6:15a3bbf90fe9 | 611 | */ |
gume | 6:15a3bbf90fe9 | 612 | bool isValid() { return ce_pin != 0xff && csn_pin != 0xff; } |
gume | 6:15a3bbf90fe9 | 613 | |
gume | 6:15a3bbf90fe9 | 614 | /** |
gume | 6:15a3bbf90fe9 | 615 | * Close a pipe after it has been previously opened. |
gume | 6:15a3bbf90fe9 | 616 | * Can be safely called without having previously opened a pipe. |
gume | 6:15a3bbf90fe9 | 617 | * @param pipe Which pipe # to close, 0-5. |
gume | 6:15a3bbf90fe9 | 618 | */ |
gume | 6:15a3bbf90fe9 | 619 | void closeReadingPipe( uint8_t pipe ) ; |
gume | 0:163155b607df | 620 | |
gume | 6:15a3bbf90fe9 | 621 | /** |
gume | 6:15a3bbf90fe9 | 622 | * Enable error detection by un-commenting #define FAILURE_HANDLING in RF24_config.h |
gume | 6:15a3bbf90fe9 | 623 | * If a failure has been detected, it usually indicates a hardware issue. By default the library |
gume | 6:15a3bbf90fe9 | 624 | * will cease operation when a failure is detected. |
gume | 6:15a3bbf90fe9 | 625 | * This should allow advanced users to detect and resolve intermittent hardware issues. |
gume | 6:15a3bbf90fe9 | 626 | * |
gume | 6:15a3bbf90fe9 | 627 | * In most cases, the radio must be re-enabled via radio.begin(); and the appropriate settings |
gume | 6:15a3bbf90fe9 | 628 | * applied after a failure occurs, if wanting to re-enable the device immediately. |
gume | 6:15a3bbf90fe9 | 629 | * |
gume | 6:15a3bbf90fe9 | 630 | * Usage: (Failure handling must be enabled per above) |
gume | 6:15a3bbf90fe9 | 631 | * @code |
gume | 6:15a3bbf90fe9 | 632 | * if(radio.failureDetected){ |
gume | 6:15a3bbf90fe9 | 633 | * radio.begin(); // Attempt to re-configure the radio with defaults |
gume | 6:15a3bbf90fe9 | 634 | * radio.failureDetected = 0; // Reset the detection value |
gume | 6:15a3bbf90fe9 | 635 | * radio.openWritingPipe(addresses[1]); // Re-configure pipe addresses |
gume | 6:15a3bbf90fe9 | 636 | * radio.openReadingPipe(1,addresses[0]); |
gume | 6:15a3bbf90fe9 | 637 | * report_failure(); // Blink leds, send a message, etc. to indicate failure |
gume | 6:15a3bbf90fe9 | 638 | * } |
gume | 6:15a3bbf90fe9 | 639 | * @endcode |
gume | 6:15a3bbf90fe9 | 640 | */ |
gume | 6:15a3bbf90fe9 | 641 | //#if defined (FAILURE_HANDLING) |
gume | 6:15a3bbf90fe9 | 642 | bool failureDetected; |
gume | 6:15a3bbf90fe9 | 643 | //#endif |
gume | 6:15a3bbf90fe9 | 644 | |
gume | 6:15a3bbf90fe9 | 645 | /**@}*/ |
gume | 0:163155b607df | 646 | |
gume | 6:15a3bbf90fe9 | 647 | /**@}*/ |
gume | 6:15a3bbf90fe9 | 648 | /** |
gume | 6:15a3bbf90fe9 | 649 | * @name Optional Configurators |
gume | 6:15a3bbf90fe9 | 650 | * |
gume | 6:15a3bbf90fe9 | 651 | * Methods you can use to get or set the configuration of the chip. |
gume | 6:15a3bbf90fe9 | 652 | * None are required. Calling begin() sets up a reasonable set of |
gume | 6:15a3bbf90fe9 | 653 | * defaults. |
gume | 6:15a3bbf90fe9 | 654 | */ |
gume | 6:15a3bbf90fe9 | 655 | /**@{*/ |
gume | 6:15a3bbf90fe9 | 656 | |
gume | 6:15a3bbf90fe9 | 657 | /** |
gume | 6:15a3bbf90fe9 | 658 | * Set the address width from 3 to 5 bytes (24, 32 or 40 bit) |
gume | 6:15a3bbf90fe9 | 659 | * |
gume | 6:15a3bbf90fe9 | 660 | * @param a_width The address width to use: 3,4 or 5 |
gume | 6:15a3bbf90fe9 | 661 | */ |
gume | 0:163155b607df | 662 | |
gume | 6:15a3bbf90fe9 | 663 | void setAddressWidth(uint8_t a_width); |
gume | 6:15a3bbf90fe9 | 664 | |
gume | 6:15a3bbf90fe9 | 665 | /** |
gume | 6:15a3bbf90fe9 | 666 | * Set the number and delay of retries upon failed submit |
gume | 6:15a3bbf90fe9 | 667 | * |
gume | 6:15a3bbf90fe9 | 668 | * @param delay How long to wait between each retry, in multiples of 250us, |
gume | 6:15a3bbf90fe9 | 669 | * max is 15. 0 means 250us, 15 means 4000us. |
gume | 6:15a3bbf90fe9 | 670 | * @param count How many retries before giving up, max 15 |
gume | 6:15a3bbf90fe9 | 671 | */ |
gume | 6:15a3bbf90fe9 | 672 | void setRetries(uint8_t delay, uint8_t count); |
gume | 6:15a3bbf90fe9 | 673 | |
gume | 6:15a3bbf90fe9 | 674 | /** |
gume | 6:15a3bbf90fe9 | 675 | * Set RF communication channel |
gume | 6:15a3bbf90fe9 | 676 | * |
gume | 6:15a3bbf90fe9 | 677 | * @param channel Which RF channel to communicate on, 0-125 |
gume | 6:15a3bbf90fe9 | 678 | */ |
gume | 6:15a3bbf90fe9 | 679 | void setChannel(uint8_t channel); |
gume | 6:15a3bbf90fe9 | 680 | |
gume | 0:163155b607df | 681 | /** |
gume | 6:15a3bbf90fe9 | 682 | * Get RF communication channel |
gume | 6:15a3bbf90fe9 | 683 | * |
gume | 6:15a3bbf90fe9 | 684 | * @return The currently configured RF Channel |
gume | 6:15a3bbf90fe9 | 685 | */ |
gume | 6:15a3bbf90fe9 | 686 | uint8_t getChannel(void); |
gume | 0:163155b607df | 687 | |
gume | 6:15a3bbf90fe9 | 688 | /** |
gume | 6:15a3bbf90fe9 | 689 | * Set Static Payload Size |
gume | 6:15a3bbf90fe9 | 690 | * |
gume | 6:15a3bbf90fe9 | 691 | * This implementation uses a pre-stablished fixed payload size for all |
gume | 6:15a3bbf90fe9 | 692 | * transmissions. If this method is never called, the driver will always |
gume | 6:15a3bbf90fe9 | 693 | * transmit the maximum payload size (32 bytes), no matter how much |
gume | 6:15a3bbf90fe9 | 694 | * was sent to write(). |
gume | 6:15a3bbf90fe9 | 695 | * |
gume | 6:15a3bbf90fe9 | 696 | * @todo Implement variable-sized payloads feature |
gume | 6:15a3bbf90fe9 | 697 | * |
gume | 6:15a3bbf90fe9 | 698 | * @param size The number of bytes in the payload |
gume | 6:15a3bbf90fe9 | 699 | */ |
gume | 6:15a3bbf90fe9 | 700 | void setPayloadSize(uint8_t size); |
gume | 0:163155b607df | 701 | |
gume | 6:15a3bbf90fe9 | 702 | /** |
gume | 6:15a3bbf90fe9 | 703 | * Get Static Payload Size |
gume | 6:15a3bbf90fe9 | 704 | * |
gume | 6:15a3bbf90fe9 | 705 | * @see setPayloadSize() |
gume | 6:15a3bbf90fe9 | 706 | * |
gume | 6:15a3bbf90fe9 | 707 | * @return The number of bytes in the payload |
gume | 6:15a3bbf90fe9 | 708 | */ |
gume | 6:15a3bbf90fe9 | 709 | uint8_t getPayloadSize(void); |
gume | 0:163155b607df | 710 | |
gume | 6:15a3bbf90fe9 | 711 | /** |
gume | 6:15a3bbf90fe9 | 712 | * Get Dynamic Payload Size |
gume | 6:15a3bbf90fe9 | 713 | * |
gume | 6:15a3bbf90fe9 | 714 | * For dynamic payloads, this pulls the size of the payload off |
gume | 6:15a3bbf90fe9 | 715 | * the chip |
gume | 6:15a3bbf90fe9 | 716 | * |
gume | 6:15a3bbf90fe9 | 717 | * @note Corrupt packets are now detected and flushed per the |
gume | 6:15a3bbf90fe9 | 718 | * manufacturer. |
gume | 6:15a3bbf90fe9 | 719 | * @code |
gume | 6:15a3bbf90fe9 | 720 | * if(radio.available()){ |
gume | 6:15a3bbf90fe9 | 721 | * if(radio.getDynamicPayloadSize() < 1){ |
gume | 6:15a3bbf90fe9 | 722 | * // Corrupt payload has been flushed |
gume | 6:15a3bbf90fe9 | 723 | * return; |
gume | 6:15a3bbf90fe9 | 724 | * } |
gume | 6:15a3bbf90fe9 | 725 | * radio.read(&data,sizeof(data)); |
gume | 6:15a3bbf90fe9 | 726 | * } |
gume | 6:15a3bbf90fe9 | 727 | * @endcode |
gume | 6:15a3bbf90fe9 | 728 | * |
gume | 6:15a3bbf90fe9 | 729 | * @return Payload length of last-received dynamic payload |
gume | 6:15a3bbf90fe9 | 730 | */ |
gume | 6:15a3bbf90fe9 | 731 | uint8_t getDynamicPayloadSize(void); |
gume | 0:163155b607df | 732 | |
gume | 6:15a3bbf90fe9 | 733 | /** |
gume | 6:15a3bbf90fe9 | 734 | * Enable custom payloads on the acknowledge packets |
gume | 6:15a3bbf90fe9 | 735 | * |
gume | 6:15a3bbf90fe9 | 736 | * Ack payloads are a handy way to return data back to senders without |
gume | 6:15a3bbf90fe9 | 737 | * manually changing the radio modes on both units. |
gume | 6:15a3bbf90fe9 | 738 | * |
gume | 6:15a3bbf90fe9 | 739 | * @note Ack payloads are dynamic payloads. This only works on pipes 0&1 by default. Call |
gume | 6:15a3bbf90fe9 | 740 | * enableDynamicPayloads() to enable on all pipes. |
gume | 6:15a3bbf90fe9 | 741 | */ |
gume | 6:15a3bbf90fe9 | 742 | void enableAckPayload(void); |
gume | 0:163155b607df | 743 | |
gume | 6:15a3bbf90fe9 | 744 | /** |
gume | 6:15a3bbf90fe9 | 745 | * Enable dynamically-sized payloads |
gume | 6:15a3bbf90fe9 | 746 | * |
gume | 6:15a3bbf90fe9 | 747 | * This way you don't always have to send large packets just to send them |
gume | 6:15a3bbf90fe9 | 748 | * once in a while. This enables dynamic payloads on ALL pipes. |
gume | 6:15a3bbf90fe9 | 749 | * |
gume | 6:15a3bbf90fe9 | 750 | */ |
gume | 6:15a3bbf90fe9 | 751 | void enableDynamicPayloads(void); |
gume | 6:15a3bbf90fe9 | 752 | |
gume | 6:15a3bbf90fe9 | 753 | /** |
gume | 6:15a3bbf90fe9 | 754 | * Disable dynamically-sized payloads |
gume | 6:15a3bbf90fe9 | 755 | * |
gume | 6:15a3bbf90fe9 | 756 | * This disables dynamic payloads on ALL pipes. Since Ack Payloads |
gume | 6:15a3bbf90fe9 | 757 | * requires Dynamic Payloads, Ack Payloads are also disabled. |
gume | 6:15a3bbf90fe9 | 758 | * If dynamic payloads are later re-enabled and ack payloads are desired |
gume | 6:15a3bbf90fe9 | 759 | * then enableAckPayload() must be called again as well. |
gume | 6:15a3bbf90fe9 | 760 | * |
gume | 6:15a3bbf90fe9 | 761 | */ |
gume | 6:15a3bbf90fe9 | 762 | void disableDynamicPayloads(void); |
gume | 6:15a3bbf90fe9 | 763 | |
gume | 6:15a3bbf90fe9 | 764 | /** |
gume | 6:15a3bbf90fe9 | 765 | * Enable dynamic ACKs (single write multicast or unicast) for chosen messages |
gume | 6:15a3bbf90fe9 | 766 | * |
gume | 6:15a3bbf90fe9 | 767 | * @note To enable full multicast or per-pipe multicast, use setAutoAck() |
gume | 6:15a3bbf90fe9 | 768 | * |
gume | 6:15a3bbf90fe9 | 769 | * @warning This MUST be called prior to attempting single write NOACK calls |
gume | 6:15a3bbf90fe9 | 770 | * @code |
gume | 6:15a3bbf90fe9 | 771 | * radio.enableDynamicAck(); |
gume | 6:15a3bbf90fe9 | 772 | * radio.write(&data,32,1); // Sends a payload with no acknowledgement requested |
gume | 6:15a3bbf90fe9 | 773 | * radio.write(&data,32,0); // Sends a payload using auto-retry/autoACK |
gume | 6:15a3bbf90fe9 | 774 | * @endcode |
gume | 6:15a3bbf90fe9 | 775 | */ |
gume | 6:15a3bbf90fe9 | 776 | void enableDynamicAck(); |
gume | 6:15a3bbf90fe9 | 777 | |
gume | 6:15a3bbf90fe9 | 778 | /** |
gume | 6:15a3bbf90fe9 | 779 | * Determine whether the hardware is an nRF24L01+ or not. |
gume | 6:15a3bbf90fe9 | 780 | * |
gume | 6:15a3bbf90fe9 | 781 | * @return true if the hardware is nRF24L01+ (or compatible) and false |
gume | 6:15a3bbf90fe9 | 782 | * if its not. |
gume | 6:15a3bbf90fe9 | 783 | */ |
gume | 6:15a3bbf90fe9 | 784 | bool isPVariant(void) ; |
gume | 0:163155b607df | 785 | |
gume | 6:15a3bbf90fe9 | 786 | /** |
gume | 6:15a3bbf90fe9 | 787 | * Enable or disable auto-acknowlede packets |
gume | 6:15a3bbf90fe9 | 788 | * |
gume | 6:15a3bbf90fe9 | 789 | * This is enabled by default, so it's only needed if you want to turn |
gume | 6:15a3bbf90fe9 | 790 | * it off for some reason. |
gume | 6:15a3bbf90fe9 | 791 | * |
gume | 6:15a3bbf90fe9 | 792 | * @param enable Whether to enable (true) or disable (false) auto-acks |
gume | 6:15a3bbf90fe9 | 793 | */ |
gume | 6:15a3bbf90fe9 | 794 | void setAutoAck(bool enable); |
gume | 0:163155b607df | 795 | |
gume | 6:15a3bbf90fe9 | 796 | /** |
gume | 6:15a3bbf90fe9 | 797 | * Enable or disable auto-acknowlede packets on a per pipeline basis. |
gume | 6:15a3bbf90fe9 | 798 | * |
gume | 6:15a3bbf90fe9 | 799 | * AA is enabled by default, so it's only needed if you want to turn |
gume | 6:15a3bbf90fe9 | 800 | * it off/on for some reason on a per pipeline basis. |
gume | 6:15a3bbf90fe9 | 801 | * |
gume | 6:15a3bbf90fe9 | 802 | * @param pipe Which pipeline to modify |
gume | 6:15a3bbf90fe9 | 803 | * @param enable Whether to enable (true) or disable (false) auto-acks |
gume | 6:15a3bbf90fe9 | 804 | */ |
gume | 6:15a3bbf90fe9 | 805 | void setAutoAck( uint8_t pipe, bool enable ) ; |
gume | 0:163155b607df | 806 | |
gume | 6:15a3bbf90fe9 | 807 | /** |
gume | 6:15a3bbf90fe9 | 808 | * Set Power Amplifier (PA) level to one of four levels: |
gume | 6:15a3bbf90fe9 | 809 | * RF24_PA_MIN, RF24_PA_LOW, RF24_PA_HIGH and RF24_PA_MAX |
gume | 6:15a3bbf90fe9 | 810 | * |
gume | 6:15a3bbf90fe9 | 811 | * The power levels correspond to the following output levels respectively: |
gume | 6:15a3bbf90fe9 | 812 | * NRF24L01: -18dBm, -12dBm,-6dBM, and 0dBm |
gume | 6:15a3bbf90fe9 | 813 | * |
gume | 6:15a3bbf90fe9 | 814 | * SI24R1: -6dBm, 0dBm, 3dBM, and 7dBm. |
gume | 6:15a3bbf90fe9 | 815 | * |
gume | 6:15a3bbf90fe9 | 816 | * @param level Desired PA level. |
gume | 6:15a3bbf90fe9 | 817 | */ |
gume | 6:15a3bbf90fe9 | 818 | void setPALevel ( uint8_t level ); |
gume | 0:163155b607df | 819 | |
gume | 6:15a3bbf90fe9 | 820 | /** |
gume | 6:15a3bbf90fe9 | 821 | * Fetches the current PA level. |
gume | 6:15a3bbf90fe9 | 822 | * |
gume | 6:15a3bbf90fe9 | 823 | * NRF24L01: -18dBm, -12dBm, -6dBm and 0dBm |
gume | 6:15a3bbf90fe9 | 824 | * SI24R1: -6dBm, 0dBm, 3dBm, 7dBm |
gume | 6:15a3bbf90fe9 | 825 | * |
gume | 6:15a3bbf90fe9 | 826 | * @return Returns values 0 to 3 representing the PA Level. |
gume | 6:15a3bbf90fe9 | 827 | */ |
gume | 6:15a3bbf90fe9 | 828 | uint8_t getPALevel( void ); |
gume | 0:163155b607df | 829 | |
gume | 6:15a3bbf90fe9 | 830 | /** |
gume | 6:15a3bbf90fe9 | 831 | * Set the transmission data rate |
gume | 6:15a3bbf90fe9 | 832 | * |
gume | 6:15a3bbf90fe9 | 833 | * @warning setting RF24_250KBPS will fail for non-plus units |
gume | 6:15a3bbf90fe9 | 834 | * |
gume | 6:15a3bbf90fe9 | 835 | * @param speed RF24_250KBPS for 250kbs, RF24_1MBPS for 1Mbps, or RF24_2MBPS for 2Mbps |
gume | 6:15a3bbf90fe9 | 836 | * @return true if the change was successful |
gume | 6:15a3bbf90fe9 | 837 | */ |
gume | 6:15a3bbf90fe9 | 838 | bool setDataRate(rf24_datarate_e speed); |
gume | 0:163155b607df | 839 | |
gume | 6:15a3bbf90fe9 | 840 | /** |
gume | 6:15a3bbf90fe9 | 841 | * Fetches the transmission data rate |
gume | 6:15a3bbf90fe9 | 842 | * |
gume | 6:15a3bbf90fe9 | 843 | * @return Returns the hardware's currently configured datarate. The value |
gume | 6:15a3bbf90fe9 | 844 | * is one of 250kbs, RF24_1MBPS for 1Mbps, or RF24_2MBPS, as defined in the |
gume | 6:15a3bbf90fe9 | 845 | * rf24_datarate_e enum. |
gume | 6:15a3bbf90fe9 | 846 | */ |
gume | 6:15a3bbf90fe9 | 847 | rf24_datarate_e getDataRate( void ) ; |
gume | 0:163155b607df | 848 | |
gume | 6:15a3bbf90fe9 | 849 | /** |
gume | 6:15a3bbf90fe9 | 850 | * Set the CRC length |
gume | 6:15a3bbf90fe9 | 851 | * <br>CRC checking cannot be disabled if auto-ack is enabled |
gume | 6:15a3bbf90fe9 | 852 | * @param length RF24_CRC_8 for 8-bit or RF24_CRC_16 for 16-bit |
gume | 6:15a3bbf90fe9 | 853 | */ |
gume | 6:15a3bbf90fe9 | 854 | void setCRCLength(rf24_crclength_e length); |
gume | 0:163155b607df | 855 | |
gume | 6:15a3bbf90fe9 | 856 | /** |
gume | 6:15a3bbf90fe9 | 857 | * Get the CRC length |
gume | 6:15a3bbf90fe9 | 858 | * <br>CRC checking cannot be disabled if auto-ack is enabled |
gume | 6:15a3bbf90fe9 | 859 | * @return RF24_CRC_DISABLED if disabled or RF24_CRC_8 for 8-bit or RF24_CRC_16 for 16-bit |
gume | 6:15a3bbf90fe9 | 860 | */ |
gume | 6:15a3bbf90fe9 | 861 | rf24_crclength_e getCRCLength(void); |
gume | 0:163155b607df | 862 | |
gume | 6:15a3bbf90fe9 | 863 | /** |
gume | 6:15a3bbf90fe9 | 864 | * Disable CRC validation |
gume | 6:15a3bbf90fe9 | 865 | * |
gume | 6:15a3bbf90fe9 | 866 | * @warning CRC cannot be disabled if auto-ack/ESB is enabled. |
gume | 6:15a3bbf90fe9 | 867 | */ |
gume | 6:15a3bbf90fe9 | 868 | void disableCRC( void ) ; |
gume | 0:163155b607df | 869 | |
gume | 6:15a3bbf90fe9 | 870 | /** |
gume | 6:15a3bbf90fe9 | 871 | * The radio will generate interrupt signals when a transmission is complete, |
gume | 6:15a3bbf90fe9 | 872 | * a transmission fails, or a payload is received. This allows users to mask |
gume | 6:15a3bbf90fe9 | 873 | * those interrupts to prevent them from generating a signal on the interrupt |
gume | 6:15a3bbf90fe9 | 874 | * pin. Interrupts are enabled on the radio chip by default. |
gume | 6:15a3bbf90fe9 | 875 | * |
gume | 6:15a3bbf90fe9 | 876 | * @code |
gume | 6:15a3bbf90fe9 | 877 | * Mask all interrupts except the receive interrupt: |
gume | 6:15a3bbf90fe9 | 878 | * |
gume | 6:15a3bbf90fe9 | 879 | * radio.maskIRQ(1,1,0); |
gume | 6:15a3bbf90fe9 | 880 | * @endcode |
gume | 6:15a3bbf90fe9 | 881 | * |
gume | 6:15a3bbf90fe9 | 882 | * @param tx_ok Mask transmission complete interrupts |
gume | 6:15a3bbf90fe9 | 883 | * @param tx_fail Mask transmit failure interrupts |
gume | 6:15a3bbf90fe9 | 884 | * @param rx_ready Mask payload received interrupts |
gume | 6:15a3bbf90fe9 | 885 | */ |
gume | 6:15a3bbf90fe9 | 886 | void maskIRQ(bool tx_ok,bool tx_fail,bool rx_ready); |
gume | 6:15a3bbf90fe9 | 887 | |
gume | 6:15a3bbf90fe9 | 888 | /** |
gume | 6:15a3bbf90fe9 | 889 | * |
gume | 6:15a3bbf90fe9 | 890 | * The driver will delay for this duration when stopListening() is called |
gume | 6:15a3bbf90fe9 | 891 | * |
gume | 6:15a3bbf90fe9 | 892 | * When responding to payloads, faster devices like ARM(RPi) are much faster than Arduino: |
gume | 6:15a3bbf90fe9 | 893 | * 1. Arduino sends data to RPi, switches to RX mode |
gume | 6:15a3bbf90fe9 | 894 | * 2. The RPi receives the data, switches to TX mode and sends before the Arduino radio is in RX mode |
gume | 6:15a3bbf90fe9 | 895 | * 3. If AutoACK is disabled, this can be set as low as 0. If AA/ESB enabled, set to 100uS minimum on RPi |
gume | 6:15a3bbf90fe9 | 896 | * |
gume | 6:15a3bbf90fe9 | 897 | * @warning If set to 0, ensure 130uS delay after stopListening() and before any sends |
gume | 6:15a3bbf90fe9 | 898 | */ |
gume | 6:15a3bbf90fe9 | 899 | |
gume | 6:15a3bbf90fe9 | 900 | uint32_t txDelay; |
gume | 0:163155b607df | 901 | |
gume | 6:15a3bbf90fe9 | 902 | /** |
gume | 6:15a3bbf90fe9 | 903 | * |
gume | 6:15a3bbf90fe9 | 904 | * On all devices but Linux and ATTiny, a small delay is added to the CSN toggling function |
gume | 6:15a3bbf90fe9 | 905 | * |
gume | 6:15a3bbf90fe9 | 906 | * This is intended to minimise the speed of SPI polling due to radio commands |
gume | 6:15a3bbf90fe9 | 907 | * |
gume | 6:15a3bbf90fe9 | 908 | * If using interrupts or timed requests, this can be set to 0 Default:5 |
gume | 6:15a3bbf90fe9 | 909 | */ |
gume | 6:15a3bbf90fe9 | 910 | |
gume | 6:15a3bbf90fe9 | 911 | uint32_t csDelay; |
gume | 6:15a3bbf90fe9 | 912 | |
gume | 6:15a3bbf90fe9 | 913 | /**@}*/ |
gume | 6:15a3bbf90fe9 | 914 | /** |
gume | 6:15a3bbf90fe9 | 915 | * @name Deprecated |
gume | 6:15a3bbf90fe9 | 916 | * |
gume | 6:15a3bbf90fe9 | 917 | * Methods provided for backwards compabibility. |
gume | 6:15a3bbf90fe9 | 918 | */ |
gume | 6:15a3bbf90fe9 | 919 | /**@{*/ |
gume | 0:163155b607df | 920 | |
gume | 0:163155b607df | 921 | |
gume | 6:15a3bbf90fe9 | 922 | /** |
gume | 6:15a3bbf90fe9 | 923 | * Open a pipe for reading |
gume | 6:15a3bbf90fe9 | 924 | * @note For compatibility with old code only, see new function |
gume | 6:15a3bbf90fe9 | 925 | * |
gume | 6:15a3bbf90fe9 | 926 | * @warning Pipes 1-5 should share the first 32 bits. |
gume | 6:15a3bbf90fe9 | 927 | * Only the least significant byte should be unique, e.g. |
gume | 6:15a3bbf90fe9 | 928 | * @code |
gume | 6:15a3bbf90fe9 | 929 | * openReadingPipe(1,0xF0F0F0F0AA); |
gume | 6:15a3bbf90fe9 | 930 | * openReadingPipe(2,0xF0F0F0F066); |
gume | 6:15a3bbf90fe9 | 931 | * @endcode |
gume | 6:15a3bbf90fe9 | 932 | * |
gume | 6:15a3bbf90fe9 | 933 | * @warning Pipe 0 is also used by the writing pipe. So if you open |
gume | 6:15a3bbf90fe9 | 934 | * pipe 0 for reading, and then startListening(), it will overwrite the |
gume | 6:15a3bbf90fe9 | 935 | * writing pipe. Ergo, do an openWritingPipe() again before write(). |
gume | 6:15a3bbf90fe9 | 936 | * |
gume | 6:15a3bbf90fe9 | 937 | * @param number Which pipe# to open, 0-5. |
gume | 6:15a3bbf90fe9 | 938 | * @param address The 40-bit address of the pipe to open. |
gume | 6:15a3bbf90fe9 | 939 | */ |
gume | 6:15a3bbf90fe9 | 940 | void openReadingPipe(uint8_t number, uint64_t address); |
gume | 0:163155b607df | 941 | |
gume | 6:15a3bbf90fe9 | 942 | /** |
gume | 6:15a3bbf90fe9 | 943 | * Open a pipe for writing |
gume | 6:15a3bbf90fe9 | 944 | * @note For compatibility with old code only, see new function |
gume | 6:15a3bbf90fe9 | 945 | * |
gume | 6:15a3bbf90fe9 | 946 | * Addresses are 40-bit hex values, e.g.: |
gume | 6:15a3bbf90fe9 | 947 | * |
gume | 6:15a3bbf90fe9 | 948 | * @code |
gume | 6:15a3bbf90fe9 | 949 | * openWritingPipe(0xF0F0F0F0F0); |
gume | 6:15a3bbf90fe9 | 950 | * @endcode |
gume | 6:15a3bbf90fe9 | 951 | * |
gume | 6:15a3bbf90fe9 | 952 | * @param address The 40-bit address of the pipe to open. |
gume | 6:15a3bbf90fe9 | 953 | */ |
gume | 6:15a3bbf90fe9 | 954 | void openWritingPipe(uint64_t address); |
gume | 6:15a3bbf90fe9 | 955 | |
gume | 6:15a3bbf90fe9 | 956 | /** |
gume | 6:15a3bbf90fe9 | 957 | * Empty the receive buffer |
gume | 6:15a3bbf90fe9 | 958 | * |
gume | 6:15a3bbf90fe9 | 959 | * @return Current value of status register |
gume | 6:15a3bbf90fe9 | 960 | */ |
gume | 6:15a3bbf90fe9 | 961 | uint8_t flush_rx(void); |
gume | 0:163155b607df | 962 | |
gume | 0:163155b607df | 963 | private: |
gume | 0:163155b607df | 964 | |
gume | 6:15a3bbf90fe9 | 965 | /** |
gume | 6:15a3bbf90fe9 | 966 | * @name Low-level internal interface. |
gume | 6:15a3bbf90fe9 | 967 | * |
gume | 6:15a3bbf90fe9 | 968 | * Protected methods that address the chip directly. Regular users cannot |
gume | 6:15a3bbf90fe9 | 969 | * ever call these. They are documented for completeness and for developers who |
gume | 6:15a3bbf90fe9 | 970 | * may want to extend this class. |
gume | 6:15a3bbf90fe9 | 971 | */ |
gume | 6:15a3bbf90fe9 | 972 | /**@{*/ |
gume | 0:163155b607df | 973 | |
gume | 6:15a3bbf90fe9 | 974 | /** |
gume | 6:15a3bbf90fe9 | 975 | * Set chip select pin |
gume | 6:15a3bbf90fe9 | 976 | * |
gume | 6:15a3bbf90fe9 | 977 | * Running SPI bus at PI_CLOCK_DIV2 so we don't waste time transferring data |
gume | 6:15a3bbf90fe9 | 978 | * and best of all, we make use of the radio's FIFO buffers. A lower speed |
gume | 6:15a3bbf90fe9 | 979 | * means we're less likely to effectively leverage our FIFOs and pay a higher |
gume | 6:15a3bbf90fe9 | 980 | * AVR runtime cost as toll. |
gume | 6:15a3bbf90fe9 | 981 | * |
gume | 6:15a3bbf90fe9 | 982 | * @param mode HIGH to take this unit off the SPI bus, LOW to put it on |
gume | 6:15a3bbf90fe9 | 983 | */ |
gume | 6:15a3bbf90fe9 | 984 | void csn(bool mode); |
gume | 0:163155b607df | 985 | |
gume | 6:15a3bbf90fe9 | 986 | /** |
gume | 6:15a3bbf90fe9 | 987 | * Set chip enable |
gume | 6:15a3bbf90fe9 | 988 | * |
gume | 6:15a3bbf90fe9 | 989 | * @param level HIGH to actively begin transmission or LOW to put in standby. Please see data sheet |
gume | 6:15a3bbf90fe9 | 990 | * for a much more detailed description of this pin. |
gume | 6:15a3bbf90fe9 | 991 | */ |
gume | 6:15a3bbf90fe9 | 992 | void ce(bool level); |
gume | 0:163155b607df | 993 | |
gume | 6:15a3bbf90fe9 | 994 | /** |
gume | 6:15a3bbf90fe9 | 995 | * Read a chunk of data in from a register |
gume | 6:15a3bbf90fe9 | 996 | * |
gume | 6:15a3bbf90fe9 | 997 | * @param reg Which register. Use constants from nRF24L01.h |
gume | 6:15a3bbf90fe9 | 998 | * @param buf Where to put the data |
gume | 6:15a3bbf90fe9 | 999 | * @param len How many bytes of data to transfer |
gume | 6:15a3bbf90fe9 | 1000 | * @return Current value of status register |
gume | 6:15a3bbf90fe9 | 1001 | */ |
gume | 6:15a3bbf90fe9 | 1002 | uint8_t read_register(uint8_t reg, uint8_t* buf, uint8_t len); |
gume | 0:163155b607df | 1003 | |
gume | 6:15a3bbf90fe9 | 1004 | /** |
gume | 6:15a3bbf90fe9 | 1005 | * Read single byte from a register |
gume | 6:15a3bbf90fe9 | 1006 | * |
gume | 6:15a3bbf90fe9 | 1007 | * @param reg Which register. Use constants from nRF24L01.h |
gume | 6:15a3bbf90fe9 | 1008 | * @return Current value of register @p reg |
gume | 6:15a3bbf90fe9 | 1009 | */ |
gume | 6:15a3bbf90fe9 | 1010 | uint8_t read_register(uint8_t reg); |
gume | 0:163155b607df | 1011 | |
gume | 6:15a3bbf90fe9 | 1012 | /** |
gume | 6:15a3bbf90fe9 | 1013 | * Write a chunk of data to a register |
gume | 6:15a3bbf90fe9 | 1014 | * |
gume | 6:15a3bbf90fe9 | 1015 | * @param reg Which register. Use constants from nRF24L01.h |
gume | 6:15a3bbf90fe9 | 1016 | * @param buf Where to get the data |
gume | 6:15a3bbf90fe9 | 1017 | * @param len How many bytes of data to transfer |
gume | 6:15a3bbf90fe9 | 1018 | * @return Current value of status register |
gume | 6:15a3bbf90fe9 | 1019 | */ |
gume | 6:15a3bbf90fe9 | 1020 | uint8_t write_register(uint8_t reg, const uint8_t* buf, uint8_t len); |
gume | 0:163155b607df | 1021 | |
gume | 6:15a3bbf90fe9 | 1022 | /** |
gume | 6:15a3bbf90fe9 | 1023 | * Write a single byte to a register |
gume | 6:15a3bbf90fe9 | 1024 | * |
gume | 6:15a3bbf90fe9 | 1025 | * @param reg Which register. Use constants from nRF24L01.h |
gume | 6:15a3bbf90fe9 | 1026 | * @param value The new value to write |
gume | 6:15a3bbf90fe9 | 1027 | * @return Current value of status register |
gume | 6:15a3bbf90fe9 | 1028 | */ |
gume | 6:15a3bbf90fe9 | 1029 | uint8_t write_register(uint8_t reg, uint8_t value); |
gume | 0:163155b607df | 1030 | |
gume | 6:15a3bbf90fe9 | 1031 | /** |
gume | 6:15a3bbf90fe9 | 1032 | * Write the transmit payload |
gume | 6:15a3bbf90fe9 | 1033 | * |
gume | 6:15a3bbf90fe9 | 1034 | * The size of data written is the fixed payload size, see getPayloadSize() |
gume | 6:15a3bbf90fe9 | 1035 | * |
gume | 6:15a3bbf90fe9 | 1036 | * @param buf Where to get the data |
gume | 6:15a3bbf90fe9 | 1037 | * @param len Number of bytes to be sent |
gume | 6:15a3bbf90fe9 | 1038 | * @return Current value of status register |
gume | 6:15a3bbf90fe9 | 1039 | */ |
gume | 6:15a3bbf90fe9 | 1040 | uint8_t write_payload(const void* buf, uint8_t len, const uint8_t writeType); |
gume | 0:163155b607df | 1041 | |
gume | 6:15a3bbf90fe9 | 1042 | /** |
gume | 6:15a3bbf90fe9 | 1043 | * Read the receive payload |
gume | 6:15a3bbf90fe9 | 1044 | * |
gume | 6:15a3bbf90fe9 | 1045 | * The size of data read is the fixed payload size, see getPayloadSize() |
gume | 6:15a3bbf90fe9 | 1046 | * |
gume | 6:15a3bbf90fe9 | 1047 | * @param buf Where to put the data |
gume | 6:15a3bbf90fe9 | 1048 | * @param len Maximum number of bytes to read |
gume | 6:15a3bbf90fe9 | 1049 | * @return Current value of status register |
gume | 6:15a3bbf90fe9 | 1050 | */ |
gume | 6:15a3bbf90fe9 | 1051 | uint8_t read_payload(void* buf, uint8_t len); |
gume | 0:163155b607df | 1052 | |
gume | 6:15a3bbf90fe9 | 1053 | /** |
gume | 6:15a3bbf90fe9 | 1054 | * Retrieve the current status of the chip |
gume | 6:15a3bbf90fe9 | 1055 | * |
gume | 6:15a3bbf90fe9 | 1056 | * @return Current value of status register |
gume | 6:15a3bbf90fe9 | 1057 | */ |
gume | 6:15a3bbf90fe9 | 1058 | uint8_t get_status(void); |
gume | 0:163155b607df | 1059 | |
gume | 6:15a3bbf90fe9 | 1060 | #if !defined (MINIMAL) |
gume | 6:15a3bbf90fe9 | 1061 | /** |
gume | 6:15a3bbf90fe9 | 1062 | * Decode and print the given status to stdout |
gume | 6:15a3bbf90fe9 | 1063 | * |
gume | 6:15a3bbf90fe9 | 1064 | * @param status Status value to print |
gume | 6:15a3bbf90fe9 | 1065 | * |
gume | 6:15a3bbf90fe9 | 1066 | * @warning Does nothing if stdout is not defined. See fdevopen in stdio.h |
gume | 6:15a3bbf90fe9 | 1067 | */ |
gume | 6:15a3bbf90fe9 | 1068 | void print_status(uint8_t status); |
gume | 0:163155b607df | 1069 | |
gume | 6:15a3bbf90fe9 | 1070 | /** |
gume | 6:15a3bbf90fe9 | 1071 | * Decode and print the given 'observe_tx' value to stdout |
gume | 6:15a3bbf90fe9 | 1072 | * |
gume | 6:15a3bbf90fe9 | 1073 | * @param value The observe_tx value to print |
gume | 6:15a3bbf90fe9 | 1074 | * |
gume | 6:15a3bbf90fe9 | 1075 | * @warning Does nothing if stdout is not defined. See fdevopen in stdio.h |
gume | 6:15a3bbf90fe9 | 1076 | */ |
gume | 6:15a3bbf90fe9 | 1077 | void print_observe_tx(uint8_t value); |
gume | 0:163155b607df | 1078 | |
gume | 6:15a3bbf90fe9 | 1079 | /** |
gume | 6:15a3bbf90fe9 | 1080 | * Print the name and value of an 8-bit register to stdout |
gume | 6:15a3bbf90fe9 | 1081 | * |
gume | 6:15a3bbf90fe9 | 1082 | * Optionally it can print some quantity of successive |
gume | 6:15a3bbf90fe9 | 1083 | * registers on the same line. This is useful for printing a group |
gume | 6:15a3bbf90fe9 | 1084 | * of related registers on one line. |
gume | 6:15a3bbf90fe9 | 1085 | * |
gume | 6:15a3bbf90fe9 | 1086 | * @param name Name of the register |
gume | 6:15a3bbf90fe9 | 1087 | * @param reg Which register. Use constants from nRF24L01.h |
gume | 6:15a3bbf90fe9 | 1088 | * @param qty How many successive registers to print |
gume | 6:15a3bbf90fe9 | 1089 | */ |
gume | 6:15a3bbf90fe9 | 1090 | void print_byte_register(const char* name, uint8_t reg, uint8_t qty = 1); |
gume | 0:163155b607df | 1091 | |
gume | 6:15a3bbf90fe9 | 1092 | /** |
gume | 6:15a3bbf90fe9 | 1093 | * Print the name and value of a 40-bit address register to stdout |
gume | 6:15a3bbf90fe9 | 1094 | * |
gume | 6:15a3bbf90fe9 | 1095 | * Optionally it can print some quantity of successive |
gume | 6:15a3bbf90fe9 | 1096 | * registers on the same line. This is useful for printing a group |
gume | 6:15a3bbf90fe9 | 1097 | * of related registers on one line. |
gume | 6:15a3bbf90fe9 | 1098 | * |
gume | 6:15a3bbf90fe9 | 1099 | * @param name Name of the register |
gume | 6:15a3bbf90fe9 | 1100 | * @param reg Which register. Use constants from nRF24L01.h |
gume | 6:15a3bbf90fe9 | 1101 | * @param qty How many successive registers to print |
gume | 6:15a3bbf90fe9 | 1102 | */ |
gume | 6:15a3bbf90fe9 | 1103 | void print_address_register(const char* name, uint8_t reg, uint8_t qty = 1); |
gume | 0:163155b607df | 1104 | #endif |
gume | 6:15a3bbf90fe9 | 1105 | /** |
gume | 6:15a3bbf90fe9 | 1106 | * Turn on or off the special features of the chip |
gume | 6:15a3bbf90fe9 | 1107 | * |
gume | 6:15a3bbf90fe9 | 1108 | * The chip has certain 'features' which are only available when the 'features' |
gume | 6:15a3bbf90fe9 | 1109 | * are enabled. See the datasheet for details. |
gume | 6:15a3bbf90fe9 | 1110 | */ |
gume | 6:15a3bbf90fe9 | 1111 | void toggle_features(void); |
gume | 0:163155b607df | 1112 | |
gume | 6:15a3bbf90fe9 | 1113 | /** |
gume | 6:15a3bbf90fe9 | 1114 | * Built in spi transfer function to simplify repeating code repeating code |
gume | 6:15a3bbf90fe9 | 1115 | */ |
gume | 0:163155b607df | 1116 | |
gume | 6:15a3bbf90fe9 | 1117 | uint8_t spiTrans(uint8_t cmd); |
gume | 6:15a3bbf90fe9 | 1118 | |
gume | 6:15a3bbf90fe9 | 1119 | #if defined (FAILURE_HANDLING) || defined (RF24_LINUX) |
gume | 0:163155b607df | 1120 | void errNotify(void); |
gume | 6:15a3bbf90fe9 | 1121 | #endif |
gume | 6:15a3bbf90fe9 | 1122 | |
gume | 6:15a3bbf90fe9 | 1123 | /**@}*/ |
gume | 0:163155b607df | 1124 | |
gume | 0:163155b607df | 1125 | }; |
gume | 0:163155b607df | 1126 | |
gume | 0:163155b607df | 1127 | |
gume | 0:163155b607df | 1128 | #endif // __RF24_H__ |