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 #include "utilities.h"
26 #include "LmHandler.h"
27 
28 /*!
29  * \brief Displays NVM context operation state
30  *
31  * \param [IN] state Indicates if we are storing (true) or
32  *                    restoring (false) the NVM context
33  *
34  * \param [IN] size Number of data bytes which were stored or restored.
35  */
36 void DisplayNvmDataChange( LmHandlerNvmContextStates_t state, uint16_t size );
37 
38 /*!
39  * \brief Displays updated network parameters
40  *
41  * \param [IN] commissioningParams Commissioning provided parameters
42  */
43 void DisplayNetworkParametersUpdate( CommissioningParams_t* commissioningParams );
44 
45 /*!
46  * \brief Displays updated McpsRequest
47  *
48  * \param [IN] status McpsRequest execution status
49  * \param [IN] mcpsReq McpsRequest command executed
50  * \param [IN] nextTxIn Time to wait for the next uplink transmission
51  */
52 void DisplayMacMcpsRequestUpdate( LoRaMacStatus_t status, McpsReq_t *mcpsReq, TimerTime_t nextTxIn );
53 
54 /*!
55  * \brief Displays updated MlmeRequest
56  *
57  * \param [IN] status MlmeRequest execution status
58  * \param [IN] mlmeReq MlmeRequest command executed
59  * \param [IN] nextTxIn Time to wait for the next uplink transmission
60  */
61 void DisplayMacMlmeRequestUpdate( LoRaMacStatus_t status, MlmeReq_t *mlmeReq, TimerTime_t nextTxIn );
62 
63 /*!
64  * \brief Displays updated JoinRequest
65  *
66  * \param [IN] params Executed JoinRequest parameters
67  */
68 void DisplayJoinRequestUpdate( LmHandlerJoinParams_t* params );
69 
70 /*!
71  * \brief Displays Tx params
72  *
73  * \param [IN] params Tx parameters
74  */
75 void DisplayTxUpdate( LmHandlerTxParams_t* params );
76 
77 /*!
78  * \brief Displays Rx params
79  *
80  * \param [IN] appData Receive data payload and port number
81  * \param [IN] params Rx parameters
82  */
83 void DisplayRxUpdate( LmHandlerAppData_t* appData, LmHandlerRxParams_t* params );
84 
85 /*!
86  * \brief Displays beacon status update
87  *
88  * \param [IN] params Beacon parameters
89  */
90 void DisplayBeaconUpdate( LoRaMacHandlerBeaconParams_t* params );
91 
92 /*!
93  * \brief Displays end-device class update
94  *
95  * \param [IN] deviceClass Current end-device class
96  */
97 void DisplayClassUpdate( DeviceClass_t deviceClass );
98 
99 /*!
100  * \brief Displays application information
101  */
102 void DisplayAppInfo( const char* appName, const Version_t* appVersion, const Version_t* gitHubVersion );
103 
104 #endif // __LMHANDLER_MSG_DISPLAY_H__
105