m2mb API docs  30.00.007
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. <<< */
20 #ifndef M2M_M2MB_SYS_H
21 #define M2M_M2MB_SYS_H
22 
23 /* Global declarations ==========================================================================*/
24 
25 /* Global typedefs ==============================================================================*/
26 typedef HANDLE M2MB_SYS_HANDLE;
27 
28 typedef enum
29 {
34  M2MB_SYS_OP_MODE_UNKNOWN,
35  M2MB_SYS_OP_MODE_MAX_VAL
37 
38 typedef enum
39 {
40  M2MB_SYS_NULL_RESP,
41  M2MB_SYS_GET_OPERATING_MODE_RESP,
42  M2MB_SYS_SET_OPERATING_MODE_RESP,
43  M2MB_SYS_OPERATING_MODE_CHANGED_IND
44 } M2MB_SYS_IND_E;
45 
46 typedef enum
47 {
48  M2MB_SYS_ERR_OK,
49  M2MB_SYS_ERR_UNKNOWN
50 } M2MB_SYS_ERR_CAUSE_E;
51 
52 typedef struct
53 {
54  M2MB_SYS_OP_MODE_E operatingMode;
55  BOOLEAN persistent;
57 
58 typedef struct
59 {
60  M2MB_SYS_ERR_CAUSE_E err;
61  M2MB_SYS_OPERATING_MODE_T operatingMode_s;
63 
64 typedef struct
65 {
66  M2MB_SYS_ERR_CAUSE_E err;
67  M2MB_RESULT_E response;
69 
70 typedef void ( *m2mb_sys_ind_callback )( M2MB_SYS_HANDLE h, M2MB_SYS_IND_E sys_event, UINT16 resp_size, void *resp_struct, void *userdata );
71 /* Global functions =============================================================================*/
72 
73 /*-----------------------------------------------------------------------------------------------*/
111 /*-----------------------------------------------------------------------------------------------*/
112 M2MB_RESULT_E m2mb_sys_init( M2MB_SYS_HANDLE *h, m2mb_sys_ind_callback callback, void *userdata );
113 
114 /*-----------------------------------------------------------------------------------------------*/
146 /*-----------------------------------------------------------------------------------------------*/
147 M2MB_RESULT_E m2mb_sys_deinit( M2MB_SYS_HANDLE h );
148 
149 /*-----------------------------------------------------------------------------------------------*/
201 /*-----------------------------------------------------------------------------------------------*/
202 M2MB_RESULT_E m2mb_sys_get_operating_mode( M2MB_SYS_HANDLE h );
203 
204 /*-----------------------------------------------------------------------------------------------*/
260 /*-----------------------------------------------------------------------------------------------*/
261 M2MB_RESULT_E m2mb_sys_set_operating_mode( M2MB_SYS_HANDLE h, M2MB_SYS_OP_MODE_E operatingMode, BOOLEAN persistent );
262 
263 
264 
265 
266 /*-----------------------------------------------------------------------------------------------*/
286 /*-----------------------------------------------------------------------------------------------*/
287 M2MB_RESULT_E m2mb_sys_reboot
288 (
289  int Type
290 );
291 
292 
293 
294 
295 #endif /* M2M_M2MB_SYS_H */
296 
M2MB_SYS_GET_OPERATING_MODE_RESP_T
Definition: m2mb_sys.h:58
M2MB_SYS_OP_MODE_LOW_POWER
Definition: m2mb_sys.h:31
M2MB_SYS_OP_MODE_E
M2MB_SYS_OP_MODE_E
Definition: m2mb_sys.h:28
M2MB_SYS_OP_MODE_FACTORY_TEST_MODE
Definition: m2mb_sys.h:32
M2MB_SYS_OP_MODE_ONLINE
Definition: m2mb_sys.h:30
M2MB_SYS_OPERATING_MODE_T
Definition: m2mb_sys.h:52
M2MB_SYS_OP_MODE_OFFLINE
Definition: m2mb_sys.h:33
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 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:64
m2mb_sys_reboot
M2MB_RESULT_E m2mb_sys_reboot(int Type)
m2mb_sys_reboot restarts all the system
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 information about operating mode.