nguyen hoang / libmDot-dev-mbed5

khang_91

SxRadioEvents.h@183:16414698889c, 2020-06-23 (annotated)

Committer:
nguyenhoang9x5555
Date:
Tue Jun 23 07:26:42 2020 +0000
Revision:
183:16414698889c
Parent:
114:8462870088eb 
phienbanthunghiem

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 114:8462870088eb 25 * \brief Tx Start callback prototype.
Jenkins@KEILDM1.dc.multitech.prv 114:8462870088eb 26 */
Jenkins@KEILDM1.dc.multitech.prv 114:8462870088eb 27 virtual void TxStart( void ) {}
Jenkins@KEILDM1.dc.multitech.prv 114:8462870088eb 28 /*!
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 29 * \brief Tx Done callback prototype.
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 30 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 31 virtual void TxDone( void ) {}
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 32 /*!
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 33 * \brief Tx Timeout callback prototype.
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 34 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 35 virtual void TxTimeout( void ) {}
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 36 /*!
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 37 * \brief Rx Done callback prototype.
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 38 *
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 39 * \param [IN] payload Received buffer pointer
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 40 * \param [IN] size Received buffer size
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 41 * \param [IN] rssi RSSI value computed while receiving the frame [dBm]
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 42 * \param [IN] snr Raw SNR value given by the radio hardware
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 43 * FSK : N/A ( set to 0 )
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 44 * LoRa: SNR value is two's complement in 1/4 dB
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 45 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 46 virtual void RxDone( uint8_t *payload, uint16_t size, int16_t rssi, int8_t snr ) {}
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 47 /*!
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 48 * \brief Rx Timeout callback prototype.
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 49 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 50 virtual void RxTimeout( void ) {}
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 51 /*!
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 52 * \brief Rx Error callback prototype.
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 53 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 54 virtual void RxError( void ) {}
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 55 /*!
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 56 * \brief FHSS Change Channel callback prototype.
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 57 *
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 58 * \param [IN] currentChannel Index number of the current channel
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 59 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 60 virtual void FhssChangeChannel( uint8_t currentChannel ) {}
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 61 /*!
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 62 * \brief CAD Done callback prototype.
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 63 *
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 64 * \param [IN] channelActivityDetected Channel Activity detected during the CAD
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 65 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 66 virtual void CadDone( bool channelActivityDetected ) {}
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 67 /*!
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 68 * \brief Mac Event callback prototype.
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 69 */
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 70 virtual void MacEvent( void ) {}
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 71
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 72 virtual void LinkIdle(void) {}
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 73 };
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 74
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 75 #endif // __SXRADIOEVENTS_H__
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 76