nrf24l01p.h

Go to the documentation of this file.

/*
 * Copyright (C) 2014 Hamburg University of Applied Sciences
 *
 * This file is subject to the terms and conditions of the GNU Lesser General
 * Public License v2.1. See the file LICENSE in the top level directory for more
 * details.
 */
 
#ifndef NRF24L01P_H
#define NRF24L01P_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
#include <stdio.h>
#include "periph/gpio.h"
#include "periph/spi.h"
 
typedef struct {
    spi_t spi;           
    gpio_t ce;           
    gpio_t cs;           
    gpio_t irq;          
    unsigned listener;   
} nrf24l01p_t;
 
typedef enum {
    NRF24L01P_AW_3BYTE, 
    NRF24L01P_AW_4BYTE, 
    NRF24L01P_AW_5BYTE  
} nrf24l01p_aw_t;
 
typedef enum {
    NRF24L01P_DR_250KBS,
    NRF24L01P_DR_1MBS,  
    NRF24L01P_DR_2MBS   
} nrf24l01p_dr_t;
 
typedef enum {
    NRF24L01P_PWR_N18DBM = 0,   
    NRF24L01P_PWR_N12DBM,       
    NRF24L01P_PWR_N6DBM,        
    NRF24L01P_PWR_0DBM          
} nrf24l01p_pwr_t;
 
typedef enum {
    NRF24L01P_PIPE0 = 0,
    NRF24L01P_PIPE1,    
    NRF24L01P_PIPE2,    
    NRF24L01P_PIPE3,    
    NRF24L01P_PIPE4,    
    NRF24L01P_PIPE5     
} nrf24l01p_rx_pipe_t;
 
typedef enum {
    NRF24L01P_CRC_1BYTE = 0,    
    NRF24L01P_CRC_2BYTE,        
} nrf24l01p_crc_t;
 
typedef enum {
    NRF24L01P_RETR_250US = 0,   
    NRF24L01P_RETR_500US,       
    NRF24L01P_RETR_750US,       
    NRF24L01P_RETR_1000US,      
    NRF24L01P_RETR_1250US,      
    NRF24L01P_RETR_1500US,      
    NRF24L01P_RETR_1750US,      
    NRF24L01P_RETR_2000US,      
    NRF24L01P_RETR_2250US,      
    NRF24L01P_RETR_2500US,      
    NRF24L01P_RETR_2750US,      
    NRF24L01P_RETR_3000US,      
    NRF24L01P_RETR_3250US,      
    NRF24L01P_RETR_3500US,      
    NRF24L01P_RETR_3750US,      
    NRF24L01P_RETR_4000US,      
} nrf24l01p_retransmit_delay_t;
 
typedef enum {
    RCV_PKT_NRF24L01P = 0,  
} nrf24l01p_rx_event_t ;
 
int nrf24l01p_read_reg(const nrf24l01p_t *dev, char reg, char *answer);
 
int nrf24l01p_write_reg(const nrf24l01p_t *dev, char reg, char write);
 
int nrf24l01p_init(nrf24l01p_t *dev, spi_t spi, gpio_t ce, gpio_t csn, gpio_t irq);
 
int nrf24l01p_on(const nrf24l01p_t *dev);
 
int nrf24l01p_off(const nrf24l01p_t *dev);
 
void nrf24l01p_transmit(const nrf24l01p_t *dev);
 
int nrf24l01p_read_payload(const nrf24l01p_t *dev, char *answer, unsigned int size);
 
void nrf24l01p_register(nrf24l01p_t *dev, unsigned int *pid);
 
int nrf24l01p_enable_dynamic_payload(const nrf24l01p_t *dev, nrf24l01p_rx_pipe_t pipe);
 
int nrf24l01p_enable_dynamic_ack(const nrf24l01p_t *dev);
 
int nrf24l01p_unregister(nrf24l01p_t *dev, unsigned int pid);
 
void nrf24l01p_get_id(const nrf24l01p_t *dev, unsigned int *pid);
 
void nrf24l01p_start(const nrf24l01p_t *dev);
 
void nrf24l01p_stop(const nrf24l01p_t *dev);
 
int nrf24l01p_preload(const nrf24l01p_t *dev, char *data, unsigned int size);
 
int nrf24l01p_set_channel(const nrf24l01p_t *dev, uint8_t chan);
 
int nrf24l01p_set_address_width(const nrf24l01p_t *dev, nrf24l01p_aw_t aw);
 
int nrf24l01p_set_payload_width(const nrf24l01p_t *dev,
                                nrf24l01p_rx_pipe_t pipe, uint8_t width);
 
int nrf24l01p_set_tx_address(const nrf24l01p_t *dev, const uint8_t *saddr, unsigned int length);
 
int nrf24l01p_set_tx_address_long(const nrf24l01p_t *dev, uint64_t saddr, unsigned int length);
 
int nrf24l01p_set_rx_address(const nrf24l01p_t *dev, nrf24l01p_rx_pipe_t pipe, const uint8_t *saddr, unsigned int length);
 
int nrf24l01p_set_rx_address_long(const nrf24l01p_t *dev, nrf24l01p_rx_pipe_t pipe, uint64_t saddr, unsigned int length);
 
uint64_t nrf24l01p_get_tx_address_long(const nrf24l01p_t *dev);
 
uint64_t nrf24l01p_get_rx_address_long(const nrf24l01p_t *dev, nrf24l01p_rx_pipe_t pipe);
 
int nrf24l01p_set_datarate(const nrf24l01p_t *dev, nrf24l01p_dr_t dr);
 
int nrf24l01p_get_status(const nrf24l01p_t *dev);
 
int nrf24l01p_set_power(const nrf24l01p_t *dev, int pwr);
 
int nrf24l01p_get_power(const nrf24l01p_t *dev);
 
int nrf24l01p_set_txmode(const nrf24l01p_t *dev);
 
int nrf24l01p_set_rxmode(const nrf24l01p_t *dev);
 
int nrf24l01p_reset_all_interrupts(const nrf24l01p_t *dev);
 
int nrf24l01p_reset_interrupts(const nrf24l01p_t *dev, char intrs);
 
int nrf24l01p_mask_interrupt(const nrf24l01p_t *dev, char intr);
 
int nrf24l01p_unmask_interrupt(const nrf24l01p_t *dev, char intr);
 
int nrf24l01p_enable_pipe(const nrf24l01p_t *dev, nrf24l01p_rx_pipe_t pipe);
 
int nrf24l01p_disable_pipe(const nrf24l01p_t *dev, nrf24l01p_rx_pipe_t pipe);
 
int nrf24l01p_disable_crc(const nrf24l01p_t *dev);
 
int nrf24l01p_enable_crc(const nrf24l01p_t *dev, nrf24l01p_crc_t crc);
 
int nrf24l01p_setup_auto_ack(const nrf24l01p_t *dev, nrf24l01p_rx_pipe_t pipe, nrf24l01p_retransmit_delay_t delay_retrans, char count_retrans);
 
int nrf24l01p_disable_all_auto_ack(const nrf24l01p_t *dev);
 
int nrf24l01p_flush_tx_fifo(const nrf24l01p_t *dev);
 
int nrf24l01p_flush_rx_fifo(const nrf24l01p_t *dev);
 
void nrf24l01p_rx_cb(void *arg);
 
#ifdef __cplusplus
}
#endif
 
#endif /* NRF24L01P_H */