Helmut Tschemernjak / SX1276GenericLib

SX1276GenericLib to support sx1276 bassed LoRa modules, including HopeRF RFM95, Murata CMWX1ZZABZ and Semtech SX1276MB1MAS/SX1276MB1LAS modules

Dependents:   DISCO-L072CZ-LRWAN1_LoRa_PingPong DISCO-L072CZ-LRWAN1_LoRa_PingPong DISCO-L072CZ-LRWAN1_LoRa_PingPong DISCO-L072CZ-LRWAN1_LoRa_USB_Rx ... more

Fork of SX1276Lib by Semtech

radio/radio.h@63:5b9d391244dc, 2017-06-29 (annotated)

Committer:
Helmut Tschemernjak
Date:
Thu Jun 29 19:30:24 2017 +0200
Revision:
63:5b9d391244dc
Parent:
61:08b50780eb91
Child:
65:b2d98328fcba
Added userData and userThisPtr into the radio events callback,

this allows to call C++ functions and in can include a context

via the userData

Who changed what in which revision?

UserRevisionLine numberNew contents of line
GregCr 0:e6ceb13d2d05 1 /*
GregCr 0:e6ceb13d2d05 2 / _____) _ | |
GregCr 0:e6ceb13d2d05 3 ( (____ _____ ____ _| |_ _____ ____| |__
GregCr 0:e6ceb13d2d05 4 \____ \| ___ | (_ _) ___ |/ ___) _ \
GregCr 0:e6ceb13d2d05 5 _____) ) ____| | | || |_| ____( (___| | | |
GregCr 0:e6ceb13d2d05 6 (______/|_____)_|_|_| \__)_____)\____)_| |_|
mluis 22:7f3aab69cca9 7 (C) 2014 Semtech
GregCr 0:e6ceb13d2d05 8
GregCr 0:e6ceb13d2d05 9 Description: Interface for the radios, contains the main functions that a radio needs, and 5 callback functions
GregCr 0:e6ceb13d2d05 10
GregCr 0:e6ceb13d2d05 11 License: Revised BSD License, see LICENSE.TXT file include in the project
GregCr 0:e6ceb13d2d05 12
GregCr 0:e6ceb13d2d05 13 Maintainers: Miguel Luis, Gregory Cristian and Nicolas Huguenin
GregCr 0:e6ceb13d2d05 14 */
GregCr 0:e6ceb13d2d05 15 #ifndef __RADIO_H__
GregCr 0:e6ceb13d2d05 16 #define __RADIO_H__
GregCr 0:e6ceb13d2d05 17
GregCr 0:e6ceb13d2d05 18 #include "mbed.h"
GregCr 0:e6ceb13d2d05 19
Helmut Tschemernjak 39:706c32eda7e7 20
Helmut Tschemernjak 53:6d3adad59633 21 /*!
Helmut Tschemernjak 39:706c32eda7e7 22 * Radio driver internal state machine states definition
Helmut Tschemernjak 39:706c32eda7e7 23 */
Helmut Tschemernjak 39:706c32eda7e7 24 typedef enum RadioState
Helmut Tschemernjak 39:706c32eda7e7 25 {
Helmut Tschemernjak 39:706c32eda7e7 26 RF_IDLE = 0,
Helmut Tschemernjak 39:706c32eda7e7 27 RF_RX_RUNNING,
Helmut Tschemernjak 39:706c32eda7e7 28 RF_TX_RUNNING,
Helmut Tschemernjak 39:706c32eda7e7 29 RF_CAD,
Helmut Tschemernjak 53:6d3adad59633 30 } RadioState_t;
Helmut Tschemernjak 39:706c32eda7e7 31
Helmut Tschemernjak 39:706c32eda7e7 32
Helmut Tschemernjak 39:706c32eda7e7 33 /*!
Helmut Tschemernjak 39:706c32eda7e7 34 * Type of the modem. [LORA / FSK]
Helmut Tschemernjak 39:706c32eda7e7 35 */
Helmut Tschemernjak 39:706c32eda7e7 36 typedef enum ModemType
Helmut Tschemernjak 39:706c32eda7e7 37 {
Helmut Tschemernjak 39:706c32eda7e7 38 MODEM_FSK = 0,
Helmut Tschemernjak 39:706c32eda7e7 39 MODEM_LORA
Helmut Tschemernjak 39:706c32eda7e7 40 }RadioModems_t;
Helmut Tschemernjak 39:706c32eda7e7 41
Helmut Tschemernjak 39:706c32eda7e7 42
Helmut Tschemernjak 39:706c32eda7e7 43 /*!
Helmut Tschemernjak 39:706c32eda7e7 44 * Radio LoRa modem parameters
Helmut Tschemernjak 39:706c32eda7e7 45 */
Helmut Tschemernjak 39:706c32eda7e7 46 typedef struct
Helmut Tschemernjak 39:706c32eda7e7 47 {
Helmut Tschemernjak 39:706c32eda7e7 48 int8_t Power;
Helmut Tschemernjak 39:706c32eda7e7 49 uint32_t Bandwidth;
Helmut Tschemernjak 39:706c32eda7e7 50 uint32_t Datarate;
Helmut Tschemernjak 39:706c32eda7e7 51 bool LowDatarateOptimize;
Helmut Tschemernjak 39:706c32eda7e7 52 uint8_t Coderate;
Helmut Tschemernjak 39:706c32eda7e7 53 uint16_t PreambleLen;
Helmut Tschemernjak 39:706c32eda7e7 54 bool FixLen;
Helmut Tschemernjak 39:706c32eda7e7 55 uint8_t PayloadLen;
Helmut Tschemernjak 39:706c32eda7e7 56 bool CrcOn;
Helmut Tschemernjak 39:706c32eda7e7 57 bool FreqHopOn;
Helmut Tschemernjak 39:706c32eda7e7 58 uint8_t HopPeriod;
Helmut Tschemernjak 39:706c32eda7e7 59 bool IqInverted;
Helmut Tschemernjak 39:706c32eda7e7 60 bool RxContinuous;
Helmut Tschemernjak 39:706c32eda7e7 61 uint32_t TxTimeout;
Helmut Tschemernjak 39:706c32eda7e7 62 bool PublicNetwork;
Helmut Tschemernjak 39:706c32eda7e7 63 }RadioLoRaSettings_t;
Helmut Tschemernjak 39:706c32eda7e7 64
Helmut Tschemernjak 39:706c32eda7e7 65 /*!
Helmut Tschemernjak 39:706c32eda7e7 66 * Radio FSK modem parameters
Helmut Tschemernjak 39:706c32eda7e7 67 */
Helmut Tschemernjak 39:706c32eda7e7 68 typedef struct
Helmut Tschemernjak 39:706c32eda7e7 69 {
Helmut Tschemernjak 39:706c32eda7e7 70 int8_t Power;
Helmut Tschemernjak 39:706c32eda7e7 71 uint32_t Fdev;
Helmut Tschemernjak 39:706c32eda7e7 72 uint32_t Bandwidth;
Helmut Tschemernjak 39:706c32eda7e7 73 uint32_t BandwidthAfc;
Helmut Tschemernjak 39:706c32eda7e7 74 uint32_t Datarate;
Helmut Tschemernjak 39:706c32eda7e7 75 uint16_t PreambleLen;
Helmut Tschemernjak 39:706c32eda7e7 76 bool FixLen;
Helmut Tschemernjak 39:706c32eda7e7 77 uint8_t PayloadLen;
Helmut Tschemernjak 39:706c32eda7e7 78 bool CrcOn;
Helmut Tschemernjak 39:706c32eda7e7 79 bool IqInverted;
Helmut Tschemernjak 39:706c32eda7e7 80 bool RxContinuous;
Helmut Tschemernjak 39:706c32eda7e7 81 uint32_t TxTimeout;
Helmut Tschemernjak 39:706c32eda7e7 82 uint32_t RxSingleTimeout;
Helmut Tschemernjak 39:706c32eda7e7 83 }RadioFskSettings_t;
Helmut Tschemernjak 39:706c32eda7e7 84
Helmut Tschemernjak 39:706c32eda7e7 85 /*!
Helmut Tschemernjak 39:706c32eda7e7 86 * Radio FSK packet handler state
Helmut Tschemernjak 39:706c32eda7e7 87 */
Helmut Tschemernjak 39:706c32eda7e7 88 typedef struct
Helmut Tschemernjak 39:706c32eda7e7 89 {
Helmut Tschemernjak 39:706c32eda7e7 90 uint8_t PreambleDetected;
Helmut Tschemernjak 39:706c32eda7e7 91 uint8_t SyncWordDetected;
Helmut Tschemernjak 39:706c32eda7e7 92 int8_t RssiValue;
Helmut Tschemernjak 39:706c32eda7e7 93 int32_t AfcValue;
Helmut Tschemernjak 39:706c32eda7e7 94 uint8_t RxGain;
Helmut Tschemernjak 39:706c32eda7e7 95 uint16_t Size;
Helmut Tschemernjak 39:706c32eda7e7 96 uint16_t NbBytes;
Helmut Tschemernjak 39:706c32eda7e7 97 uint8_t FifoThresh;
Helmut Tschemernjak 39:706c32eda7e7 98 uint8_t ChunkSize;
Helmut Tschemernjak 39:706c32eda7e7 99 }RadioFskPacketHandler_t;
Helmut Tschemernjak 39:706c32eda7e7 100
Helmut Tschemernjak 39:706c32eda7e7 101 /*!
Helmut Tschemernjak 39:706c32eda7e7 102 * Radio LoRa packet handler state
Helmut Tschemernjak 39:706c32eda7e7 103 */
Helmut Tschemernjak 39:706c32eda7e7 104 typedef struct
Helmut Tschemernjak 39:706c32eda7e7 105 {
Helmut Tschemernjak 39:706c32eda7e7 106 int8_t SnrValue;
Helmut Tschemernjak 39:706c32eda7e7 107 int8_t RssiValue;
Helmut Tschemernjak 39:706c32eda7e7 108 uint8_t Size;
Helmut Tschemernjak 39:706c32eda7e7 109 }RadioLoRaPacketHandler_t;
Helmut Tschemernjak 39:706c32eda7e7 110
Helmut Tschemernjak 39:706c32eda7e7 111 /*!
Helmut Tschemernjak 39:706c32eda7e7 112 * Radio Settings
Helmut Tschemernjak 39:706c32eda7e7 113 */
Helmut Tschemernjak 39:706c32eda7e7 114 typedef struct
Helmut Tschemernjak 39:706c32eda7e7 115 {
Helmut Tschemernjak 39:706c32eda7e7 116 RadioState State;
Helmut Tschemernjak 39:706c32eda7e7 117 ModemType Modem;
Helmut Tschemernjak 39:706c32eda7e7 118 uint32_t Channel;
Helmut Tschemernjak 39:706c32eda7e7 119 RadioFskSettings_t Fsk;
Helmut Tschemernjak 39:706c32eda7e7 120 RadioFskPacketHandler_t FskPacketHandler;
Helmut Tschemernjak 39:706c32eda7e7 121 RadioLoRaSettings_t LoRa;
Helmut Tschemernjak 39:706c32eda7e7 122 RadioLoRaPacketHandler_t LoRaPacketHandler;
Helmut Tschemernjak 39:706c32eda7e7 123 }RadioSettings_t;
GregCr 0:e6ceb13d2d05 124
GregCr 0:e6ceb13d2d05 125 /*!
mluis 21:2e496deb7858 126 * @brief Radio driver callback functions
GregCr 0:e6ceb13d2d05 127 */
mluis 21:2e496deb7858 128 typedef struct
GregCr 0:e6ceb13d2d05 129 {
mluis 13:618826a997e2 130 /*!
GregCr 0:e6ceb13d2d05 131 * @brief Tx Done callback prototype.
GregCr 0:e6ceb13d2d05 132 */
Helmut Tschemernjak 63:5b9d391244dc 133 void ( *TxDone )(void *radio, void *userThisPtr, void *userData);
mluis 13:618826a997e2 134 /*!
GregCr 0:e6ceb13d2d05 135 * @brief Tx Timeout callback prototype.
GregCr 0:e6ceb13d2d05 136 */
Helmut Tschemernjak 63:5b9d391244dc 137 void ( *TxTimeout )(void *radio, void *userThisPtr, void *userData);
mluis 13:618826a997e2 138 /*!
GregCr 0:e6ceb13d2d05 139 * @brief Rx Done callback prototype.
GregCr 0:e6ceb13d2d05 140 *
GregCr 0:e6ceb13d2d05 141 * @param [IN] payload Received buffer pointer
GregCr 0:e6ceb13d2d05 142 * @param [IN] size Received buffer size
GregCr 0:e6ceb13d2d05 143 * @param [IN] rssi RSSI value computed while receiving the frame [dBm]
GregCr 0:e6ceb13d2d05 144 * @param [IN] snr Raw SNR value given by the radio hardware
GregCr 0:e6ceb13d2d05 145 * FSK : N/A ( set to 0 )
GregCr 0:e6ceb13d2d05 146 * LoRa: SNR value in dB
GregCr 0:e6ceb13d2d05 147 */
Helmut Tschemernjak 63:5b9d391244dc 148 void ( *RxDone )(void *radio, void *userThisPtr, void *userData, uint8_t *payload, uint16_t size, int16_t rssi, int8_t snr );
GregCr 0:e6ceb13d2d05 149 /*!
GregCr 0:e6ceb13d2d05 150 * @brief Rx Timeout callback prototype.
GregCr 0:e6ceb13d2d05 151 */
Helmut Tschemernjak 63:5b9d391244dc 152 void ( *RxTimeout )(void *radio, void *userThisPtr, void *userData);
GregCr 0:e6ceb13d2d05 153 /*!
GregCr 0:e6ceb13d2d05 154 * @brief Rx Error callback prototype.
GregCr 0:e6ceb13d2d05 155 */
Helmut Tschemernjak 63:5b9d391244dc 156 void ( *RxError )(void *radio, void *userThisPtr, void *userData);
mluis 13:618826a997e2 157 /*!
GregCr 6:e7f02929cd3d 158 * \brief FHSS Change Channel callback prototype.
GregCr 6:e7f02929cd3d 159 *
mluis 21:2e496deb7858 160 * \param [IN] currentChannel Index number of the current channel
GregCr 6:e7f02929cd3d 161 */
Helmut Tschemernjak 63:5b9d391244dc 162 void ( *FhssChangeChannel )(void *radio, void *userThisPtr, void *userData, uint8_t currentChannel );
GregCr 7:2b555111463f 163
GregCr 7:2b555111463f 164 /*!
GregCr 7:2b555111463f 165 * @brief CAD Done callback prototype.
GregCr 12:aa5b3bf7fdf4 166 *
mluis 21:2e496deb7858 167 * @param [IN] channelDetected Channel Activity detected during the CAD
GregCr 7:2b555111463f 168 */
Helmut Tschemernjak 63:5b9d391244dc 169 void ( *CadDone ) (void *radio, void *userThisPtr, void *userData, bool channelActivityDetected );
Helmut Tschemernjak 63:5b9d391244dc 170
Helmut Tschemernjak 63:5b9d391244dc 171 /*
Helmut Tschemernjak 63:5b9d391244dc 172 * Optional data which is being provided in callbacks
Helmut Tschemernjak 63:5b9d391244dc 173 * can be used e.g. for the C++ this pointer.
Helmut Tschemernjak 63:5b9d391244dc 174 */
Helmut Tschemernjak 63:5b9d391244dc 175 void *userThisPtr;
Helmut Tschemernjak 63:5b9d391244dc 176
Helmut Tschemernjak 63:5b9d391244dc 177 /*
Helmut Tschemernjak 63:5b9d391244dc 178 * Optional data which allows to bring in data structures pointer
Helmut Tschemernjak 63:5b9d391244dc 179 * for a given radio. As callbacks are being called in interrupt level
Helmut Tschemernjak 63:5b9d391244dc 180 * the userData is perfect to know the context without iterating this
Helmut Tschemernjak 63:5b9d391244dc 181 * data structures.
Helmut Tschemernjak 63:5b9d391244dc 182 */
Helmut Tschemernjak 63:5b9d391244dc 183 void *userData;
Helmut64 48:62af1e692f00 184
mluis 21:2e496deb7858 185 }RadioEvents_t;
mluis 21:2e496deb7858 186
mluis 21:2e496deb7858 187 /*!
mluis 21:2e496deb7858 188 * Interface for the radios, contains the main functions that a radio needs, and 5 callback functions
mluis 21:2e496deb7858 189 */
mluis 21:2e496deb7858 190 class Radio
mluis 21:2e496deb7858 191 {
mluis 21:2e496deb7858 192 protected:
mluis 21:2e496deb7858 193 RadioEvents_t* RadioEvents;
mluis 21:2e496deb7858 194
GregCr 0:e6ceb13d2d05 195 public:
mluis 13:618826a997e2 196 //-------------------------------------------------------------------------
mluis 13:618826a997e2 197 // Constructor
mluis 13:618826a997e2 198 //-------------------------------------------------------------------------
mluis 13:618826a997e2 199 /*!
mluis 13:618826a997e2 200 * @brief Constructor of the radio object, the parameters are the callback functions described in the header.
mluis 21:2e496deb7858 201 *
mluis 21:2e496deb7858 202 * @param [IN] events Structure containing the driver callback functions
mluis 13:618826a997e2 203 */
mluis 21:2e496deb7858 204 Radio( RadioEvents_t *events );
mluis 13:618826a997e2 205 virtual ~Radio( ) {};
GregCr 0:e6ceb13d2d05 206
mluis 13:618826a997e2 207 //-------------------------------------------------------------------------
mluis 13:618826a997e2 208 // Pure virtual functions
mluis 13:618826a997e2 209 //-------------------------------------------------------------------------
GregCr 0:e6ceb13d2d05 210
mluis 13:618826a997e2 211 /*!
mluis 21:2e496deb7858 212 * @brief Initializes the radio
mluis 21:2e496deb7858 213 *
mluis 21:2e496deb7858 214 * @param [IN] events Structure containing the driver callback functions
mluis 21:2e496deb7858 215 */
Helmut Tschemernjak 54:0d8ea87fbab9 216 virtual bool Init( RadioEvents_t *events ) = 0;
mluis 21:2e496deb7858 217
mluis 21:2e496deb7858 218 /*!
Helmut Tschemernjak 54:0d8ea87fbab9 219 * @brief Return current radio status, returns true if a radios has been found.
GregCr 0:e6ceb13d2d05 220 *
Helmut Tschemernjak 50:43f7160e869c 221 * @param status Radio status. [RF_IDLE, RX_RUNNING, TX_RUNNING, CAD_RUNNING]
GregCr 0:e6ceb13d2d05 222 */
GregCr 19:71a47bb03fbb 223 virtual RadioState GetStatus( void ) = 0;
mluis 13:618826a997e2 224
mluis 13:618826a997e2 225 /*!
mluis 21:2e496deb7858 226 * @brief Configures the radio with the given modem
mluis 13:618826a997e2 227 *
mluis 21:2e496deb7858 228 * @param [IN] modem Modem to be used [0: FSK, 1: LoRa]
mluis 13:618826a997e2 229 */
mluis 22:7f3aab69cca9 230 virtual void SetModem( RadioModems_t modem ) = 0;
mluis 13:618826a997e2 231
mluis 13:618826a997e2 232 /*!
GregCr 0:e6ceb13d2d05 233 * @brief Sets the channel frequency
GregCr 0:e6ceb13d2d05 234 *
GregCr 0:e6ceb13d2d05 235 * @param [IN] freq Channel RF frequency
GregCr 0:e6ceb13d2d05 236 */
GregCr 0:e6ceb13d2d05 237 virtual void SetChannel( uint32_t freq ) = 0;
GregCr 0:e6ceb13d2d05 238
mluis 13:618826a997e2 239 /*!
GregCr 0:e6ceb13d2d05 240 * @brief Sets the channels configuration
GregCr 0:e6ceb13d2d05 241 *
GregCr 0:e6ceb13d2d05 242 * @param [IN] modem Radio modem to be used [0: FSK, 1: LoRa]
GregCr 0:e6ceb13d2d05 243 * @param [IN] freq Channel RF frequency
GregCr 0:e6ceb13d2d05 244 * @param [IN] rssiThresh RSSI threshold
GregCr 0:e6ceb13d2d05 245 *
GregCr 0:e6ceb13d2d05 246 * @retval isFree [true: Channel is free, false: Channel is not free]
GregCr 0:e6ceb13d2d05 247 */
mluis 22:7f3aab69cca9 248 virtual bool IsChannelFree( RadioModems_t modem, uint32_t freq, int16_t rssiThresh ) = 0;
GregCr 0:e6ceb13d2d05 249
mluis 13:618826a997e2 250 /*!
GregCr 0:e6ceb13d2d05 251 * @brief Generates a 32 bits random value based on the RSSI readings
GregCr 0:e6ceb13d2d05 252 *
GregCr 0:e6ceb13d2d05 253 * \remark This function sets the radio in LoRa modem mode and disables
GregCr 0:e6ceb13d2d05 254 * all interrupts.
GregCr 0:e6ceb13d2d05 255 * After calling this function either Radio.SetRxConfig or
GregCr 0:e6ceb13d2d05 256 * Radio.SetTxConfig functions must be called.
GregCr 0:e6ceb13d2d05 257 *
GregCr 0:e6ceb13d2d05 258 * @retval randomValue 32 bits random value
GregCr 0:e6ceb13d2d05 259 */
GregCr 0:e6ceb13d2d05 260 virtual uint32_t Random( void )= 0;
GregCr 0:e6ceb13d2d05 261
mluis 13:618826a997e2 262 /*!
GregCr 0:e6ceb13d2d05 263 * @brief Sets the reception parameters
GregCr 0:e6ceb13d2d05 264 *
GregCr 0:e6ceb13d2d05 265 * @param [IN] modem Radio modem to be used [0: FSK, 1: LoRa]
GregCr 0:e6ceb13d2d05 266 * @param [IN] bandwidth Sets the bandwidth
GregCr 0:e6ceb13d2d05 267 * FSK : >= 2600 and <= 250000 Hz
GregCr 0:e6ceb13d2d05 268 * LoRa: [0: 125 kHz, 1: 250 kHz,
GregCr 0:e6ceb13d2d05 269 * 2: 500 kHz, 3: Reserved]
GregCr 0:e6ceb13d2d05 270 * @param [IN] datarate Sets the Datarate
GregCr 0:e6ceb13d2d05 271 * FSK : 600..300000 bits/s
GregCr 0:e6ceb13d2d05 272 * LoRa: [6: 64, 7: 128, 8: 256, 9: 512,
GregCr 0:e6ceb13d2d05 273 * 10: 1024, 11: 2048, 12: 4096 chips]
GregCr 0:e6ceb13d2d05 274 * @param [IN] coderate Sets the coding rate ( LoRa only )
GregCr 0:e6ceb13d2d05 275 * FSK : N/A ( set to 0 )
GregCr 0:e6ceb13d2d05 276 * LoRa: [1: 4/5, 2: 4/6, 3: 4/7, 4: 4/8]
GregCr 0:e6ceb13d2d05 277 * @param [IN] bandwidthAfc Sets the AFC Bandwidth ( FSK only )
GregCr 0:e6ceb13d2d05 278 * FSK : >= 2600 and <= 250000 Hz
GregCr 0:e6ceb13d2d05 279 * LoRa: N/A ( set to 0 )
GregCr 0:e6ceb13d2d05 280 * @param [IN] preambleLen Sets the Preamble length ( LoRa only )
GregCr 0:e6ceb13d2d05 281 * FSK : N/A ( set to 0 )
GregCr 0:e6ceb13d2d05 282 * LoRa: Length in symbols ( the hardware adds 4 more symbols )
Helmut Tschemernjak 31:e50929bd3f32 283 * @param [IN] symbTimeout Sets the RxSingle timeout value
Helmut Tschemernjak 31:e50929bd3f32 284 * FSK : timeout number of bytes
GregCr 0:e6ceb13d2d05 285 * LoRa: timeout in symbols
GregCr 0:e6ceb13d2d05 286 * @param [IN] fixLen Fixed length packets [0: variable, 1: fixed]
mluis 13:618826a997e2 287 * @param [IN] payloadLen Sets payload length when fixed lenght is used
GregCr 0:e6ceb13d2d05 288 * @param [IN] crcOn Enables/Disables the CRC [0: OFF, 1: ON]
mluis 13:618826a997e2 289 * @param [IN] freqHopOn Enables disables the intra-packet frequency hopping [0: OFF, 1: ON] (LoRa only)
mluis 13:618826a997e2 290 * @param [IN] hopPeriod Number of symbols bewteen each hop (LoRa only)
GregCr 0:e6ceb13d2d05 291 * @param [IN] iqInverted Inverts IQ signals ( LoRa only )
GregCr 0:e6ceb13d2d05 292 * FSK : N/A ( set to 0 )
GregCr 0:e6ceb13d2d05 293 * LoRa: [0: not inverted, 1: inverted]
GregCr 0:e6ceb13d2d05 294 * @param [IN] rxContinuous Sets the reception in continuous mode
GregCr 0:e6ceb13d2d05 295 * [false: single mode, true: continuous mode]
GregCr 0:e6ceb13d2d05 296 */
mluis 22:7f3aab69cca9 297 virtual void SetRxConfig ( RadioModems_t modem, uint32_t bandwidth,
GregCr 0:e6ceb13d2d05 298 uint32_t datarate, uint8_t coderate,
GregCr 0:e6ceb13d2d05 299 uint32_t bandwidthAfc, uint16_t preambleLen,
GregCr 0:e6ceb13d2d05 300 uint16_t symbTimeout, bool fixLen,
mluis 13:618826a997e2 301 uint8_t payloadLen,
mluis 13:618826a997e2 302 bool crcOn, bool freqHopOn, uint8_t hopPeriod,
GregCr 6:e7f02929cd3d 303 bool iqInverted, bool rxContinuous ) = 0;
Helmut Tschemernjak 31:e50929bd3f32 304
mluis 13:618826a997e2 305 /*!
GregCr 0:e6ceb13d2d05 306 * @brief Sets the transmission parameters
GregCr 0:e6ceb13d2d05 307 *
GregCr 0:e6ceb13d2d05 308 * @param [IN] modem Radio modem to be used [0: FSK, 1: LoRa]
GregCr 0:e6ceb13d2d05 309 * @param [IN] power Sets the output power [dBm]
GregCr 0:e6ceb13d2d05 310 * @param [IN] fdev Sets the frequency deviation ( FSK only )
GregCr 0:e6ceb13d2d05 311 * FSK : [Hz]
GregCr 0:e6ceb13d2d05 312 * LoRa: 0
GregCr 0:e6ceb13d2d05 313 * @param [IN] bandwidth Sets the bandwidth ( LoRa only )
GregCr 0:e6ceb13d2d05 314 * FSK : 0
GregCr 0:e6ceb13d2d05 315 * LoRa: [0: 125 kHz, 1: 250 kHz,
GregCr 0:e6ceb13d2d05 316 * 2: 500 kHz, 3: Reserved]
GregCr 0:e6ceb13d2d05 317 * @param [IN] datarate Sets the Datarate
GregCr 0:e6ceb13d2d05 318 * FSK : 600..300000 bits/s
GregCr 0:e6ceb13d2d05 319 * LoRa: [6: 64, 7: 128, 8: 256, 9: 512,
GregCr 0:e6ceb13d2d05 320 * 10: 1024, 11: 2048, 12: 4096 chips]
GregCr 0:e6ceb13d2d05 321 * @param [IN] coderate Sets the coding rate ( LoRa only )
GregCr 0:e6ceb13d2d05 322 * FSK : N/A ( set to 0 )
GregCr 0:e6ceb13d2d05 323 * LoRa: [1: 4/5, 2: 4/6, 3: 4/7, 4: 4/8]
GregCr 0:e6ceb13d2d05 324 * @param [IN] preambleLen Sets the preamble length
GregCr 0:e6ceb13d2d05 325 * @param [IN] fixLen Fixed length packets [0: variable, 1: fixed]
GregCr 0:e6ceb13d2d05 326 * @param [IN] crcOn Enables disables the CRC [0: OFF, 1: ON]
mluis 13:618826a997e2 327 * @param [IN] freqHopOn Enables disables the intra-packet frequency hopping [0: OFF, 1: ON] (LoRa only)
mluis 13:618826a997e2 328 * @param [IN] hopPeriod Number of symbols bewteen each hop (LoRa only)
GregCr 0:e6ceb13d2d05 329 * @param [IN] iqInverted Inverts IQ signals ( LoRa only )
GregCr 0:e6ceb13d2d05 330 * FSK : N/A ( set to 0 )
GregCr 0:e6ceb13d2d05 331 * LoRa: [0: not inverted, 1: inverted]
GregCr 0:e6ceb13d2d05 332 * @param [IN] timeout Transmission timeout [us]
GregCr 0:e6ceb13d2d05 333 */
mluis 22:7f3aab69cca9 334 virtual void SetTxConfig( RadioModems_t modem, int8_t power, uint32_t fdev,
GregCr 6:e7f02929cd3d 335 uint32_t bandwidth, uint32_t datarate,
GregCr 6:e7f02929cd3d 336 uint8_t coderate, uint16_t preambleLen,
mluis 13:618826a997e2 337 bool fixLen, bool crcOn, bool freqHopOn,
mluis 13:618826a997e2 338 uint8_t hopPeriod, bool iqInverted, uint32_t timeout ) = 0;
Helmut Tschemernjak 31:e50929bd3f32 339
mluis 13:618826a997e2 340 /*!
GregCr 0:e6ceb13d2d05 341 * @brief Checks if the given RF frequency is supported by the hardware
GregCr 0:e6ceb13d2d05 342 *
GregCr 0:e6ceb13d2d05 343 * @param [IN] frequency RF frequency to be checked
GregCr 0:e6ceb13d2d05 344 * @retval isSupported [true: supported, false: unsupported]
GregCr 0:e6ceb13d2d05 345 */
GregCr 0:e6ceb13d2d05 346 virtual bool CheckRfFrequency( uint32_t frequency ) = 0;
GregCr 0:e6ceb13d2d05 347
mluis 13:618826a997e2 348 /*!
GregCr 0:e6ceb13d2d05 349 * @brief Computes the packet time on air for the given payload
GregCr 0:e6ceb13d2d05 350 *
GregCr 0:e6ceb13d2d05 351 * \Remark Can only be called once SetRxConfig or SetTxConfig have been called
GregCr 0:e6ceb13d2d05 352 *
GregCr 0:e6ceb13d2d05 353 * @param [IN] modem Radio modem to be used [0: FSK, 1: LoRa]
GregCr 0:e6ceb13d2d05 354 * @param [IN] pktLen Packet payload length
GregCr 0:e6ceb13d2d05 355 *
GregCr 0:e6ceb13d2d05 356 * @retval airTime Computed airTime for the given packet payload length
GregCr 0:e6ceb13d2d05 357 */
Helmut Tschemernjak 59:38e56c85fa44 358 virtual uint32_t TimeOnAir ( RadioModems_t modem, int16_t pktLen ) = 0;
GregCr 0:e6ceb13d2d05 359
mluis 13:618826a997e2 360 /*!
GregCr 0:e6ceb13d2d05 361 * @brief Sends the buffer of size. Prepares the packet to be sent and sets
GregCr 0:e6ceb13d2d05 362 * the radio in transmission
GregCr 0:e6ceb13d2d05 363 *
GregCr 0:e6ceb13d2d05 364 * @param [IN]: buffer Buffer pointer
GregCr 0:e6ceb13d2d05 365 * @param [IN]: size Buffer size
Helmut Tschemernjak 50:43f7160e869c 366 * @param [IN]: buffer Header pointer
Helmut Tschemernjak 50:43f7160e869c 367 * @param [IN]: size Header size
GregCr 0:e6ceb13d2d05 368 */
Helmut Tschemernjak 51:aef3234bcb71 369 virtual void Send( void *buffer, int16_t size, void *header = NULL, int16_t hsize = 0) = 0;
Helmut Tschemernjak 31:e50929bd3f32 370
mluis 13:618826a997e2 371 /*!
GregCr 0:e6ceb13d2d05 372 * @brief Sets the radio in sleep mode
GregCr 0:e6ceb13d2d05 373 */
GregCr 0:e6ceb13d2d05 374 virtual void Sleep( void ) = 0;
Helmut Tschemernjak 31:e50929bd3f32 375
mluis 13:618826a997e2 376 /*!
GregCr 0:e6ceb13d2d05 377 * @brief Sets the radio in standby mode
GregCr 0:e6ceb13d2d05 378 */
GregCr 7:2b555111463f 379 virtual void Standby( void ) = 0;
Helmut Tschemernjak 31:e50929bd3f32 380
mluis 13:618826a997e2 381 /*!
GregCr 7:2b555111463f 382 * @brief Sets the radio in CAD mode
GregCr 7:2b555111463f 383 */
GregCr 7:2b555111463f 384 virtual void StartCad( void ) = 0;
Helmut Tschemernjak 31:e50929bd3f32 385
mluis 13:618826a997e2 386 /*!
GregCr 0:e6ceb13d2d05 387 * @brief Sets the radio in reception mode for the given time
GregCr 0:e6ceb13d2d05 388 * @param [IN] timeout Reception timeout [us]
GregCr 0:e6ceb13d2d05 389 * [0: continuous, others timeout]
GregCr 0:e6ceb13d2d05 390 */
GregCr 0:e6ceb13d2d05 391 virtual void Rx( uint32_t timeout ) = 0;
Helmut Tschemernjak 54:0d8ea87fbab9 392
Helmut Tschemernjak 54:0d8ea87fbab9 393 /*!
Helmut Tschemernjak 54:0d8ea87fbab9 394 * @brief Check is radio receives a signal
Helmut Tschemernjak 54:0d8ea87fbab9 395 */
Helmut Tschemernjak 54:0d8ea87fbab9 396 virtual bool RxSignalPending() = 0;
Helmut Tschemernjak 54:0d8ea87fbab9 397
Helmut Tschemernjak 31:e50929bd3f32 398
mluis 13:618826a997e2 399 /*!
GregCr 0:e6ceb13d2d05 400 * @brief Sets the radio in transmission mode for the given time
GregCr 0:e6ceb13d2d05 401 * @param [IN] timeout Transmission timeout [us]
GregCr 0:e6ceb13d2d05 402 * [0: continuous, others timeout]
GregCr 0:e6ceb13d2d05 403 */
GregCr 0:e6ceb13d2d05 404 virtual void Tx( uint32_t timeout ) = 0;
Helmut Tschemernjak 31:e50929bd3f32 405
Helmut Tschemernjak 31:e50929bd3f32 406 /*!
Helmut Tschemernjak 31:e50929bd3f32 407 * @brief Sets the radio in continuous wave transmission mode
Helmut Tschemernjak 31:e50929bd3f32 408 *
Helmut Tschemernjak 31:e50929bd3f32 409 * @param [IN]: freq Channel RF frequency
Helmut Tschemernjak 31:e50929bd3f32 410 * @param [IN]: power Sets the output power [dBm]
Helmut Tschemernjak 31:e50929bd3f32 411 * @param [IN]: time Transmission mode timeout [s]
Helmut Tschemernjak 31:e50929bd3f32 412 */
Helmut Tschemernjak 31:e50929bd3f32 413 virtual void SetTxContinuousWave( uint32_t freq, int8_t power, uint16_t time ) = 0;
Helmut Tschemernjak 31:e50929bd3f32 414
mluis 13:618826a997e2 415 /*!
Helmut Tschemernjak 50:43f7160e869c 416 * @brief Returns the maximal transfer unit for a given modem
Helmut Tschemernjak 50:43f7160e869c 417 *
Helmut Tschemernjak 50:43f7160e869c 418 * @retval MTU size in bytes
Helmut Tschemernjak 50:43f7160e869c 419 */
Helmut Tschemernjak 50:43f7160e869c 420 virtual int16_t MaxMTUSize( RadioModems_t modem ) = 0;
Helmut Tschemernjak 50:43f7160e869c 421
Helmut Tschemernjak 50:43f7160e869c 422 /*!
GregCr 0:e6ceb13d2d05 423 * @brief Reads the current RSSI value
GregCr 0:e6ceb13d2d05 424 *
GregCr 0:e6ceb13d2d05 425 * @retval rssiValue Current RSSI value in [dBm]
GregCr 0:e6ceb13d2d05 426 */
mluis 22:7f3aab69cca9 427 virtual int16_t GetRssi ( RadioModems_t modem ) = 0;
Helmut Tschemernjak 31:e50929bd3f32 428
mluis 13:618826a997e2 429 /*!
GregCr 0:e6ceb13d2d05 430 * @brief Writes the radio register at the specified address
GregCr 0:e6ceb13d2d05 431 *
GregCr 0:e6ceb13d2d05 432 * @param [IN]: addr Register address
GregCr 0:e6ceb13d2d05 433 * @param [IN]: data New register value
GregCr 0:e6ceb13d2d05 434 */
GregCr 0:e6ceb13d2d05 435 virtual void Write ( uint8_t addr, uint8_t data ) = 0;
Helmut Tschemernjak 31:e50929bd3f32 436
mluis 13:618826a997e2 437 /*!
GregCr 0:e6ceb13d2d05 438 * @brief Reads the radio register at the specified address
GregCr 0:e6ceb13d2d05 439 *
GregCr 0:e6ceb13d2d05 440 * @param [IN]: addr Register address
GregCr 0:e6ceb13d2d05 441 * @retval data Register value
GregCr 0:e6ceb13d2d05 442 */
GregCr 0:e6ceb13d2d05 443 virtual uint8_t Read ( uint8_t addr ) = 0;
Helmut Tschemernjak 31:e50929bd3f32 444
mluis 13:618826a997e2 445 /*!
GregCr 0:e6ceb13d2d05 446 * @brief Writes multiple radio registers starting at address
GregCr 0:e6ceb13d2d05 447 *
GregCr 0:e6ceb13d2d05 448 * @param [IN] addr First Radio register address
GregCr 0:e6ceb13d2d05 449 * @param [IN] buffer Buffer containing the new register's values
GregCr 0:e6ceb13d2d05 450 * @param [IN] size Number of registers to be written
GregCr 0:e6ceb13d2d05 451 */
Helmut Tschemernjak 51:aef3234bcb71 452 virtual void Write( uint8_t addr, void *buffer, uint8_t size ) = 0;
Helmut Tschemernjak 31:e50929bd3f32 453
mluis 13:618826a997e2 454 /*!
GregCr 0:e6ceb13d2d05 455 * @brief Reads multiple radio registers starting at address
GregCr 0:e6ceb13d2d05 456 *
GregCr 0:e6ceb13d2d05 457 * @param [IN] addr First Radio register address
GregCr 0:e6ceb13d2d05 458 * @param [OUT] buffer Buffer where to copy the registers data
GregCr 0:e6ceb13d2d05 459 * @param [IN] size Number of registers to be read
GregCr 0:e6ceb13d2d05 460 */
Helmut Tschemernjak 51:aef3234bcb71 461 virtual void Read ( uint8_t addr, void *buffer, uint8_t size ) = 0;
Helmut Tschemernjak 31:e50929bd3f32 462
mluis 13:618826a997e2 463 /*!
Helmut Tschemernjak 31:e50929bd3f32 464 * @brief Writes the buffer contents to the Radio FIFO
mluis 13:618826a997e2 465 *
mluis 13:618826a997e2 466 * @param [IN] buffer Buffer containing data to be put on the FIFO.
mluis 13:618826a997e2 467 * @param [IN] size Number of bytes to be written to the FIFO
mluis 13:618826a997e2 468 */
Helmut Tschemernjak 51:aef3234bcb71 469 virtual void WriteFifo( void *buffer, uint8_t size ) = 0;
GregCr 0:e6ceb13d2d05 470
mluis 13:618826a997e2 471 /*!
Helmut Tschemernjak 31:e50929bd3f32 472 * @brief Reads the contents of the Radio FIFO
mluis 13:618826a997e2 473 *
mluis 13:618826a997e2 474 * @param [OUT] buffer Buffer where to copy the FIFO read data.
mluis 13:618826a997e2 475 * @param [IN] size Number of bytes to be read from the FIFO
mluis 13:618826a997e2 476 */
Helmut Tschemernjak 51:aef3234bcb71 477 virtual void ReadFifo( void *buffer, uint8_t size ) = 0;
Helmut Tschemernjak 31:e50929bd3f32 478
mluis 20:e05596ba4166 479 /*!
mluis 20:e05596ba4166 480 * @brief Sets the maximum payload length.
mluis 20:e05596ba4166 481 *
mluis 20:e05596ba4166 482 * @param [IN] modem Radio modem to be used [0: FSK, 1: LoRa]
mluis 20:e05596ba4166 483 * @param [IN] max Maximum payload length in bytes
mluis 20:e05596ba4166 484 */
mluis 22:7f3aab69cca9 485 virtual void SetMaxPayloadLength( RadioModems_t modem, uint8_t max ) = 0;
Helmut Tschemernjak 31:e50929bd3f32 486
Helmut Tschemernjak 31:e50929bd3f32 487 /*!
Helmut Tschemernjak 31:e50929bd3f32 488 * @brief Sets the network to public or private. Updates the sync byte.
Helmut Tschemernjak 31:e50929bd3f32 489 *
Helmut Tschemernjak 31:e50929bd3f32 490 * @remark Applies to LoRa modem only
Helmut Tschemernjak 31:e50929bd3f32 491 *
Helmut Tschemernjak 31:e50929bd3f32 492 * @param [IN] enable if true, it enables a public network
Helmut Tschemernjak 31:e50929bd3f32 493 */
Helmut Tschemernjak 31:e50929bd3f32 494 virtual void SetPublicNetwork( bool enable ) = 0;
Helmut Tschemernjak 61:08b50780eb91 495
Helmut Tschemernjak 61:08b50780eb91 496 /*!
Helmut Tschemernjak 61:08b50780eb91 497 * \brief Sets the radio output power.
Helmut Tschemernjak 61:08b50780eb91 498 *
Helmut Tschemernjak 61:08b50780eb91 499 * @param [IN] power Sets the RF output power
Helmut Tschemernjak 61:08b50780eb91 500 */
Helmut Tschemernjak 61:08b50780eb91 501 virtual void SetRfTxPower( int8_t power ) = 0;
Helmut Tschemernjak 61:08b50780eb91 502
GregCr 0:e6ceb13d2d05 503 };
GregCr 0:e6ceb13d2d05 504
GregCr 0:e6ceb13d2d05 505 #endif // __RADIO_H__