Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependents: Nucleo_Private_LoRa
radio/radio.h@0:e6ceb13d2d05, 2014-08-18 (annotated)
- Committer:
 - GregCr
 - Date:
 - Mon Aug 18 14:24:46 2014 +0000
 - Revision:
 - 0:e6ceb13d2d05
 - Child:
 - 6:e7f02929cd3d
 
SX1276 Library first attempt
Who changed what in which revision?
| User | Revision | Line number | New 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 | (______/|_____)_|_|_| \__)_____)\____)_| |_| | 
| GregCr | 0:e6ceb13d2d05 | 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 | |
| GregCr | 0:e6ceb13d2d05 | 20 | #include "./enums/enums.h" | 
| GregCr | 0:e6ceb13d2d05 | 21 | |
| GregCr | 0:e6ceb13d2d05 | 22 | /*! | 
| GregCr | 0:e6ceb13d2d05 | 23 | * Interface for the radios, contains the main functions that a radio needs, and 5 callback functions | 
| GregCr | 0:e6ceb13d2d05 | 24 | */ | 
| GregCr | 0:e6ceb13d2d05 | 25 | class Radio | 
| GregCr | 0:e6ceb13d2d05 | 26 | { | 
| GregCr | 0:e6ceb13d2d05 | 27 | protected: | 
| GregCr | 0:e6ceb13d2d05 | 28 | |
| GregCr | 0:e6ceb13d2d05 | 29 | //------------------------------------------------------------------------- | 
| GregCr | 0:e6ceb13d2d05 | 30 | // Callback functions pointers | 
| GregCr | 0:e6ceb13d2d05 | 31 | //------------------------------------------------------------------------- | 
| GregCr | 0:e6ceb13d2d05 | 32 | |
| GregCr | 0:e6ceb13d2d05 | 33 | /*! | 
| GregCr | 0:e6ceb13d2d05 | 34 | * @brief Tx Done callback prototype. | 
| GregCr | 0:e6ceb13d2d05 | 35 | */ | 
| GregCr | 0:e6ceb13d2d05 | 36 | void ( *txDone )( ); | 
| GregCr | 0:e6ceb13d2d05 | 37 | |
| GregCr | 0:e6ceb13d2d05 | 38 | /*! | 
| GregCr | 0:e6ceb13d2d05 | 39 | * @brief Tx Timeout callback prototype. | 
| GregCr | 0:e6ceb13d2d05 | 40 | */ | 
| GregCr | 0:e6ceb13d2d05 | 41 | void ( *txTimeout ) ( ); | 
| GregCr | 0:e6ceb13d2d05 | 42 | |
| GregCr | 0:e6ceb13d2d05 | 43 | /*! | 
| GregCr | 0:e6ceb13d2d05 | 44 | * @brief Rx Done callback prototype. | 
| GregCr | 0:e6ceb13d2d05 | 45 | * | 
| GregCr | 0:e6ceb13d2d05 | 46 | * @param [IN] payload Received buffer pointer | 
| GregCr | 0:e6ceb13d2d05 | 47 | * @param [IN] size Received buffer size | 
| GregCr | 0:e6ceb13d2d05 | 48 | * @param [IN] rssi RSSI value computed while receiving the frame [dBm] | 
| GregCr | 0:e6ceb13d2d05 | 49 | * @param [IN] snr Raw SNR value given by the radio hardware | 
| GregCr | 0:e6ceb13d2d05 | 50 | * FSK : N/A ( set to 0 ) | 
| GregCr | 0:e6ceb13d2d05 | 51 | * LoRa: SNR value in dB | 
| GregCr | 0:e6ceb13d2d05 | 52 | */ | 
| GregCr | 0:e6ceb13d2d05 | 53 | void ( *rxDone ) ( uint8_t *payload, uint16_t size, int8_t rssi, int8_t snr ); | 
| GregCr | 0:e6ceb13d2d05 | 54 | |
| GregCr | 0:e6ceb13d2d05 | 55 | /*! | 
| GregCr | 0:e6ceb13d2d05 | 56 | * @brief Rx Timeout callback prototype. | 
| GregCr | 0:e6ceb13d2d05 | 57 | */ | 
| GregCr | 0:e6ceb13d2d05 | 58 | void ( *rxTimeout ) ( ); | 
| GregCr | 0:e6ceb13d2d05 | 59 | |
| GregCr | 0:e6ceb13d2d05 | 60 | /*! | 
| GregCr | 0:e6ceb13d2d05 | 61 | * @brief Rx Error callback prototype. | 
| GregCr | 0:e6ceb13d2d05 | 62 | */ | 
| GregCr | 0:e6ceb13d2d05 | 63 | void ( *rxError ) ( ); | 
| GregCr | 0:e6ceb13d2d05 | 64 | |
| GregCr | 0:e6ceb13d2d05 | 65 | public: | 
| GregCr | 0:e6ceb13d2d05 | 66 | //------------------------------------------------------------------------- | 
| GregCr | 0:e6ceb13d2d05 | 67 | // Constructor | 
| GregCr | 0:e6ceb13d2d05 | 68 | //------------------------------------------------------------------------- | 
| GregCr | 0:e6ceb13d2d05 | 69 | /*! | 
| GregCr | 0:e6ceb13d2d05 | 70 | * @brief Constructor of the radio object, the parameters are the callback functions described in the header. | 
| GregCr | 0:e6ceb13d2d05 | 71 | * @param [IN] txDone | 
| GregCr | 0:e6ceb13d2d05 | 72 | * @param [IN] txTimeout | 
| GregCr | 0:e6ceb13d2d05 | 73 | * @param [IN] rxDone | 
| GregCr | 0:e6ceb13d2d05 | 74 | * @param [IN] rxTimeout | 
| GregCr | 0:e6ceb13d2d05 | 75 | * @param [IN] rxError | 
| GregCr | 0:e6ceb13d2d05 | 76 | */ | 
| GregCr | 0:e6ceb13d2d05 | 77 | Radio( void ( *txDone )( ), void ( *txTimeout ) ( ), void ( *rxDone ) ( uint8_t *payload, uint16_t size, int8_t rssi, int8_t snr ), void ( *rxTimeout ) ( ), void ( *rxError ) ( ) ); | 
| GregCr | 0:e6ceb13d2d05 | 78 | virtual ~Radio( ) {}; | 
| GregCr | 0:e6ceb13d2d05 | 79 | |
| GregCr | 0:e6ceb13d2d05 | 80 | //------------------------------------------------------------------------- | 
| GregCr | 0:e6ceb13d2d05 | 81 | // Pure virtual functions | 
| GregCr | 0:e6ceb13d2d05 | 82 | //------------------------------------------------------------------------- | 
| GregCr | 0:e6ceb13d2d05 | 83 | |
| GregCr | 0:e6ceb13d2d05 | 84 | /*! | 
| GregCr | 0:e6ceb13d2d05 | 85 | * Return current radio status | 
| GregCr | 0:e6ceb13d2d05 | 86 | * | 
| GregCr | 0:e6ceb13d2d05 | 87 | * @param status Radio status.[RF_IDLE, RF_RX_RUNNING, RF_TX_RUNNING] | 
| GregCr | 0:e6ceb13d2d05 | 88 | */ | 
| GregCr | 0:e6ceb13d2d05 | 89 | virtual RadioState GetState( void ) = 0; | 
| GregCr | 0:e6ceb13d2d05 | 90 | |
| GregCr | 0:e6ceb13d2d05 | 91 | /*! | 
| GregCr | 0:e6ceb13d2d05 | 92 | * @brief Sets the channel frequency | 
| GregCr | 0:e6ceb13d2d05 | 93 | * | 
| GregCr | 0:e6ceb13d2d05 | 94 | * @param [IN] freq Channel RF frequency | 
| GregCr | 0:e6ceb13d2d05 | 95 | */ | 
| GregCr | 0:e6ceb13d2d05 | 96 | virtual void SetChannel( uint32_t freq ) = 0; | 
| GregCr | 0:e6ceb13d2d05 | 97 | |
| GregCr | 0:e6ceb13d2d05 | 98 | /*! | 
| GregCr | 0:e6ceb13d2d05 | 99 | * @brief Sets the channels configuration | 
| GregCr | 0:e6ceb13d2d05 | 100 | * | 
| GregCr | 0:e6ceb13d2d05 | 101 | * @param [IN] modem Radio modem to be used [0: FSK, 1: LoRa] | 
| GregCr | 0:e6ceb13d2d05 | 102 | * @param [IN] freq Channel RF frequency | 
| GregCr | 0:e6ceb13d2d05 | 103 | * @param [IN] rssiThresh RSSI threshold | 
| GregCr | 0:e6ceb13d2d05 | 104 | * | 
| GregCr | 0:e6ceb13d2d05 | 105 | * @retval isFree [true: Channel is free, false: Channel is not free] | 
| GregCr | 0:e6ceb13d2d05 | 106 | */ | 
| GregCr | 0:e6ceb13d2d05 | 107 | virtual bool IsChannelFree( ModemType modem, uint32_t freq, int8_t rssiThresh ) = 0; | 
| GregCr | 0:e6ceb13d2d05 | 108 | |
| GregCr | 0:e6ceb13d2d05 | 109 | /*! | 
| GregCr | 0:e6ceb13d2d05 | 110 | * @brief Generates a 32 bits random value based on the RSSI readings | 
| GregCr | 0:e6ceb13d2d05 | 111 | * | 
| GregCr | 0:e6ceb13d2d05 | 112 | * \remark This function sets the radio in LoRa modem mode and disables | 
| GregCr | 0:e6ceb13d2d05 | 113 | * all interrupts. | 
| GregCr | 0:e6ceb13d2d05 | 114 | * After calling this function either Radio.SetRxConfig or | 
| GregCr | 0:e6ceb13d2d05 | 115 | * Radio.SetTxConfig functions must be called. | 
| GregCr | 0:e6ceb13d2d05 | 116 | * | 
| GregCr | 0:e6ceb13d2d05 | 117 | * @retval randomValue 32 bits random value | 
| GregCr | 0:e6ceb13d2d05 | 118 | */ | 
| GregCr | 0:e6ceb13d2d05 | 119 | virtual uint32_t Random( void )= 0; | 
| GregCr | 0:e6ceb13d2d05 | 120 | |
| GregCr | 0:e6ceb13d2d05 | 121 | /*! | 
| GregCr | 0:e6ceb13d2d05 | 122 | * @brief Sets the reception parameters | 
| GregCr | 0:e6ceb13d2d05 | 123 | * | 
| GregCr | 0:e6ceb13d2d05 | 124 | * @param [IN] modem Radio modem to be used [0: FSK, 1: LoRa] | 
| GregCr | 0:e6ceb13d2d05 | 125 | * @param [IN] bandwidth Sets the bandwidth | 
| GregCr | 0:e6ceb13d2d05 | 126 | * FSK : >= 2600 and <= 250000 Hz | 
| GregCr | 0:e6ceb13d2d05 | 127 | * LoRa: [0: 125 kHz, 1: 250 kHz, | 
| GregCr | 0:e6ceb13d2d05 | 128 | * 2: 500 kHz, 3: Reserved] | 
| GregCr | 0:e6ceb13d2d05 | 129 | * @param [IN] datarate Sets the Datarate | 
| GregCr | 0:e6ceb13d2d05 | 130 | * FSK : 600..300000 bits/s | 
| GregCr | 0:e6ceb13d2d05 | 131 | * LoRa: [6: 64, 7: 128, 8: 256, 9: 512, | 
| GregCr | 0:e6ceb13d2d05 | 132 | * 10: 1024, 11: 2048, 12: 4096 chips] | 
| GregCr | 0:e6ceb13d2d05 | 133 | * @param [IN] coderate Sets the coding rate ( LoRa only ) | 
| GregCr | 0:e6ceb13d2d05 | 134 | * FSK : N/A ( set to 0 ) | 
| GregCr | 0:e6ceb13d2d05 | 135 | * LoRa: [1: 4/5, 2: 4/6, 3: 4/7, 4: 4/8] | 
| GregCr | 0:e6ceb13d2d05 | 136 | * @param [IN] bandwidthAfc Sets the AFC Bandwidth ( FSK only ) | 
| GregCr | 0:e6ceb13d2d05 | 137 | * FSK : >= 2600 and <= 250000 Hz | 
| GregCr | 0:e6ceb13d2d05 | 138 | * LoRa: N/A ( set to 0 ) | 
| GregCr | 0:e6ceb13d2d05 | 139 | * @param [IN] preambleLen Sets the Preamble length ( LoRa only ) | 
| GregCr | 0:e6ceb13d2d05 | 140 | * FSK : N/A ( set to 0 ) | 
| GregCr | 0:e6ceb13d2d05 | 141 | * LoRa: Length in symbols ( the hardware adds 4 more symbols ) | 
| GregCr | 0:e6ceb13d2d05 | 142 | * @param [IN] symbTimeout Sets the RxSingle timeout value ( LoRa only ) | 
| GregCr | 0:e6ceb13d2d05 | 143 | * FSK : N/A ( set to 0 ) | 
| GregCr | 0:e6ceb13d2d05 | 144 | * LoRa: timeout in symbols | 
| GregCr | 0:e6ceb13d2d05 | 145 | * @param [IN] fixLen Fixed length packets [0: variable, 1: fixed] | 
| GregCr | 0:e6ceb13d2d05 | 146 | * @param [IN] crcOn Enables/Disables the CRC [0: OFF, 1: ON] | 
| GregCr | 0:e6ceb13d2d05 | 147 | * @param [IN] iqInverted Inverts IQ signals ( LoRa only ) | 
| GregCr | 0:e6ceb13d2d05 | 148 | * FSK : N/A ( set to 0 ) | 
| GregCr | 0:e6ceb13d2d05 | 149 | * LoRa: [0: not inverted, 1: inverted] | 
| GregCr | 0:e6ceb13d2d05 | 150 | * @param [IN] rxContinuous Sets the reception in continuous mode | 
| GregCr | 0:e6ceb13d2d05 | 151 | * [false: single mode, true: continuous mode] | 
| GregCr | 0:e6ceb13d2d05 | 152 | */ | 
| GregCr | 0:e6ceb13d2d05 | 153 | virtual void SetRxConfig ( ModemType modem, uint32_t bandwidth, | 
| GregCr | 0:e6ceb13d2d05 | 154 | uint32_t datarate, uint8_t coderate, | 
| GregCr | 0:e6ceb13d2d05 | 155 | uint32_t bandwidthAfc, uint16_t preambleLen, | 
| GregCr | 0:e6ceb13d2d05 | 156 | uint16_t symbTimeout, bool fixLen, | 
| GregCr | 0:e6ceb13d2d05 | 157 | bool crcOn, bool iqInverted, bool rxContinuous ) = 0; | 
| GregCr | 0:e6ceb13d2d05 | 158 | |
| GregCr | 0:e6ceb13d2d05 | 159 | /*! | 
| GregCr | 0:e6ceb13d2d05 | 160 | * @brief Sets the transmission parameters | 
| GregCr | 0:e6ceb13d2d05 | 161 | * | 
| GregCr | 0:e6ceb13d2d05 | 162 | * @param [IN] modem Radio modem to be used [0: FSK, 1: LoRa] | 
| GregCr | 0:e6ceb13d2d05 | 163 | * @param [IN] power Sets the output power [dBm] | 
| GregCr | 0:e6ceb13d2d05 | 164 | * @param [IN] fdev Sets the frequency deviation ( FSK only ) | 
| GregCr | 0:e6ceb13d2d05 | 165 | * FSK : [Hz] | 
| GregCr | 0:e6ceb13d2d05 | 166 | * LoRa: 0 | 
| GregCr | 0:e6ceb13d2d05 | 167 | * @param [IN] bandwidth Sets the bandwidth ( LoRa only ) | 
| GregCr | 0:e6ceb13d2d05 | 168 | * FSK : 0 | 
| GregCr | 0:e6ceb13d2d05 | 169 | * LoRa: [0: 125 kHz, 1: 250 kHz, | 
| GregCr | 0:e6ceb13d2d05 | 170 | * 2: 500 kHz, 3: Reserved] | 
| GregCr | 0:e6ceb13d2d05 | 171 | * @param [IN] datarate Sets the Datarate | 
| GregCr | 0:e6ceb13d2d05 | 172 | * FSK : 600..300000 bits/s | 
| GregCr | 0:e6ceb13d2d05 | 173 | * LoRa: [6: 64, 7: 128, 8: 256, 9: 512, | 
| GregCr | 0:e6ceb13d2d05 | 174 | * 10: 1024, 11: 2048, 12: 4096 chips] | 
| GregCr | 0:e6ceb13d2d05 | 175 | * @param [IN] coderate Sets the coding rate ( LoRa only ) | 
| GregCr | 0:e6ceb13d2d05 | 176 | * FSK : N/A ( set to 0 ) | 
| GregCr | 0:e6ceb13d2d05 | 177 | * LoRa: [1: 4/5, 2: 4/6, 3: 4/7, 4: 4/8] | 
| GregCr | 0:e6ceb13d2d05 | 178 | * @param [IN] preambleLen Sets the preamble length | 
| GregCr | 0:e6ceb13d2d05 | 179 | * @param [IN] fixLen Fixed length packets [0: variable, 1: fixed] | 
| GregCr | 0:e6ceb13d2d05 | 180 | * @param [IN] crcOn Enables disables the CRC [0: OFF, 1: ON] | 
| GregCr | 0:e6ceb13d2d05 | 181 | * @param [IN] iqInverted Inverts IQ signals ( LoRa only ) | 
| GregCr | 0:e6ceb13d2d05 | 182 | * FSK : N/A ( set to 0 ) | 
| GregCr | 0:e6ceb13d2d05 | 183 | * LoRa: [0: not inverted, 1: inverted] | 
| GregCr | 0:e6ceb13d2d05 | 184 | * @param [IN] timeout Transmission timeout [us] | 
| GregCr | 0:e6ceb13d2d05 | 185 | */ | 
| GregCr | 0:e6ceb13d2d05 | 186 | virtual void SetTxConfig( ModemType modem, int8_t power, uint32_t fdev, | 
| GregCr | 0:e6ceb13d2d05 | 187 | uint32_t bandwidth, uint32_t datarate, | 
| GregCr | 0:e6ceb13d2d05 | 188 | uint8_t coderate, uint16_t preambleLen, | 
| GregCr | 0:e6ceb13d2d05 | 189 | bool fixLen, bool crcOn, | 
| GregCr | 0:e6ceb13d2d05 | 190 | bool iqInverted, uint32_t timeout ) = 0; | 
| GregCr | 0:e6ceb13d2d05 | 191 | |
| GregCr | 0:e6ceb13d2d05 | 192 | /*! | 
| GregCr | 0:e6ceb13d2d05 | 193 | * @brief Checks if the given RF frequency is supported by the hardware | 
| GregCr | 0:e6ceb13d2d05 | 194 | * | 
| GregCr | 0:e6ceb13d2d05 | 195 | * @param [IN] frequency RF frequency to be checked | 
| GregCr | 0:e6ceb13d2d05 | 196 | * @retval isSupported [true: supported, false: unsupported] | 
| GregCr | 0:e6ceb13d2d05 | 197 | */ | 
| GregCr | 0:e6ceb13d2d05 | 198 | virtual bool CheckRfFrequency( uint32_t frequency ) = 0; | 
| GregCr | 0:e6ceb13d2d05 | 199 | |
| GregCr | 0:e6ceb13d2d05 | 200 | /*! | 
| GregCr | 0:e6ceb13d2d05 | 201 | * @brief Computes the packet time on air for the given payload | 
| GregCr | 0:e6ceb13d2d05 | 202 | * | 
| GregCr | 0:e6ceb13d2d05 | 203 | * \Remark Can only be called once SetRxConfig or SetTxConfig have been called | 
| GregCr | 0:e6ceb13d2d05 | 204 | * | 
| GregCr | 0:e6ceb13d2d05 | 205 | * @param [IN] modem Radio modem to be used [0: FSK, 1: LoRa] | 
| GregCr | 0:e6ceb13d2d05 | 206 | * @param [IN] pktLen Packet payload length | 
| GregCr | 0:e6ceb13d2d05 | 207 | * | 
| GregCr | 0:e6ceb13d2d05 | 208 | * @retval airTime Computed airTime for the given packet payload length | 
| GregCr | 0:e6ceb13d2d05 | 209 | */ | 
| GregCr | 0:e6ceb13d2d05 | 210 | virtual double TimeOnAir ( ModemType modem, uint8_t pktLen ) = 0; | 
| GregCr | 0:e6ceb13d2d05 | 211 | |
| GregCr | 0:e6ceb13d2d05 | 212 | /*! | 
| GregCr | 0:e6ceb13d2d05 | 213 | * @brief Sends the buffer of size. Prepares the packet to be sent and sets | 
| GregCr | 0:e6ceb13d2d05 | 214 | * the radio in transmission | 
| GregCr | 0:e6ceb13d2d05 | 215 | * | 
| GregCr | 0:e6ceb13d2d05 | 216 | * @param [IN]: buffer Buffer pointer | 
| GregCr | 0:e6ceb13d2d05 | 217 | * @param [IN]: size Buffer size | 
| GregCr | 0:e6ceb13d2d05 | 218 | */ | 
| GregCr | 0:e6ceb13d2d05 | 219 | virtual void Send( uint8_t *buffer, uint8_t size ) = 0; | 
| GregCr | 0:e6ceb13d2d05 | 220 | |
| GregCr | 0:e6ceb13d2d05 | 221 | /*! | 
| GregCr | 0:e6ceb13d2d05 | 222 | * @brief Sets the radio in sleep mode | 
| GregCr | 0:e6ceb13d2d05 | 223 | */ | 
| GregCr | 0:e6ceb13d2d05 | 224 | virtual void Sleep( void ) = 0; | 
| GregCr | 0:e6ceb13d2d05 | 225 | |
| GregCr | 0:e6ceb13d2d05 | 226 | /*! | 
| GregCr | 0:e6ceb13d2d05 | 227 | * @brief Sets the radio in standby mode | 
| GregCr | 0:e6ceb13d2d05 | 228 | */ | 
| GregCr | 0:e6ceb13d2d05 | 229 | virtual void Standby( void )= 0; | 
| GregCr | 0:e6ceb13d2d05 | 230 | |
| GregCr | 0:e6ceb13d2d05 | 231 | /*! | 
| GregCr | 0:e6ceb13d2d05 | 232 | * @brief Sets the radio in reception mode for the given time | 
| GregCr | 0:e6ceb13d2d05 | 233 | * @param [IN] timeout Reception timeout [us] | 
| GregCr | 0:e6ceb13d2d05 | 234 | * [0: continuous, others timeout] | 
| GregCr | 0:e6ceb13d2d05 | 235 | */ | 
| GregCr | 0:e6ceb13d2d05 | 236 | virtual void Rx( uint32_t timeout ) = 0; | 
| GregCr | 0:e6ceb13d2d05 | 237 | |
| GregCr | 0:e6ceb13d2d05 | 238 | /*! | 
| GregCr | 0:e6ceb13d2d05 | 239 | * @brief Sets the radio in transmission mode for the given time | 
| GregCr | 0:e6ceb13d2d05 | 240 | * @param [IN] timeout Transmission timeout [us] | 
| GregCr | 0:e6ceb13d2d05 | 241 | * [0: continuous, others timeout] | 
| GregCr | 0:e6ceb13d2d05 | 242 | */ | 
| GregCr | 0:e6ceb13d2d05 | 243 | virtual void Tx( uint32_t timeout ) = 0; | 
| GregCr | 0:e6ceb13d2d05 | 244 | |
| GregCr | 0:e6ceb13d2d05 | 245 | /*! | 
| GregCr | 0:e6ceb13d2d05 | 246 | * @brief Reads the current RSSI value | 
| GregCr | 0:e6ceb13d2d05 | 247 | * | 
| GregCr | 0:e6ceb13d2d05 | 248 | * @retval rssiValue Current RSSI value in [dBm] | 
| GregCr | 0:e6ceb13d2d05 | 249 | */ | 
| GregCr | 0:e6ceb13d2d05 | 250 | virtual int8_t GetRssi ( ModemType modem ) = 0; | 
| GregCr | 0:e6ceb13d2d05 | 251 | |
| GregCr | 0:e6ceb13d2d05 | 252 | /*! | 
| GregCr | 0:e6ceb13d2d05 | 253 | * @brief Writes the radio register at the specified address | 
| GregCr | 0:e6ceb13d2d05 | 254 | * | 
| GregCr | 0:e6ceb13d2d05 | 255 | * @param [IN]: addr Register address | 
| GregCr | 0:e6ceb13d2d05 | 256 | * @param [IN]: data New register value | 
| GregCr | 0:e6ceb13d2d05 | 257 | */ | 
| GregCr | 0:e6ceb13d2d05 | 258 | virtual void Write ( uint8_t addr, uint8_t data ) = 0; | 
| GregCr | 0:e6ceb13d2d05 | 259 | |
| GregCr | 0:e6ceb13d2d05 | 260 | /*! | 
| GregCr | 0:e6ceb13d2d05 | 261 | * @brief Reads the radio register at the specified address | 
| GregCr | 0:e6ceb13d2d05 | 262 | * | 
| GregCr | 0:e6ceb13d2d05 | 263 | * @param [IN]: addr Register address | 
| GregCr | 0:e6ceb13d2d05 | 264 | * @retval data Register value | 
| GregCr | 0:e6ceb13d2d05 | 265 | */ | 
| GregCr | 0:e6ceb13d2d05 | 266 | virtual uint8_t Read ( uint8_t addr ) = 0; | 
| GregCr | 0:e6ceb13d2d05 | 267 | |
| GregCr | 0:e6ceb13d2d05 | 268 | /*! | 
| GregCr | 0:e6ceb13d2d05 | 269 | * @brief Writes multiple radio registers starting at address | 
| GregCr | 0:e6ceb13d2d05 | 270 | * | 
| GregCr | 0:e6ceb13d2d05 | 271 | * @param [IN] addr First Radio register address | 
| GregCr | 0:e6ceb13d2d05 | 272 | * @param [IN] buffer Buffer containing the new register's values | 
| GregCr | 0:e6ceb13d2d05 | 273 | * @param [IN] size Number of registers to be written | 
| GregCr | 0:e6ceb13d2d05 | 274 | */ | 
| GregCr | 0:e6ceb13d2d05 | 275 | virtual void Write( uint8_t addr, uint8_t *buffer, uint8_t size ) = 0; | 
| GregCr | 0:e6ceb13d2d05 | 276 | |
| GregCr | 0:e6ceb13d2d05 | 277 | /*! | 
| GregCr | 0:e6ceb13d2d05 | 278 | * @brief Reads multiple radio registers starting at address | 
| GregCr | 0:e6ceb13d2d05 | 279 | * | 
| GregCr | 0:e6ceb13d2d05 | 280 | * @param [IN] addr First Radio register address | 
| GregCr | 0:e6ceb13d2d05 | 281 | * @param [OUT] buffer Buffer where to copy the registers data | 
| GregCr | 0:e6ceb13d2d05 | 282 | * @param [IN] size Number of registers to be read | 
| GregCr | 0:e6ceb13d2d05 | 283 | */ | 
| GregCr | 0:e6ceb13d2d05 | 284 | virtual void Read ( uint8_t addr, uint8_t *buffer, uint8_t size ) = 0; | 
| GregCr | 0:e6ceb13d2d05 | 285 | |
| GregCr | 0:e6ceb13d2d05 | 286 | /*! | 
| GregCr | 0:e6ceb13d2d05 | 287 | * @brief Writes the buffer contents to the SX1276 FIFO | 
| GregCr | 0:e6ceb13d2d05 | 288 | * | 
| GregCr | 0:e6ceb13d2d05 | 289 | * @param [IN] buffer Buffer containing data to be put on the FIFO. | 
| GregCr | 0:e6ceb13d2d05 | 290 | * @param [IN] size Number of bytes to be written to the FIFO | 
| GregCr | 0:e6ceb13d2d05 | 291 | */ | 
| GregCr | 0:e6ceb13d2d05 | 292 | virtual void WriteFifo( uint8_t *buffer, uint8_t size ) = 0; | 
| GregCr | 0:e6ceb13d2d05 | 293 | |
| GregCr | 0:e6ceb13d2d05 | 294 | /*! | 
| GregCr | 0:e6ceb13d2d05 | 295 | * @brief Reads the contents of the SX1276 FIFO | 
| GregCr | 0:e6ceb13d2d05 | 296 | * | 
| GregCr | 0:e6ceb13d2d05 | 297 | * @param [OUT] buffer Buffer where to copy the FIFO read data. | 
| GregCr | 0:e6ceb13d2d05 | 298 | * @param [IN] size Number of bytes to be read from the FIFO | 
| GregCr | 0:e6ceb13d2d05 | 299 | */ | 
| GregCr | 0:e6ceb13d2d05 | 300 | virtual void ReadFifo( uint8_t *buffer, uint8_t size ) = 0; | 
| GregCr | 0:e6ceb13d2d05 | 301 | }; | 
| GregCr | 0:e6ceb13d2d05 | 302 | |
| GregCr | 0:e6ceb13d2d05 | 303 | #endif // __RADIO_H__ | 
| GregCr | 0:e6ceb13d2d05 | 304 |