student-devel / libmDot-mbed5

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.

Fork of libmDot-mbed5 by MultiTech

SxRadioEvents.h@61:58ed1e136af5, 2017-07-27 (annotated)

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