Code for Technion Formula car sensors reader
Dependencies: mbed Buffer FATFileSystem
Fork of SX1272PingPong by
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:
- Click button at top-left
- Add Board
- 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/radio/radio.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?
User | Revision | Line number | New 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: Interface for the radios, contains the main functions that a radio needs, and 5 callback functions |
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 __RADIO_H__ |
wardm | 15:2e0d977dbb31 | 16 | #define __RADIO_H__ |
wardm | 15:2e0d977dbb31 | 17 | |
wardm | 15:2e0d977dbb31 | 18 | #include "mbed.h" |
wardm | 15:2e0d977dbb31 | 19 | |
wardm | 15:2e0d977dbb31 | 20 | #include "./enums/enums.h" |
wardm | 15:2e0d977dbb31 | 21 | |
wardm | 15:2e0d977dbb31 | 22 | /*! |
wardm | 15:2e0d977dbb31 | 23 | * @brief Radio driver callback functions |
wardm | 15:2e0d977dbb31 | 24 | */ |
wardm | 15:2e0d977dbb31 | 25 | typedef struct |
wardm | 15:2e0d977dbb31 | 26 | { |
wardm | 15:2e0d977dbb31 | 27 | /*! |
wardm | 15:2e0d977dbb31 | 28 | * @brief Tx Done callback prototype. |
wardm | 15:2e0d977dbb31 | 29 | */ |
wardm | 15:2e0d977dbb31 | 30 | void ( *TxDone )( void ); |
wardm | 15:2e0d977dbb31 | 31 | /*! |
wardm | 15:2e0d977dbb31 | 32 | * @brief Tx Timeout callback prototype. |
wardm | 15:2e0d977dbb31 | 33 | */ |
wardm | 15:2e0d977dbb31 | 34 | void ( *TxTimeout )( void ); |
wardm | 15:2e0d977dbb31 | 35 | /*! |
wardm | 15:2e0d977dbb31 | 36 | * @brief Rx Done callback prototype. |
wardm | 15:2e0d977dbb31 | 37 | * |
wardm | 15:2e0d977dbb31 | 38 | * @param [IN] payload Received buffer pointer |
wardm | 15:2e0d977dbb31 | 39 | * @param [IN] size Received buffer size |
wardm | 15:2e0d977dbb31 | 40 | * @param [IN] rssi RSSI value computed while receiving the frame [dBm] |
wardm | 15:2e0d977dbb31 | 41 | * @param [IN] snr Raw SNR value given by the radio hardware |
wardm | 15:2e0d977dbb31 | 42 | * FSK : N/A ( set to 0 ) |
wardm | 15:2e0d977dbb31 | 43 | * LoRa: SNR value in dB |
wardm | 15:2e0d977dbb31 | 44 | */ |
wardm | 15:2e0d977dbb31 | 45 | void ( *RxDone )( uint8_t *payload, uint16_t size, int16_t rssi, int8_t snr ); |
wardm | 15:2e0d977dbb31 | 46 | /*! |
wardm | 15:2e0d977dbb31 | 47 | * @brief Rx Timeout callback prototype. |
wardm | 15:2e0d977dbb31 | 48 | */ |
wardm | 15:2e0d977dbb31 | 49 | void ( *RxTimeout )( void ); |
wardm | 15:2e0d977dbb31 | 50 | /*! |
wardm | 15:2e0d977dbb31 | 51 | * @brief Rx Error callback prototype. |
wardm | 15:2e0d977dbb31 | 52 | */ |
wardm | 15:2e0d977dbb31 | 53 | void ( *RxError )( void ); |
wardm | 15:2e0d977dbb31 | 54 | /*! |
wardm | 15:2e0d977dbb31 | 55 | * \brief FHSS Change Channel callback prototype. |
wardm | 15:2e0d977dbb31 | 56 | * |
wardm | 15:2e0d977dbb31 | 57 | * \param [IN] currentChannel Index number of the current channel |
wardm | 15:2e0d977dbb31 | 58 | */ |
wardm | 15:2e0d977dbb31 | 59 | void ( *FhssChangeChannel )( uint8_t currentChannel ); |
wardm | 15:2e0d977dbb31 | 60 | /*! |
wardm | 15:2e0d977dbb31 | 61 | * @brief CAD Done callback prototype. |
wardm | 15:2e0d977dbb31 | 62 | * |
wardm | 15:2e0d977dbb31 | 63 | * @param [IN] channelDetected Channel Activity detected during the CAD |
wardm | 15:2e0d977dbb31 | 64 | */ |
wardm | 15:2e0d977dbb31 | 65 | void ( *CadDone ) ( bool channelActivityDetected ); |
wardm | 15:2e0d977dbb31 | 66 | }RadioEvents_t; |
wardm | 15:2e0d977dbb31 | 67 | |
wardm | 15:2e0d977dbb31 | 68 | /*! |
wardm | 15:2e0d977dbb31 | 69 | * Interface for the radios, contains the main functions that a radio needs, and 5 callback functions |
wardm | 15:2e0d977dbb31 | 70 | */ |
wardm | 15:2e0d977dbb31 | 71 | class Radio |
wardm | 15:2e0d977dbb31 | 72 | { |
wardm | 15:2e0d977dbb31 | 73 | protected: |
wardm | 15:2e0d977dbb31 | 74 | RadioEvents_t* RadioEvents; |
wardm | 15:2e0d977dbb31 | 75 | |
wardm | 15:2e0d977dbb31 | 76 | public: |
wardm | 15:2e0d977dbb31 | 77 | //------------------------------------------------------------------------- |
wardm | 15:2e0d977dbb31 | 78 | // Constructor |
wardm | 15:2e0d977dbb31 | 79 | //------------------------------------------------------------------------- |
wardm | 15:2e0d977dbb31 | 80 | /*! |
wardm | 15:2e0d977dbb31 | 81 | * @brief Constructor of the radio object, the parameters are the callback functions described in the header. |
wardm | 15:2e0d977dbb31 | 82 | * |
wardm | 15:2e0d977dbb31 | 83 | * @param [IN] events Structure containing the driver callback functions |
wardm | 15:2e0d977dbb31 | 84 | */ |
wardm | 15:2e0d977dbb31 | 85 | Radio( RadioEvents_t *events ); |
wardm | 15:2e0d977dbb31 | 86 | virtual ~Radio( ) {}; |
wardm | 15:2e0d977dbb31 | 87 | |
wardm | 15:2e0d977dbb31 | 88 | //------------------------------------------------------------------------- |
wardm | 15:2e0d977dbb31 | 89 | // Pure virtual functions |
wardm | 15:2e0d977dbb31 | 90 | //------------------------------------------------------------------------- |
wardm | 15:2e0d977dbb31 | 91 | /*! |
wardm | 15:2e0d977dbb31 | 92 | * @brief Initializes the radio |
wardm | 15:2e0d977dbb31 | 93 | * |
wardm | 15:2e0d977dbb31 | 94 | * @param [IN] events Structure containing the driver callback functions |
wardm | 15:2e0d977dbb31 | 95 | */ |
wardm | 15:2e0d977dbb31 | 96 | virtual void Init( RadioEvents_t *events ) = 0; |
wardm | 15:2e0d977dbb31 | 97 | /*! |
wardm | 15:2e0d977dbb31 | 98 | * @brief Return current radio status |
wardm | 15:2e0d977dbb31 | 99 | * |
wardm | 15:2e0d977dbb31 | 100 | * @param status Radio status.[RF_IDLE, RF_RX_RUNNING, RF_TX_RUNNING] |
wardm | 15:2e0d977dbb31 | 101 | */ |
wardm | 15:2e0d977dbb31 | 102 | virtual RadioState GetStatus( void ) = 0; |
wardm | 15:2e0d977dbb31 | 103 | /*! |
wardm | 15:2e0d977dbb31 | 104 | * @brief Configures the radio with the given modem |
wardm | 15:2e0d977dbb31 | 105 | * |
wardm | 15:2e0d977dbb31 | 106 | * @param [IN] modem Modem to be used [0: FSK, 1: LoRa] |
wardm | 15:2e0d977dbb31 | 107 | */ |
wardm | 15:2e0d977dbb31 | 108 | virtual void SetModem( RadioModems_t modem ) = 0; |
wardm | 15:2e0d977dbb31 | 109 | /*! |
wardm | 15:2e0d977dbb31 | 110 | * @brief Sets the channel frequency |
wardm | 15:2e0d977dbb31 | 111 | * |
wardm | 15:2e0d977dbb31 | 112 | * @param [IN] freq Channel RF frequency |
wardm | 15:2e0d977dbb31 | 113 | */ |
wardm | 15:2e0d977dbb31 | 114 | virtual void SetChannel( uint32_t freq ) = 0; |
wardm | 15:2e0d977dbb31 | 115 | /*! |
wardm | 15:2e0d977dbb31 | 116 | * @brief Sets the channels configuration |
wardm | 15:2e0d977dbb31 | 117 | * |
wardm | 15:2e0d977dbb31 | 118 | * @param [IN] modem Radio modem to be used [0: FSK, 1: LoRa] |
wardm | 15:2e0d977dbb31 | 119 | * @param [IN] freq Channel RF frequency |
wardm | 15:2e0d977dbb31 | 120 | * @param [IN] rssiThresh RSSI threshold |
wardm | 15:2e0d977dbb31 | 121 | * |
wardm | 15:2e0d977dbb31 | 122 | * @retval isFree [true: Channel is free, false: Channel is not free] |
wardm | 15:2e0d977dbb31 | 123 | */ |
wardm | 15:2e0d977dbb31 | 124 | virtual bool IsChannelFree( RadioModems_t modem, uint32_t freq, int16_t rssiThresh ) = 0; |
wardm | 15:2e0d977dbb31 | 125 | /*! |
wardm | 15:2e0d977dbb31 | 126 | * @brief Generates a 32 bits random value based on the RSSI readings |
wardm | 15:2e0d977dbb31 | 127 | * |
wardm | 15:2e0d977dbb31 | 128 | * \remark This function sets the radio in LoRa modem mode and disables |
wardm | 15:2e0d977dbb31 | 129 | * all interrupts. |
wardm | 15:2e0d977dbb31 | 130 | * After calling this function either Radio.SetRxConfig or |
wardm | 15:2e0d977dbb31 | 131 | * Radio.SetTxConfig functions must be called. |
wardm | 15:2e0d977dbb31 | 132 | * |
wardm | 15:2e0d977dbb31 | 133 | * @retval randomValue 32 bits random value |
wardm | 15:2e0d977dbb31 | 134 | */ |
wardm | 15:2e0d977dbb31 | 135 | virtual uint32_t Random( void )= 0; |
wardm | 15:2e0d977dbb31 | 136 | /*! |
wardm | 15:2e0d977dbb31 | 137 | * @brief Sets the reception parameters |
wardm | 15:2e0d977dbb31 | 138 | * |
wardm | 15:2e0d977dbb31 | 139 | * @param [IN] modem Radio modem to be used [0: FSK, 1: LoRa] |
wardm | 15:2e0d977dbb31 | 140 | * @param [IN] bandwidth Sets the bandwidth |
wardm | 15:2e0d977dbb31 | 141 | * FSK : >= 2600 and <= 250000 Hz |
wardm | 15:2e0d977dbb31 | 142 | * LoRa: [0: 125 kHz, 1: 250 kHz, |
wardm | 15:2e0d977dbb31 | 143 | * 2: 500 kHz, 3: Reserved] |
wardm | 15:2e0d977dbb31 | 144 | * @param [IN] datarate Sets the Datarate |
wardm | 15:2e0d977dbb31 | 145 | * FSK : 600..300000 bits/s |
wardm | 15:2e0d977dbb31 | 146 | * LoRa: [6: 64, 7: 128, 8: 256, 9: 512, |
wardm | 15:2e0d977dbb31 | 147 | * 10: 1024, 11: 2048, 12: 4096 chips] |
wardm | 15:2e0d977dbb31 | 148 | * @param [IN] coderate Sets the coding rate ( LoRa only ) |
wardm | 15:2e0d977dbb31 | 149 | * FSK : N/A ( set to 0 ) |
wardm | 15:2e0d977dbb31 | 150 | * LoRa: [1: 4/5, 2: 4/6, 3: 4/7, 4: 4/8] |
wardm | 15:2e0d977dbb31 | 151 | * @param [IN] bandwidthAfc Sets the AFC Bandwidth ( FSK only ) |
wardm | 15:2e0d977dbb31 | 152 | * FSK : >= 2600 and <= 250000 Hz |
wardm | 15:2e0d977dbb31 | 153 | * LoRa: N/A ( set to 0 ) |
wardm | 15:2e0d977dbb31 | 154 | * @param [IN] preambleLen Sets the Preamble length ( LoRa only ) |
wardm | 15:2e0d977dbb31 | 155 | * FSK : N/A ( set to 0 ) |
wardm | 15:2e0d977dbb31 | 156 | * LoRa: Length in symbols ( the hardware adds 4 more symbols ) |
wardm | 15:2e0d977dbb31 | 157 | * @param [IN] symbTimeout Sets the RxSingle timeout value |
wardm | 15:2e0d977dbb31 | 158 | * FSK : timeout number of bytes |
wardm | 15:2e0d977dbb31 | 159 | * LoRa: timeout in symbols |
wardm | 15:2e0d977dbb31 | 160 | * @param [IN] fixLen Fixed length packets [0: variable, 1: fixed] |
wardm | 15:2e0d977dbb31 | 161 | * @param [IN] payloadLen Sets payload length when fixed lenght is used |
wardm | 15:2e0d977dbb31 | 162 | * @param [IN] crcOn Enables/Disables the CRC [0: OFF, 1: ON] |
wardm | 15:2e0d977dbb31 | 163 | * @param [IN] freqHopOn Enables disables the intra-packet frequency hopping [0: OFF, 1: ON] (LoRa only) |
wardm | 15:2e0d977dbb31 | 164 | * @param [IN] hopPeriod Number of symbols bewteen each hop (LoRa only) |
wardm | 15:2e0d977dbb31 | 165 | * @param [IN] iqInverted Inverts IQ signals ( LoRa only ) |
wardm | 15:2e0d977dbb31 | 166 | * FSK : N/A ( set to 0 ) |
wardm | 15:2e0d977dbb31 | 167 | * LoRa: [0: not inverted, 1: inverted] |
wardm | 15:2e0d977dbb31 | 168 | * @param [IN] rxContinuous Sets the reception in continuous mode |
wardm | 15:2e0d977dbb31 | 169 | * [false: single mode, true: continuous mode] |
wardm | 15:2e0d977dbb31 | 170 | */ |
wardm | 15:2e0d977dbb31 | 171 | virtual void SetRxConfig ( RadioModems_t modem, uint32_t bandwidth, |
wardm | 15:2e0d977dbb31 | 172 | uint32_t datarate, uint8_t coderate, |
wardm | 15:2e0d977dbb31 | 173 | uint32_t bandwidthAfc, uint16_t preambleLen, |
wardm | 15:2e0d977dbb31 | 174 | uint16_t symbTimeout, bool fixLen, |
wardm | 15:2e0d977dbb31 | 175 | uint8_t payloadLen, |
wardm | 15:2e0d977dbb31 | 176 | bool crcOn, bool freqHopOn, uint8_t hopPeriod, |
wardm | 15:2e0d977dbb31 | 177 | bool iqInverted, bool rxContinuous ) = 0; |
wardm | 15:2e0d977dbb31 | 178 | /*! |
wardm | 15:2e0d977dbb31 | 179 | * @brief Sets the transmission parameters |
wardm | 15:2e0d977dbb31 | 180 | * |
wardm | 15:2e0d977dbb31 | 181 | * @param [IN] modem Radio modem to be used [0: FSK, 1: LoRa] |
wardm | 15:2e0d977dbb31 | 182 | * @param [IN] power Sets the output power [dBm] |
wardm | 15:2e0d977dbb31 | 183 | * @param [IN] fdev Sets the frequency deviation ( FSK only ) |
wardm | 15:2e0d977dbb31 | 184 | * FSK : [Hz] |
wardm | 15:2e0d977dbb31 | 185 | * LoRa: 0 |
wardm | 15:2e0d977dbb31 | 186 | * @param [IN] bandwidth Sets the bandwidth ( LoRa only ) |
wardm | 15:2e0d977dbb31 | 187 | * FSK : 0 |
wardm | 15:2e0d977dbb31 | 188 | * LoRa: [0: 125 kHz, 1: 250 kHz, |
wardm | 15:2e0d977dbb31 | 189 | * 2: 500 kHz, 3: Reserved] |
wardm | 15:2e0d977dbb31 | 190 | * @param [IN] datarate Sets the Datarate |
wardm | 15:2e0d977dbb31 | 191 | * FSK : 600..300000 bits/s |
wardm | 15:2e0d977dbb31 | 192 | * LoRa: [6: 64, 7: 128, 8: 256, 9: 512, |
wardm | 15:2e0d977dbb31 | 193 | * 10: 1024, 11: 2048, 12: 4096 chips] |
wardm | 15:2e0d977dbb31 | 194 | * @param [IN] coderate Sets the coding rate ( LoRa only ) |
wardm | 15:2e0d977dbb31 | 195 | * FSK : N/A ( set to 0 ) |
wardm | 15:2e0d977dbb31 | 196 | * LoRa: [1: 4/5, 2: 4/6, 3: 4/7, 4: 4/8] |
wardm | 15:2e0d977dbb31 | 197 | * @param [IN] preambleLen Sets the preamble length |
wardm | 15:2e0d977dbb31 | 198 | * @param [IN] fixLen Fixed length packets [0: variable, 1: fixed] |
wardm | 15:2e0d977dbb31 | 199 | * @param [IN] crcOn Enables disables the CRC [0: OFF, 1: ON] |
wardm | 15:2e0d977dbb31 | 200 | * @param [IN] freqHopOn Enables disables the intra-packet frequency hopping [0: OFF, 1: ON] (LoRa only) |
wardm | 15:2e0d977dbb31 | 201 | * @param [IN] hopPeriod Number of symbols bewteen each hop (LoRa only) |
wardm | 15:2e0d977dbb31 | 202 | * @param [IN] iqInverted Inverts IQ signals ( LoRa only ) |
wardm | 15:2e0d977dbb31 | 203 | * FSK : N/A ( set to 0 ) |
wardm | 15:2e0d977dbb31 | 204 | * LoRa: [0: not inverted, 1: inverted] |
wardm | 15:2e0d977dbb31 | 205 | * @param [IN] timeout Transmission timeout [us] |
wardm | 15:2e0d977dbb31 | 206 | */ |
wardm | 15:2e0d977dbb31 | 207 | virtual void SetTxConfig( RadioModems_t modem, int8_t power, uint32_t fdev, |
wardm | 15:2e0d977dbb31 | 208 | uint32_t bandwidth, uint32_t datarate, |
wardm | 15:2e0d977dbb31 | 209 | uint8_t coderate, uint16_t preambleLen, |
wardm | 15:2e0d977dbb31 | 210 | bool fixLen, bool crcOn, bool freqHopOn, |
wardm | 15:2e0d977dbb31 | 211 | uint8_t hopPeriod, bool iqInverted, uint32_t timeout ) = 0; |
wardm | 15:2e0d977dbb31 | 212 | /*! |
wardm | 15:2e0d977dbb31 | 213 | * @brief Checks if the given RF frequency is supported by the hardware |
wardm | 15:2e0d977dbb31 | 214 | * |
wardm | 15:2e0d977dbb31 | 215 | * @param [IN] frequency RF frequency to be checked |
wardm | 15:2e0d977dbb31 | 216 | * @retval isSupported [true: supported, false: unsupported] |
wardm | 15:2e0d977dbb31 | 217 | */ |
wardm | 15:2e0d977dbb31 | 218 | virtual bool CheckRfFrequency( uint32_t frequency ) = 0; |
wardm | 15:2e0d977dbb31 | 219 | /*! |
wardm | 15:2e0d977dbb31 | 220 | * @brief Computes the packet time on air for the given payload |
wardm | 15:2e0d977dbb31 | 221 | * |
wardm | 15:2e0d977dbb31 | 222 | * \Remark Can only be called once SetRxConfig or SetTxConfig have been called |
wardm | 15:2e0d977dbb31 | 223 | * |
wardm | 15:2e0d977dbb31 | 224 | * @param [IN] modem Radio modem to be used [0: FSK, 1: LoRa] |
wardm | 15:2e0d977dbb31 | 225 | * @param [IN] pktLen Packet payload length |
wardm | 15:2e0d977dbb31 | 226 | * |
wardm | 15:2e0d977dbb31 | 227 | * @retval airTime Computed airTime for the given packet payload length |
wardm | 15:2e0d977dbb31 | 228 | */ |
wardm | 15:2e0d977dbb31 | 229 | virtual uint32_t TimeOnAir ( RadioModems_t modem, uint8_t pktLen ) = 0; |
wardm | 15:2e0d977dbb31 | 230 | /*! |
wardm | 15:2e0d977dbb31 | 231 | * @brief Sends the buffer of size. Prepares the packet to be sent and sets |
wardm | 15:2e0d977dbb31 | 232 | * the radio in transmission |
wardm | 15:2e0d977dbb31 | 233 | * |
wardm | 15:2e0d977dbb31 | 234 | * @param [IN]: buffer Buffer pointer |
wardm | 15:2e0d977dbb31 | 235 | * @param [IN]: size Buffer size |
wardm | 15:2e0d977dbb31 | 236 | */ |
wardm | 15:2e0d977dbb31 | 237 | virtual void Send( uint8_t *buffer, uint8_t size ) = 0; |
wardm | 15:2e0d977dbb31 | 238 | /*! |
wardm | 15:2e0d977dbb31 | 239 | * @brief Sets the radio in sleep mode |
wardm | 15:2e0d977dbb31 | 240 | */ |
wardm | 15:2e0d977dbb31 | 241 | virtual void Sleep( void ) = 0; |
wardm | 15:2e0d977dbb31 | 242 | /*! |
wardm | 15:2e0d977dbb31 | 243 | * @brief Sets the radio in standby mode |
wardm | 15:2e0d977dbb31 | 244 | */ |
wardm | 15:2e0d977dbb31 | 245 | virtual void Standby( void ) = 0; |
wardm | 15:2e0d977dbb31 | 246 | /*! |
wardm | 15:2e0d977dbb31 | 247 | * @brief Sets the radio in CAD mode |
wardm | 15:2e0d977dbb31 | 248 | */ |
wardm | 15:2e0d977dbb31 | 249 | virtual void StartCad( void ) = 0; |
wardm | 15:2e0d977dbb31 | 250 | /*! |
wardm | 15:2e0d977dbb31 | 251 | * @brief Sets the radio in reception mode for the given time |
wardm | 15:2e0d977dbb31 | 252 | * @param [IN] timeout Reception timeout [us] |
wardm | 15:2e0d977dbb31 | 253 | * [0: continuous, others timeout] |
wardm | 15:2e0d977dbb31 | 254 | */ |
wardm | 15:2e0d977dbb31 | 255 | virtual void Rx( uint32_t timeout ) = 0; |
wardm | 15:2e0d977dbb31 | 256 | /*! |
wardm | 15:2e0d977dbb31 | 257 | * @brief Sets the radio in transmission mode for the given time |
wardm | 15:2e0d977dbb31 | 258 | * @param [IN] timeout Transmission timeout [us] |
wardm | 15:2e0d977dbb31 | 259 | * [0: continuous, others timeout] |
wardm | 15:2e0d977dbb31 | 260 | */ |
wardm | 15:2e0d977dbb31 | 261 | virtual void Tx( uint32_t timeout ) = 0; |
wardm | 15:2e0d977dbb31 | 262 | /*! |
wardm | 15:2e0d977dbb31 | 263 | * @brief Sets the radio in continuous wave transmission mode |
wardm | 15:2e0d977dbb31 | 264 | * |
wardm | 15:2e0d977dbb31 | 265 | * @param [IN]: freq Channel RF frequency |
wardm | 15:2e0d977dbb31 | 266 | * @param [IN]: power Sets the output power [dBm] |
wardm | 15:2e0d977dbb31 | 267 | * @param [IN]: time Transmission mode timeout [s] |
wardm | 15:2e0d977dbb31 | 268 | */ |
wardm | 15:2e0d977dbb31 | 269 | virtual void SetTxContinuousWave( uint32_t freq, int8_t power, uint16_t time ) = 0; |
wardm | 15:2e0d977dbb31 | 270 | /*! |
wardm | 15:2e0d977dbb31 | 271 | * @brief Reads the current RSSI value |
wardm | 15:2e0d977dbb31 | 272 | * |
wardm | 15:2e0d977dbb31 | 273 | * @retval rssiValue Current RSSI value in [dBm] |
wardm | 15:2e0d977dbb31 | 274 | */ |
wardm | 15:2e0d977dbb31 | 275 | virtual int16_t GetRssi ( RadioModems_t modem ) = 0; |
wardm | 15:2e0d977dbb31 | 276 | /*! |
wardm | 15:2e0d977dbb31 | 277 | * @brief Writes the radio register at the specified address |
wardm | 15:2e0d977dbb31 | 278 | * |
wardm | 15:2e0d977dbb31 | 279 | * @param [IN]: addr Register address |
wardm | 15:2e0d977dbb31 | 280 | * @param [IN]: data New register value |
wardm | 15:2e0d977dbb31 | 281 | */ |
wardm | 15:2e0d977dbb31 | 282 | virtual void Write ( uint8_t addr, uint8_t data ) = 0; |
wardm | 15:2e0d977dbb31 | 283 | /*! |
wardm | 15:2e0d977dbb31 | 284 | * @brief Reads the radio register at the specified address |
wardm | 15:2e0d977dbb31 | 285 | * |
wardm | 15:2e0d977dbb31 | 286 | * @param [IN]: addr Register address |
wardm | 15:2e0d977dbb31 | 287 | * @retval data Register value |
wardm | 15:2e0d977dbb31 | 288 | */ |
wardm | 15:2e0d977dbb31 | 289 | virtual uint8_t Read ( uint8_t addr ) = 0; |
wardm | 15:2e0d977dbb31 | 290 | /*! |
wardm | 15:2e0d977dbb31 | 291 | * @brief Writes multiple radio registers starting at address |
wardm | 15:2e0d977dbb31 | 292 | * |
wardm | 15:2e0d977dbb31 | 293 | * @param [IN] addr First Radio register address |
wardm | 15:2e0d977dbb31 | 294 | * @param [IN] buffer Buffer containing the new register's values |
wardm | 15:2e0d977dbb31 | 295 | * @param [IN] size Number of registers to be written |
wardm | 15:2e0d977dbb31 | 296 | */ |
wardm | 15:2e0d977dbb31 | 297 | virtual void Write( uint8_t addr, uint8_t *buffer, uint8_t size ) = 0; |
wardm | 15:2e0d977dbb31 | 298 | /*! |
wardm | 15:2e0d977dbb31 | 299 | * @brief Reads multiple radio registers starting at address |
wardm | 15:2e0d977dbb31 | 300 | * |
wardm | 15:2e0d977dbb31 | 301 | * @param [IN] addr First Radio register address |
wardm | 15:2e0d977dbb31 | 302 | * @param [OUT] buffer Buffer where to copy the registers data |
wardm | 15:2e0d977dbb31 | 303 | * @param [IN] size Number of registers to be read |
wardm | 15:2e0d977dbb31 | 304 | */ |
wardm | 15:2e0d977dbb31 | 305 | virtual void Read ( uint8_t addr, uint8_t *buffer, uint8_t size ) = 0; |
wardm | 15:2e0d977dbb31 | 306 | /*! |
wardm | 15:2e0d977dbb31 | 307 | * @brief Writes the buffer contents to the Radio FIFO |
wardm | 15:2e0d977dbb31 | 308 | * |
wardm | 15:2e0d977dbb31 | 309 | * @param [IN] buffer Buffer containing data to be put on the FIFO. |
wardm | 15:2e0d977dbb31 | 310 | * @param [IN] size Number of bytes to be written to the FIFO |
wardm | 15:2e0d977dbb31 | 311 | */ |
wardm | 15:2e0d977dbb31 | 312 | virtual void WriteFifo( uint8_t *buffer, uint8_t size ) = 0; |
wardm | 15:2e0d977dbb31 | 313 | /*! |
wardm | 15:2e0d977dbb31 | 314 | * @brief Reads the contents of the Radio FIFO |
wardm | 15:2e0d977dbb31 | 315 | * |
wardm | 15:2e0d977dbb31 | 316 | * @param [OUT] buffer Buffer where to copy the FIFO read data. |
wardm | 15:2e0d977dbb31 | 317 | * @param [IN] size Number of bytes to be read from the FIFO |
wardm | 15:2e0d977dbb31 | 318 | */ |
wardm | 15:2e0d977dbb31 | 319 | virtual void ReadFifo( uint8_t *buffer, uint8_t size ) = 0; |
wardm | 15:2e0d977dbb31 | 320 | /*! |
wardm | 15:2e0d977dbb31 | 321 | * @brief Sets the maximum payload length. |
wardm | 15:2e0d977dbb31 | 322 | * |
wardm | 15:2e0d977dbb31 | 323 | * @param [IN] modem Radio modem to be used [0: FSK, 1: LoRa] |
wardm | 15:2e0d977dbb31 | 324 | * @param [IN] max Maximum payload length in bytes |
wardm | 15:2e0d977dbb31 | 325 | */ |
wardm | 15:2e0d977dbb31 | 326 | virtual void SetMaxPayloadLength( RadioModems_t modem, uint8_t max ) = 0; |
wardm | 15:2e0d977dbb31 | 327 | /*! |
wardm | 15:2e0d977dbb31 | 328 | * @brief Sets the network to public or private. Updates the sync byte. |
wardm | 15:2e0d977dbb31 | 329 | * |
wardm | 15:2e0d977dbb31 | 330 | * @remark Applies to LoRa modem only |
wardm | 15:2e0d977dbb31 | 331 | * |
wardm | 15:2e0d977dbb31 | 332 | * @param [IN] enable if true, it enables a public network |
wardm | 15:2e0d977dbb31 | 333 | */ |
wardm | 15:2e0d977dbb31 | 334 | virtual void SetPublicNetwork( bool enable ) = 0; |
wardm | 15:2e0d977dbb31 | 335 | }; |
wardm | 15:2e0d977dbb31 | 336 | |
wardm | 15:2e0d977dbb31 | 337 | #endif // __RADIO_H__ |