m2mb API docs  25.30.004.0
m2mb API sets documentation
m2mb_atp_profile.h
Go to the documentation of this file.
1 /* $version: 252203 */
2 /*===============================================================================================*/
3 /* >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<< */
23 #ifndef M2M_M2MB_ATP_PROFILE_API_H
24 #define M2M_M2MB_ATP_PROFILE_API_H
25 
26 
27 /* Global declarations ==========================================================================*/
28 
29 #define M2MB_ATP_PROFILE_PARAM_REGISTER(paramString, paramFlags, paramDefault, paramType) \
30 m2mb_atp_profile_param_register((CHAR*)paramString, (UINT16)paramFlags, (void*)paramDefault, (UINT16)(sizeof(paramType)))
31 #define M2MB_ATP_PROFILE_PARAM_SET(h, instanceNum, paramString, paramValue, paramType) \
32  m2mb_atp_profile_param_set((M2MB_ATP_HANDLE)h, (UINT16)instanceNum, (CHAR*)paramString, (void*)paramValue, (UINT16)(sizeof(paramType)))
33 #define M2MB_ATP_PROFILE_PARAM_GET(h, instanceNum, paramString, paramValue, paramType) \
34  m2mb_atp_profile_param_get((M2MB_ATP_HANDLE)h, (UINT16)instanceNum, (CHAR*)paramString, (void*)paramValue, (UINT16)(sizeof(paramType)))
35 
36 #define M2MB_ATP_BASE_PROFILE_FLAG 0x80
37 
38 typedef enum
39 {
40  M2MB_ATP_PI_FIRST = 0,
41  M2MB_ATP_PI_SECOND,
42  M2MB_ATP_PI_MAX,
43  M2MB_ATP_PI_BASE_FIRST = (M2MB_ATP_BASE_PROFILE_FLAG | M2MB_ATP_PI_FIRST),
44  M2MB_ATP_PI_BASE_SECOND,
45  M2MB_ATP_PI_BASE_MAX
46 } M2MB_ATP_PROFILE_INDEX_E;
47 
48 typedef enum
49 {
50  M2MB_ATP_COMMON_PROFILE = 0,
51  M2MB_ATP_INSTANCE_PROFILE
52 } M2MB_ATP_PROFILE_TYPE_E;
53 
54 /* Global functions =============================================================================*/
55 /*-----------------------------------------------------------------------------------------------*/
99 /*-----------------------------------------------------------------------------------------------*/
100 M2MB_RESULT_E m2mb_atp_profile_param_register( M2MB_ATP_HANDLE h, CHAR *paramString, M2MB_ATP_PROFILE_TYPE_E paramFlags, void *paramDefault, UINT16 paramSize );
101 
102 /*-----------------------------------------------------------------------------------------------*/
175 /*-----------------------------------------------------------------------------------------------*/
176 M2MB_RESULT_E m2mb_atp_profile_param_set( M2MB_ATP_HANDLE h, UINT16 instanceNum, CHAR *paramString, void *paramValue, UINT16 paramSize );
177 
178 /*-----------------------------------------------------------------------------------------------*/
251 /*-----------------------------------------------------------------------------------------------*/
252 M2MB_RESULT_E m2mb_atp_profile_param_get( M2MB_ATP_HANDLE h, UINT16 instanceNum, CHAR *paramString, void *paramValue, UINT16 paramSize );
253 
254 /*-----------------------------------------------------------------------------------------------*/
325 /*-----------------------------------------------------------------------------------------------*/
326 M2MB_RESULT_E m2mb_atp_profile_param_restore( M2MB_ATP_HANDLE h, UINT16 instanceNum, CHAR *paramString );
327 
328 /*-----------------------------------------------------------------------------------------------*/
399 /*-----------------------------------------------------------------------------------------------*/
400 M2MB_RESULT_E m2mb_atp_profile_set_active_profile( M2MB_ATP_HANDLE h, UINT16 instanceNum, M2MB_ATP_PROFILE_INDEX_E profileID );
401 
402 /*-----------------------------------------------------------------------------------------------*/
473 /*-----------------------------------------------------------------------------------------------*/
474 M2MB_RESULT_E m2mb_atp_profile_get_active_profile( M2MB_ATP_HANDLE h, UINT16 instanceNum, M2MB_ATP_PROFILE_INDEX_E *profileID );
475 
476 /*-----------------------------------------------------------------------------------------------*/
548 /*-----------------------------------------------------------------------------------------------*/
549 M2MB_RESULT_E m2mb_atp_profile_param_store( M2MB_ATP_HANDLE h, UINT16 instanceNum, CHAR *paramString, M2MB_ATP_PROFILE_INDEX_E profileID );
550 
551 
552 
553 #endif
554 
m2mb_atp_profile_param_set
M2MB_RESULT_E m2mb_atp_profile_param_set(M2MB_ATP_HANDLE h, UINT16 instanceNum, CHAR *paramString, void *paramValue, UINT16 paramSize)
m2mb_atp_profile_param_set sets value for a registered command parameter.
m2mb_atp_profile_param_restore
M2MB_RESULT_E m2mb_atp_profile_param_restore(M2MB_ATP_HANDLE h, UINT16 instanceNum, CHAR *paramString)
m2mb_atp_profile_param_restore resets all registered command parameters to their default value.
m2mb_atp_profile_param_store
M2MB_RESULT_E m2mb_atp_profile_param_store(M2MB_ATP_HANDLE h, UINT16 instanceNum, CHAR *paramString, M2MB_ATP_PROFILE_INDEX_E profileID)
m2mb_atp_profile_param_store stores current value of a command parameter in a permanent (not volatile...
m2mb_atp_profile_param_register
M2MB_RESULT_E m2mb_atp_profile_param_register(M2MB_ATP_HANDLE h, CHAR *paramString, M2MB_ATP_PROFILE_TYPE_E paramFlags, void *paramDefault, UINT16 paramSize)
m2mb_atp_profile_param_register registers a command parameter.
m2mb_atp_profile_get_active_profile
M2MB_RESULT_E m2mb_atp_profile_get_active_profile(M2MB_ATP_HANDLE h, UINT16 instanceNum, M2MB_ATP_PROFILE_INDEX_E *profileID)
m2mb_atp_profile_get_active_profile gets active profile.
m2mb_atp_profile_set_active_profile
M2MB_RESULT_E m2mb_atp_profile_set_active_profile(M2MB_ATP_HANDLE h, UINT16 instanceNum, M2MB_ATP_PROFILE_INDEX_E profileID)
m2mb_atp_profile_set_active_profile sets active profile.
m2mb_atp_profile_param_get
M2MB_RESULT_E m2mb_atp_profile_param_get(M2MB_ATP_HANDLE h, UINT16 instanceNum, CHAR *paramString, void *paramValue, UINT16 paramSize)
m2mb_atp_profile_param_get gets value for a registered command parameter.