Damien Frost / NRF2401P

My fork during debugging.

Fork of NRF2401P by Malcolm McCulloch

NRF2401P.h@8:3e027705ce23, 2015-07-05 (annotated)

Committer:
nixonkj
Date:
Sun Jul 05 23:33:37 2015 +0000
Revision:
8:3e027705ce23
Parent:
7:621a5b0cf1aa
Child:
9:c21b80aaf250
Incremental improvement on documentation.

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 */
epgmdm 5:7e253c677a1f 26
epgmdm 5:7e253c677a1f 27 /** \brief A library to drive the nRF24l01+
epgmdm 5:7e253c677a1f 28 *
epgmdm 5:7e253c677a1f 29 * This library is a simple way to get the nRF24l01+ up and running.
epgmdm 5:7e253c677a1f 30 *
epgmdm 5:7e253c677a1f 31 *- Use case: For a simple transmitter
epgmdm 5:7e253c677a1f 32 *@code
epgmdm 5:7e253c677a1f 33 *int main() {
epgmdm 5:7e253c677a1f 34 *
epgmdm 5:7e253c677a1f 35 * long long addr1=0xAB00CD; // setup address - any 5 byte number - same as RX
epgmdm 5:7e253c677a1f 36 * int channel =0x12; // [0-126] setup channel, must be same as RX
epgmdm 5:7e253c677a1f 37 * bool txOK;
epgmdm 5:7e253c677a1f 38 * char msg[32];
epgmdm 5:7e253c677a1f 39 * char ackData[32];
epgmdm 5:7e253c677a1f 40 * char len;
epgmdm 5:7e253c677a1f 41 *
epgmdm 5:7e253c677a1f 42 * // Setup
epgmdm 5:7e253c677a1f 43 * NRF2401P nrf1(PTD6,PTD7, PTD5,PTD4, PTC12); //mosi, miso, sclk, csn, ce)
epgmdm 5:7e253c677a1f 44 * nrf1.quickTxSetup(channel, addr1); // sets nrf24l01+ as transmitter
epgmdm 5:7e253c677a1f 45 *
epgmdm 5:7e253c677a1f 46 * // transmit
epgmdm 5:7e253c677a1f 47 * strcpy (msg, "Hello");
epgmdm 5:7e253c677a1f 48 * txOK= nrf1.transmitData(msg,strlen(msg));
epgmdm 5:7e253c677a1f 49 *
epgmdm 5:7e253c677a1f 50 * // read ack data if available
epgmdm 5:7e253c677a1f 51 * if (nrf1.isAckData()) {
epgmdm 5:7e253c677a1f 52 * len= nrf1.getRxData(ackData); // len is number of bytes in ackData
epgmdm 5:7e253c677a1f 53 * }
epgmdm 5:7e253c677a1f 54 *}
epgmdm 5:7e253c677a1f 55 *@endcode
epgmdm 5:7e253c677a1f 56 *- Use case: For a simple receiver
epgmdm 5:7e253c677a1f 57 *@code
epgmdm 5:7e253c677a1f 58 *int main(){
epgmdm 5:7e253c677a1f 59 *
epgmdm 5:7e253c677a1f 60 * long long addr1=0xAB00CD; // setup address - any 5 byte number - same as TX
epgmdm 5:7e253c677a1f 61 * int channel =0x12; // [0-126] setup channel, must be same as TX
epgmdm 5:7e253c677a1f 62 * bool txOK;
epgmdm 5:7e253c677a1f 63 * char msg[32];
epgmdm 5:7e253c677a1f 64 * char ackData[32];
epgmdm 5:7e253c677a1f 65 * char len;
epgmdm 5:7e253c677a1f 66 *
epgmdm 5:7e253c677a1f 67 * // Setup
epgmdm 5:7e253c677a1f 68 * NRF2401P nrf1(PTD6,PTD7, PTD5,PTD4, PTC12); //mosi, miso, sclk, csn, ce)
epgmdm 5:7e253c677a1f 69 * nrf1.quickRxSetup(channel, addr1); // sets nrf24l01+ as receiver, using pipe 1
epgmdm 5:7e253c677a1f 70 *
epgmdm 5:7e253c677a1f 71 * // set ack data
epgmdm 5:7e253c677a1f 72 * sprintf(ackData,"Ack data");
epgmdm 5:7e253c677a1f 73 * nrf1.acknowledgeData(ackData, strlen(ackData),1); // ack for pipe 1
epgmdm 5:7e253c677a1f 74 *
epgmdm 5:7e253c677a1f 75 * // receive
epgmdm 5:7e253c677a1f 76 * while (! nrf1.isRxData()); // note this blocks until RX data
epgmdm 5:7e253c677a1f 77 * len= nrf1.getRxData(msg); // gets the message, len is length of msg
epgmdm 5:7e253c677a1f 78 *
epgmdm 5:7e253c677a1f 79 *}
epgmdm 5:7e253c677a1f 80 *@endcode
epgmdm 5:7e253c677a1f 81 */
epgmdm 0:8fd0531ae0be 82 class NRF2401P
epgmdm 0:8fd0531ae0be 83 {
epgmdm 0:8fd0531ae0be 84 public:
epgmdm 0:8fd0531ae0be 85 SPI *spi;
epgmdm 0:8fd0531ae0be 86 DigitalOut csn,ce;
epgmdm 0:8fd0531ae0be 87 char addressWidth;
epgmdm 0:8fd0531ae0be 88 char logMsg[80];
epgmdm 0:8fd0531ae0be 89 char status;
epgmdm 0:8fd0531ae0be 90 char statusS[32];
epgmdm 2:ca0a3c0bba70 91 char pipe0Add[5];
epgmdm 2:ca0a3c0bba70 92 char txAdd[5];
epgmdm 0:8fd0531ae0be 93 bool dynamic,debug;
epgmdm 0:8fd0531ae0be 94 Serial *pc;
epgmdm 0:8fd0531ae0be 95
epgmdm 0:8fd0531ae0be 96 NRF2401P (PinName mosi, PinName miso, PinName sclk, PinName _csn, PinName _ce);
epgmdm 0:8fd0531ae0be 97
nixonkj 8:3e027705ce23 98 char acknowledgeData(char *data, char width, char pipe);
epgmdm 1:ff53b1ac3bad 99 char checkStatus();
nixonkj 6:77ead8abdd1c 100 void clearStatus();
nixonkj 6:77ead8abdd1c 101 void flushRx();
nixonkj 6:77ead8abdd1c 102 void flushTx();
epgmdm 0:8fd0531ae0be 103 char getRxData(char * buffer);
epgmdm 0:8fd0531ae0be 104 char getRxWidth();
epgmdm 1:ff53b1ac3bad 105 bool isAckData();
epgmdm 0:8fd0531ae0be 106 bool isRxData();
nixonkj 8:3e027705ce23 107
nixonkj 8:3e027705ce23 108 /** Writes message and waits for 10 ms (
nixonkj 8:3e027705ce23 109 *
nixonkj 8:3e027705ce23 110 * @param msg
nixonkj 8:3e027705ce23 111 */
epgmdm 0:8fd0531ae0be 112 void log (char *msg);
nixonkj 8:3e027705ce23 113
epgmdm 0:8fd0531ae0be 114 void quickRxSetup(int channel,long long addr);
epgmdm 0:8fd0531ae0be 115 void quickTxSetup(int channel,long long addr);
nixonkj 6:77ead8abdd1c 116 void readReg(char address, char *data);
epgmdm 0:8fd0531ae0be 117 char testReceive();
epgmdm 0:8fd0531ae0be 118 char testTransmit();
nixonkj 6:77ead8abdd1c 119 char transmitData( char *data, char width );
epgmdm 0:8fd0531ae0be 120
nixonkj 6:77ead8abdd1c 121 char setAddressWidth(char width);
nixonkj 8:3e027705ce23 122
nixonkj 8:3e027705ce23 123 /** Sets the frequency channel nRF24L01+ operates on
nixonkj 8:3e027705ce23 124 *
nixonkj 8:3e027705ce23 125 * @param chan F0 = 2400 + chan [MHz]
nixonkj 8:3e027705ce23 126 * @returns
nixonkj 8:3e027705ce23 127 * 0 on success,
nixonkj 8:3e027705ce23 128 * non-zero on failure.
nixonkj 8:3e027705ce23 129 */
epgmdm 0:8fd0531ae0be 130 char setChannel(char chan);
nixonkj 8:3e027705ce23 131
epgmdm 2:ca0a3c0bba70 132 void setDynamicPayload();
nixonkj 6:77ead8abdd1c 133 char setPwrUp();
nixonkj 7:621a5b0cf1aa 134
nixonkj 7:621a5b0cf1aa 135 /** Set RF data rate and RF output power in TX mode
nixonkj 7:621a5b0cf1aa 136 *
nixonkj 7:621a5b0cf1aa 137 * @param speed RF data rate: '0x00' – 1Mbps, '0x01' – 2Mbps, '0x02' – 250kbps, '0x03' – Reserved
nixonkj 7:621a5b0cf1aa 138 * @param power RF output power: '0x00' – -18dBm, '0x01' – -12dBm, '0x02' – -6dBm, '0x03' – 0dBm
nixonkj 7:621a5b0cf1aa 139 * @returns
nixonkj 7:621a5b0cf1aa 140 * 0 on success,
nixonkj 7:621a5b0cf1aa 141 * non-zero on failure.
nixonkj 7:621a5b0cf1aa 142 */
nixonkj 7:621a5b0cf1aa 143 char setRadio(char speed, char power);
nixonkj 7:621a5b0cf1aa 144
epgmdm 0:8fd0531ae0be 145 char setRxAddress(char *address, char pipe);
epgmdm 0:8fd0531ae0be 146 char setRxAddress(long long address, char pipe);
nixonkj 6:77ead8abdd1c 147 char setRxMode();
epgmdm 0:8fd0531ae0be 148 char setTxAddress(char *address);
epgmdm 0:8fd0531ae0be 149 char setTxAddress(long long address);
nixonkj 6:77ead8abdd1c 150 char setTxMode();
nixonkj 8:3e027705ce23 151
nixonkj 8:3e027705ce23 152 /** Sets the timing and number of TX retries
nixonkj 8:3e027705ce23 153 *
nixonkj 8:3e027705ce23 154 * @param delay Auto Retransmit Delay: '0000' – Wait 250uS', '0001' – Wait 500uS, ..., '1111' – Wait 4000uS
nixonkj 8:3e027705ce23 155 * @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 156 * @returns
nixonkj 8:3e027705ce23 157 * 0 on success,
nixonkj 8:3e027705ce23 158 * non-zero on failure.
nixonkj 8:3e027705ce23 159 */
nixonkj 6:77ead8abdd1c 160 char setTxRetry(char delay, char numTries);
nixonkj 8:3e027705ce23 161
epgmdm 2:ca0a3c0bba70 162 void start();
nixonkj 8:3e027705ce23 163 char* statusString();
nixonkj 6:77ead8abdd1c 164 void writeReg(char address, char *data, char width);
nixonkj 6:77ead8abdd1c 165 void writeReg(char address, char data);
epgmdm 0:8fd0531ae0be 166
epgmdm 0:8fd0531ae0be 167 void scratch();
epgmdm 0:8fd0531ae0be 168
epgmdm 0:8fd0531ae0be 169
epgmdm 0:8fd0531ae0be 170 };