蜂窝模组基础功能API实现接口。更多...

#include <stdint.h>
#include "tuya_cloud_types.h"
#include "tkl_uart.h"

tkl_cellular_base.h 的引用(Include)关系图:

此图展示该文件直接或间接的被哪些文件引用了:

结构体
struct	TKL_CELL_INIT_PARAM_T

宏定义
#define	CELL_IOCTL_CMD_GET_START 0x400

#define	CELL_IOCTL_CMD_SET_START 0

#define	CELL_IOCTL_CMD_USR_START 0x1000

#define	CELL_IOCTL_GET_EPOCH_TIME 0x401

#define	CELL_IOCTL_GET_NET_TYPE 8

#define	CELL_IOCTL_GET_RSSI 9

#define	CELL_IOCTL_GET_RSSIDBM 7

#define	CELL_IOCTL_GET_UP_TIME 0x402

#define	CELL_IOCTL_GET_UP_TIME_US 0x403

#define	CELL_IOCTL_SET_ADC_SELFTEST 0x102

#define	CELL_IOCTL_SET_ATUART_OFF 5

#define	CELL_IOCTL_SET_ATUART_ON 6

#define	CELL_IOCTL_SET_MIC_SELFTEST 0x103

#define	CELL_IOCTL_SET_POWEKEY_DISABLE_POWEROFF 4

#define	CELL_IOCTL_SET_POWEKEY_ENABLE_POWEROFF 3

#define	CELL_IOCTL_SET_SMS_CHAR 10

#define	CELL_IOCTL_SET_TFCARD_SELFTEST 0x101

#define	CELL_IOCTL_SET_TRACE_OFF 2

#define	CELL_IOCTL_SET_TRACE_ON 1

#define	CELL_IOCTL_SET_UART_SELFTEST 0x100

#define	NEIGHBOUR_NUM 4

类型定义
typedef INT_T	CELL_IOCTRL_CMD

typedef VOID(*	TKL_SIM_NOTIFY) (TKL_SIM_STATE_E status)
	sim卡状态变化通知函数原型更多...

枚举
enum	TKL_CELLULAR_ABILITY_E { DOUBLE_SIM_DOUBLE_CHANNEL = 1 , DOUBLE_SIM_SINGLE_CHANNEL = 2 , SINGLE_SIM_SINGLE_CHANNEL = 4 }

enum	TKL_SIM_STATE_E { TKL_NO_SIM , TKL_SIM_READY }
	sim卡状态定义

enum	TUYA_CELLULAR_RAT_E { TUYA_CELL_NET_TYPE_UNKNOWN = -1 , TUYA_CELL_NET_TYPE_GSM = 1 , TUYA_CELL_NET_TYPE_LTE }

enum	TUYA_SIM_TYPE_E { TUYA_TSIM_TYPE , TUYA_VSIM_TYPE }

函数
OPERATE_RET	tkl_cellular_base_enable_sim_detect (UINT8_T simid, BOOL_T enable)
	使能或禁止sim卡gpio检测更多...

OPERATE_RET	tkl_cellular_base_enable_sim_hotplug (UINT8_T sim_id, BOOL_T enable)
	使能或禁止sim卡热拔插更多...

OPERATE_RET	tkl_cellular_base_get_ability (TKL_CELLULAR_ABILITY_E *ability)
	获取当前设备的通讯能力更多...

OPERATE_RET	tkl_cellular_base_get_cfun_mode (UINT8_T simd_id, PINT_T cfun)
	获取蜂窝设备当前的通信功能设置更多...

INT8_T	tkl_cellular_base_get_default_simid (VOID)
	获取默认的SIM ID 更多...

OPERATE_RET	tkl_cellular_base_get_iccid (UINT8_T sim_id, CHAR_T iccid[20+1])
	获取SIM卡的ICCID 更多...

OPERATE_RET	tkl_cellular_base_get_imei (UINT8_T sim_id, CHAR_T imei[15+1])
	获取SIM卡所在通道设备的IMEI号更多...

OPERATE_RET	tkl_cellular_base_get_imsi (UINT8_T sim_id, CHAR_T imsi[15+1])
	获取SIM卡中的国际移动用户识别码更多...

OPERATE_RET	tkl_cellular_base_get_lbs (UINT8_T sim_id, TKL_LBS_INFO_T *lbs, BOOL_T neighbour, INT_T timeout)
	SIM卡所在通道LBS的基站信息) 更多...

OPERATE_RET	tkl_cellular_base_get_rsrp (UINT8_T sim_id, INT_T *rsrp)
	获取SIM卡所在通道蜂窝设备的信号接收功率——单位dbm 更多...

OPERATE_RET	tkl_cellular_base_get_sinr (UINT8_T sim_id, INT_T sinr, INT_T bit_error)
	获取蜂窝设备SIM卡所在通道的信号噪声比及误码率更多...

OPERATE_RET	tkl_cellular_base_init (TKL_CELL_INIT_PARAM_T *param)

OPERATE_RET	tkl_cellular_base_ioctl (INT_T cmd, VOID *argv)
	蜂窝基础的通用控制功能，一般作为平台提供一些特殊的能力接口更多...

OPERATE_RET	tkl_cellular_base_register_sim_state_notify (UINT8_T simd_id, TKL_SIM_NOTIFY fun)
	注册SIM状态变化通知函数更多...

BOOL_T	tkl_cellular_base_rf_calibrated (VOID_T)
	获取当前设备的射频校准状态更多...

OPERATE_RET	tkl_cellular_base_set_cfun_mode (UINT8_T simd_id, INT_T cfun)
	设置蜂窝设备的通信功能模式更多...

OPERATE_RET	tkl_cellular_base_set_imei (UINT8_T sim_id, CHAR_T imei[15+1])
	设置设备的IMEI号更多...

OPERATE_RET	tkl_cellular_base_sim_get_status (UINT8_T sim_id, UCHAR_T *state)
	获取SIM卡的状态更多...

OPERATE_RET	tkl_cellular_base_switch_sim (UINT8_T sim_id)
	切换当前使能的SIM卡。更多...

详细描述

蜂窝模组基础功能API实现接口。

作者: www.tuya.com

版权所有: Copyright (c) tuya.inc 2021

类型定义说明

◆ TKL_SIM_NOTIFY

typedef VOID(* TKL_SIM_NOTIFY) (TKL_SIM_STATE_E status)

sim卡状态变化通知函数原型

参数

state sim卡状态，查看 @TAL_SIM_STATE_E 定义

函数说明

◆ tkl_cellular_base_enable_sim_detect()

OPERATE_RET tkl_cellular_base_enable_sim_detect	(	UINT8_T	simid,
		BOOL_T	enable
	)

使能或禁止sim卡gpio检测

参数

simId	sim卡ID
enable	TRUE 使能 FALSE 禁止

返回: 0 成功其它失败

◆ tkl_cellular_base_enable_sim_hotplug()

OPERATE_RET tkl_cellular_base_enable_sim_hotplug	(	UINT8_T	sim_id,
		BOOL_T	enable
	)

使能或禁止sim卡热拔插

参数

simId	sim卡ID
enable	TRUE 使能 FALSE 禁止

返回: 0 成功其它失败

◆ tkl_cellular_base_get_ability()

OPERATE_RET tkl_cellular_base_get_ability ( TKL_CELLULAR_ABILITY_E * ability )

获取当前设备的通讯能力

参数

ability @TKL_CELLULAR_ABILITY_E 类型

返回: 0 成功其它失败

◆ tkl_cellular_base_get_cfun_mode()

OPERATE_RET tkl_cellular_base_get_cfun_mode	(	UINT8_T	simd_id,
		PINT_T	cfun
	)

获取蜂窝设备当前的通信功能设置

参数

cfun 获取的通信功能

返回: 0 成功其它失败

◆ tkl_cellular_base_get_default_simid()

INT8_T tkl_cellular_base_get_default_simid ( VOID )

获取默认的SIM ID

返回: 小于0失败，其他SIM ID

◆ tkl_cellular_base_get_iccid()

OPERATE_RET tkl_cellular_base_get_iccid	(	UINT8_T	sim_id,
		CHAR_T	iccid[20+1]
	)

获取SIM卡的ICCID

参数

simid
ICCID识别码，为20字节的字符串

返回: 0 成功其它失败

◆ tkl_cellular_base_get_imei()

OPERATE_RET tkl_cellular_base_get_imei	(	UINT8_T	sim_id,
		CHAR_T	imei[15+1]
	)

获取SIM卡所在通道设备的IMEI号

参数

simid
IMEI识别码，为15字节的字符串

返回: 0 成功其它失败

◆ tkl_cellular_base_get_imsi()

OPERATE_RET tkl_cellular_base_get_imsi	(	UINT8_T	sim_id,
		CHAR_T	imsi[15+1]
	)

获取SIM卡中的国际移动用户识别码

参数

simid,SIM卡id号(0,1,2...)
imsi识别码，为16字节的字符串

返回: 0 成功其它失败

◆ tkl_cellular_base_get_lbs()

OPERATE_RET tkl_cellular_base_get_lbs	(	UINT8_T	sim_id,
		TKL_LBS_INFO_T *	lbs,
		BOOL_T	neighbour,
		INT_T	timeout
	)

SIM卡所在通道LBS的基站信息)

参数

simid
lbs	返回基站信息
neighbour	是否搜索临近基站信息
timeout	搜索临近基站信息超时时间(一般需要4秒左右)

返回: 0 成功其它失败

◆ tkl_cellular_base_get_rsrp()

OPERATE_RET tkl_cellular_base_get_rsrp	(	UINT8_T	sim_id,
		INT_T *	rsrp
	)

获取SIM卡所在通道蜂窝设备的信号接收功率——单位dbm

参数

simid
rsrp	返回实际的信号强度(dbm)

返回: 0 成功其它失败

◆ tkl_cellular_base_get_sinr()

OPERATE_RET tkl_cellular_base_get_sinr	(	UINT8_T	sim_id,
		INT_T *	sinr,
		INT_T *	bit_error
	)

获取蜂窝设备SIM卡所在通道的信号噪声比及误码率

参数

simid
sinr	(0~31)
bit_error	(0~7,99) 99无网络

返回: 0 成功其它失败

◆ tkl_cellular_base_ioctl()

OPERATE_RET tkl_cellular_base_ioctl	(	INT_T	cmd,
		VOID *	argv
	)

蜂窝基础的通用控制功能，一般作为平台提供一些特殊的能力接口

参数

cmd	参考CELL_IOCTRL_CMD
argv	平台自定义

返回: 0 成功其它失败

◆ tkl_cellular_base_register_sim_state_notify()

OPERATE_RET tkl_cellular_base_register_sim_state_notify	(	UINT8_T	simd_id,
		TKL_SIM_NOTIFY	fun
	)

注册SIM状态变化通知函数

参数

fun 状态变化通知函数

返回: 0 成功其它失败

◆ tkl_cellular_base_rf_calibrated()

BOOL_T tkl_cellular_base_rf_calibrated ( VOID_T )

获取当前设备的射频校准状态

参数

return TRUE正常，FALSE异常

◆ tkl_cellular_base_set_cfun_mode()

OPERATE_RET tkl_cellular_base_set_cfun_mode	(	UINT8_T	simd_id,
		INT_T	cfun
	)

设置蜂窝设备的通信功能模式

参数

cfun	通信功能，取值含义如下： 1：全功能模式 4：飞行模式

返回: 0 成功其它失败

◆ tkl_cellular_base_set_imei()

OPERATE_RET tkl_cellular_base_set_imei	(	UINT8_T	sim_id,
		CHAR_T	imei[15+1]
	)

设置设备的IMEI号

参数

simid
IMEI识别码，为15字节的字符串

返回: 0 成功其它失败

◆ tkl_cellular_base_sim_get_status()

OPERATE_RET tkl_cellular_base_sim_get_status	(	UINT8_T	sim_id,
		UCHAR_T *	state
	)

获取SIM卡的状态

参数

simId	sim卡ID
state	1：正常，0：异常

返回: 0 成功其它失败

◆ tkl_cellular_base_switch_sim()

OPERATE_RET tkl_cellular_base_switch_sim ( UINT8_T sim_id )

切换当前使能的SIM卡。

参数

simid SIM卡ID.(0~1)

返回: 0 成功其它失败

结构体

宏定义

类型定义

枚举

函数

详细描述

类型定义说明

◆ TKL_SIM_NOTIFY

函数说明

◆ tkl_cellular_base_enable_sim_detect()

◆ tkl_cellular_base_enable_sim_hotplug()

◆ tkl_cellular_base_get_ability()

◆ tkl_cellular_base_get_cfun_mode()

◆ tkl_cellular_base_get_default_simid()

◆ tkl_cellular_base_get_iccid()

◆ tkl_cellular_base_get_imei()

◆ tkl_cellular_base_get_imsi()

◆ tkl_cellular_base_get_lbs()

◆ tkl_cellular_base_get_rsrp()

◆ tkl_cellular_base_get_sinr()

◆ tkl_cellular_base_ioctl()

◆ tkl_cellular_base_register_sim_state_notify()

◆ tkl_cellular_base_rf_calibrated()

◆ tkl_cellular_base_set_cfun_mode()

◆ tkl_cellular_base_set_imei()

◆ tkl_cellular_base_sim_get_status()

◆ tkl_cellular_base_switch_sim()