Custom

结构体
struct	at_token_int_range_t
	定义基于取值范围的整型校验语法。 更多...
struct	at_token_int_list_t
	定义基于白名单的整型校验语法。 更多...
struct	at_token_string_t
	定义基于长度的字符串校验语法。 更多...
struct	at_token_string_values_t
	定义基于白名单的字符串校验语法。 更多...
struct	at_token_bit_string_range_t
	定义基于范围值的二进制字符串校验语法。 更多...
struct	at_token_bit_string_list_t
	定义基于白名单二进制字符串校验语法。 更多...
struct	at_token_hex_string_t
	定义基于长度的十六进制字符串校验语法。 更多...
struct	at_para_parse_syntax_t
	定义AT命令某个参数校验结构。 更多...
struct	at_cmd_entry_t
	定义AT命令实体。 更多...

宏定义
#define	AT_RESPONSE_OK   "OK\r\n"
#define	AT_RESPONSE_ERROR   "ERROR\r\n"
#define	AT_RESPONSE_BUSY   "BUSY\r\n"
#define	AT_RESPONSE_ABORTING   "ABORTING\r\n"
#define	AT_FLAG_NONE   0x0
#define	AT_FLAG_ABORTABLE   0x10
#define	AT_FLAG_NOT_BLOCK_URC   0x200

类型定义
typedef at_ret_t(*	at_abort_func_t) (void *arg)
	声明AT命令打断函数类型。
typedef at_ret_t(*	at_interactivity_func_t) (const char *data, uint32_t len)
	声明AT命令交互函数类型。
typedef at_ret_t(*	at_cmd_func_t) (void)
	声明AT命令执行函数类型。
typedef at_ret_t(*	at_set_func_t) (const void *arg)
	声明AT命令设置函数类型。
typedef at_ret_t(*	at_read_func_t) (void)
	声明AT命令读函数类型。
typedef at_ret_t(*	at_test_func_t) (void)
	声明AT命令测试函数类型。

枚举
enum	at_ret_t {   AT_RET_OK = 0 , AT_RET_SYNTAX_ERROR , AT_RET_MALLOC_ERROR , AT_RET_MEM_API_ERROR ,   AT_RET_CHANNEL_PARA_ERROR , AT_RET_CHANNEL_NOT_INIT , AT_RET_CHANNEL_DATA_NULL , AT_RET_CMD_PARA_ERROR ,   AT_RET_CMD_FORMAT_ERROR , AT_RET_CMD_NO_MATCH , AT_RET_CMD_TYPE_ERROR , AT_RET_CMD_IN_PROGRESS_BLOCK ,   AT_RET_CMD_ATTR_NOT_ALLOW , AT_RET_PROC_CMD_FUNC_MISSING , AT_RET_PROC_READ_FUNC_MISSING , AT_RET_PROC_TEST_FUNC_MISSING ,   AT_RET_PROC_SET_FUNC_MISSING , AT_RET_PROC_WAIT_INTERACTIVITY , AT_RET_PROC_ABORT_CURRENT_COMMAND , AT_RET_PARSE_PARA_ERROR ,   AT_RET_PARSE_PARA_MISSING_ERROR , AT_RET_PROGRESS_BLOCK , AT_RET_TIMER_ERROR , AT_RET_ABORT_DELAY }
	定义AT错误码。 更多...
enum	at_cmd_type_t {   AT_CMD_TYPE_CMD = 0x00 , AT_CMD_TYPE_SET , AT_CMD_TYPE_READ , AT_CMD_TYPE_TEST ,   AT_CMD_TYPE_ERROR }
	定义AT命令类型。 更多...
enum	at_syntax_type_t {   AT_SYNTAX_TYPE_INT , AT_SYNTAX_TYPE_STRING , AT_SYNTAX_TYPE_BIT_STRING , AT_SYNTAX_TYPE_OCTET_STRING ,   AT_SYNTAX_TYPE_NUM }
	定义AT命令参数类型。 更多...
enum	at_syntax_attribute_t {   AT_SYNTAX_ATTR_NOT_SUPPORTED = 0x0001 , AT_SYNTAX_ATTR_OPTIONAL = 0x0002 , AT_SYNTAX_ATTR_AT_MIN_VALUE = 0x0004 , AT_SYNTAX_ATTR_AT_MAX_VALUE = 0x0008 ,   AT_SYNTAX_ATTR_LIST_VALUE = 0x0010 , AT_SYNTAX_ATTR_MAX_LENGTH = 0x0020 , AT_SYNTAX_ATTR_ADD_LENGTH = 0x0040 , AT_SYNTAX_ATTR_FIX_CASE = 0x0080 ,   AT_SYNTAX_ATTR_LENGTH_FIELD = 0x0100 }
	定义AT命令参数校验属性。 更多...

函数
errcode_t	uapi_at_cmd_table_register (const at_cmd_entry_t *table, uint32_t len, uint32_t struct_max_size)
	注册AT命令列表。
void	uapi_at_report (const char *str)
	向默认通道输出AT打印信息。
void	uapi_at_report_to_single_channel (at_channel_id_t channel_id, const char *str)
	向指定通道输出AT打印信息。

详细描述

Copyright (c) HiSilicon (Shanghai) Technologies Co., Ltd. 2022-2022. All rights reserved.

Description: Provides at common service api header for customer
History:
2022-09-02, Create file.

宏定义说明

AT_FLAG_ABORTABLE

#define AT_FLAG_ABORTABLE   0x10

AT_FLAG_NONE

#define AT_FLAG_NONE   0x0

AT_FLAG_NOT_BLOCK_URC

#define AT_FLAG_NOT_BLOCK_URC   0x200

AT_RESPONSE_ABORTING

#define AT_RESPONSE_ABORTING   "ABORTING\r\n"

AT_RESPONSE_BUSY

#define AT_RESPONSE_BUSY   "BUSY\r\n"

AT_RESPONSE_ERROR

#define AT_RESPONSE_ERROR   "ERROR\r\n"

AT_RESPONSE_OK

#define AT_RESPONSE_OK   "OK\r\n"

类型定义说明

at_abort_func_t

typedef at_ret_t(* at_abort_func_t) (void *arg)

声明AT命令打断函数类型。

at_cmd_func_t

typedef at_ret_t(* at_cmd_func_t) (void)

声明AT命令执行函数类型。

at_interactivity_func_t

typedef at_ret_t(* at_interactivity_func_t) (const char *data, uint32_t len)

声明AT命令交互函数类型。

at_read_func_t

typedef at_ret_t(* at_read_func_t) (void)

声明AT命令读函数类型。

at_set_func_t

typedef at_ret_t(* at_set_func_t) (const void *arg)

声明AT命令设置函数类型。

at_test_func_t

typedef at_ret_t(* at_test_func_t) (void)

声明AT命令测试函数类型。

枚举类型说明

at_cmd_type_t

enum at_cmd_type_t

定义AT命令类型。

枚举值
AT_CMD_TYPE_CMD	AT execute command. "AT+TEST", for example.
AT_CMD_TYPE_SET	AT set command. "AT+TEST=520", for example.
AT_CMD_TYPE_READ	AT read command. "AT+TEST?", for example.
AT_CMD_TYPE_TEST	AT test command. "AT+TEST=?", for example.
AT_CMD_TYPE_ERROR

at_ret_t

enum at_ret_t

定义AT错误码。

枚举值
AT_RET_OK
AT_RET_SYNTAX_ERROR
AT_RET_MALLOC_ERROR
AT_RET_MEM_API_ERROR
AT_RET_CHANNEL_PARA_ERROR
AT_RET_CHANNEL_NOT_INIT
AT_RET_CHANNEL_DATA_NULL
AT_RET_CMD_PARA_ERROR
AT_RET_CMD_FORMAT_ERROR
AT_RET_CMD_NO_MATCH
AT_RET_CMD_TYPE_ERROR
AT_RET_CMD_IN_PROGRESS_BLOCK
AT_RET_CMD_ATTR_NOT_ALLOW
AT_RET_PROC_CMD_FUNC_MISSING
AT_RET_PROC_READ_FUNC_MISSING
AT_RET_PROC_TEST_FUNC_MISSING
AT_RET_PROC_SET_FUNC_MISSING
AT_RET_PROC_WAIT_INTERACTIVITY
AT_RET_PROC_ABORT_CURRENT_COMMAND
AT_RET_PARSE_PARA_ERROR
AT_RET_PARSE_PARA_MISSING_ERROR
AT_RET_PROGRESS_BLOCK
AT_RET_TIMER_ERROR
AT_RET_ABORT_DELAY

at_syntax_attribute_t

enum at_syntax_attribute_t

定义AT命令参数校验属性。

枚举值
AT_SYNTAX_ATTR_NOT_SUPPORTED	标识该参数当前不支持。
AT_SYNTAX_ATTR_OPTIONAL	标识该参数可缺省，为保证参数顺序，缺省时‘，’不可缺省。
AT_SYNTAX_ATTR_AT_MIN_VALUE	该属性标识校验方式为最小值校验。
AT_SYNTAX_ATTR_AT_MAX_VALUE	该属性标识校验方式为最大值校验。
AT_SYNTAX_ATTR_LIST_VALUE	该属性标识校验方式为白名单校验。
AT_SYNTAX_ATTR_MAX_LENGTH	该属性标识校验方式为长度校验。
AT_SYNTAX_ATTR_ADD_LENGTH	该属性标识为该参数新增此参数的长度字段。
AT_SYNTAX_ATTR_FIX_CASE	该参数用于字符串，标识字符串支持大小写混合。
AT_SYNTAX_ATTR_LENGTH_FIELD	该属性标识该参数已预设长度字段。

at_syntax_type_t

enum at_syntax_type_t

定义AT命令参数类型。

枚举值
AT_SYNTAX_TYPE_INT
AT_SYNTAX_TYPE_STRING
AT_SYNTAX_TYPE_BIT_STRING
AT_SYNTAX_TYPE_OCTET_STRING
AT_SYNTAX_TYPE_NUM

函数说明

uapi_at_cmd_table_register()

errcode_t uapi_at_cmd_table_register	(	const at_cmd_entry_t *	table,
		uint32_t	len,
		uint32_t	struct_max_size
	)

注册AT命令列表。

uapi_at_report()

void uapi_at_report

(

const char *

str

)

向默认通道输出AT打印信息。

uapi_at_report_to_single_channel()

void uapi_at_report_to_single_channel	(	at_channel_id_t	channel_id,
		const char *	str
	)

向指定通道输出AT打印信息。