radio.h

Go to the documentation of this file.

 
#ifndef __RADIO_H__
#define __RADIO_H__
 
extern "C"
{
    typedef enum
    {
        MODEM_FSK = 0,
        MODEM_LORA,
    } RadioModems_t;
 
    typedef enum
    {
        RF_IDLE = 0,   
        RF_RX_RUNNING, 
        RF_TX_RUNNING, 
        RF_CAD,        
    } RadioState_t;
 
    typedef struct
    {
        void (*TxDone)(void);
        void (*TxTimeout)(void);
        void (*RxDone)(uint8_t *payload, uint16_t size, int16_t rssi, int8_t snr);
        void (*RxTimeout)(void);
        void (*RxError)(void);
        void (*PreAmpDetect)(void);
        void (*FhssChangeChannel)(uint8_t currentChannel);
 
        void (*CadDone)(bool channelActivityDetected);
    } RadioEvents_t;
 
    struct Radio_s
    {
        void (*Init)(RadioEvents_t *events);
        void (*ReInit)(RadioEvents_t *events);
        RadioState_t (*GetStatus)(void);
        void (*SetModem)(RadioModems_t modem);
        void (*SetChannel)(uint32_t freq);
        bool (*IsChannelFree)(RadioModems_t modem, uint32_t freq, int16_t rssiThresh, uint32_t maxCarrierSenseTime);
        uint32_t (*Random)(void);
        void (*SetRxConfig)(RadioModems_t modem, uint32_t bandwidth,
                            uint32_t datarate, uint8_t coderate,
                            uint32_t bandwidthAfc, uint16_t preambleLen,
                            uint16_t symbTimeout, bool fixLen,
                            uint8_t payloadLen,
                            bool crcOn, bool freqHopOn, uint8_t hopPeriod,
                            bool iqInverted, bool rxContinuous);
        void (*SetTxConfig)(RadioModems_t modem, int8_t power, uint32_t fdev,
                            uint32_t bandwidth, uint32_t datarate,
                            uint8_t coderate, uint16_t preambleLen,
                            bool fixLen, bool crcOn, bool freqHopOn,
                            uint8_t hopPeriod, bool iqInverted, uint32_t timeout);
        bool (*CheckRfFrequency)(uint32_t frequency);
        uint32_t (*TimeOnAir)(RadioModems_t modem, uint8_t pktLen);
        void (*Send)(uint8_t *buffer, uint8_t size);
        void (*Sleep)(void);
        void (*Standby)(void);
        void (*Rx)(uint32_t timeout);
        void (*SetCadParams)(uint8_t cadSymbolNum, uint8_t cadDetPeak, uint8_t cadDetMin, uint8_t cadExitMode, uint32_t cadTimeout);
        void (*StartCad)(void);
        void (*SetTxContinuousWave)(uint32_t freq, int8_t power, uint16_t time);
        int16_t (*Rssi)(RadioModems_t modem);
        void (*Write)(uint16_t addr, uint8_t data);
        uint8_t (*Read)(uint16_t addr);
        void (*WriteBuffer)(uint16_t addr, uint8_t *buffer, uint8_t size);
        void (*ReadBuffer)(uint16_t addr, uint8_t *buffer, uint8_t size);
        void (*SetMaxPayloadLength)(RadioModems_t modem, uint8_t max);
        void (*SetPublicNetwork)(bool enable);
        uint32_t (*GetWakeupTime)(void);
        void (*BgIrqProcess)(void);
        void (*IrqProcess)(void);
        /*
      * \brief Process radio irq after CPU wakeup from deep sleep
     */
        void (*IrqProcessAfterDeepSleep)(void);
        /*
     * The next functions are available only on SX126x radios.
     */
        void (*RxBoosted)(uint32_t timeout);
        void (*SetRxDutyCycle)(uint32_t rxTime, uint32_t sleepTime);
    };
 
    extern const struct Radio_s Radio;
};
#endif // __RADIO_H__