lriot  2.1.0.0
lr1110_modem_common.h
Go to the documentation of this file.
1 
32 #ifndef LR1110_MODEM_COMMON_H
33 #define LR1110_MODEM_COMMON_H
34 
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38 
39 /*
40  * -----------------------------------------------------------------------------
41  * --- DEPENDENCIES ------------------------------------------------------------
42  */
43 
44 #include <stdbool.h>
45 #include <stdint.h>
46 
47 /*
48  * -----------------------------------------------------------------------------
49  * --- PUBLIC MACROS -----------------------------------------------------------
50  */
51 
52 /*
53  * -----------------------------------------------------------------------------
54  * --- PUBLIC CONSTANTS --------------------------------------------------------
55  */
56 
60 #define LR1110_MODEM_EVENT_RESET_COUNT_DATA_LENGTH ( 2 )
61 
65 #define LR1110_MODEM_EVENT_TX_DONE_STATUS_DATA_LENGTH ( 2 )
66 
70 #define LR1110_MODEM_EVENT_DOWN_DATA_DATA_LENGTH ( 2 )
71 
75 #define LR1110_MODEM_EVENT_UPLOAD_DONE_DATA_LENGTH ( 2 )
76 
80 #define LR1110_MODEM_EVENT_SET_CONF_DATA_LENGTH ( 2 )
81 
85 #define LR1110_MODEM_EVENT_LINK_STATUS_DATA_LENGTH ( 2 )
86 
90 #define LR1110_MODEM_EVENT_MAX_LENGTH_BUFFER ( 1024 )
91 
92 /*
93  * -----------------------------------------------------------------------------
94  * --- PUBLIC TYPES ------------------------------------------------------------
95  */
96 
100 typedef enum
101 {
107 
111 typedef enum
112 {
124 
128 typedef enum
129 {
143  0x0D,
145  0x0E,
150 
151 /*
152  * -----------------------------------------------------------------------------
153  * --- PUBLIC FUNCTIONS PROTOTYPES ---------------------------------------------
154  */
155 
156 #ifdef __cplusplus
157 }
158 #endif
159 
160 #endif // LR1110_MODEM_COMMON_H
161 
162 /* --- EOF ------------------------------------------------------------------ */
LR1110_MODEM_LORAWAN_EVENT_TIME_UPDATED_ALC_SYNC
@ LR1110_MODEM_LORAWAN_EVENT_TIME_UPDATED_ALC_SYNC
Time updated by Application Layer Clock synchronization.
Definition: lr1110_modem_common.h:142
LR1110_MODEM_LORAWAN_EVENT_STREAM_DONE
@ LR1110_MODEM_LORAWAN_EVENT_STREAM_DONE
Last data stream fragment sent.
Definition: lr1110_modem_common.h:138
LR1110_MODEM_RESPONSE_CODE_INVALID
@ LR1110_MODEM_RESPONSE_CODE_INVALID
Invalid command parameters.
Definition: lr1110_modem_common.h:116
LR1110_MODEM_GROUP_ID_WIFI
@ LR1110_MODEM_GROUP_ID_WIFI
Group ID for Wi-Fi commands.
Definition: lr1110_modem_common.h:103
LR1110_MODEM_LORAWAN_EVENT_MUTE
@ LR1110_MODEM_LORAWAN_EVENT_MUTE
Modem has been muted or un-muted by Device Manager.
Definition: lr1110_modem_common.h:137
LR1110_MODEM_LORAWAN_EVENT_RESET
@ LR1110_MODEM_LORAWAN_EVENT_RESET
Modem has reset.
Definition: lr1110_modem_common.h:130
LR1110_MODEM_LORAWAN_EVENT_NO_EVENT
@ LR1110_MODEM_LORAWAN_EVENT_NO_EVENT
No event: notify the host that no data have to be read.
Definition: lr1110_modem_common.h:148
LR1110_MODEM_RESPONSE_CODE_NO_TIME
@ LR1110_MODEM_RESPONSE_CODE_NO_TIME
GNSS time synchronisation lost.
Definition: lr1110_modem_common.h:122
LR1110_MODEM_LORAWAN_EVENT_JOIN_FAIL
@ LR1110_MODEM_LORAWAN_EVENT_JOIN_FAIL
Attempt to join network failed.
Definition: lr1110_modem_common.h:139
LR1110_MODEM_RESPONSE_CODE_NOT_INITIALIZED
@ LR1110_MODEM_RESPONSE_CODE_NOT_INITIALIZED
Command not initialized.
Definition: lr1110_modem_common.h:115
LR1110_MODEM_GROUP_ID_GNSS
@ LR1110_MODEM_GROUP_ID_GNSS
Group ID for GNSS commands.
Definition: lr1110_modem_common.h:104
lr1110_modem_api_group_id_t
lr1110_modem_api_group_id_t
Command group identifier.
Definition: lr1110_modem_common.h:101
LR1110_MODEM_LORAWAN_EVENT_ALARM
@ LR1110_MODEM_LORAWAN_EVENT_ALARM
Alarm time expired.
Definition: lr1110_modem_common.h:131
LR1110_MODEM_LORAWAN_EVENT_TX_DONE
@ LR1110_MODEM_LORAWAN_EVENT_TX_DONE
Frame transmitted.
Definition: lr1110_modem_common.h:133
LR1110_MODEM_GROUP_ID_SYSTEM
@ LR1110_MODEM_GROUP_ID_SYSTEM
Group ID for system commands.
Definition: lr1110_modem_common.h:102
LR1110_MODEM_GROUP_ID_MODEM
@ LR1110_MODEM_GROUP_ID_MODEM
Group ID for modem commands.
Definition: lr1110_modem_common.h:105
LR1110_MODEM_RESPONSE_CODE_BUSY
@ LR1110_MODEM_RESPONSE_CODE_BUSY
Command cannot be executed now.
Definition: lr1110_modem_common.h:117
LR1110_MODEM_RESPONSE_CODE_FAIL
@ LR1110_MODEM_RESPONSE_CODE_FAIL
Command execution failed.
Definition: lr1110_modem_common.h:118
LR1110_MODEM_RESPONSE_CODE_OK
@ LR1110_MODEM_RESPONSE_CODE_OK
Driver command executed successfully.
Definition: lr1110_modem_common.h:113
LR1110_MODEM_RESPONSE_CODE_BAD_FILE_UPLOAD_CRC
@ LR1110_MODEM_RESPONSE_CODE_BAD_FILE_UPLOAD_CRC
File upload CRC check failed.
Definition: lr1110_modem_common.h:119
LR1110_MODEM_LORAWAN_EVENT_WIFI_SCAN_DONE
@ LR1110_MODEM_LORAWAN_EVENT_WIFI_SCAN_DONE
Wi-Fi passive scan done.
Definition: lr1110_modem_common.h:140
lr1110_modem_lorawan_event_type_t
lr1110_modem_lorawan_event_type_t
Event type for modem operation.
Definition: lr1110_modem_common.h:129
LR1110_MODEM_RESPONSE_CODE_BAD_SIZE
@ LR1110_MODEM_RESPONSE_CODE_BAD_SIZE
Size check failed.
Definition: lr1110_modem_common.h:120
LR1110_MODEM_LORAWAN_EVENT_SET_CONF
@ LR1110_MODEM_LORAWAN_EVENT_SET_CONF
Configuration has been changed by Device Manager.
Definition: lr1110_modem_common.h:136
LR1110_MODEM_LORAWAN_EVENT_DOWN_DATA
@ LR1110_MODEM_LORAWAN_EVENT_DOWN_DATA
Downlink data received.
Definition: lr1110_modem_common.h:134
LR1110_MODEM_RESPONSE_CODE_UNKOWN
@ LR1110_MODEM_RESPONSE_CODE_UNKOWN
Command code unknown.
Definition: lr1110_modem_common.h:114
LR1110_MODEM_LORAWAN_EVENT_ADR_MOBILE_TO_STATIC
@ LR1110_MODEM_LORAWAN_EVENT_ADR_MOBILE_TO_STATIC
Definition: lr1110_modem_common.h:144
LR1110_MODEM_RESPONSE_CODE_BAD_FRAME
@ LR1110_MODEM_RESPONSE_CODE_BAD_FRAME
SPI command checksum failed or CRC failed.
Definition: lr1110_modem_common.h:121
LR1110_MODEM_LORAWAN_EVENT_NEW_LINK_ADR
@ LR1110_MODEM_LORAWAN_EVENT_NEW_LINK_ADR
Modem received a LinkADR request.
Definition: lr1110_modem_common.h:147
lr1110_modem_response_code_t
lr1110_modem_response_code_t
Command return code (RC)
Definition: lr1110_modem_common.h:112
LR1110_MODEM_LORAWAN_EVENT_UPLOAD_DONE
@ LR1110_MODEM_LORAWAN_EVENT_UPLOAD_DONE
File upload completed.
Definition: lr1110_modem_common.h:135
LR1110_MODEM_LORAWAN_EVENT_GNSS_SCAN_DONE
@ LR1110_MODEM_LORAWAN_EVENT_GNSS_SCAN_DONE
GNSS scan done or almanac update done.
Definition: lr1110_modem_common.h:141
LR1110_MODEM_LORAWAN_EVENT_JOINED
@ LR1110_MODEM_LORAWAN_EVENT_JOINED
Network successfully joined.
Definition: lr1110_modem_common.h:132