nRF905.h

Go to the documentation of this file.

/*
 * Project: nRF905 Radio Library for Arduino
 * Author: Zak Kemble, contact@zakkemble.net
 * Copyright: (C) 2020 by Zak Kemble
 * License: GNU GPL v3 (see License.txt)
 * Web: https://blog.zakkemble.net/nrf905-avrarduino-librarydriver/
 */

#ifndef NRF905_H_
#define NRF905_H_

#include <Arduino.h>
#include <SPI.h>
#include <stdint.h>
#include "nRF905_config.h"

typedef enum
{
// TODO use nRF905_mode_t instead of nRF905_nextmode_t?

    NRF905_NEXTMODE_STANDBY, 
    NRF905_NEXTMODE_RX, 
    NRF905_NEXTMODE_TX 
} nRF905_nextmode_t;

typedef enum
{
    NRF905_MODE_POWERDOWN, 
    NRF905_MODE_STANDBY, 
    NRF905_MODE_RX, 
    NRF905_MODE_TX, 
    NRF905_MODE_ACTIVE 
} nRF905_mode_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_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;

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

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

class nRF905 //: public Stream // TODO see Wire library
{
private:
    SPIClass spi;
    SPISettings spiSettings;
    
    // Pins
    uint8_t csn; // SPI SS
    uint8_t trx; // Standby (CE/TRX_EN)
    uint8_t tx; // TX or RX mode (TXE/TX_EN)
    uint8_t pwr; // Power-down control (PWR)
    uint8_t cd; // Carrier detect (CD)
    uint8_t dr; // Data ready (DR)
    uint8_t am; // Address match (AM)
    
    // Events
    void (*onRxComplete)(nRF905* device);
    void (*onRxInvalid)(nRF905* device);
    void (*onTxComplete)(nRF905* device);
    void (*onAddrMatch)(nRF905* device);

    volatile uint8_t validPacket;
    bool polledMode;

    inline uint8_t cselect();
    inline uint8_t cdeselect();
    uint8_t readConfigRegister(uint8_t reg);
    void writeConfigRegister(uint8_t reg, uint8_t val);
    void setConfigReg1(uint8_t val, uint8_t mask, uint8_t reg);
    void setConfigReg2(uint8_t val, uint8_t mask, uint8_t reg);
    void defaultConfig();
    inline void powerOn(bool val);
    inline void standbyMode(bool val);
    inline void txMode(bool val);
    void setAddress(uint32_t address, uint8_t cmd);
    uint8_t readStatus();
    //bool dataReady();
    bool addressMatched();

public:
    /*virtual size_t write(uint8_t);
    virtual size_t write(const uint8_t *, size_t);
    virtual int available();
    virtual int read();
    virtual int peek();
    virtual void flush();
    using Print::write;*/

    nRF905();

    void begin(
        SPIClass spi,
        uint32_t spiClock,
        int csn,
        int trx,
        int tx,
        int pwr,
        int cd,
        int dr,
        int am,
        void (*callback_interrupt_dr)(),
        void (*callback_interrupt_am)()
    );

    void otherSPIinterrupts();

    void events(
        void (*onRxComplete)(nRF905* device),
        void (*onRxInvalid)(nRF905* device),
        void (*onTxComplete)(nRF905* device),
        void (*onAddrMatch)(nRF905* device)
    );

    void setChannel(uint16_t channel);

    void setBand(nRF905_band_t band);

    void setAutoRetransmit(bool val);

    void setLowRxPower(bool val);

    void setTransmitPower(nRF905_pwr_t val);

    void setCRC(nRF905_crc_t val);

    void setClockOut(nRF905_outclk_t val);

    void setPayloadSize(uint8_t sizeTX, uint8_t sizeRX);

    void setAddressSize(uint8_t sizeTX, uint8_t sizeRX);

    bool receiveBusy();

    bool airwayBusy();

    void setListenAddress(uint32_t address);

    void write(uint32_t sendTo, void* data, uint8_t len);

    void read(void* data, uint8_t len);

    //uint32_t readUInt32(); // TODO
    //uint8_t readUInt8(); // TODO
    //char readChar(); // TODO
    //uint8_t readString(char str, uint8_t size); // TODO

    bool TX(nRF905_nextmode_t nextMode, bool collisionAvoid);

    void RX();

    void powerDown();

    void standby();

    nRF905_mode_t mode();

    void getConfigRegisters(void* regs);

    void interrupt_dr();

    void interrupt_am();

    void poll();
};

#endif /* NRF905_H_ */