XTINY 蜂窝网络模块接口更多...

结构体
struct	cesq_data
	CESQ 信号质量数据结构体更多...
struct	scell_info
	服务小区信息结构体更多...
struct	cell_info
	邻近小区信息结构体更多...

宏定义
#define	XT_MOBILE_IMEI_MAX_LEN 16
#define	XT_MOBILE_SIM_0 0
#define	XT_MOBILE_SIM_1 1
#define	XT_MOBILE_SIM_NUM_MAX XT_MOBILE_SIM_1
#define	XT_MOBILE_USIM_NOT_READY -4
#define	XT_MOBILE_USIM_TIMEOUT -3
#define	XT_MOBILE_USIM_NOT_INSERTED -2
#define	XT_MOBILE_USIM_UNKNOW -1
#define	XT_MOBILE_USIM_READY 0
#define	XT_MOBILE_USIM_SIMPIN 1
#define	XT_MOBILE_USIM_SIMPUK 2
#define	XT_MOBILE_CELLINFO_MAX_LEN 10

类型定义
typedef void(*	xt_mobile_on_event_cb_t) (uint32_t event_id, void *param)
	蜂窝网络事件回调函数类型
typedef int(*	xt_mobile_cellinfo_ind_cb_t) (struct cell_info *info)
	邻近小区信息异步回调函数类型

枚举
enum	xt_mobile_event_id { XT_MOBILE_SIM_IND , XT_MOBILE_IP_READY , XT_MOBILE_IP_LOSE , XT_MOBILE_NTP_UPDATE }
	蜂窝网络事件 ID 枚举更多...

函数
xt_err_t	xt_mobile_set_event_cb (xt_mobile_on_event_cb_t on_event_cb)
	注册网络事件回调
xt_err_t	xt_mobile_get_imei (char str_imei[15+1])
	获取设备 IMEI
xt_err_t	xt_mobile_get_imsi (uint8_t simid, char str_imsi[15+1])
	获取 SIM 卡 IMSI
xt_err_t	xt_mobile_get_iccid (uint8_t simid, char str_iccid[20+1])
	获取 SIM 卡 ICCID
int	xt_mobile_get_status (void)
	获取网络注册状态
uint8_t	xt_mobile_get_csq (void)
	获取 CSQ 相对值
xt_err_t	xt_mobile_get_csq_real (int8_t *rssi)
	获取 CSQ 真实值（RSSI）
xt_err_t	xt_mobile_get_cesq (struct cesq_data *ptr_data)
	获取 CESQ 信号质量（相对值）
xt_err_t	xt_mobile_get_cesq_real (struct cesq_data *ptr_data)
	获取 CESQ 信号质量（真实值）
int	xt_mobile_get_simstatus (uint8_t simid)
	获取 SIM 卡状态
xt_err_t	xt_mobile_set_simid (uint8_t simid)
	设置当前使用的 SIM 卡
uint8_t	xt_mobile_get_simid (void)
	获取当前使用的 SIM 卡编号
xt_err_t	xt_mobile_set_flymode (uint8_t simid, uint8_t onoff)
	设置飞行模式
int	xt_mobile_get_flymode (uint8_t simid)
	获取飞行模式状态
xt_err_t	xt_mobile_get_scell (struct scell_info *scell_info)
	获取当前服务小区信息
xt_err_t	xt_mobile_get_cellinfo (struct cell_info *cell_info)
	同步获取邻近小区信息
xt_err_t	xt_mobile_get_cellinfo_async (xt_mobile_cellinfo_ind_cb_t cb)
	异步获取邻近小区信息
xt_err_t	xt_mobile_set_rrcrel (uint8_t sec)
	设置 RRC 释放时间

详细描述

XTINY 蜂窝网络模块接口

宏定义说明

◆ XT_MOBILE_CELLINFO_MAX_LEN

#define XT_MOBILE_CELLINFO_MAX_LEN 10

小区信息最大数量

在文件 xt_mobile.h 第 47 行定义.

◆ XT_MOBILE_IMEI_MAX_LEN

#define XT_MOBILE_IMEI_MAX_LEN 16

IMEI 最大长度

在文件 xt_mobile.h 第 33 行定义.

◆ XT_MOBILE_SIM_0

#define XT_MOBILE_SIM_0 0

SIM 卡槽 0

在文件 xt_mobile.h 第 34 行定义.

◆ XT_MOBILE_SIM_1

#define XT_MOBILE_SIM_1 1

SIM 卡槽 1

在文件 xt_mobile.h 第 35 行定义.

◆ XT_MOBILE_SIM_NUM_MAX

#define XT_MOBILE_SIM_NUM_MAX XT_MOBILE_SIM_1

最大 SIM 卡槽编号

在文件 xt_mobile.h 第 36 行定义.

◆ XT_MOBILE_USIM_NOT_INSERTED

#define XT_MOBILE_USIM_NOT_INSERTED -2

SIM 卡未插入

在文件 xt_mobile.h 第 41 行定义.

◆ XT_MOBILE_USIM_NOT_READY

#define XT_MOBILE_USIM_NOT_READY -4

SIM 卡未就绪

在文件 xt_mobile.h 第 39 行定义.

◆ XT_MOBILE_USIM_READY

#define XT_MOBILE_USIM_READY 0

SIM 卡就绪

在文件 xt_mobile.h 第 43 行定义.

◆ XT_MOBILE_USIM_SIMPIN

#define XT_MOBILE_USIM_SIMPIN 1

需要 PIN 码

在文件 xt_mobile.h 第 44 行定义.

◆ XT_MOBILE_USIM_SIMPUK

#define XT_MOBILE_USIM_SIMPUK 2

需要 PUK 码

在文件 xt_mobile.h 第 45 行定义.

◆ XT_MOBILE_USIM_TIMEOUT

#define XT_MOBILE_USIM_TIMEOUT -3

SIM 卡超时

在文件 xt_mobile.h 第 40 行定义.

◆ XT_MOBILE_USIM_UNKNOW

#define XT_MOBILE_USIM_UNKNOW -1

SIM 卡状态未知

在文件 xt_mobile.h 第 42 行定义.

类型定义说明

◆ xt_mobile_cellinfo_ind_cb_t

typedef int(* xt_mobile_cellinfo_ind_cb_t) (struct cell_info *info)

邻近小区信息异步回调函数类型

参数

info	邻近小区信息指针，见 cell_info

返回: int 0 成功

在文件 xt_mobile.h 第 119 行定义.

◆ xt_mobile_on_event_cb_t

typedef void(* xt_mobile_on_event_cb_t) (uint32_t event_id, void *param)

蜂窝网络事件回调函数类型

参数

event_id	事件 ID，见 xt_mobile_event_id
param	事件参数（取决于具体事件类型）

在文件 xt_mobile.h 第 67 行定义.

枚举类型说明

◆ xt_mobile_event_id

enum xt_mobile_event_id

蜂窝网络事件 ID 枚举

枚举值
XT_MOBILE_SIM_IND	SIM 卡状态变化
XT_MOBILE_IP_READY	已联网
XT_MOBILE_IP_LOSE	已断网
XT_MOBILE_NTP_UPDATE	时间已同步

在文件 xt_mobile.h 第 54 行定义.

函数说明

◆ xt_mobile_get_cellinfo()

xt_err_t xt_mobile_get_cellinfo ( struct cell_info * cell_info )

同步获取邻近小区信息

参数

cell_info 输出邻近小区信息，见 cell_info

返回: xt_err_t XT_EOK 成功，其他失败

◆ xt_mobile_get_cellinfo_async()

xt_err_t xt_mobile_get_cellinfo_async ( xt_mobile_cellinfo_ind_cb_t cb )

异步获取邻近小区信息

参数

cb	结果回调函数，见 xt_mobile_cellinfo_ind_cb_t

返回: xt_err_t XT_EOK 成功，其他失败

◆ xt_mobile_get_cesq()

xt_err_t xt_mobile_get_cesq ( struct cesq_data * ptr_data )

获取 CESQ 信号质量（相对值）

注解: 参数中 rsrq 与 rsrp 为相对值

参数

ptr_data 输出 CESQ 数据，见 cesq_data

返回: xt_err_t XT_EOK 成功，其他失败

◆ xt_mobile_get_cesq_real()

xt_err_t xt_mobile_get_cesq_real ( struct cesq_data * ptr_data )

获取 CESQ 信号质量（真实值）

注解: 参数中 rsrq 与 rsrp 为真实值

参数

ptr_data 输出 CESQ 数据，见 cesq_data

返回: xt_err_t XT_EOK 成功，其他失败

◆ xt_mobile_get_csq()

uint8_t xt_mobile_get_csq ( void )

获取 CSQ 相对值

返回: uint8_t 正常范围 1~31，0 或 99 异常

◆ xt_mobile_get_csq_real()

xt_err_t xt_mobile_get_csq_real ( int8_t * rssi )

获取 CSQ 真实值（RSSI）

参数

rssi	输出 RSSI 值（单位：dBm）

返回: xt_err_t XT_EOK 成功，其他失败

◆ xt_mobile_get_flymode()

int xt_mobile_get_flymode ( uint8_t simid )

获取飞行模式状态

参数

simid SIM 卡槽编号

返回: int 小于 0 异常，0 飞行模式，1 正常模式，4 射频关闭

◆ xt_mobile_get_iccid()

xt_err_t xt_mobile_get_iccid	(	uint8_t	simid,
		char	str_iccid[20+1] )

获取 SIM 卡 ICCID

参数

simid	SIM 卡槽编号（XT_MOBILE_SIM_0 / XT_MOBILE_SIM_1）
str_iccid	输出缓冲区，长度至少 21 字节（20 位 + '\0'）

返回: xt_err_t XT_EOK 成功，其他失败

◆ xt_mobile_get_imei()

xt_err_t xt_mobile_get_imei ( char str_imei[15+1] )

获取设备 IMEI

参数

str_imei 输出缓冲区，长度至少 16 字节（15 位 + '\0'）

返回: xt_err_t XT_EOK 成功，其他失败

◆ xt_mobile_get_imsi()

xt_err_t xt_mobile_get_imsi	(	uint8_t	simid,
		char	str_imsi[15+1] )

获取 SIM 卡 IMSI

参数

simid	SIM 卡槽编号（XT_MOBILE_SIM_0 / XT_MOBILE_SIM_1）
str_imsi	输出缓冲区，长度至少 16 字节（15 位 + '\0'）

返回: xt_err_t XT_EOK 成功，其他失败

◆ xt_mobile_get_scell()

xt_err_t xt_mobile_get_scell ( struct scell_info * scell_info )

获取当前服务小区信息

参数

scell_info 输出服务小区信息，见 scell_info

返回: xt_err_t XT_EOK 成功，其他失败

◆ xt_mobile_get_simid()

uint8_t xt_mobile_get_simid ( void )

获取当前使用的 SIM 卡编号

返回: uint8_t 当前 SIM 卡槽编号

◆ xt_mobile_get_simstatus()

int xt_mobile_get_simstatus ( uint8_t simid )

获取 SIM 卡状态

参数

simid SIM 卡槽编号（XT_MOBILE_SIM_0 / XT_MOBILE_SIM_1）

返回: int SIM 卡状态，参考 XT_MOBILE_USIM_xxx 宏定义

◆ xt_mobile_get_status()

int xt_mobile_get_status ( void )

获取网络注册状态

返回: int 网络注册状态，参考 AT+CEREG <stat> 定义

◆ xt_mobile_set_event_cb()

xt_err_t xt_mobile_set_event_cb ( xt_mobile_on_event_cb_t on_event_cb )

注册网络事件回调

参数

on_event_cb 事件回调函数，见 xt_mobile_on_event_cb_t

返回: xt_err_t XT_EOK 成功，其他失败

◆ xt_mobile_set_flymode()

xt_err_t xt_mobile_set_flymode	(	uint8_t	simid,
		uint8_t	onoff )

设置飞行模式

参数

simid	SIM 卡槽编号
onoff	1 开启飞行模式，0 关闭飞行模式

返回: xt_err_t XT_EOK 成功，其他失败

◆ xt_mobile_set_rrcrel()

xt_err_t xt_mobile_set_rrcrel ( uint8_t sec )

设置 RRC 释放时间

参数

sec	释放时间（单位：秒），范围 1~10

返回: xt_err_t XT_EOK 成功，其他失败

◆ xt_mobile_set_simid()

xt_err_t xt_mobile_set_simid ( uint8_t simid )

设置当前使用的 SIM 卡

参数

simid SIM 卡槽编号（XT_MOBILE_SIM_0 / XT_MOBILE_SIM_1）

返回: xt_err_t XT_EOK 成功，其他失败

结构体

宏定义

类型定义

枚举

函数

详细描述

宏定义说明

◆ XT_MOBILE_CELLINFO_MAX_LEN

◆ XT_MOBILE_IMEI_MAX_LEN

◆ XT_MOBILE_SIM_0

◆ XT_MOBILE_SIM_1

◆ XT_MOBILE_SIM_NUM_MAX

◆ XT_MOBILE_USIM_NOT_INSERTED

◆ XT_MOBILE_USIM_NOT_READY

◆ XT_MOBILE_USIM_READY

◆ XT_MOBILE_USIM_SIMPIN

◆ XT_MOBILE_USIM_SIMPUK

◆ XT_MOBILE_USIM_TIMEOUT

◆ XT_MOBILE_USIM_UNKNOW

类型定义说明

◆ xt_mobile_cellinfo_ind_cb_t

◆ xt_mobile_on_event_cb_t

枚举类型说明

◆ xt_mobile_event_id

函数说明

◆ xt_mobile_get_cellinfo()

◆ xt_mobile_get_cellinfo_async()

◆ xt_mobile_get_cesq()

◆ xt_mobile_get_cesq_real()

◆ xt_mobile_get_csq()

◆ xt_mobile_get_csq_real()

◆ xt_mobile_get_flymode()

◆ xt_mobile_get_iccid()

◆ xt_mobile_get_imei()

◆ xt_mobile_get_imsi()

◆ xt_mobile_get_scell()

◆ xt_mobile_get_simid()

◆ xt_mobile_get_simstatus()

◆ xt_mobile_get_status()

◆ xt_mobile_set_event_cb()

◆ xt_mobile_set_flymode()

◆ xt_mobile_set_rrcrel()

◆ xt_mobile_set_simid()