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:
9:c21b80aaf250
Parent:
8:3e027705ce23
Child:
10:8a217441c38e
--- a/NRF2401P.h	Sun Jul 05 23:33:37 2015 +0000
+++ b/NRF2401P.h	Sat Jul 11 09:38:59 2015 +0000
@@ -23,6 +23,9 @@
  * THE SOFTWARE.
  * @file "NRF2401P.h"
  */
+
+#ifndef MBED_NRF2401P_H
+#define MBED_NRF2401P_H
  
 /** \brief A library to drive the nRF24l01+
 * 
@@ -79,6 +82,7 @@
 *}
 *@endcode
 */
+
 class NRF2401P
 {
 public:
@@ -93,6 +97,14 @@
     bool dynamic,debug;
     Serial *pc;
 
+    /** Create a radio device for communicating with the RF24L01P via SPI.
+     *
+     * @param mosi The SPI slave data input pin.
+     * @param miso The SPI Slave Data Output (with tri-state option).
+     * @param sclk The SPI clock pin.
+     * @param _csn The SPI chip select pin.
+     * @param _ce Chip Enable pin (Activates RX or TX mode).
+     */
     NRF2401P (PinName mosi, PinName miso, PinName sclk, PinName _csn, PinName _ce);
 
     char acknowledgeData(char *data, char width, char pipe);
@@ -161,10 +173,18 @@
     
     void start();
     char* statusString();
+    
+    /** Print details about the radio setup and configuration
+     *
+     *  (Need to add ability to print address configurations
+     */    
+    void printDetails();
+
     void writeReg(char address, char *data, char width);
     void writeReg(char address, char data);
 
     void scratch();
 
 
-};
\ No newline at end of file
+};
+#endif
\ No newline at end of file