driver_nrf24l01.h

Go to the documentation of this file.

 
#ifndef DRIVER_NRF24L01_H
#define DRIVER_NRF24L01_H
 
#include <stdio.h>
#include <stdint.h>
#include <string.h>
 
#ifdef __cplusplus
extern "C"{
#endif
 
typedef enum
{
    NRF24L01_BOOL_FALSE = 0x00,        
    NRF24L01_BOOL_TRUE  = 0x01,        
} nrf24l01_bool_t;
 
typedef enum
{
    NRF24L01_CONFIG_MASK_RX_DR  = 6,        
    NRF24L01_CONFIG_MASK_TX_DS  = 5,        
    NRF24L01_CONFIG_MASK_MAX_RT = 4,        
    NRF24L01_CONFIG_EN_CRC      = 3,        
    NRF24L01_CONFIG_CRCO        = 2,        
    NRF24L01_CONFIG_PWR_UP      = 1,        
} nrf24l01_config_t;
 
typedef enum
{
    NRF24L01_MODE_TX = 0x00,        
    NRF24L01_MODE_RX = 0x01,        
} nrf24l01_mode_t;
 
typedef enum
{
    NRF24L01_PIPE_0 = 0,        
    NRF24L01_PIPE_1 = 1,        
    NRF24L01_PIPE_2 = 2,        
    NRF24L01_PIPE_3 = 3,        
    NRF24L01_PIPE_4 = 4,        
    NRF24L01_PIPE_5 = 5,        
} nrf24l01_pipe_t;
 
typedef enum
{
    NRF24L01_ADDRESS_WIDTH_ILLEGAL = 0,       
    NRF24L01_ADDRESS_WIDTH_3_BYTES = 1,       
    NRF24L01_ADDRESS_WIDTH_4_BYTES = 2,       
    NRF24L01_ADDRESS_WIDTH_5_BYTES = 3,       
} nrf24l01_address_width_t;
 
typedef enum
{
    NRF24L01_DATA_RATE_1M   = 0,        
    NRF24L01_DATA_RATE_2M   = 1,        
    NRF24L01_DATA_RATE_250K = 2,        
} nrf24l01_data_rate_t;
 
typedef enum
{
    NRF24L01_OUTPUT_POWER_NEGATIVE_18_DBM = 0,        
    NRF24L01_OUTPUT_POWER_NEGATIVE_12_DBM = 1,        
    NRF24L01_OUTPUT_POWER_NEGATIVE_6_DBM  = 2,        
    NRF24L01_OUTPUT_POWER_0_DBM          = 3,         
} nrf24l01_output_power_t;
 
typedef enum
{
    NRF24L01_INTERRUPT_RX_DR   = 6,        
    NRF24L01_INTERRUPT_TX_DS   = 5,        
    NRF24L01_INTERRUPT_MAX_RT  = 4,        
    NRF24L01_INTERRUPT_TX_FULL = 0,        
} nrf24l01_interrupt_t;
 
typedef enum
{
    NRF24L01_FIFO_STATUS_TX_REUSE = 6,        
    NRF24L01_FIFO_STATUS_TX_FULL  = 5,        
    NRF24L01_FIFO_STATUS_TX_EMPTY = 4,        
    NRF24L01_FIFO_STATUS_RX_FULL  = 1,        
    NRF24L01_FIFO_STATUS_RX_EMPTY = 0,        
} nrf24l01_fifo_status_t;
 
typedef struct nrf24l01_handle_s
{
    uint8_t (*gpio_init)(void);                                                            
    uint8_t (*gpio_deinit)(void);                                                          
    uint8_t (*gpio_write)(uint8_t value);                                                  
    uint8_t (*spi_init)(void);                                                             
    uint8_t (*spi_deinit)(void);                                                           
    uint8_t (*spi_read)(uint8_t reg, uint8_t *buf, uint16_t len);                          
    uint8_t (*spi_write)(uint8_t reg, uint8_t *buf, uint16_t len);                         
    void (*delay_ms)(uint32_t ms);                                                         
    void (*debug_print)(const char *const fmt, ...);                                       
    void (*receive_callback)(uint8_t type, uint8_t num, uint8_t *buf, uint8_t len);        
    uint8_t inited;                                                                        
    uint8_t finished;                                                                      
} nrf24l01_handle_t;
 
typedef struct nrf24l01_info_s
{
    char chip_name[32];                
    char manufacturer_name[32];        
    char interface[8];                 
    float supply_voltage_min_v;        
    float supply_voltage_max_v;        
    float max_current_ma;              
    float temperature_min;             
    float temperature_max;             
    uint32_t driver_version;           
} nrf24l01_info_t;
 
#define DRIVER_NRF24L01_LINK_INIT(HANDLE, STRUCTURE)         memset(HANDLE, 0, sizeof(STRUCTURE))
 
#define DRIVER_NRF24L01_LINK_SPI_INIT(HANDLE, FUC)          (HANDLE)->spi_init = FUC
 
#define DRIVER_NRF24L01_LINK_SPI_DEINIT(HANDLE, FUC)        (HANDLE)->spi_deinit = FUC
 
#define DRIVER_NRF24L01_LINK_SPI_READ(HANDLE, FUC)          (HANDLE)->spi_read = FUC
 
#define DRIVER_NRF24L01_LINK_SPI_WRITE(HANDLE, FUC)         (HANDLE)->spi_write = FUC
 
#define DRIVER_NRF24L01_LINK_GPIO_INIT(HANDLE, FUC)         (HANDLE)->gpio_init = FUC
 
#define DRIVER_NRF24L01_LINK_GPIO_DEINIT(HANDLE, FUC)       (HANDLE)->gpio_deinit = FUC
 
#define DRIVER_NRF24L01_LINK_GPIO_WRITE(HANDLE, FUC)        (HANDLE)->gpio_write = FUC
 
#define DRIVER_NRF24L01_LINK_DELAY_MS(HANDLE, FUC)          (HANDLE)->delay_ms = FUC
 
#define DRIVER_NRF24L01_LINK_DEBUG_PRINT(HANDLE, FUC)       (HANDLE)->debug_print = FUC
 
#define DRIVER_NRF24L01_LINK_RECEIVE_CALLBACK(HANDLE, FUC)  (HANDLE)->receive_callback = FUC
 
uint8_t nrf24l01_info(nrf24l01_info_t *info);
 
uint8_t nrf24l01_irq_handler(nrf24l01_handle_t *handle);
 
uint8_t nrf24l01_init(nrf24l01_handle_t *handle);
 
uint8_t nrf24l01_deinit(nrf24l01_handle_t *handle);
 
uint8_t nrf24l01_send(nrf24l01_handle_t *handle, uint8_t *buf, uint8_t len);
 
uint8_t nrf24l01_set_active(nrf24l01_handle_t *handle, nrf24l01_bool_t enable);
 
uint8_t nrf24l01_set_config(nrf24l01_handle_t *handle, nrf24l01_config_t config, nrf24l01_bool_t enable);
 
uint8_t nrf24l01_get_config(nrf24l01_handle_t *handle, nrf24l01_config_t config, nrf24l01_bool_t *enable);
 
uint8_t nrf24l01_set_mode(nrf24l01_handle_t *handle, nrf24l01_mode_t mode);
 
uint8_t nrf24l01_get_mode(nrf24l01_handle_t *handle, nrf24l01_mode_t *mode);
 
uint8_t nrf24l01_set_auto_acknowledgment(nrf24l01_handle_t *handle, nrf24l01_pipe_t pipe, nrf24l01_bool_t enable);
 
uint8_t nrf24l01_get_auto_acknowledgment(nrf24l01_handle_t *handle, nrf24l01_pipe_t pipe, nrf24l01_bool_t *enable);
 
uint8_t nrf24l01_set_rx_pipe(nrf24l01_handle_t *handle, nrf24l01_pipe_t pipe, nrf24l01_bool_t enable);
 
uint8_t nrf24l01_get_rx_pipe(nrf24l01_handle_t *handle, nrf24l01_pipe_t pipe, nrf24l01_bool_t *enable);
 
uint8_t nrf24l01_set_address_width(nrf24l01_handle_t *handle, nrf24l01_address_width_t width);
 
uint8_t nrf24l01_get_address_width(nrf24l01_handle_t *handle, nrf24l01_address_width_t *width);
 
uint8_t nrf24l01_set_auto_retransmit_delay(nrf24l01_handle_t *handle, uint8_t delay);
 
uint8_t nrf24l01_get_auto_retransmit_delay(nrf24l01_handle_t *handle, uint8_t *delay);
 
uint8_t nrf24l01_auto_retransmit_delay_convert_to_register(nrf24l01_handle_t *handle, uint32_t us, uint8_t *reg);
 
uint8_t nrf24l01_auto_retransmit_delay_convert_to_data(nrf24l01_handle_t *handle, uint8_t reg, uint32_t *us);
 
uint8_t nrf24l01_set_auto_retransmit_count(nrf24l01_handle_t *handle, uint8_t count);
 
uint8_t nrf24l01_get_auto_retransmit_count(nrf24l01_handle_t *handle, uint8_t *count);
 
uint8_t nrf24l01_set_channel_frequency(nrf24l01_handle_t *handle, uint8_t freq);
 
uint8_t nrf24l01_get_channel_frequency(nrf24l01_handle_t *handle, uint8_t *freq);
 
uint8_t nrf24l01_set_continuous_carrier_transmit(nrf24l01_handle_t *handle, nrf24l01_bool_t enable);
 
uint8_t nrf24l01_get_continuous_carrier_transmit(nrf24l01_handle_t *handle, nrf24l01_bool_t *enable);
 
uint8_t nrf24l01_set_force_pll_lock_signal(nrf24l01_handle_t *handle, nrf24l01_bool_t enable);
 
uint8_t nrf24l01_get_force_pll_lock_signal(nrf24l01_handle_t *handle, nrf24l01_bool_t *enable);
 
uint8_t nrf24l01_set_data_rate(nrf24l01_handle_t *handle, nrf24l01_data_rate_t rate);
 
uint8_t nrf24l01_get_data_rate(nrf24l01_handle_t *handle, nrf24l01_data_rate_t *rate);
 
uint8_t nrf24l01_set_output_power(nrf24l01_handle_t *handle, nrf24l01_output_power_t power);
 
uint8_t nrf24l01_get_output_power(nrf24l01_handle_t *handle, nrf24l01_output_power_t *power);
 
uint8_t nrf24l01_get_interrupt(nrf24l01_handle_t *handle, nrf24l01_interrupt_t type, nrf24l01_bool_t *enable);
 
uint8_t nrf24l01_clear_interrupt(nrf24l01_handle_t *handle, nrf24l01_interrupt_t type);
 
uint8_t nrf24l01_get_data_pipe_number(nrf24l01_handle_t *handle, uint8_t *number);
 
uint8_t nrf24l01_get_lost_packet_count(nrf24l01_handle_t *handle, uint8_t *count);
 
uint8_t nrf24l01_get_retransmitted_packet_count(nrf24l01_handle_t *handle, uint8_t *count);
 
uint8_t nrf24l01_get_received_power_detector(nrf24l01_handle_t *handle, nrf24l01_bool_t *enable);
 
uint8_t nrf24l01_set_rx_pipe_0_address(nrf24l01_handle_t *handle, uint8_t *addr, uint8_t len);
 
uint8_t nrf24l01_get_rx_pipe_0_address(nrf24l01_handle_t *handle, uint8_t *addr, uint8_t *len);
 
uint8_t nrf24l01_set_rx_pipe_1_address(nrf24l01_handle_t *handle, uint8_t *addr, uint8_t len);
 
uint8_t nrf24l01_get_rx_pipe_1_address(nrf24l01_handle_t *handle, uint8_t *addr, uint8_t *len);
 
uint8_t nrf24l01_set_rx_pipe_2_address(nrf24l01_handle_t *handle, uint8_t addr);
 
uint8_t nrf24l01_get_rx_pipe_2_address(nrf24l01_handle_t *handle, uint8_t *addr);
 
uint8_t nrf24l01_set_rx_pipe_3_address(nrf24l01_handle_t *handle, uint8_t addr);
 
uint8_t nrf24l01_get_rx_pipe_3_address(nrf24l01_handle_t *handle, uint8_t *addr);
 
uint8_t nrf24l01_set_rx_pipe_4_address(nrf24l01_handle_t *handle, uint8_t addr);
 
uint8_t nrf24l01_get_rx_pipe_4_address(nrf24l01_handle_t *handle, uint8_t *addr);
 
uint8_t nrf24l01_set_rx_pipe_5_address(nrf24l01_handle_t *handle, uint8_t addr);
 
uint8_t nrf24l01_get_rx_pipe_5_address(nrf24l01_handle_t *handle, uint8_t *addr);
 
uint8_t nrf24l01_set_tx_address(nrf24l01_handle_t *handle, uint8_t *addr, uint8_t len);
 
uint8_t nrf24l01_get_tx_address(nrf24l01_handle_t *handle, uint8_t *addr, uint8_t *len);
 
uint8_t nrf24l01_set_pipe_0_payload_number(nrf24l01_handle_t *handle, uint8_t num);
 
uint8_t nrf24l01_get_pipe_0_payload_number(nrf24l01_handle_t *handle, uint8_t *num);
 
uint8_t nrf24l01_set_pipe_1_payload_number(nrf24l01_handle_t *handle, uint8_t num);
 
uint8_t nrf24l01_get_pipe_1_payload_number(nrf24l01_handle_t *handle, uint8_t *num);
 
uint8_t nrf24l01_set_pipe_2_payload_number(nrf24l01_handle_t *handle, uint8_t num);
 
uint8_t nrf24l01_get_pipe_2_payload_number(nrf24l01_handle_t *handle, uint8_t *num);
 
uint8_t nrf24l01_set_pipe_3_payload_number(nrf24l01_handle_t *handle, uint8_t num);
 
uint8_t nrf24l01_get_pipe_3_payload_number(nrf24l01_handle_t *handle, uint8_t *num);
 
uint8_t nrf24l01_set_pipe_4_payload_number(nrf24l01_handle_t *handle, uint8_t num);
 
uint8_t nrf24l01_get_pipe_4_payload_number(nrf24l01_handle_t *handle, uint8_t *num);
 
uint8_t nrf24l01_set_pipe_5_payload_number(nrf24l01_handle_t *handle, uint8_t num);
 
uint8_t nrf24l01_get_pipe_5_payload_number(nrf24l01_handle_t *handle, uint8_t *num);
 
uint8_t nrf24l01_get_fifo_status(nrf24l01_handle_t *handle, uint8_t *status);
 
uint8_t nrf24l01_set_pipe_dynamic_payload(nrf24l01_handle_t *handle, nrf24l01_pipe_t pipe, nrf24l01_bool_t enable);
 
uint8_t nrf24l01_get_pipe_dynamic_payload(nrf24l01_handle_t *handle, nrf24l01_pipe_t pipe, nrf24l01_bool_t *enable);
 
uint8_t nrf24l01_set_dynamic_payload(nrf24l01_handle_t *handle, nrf24l01_bool_t enable);
 
uint8_t nrf24l01_get_dynamic_payload(nrf24l01_handle_t *handle, nrf24l01_bool_t *enable);
 
uint8_t nrf24l01_set_payload_with_ack(nrf24l01_handle_t *handle, nrf24l01_bool_t enable);
 
uint8_t nrf24l01_get_payload_with_ack(nrf24l01_handle_t *handle, nrf24l01_bool_t *enable);
 
uint8_t nrf24l01_set_tx_payload_with_no_ack(nrf24l01_handle_t *handle, nrf24l01_bool_t enable);
 
uint8_t nrf24l01_get_tx_payload_with_no_ack(nrf24l01_handle_t *handle, nrf24l01_bool_t *enable);
 
uint8_t nrf24l01_read_rx_payload(nrf24l01_handle_t *handle, uint8_t *buf, uint8_t len);
 
uint8_t nrf24l01_write_tx_payload(nrf24l01_handle_t *handle, uint8_t *buf, uint8_t len);
 
uint8_t nrf24l01_flush_tx(nrf24l01_handle_t *handle);
 
uint8_t nrf24l01_flush_rx(nrf24l01_handle_t *handle);
 
uint8_t nrf24l01_reuse_tx_payload(nrf24l01_handle_t *handle);
 
uint8_t nrf24l01_get_rx_payload_width(nrf24l01_handle_t *handle, uint8_t *width);
 
uint8_t nrf24l01_write_payload_with_ack(nrf24l01_handle_t *handle, nrf24l01_pipe_t pipe, uint8_t *buf, uint8_t len);
 
uint8_t nrf24l01_write_payload_with_no_ack(nrf24l01_handle_t *handle, uint8_t *buf, uint8_t len);
 
uint8_t nrf24l01_nop(nrf24l01_handle_t *handle);
 
uint8_t nrf24l01_set_reg(nrf24l01_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len);
 
uint8_t nrf24l01_get_reg(nrf24l01_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len);
 
#ifdef __cplusplus
}
#endif
 
#endif