1 /*!
2  * \file      LmHandlerMsgDisplay.h
3  *
4  * \brief     Common set of functions to display default messages from
5  *            LoRaMacHandler.
6  *
7  * \copyright Revised BSD License, see section \ref LICENSE.
8  *
9  * \code
10  *                ______                              _
11  *               / _____)             _              | |
12  *              ( (____  _____ ____ _| |_ _____  ____| |__
13  *               \____ \| ___ |    (_   _) ___ |/ ___)  _ \
14  *               _____) ) ____| | | || |_| ____( (___| | | |
15  *              (______/|_____)_|_|_| \__)_____)\____)_| |_|
16  *              (C)2013-2019 Semtech
17  *
18  * \endcode
19  *
20  * \author    Miguel Luis ( Semtech )
21  */
22 #ifndef __LMHANDLER_MSG_DISPLAY_H__
23 #define __LMHANDLER_MSG_DISPLAY_H__
24 
25 #ifdef __cplusplus
26 extern "C" {
27 #endif
28 
29 #include "utilities.h"
30 #include "LmHandler.h"
31 
32 /*!
33  * \brief Displays NVM context operation state
34  *
35  * \param [IN] state Indicates if we are storing (true) or
36  *                    restoring (false) the NVM context
37  *
38  * \param [IN] size Number of data bytes which were stored or restored.
39  */
40 void DisplayNvmDataChange( LmHandlerNvmContextStates_t state, uint16_t size );
41 
42 /*!
43  * \brief Displays updated network parameters
44  *
45  * \param [IN] commissioningParams Commissioning provided parameters
46  */
47 void DisplayNetworkParametersUpdate( CommissioningParams_t* commissioningParams );
48 
49 /*!
50  * \brief Displays updated McpsRequest
51  *
52  * \param [IN] status McpsRequest execution status
53  * \param [IN] mcpsReq McpsRequest command executed
54  * \param [IN] nextTxIn Time to wait for the next uplink transmission
55  */
56 void DisplayMacMcpsRequestUpdate( LoRaMacStatus_t status, McpsReq_t *mcpsReq, TimerTime_t nextTxIn );
57 
58 /*!
59  * \brief Displays updated MlmeRequest
60  *
61  * \param [IN] status MlmeRequest execution status
62  * \param [IN] mlmeReq MlmeRequest command executed
63  * \param [IN] nextTxIn Time to wait for the next uplink transmission
64  */
65 void DisplayMacMlmeRequestUpdate( LoRaMacStatus_t status, MlmeReq_t *mlmeReq, TimerTime_t nextTxIn );
66 
67 /*!
68  * \brief Displays updated JoinRequest
69  *
70  * \param [IN] params Executed JoinRequest parameters
71  */
72 void DisplayJoinRequestUpdate( LmHandlerJoinParams_t* params );
73 
74 /*!
75  * \brief Displays Tx params
76  *
77  * \param [IN] params Tx parameters
78  */
79 void DisplayTxUpdate( LmHandlerTxParams_t* params );
80 
81 /*!
82  * \brief Displays Rx params
83  *
84  * \param [IN] appData Receive data payload and port number
85  * \param [IN] params Rx parameters
86  */
87 void DisplayRxUpdate( LmHandlerAppData_t* appData, LmHandlerRxParams_t* params );
88 
89 /*!
90  * \brief Displays beacon status update
91  *
92  * \param [IN] params Beacon parameters
93  */
94 void DisplayBeaconUpdate( LoRaMacHandlerBeaconParams_t* params );
95 
96 /*!
97  * \brief Displays end-device class update
98  *
99  * \param [IN] deviceClass Current end-device class
100  */
101 void DisplayClassUpdate( DeviceClass_t deviceClass );
102 
103 /*!
104  * \brief Displays application information
105  */
106 void DisplayAppInfo( const char* appName, const Version_t* appVersion, const Version_t* gitHubVersion );
107 
108 #ifdef __cplusplus
109 }
110 #endif
111 
112 #endif // __LMHANDLER_MSG_DISPLAY_H__
113