m2mb API docs  25.30.003
m2mb API sets documentation
m2mb_sys.h
Go to the documentation of this file.
1 /*===============================================================================================*/
2 /* >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<< */
36 #ifndef M2M_M2MB_SYS_H
37 #define M2M_M2MB_SYS_H
38 
39 /* Global declarations ==========================================================================*/
40 
41 /* Global typedefs ==============================================================================*/
42 typedef HANDLE M2MB_SYS_HANDLE;
43 
44 typedef enum
45 {
50  M2MB_SYS_OP_MODE_UNKNOWN,
51  M2MB_SYS_OP_MODE_MAX_VAL
53 
54 typedef enum
55 {
56  M2MB_SYS_NULL_RESP,
57  M2MB_SYS_GET_OPERATING_MODE_RESP,
58  M2MB_SYS_SET_OPERATING_MODE_RESP,
59  M2MB_SYS_OPERATING_MODE_CHANGED_IND
60 } M2MB_SYS_IND_E;
61 
62 typedef enum
63 {
64  M2MB_SYS_ERR_OK,
65  M2MB_SYS_ERR_UNKNOWN
66 } M2MB_SYS_ERR_CAUSE_E;
67 
68 typedef struct
69 {
70  M2MB_SYS_OP_MODE_E operatingMode;
71  BOOLEAN persistent;
73 
74 typedef struct
75 {
76  M2MB_SYS_ERR_CAUSE_E err;
77  M2MB_SYS_OPERATING_MODE_T operatingMode_s;
79 
80 typedef struct
81 {
82  M2MB_SYS_ERR_CAUSE_E err;
83  M2MB_RESULT_E response;
85 
86 typedef void ( *m2mb_sys_ind_callback )( M2MB_SYS_HANDLE h, M2MB_SYS_IND_E sys_event, UINT16 resp_size, void *resp_struct, void *userdata );
87 /* Global functions =============================================================================*/
88 
89 /*-----------------------------------------------------------------------------------------------*/
130 /*-----------------------------------------------------------------------------------------------*/
131 M2MB_RESULT_E m2mb_sys_init( M2MB_SYS_HANDLE *h, m2mb_sys_ind_callback callback, void *userdata );
132 
133 /*-----------------------------------------------------------------------------------------------*/
167 /*-----------------------------------------------------------------------------------------------*/
168 M2MB_RESULT_E m2mb_sys_deinit( M2MB_SYS_HANDLE h );
169 
170 /*-----------------------------------------------------------------------------------------------*/
226 /*-----------------------------------------------------------------------------------------------*/
227 M2MB_RESULT_E m2mb_sys_get_operating_mode( M2MB_SYS_HANDLE h );
228 
229 /*-----------------------------------------------------------------------------------------------*/
300 /*-----------------------------------------------------------------------------------------------*/
301 M2MB_RESULT_E m2mb_sys_set_operating_mode( M2MB_SYS_HANDLE h, M2MB_SYS_OP_MODE_E operatingMode, BOOLEAN persistent );
302 
303 
304 
305 #endif /* M2M_M2MB_SYS_H */
306 
M2MB_SYS_GET_OPERATING_MODE_RESP_T
Definition: m2mb_sys.h:74
M2MB_SYS_OP_MODE_LOW_POWER
Definition: m2mb_sys.h:47
M2MB_SYS_OP_MODE_E
M2MB_SYS_OP_MODE_E
Definition: m2mb_sys.h:44
M2MB_SYS_OP_MODE_FACTORY_TEST_MODE
Definition: m2mb_sys.h:48
M2MB_SYS_OP_MODE_ONLINE
Definition: m2mb_sys.h:46
M2MB_SYS_OPERATING_MODE_T
Definition: m2mb_sys.h:68
M2MB_SYS_OP_MODE_OFFLINE
Definition: m2mb_sys.h:49
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:80
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.