nRF905.h

Go to the documentation of this file.

/*
 * Project: nRF905 AVR/Arduino Library/Driver
 * Author: Zak Kemble, contact@zakkemble.co.uk
 * Copyright: (C) 2017 by Zak Kemble
 * License: GNU GPL v3 (see License.txt)
 * Web: http://blog.zakkemble.co.uk/nrf905-avrarduino-librarydriver/
 */

#ifndef NRF905_H_
#define NRF905_H_

#ifdef ARDUINO
#include <Arduino.h>
#endif

#include <stdint.h>

#include "nRF905_config.h"

typedef enum
{
    NRF905_NEXTMODE_STANDBY, 
    NRF905_NEXTMODE_RX, 
    NRF905_NEXTMODE_TX 
} nRF905_nextmode_t;

typedef enum
{
// NOTE:
// When using NRF905_BAND_868 and NRF905_BAND_915 for calculating channel (NRF905_CALC_CHANNEL(f, b)) they should be value 0x01,
// but when using them for setting registers their value should be 0x02.
// They're defined as 0x02 here so when used for calculating channel they're right shifted by 1

    NRF905_BAND_433 = 0x00, 
    NRF905_BAND_868 = 0x02, 
    NRF905_BAND_915 = 0x02  
} nRF905_band_t;

typedef enum
{
    NRF905_PWR_n10 = 0x00,  
    NRF905_PWR_n2 = 0x04,   
    NRF905_PWR_6 = 0x08,    
    NRF905_PWR_10 = 0x0C    
} nRF905_pwr_t;

typedef enum
{
    NRF905_LOW_RX_DISABLE = 0x00,   
    NRF905_LOW_RX_ENABLE = 0x10     
} nRF905_low_rx_t;

typedef enum
{
    NRF905_AUTO_RETRAN_DISABLE = 0x00,  
    NRF905_AUTO_RETRAN_ENABLE = 0x20    
} nRF905_auto_retran_t;

typedef enum
{
    NRF905_OUTCLK_DISABLE = 0x00,   
    NRF905_OUTCLK_4MHZ = 0x04,      
    NRF905_OUTCLK_2MHZ = 0x05,      
    NRF905_OUTCLK_1MHZ = 0x06,      
    NRF905_OUTCLK_500KHZ = 0x07,    
} nRF905_outclk_t;

typedef enum
{
    NRF905_CRC_DISABLE = 0x00,  
    NRF905_CRC_8 = 0x40,        
    NRF905_CRC_16 = 0xC0,       
} nRF905_crc_t;

typedef enum
{
    NRF905_ADDR_SIZE_1 = 0x01,  
    NRF905_ADDR_SIZE_4 = 0x04,  
} nRF905_addr_size_t;

// TODO remove?
// Setting options
//#define NRF905_BAND_433           0x00
//#define NRF905_BAND_868           0x02
//#define NRF905_BAND_915           0x02
//#define NRF905_PWR_n10            0x00
//#define NRF905_PWR_n2         0x04
//#define NRF905_PWR_6          0x08
//#define NRF905_PWR_10         0x0C
//#define NRF905_LOW_RX_ENABLE  0x10
//#define NRF905_LOW_RX_DISABLE 0x00
//#define NRF905_AUTO_RETRAN_ENABLE 0x20
//#define NRF905_AUTO_RETRAN_DISABLE    0x00
//#define NRF905_OUTCLK_DISABLE 0x00
//#define NRF905_OUTCLK_4MHZ        0x04
//#define NRF905_OUTCLK_2MHZ        0x05
//#define NRF905_OUTCLK_1MHZ        0x06
//#define NRF905_OUTCLK_500KHZ  0x07
//#define NRF905_CRC_DISABLE        0x00
//#define NRF905_CRC_8          0x40
//#define NRF905_CRC_16         0xC0
//#define NRF905_ADDR_SIZE_1        0x01
//#define NRF905_ADDR_SIZE_4        0x04

#define NRF905_MAX_PAYLOAD      32 
#define NRF905_REGISTER_COUNT   10 
#define NRF905_DEFAULT_RXADDR   0xE7E7E7E7 
#define NRF905_DEFAULT_TXADDR   0xE7E7E7E7 

#define NRF905_CALC_CHANNEL(f, b)   ((((f) / (1 + (b>>1))) - 422400000UL) / 100000UL) 

#if defined(__cplusplus)
extern "C" {
#endif

void nRF905_init(void);

void nRF905_setChannel(uint16_t channel);

void nRF905_setBand(nRF905_band_t band);

void nRF905_setAutoRetransmit(nRF905_auto_retran_t val);

void nRF905_setLowRxPower(nRF905_low_rx_t val);

void nRF905_setTransmitPower(nRF905_pwr_t val);

void nRF905_setCRC(nRF905_crc_t val);

void nRF905_setClockOut(nRF905_outclk_t val);

void nRF905_setPayloadSize(uint8_t size);

void nRF905_setAddressSize(nRF905_addr_size_t size);

uint8_t nRF905_receiveBusy(void);

uint8_t nRF905_airwayBusy(void);

void nRF905_setListenAddress(uint32_t address);

uint8_t nRF905_TX(uint32_t sendTo, void* data, uint8_t len, nRF905_nextmode_t nextMode);

void nRF905_RX(void);

void nRF905_read(void* data, uint8_t len);

void nRF905_powerDown(void);

void nRF905_powerUp(void);

void nRF905_standby(void);

void nRF905_getConfigRegisters(void*);

#if DOXYGEN || NRF905_INTERRUPTS == 0
void nRF905_SERVICE(void);
#else
#define nRF905_SERVICE() ((void)(0))
#endif

uint8_t nRF905_irq_off(void);

void nRF905_irq_on(uint8_t origVal);

#if DOXYGEN || NRF905_INTERRUPTS != 0

#if !defined(DOXYGEN)
static inline void _nRF905_iRestore(const  uint8_t *__s)
{
    nRF905_irq_on(*__s);
    __asm__ volatile ("" ::: "memory");
}
#endif

#define NRF905_NO_INTERRUPT() \
    for(uint8_t nrf905_irq __attribute__((__cleanup__(_nRF905_iRestore))) = nRF905_irq_off(), \
    nrf905_tmp = 1; nrf905_tmp ; nrf905_tmp = 0)

#else
#define NRF905_NO_INTERRUPT() ((void)(0));
#endif


#if defined(__cplusplus)
}
#endif

#endif /* NRF905_H_ */