MultiTech / fota-mdot

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:   UQ_LoraWAN

mdot/Lora/Radio/SxRadioEvents.h@8:7ba1f2abb8c0, 2019-01-15 (annotated)

Committer:
rklaassen
Date:
Tue Jan 15 09:25:58 2019 -0600
Revision:
8:7ba1f2abb8c0
Parent:
3:63d10f2375ea 
README test

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 1 /*
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 2 / _____) _ | |
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 3 ( (____ _____ ____ _| |_ _____ ____| |__
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 4 \____ \| ___ | (_ _) ___ |/ ___) _ \
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 5 _____) ) ____| | | || |_| ____( (___| | | |
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 6 (______/|_____)_|_|_| \__)_____)\____)_| |_|
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 7 (C)2013 Semtech
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 8
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 9 Description: Generic radio driver definition
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 10
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 11 License: Revised BSD License, see LICENSE.TXT file include in the project
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 12
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 13 Maintainer: Miguel Luis and Gregory Cristian
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 14 */
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 15 #ifndef __SXRADIOEVENTS_H__
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 16 #define __SXRADIOEVENTS_H__
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 17
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 18 /*!
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 19 * \brief Radio driver callback functions
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 20 */
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 21 class SxRadioEvents
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 22 {
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 23 public:
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 24 /*!
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 25 * \brief Tx Start callback prototype.
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 26 */
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 27 virtual void TxStart( void ) {}
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 28 /*!
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 29 * \brief Tx Done callback prototype.
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 30 */
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 31 virtual void TxDone( void ) {}
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 32 /*!
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 33 * \brief Tx Timeout callback prototype.
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 34 */
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 35 virtual void TxTimeout( void ) {}
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 36 /*!
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 37 * \brief Rx Done callback prototype.
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 38 *
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 39 * \param [IN] payload Received buffer pointer
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 40 * \param [IN] size Received buffer size
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 41 * \param [IN] rssi RSSI value computed while receiving the frame [dBm]
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 42 * \param [IN] snr Raw SNR value given by the radio hardware
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 43 * FSK : N/A ( set to 0 )
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 44 * LoRa: SNR value is two's complement in 1/4 dB
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 45 */
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 46 virtual void RxDone( uint8_t *payload, uint16_t size, int16_t rssi, int8_t snr ) {}
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 47 /*!
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 48 * \brief Rx Timeout callback prototype.
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 49 */
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 50 virtual void RxTimeout( void ) {}
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 51 /*!
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 52 * \brief Rx Error callback prototype.
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 53 */
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 54 virtual void RxError( void ) {}
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 55 /*!
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 56 * \brief FHSS Change Channel callback prototype.
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 57 *
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 58 * \param [IN] currentChannel Index number of the current channel
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 59 */
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 60 virtual void FhssChangeChannel( uint8_t currentChannel ) {}
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 61 /*!
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 62 * \brief CAD Done callback prototype.
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 63 *
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 64 * \param [IN] channelActivityDetected Channel Activity detected during the CAD
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 65 */
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 66 virtual void CadDone( bool channelActivityDetected ) {}
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 67 /*!
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 68 * \brief Mac Event callback prototype.
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 69 */
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 70 virtual void MacEvent( void ) {}
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 71
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 72 virtual void LinkIdle(void) {}
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 73 };
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 74
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 75 #endif // __SXRADIOEVENTS_H__
Jenkins@KEILDM1.dc.multitech.prv 3:63d10f2375ea 76