m2mb API docs  25.30.004.0
m2mb API sets documentation
m2mb_sys.h
Go to the documentation of this file.
1 /* $version: 252203 */
2 /*===============================================================================================*/
3 /* >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<< */
37 #ifndef M2M_M2MB_SYS_H
38 #define M2M_M2MB_SYS_H
39 
40 /* Global declarations ==========================================================================*/
41 
42 /* Global typedefs ==============================================================================*/
43 typedef HANDLE M2MB_SYS_HANDLE;
44 
45 typedef enum
46 {
51  M2MB_SYS_OP_MODE_UNKNOWN,
52  M2MB_SYS_OP_MODE_MAX_VAL
54 
55 typedef enum
56 {
57  M2MB_SYS_NULL_RESP,
58  M2MB_SYS_GET_OPERATING_MODE_RESP,
59  M2MB_SYS_SET_OPERATING_MODE_RESP,
60  M2MB_SYS_OPERATING_MODE_CHANGED_IND
61 } M2MB_SYS_IND_E;
62 
63 typedef enum
64 {
65  M2MB_SYS_ERR_OK,
66  M2MB_SYS_ERR_UNKNOWN
67 } M2MB_SYS_ERR_CAUSE_E;
68 
69 typedef struct
70 {
71  M2MB_SYS_OP_MODE_E operatingMode;
72  BOOLEAN persistent;
74 
75 typedef struct
76 {
77  M2MB_SYS_ERR_CAUSE_E err;
78  M2MB_SYS_OPERATING_MODE_T operatingMode_s;
80 
81 typedef struct
82 {
83  M2MB_SYS_ERR_CAUSE_E err;
84  M2MB_RESULT_E response;
86 
87 typedef void ( *m2mb_sys_ind_callback )( M2MB_SYS_HANDLE h, M2MB_SYS_IND_E sys_event, UINT16 resp_size, void *resp_struct, void *userdata );
88 /* Global functions =============================================================================*/
89 
90 /*-----------------------------------------------------------------------------------------------*/
131 /*-----------------------------------------------------------------------------------------------*/
132 M2MB_RESULT_E m2mb_sys_init( M2MB_SYS_HANDLE *h, m2mb_sys_ind_callback callback, void *userdata );
133 
134 /*-----------------------------------------------------------------------------------------------*/
168 /*-----------------------------------------------------------------------------------------------*/
169 M2MB_RESULT_E m2mb_sys_deinit( M2MB_SYS_HANDLE h );
170 
171 /*-----------------------------------------------------------------------------------------------*/
227 /*-----------------------------------------------------------------------------------------------*/
228 M2MB_RESULT_E m2mb_sys_get_operating_mode( M2MB_SYS_HANDLE h );
229 
230 /*-----------------------------------------------------------------------------------------------*/
301 /*-----------------------------------------------------------------------------------------------*/
302 M2MB_RESULT_E m2mb_sys_set_operating_mode( M2MB_SYS_HANDLE h, M2MB_SYS_OP_MODE_E operatingMode, BOOLEAN persistent );
303 
304 
305 
306 #endif /* M2M_M2MB_SYS_H */
307 
M2MB_SYS_GET_OPERATING_MODE_RESP_T
Definition: m2mb_sys.h:75
M2MB_SYS_OP_MODE_LOW_POWER
Definition: m2mb_sys.h:48
M2MB_SYS_OP_MODE_E
M2MB_SYS_OP_MODE_E
Definition: m2mb_sys.h:45
M2MB_SYS_OP_MODE_FACTORY_TEST_MODE
Definition: m2mb_sys.h:49
M2MB_SYS_OP_MODE_ONLINE
Definition: m2mb_sys.h:47
M2MB_SYS_OPERATING_MODE_T
Definition: m2mb_sys.h:69
M2MB_SYS_OP_MODE_OFFLINE
Definition: m2mb_sys.h:50
m2mb_sys_deinit
M2MB_RESULT_E m2mb_sys_deinit(M2MB_SYS_HANDLE h)
m2mb_sys_deinit deinitializes SYS service for current client.
m2mb_sys_get_operating_mode
M2MB_RESULT_E m2mb_sys_get_operating_mode(M2MB_SYS_HANDLE h)
m2mb_sys_get_operating_mode gets information about the current operating mode.
m2mb_sys_init
M2MB_RESULT_E m2mb_sys_init(M2MB_SYS_HANDLE *h, m2mb_sys_ind_callback callback, void *userdata)
m2mb_sys_init initializes SYS service for current client.
M2MB_SYS_GENERIC_RESP_T
Definition: m2mb_sys.h:81
m2mb_sys_set_operating_mode
M2MB_RESULT_E m2mb_sys_set_operating_mode(M2MB_SYS_HANDLE h, M2MB_SYS_OP_MODE_E operatingMode, BOOLEAN persistent)
m2mb_sys_set_operating_mode sets the operating mode.