NRF24L01 Class Reference

C++ API for NRF24l01 transceiver module. More...

Detailed Description

• ID: nrf24l01
• Name: nrf24l01 transceiver library
• Category: wifi
• Manufacturer: seeed
• Link: http://www.seeedstudio.com/depot/nRF24L01Module-p-1394.html
• Connection: spi

This file defines the NRF24l01 C++ interface for libnrf24l01

void nrf_handler () {
    std::cout << "Reciever :: " << *((uint32_t *)&(comm->m_rxBuffer[0])) << std::endl;
}

int
main(int argc, char **argv)
{

    comm = new upm::NRF24L01(7, 8);
    comm->setSourceAddress ((uint8_t *) local_address);
    comm->setDestinationAddress ((uint8_t *) broadcast_address);
    comm->setPayload (MAX_BUFFER);
    comm->configure ();
    comm->setSpeedRate (upm::NRF_250KBPS);
    comm->setChannel (99);
    comm->dataRecievedHandler = nrf_handler;

    signal(SIGINT, sig_handler);

    while (!running) {
        comm->pollListener ();
    }

    std::cout << "exiting application" << std::endl;

    delete comm;
    return 0;
}

    uint32_t dummyData = 0;
    comm = new upm::NRF24L01(7, 8);
    comm->setSourceAddress ((uint8_t *) srcAddress);
    comm->setDestinationAddress ((uint8_t *) destAddress);
    comm->setPayload (MAX_BUFFER);
    comm->setChannel (99);
    comm->configure ();
    comm->dataRecievedHandler = nrf_handler;

    signal(SIGINT, sig_handler);

    while (!running) {
        memcpy (comm->m_txBuffer, &dummyData, sizeof (dummyData));
        comm->send ();
        std::cout << "devi2 :: sending data ...." << dummyData << std::endl;
        usleep (3000000);
        dummyData += 3000;
    }

    std::cout << "exiting application" << std::endl;

    delete comm;

    sensor = new upm::NRF24L01(7, 8);
    sensor->setBeaconingMode ();

    std::vector<std::string> msgs;

    msgs.push_back ("Hello World 1!!!");
    msgs.push_back ("Hello World 2!!!");
    msgs.push_back ("Hello World 3!!!");
    msgs.push_back ("Hello World 4!!!");
    msgs.push_back ("Hello World 5!!!");

    signal(SIGINT, sig_handler);

    while (!running) {
        for (std::vector<std::string>::iterator item = msgs.begin(); item != msgs.end(); ++item) {
            std::cout << "BROADCASTING " << (*item).c_str() << std::endl;

            for (int i = 0; i < 3; i++) {
                sensor->sendBeaconingMsg ((uint8_t*) (*item).c_str());
                usleep (1000000);
            }
        }
    }

    std::cout << "exiting application" << std::endl;

    msgs.clear();
    delete sensor;

Public Member Functions
	NRF24L01 (uint8_t cs, uint8_t ce)
	~NRF24L01 ()
std::string	name ()
void	init (uint8_t chipSelect, uint8_t chipEnable)
void	configure ()
void	send (uint8_t *value)
void	send ()
void	setSourceAddress (uint8_t *addr)
void	setDestinationAddress (uint8_t *addr)
void	setBroadcastAddress (uint8_t *addr)
void	setPayload (uint8_t load)
bool	dataReady ()
bool	dataSending ()
void	getData (uint8_t *data)
uint8_t	getStatus ()
bool	rxFifoEmpty ()
void	rxPowerUp ()
void	rxFlushBuffer ()
void	txPowerUp ()
void	powerDown ()
void	setChannel (uint8_t channel)
void	setPower (power_t power)
uint8_t	setSpeedRate (speed_rate_t rate)
void	txFlushBuffer ()
void	pollListener ()
mraa_result_t	ceHigh ()
mraa_result_t	ceLow ()
mraa_result_t	csOn ()
mraa_result_t	csOff ()
void	setBeaconingMode ()
void	sendBeaconingMsg (uint8_t *msg)

Data Fields
uint8_t	m_rxBuffer [MAX_BUFFER]
uint8_t	m_txBuffer [MAX_BUFFER]
uint8_t	m_bleBuffer [32]
funcPtrVoidVoid	dataRecievedHandler

Constructor & Destructor Documentation

NRF24L01	(	uint8_t	cs,
		uint8_t	ce
	)

Instanciates a NRF24l01 object

Parameters

cs	chip select pin

Here is the call graph for this function:

~NRF24L01

(

)

NRF24l01 object destructor

Member Function Documentation

std::string name ( )

inline

Return name of the component

void init	(	uint8_t	chipSelect,
		uint8_t	chipEnable
	)

Initialize needed Gpio pins and SPI interface

Parameters

chipSelect	setting up the chip select pin
chipEnable	setting up the chip enable pin

Here is the call graph for this function:

Here is the caller graph for this function:

void configure

(

)

Configure NRF24l01 chip

Here is the call graph for this function:

void send

(

uint8_t *

value

)

Send the buffer data

Parameters

*value

pointer to the buffer

Here is the call graph for this function:

void send

(

)

Send the data located in inner bufer, user must fill the m_txBuffer buffer

void setSourceAddress

(

uint8_t *

addr

)

Set recieving address of the device

Parameters

addr	5 bytes addres

Here is the call graph for this function:

void setDestinationAddress

(

uint8_t *

addr

)

Set recipient address. nrfSend method will send the data buffer to this address

Parameters

addr	5 bytes addres

void setBroadcastAddress

(

uint8_t *

addr

)

Set broadcasting address.

Parameters

addr	5 bytes addres

void setPayload

(

uint8_t

load

)

Set payload size.

Parameters

load	size of the payload (MAX 32)

bool dataReady

(

)

Check if data arrived

Here is the call graph for this function:

Here is the caller graph for this function:

bool dataSending

(

)

Check if chip in sending mode

Here is the call graph for this function:

Here is the caller graph for this function:

void getData

(

uint8_t *

data

)

Sink all arrived data into the provided buffer

Parameters

load	size of the payload (MAX 32)

Here is the call graph for this function:

Here is the caller graph for this function:

uint8_t getStatus

(

)

Check the chip state

Here is the caller graph for this function:

bool rxFifoEmpty

(

)

Check if recieving stack is empty

Here is the caller graph for this function:

void rxPowerUp

(

)

Power up reciever

Here is the call graph for this function:

Here is the caller graph for this function:

void rxFlushBuffer

(

)

Flush reciver stack

Here is the caller graph for this function:

void txPowerUp

(

)

Power up transmitter

Here is the caller graph for this function:

void powerDown

(

)

Power down all

Here is the call graph for this function:

void txFlushBuffer

(

)

Flush transmit stack

Here is the caller graph for this function:

void pollListener

(

)

Pulling method which listenning for arrived data, if data arrived dataRecievedHandler will be triggered

Here is the call graph for this function:

mraa_result_t ceHigh

(

)

Set chip enable pin HIGH

Here is the caller graph for this function:

mraa_result_t ceLow

(

)

Set chip enable LOW

Here is the caller graph for this function:

mraa_result_t csOn

(

)

Set chip select pin LOW

Here is the caller graph for this function:

mraa_result_t csOff

(

)

Set chip select pin HIGH

Here is the caller graph for this function:

void setBeaconingMode

(

)

Configure nRF24l01 module to behave as BLE (Bluetooth Low Energy) beaconing devcie.

void sendBeaconingMsg

(

uint8_t *

msg

)

Beaconing the provided message to BLE scanners.

Parameters

msg	beacon the provated message (max length is 16 bytes)

Here is the call graph for this function:

Field Documentation

uint8_t m_rxBuffer[MAX_BUFFER]

Reciver buffer

uint8_t m_txBuffer[MAX_BUFFER]

Transmit buffer

uint8_t m_bleBuffer[32]

BLE buffer

funcPtrVoidVoid dataRecievedHandler

Data arrived handler

---

The documentation for this class was generated from the following files:

• /var/lib/jenkins/workspace/upm-doc-stable/src/nrf24l01/nrf24l01.h
• /var/lib/jenkins/workspace/upm-doc-stable/src/nrf24l01/nrf24l01.cxx