Ward Mattar / Mbed 2 deprecated Forumla_Nucleo_Reader

Code for Technion Formula car sensors reader

Dependencies:   mbed Buffer FATFileSystem

Fork of SX1272PingPong by Semtech

This is code is part of a Technion course project in advanced IoT, implementing a device to read and transmit sensors data from a Formula racing car built by students at Technion - Israel Institute of Technology.

How to install

  • Create an account on Mbed: https://os.mbed.com/account/signup/
  • Import project into Compiler
  • In the Program Workspace select "Formula_Nucleo_Reader"
  • Select a Platform like so:
  1. Click button at top-left
  2. Add Board
  3. Search "NUCLEO F103RB" and then "Add to your Mbed Compiler"
  • Finally click "Compile", if the build was successful, the binary would download automatically
  • To install it on device simply plug it in to a PC, open device drive and drag then drop binary file in it

SX1272Lib/sx1272/sx1272.h@15:2e0d977dbb31, 2018-05-17 (annotated)

Committer:
wardm
Date:
Thu May 17 20:37:41 2018 +0000
Revision:
15:2e0d977dbb31
V1.0.0

Who changed what in which revision?

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