Damien Frost / NRF2401P

My fork during debugging.

Fork of NRF2401P by Malcolm McCulloch

NRF2401P.h@9:c21b80aaf250, 2015-07-11 (annotated)

Committer:
nixonkj
Date:
Sat Jul 11 09:38:59 2015 +0000
Revision:
9:c21b80aaf250
Parent:
8:3e027705ce23
Child:
10:8a217441c38e
Added basic function to display radio setup and configuration.  Fix dynamic payload setup.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
epgmdm 0:8fd0531ae0be 1 /**
epgmdm 0:8fd0531ae0be 2 *@section DESCRIPTION
epgmdm 0:8fd0531ae0be 3 * mbed NRF2401+ Library
epgmdm 0:8fd0531ae0be 4 *@section LICENSE
epgmdm 0:8fd0531ae0be 5 * Copyright (c) 2015, Malcolm McCulloch
epgmdm 0:8fd0531ae0be 6 *
epgmdm 0:8fd0531ae0be 7 * Permission is hereby granted, free of charge, to any person obtaining a copy
epgmdm 0:8fd0531ae0be 8 * of this software and associated documentation files (the "Software"), to deal
epgmdm 0:8fd0531ae0be 9 * in the Software without restriction, including without limitation the rights
epgmdm 0:8fd0531ae0be 10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
epgmdm 0:8fd0531ae0be 11 * copies of the Software, and to permit persons to whom the Software is
epgmdm 0:8fd0531ae0be 12 * furnished to do so, subject to the following conditions:
epgmdm 0:8fd0531ae0be 13 *
epgmdm 0:8fd0531ae0be 14 * The above copyright notice and this permission notice shall be included in
epgmdm 0:8fd0531ae0be 15 * all copies or substantial portions of the Software.
epgmdm 0:8fd0531ae0be 16 *
epgmdm 0:8fd0531ae0be 17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
epgmdm 0:8fd0531ae0be 18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
epgmdm 0:8fd0531ae0be 19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
epgmdm 0:8fd0531ae0be 20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
epgmdm 0:8fd0531ae0be 21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
epgmdm 0:8fd0531ae0be 22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
epgmdm 0:8fd0531ae0be 23 * THE SOFTWARE.
epgmdm 0:8fd0531ae0be 24 * @file "NRF2401P.h"
epgmdm 0:8fd0531ae0be 25 */
nixonkj 9:c21b80aaf250 26
nixonkj 9:c21b80aaf250 27 #ifndef MBED_NRF2401P_H
nixonkj 9:c21b80aaf250 28 #define MBED_NRF2401P_H
epgmdm 5:7e253c677a1f 29
epgmdm 5:7e253c677a1f 30 /** \brief A library to drive the nRF24l01+
epgmdm 5:7e253c677a1f 31 *
epgmdm 5:7e253c677a1f 32 * This library is a simple way to get the nRF24l01+ up and running.
epgmdm 5:7e253c677a1f 33 *
epgmdm 5:7e253c677a1f 34 *- Use case: For a simple transmitter
epgmdm 5:7e253c677a1f 35 *@code
epgmdm 5:7e253c677a1f 36 *int main() {
epgmdm 5:7e253c677a1f 37 *
epgmdm 5:7e253c677a1f 38 * long long addr1=0xAB00CD; // setup address - any 5 byte number - same as RX
epgmdm 5:7e253c677a1f 39 * int channel =0x12; // [0-126] setup channel, must be same as RX
epgmdm 5:7e253c677a1f 40 * bool txOK;
epgmdm 5:7e253c677a1f 41 * char msg[32];
epgmdm 5:7e253c677a1f 42 * char ackData[32];
epgmdm 5:7e253c677a1f 43 * char len;
epgmdm 5:7e253c677a1f 44 *
epgmdm 5:7e253c677a1f 45 * // Setup
epgmdm 5:7e253c677a1f 46 * NRF2401P nrf1(PTD6,PTD7, PTD5,PTD4, PTC12); //mosi, miso, sclk, csn, ce)
epgmdm 5:7e253c677a1f 47 * nrf1.quickTxSetup(channel, addr1); // sets nrf24l01+ as transmitter
epgmdm 5:7e253c677a1f 48 *
epgmdm 5:7e253c677a1f 49 * // transmit
epgmdm 5:7e253c677a1f 50 * strcpy (msg, "Hello");
epgmdm 5:7e253c677a1f 51 * txOK= nrf1.transmitData(msg,strlen(msg));
epgmdm 5:7e253c677a1f 52 *
epgmdm 5:7e253c677a1f 53 * // read ack data if available
epgmdm 5:7e253c677a1f 54 * if (nrf1.isAckData()) {
epgmdm 5:7e253c677a1f 55 * len= nrf1.getRxData(ackData); // len is number of bytes in ackData
epgmdm 5:7e253c677a1f 56 * }
epgmdm 5:7e253c677a1f 57 *}
epgmdm 5:7e253c677a1f 58 *@endcode
epgmdm 5:7e253c677a1f 59 *- Use case: For a simple receiver
epgmdm 5:7e253c677a1f 60 *@code
epgmdm 5:7e253c677a1f 61 *int main(){
epgmdm 5:7e253c677a1f 62 *
epgmdm 5:7e253c677a1f 63 * long long addr1=0xAB00CD; // setup address - any 5 byte number - same as TX
epgmdm 5:7e253c677a1f 64 * int channel =0x12; // [0-126] setup channel, must be same as TX
epgmdm 5:7e253c677a1f 65 * bool txOK;
epgmdm 5:7e253c677a1f 66 * char msg[32];
epgmdm 5:7e253c677a1f 67 * char ackData[32];
epgmdm 5:7e253c677a1f 68 * char len;
epgmdm 5:7e253c677a1f 69 *
epgmdm 5:7e253c677a1f 70 * // Setup
epgmdm 5:7e253c677a1f 71 * NRF2401P nrf1(PTD6,PTD7, PTD5,PTD4, PTC12); //mosi, miso, sclk, csn, ce)
epgmdm 5:7e253c677a1f 72 * nrf1.quickRxSetup(channel, addr1); // sets nrf24l01+ as receiver, using pipe 1
epgmdm 5:7e253c677a1f 73 *
epgmdm 5:7e253c677a1f 74 * // set ack data
epgmdm 5:7e253c677a1f 75 * sprintf(ackData,"Ack data");
epgmdm 5:7e253c677a1f 76 * nrf1.acknowledgeData(ackData, strlen(ackData),1); // ack for pipe 1
epgmdm 5:7e253c677a1f 77 *
epgmdm 5:7e253c677a1f 78 * // receive
epgmdm 5:7e253c677a1f 79 * while (! nrf1.isRxData()); // note this blocks until RX data
epgmdm 5:7e253c677a1f 80 * len= nrf1.getRxData(msg); // gets the message, len is length of msg
epgmdm 5:7e253c677a1f 81 *
epgmdm 5:7e253c677a1f 82 *}
epgmdm 5:7e253c677a1f 83 *@endcode
epgmdm 5:7e253c677a1f 84 */
nixonkj 9:c21b80aaf250 85
epgmdm 0:8fd0531ae0be 86 class NRF2401P
epgmdm 0:8fd0531ae0be 87 {
epgmdm 0:8fd0531ae0be 88 public:
epgmdm 0:8fd0531ae0be 89 SPI *spi;
epgmdm 0:8fd0531ae0be 90 DigitalOut csn,ce;
epgmdm 0:8fd0531ae0be 91 char addressWidth;
epgmdm 0:8fd0531ae0be 92 char logMsg[80];
epgmdm 0:8fd0531ae0be 93 char status;
epgmdm 0:8fd0531ae0be 94 char statusS[32];
epgmdm 2:ca0a3c0bba70 95 char pipe0Add[5];
epgmdm 2:ca0a3c0bba70 96 char txAdd[5];
epgmdm 0:8fd0531ae0be 97 bool dynamic,debug;
epgmdm 0:8fd0531ae0be 98 Serial *pc;
epgmdm 0:8fd0531ae0be 99
nixonkj 9:c21b80aaf250 100 /** Create a radio device for communicating with the RF24L01P via SPI.
nixonkj 9:c21b80aaf250 101 *
nixonkj 9:c21b80aaf250 102 * @param mosi The SPI slave data input pin.
nixonkj 9:c21b80aaf250 103 * @param miso The SPI Slave Data Output (with tri-state option).
nixonkj 9:c21b80aaf250 104 * @param sclk The SPI clock pin.
nixonkj 9:c21b80aaf250 105 * @param _csn The SPI chip select pin.
nixonkj 9:c21b80aaf250 106 * @param _ce Chip Enable pin (Activates RX or TX mode).
nixonkj 9:c21b80aaf250 107 */
epgmdm 0:8fd0531ae0be 108 NRF2401P (PinName mosi, PinName miso, PinName sclk, PinName _csn, PinName _ce);
epgmdm 0:8fd0531ae0be 109
nixonkj 8:3e027705ce23 110 char acknowledgeData(char *data, char width, char pipe);
epgmdm 1:ff53b1ac3bad 111 char checkStatus();
nixonkj 6:77ead8abdd1c 112 void clearStatus();
nixonkj 6:77ead8abdd1c 113 void flushRx();
nixonkj 6:77ead8abdd1c 114 void flushTx();
epgmdm 0:8fd0531ae0be 115 char getRxData(char * buffer);
epgmdm 0:8fd0531ae0be 116 char getRxWidth();
epgmdm 1:ff53b1ac3bad 117 bool isAckData();
epgmdm 0:8fd0531ae0be 118 bool isRxData();
nixonkj 8:3e027705ce23 119
nixonkj 8:3e027705ce23 120 /** Writes message and waits for 10 ms (
nixonkj 8:3e027705ce23 121 *
nixonkj 8:3e027705ce23 122 * @param msg
nixonkj 8:3e027705ce23 123 */
epgmdm 0:8fd0531ae0be 124 void log (char *msg);
nixonkj 8:3e027705ce23 125
epgmdm 0:8fd0531ae0be 126 void quickRxSetup(int channel,long long addr);
epgmdm 0:8fd0531ae0be 127 void quickTxSetup(int channel,long long addr);
nixonkj 6:77ead8abdd1c 128 void readReg(char address, char *data);
epgmdm 0:8fd0531ae0be 129 char testReceive();
epgmdm 0:8fd0531ae0be 130 char testTransmit();
nixonkj 6:77ead8abdd1c 131 char transmitData( char *data, char width );
epgmdm 0:8fd0531ae0be 132
nixonkj 6:77ead8abdd1c 133 char setAddressWidth(char width);
nixonkj 8:3e027705ce23 134
nixonkj 8:3e027705ce23 135 /** Sets the frequency channel nRF24L01+ operates on
nixonkj 8:3e027705ce23 136 *
nixonkj 8:3e027705ce23 137 * @param chan F0 = 2400 + chan [MHz]
nixonkj 8:3e027705ce23 138 * @returns
nixonkj 8:3e027705ce23 139 * 0 on success,
nixonkj 8:3e027705ce23 140 * non-zero on failure.
nixonkj 8:3e027705ce23 141 */
epgmdm 0:8fd0531ae0be 142 char setChannel(char chan);
nixonkj 8:3e027705ce23 143
epgmdm 2:ca0a3c0bba70 144 void setDynamicPayload();
nixonkj 6:77ead8abdd1c 145 char setPwrUp();
nixonkj 7:621a5b0cf1aa 146
nixonkj 7:621a5b0cf1aa 147 /** Set RF data rate and RF output power in TX mode
nixonkj 7:621a5b0cf1aa 148 *
nixonkj 7:621a5b0cf1aa 149 * @param speed RF data rate: '0x00' – 1Mbps, '0x01' – 2Mbps, '0x02' – 250kbps, '0x03' – Reserved
nixonkj 7:621a5b0cf1aa 150 * @param power RF output power: '0x00' – -18dBm, '0x01' – -12dBm, '0x02' – -6dBm, '0x03' – 0dBm
nixonkj 7:621a5b0cf1aa 151 * @returns
nixonkj 7:621a5b0cf1aa 152 * 0 on success,
nixonkj 7:621a5b0cf1aa 153 * non-zero on failure.
nixonkj 7:621a5b0cf1aa 154 */
nixonkj 7:621a5b0cf1aa 155 char setRadio(char speed, char power);
nixonkj 7:621a5b0cf1aa 156
epgmdm 0:8fd0531ae0be 157 char setRxAddress(char *address, char pipe);
epgmdm 0:8fd0531ae0be 158 char setRxAddress(long long address, char pipe);
nixonkj 6:77ead8abdd1c 159 char setRxMode();
epgmdm 0:8fd0531ae0be 160 char setTxAddress(char *address);
epgmdm 0:8fd0531ae0be 161 char setTxAddress(long long address);
nixonkj 6:77ead8abdd1c 162 char setTxMode();
nixonkj 8:3e027705ce23 163
nixonkj 8:3e027705ce23 164 /** Sets the timing and number of TX retries
nixonkj 8:3e027705ce23 165 *
nixonkj 8:3e027705ce23 166 * @param delay Auto Retransmit Delay: '0000' – Wait 250uS', '0001' – Wait 500uS, ..., '1111' – Wait 4000uS
nixonkj 8:3e027705ce23 167 * @param numTries Auto Retransmit Count: '0000' – Re-Transmit disabled, '0001' – Up to 1 Re-Transmit on fail of AA, ..., '1111' – Up to 15 Re-Transmit on fail of AA
nixonkj 8:3e027705ce23 168 * @returns
nixonkj 8:3e027705ce23 169 * 0 on success,
nixonkj 8:3e027705ce23 170 * non-zero on failure.
nixonkj 8:3e027705ce23 171 */
nixonkj 6:77ead8abdd1c 172 char setTxRetry(char delay, char numTries);
nixonkj 8:3e027705ce23 173
epgmdm 2:ca0a3c0bba70 174 void start();
nixonkj 8:3e027705ce23 175 char* statusString();
nixonkj 9:c21b80aaf250 176
nixonkj 9:c21b80aaf250 177 /** Print details about the radio setup and configuration
nixonkj 9:c21b80aaf250 178 *
nixonkj 9:c21b80aaf250 179 * (Need to add ability to print address configurations
nixonkj 9:c21b80aaf250 180 */
nixonkj 9:c21b80aaf250 181 void printDetails();
nixonkj 9:c21b80aaf250 182
nixonkj 6:77ead8abdd1c 183 void writeReg(char address, char *data, char width);
nixonkj 6:77ead8abdd1c 184 void writeReg(char address, char data);
epgmdm 0:8fd0531ae0be 185
epgmdm 0:8fd0531ae0be 186 void scratch();
epgmdm 0:8fd0531ae0be 187
epgmdm 0:8fd0531ae0be 188
nixonkj 9:c21b80aaf250 189 };
nixonkj 9:c21b80aaf250 190 #endif