Diff: SxRadioEvents.h

Revision:

61:58ed1e136af5

Child:

64:64982192a2af

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/SxRadioEvents.h	Thu Jul 27 10:43:57 2017 -0500
@@ -0,0 +1,72 @@
+/*
+ / _____)             _              | |
+( (____  _____ ____ _| |_ _____  ____| |__
+ \____ \| ___ |    (_   _) ___ |/ ___)  _ \
+ _____) ) ____| | | || |_| ____( (___| | | |
+(______/|_____)_|_|_| \__)_____)\____)_| |_|
+    (C)2013 Semtech
+
+Description: Generic radio driver definition
+
+License: Revised BSD License, see LICENSE.TXT file include in the project
+
+Maintainer: Miguel Luis and Gregory Cristian
+*/
+#ifndef __SXRADIOEVENTS_H__
+#define __SXRADIOEVENTS_H__
+
+/*!
+ * \brief Radio driver callback functions
+ */
+class SxRadioEvents
+{
+public:
+    /*!
+     * \brief  Tx Done callback prototype.
+     */
+    virtual void TxDone( void ) {}
+    /*!
+     * \brief  Tx Timeout callback prototype.
+     */
+    virtual void TxTimeout( void ) {}
+    /*!
+     * \brief Rx Done callback prototype.
+     *
+     * \param [IN] payload Received buffer pointer
+     * \param [IN] size    Received buffer size
+     * \param [IN] rssi    RSSI value computed while receiving the frame [dBm]
+     * \param [IN] snr     Raw SNR value given by the radio hardware
+     *                     FSK : N/A ( set to 0 )
+     *                     LoRa: SNR value is two's complement in 1/4 dB
+     */
+    virtual void RxDone( uint8_t *payload, uint16_t size, int16_t rssi, int8_t snr ) {}
+    /*!
+     * \brief  Rx Timeout callback prototype.
+     */
+    virtual void RxTimeout( void ) {}
+    /*!
+     * \brief Rx Error callback prototype.
+     */
+    virtual void RxError( void ) {}
+    /*!
+     * \brief  FHSS Change Channel callback prototype.
+     *
+     * \param [IN] currentChannel   Index number of the current channel
+     */
+    virtual void FhssChangeChannel( uint8_t currentChannel ) {}
+    /*!
+     * \brief CAD Done callback prototype.
+     *
+     * \param [IN] channelActivityDetected  Channel Activity detected during the CAD
+     */
+    virtual void CadDone( bool channelActivityDetected ) {}
+    /*!
+     * \brief Mac Event callback prototype.
+     */
+    virtual void MacEvent( void ) {}
+
+    virtual void LinkIdle(void) {}
+};
+
+#endif // __SXRADIOEVENTS_H__
+