nrf24L01Plus.h

Go to the documentation of this file.

/*
 *     SocialLedge.com - Copyright (C) 2013
 *
 *     This file is part of free software framework for embedded processors.
 *     You can use it and/or distribute it as long as this copyright header
 *     remains unmodified.  The code is free for personal use and requires
 *     permission to use in a commercial product.
 *
 *      THIS SOFTWARE IS PROVIDED "AS IS".  NO WARRANTIES, WHETHER EXPRESS, IMPLIED
 *      OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF
 *      MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE.
 *      I SHALL NOT, IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL, OR
 *      CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER.
 *
 *     You can reach the author of this software at :
 *          p r e e t . w i k i @ g m a i l . c o m
 */

#ifndef NRF24L01PLUS_H_
#define NRF24L01PLUS_H_
#ifdef __cplusplus
extern "C" {
#endif

#include <stdbool.h>
#include "utilities.h"   // delay_us()
#include "bio.h"         // board_io* functions
#include "ssp0.h"        // SPI Bus functions



#define NORDIC_EXCHANGE_SPI(byte)               ssp0_exchange_byte(byte)
#define NORDIC_EXCHANGE_MULTI_BYTE(ptr, len)    ssp0_exchange_data(ptr, len)

#define NORDIC_LOCK_SPI()
#define NORDIC_UNLOCK_SPI()
#define NORDIC_DELAY_US(us)         delay_us(us)
#define NORDIC_CS_ENABLE()          board_io_nordic_cs()
#define NORDIC_CS_DISABLE()         board_io_nordic_ds()
#define NORDIC_CE_HIGH()            board_io_nordic_ce_high()
#define NORDIC_CE_LOW()             board_io_nordic_ce_low()
#define NORDIC_INT_SIGNAL()         (!board_io_nordic_irq_sig()) /* Signal is active low */



void nordic_init(unsigned char payload, unsigned short mhz, unsigned short bitrate_kbps);

bool nordic_is_air_free();

static inline bool nordic_intr_signal() { return NORDIC_INT_SIGNAL(); }

/* ******************************************************************************************************* */
/* ******************************         Nordic Modes of Operations       ******************************* */
/* ******************************************************************************************************* */

void nordic_rx_to_Stanby1();

void nordic_standby1_to_rx();

void nordic_standby1_to_tx_mode1();

void nordic_standby1_to_tx_mode2();

void nordic_tx_mode2_to_standby1_through_power_down();





/* ******************************************************************************************************* */
/* *****************************        Nordic Transmission functions       ****************************** */
/* ******************************************************************************************************* */

bool nordic_is_tx_fifo_full();

bool nordic_is_tx_fifo_empty();

void nordic_clear_all_intr_flags();

void nordic_queue_tx_fifo(char *data, unsigned short length);

void nordic_mode1_send_single_packet(char *data, unsigned short length);

bool nordic_is_packet_sent();

void nordic_clear_packet_sent_flag();

bool nordic_is_max_retries_reached();

void nordic_clear_max_retries_flag();

void nordic_flush_tx_fifo();



/* ******************************************************************************************************* */
/* ******************************         Nordic Receive functions         ******************************* */
/* ******************************************************************************************************* */

bool nordic_is_packet_available();

void nordic_clear_packet_available_flag();

char nordic_read_rx_fifo(char *data, unsigned short length);

void nordic_flush_rx_fifo();







/* ******************************************************************************************************* */
/* *****************************       Nordic Configuration Functions       ****************************** */
/* ******************************************************************************************************* */

void nordic_set_intr_signals(bool rx, bool tx, bool maxTransmissions);

char nordic_get_intr_reg_status(void);

void nordic_set_crc(unsigned char length);

void nordic_power_up();

void nordic_power_down();

void nordic_set_channel(unsigned short MHz);

void nordic_set_continous_carrier_transmit(bool enable);

void nordic_set_air_data_rate(unsigned short kbps);

void nordic_set_power_level(unsigned char powerLevel);





/* ******************************************************************************************************* */
/* *************************        Nordic Enhanced Shockburst functions        ************************** */
/* ******************************************************************************************************* */

void nordic_set_auto_transmit_options(unsigned short txDelayUs, unsigned char retries);

char nordic_get_lost_packet_cnt(bool clear);

char nordic_get_retransmit_count();




/* ******************************************************************************************************* */
/* *************************         Nordic Pipes & Addresses functions         ************************** */
/* ******************************************************************************************************* */

void nordic_set_payload_for_pipe(unsigned char pipeNumber, unsigned char payload);

void nordic_set_addr_width(unsigned short width);

void nordic_set_tx_address(char* address, unsigned short length);

void nordic_set_rx_pipe0_addr(char* address, unsigned short length);

void nordic_set_rx_pipe1_addr(char* address, unsigned short length);


void nordic_set_rx_pipe2_lsb_addr(char address);
void nordic_set_rx_pipe3_lsb_addr(char address);
void nordic_set_rx_pipe4_lsb_addr(char address);
void nordic_set_rx_pipe5_lsb_addr(char address);

void nordic_set_auto_ack_for_pipes(bool pipe0, bool pipe1, bool pipe2, bool pipe3, bool pipe4, bool pipe5);

void nordic_enable_pipes(bool pipe0, bool pipe1, bool pipe2, bool pipe3, bool pipe4, bool pipe5);





#ifdef __cplusplus
}
#endif

#endif /* NRF24L01PLUS_H_ */