CLI Argument Parser API References

Collaboration diagram for CLI Argument Parser API References:

Functions
void	tr_print_cli_cmd_status (char *cmd_string, zb_ret_t status)
	API for printing a ZBOSS command status.
zb_uint8_t	tr_cli_parse_standard_args (tr_standard_args_s *parsed_args_ptr, zb_int_t argc, zb_char_t **argv)
	API for parsing standard arguments used by many CLI commands.
void	tr_print_cli_arg_struct (tr_standard_args_s *args_struct_ptr)
	debug API for printing the argument structure
void	tr_print_attr_value (zb_zcl_attr_t *attr_desc, zb_uint8_t *ext_attr_data_p)
	API for printing an attribute value based on its ZCL type.
void	tr_print_eui64 (zb_ieee_addr_t eui64)
	API for printing an EUI64 in hex with the right byte order.
void	tr_print_tx_buffer (zb_bufid_t buf, zb_uint8_t *ptr)
	APU for printing the contents of a transmit buffer.

Detailed Description

---

---

Function Documentation

tr_cli_parse_standard_args()

zb_uint8_t tr_cli_parse_standard_args	(	tr_standard_args_s *	parsed_args_ptr,
		zb_int_t	argc,
		zb_char_t **	argv )

API for parsing standard arguments used by many CLI commands.

Parameters

parsed_args_ptr	pointer to the standard cli command argument structure
argc	number of arguments for the current command
argv	pointer to the argument array

Returns

tr_print_attr_value()

void tr_print_attr_value	(	zb_zcl_attr_t *	attr_desc,
		zb_uint8_t *	ext_attr_data_p )

API for printing an attribute value based on its ZCL type.

Parameters

attr_desc	pointer to the attribute descriptor
ext_attr_data_p	pointer to the attribute value

tr_print_cli_arg_struct()

void tr_print_cli_arg_struct

(

tr_standard_args_s *

args_struct_ptr

)

debug API for printing the argument structure

Parameters

args_struct_ptr

pointer to the standard cli command argument structure

tr_print_cli_cmd_status()

void tr_print_cli_cmd_status	(	char *	cmd_string,
		zb_ret_t	status )

API for printing a ZBOSS command status.

Parameters

cmd_string	pointer to null terminated string to print
status	ZBOSS status to decode and print

tr_print_eui64()

void tr_print_eui64

(

zb_ieee_addr_t

eui64

)

API for printing an EUI64 in hex with the right byte order.

Parameters

eui64

pointer to the eui64 array

tr_print_tx_buffer()

void tr_print_tx_buffer	(	zb_bufid_t	buf,
		zb_uint8_t *	ptr )

APU for printing the contents of a transmit buffer.

Parameters

buf	buffer index
ptr	pointer to the start of the command in the buffer