Amir Chaudhary / Mbed 2 deprecated LoRaWAN-hello-world-8thApril

LoRaWAN-hello-world- code

Dependencies:   mbed LoRaWAN-lib

radio/SX1276Lib/sx1276/sx1276.h@12:813e9e5f5ff6, 2019-03-22 (annotated)

Committer:
amirchaudhary
Date:
Fri Mar 22 16:24:25 2019 +0000
Revision:
12:813e9e5f5ff6
Updated the code to Class C Lorawan.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
amirchaudhary 12:813e9e5f5ff6 1 /*
amirchaudhary 12:813e9e5f5ff6 2 / _____) _ | |
amirchaudhary 12:813e9e5f5ff6 3 ( (____ _____ ____ _| |_ _____ ____| |__
amirchaudhary 12:813e9e5f5ff6 4 \____ \| ___ | (_ _) ___ |/ ___) _ \
amirchaudhary 12:813e9e5f5ff6 5 _____) ) ____| | | || |_| ____( (___| | | |
amirchaudhary 12:813e9e5f5ff6 6 (______/|_____)_|_|_| \__)_____)\____)_| |_|
amirchaudhary 12:813e9e5f5ff6 7 (C) 2014 Semtech
amirchaudhary 12:813e9e5f5ff6 8
amirchaudhary 12:813e9e5f5ff6 9 Description: Actual implementation of a SX1276 radio, inherits Radio
amirchaudhary 12:813e9e5f5ff6 10
amirchaudhary 12:813e9e5f5ff6 11 License: Revised BSD License, see LICENSE.TXT file include in the project
amirchaudhary 12:813e9e5f5ff6 12
amirchaudhary 12:813e9e5f5ff6 13 Maintainers: Miguel Luis, Gregory Cristian and Nicolas Huguenin
amirchaudhary 12:813e9e5f5ff6 14 */
amirchaudhary 12:813e9e5f5ff6 15 #ifndef __SX1276_H__
amirchaudhary 12:813e9e5f5ff6 16 #define __SX1276_H__
amirchaudhary 12:813e9e5f5ff6 17
amirchaudhary 12:813e9e5f5ff6 18 #include "radio.h"
amirchaudhary 12:813e9e5f5ff6 19 #include "./registers/sx1276Regs-Fsk.h"
amirchaudhary 12:813e9e5f5ff6 20 #include "./registers/sx1276Regs-LoRa.h"
amirchaudhary 12:813e9e5f5ff6 21 #include "./typedefs/typedefs.h"
amirchaudhary 12:813e9e5f5ff6 22
amirchaudhary 12:813e9e5f5ff6 23 /*!
amirchaudhary 12:813e9e5f5ff6 24 * Radio wake-up time from sleep
amirchaudhary 12:813e9e5f5ff6 25 */
amirchaudhary 12:813e9e5f5ff6 26 #define RADIO_WAKEUP_TIME 1 // [ms]
amirchaudhary 12:813e9e5f5ff6 27
amirchaudhary 12:813e9e5f5ff6 28 /*!
amirchaudhary 12:813e9e5f5ff6 29 * Sync word for Private LoRa networks
amirchaudhary 12:813e9e5f5ff6 30 */
amirchaudhary 12:813e9e5f5ff6 31 #define LORA_MAC_PRIVATE_SYNCWORD 0x12
amirchaudhary 12:813e9e5f5ff6 32
amirchaudhary 12:813e9e5f5ff6 33 /*!
amirchaudhary 12:813e9e5f5ff6 34 * Sync word for Public LoRa networks
amirchaudhary 12:813e9e5f5ff6 35 */
amirchaudhary 12:813e9e5f5ff6 36 #define LORA_MAC_PUBLIC_SYNCWORD 0x34
amirchaudhary 12:813e9e5f5ff6 37
amirchaudhary 12:813e9e5f5ff6 38
amirchaudhary 12:813e9e5f5ff6 39 /*!
amirchaudhary 12:813e9e5f5ff6 40 * SX1276 definitions
amirchaudhary 12:813e9e5f5ff6 41 */
amirchaudhary 12:813e9e5f5ff6 42 #define XTAL_FREQ 32000000
amirchaudhary 12:813e9e5f5ff6 43 #define FREQ_STEP 61.03515625
amirchaudhary 12:813e9e5f5ff6 44
amirchaudhary 12:813e9e5f5ff6 45 #define RX_BUFFER_SIZE 256
amirchaudhary 12:813e9e5f5ff6 46
amirchaudhary 12:813e9e5f5ff6 47 /*!
amirchaudhary 12:813e9e5f5ff6 48 * Constant values need to compute the RSSI value
amirchaudhary 12:813e9e5f5ff6 49 */
amirchaudhary 12:813e9e5f5ff6 50 #define RSSI_OFFSET_LF -164.0
amirchaudhary 12:813e9e5f5ff6 51 #define RSSI_OFFSET_HF -157.0
amirchaudhary 12:813e9e5f5ff6 52
amirchaudhary 12:813e9e5f5ff6 53 #define RF_MID_BAND_THRESH 525000000
amirchaudhary 12:813e9e5f5ff6 54
amirchaudhary 12:813e9e5f5ff6 55 /*!
amirchaudhary 12:813e9e5f5ff6 56 * Actual implementation of a SX1276 radio, inherits Radio
amirchaudhary 12:813e9e5f5ff6 57 */
amirchaudhary 12:813e9e5f5ff6 58 class SX1276 : public Radio
amirchaudhary 12:813e9e5f5ff6 59 {
amirchaudhary 12:813e9e5f5ff6 60 protected:
amirchaudhary 12:813e9e5f5ff6 61 /*!
amirchaudhary 12:813e9e5f5ff6 62 * SPI Interface
amirchaudhary 12:813e9e5f5ff6 63 */
amirchaudhary 12:813e9e5f5ff6 64 SPI spi; // mosi, miso, sclk
amirchaudhary 12:813e9e5f5ff6 65 DigitalOut nss;
amirchaudhary 12:813e9e5f5ff6 66
amirchaudhary 12:813e9e5f5ff6 67 /*!
amirchaudhary 12:813e9e5f5ff6 68 * SX1276 Reset pin
amirchaudhary 12:813e9e5f5ff6 69 */
amirchaudhary 12:813e9e5f5ff6 70 DigitalInOut reset;
amirchaudhary 12:813e9e5f5ff6 71
amirchaudhary 12:813e9e5f5ff6 72 /*!
amirchaudhary 12:813e9e5f5ff6 73 * SX1276 DIO pins
amirchaudhary 12:813e9e5f5ff6 74 */
amirchaudhary 12:813e9e5f5ff6 75 InterruptIn dio0;
amirchaudhary 12:813e9e5f5ff6 76 InterruptIn dio1;
amirchaudhary 12:813e9e5f5ff6 77 InterruptIn dio2;
amirchaudhary 12:813e9e5f5ff6 78 InterruptIn dio3;
amirchaudhary 12:813e9e5f5ff6 79 InterruptIn dio4;
amirchaudhary 12:813e9e5f5ff6 80 DigitalIn dio5;
amirchaudhary 12:813e9e5f5ff6 81
amirchaudhary 12:813e9e5f5ff6 82 bool isRadioActive;
amirchaudhary 12:813e9e5f5ff6 83
amirchaudhary 12:813e9e5f5ff6 84 uint8_t boardConnected; //1 = SX1276MB1LAS; 0 = SX1276MB1MAS
amirchaudhary 12:813e9e5f5ff6 85
amirchaudhary 12:813e9e5f5ff6 86 uint8_t *rxtxBuffer;
amirchaudhary 12:813e9e5f5ff6 87
amirchaudhary 12:813e9e5f5ff6 88 /*!
amirchaudhary 12:813e9e5f5ff6 89 * Hardware DIO IRQ functions
amirchaudhary 12:813e9e5f5ff6 90 */
amirchaudhary 12:813e9e5f5ff6 91 DioIrqHandler *dioIrq;
amirchaudhary 12:813e9e5f5ff6 92
amirchaudhary 12:813e9e5f5ff6 93 /*!
amirchaudhary 12:813e9e5f5ff6 94 * Tx and Rx timers
amirchaudhary 12:813e9e5f5ff6 95 */
amirchaudhary 12:813e9e5f5ff6 96 Timeout txTimeoutTimer;
amirchaudhary 12:813e9e5f5ff6 97 Timeout rxTimeoutTimer;
amirchaudhary 12:813e9e5f5ff6 98 Timeout rxTimeoutSyncWord;
amirchaudhary 12:813e9e5f5ff6 99
amirchaudhary 12:813e9e5f5ff6 100 RadioSettings_t settings;
amirchaudhary 12:813e9e5f5ff6 101
amirchaudhary 12:813e9e5f5ff6 102 static const FskBandwidth_t FskBandwidths[];
amirchaudhary 12:813e9e5f5ff6 103 protected:
amirchaudhary 12:813e9e5f5ff6 104
amirchaudhary 12:813e9e5f5ff6 105 /*!
amirchaudhary 12:813e9e5f5ff6 106 * Performs the Rx chain calibration for LF and HF bands
amirchaudhary 12:813e9e5f5ff6 107 * \remark Must be called just after the reset so all registers are at their
amirchaudhary 12:813e9e5f5ff6 108 * default values
amirchaudhary 12:813e9e5f5ff6 109 */
amirchaudhary 12:813e9e5f5ff6 110 void RxChainCalibration( void );
amirchaudhary 12:813e9e5f5ff6 111
amirchaudhary 12:813e9e5f5ff6 112 public:
amirchaudhary 12:813e9e5f5ff6 113 SX1276( RadioEvents_t *events,
amirchaudhary 12:813e9e5f5ff6 114 PinName mosi, PinName miso, PinName sclk, PinName nss, PinName reset,
amirchaudhary 12:813e9e5f5ff6 115 PinName dio0, PinName dio1, PinName dio2, PinName dio3, PinName dio4, PinName dio5 );
amirchaudhary 12:813e9e5f5ff6 116 SX1276( RadioEvents_t *events );
amirchaudhary 12:813e9e5f5ff6 117 virtual ~SX1276( );
amirchaudhary 12:813e9e5f5ff6 118
amirchaudhary 12:813e9e5f5ff6 119 //-------------------------------------------------------------------------
amirchaudhary 12:813e9e5f5ff6 120 // Redefined Radio functions
amirchaudhary 12:813e9e5f5ff6 121 //-------------------------------------------------------------------------
amirchaudhary 12:813e9e5f5ff6 122 /*!
amirchaudhary 12:813e9e5f5ff6 123 * @brief Initializes the radio
amirchaudhary 12:813e9e5f5ff6 124 *
amirchaudhary 12:813e9e5f5ff6 125 * @param [IN] events Structure containing the driver callback functions
amirchaudhary 12:813e9e5f5ff6 126 */
amirchaudhary 12:813e9e5f5ff6 127 virtual void Init( RadioEvents_t *events );
amirchaudhary 12:813e9e5f5ff6 128 /*!
amirchaudhary 12:813e9e5f5ff6 129 * Return current radio status
amirchaudhary 12:813e9e5f5ff6 130 *
amirchaudhary 12:813e9e5f5ff6 131 * @param status Radio status. [RF_IDLE, RX_RUNNING, TX_RUNNING]
amirchaudhary 12:813e9e5f5ff6 132 */
amirchaudhary 12:813e9e5f5ff6 133 virtual RadioState GetStatus( void );
amirchaudhary 12:813e9e5f5ff6 134 /*!
amirchaudhary 12:813e9e5f5ff6 135 * @brief Configures the SX1276 with the given modem
amirchaudhary 12:813e9e5f5ff6 136 *
amirchaudhary 12:813e9e5f5ff6 137 * @param [IN] modem Modem to be used [0: FSK, 1: LoRa]
amirchaudhary 12:813e9e5f5ff6 138 */
amirchaudhary 12:813e9e5f5ff6 139 virtual void SetModem( RadioModems_t modem );
amirchaudhary 12:813e9e5f5ff6 140 /*!
amirchaudhary 12:813e9e5f5ff6 141 * @brief Sets the channel frequency
amirchaudhary 12:813e9e5f5ff6 142 *
amirchaudhary 12:813e9e5f5ff6 143 * @param [IN] freq Channel RF frequency
amirchaudhary 12:813e9e5f5ff6 144 */
amirchaudhary 12:813e9e5f5ff6 145 virtual void SetChannel( uint32_t freq );
amirchaudhary 12:813e9e5f5ff6 146 /*!
amirchaudhary 12:813e9e5f5ff6 147 * @brief Sets the channels configuration
amirchaudhary 12:813e9e5f5ff6 148 *
amirchaudhary 12:813e9e5f5ff6 149 * @param [IN] modem Radio modem to be used [0: FSK, 1: LoRa]
amirchaudhary 12:813e9e5f5ff6 150 * @param [IN] freq Channel RF frequency
amirchaudhary 12:813e9e5f5ff6 151 * @param [IN] rssiThresh RSSI threshold
amirchaudhary 12:813e9e5f5ff6 152 *
amirchaudhary 12:813e9e5f5ff6 153 * @retval isFree [true: Channel is free, false: Channel is not free]
amirchaudhary 12:813e9e5f5ff6 154 */
amirchaudhary 12:813e9e5f5ff6 155 virtual bool IsChannelFree( RadioModems_t modem, uint32_t freq, int16_t rssiThresh );
amirchaudhary 12:813e9e5f5ff6 156 /*!
amirchaudhary 12:813e9e5f5ff6 157 * @brief Generates a 32 bits random value based on the RSSI readings
amirchaudhary 12:813e9e5f5ff6 158 *
amirchaudhary 12:813e9e5f5ff6 159 * \remark This function sets the radio in LoRa modem mode and disables
amirchaudhary 12:813e9e5f5ff6 160 * all interrupts.
amirchaudhary 12:813e9e5f5ff6 161 * After calling this function either Radio.SetRxConfig or
amirchaudhary 12:813e9e5f5ff6 162 * Radio.SetTxConfig functions must be called.
amirchaudhary 12:813e9e5f5ff6 163 *
amirchaudhary 12:813e9e5f5ff6 164 * @retval randomValue 32 bits random value
amirchaudhary 12:813e9e5f5ff6 165 */
amirchaudhary 12:813e9e5f5ff6 166 virtual uint32_t Random( void );
amirchaudhary 12:813e9e5f5ff6 167 /*!
amirchaudhary 12:813e9e5f5ff6 168 * @brief Sets the reception parameters
amirchaudhary 12:813e9e5f5ff6 169 *
amirchaudhary 12:813e9e5f5ff6 170 * @param [IN] modem Radio modem to be used [0: FSK, 1: LoRa]
amirchaudhary 12:813e9e5f5ff6 171 * @param [IN] bandwidth Sets the bandwidth
amirchaudhary 12:813e9e5f5ff6 172 * FSK : >= 2600 and <= 250000 Hz
amirchaudhary 12:813e9e5f5ff6 173 * LoRa: [0: 125 kHz, 1: 250 kHz,
amirchaudhary 12:813e9e5f5ff6 174 * 2: 500 kHz, 3: Reserved]
amirchaudhary 12:813e9e5f5ff6 175 * @param [IN] datarate Sets the Datarate
amirchaudhary 12:813e9e5f5ff6 176 * FSK : 600..300000 bits/s
amirchaudhary 12:813e9e5f5ff6 177 * LoRa: [6: 64, 7: 128, 8: 256, 9: 512,
amirchaudhary 12:813e9e5f5ff6 178 * 10: 1024, 11: 2048, 12: 4096 chips]
amirchaudhary 12:813e9e5f5ff6 179 * @param [IN] coderate Sets the coding rate ( LoRa only )
amirchaudhary 12:813e9e5f5ff6 180 * FSK : N/A ( set to 0 )
amirchaudhary 12:813e9e5f5ff6 181 * LoRa: [1: 4/5, 2: 4/6, 3: 4/7, 4: 4/8]
amirchaudhary 12:813e9e5f5ff6 182 * @param [IN] bandwidthAfc Sets the AFC Bandwidth ( FSK only )
amirchaudhary 12:813e9e5f5ff6 183 * FSK : >= 2600 and <= 250000 Hz
amirchaudhary 12:813e9e5f5ff6 184 * LoRa: N/A ( set to 0 )
amirchaudhary 12:813e9e5f5ff6 185 * @param [IN] preambleLen Sets the Preamble length ( LoRa only )
amirchaudhary 12:813e9e5f5ff6 186 * FSK : N/A ( set to 0 )
amirchaudhary 12:813e9e5f5ff6 187 * LoRa: Length in symbols ( the hardware adds 4 more symbols )
amirchaudhary 12:813e9e5f5ff6 188 * @param [IN] symbTimeout Sets the RxSingle timeout value
amirchaudhary 12:813e9e5f5ff6 189 * FSK : timeout number of bytes
amirchaudhary 12:813e9e5f5ff6 190 * LoRa: timeout in symbols
amirchaudhary 12:813e9e5f5ff6 191 * @param [IN] fixLen Fixed length packets [0: variable, 1: fixed]
amirchaudhary 12:813e9e5f5ff6 192 * @param [IN] payloadLen Sets payload length when fixed lenght is used
amirchaudhary 12:813e9e5f5ff6 193 * @param [IN] crcOn Enables/Disables the CRC [0: OFF, 1: ON]
amirchaudhary 12:813e9e5f5ff6 194 * @param [IN] freqHopOn Enables disables the intra-packet frequency hopping [0: OFF, 1: ON] (LoRa only)
amirchaudhary 12:813e9e5f5ff6 195 * @param [IN] hopPeriod Number of symbols bewteen each hop (LoRa only)
amirchaudhary 12:813e9e5f5ff6 196 * @param [IN] iqInverted Inverts IQ signals ( LoRa only )
amirchaudhary 12:813e9e5f5ff6 197 * FSK : N/A ( set to 0 )
amirchaudhary 12:813e9e5f5ff6 198 * LoRa: [0: not inverted, 1: inverted]
amirchaudhary 12:813e9e5f5ff6 199 * @param [IN] rxContinuous Sets the reception in continuous mode
amirchaudhary 12:813e9e5f5ff6 200 * [false: single mode, true: continuous mode]
amirchaudhary 12:813e9e5f5ff6 201 */
amirchaudhary 12:813e9e5f5ff6 202 virtual void SetRxConfig ( RadioModems_t modem, uint32_t bandwidth,
amirchaudhary 12:813e9e5f5ff6 203 uint32_t datarate, uint8_t coderate,
amirchaudhary 12:813e9e5f5ff6 204 uint32_t bandwidthAfc, uint16_t preambleLen,
amirchaudhary 12:813e9e5f5ff6 205 uint16_t symbTimeout, bool fixLen,
amirchaudhary 12:813e9e5f5ff6 206 uint8_t payloadLen,
amirchaudhary 12:813e9e5f5ff6 207 bool crcOn, bool freqHopOn, uint8_t hopPeriod,
amirchaudhary 12:813e9e5f5ff6 208 bool iqInverted, bool rxContinuous );
amirchaudhary 12:813e9e5f5ff6 209 /*!
amirchaudhary 12:813e9e5f5ff6 210 * @brief Sets the transmission parameters
amirchaudhary 12:813e9e5f5ff6 211 *
amirchaudhary 12:813e9e5f5ff6 212 * @param [IN] modem Radio modem to be used [0: FSK, 1: LoRa]
amirchaudhary 12:813e9e5f5ff6 213 * @param [IN] power Sets the output power [dBm]
amirchaudhary 12:813e9e5f5ff6 214 * @param [IN] fdev Sets the frequency deviation ( FSK only )
amirchaudhary 12:813e9e5f5ff6 215 * FSK : [Hz]
amirchaudhary 12:813e9e5f5ff6 216 * LoRa: 0
amirchaudhary 12:813e9e5f5ff6 217 * @param [IN] bandwidth Sets the bandwidth ( LoRa only )
amirchaudhary 12:813e9e5f5ff6 218 * FSK : 0
amirchaudhary 12:813e9e5f5ff6 219 * LoRa: [0: 125 kHz, 1: 250 kHz,
amirchaudhary 12:813e9e5f5ff6 220 * 2: 500 kHz, 3: Reserved]
amirchaudhary 12:813e9e5f5ff6 221 * @param [IN] datarate Sets the Datarate
amirchaudhary 12:813e9e5f5ff6 222 * FSK : 600..300000 bits/s
amirchaudhary 12:813e9e5f5ff6 223 * LoRa: [6: 64, 7: 128, 8: 256, 9: 512,
amirchaudhary 12:813e9e5f5ff6 224 * 10: 1024, 11: 2048, 12: 4096 chips]
amirchaudhary 12:813e9e5f5ff6 225 * @param [IN] coderate Sets the coding rate ( LoRa only )
amirchaudhary 12:813e9e5f5ff6 226 * FSK : N/A ( set to 0 )
amirchaudhary 12:813e9e5f5ff6 227 * LoRa: [1: 4/5, 2: 4/6, 3: 4/7, 4: 4/8]
amirchaudhary 12:813e9e5f5ff6 228 * @param [IN] preambleLen Sets the preamble length
amirchaudhary 12:813e9e5f5ff6 229 * @param [IN] fixLen Fixed length packets [0: variable, 1: fixed]
amirchaudhary 12:813e9e5f5ff6 230 * @param [IN] crcOn Enables disables the CRC [0: OFF, 1: ON]
amirchaudhary 12:813e9e5f5ff6 231 * @param [IN] freqHopOn Enables disables the intra-packet frequency hopping [0: OFF, 1: ON] (LoRa only)
amirchaudhary 12:813e9e5f5ff6 232 * @param [IN] hopPeriod Number of symbols bewteen each hop (LoRa only)
amirchaudhary 12:813e9e5f5ff6 233 * @param [IN] iqInverted Inverts IQ signals ( LoRa only )
amirchaudhary 12:813e9e5f5ff6 234 * FSK : N/A ( set to 0 )
amirchaudhary 12:813e9e5f5ff6 235 * LoRa: [0: not inverted, 1: inverted]
amirchaudhary 12:813e9e5f5ff6 236 * @param [IN] timeout Transmission timeout [ms]
amirchaudhary 12:813e9e5f5ff6 237 */
amirchaudhary 12:813e9e5f5ff6 238 virtual void SetTxConfig( RadioModems_t modem, int8_t power, uint32_t fdev,
amirchaudhary 12:813e9e5f5ff6 239 uint32_t bandwidth, uint32_t datarate,
amirchaudhary 12:813e9e5f5ff6 240 uint8_t coderate, uint16_t preambleLen,
amirchaudhary 12:813e9e5f5ff6 241 bool fixLen, bool crcOn, bool freqHopOn,
amirchaudhary 12:813e9e5f5ff6 242 uint8_t hopPeriod, bool iqInverted, uint32_t timeout );
amirchaudhary 12:813e9e5f5ff6 243 /*!
amirchaudhary 12:813e9e5f5ff6 244 * @brief Checks if the given RF frequency is supported by the hardware
amirchaudhary 12:813e9e5f5ff6 245 *
amirchaudhary 12:813e9e5f5ff6 246 * @param [IN] frequency RF frequency to be checked
amirchaudhary 12:813e9e5f5ff6 247 * @retval isSupported [true: supported, false: unsupported]
amirchaudhary 12:813e9e5f5ff6 248 */
amirchaudhary 12:813e9e5f5ff6 249 virtual bool CheckRfFrequency( uint32_t frequency ) = 0;
amirchaudhary 12:813e9e5f5ff6 250 /*!
amirchaudhary 12:813e9e5f5ff6 251 * @brief Computes the packet time on air for the given payload
amirchaudhary 12:813e9e5f5ff6 252 *
amirchaudhary 12:813e9e5f5ff6 253 * \Remark Can only be called once SetRxConfig or SetTxConfig have been called
amirchaudhary 12:813e9e5f5ff6 254 *
amirchaudhary 12:813e9e5f5ff6 255 * @param [IN] modem Radio modem to be used [0: FSK, 1: LoRa]
amirchaudhary 12:813e9e5f5ff6 256 * @param [IN] pktLen Packet payload length
amirchaudhary 12:813e9e5f5ff6 257 *
amirchaudhary 12:813e9e5f5ff6 258 * @retval airTime Computed airTime for the given packet payload length
amirchaudhary 12:813e9e5f5ff6 259 */
amirchaudhary 12:813e9e5f5ff6 260 virtual uint32_t TimeOnAir ( RadioModems_t modem, uint8_t pktLen );
amirchaudhary 12:813e9e5f5ff6 261 /*!
amirchaudhary 12:813e9e5f5ff6 262 * @brief Sends the buffer of size. Prepares the packet to be sent and sets
amirchaudhary 12:813e9e5f5ff6 263 * the radio in transmission
amirchaudhary 12:813e9e5f5ff6 264 *
amirchaudhary 12:813e9e5f5ff6 265 * @param [IN]: buffer Buffer pointer
amirchaudhary 12:813e9e5f5ff6 266 * @param [IN]: size Buffer size
amirchaudhary 12:813e9e5f5ff6 267 */
amirchaudhary 12:813e9e5f5ff6 268 virtual void Send( uint8_t *buffer, uint8_t size );
amirchaudhary 12:813e9e5f5ff6 269 /*!
amirchaudhary 12:813e9e5f5ff6 270 * @brief Sets the radio in sleep mode
amirchaudhary 12:813e9e5f5ff6 271 */
amirchaudhary 12:813e9e5f5ff6 272 virtual void Sleep( void );
amirchaudhary 12:813e9e5f5ff6 273 /*!
amirchaudhary 12:813e9e5f5ff6 274 * @brief Sets the radio in standby mode
amirchaudhary 12:813e9e5f5ff6 275 */
amirchaudhary 12:813e9e5f5ff6 276 virtual void Standby( void );
amirchaudhary 12:813e9e5f5ff6 277 /*!
amirchaudhary 12:813e9e5f5ff6 278 * @brief Sets the radio in CAD mode
amirchaudhary 12:813e9e5f5ff6 279 */
amirchaudhary 12:813e9e5f5ff6 280 virtual void StartCad( void );
amirchaudhary 12:813e9e5f5ff6 281 /*!
amirchaudhary 12:813e9e5f5ff6 282 * @brief Sets the radio in reception mode for the given time
amirchaudhary 12:813e9e5f5ff6 283 * @param [IN] timeout Reception timeout [ms]
amirchaudhary 12:813e9e5f5ff6 284 * [0: continuous, others timeout]
amirchaudhary 12:813e9e5f5ff6 285 */
amirchaudhary 12:813e9e5f5ff6 286 virtual void Rx( uint32_t timeout );
amirchaudhary 12:813e9e5f5ff6 287 /*!
amirchaudhary 12:813e9e5f5ff6 288 * @brief Sets the radio in transmission mode for the given time
amirchaudhary 12:813e9e5f5ff6 289 * @param [IN] timeout Transmission timeout [ms]
amirchaudhary 12:813e9e5f5ff6 290 * [0: continuous, others timeout]
amirchaudhary 12:813e9e5f5ff6 291 */
amirchaudhary 12:813e9e5f5ff6 292 virtual void Tx( uint32_t timeout );
amirchaudhary 12:813e9e5f5ff6 293 /*!
amirchaudhary 12:813e9e5f5ff6 294 * @brief Sets the radio in continuous wave transmission mode
amirchaudhary 12:813e9e5f5ff6 295 *
amirchaudhary 12:813e9e5f5ff6 296 * @param [IN]: freq Channel RF frequency
amirchaudhary 12:813e9e5f5ff6 297 * @param [IN]: power Sets the output power [dBm]
amirchaudhary 12:813e9e5f5ff6 298 * @param [IN]: time Transmission mode timeout [s]
amirchaudhary 12:813e9e5f5ff6 299 */
amirchaudhary 12:813e9e5f5ff6 300 virtual void SetTxContinuousWave( uint32_t freq, int8_t power, uint16_t time );
amirchaudhary 12:813e9e5f5ff6 301 /*!
amirchaudhary 12:813e9e5f5ff6 302 * @brief Reads the current RSSI value
amirchaudhary 12:813e9e5f5ff6 303 *
amirchaudhary 12:813e9e5f5ff6 304 * @retval rssiValue Current RSSI value in [dBm]
amirchaudhary 12:813e9e5f5ff6 305 */
amirchaudhary 12:813e9e5f5ff6 306 virtual int16_t GetRssi ( RadioModems_t modem );
amirchaudhary 12:813e9e5f5ff6 307 /*!
amirchaudhary 12:813e9e5f5ff6 308 * @brief Writes the radio register at the specified address
amirchaudhary 12:813e9e5f5ff6 309 *
amirchaudhary 12:813e9e5f5ff6 310 * @param [IN]: addr Register address
amirchaudhary 12:813e9e5f5ff6 311 * @param [IN]: data New register value
amirchaudhary 12:813e9e5f5ff6 312 */
amirchaudhary 12:813e9e5f5ff6 313 virtual void Write ( uint8_t addr, uint8_t data ) = 0;
amirchaudhary 12:813e9e5f5ff6 314 /*!
amirchaudhary 12:813e9e5f5ff6 315 * @brief Reads the radio register at the specified address
amirchaudhary 12:813e9e5f5ff6 316 *
amirchaudhary 12:813e9e5f5ff6 317 * @param [IN]: addr Register address
amirchaudhary 12:813e9e5f5ff6 318 * @retval data Register value
amirchaudhary 12:813e9e5f5ff6 319 */
amirchaudhary 12:813e9e5f5ff6 320 virtual uint8_t Read ( uint8_t addr ) = 0;
amirchaudhary 12:813e9e5f5ff6 321 /*!
amirchaudhary 12:813e9e5f5ff6 322 * @brief Writes multiple radio registers starting at address
amirchaudhary 12:813e9e5f5ff6 323 *
amirchaudhary 12:813e9e5f5ff6 324 * @param [IN] addr First Radio register address
amirchaudhary 12:813e9e5f5ff6 325 * @param [IN] buffer Buffer containing the new register's values
amirchaudhary 12:813e9e5f5ff6 326 * @param [IN] size Number of registers to be written
amirchaudhary 12:813e9e5f5ff6 327 */
amirchaudhary 12:813e9e5f5ff6 328 virtual void Write( uint8_t addr, uint8_t *buffer, uint8_t size ) = 0;
amirchaudhary 12:813e9e5f5ff6 329 /*!
amirchaudhary 12:813e9e5f5ff6 330 * @brief Reads multiple radio registers starting at address
amirchaudhary 12:813e9e5f5ff6 331 *
amirchaudhary 12:813e9e5f5ff6 332 * @param [IN] addr First Radio register address
amirchaudhary 12:813e9e5f5ff6 333 * @param [OUT] buffer Buffer where to copy the registers data
amirchaudhary 12:813e9e5f5ff6 334 * @param [IN] size Number of registers to be read
amirchaudhary 12:813e9e5f5ff6 335 */
amirchaudhary 12:813e9e5f5ff6 336 virtual void Read ( uint8_t addr, uint8_t *buffer, uint8_t size ) = 0;
amirchaudhary 12:813e9e5f5ff6 337 /*!
amirchaudhary 12:813e9e5f5ff6 338 * @brief Writes the buffer contents to the SX1276 FIFO
amirchaudhary 12:813e9e5f5ff6 339 *
amirchaudhary 12:813e9e5f5ff6 340 * @param [IN] buffer Buffer containing data to be put on the FIFO.
amirchaudhary 12:813e9e5f5ff6 341 * @param [IN] size Number of bytes to be written to the FIFO
amirchaudhary 12:813e9e5f5ff6 342 */
amirchaudhary 12:813e9e5f5ff6 343 virtual void WriteFifo( uint8_t *buffer, uint8_t size ) = 0;
amirchaudhary 12:813e9e5f5ff6 344 /*!
amirchaudhary 12:813e9e5f5ff6 345 * @brief Reads the contents of the SX1276 FIFO
amirchaudhary 12:813e9e5f5ff6 346 *
amirchaudhary 12:813e9e5f5ff6 347 * @param [OUT] buffer Buffer where to copy the FIFO read data.
amirchaudhary 12:813e9e5f5ff6 348 * @param [IN] size Number of bytes to be read from the FIFO
amirchaudhary 12:813e9e5f5ff6 349 */
amirchaudhary 12:813e9e5f5ff6 350 virtual void ReadFifo( uint8_t *buffer, uint8_t size ) = 0;
amirchaudhary 12:813e9e5f5ff6 351 /*!
amirchaudhary 12:813e9e5f5ff6 352 * @brief Resets the SX1276
amirchaudhary 12:813e9e5f5ff6 353 */
amirchaudhary 12:813e9e5f5ff6 354 virtual void Reset( void ) = 0;
amirchaudhary 12:813e9e5f5ff6 355
amirchaudhary 12:813e9e5f5ff6 356 /*!
amirchaudhary 12:813e9e5f5ff6 357 * @brief Sets the maximum payload length.
amirchaudhary 12:813e9e5f5ff6 358 *
amirchaudhary 12:813e9e5f5ff6 359 * @param [IN] modem Radio modem to be used [0: FSK, 1: LoRa]
amirchaudhary 12:813e9e5f5ff6 360 * @param [IN] max Maximum payload length in bytes
amirchaudhary 12:813e9e5f5ff6 361 */
amirchaudhary 12:813e9e5f5ff6 362 virtual void SetMaxPayloadLength( RadioModems_t modem, uint8_t max );
amirchaudhary 12:813e9e5f5ff6 363
amirchaudhary 12:813e9e5f5ff6 364 /*!
amirchaudhary 12:813e9e5f5ff6 365 * \brief Sets the network to public or private. Updates the sync byte.
amirchaudhary 12:813e9e5f5ff6 366 *
amirchaudhary 12:813e9e5f5ff6 367 * \remark Applies to LoRa modem only
amirchaudhary 12:813e9e5f5ff6 368 *
amirchaudhary 12:813e9e5f5ff6 369 * \param [IN] enable if true, it enables a public network
amirchaudhary 12:813e9e5f5ff6 370 */
amirchaudhary 12:813e9e5f5ff6 371 virtual void SetPublicNetwork( bool enable );
amirchaudhary 12:813e9e5f5ff6 372
amirchaudhary 12:813e9e5f5ff6 373 //-------------------------------------------------------------------------
amirchaudhary 12:813e9e5f5ff6 374 // Board relative functions
amirchaudhary 12:813e9e5f5ff6 375 //-------------------------------------------------------------------------
amirchaudhary 12:813e9e5f5ff6 376
amirchaudhary 12:813e9e5f5ff6 377 protected:
amirchaudhary 12:813e9e5f5ff6 378 /*!
amirchaudhary 12:813e9e5f5ff6 379 * @brief Initializes the radio I/Os pins interface
amirchaudhary 12:813e9e5f5ff6 380 */
amirchaudhary 12:813e9e5f5ff6 381 virtual void IoInit( void ) = 0;
amirchaudhary 12:813e9e5f5ff6 382
amirchaudhary 12:813e9e5f5ff6 383 /*!
amirchaudhary 12:813e9e5f5ff6 384 * @brief Initializes the radio registers
amirchaudhary 12:813e9e5f5ff6 385 */
amirchaudhary 12:813e9e5f5ff6 386 virtual void RadioRegistersInit( ) = 0;
amirchaudhary 12:813e9e5f5ff6 387
amirchaudhary 12:813e9e5f5ff6 388 /*!
amirchaudhary 12:813e9e5f5ff6 389 * @brief Initializes the radio SPI
amirchaudhary 12:813e9e5f5ff6 390 */
amirchaudhary 12:813e9e5f5ff6 391 virtual void SpiInit( void ) = 0;
amirchaudhary 12:813e9e5f5ff6 392
amirchaudhary 12:813e9e5f5ff6 393 /*!
amirchaudhary 12:813e9e5f5ff6 394 * @brief Initializes DIO IRQ handlers
amirchaudhary 12:813e9e5f5ff6 395 *
amirchaudhary 12:813e9e5f5ff6 396 * @param [IN] irqHandlers Array containing the IRQ callback functions
amirchaudhary 12:813e9e5f5ff6 397 */
amirchaudhary 12:813e9e5f5ff6 398 virtual void IoIrqInit( DioIrqHandler *irqHandlers ) = 0;
amirchaudhary 12:813e9e5f5ff6 399
amirchaudhary 12:813e9e5f5ff6 400 /*!
amirchaudhary 12:813e9e5f5ff6 401 * @brief De-initializes the radio I/Os pins interface.
amirchaudhary 12:813e9e5f5ff6 402 *
amirchaudhary 12:813e9e5f5ff6 403 * \remark Useful when going in MCU lowpower modes
amirchaudhary 12:813e9e5f5ff6 404 */
amirchaudhary 12:813e9e5f5ff6 405 virtual void IoDeInit( void ) = 0;
amirchaudhary 12:813e9e5f5ff6 406
amirchaudhary 12:813e9e5f5ff6 407 /*!
amirchaudhary 12:813e9e5f5ff6 408 * @brief Sets the radio output power.
amirchaudhary 12:813e9e5f5ff6 409 *
amirchaudhary 12:813e9e5f5ff6 410 * @param [IN] power Sets the RF output power
amirchaudhary 12:813e9e5f5ff6 411 */
amirchaudhary 12:813e9e5f5ff6 412 virtual void SetRfTxPower( int8_t power ) = 0;
amirchaudhary 12:813e9e5f5ff6 413
amirchaudhary 12:813e9e5f5ff6 414 /*!
amirchaudhary 12:813e9e5f5ff6 415 * @brief Gets the board PA selection configuration
amirchaudhary 12:813e9e5f5ff6 416 *
amirchaudhary 12:813e9e5f5ff6 417 * @param [IN] channel Channel frequency in Hz
amirchaudhary 12:813e9e5f5ff6 418 * @retval PaSelect RegPaConfig PaSelect value
amirchaudhary 12:813e9e5f5ff6 419 */
amirchaudhary 12:813e9e5f5ff6 420 virtual uint8_t GetPaSelect( uint32_t channel ) = 0;
amirchaudhary 12:813e9e5f5ff6 421
amirchaudhary 12:813e9e5f5ff6 422 /*!
amirchaudhary 12:813e9e5f5ff6 423 * @brief Set the RF Switch I/Os pins in Low Power mode
amirchaudhary 12:813e9e5f5ff6 424 *
amirchaudhary 12:813e9e5f5ff6 425 * @param [IN] status enable or disable
amirchaudhary 12:813e9e5f5ff6 426 */
amirchaudhary 12:813e9e5f5ff6 427 virtual void SetAntSwLowPower( bool status ) = 0;
amirchaudhary 12:813e9e5f5ff6 428
amirchaudhary 12:813e9e5f5ff6 429 /*!
amirchaudhary 12:813e9e5f5ff6 430 * @brief Initializes the RF Switch I/Os pins interface
amirchaudhary 12:813e9e5f5ff6 431 */
amirchaudhary 12:813e9e5f5ff6 432 virtual void AntSwInit( void ) = 0;
amirchaudhary 12:813e9e5f5ff6 433
amirchaudhary 12:813e9e5f5ff6 434 /*!
amirchaudhary 12:813e9e5f5ff6 435 * @brief De-initializes the RF Switch I/Os pins interface
amirchaudhary 12:813e9e5f5ff6 436 *
amirchaudhary 12:813e9e5f5ff6 437 * \remark Needed to decrease the power consumption in MCU lowpower modes
amirchaudhary 12:813e9e5f5ff6 438 */
amirchaudhary 12:813e9e5f5ff6 439 virtual void AntSwDeInit( void ) = 0;
amirchaudhary 12:813e9e5f5ff6 440
amirchaudhary 12:813e9e5f5ff6 441 /*!
amirchaudhary 12:813e9e5f5ff6 442 * @brief Controls the antenna switch if necessary.
amirchaudhary 12:813e9e5f5ff6 443 *
amirchaudhary 12:813e9e5f5ff6 444 * \remark see errata note
amirchaudhary 12:813e9e5f5ff6 445 *
amirchaudhary 12:813e9e5f5ff6 446 * @param [IN] opMode Current radio operating mode
amirchaudhary 12:813e9e5f5ff6 447 */
amirchaudhary 12:813e9e5f5ff6 448 virtual void SetAntSw( uint8_t opMode ) = 0;
amirchaudhary 12:813e9e5f5ff6 449 protected:
amirchaudhary 12:813e9e5f5ff6 450
amirchaudhary 12:813e9e5f5ff6 451 /*!
amirchaudhary 12:813e9e5f5ff6 452 * @brief Sets the SX1276 operating mode
amirchaudhary 12:813e9e5f5ff6 453 *
amirchaudhary 12:813e9e5f5ff6 454 * @param [IN] opMode New operating mode
amirchaudhary 12:813e9e5f5ff6 455 */
amirchaudhary 12:813e9e5f5ff6 456 virtual void SetOpMode( uint8_t opMode );
amirchaudhary 12:813e9e5f5ff6 457
amirchaudhary 12:813e9e5f5ff6 458 /*
amirchaudhary 12:813e9e5f5ff6 459 * SX1276 DIO IRQ callback functions prototype
amirchaudhary 12:813e9e5f5ff6 460 */
amirchaudhary 12:813e9e5f5ff6 461
amirchaudhary 12:813e9e5f5ff6 462 /*!
amirchaudhary 12:813e9e5f5ff6 463 * @brief DIO 0 IRQ callback
amirchaudhary 12:813e9e5f5ff6 464 */
amirchaudhary 12:813e9e5f5ff6 465 virtual void OnDio0Irq( void );
amirchaudhary 12:813e9e5f5ff6 466
amirchaudhary 12:813e9e5f5ff6 467 /*!
amirchaudhary 12:813e9e5f5ff6 468 * @brief DIO 1 IRQ callback
amirchaudhary 12:813e9e5f5ff6 469 */
amirchaudhary 12:813e9e5f5ff6 470 virtual void OnDio1Irq( void );
amirchaudhary 12:813e9e5f5ff6 471
amirchaudhary 12:813e9e5f5ff6 472 /*!
amirchaudhary 12:813e9e5f5ff6 473 * @brief DIO 2 IRQ callback
amirchaudhary 12:813e9e5f5ff6 474 */
amirchaudhary 12:813e9e5f5ff6 475 virtual void OnDio2Irq( void );
amirchaudhary 12:813e9e5f5ff6 476
amirchaudhary 12:813e9e5f5ff6 477 /*!
amirchaudhary 12:813e9e5f5ff6 478 * @brief DIO 3 IRQ callback
amirchaudhary 12:813e9e5f5ff6 479 */
amirchaudhary 12:813e9e5f5ff6 480 virtual void OnDio3Irq( void );
amirchaudhary 12:813e9e5f5ff6 481
amirchaudhary 12:813e9e5f5ff6 482 /*!
amirchaudhary 12:813e9e5f5ff6 483 * @brief DIO 4 IRQ callback
amirchaudhary 12:813e9e5f5ff6 484 */
amirchaudhary 12:813e9e5f5ff6 485 virtual void OnDio4Irq( void );
amirchaudhary 12:813e9e5f5ff6 486
amirchaudhary 12:813e9e5f5ff6 487 /*!
amirchaudhary 12:813e9e5f5ff6 488 * @brief DIO 5 IRQ callback
amirchaudhary 12:813e9e5f5ff6 489 */
amirchaudhary 12:813e9e5f5ff6 490 virtual void OnDio5Irq( void );
amirchaudhary 12:813e9e5f5ff6 491
amirchaudhary 12:813e9e5f5ff6 492 /*!
amirchaudhary 12:813e9e5f5ff6 493 * @brief Tx & Rx timeout timer callback
amirchaudhary 12:813e9e5f5ff6 494 */
amirchaudhary 12:813e9e5f5ff6 495 virtual void OnTimeoutIrq( void );
amirchaudhary 12:813e9e5f5ff6 496
amirchaudhary 12:813e9e5f5ff6 497 /*!
amirchaudhary 12:813e9e5f5ff6 498 * Returns the known FSK bandwidth registers value
amirchaudhary 12:813e9e5f5ff6 499 *
amirchaudhary 12:813e9e5f5ff6 500 * \param [IN] bandwidth Bandwidth value in Hz
amirchaudhary 12:813e9e5f5ff6 501 * \retval regValue Bandwidth register value.
amirchaudhary 12:813e9e5f5ff6 502 */
amirchaudhary 12:813e9e5f5ff6 503 static uint8_t GetFskBandwidthRegValue( uint32_t bandwidth );
amirchaudhary 12:813e9e5f5ff6 504 };
amirchaudhary 12:813e9e5f5ff6 505
amirchaudhary 12:813e9e5f5ff6 506 #endif // __SX1276_H__