Malcolm McCulloch / NRF2401P

This is a work in progress for an NRF2401P

Dependents:   NRF_receiver sender locker4 Weather_Station_Ofiicial ... more

About

This is a simple library to drive the nRF24l01+.

Hardware

This uses the commonly available breakout. The connections are shown below /media/uploads/epgmdm/nrf24l01pinout.png

Software

Use case: For a simple transmitter

tx code snipet

#include "NRF2401P.h"
int main() {
*
*  long long addr1=0xAB00CD; // setup address - any 5 byte number - same as RX
*  int channel =0x12;  // [0-126] setup channel, must be same as RX
*  bool txOK;
*  char msg[32];
*  char ackData[32];
*  char len;
*
*  // Setup 
*  NRF2401P nrf1(PTD6,PTD7, PTD5,PTD4, PTC12); //mosi, miso, sclk, csn, ce)
*  nrf1.quickTxSetup(channel, addr1); // sets nrf24l01+ as transmitter
*
*  // transmit
*  strcpy (msg, "Hello"); 
*  txOK= nrf1.transmitData(msg,strlen(msg));
*
*  // read ack data if available
*  if (nrf1.isAckData()) { 
*      len= nrf1.getRxData(ackData); // len is number of bytes in ackData
*   }
*}

Use case: For a simple receiver

rx code snipet

#include "NRF2401P.h"
*int main(){
*        
*  long long addr1=0xAB00CD; // setup address - any 5 byte number - same as TX
*  int channel =0x12;  // [0-126] setup channel, must be same as TX
*  bool txOK;
*  char msg[32];
*  char ackData[32];
*  char len;
*
*  // Setup 
*  NRF2401P nrf1(PTD6,PTD7, PTD5,PTD4, PTC12); //mosi, miso, sclk, csn, ce)
*  nrf1.quickRxSetup(channel, addr1); // sets nrf24l01+ as  receiver, using pipe 1
*
*  // set ack data
*  sprintf(ackData,"Ack data");
*  nrf1.acknowledgeData(ackData, strlen(ackData),1); // ack for pipe 1
*    
*  // receive
*  while (! nrf1.isRxData()); // note this blocks until RX data
*  len= nrf1.getRxData(msg); // gets the message, len is length of msg
*
*}

Diff: NRF2401P.h

Revision:
20:e61edde5680d
Parent:
18:220df99d2d41
--- a/NRF2401P.h	Fri Feb 19 14:03:31 2016 +0000
+++ b/NRF2401P.h	Thu Feb 25 09:44:11 2016 +0000
@@ -107,7 +107,7 @@
      */
     NRF2401P (PinName mosi, PinName miso, PinName sclk, PinName _csn, PinName _ce);
 
-    char acknowledgeData(char *data, char width, char pipe);
+    void acknowledgeData(char *data, char width, char pipe);
     char checkStatus();
     void clearStatus();
     void flushRx();
@@ -143,12 +143,12 @@
     void quickTxSetup(int channel,long long addr);
     void readReg(char address, char *data);
     void readReg(char address, char *data, char width);
-    char testReceive();
-    char testTransmit();
+    void testReceive();
+    void testTransmit();
     char transmitData( char *data, char width );
-    char retransmitData( );
+    void retransmitData( );
 
-    char setAddressWidth(char width);
+    void setAddressWidth(char width);
     
     /**  Sets the frequency channel nRF24L01+ operates on
      *
@@ -157,11 +157,11 @@
      *   0 on success,
      *   non-zero on failure.
      */    
-    char setChannel(char chan);
+    void setChannel(char chan);
     
     void setDynamicPayload();
-    char setPwrUp();
-    char setPwrDown();
+    void setPwrUp();
+    void setPwrDown();
     
     /**  Set RF data rate and RF output power in TX mode
      *
@@ -171,14 +171,14 @@
      *   0 on success,
      *   non-zero on failure.
      */
-    char setRadio(char speed, char power);
+    void setRadio(char speed, char power);
     
-    char setRxAddress(char *address, char pipe);
-    char setRxAddress(long long address, char pipe);
-    char setRxMode();
-    char setTxAddress(char *address);
-    char setTxAddress(long long address);
-    char setTxMode();
+    void setRxAddress(char *address, char pipe);
+    void setRxAddress(long long address, char pipe);
+    void setRxMode();
+    void setTxAddress(char *address);
+    void setTxAddress(long long address);
+    void setTxMode();
     
     /** Sets the timing and number of TX retries
      *
@@ -188,7 +188,7 @@
      *   0 on success,
      *   non-zero on failure.
      */    
-    char setTxRetry(char delay, char numTries);
+    void setTxRetry(char delay, char numTries);
     
     void start();
     char* statusString();