at_custom.h 文件参考

#include "c_types.h"

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

浏览源代码.

结构体
struct	at_funcationType

类型定义
typedef void(*	at_custom_uart_rx_intr )(uint8 *data, int32 len)
typedef void(*	at_custom_response_func_type )(const char *str)
typedef void(*	at_fake_uart_tx_func_type )(const uint8 *data, uint32 length)

函数
void	at_response_ok (void)
	Response "OK" to uart. 更多...
void	at_response_error (void)
	Response "ERROR" to uart. 更多...
void	at_response (const char *str)
	Response string. It is equivalent to at_port_print,if not call at_register_response_func or call at_register_response_func(NULL); It will run custom response function,if call at_register_response_func and parameter is not NULL. 更多...
void	at_register_response_func (at_custom_response_func_type response_func)
	register custom response function. 更多...
void	at_cmd_array_regist (at_funcationType *custom_at_cmd_array, uint32 cmd_num)
	Task of process command or txdata. 更多...
bool	at_get_next_int_dec (char **p_src, int *result, int *err)
	get digit form at cmd line.the maybe alter pSrc 更多...
int32	at_data_str_copy (char *p_dest, char **p_src, int32 max_len)
	get string form at cmd line.the maybe alter pSrc 更多...
void	at_init (void)
	initialize at module 更多...
void	at_port_print (const char *str)
	print string to at port 更多...
void	at_set_custom_info (char *info)
	print custom information when AT+GMR 更多...
void	at_enter_special_state (void)
	if current at command is processing,you can call at_enter_special_state, then if other comamnd coming,it will return busy. 更多...
void	at_leave_special_state (void)
uint32	at_get_version (void)
	get at version 更多...
void	at_register_uart_rx_intr (at_custom_uart_rx_intr rx_func)
	register custom uart rx interrupt function 更多...
uint32	at_fake_uart_rx (uint8 *data, uint32 length)
	notify at module that has receive data 更多...
bool	at_fake_uart_enable (bool enable, at_fake_uart_tx_func_type at_fake_uart_tx_func)
	enable fake uart,and register fake uart tx 更多...
bool	at_set_escape_character (uint8 ch)
	set at escape character 更多...

变量
uint8	at_customLinkMax

类型定义说明

typedef void(* at_custom_uart_rx_intr)(uint8 *data, int32 len)

typedef void(* at_custom_response_func_type)(const char *str)

typedef void(* at_fake_uart_tx_func_type)(const uint8 *data, uint32 length)

函数说明

void at_response_ok

(

void

)

Response "OK" to uart.

参数

None

返回值

None

void at_response_error

(

void

)

Response "ERROR" to uart.

参数

None

返回值

None

void at_response

(

const char *

str

)

Response string. It is equivalent to at_port_print,if not call at_register_response_func or call at_register_response_func(NULL); It will run custom response function,if call at_register_response_func and parameter is not NULL.

参数

string

返回值

None

void at_register_response_func

(

at_custom_response_func_type

response_func

)

register custom response function.

参数

response_func

the function that will run when call at_response

返回值

None

void at_cmd_array_regist	(	at_funcationType *	custom_at_cmd_array,
		uint32	cmd_num
	)

Task of process command or txdata.

参数

custom_at_cmd_array

the array of at cmd that custom defined cmd_num : the num of at cmd that custom defined

返回值

None

bool at_get_next_int_dec	(	char **	p_src,
		int *	result,
		int *	err
	)

get digit form at cmd line.the maybe alter pSrc

参数

p_src

at cmd line string result:the buffer to be placed result err : err num

返回值

TRUE

FALSE:

int32 at_data_str_copy	(	char *	p_dest,
		char **	p_src,
		int32	max_len
	)

get string form at cmd line.the maybe alter pSrc

参数

p_dest

the buffer to be placed result p_src: at cmd line string max_len :max len of string excepted to get

返回值

None

void at_init

(

void

)

initialize at module

参数

None

返回值

None

void at_port_print

(

const char *

str

)

print string to at port

参数

string

返回值

None

void at_set_custom_info

(

char *

info

)

print custom information when AT+GMR

参数

string

返回值

None

void at_enter_special_state

(

void

)

if current at command is processing,you can call at_enter_special_state, then if other comamnd coming,it will return busy.

参数

None

返回值

None

void at_leave_special_state

(

void

)

参数

None

返回值

None

uint32 at_get_version

(

void

)

get at version

参数

None

返回值

at	version bit24~31: at main version bit23~16: at sub version bit15~8 : at test version bit7~0 : customized version

void at_register_uart_rx_intr

(

at_custom_uart_rx_intr

rx_func

)

register custom uart rx interrupt function

参数

rx_func

custom uart rx interrupt function. If rx_func is non-void,when rx interrupt comming,it will call rx_func(data,len), data is the buffer of data,len is the length of data.Otherwise,it will run AT rx function.

返回值

None

uint32 at_fake_uart_rx	(	uint8 *	data,
		uint32	length
	)

notify at module that has receive data

参数

data	data buffer.
length	data length

返回值

data	len,if ok len == length

bool at_fake_uart_enable	(	bool	enable,
		at_fake_uart_tx_func_type	at_fake_uart_tx_func
	)

enable fake uart,and register fake uart tx

参数

enable	enable fake uart.
at_fake_uart_tx_func

返回值

data	len,if ok len == length

bool at_set_escape_character

(

uint8

ch

)

set at escape character

参数

ch	escape character.

返回值

TRUE,if

set ok,otherwize FALSE.

变量说明

uint8 at_customLinkMax