nguyen hoang / libmDot-dev-mbed5

khang_91

SxRadioEvents.h@82:0f5a742a08cd, 2017-06-19 (annotated)

Committer:
Jenkins@KEILDM1.dc.multitech.prv
Date:
Mon Jun 19 16:03:40 2017 -0500
Revision:
82:0f5a742a08cd
Child:
114:8462870088eb
mdot-library revision 3.0.0-rc7-1-ga5165ae and mbed-os revision mbed-os-5.4.7

Who changed what in which revision?

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