xt-sdk 文档
v1.0.3
xt-sdk 嵌入式 SDK API 参考
Toggle main menu visibility
载入中...
搜索中...
未找到
xt_mobile.h
浏览该文件的文档.
1
12
13
#ifndef __XT_MOBILE_H__
14
#define __XT_MOBILE_H__
15
16
/* ==================== [Includes] ========================================== */
17
18
#include "
xt_error.h
"
19
20
#ifdef __cplusplus
21
extern
"C"
{
22
#endif
23
30
31
/* ==================== [Defines] =========================================== */
32
33
#define XT_MOBILE_IMEI_MAX_LEN 16
34
#define XT_MOBILE_SIM_0 0
35
#define XT_MOBILE_SIM_1 1
36
#define XT_MOBILE_SIM_NUM_MAX XT_MOBILE_SIM_1
37
38
/* SIM 卡状态 */
39
#define XT_MOBILE_USIM_NOT_READY -4
40
#define XT_MOBILE_USIM_TIMEOUT -3
41
#define XT_MOBILE_USIM_NOT_INSERTED -2
42
#define XT_MOBILE_USIM_UNKNOW -1
43
#define XT_MOBILE_USIM_READY 0
44
#define XT_MOBILE_USIM_SIMPIN 1
45
#define XT_MOBILE_USIM_SIMPUK 2
46
47
#define XT_MOBILE_CELLINFO_MAX_LEN 10
48
49
/* ==================== [Typedefs] ========================================== */
50
54
enum
xt_mobile_event_id
{
55
XT_MOBILE_SIM_IND
,
56
XT_MOBILE_IP_READY
,
57
XT_MOBILE_IP_LOSE
,
58
XT_MOBILE_NTP_UPDATE
,
59
};
60
67
typedef
void (*
xt_mobile_on_event_cb_t
)(uint32_t event_id,
void
*param);
68
72
struct
cesq_data
{
73
int
rxlev
;
74
int
ber
;
75
int
rscp
;
76
int
ecno
;
77
int
rsrq
;
78
int
rsrp
;
79
};
80
84
struct
scell_info
{
85
int
mnc
;
86
int
mcc
;
87
int
earfcn
;
88
int
pci
;
89
int
tac
;
90
int
cid
;
91
int
rsrq
;
92
int
rsrp
;
93
int
rssi
;
94
};
95
99
struct
cell_info
{
100
int
num
;
101
struct
{
102
int
mnc
;
103
int
mcc
;
104
int
earfcn
;
105
int
pci
;
106
int
tac
;
107
int
cid
;
108
int
rsrq
;
109
int
rsrp
;
110
}
items
[
XT_MOBILE_CELLINFO_MAX_LEN
];
111
};
112
119
typedef
int (*
xt_mobile_cellinfo_ind_cb_t
)(
struct
cell_info
*info);
120
121
/* ==================== [Global Prototypes] ================================= */
122
129
xt_err_t
xt_mobile_set_event_cb
(
xt_mobile_on_event_cb_t
on_event_cb);
130
137
xt_err_t
xt_mobile_get_imei
(
char
str_imei[15+1]);
138
146
xt_err_t
xt_mobile_get_imsi
(uint8_t simid,
char
str_imsi[15+1]);
147
155
xt_err_t
xt_mobile_get_iccid
(uint8_t simid,
char
str_iccid[20+1]);
156
162
int
xt_mobile_get_status
(
void
);
163
169
uint8_t
xt_mobile_get_csq
(
void
);
170
177
xt_err_t
xt_mobile_get_csq_real
(int8_t *rssi);
178
187
xt_err_t
xt_mobile_get_cesq
(
struct
cesq_data
*ptr_data);
188
197
xt_err_t
xt_mobile_get_cesq_real
(
struct
cesq_data
*ptr_data);
198
205
int
xt_mobile_get_simstatus
(uint8_t simid);
206
213
xt_err_t
xt_mobile_set_simid
(uint8_t simid);
214
220
uint8_t
xt_mobile_get_simid
(
void
);
221
229
xt_err_t
xt_mobile_set_flymode
(uint8_t simid, uint8_t onoff);
230
237
int
xt_mobile_get_flymode
(uint8_t simid);
238
245
xt_err_t
xt_mobile_get_scell
(
struct
scell_info
*
scell_info
);
246
253
xt_err_t
xt_mobile_get_cellinfo
(
struct
cell_info
*
cell_info
);
254
261
xt_err_t
xt_mobile_get_cellinfo_async
(
xt_mobile_cellinfo_ind_cb_t
cb);
262
269
xt_err_t
xt_mobile_set_rrcrel
(uint8_t sec);
270
271
/* ==================== [Macros] ============================================ */
272
/* xt_mobile */
274
275
#ifdef __cplusplus
276
}
/* extern "C" */
277
#endif
278
279
#endif
/* __XT_MOBILE_H__ */
xt_err_t
int32_t xt_err_t
错误码类型
定义
xt_error.h:38
xt_mobile_get_csq_real
xt_err_t xt_mobile_get_csq_real(int8_t *rssi)
获取 CSQ 真实值(RSSI)
xt_mobile_get_cesq_real
xt_err_t xt_mobile_get_cesq_real(struct cesq_data *ptr_data)
获取 CESQ 信号质量(真实值)
xt_mobile_get_cellinfo
xt_err_t xt_mobile_get_cellinfo(struct cell_info *cell_info)
同步获取邻近小区信息
xt_mobile_set_simid
xt_err_t xt_mobile_set_simid(uint8_t simid)
设置当前使用的 SIM 卡
xt_mobile_get_flymode
int xt_mobile_get_flymode(uint8_t simid)
获取飞行模式状态
xt_mobile_get_csq
uint8_t xt_mobile_get_csq(void)
获取 CSQ 相对值
xt_mobile_get_cesq
xt_err_t xt_mobile_get_cesq(struct cesq_data *ptr_data)
获取 CESQ 信号质量(相对值)
xt_mobile_on_event_cb_t
void(* xt_mobile_on_event_cb_t)(uint32_t event_id, void *param)
蜂窝网络事件回调函数类型
定义
xt_mobile.h:67
xt_mobile_set_flymode
xt_err_t xt_mobile_set_flymode(uint8_t simid, uint8_t onoff)
设置飞行模式
xt_mobile_set_rrcrel
xt_err_t xt_mobile_set_rrcrel(uint8_t sec)
设置 RRC 释放时间
XT_MOBILE_CELLINFO_MAX_LEN
#define XT_MOBILE_CELLINFO_MAX_LEN
定义
xt_mobile.h:47
xt_mobile_event_id
xt_mobile_event_id
蜂窝网络事件 ID 枚举
定义
xt_mobile.h:54
xt_mobile_cellinfo_ind_cb_t
int(* xt_mobile_cellinfo_ind_cb_t)(struct cell_info *info)
邻近小区信息异步回调函数类型
定义
xt_mobile.h:119
xt_mobile_get_simstatus
int xt_mobile_get_simstatus(uint8_t simid)
获取 SIM 卡状态
xt_mobile_get_status
int xt_mobile_get_status(void)
获取网络注册状态
xt_mobile_get_scell
xt_err_t xt_mobile_get_scell(struct scell_info *scell_info)
获取当前服务小区信息
xt_mobile_get_imsi
xt_err_t xt_mobile_get_imsi(uint8_t simid, char str_imsi[15+1])
获取 SIM 卡 IMSI
xt_mobile_get_iccid
xt_err_t xt_mobile_get_iccid(uint8_t simid, char str_iccid[20+1])
获取 SIM 卡 ICCID
xt_mobile_get_simid
uint8_t xt_mobile_get_simid(void)
获取当前使用的 SIM 卡编号
xt_mobile_set_event_cb
xt_err_t xt_mobile_set_event_cb(xt_mobile_on_event_cb_t on_event_cb)
注册网络事件回调
xt_mobile_get_cellinfo_async
xt_err_t xt_mobile_get_cellinfo_async(xt_mobile_cellinfo_ind_cb_t cb)
异步获取邻近小区信息
xt_mobile_get_imei
xt_err_t xt_mobile_get_imei(char str_imei[15+1])
获取设备 IMEI
XT_MOBILE_SIM_IND
@ XT_MOBILE_SIM_IND
定义
xt_mobile.h:55
XT_MOBILE_NTP_UPDATE
@ XT_MOBILE_NTP_UPDATE
定义
xt_mobile.h:58
XT_MOBILE_IP_READY
@ XT_MOBILE_IP_READY
定义
xt_mobile.h:56
XT_MOBILE_IP_LOSE
@ XT_MOBILE_IP_LOSE
定义
xt_mobile.h:57
cell_info
邻近小区信息结构体
定义
xt_mobile.h:99
cell_info::cid
int cid
定义
xt_mobile.h:107
cell_info::rsrq
int rsrq
定义
xt_mobile.h:108
cell_info::num
int num
定义
xt_mobile.h:100
cell_info::items
struct cell_info::@265131021054216162303064070343271254226150236030 items[10/*!< 小区信息最大数量 */]
cell_info::mnc
int mnc
定义
xt_mobile.h:102
cell_info::tac
int tac
定义
xt_mobile.h:106
cell_info::pci
int pci
定义
xt_mobile.h:105
cell_info::mcc
int mcc
定义
xt_mobile.h:103
cell_info::rsrp
int rsrp
定义
xt_mobile.h:109
cell_info::earfcn
int earfcn
定义
xt_mobile.h:104
cesq_data
CESQ 信号质量数据结构体
定义
xt_mobile.h:72
cesq_data::rxlev
int rxlev
定义
xt_mobile.h:73
cesq_data::ecno
int ecno
定义
xt_mobile.h:76
cesq_data::rsrq
int rsrq
定义
xt_mobile.h:77
cesq_data::rscp
int rscp
定义
xt_mobile.h:75
cesq_data::ber
int ber
定义
xt_mobile.h:74
cesq_data::rsrp
int rsrp
定义
xt_mobile.h:78
scell_info
服务小区信息结构体
定义
xt_mobile.h:84
scell_info::earfcn
int earfcn
定义
xt_mobile.h:87
scell_info::mcc
int mcc
定义
xt_mobile.h:86
scell_info::rssi
int rssi
定义
xt_mobile.h:93
scell_info::pci
int pci
定义
xt_mobile.h:88
scell_info::cid
int cid
定义
xt_mobile.h:90
scell_info::mnc
int mnc
定义
xt_mobile.h:85
scell_info::tac
int tac
定义
xt_mobile.h:89
scell_info::rsrp
int rsrp
定义
xt_mobile.h:92
scell_info::rsrq
int rsrq
定义
xt_mobile.h:91
xt_error.h
XTINY 错误码定义
platforms
components
xtiny
xt_mobile
xt_mobile.h
生成于
, 为 xt-sdk 文档使用
1.17.0