at_params.h File Reference

Store a list of AT command/response parameters. More...

#include <zephyr/types.h>

Go to the source code of this file.

Data Structures
union	at_param_value
	Parameter value. More...
struct	at_param
	A parameter is defined with a type, length and value. More...
struct	at_param_list
	List of AT parameters that compose an AT command or response. More...

Enumerations
enum	at_param_type {   AT_PARAM_TYPE_INVALID , AT_PARAM_TYPE_NUM_INT , AT_PARAM_TYPE_STRING , AT_PARAM_TYPE_ARRAY ,   AT_PARAM_TYPE_EMPTY }
	Parameter types that can be stored. More...

Functions
int	at_params_list_init (struct at_param_list *list, size_t max_params_count)
	Create a list of parameters.
void	at_params_list_clear (struct at_param_list *list)
	Clear/reset all parameter types and values.
void	at_params_list_free (struct at_param_list *list)
	Free a list of parameters.
int	at_params_int_put (const struct at_param_list *list, size_t index, int64_t value)
	Add a parameter in the list at the specified index and assign it an integer value.
int	at_params_string_put (const struct at_param_list *list, size_t index, const char *str, size_t str_len)
	Add a parameter in the list at the specified index and assign it a string value.
int	at_params_array_put (const struct at_param_list *list, size_t index, const uint32_t *array, size_t array_len)
	Add a parameter in the list at the specified index and assign it an array type value.
int	at_params_empty_put (const struct at_param_list *list, size_t index)
	Add a parameter in the list at the specified index and assign it an empty status.
int	at_params_size_get (const struct at_param_list *list, size_t index, size_t *len)
	Get the size of a given parameter (in bytes).
int	at_params_short_get (const struct at_param_list *list, size_t index, int16_t *value)
	Get a parameter value as a short number.
int	at_params_unsigned_short_get (const struct at_param_list *list, size_t index, uint16_t *value)
	Get a parameter value as an unsigned short number.
int	at_params_int_get (const struct at_param_list *list, size_t index, int32_t *value)
	Get a parameter value as an integer number.
int	at_params_unsigned_int_get (const struct at_param_list *list, size_t index, uint32_t *value)
	Get a parameter value as an unsigned integer number.
int	at_params_int64_get (const struct at_param_list *list, size_t index, int64_t *value)
	Get a parameter value as a signed 64-bit integer number.
int	at_params_string_get (const struct at_param_list *list, size_t index, char *value, size_t *len)
	Get a parameter value as a string.
int	at_params_string_ptr_get (const struct at_param_list *list, size_t index, const char **at_param, size_t *len)
	Get a pointer to the string parameter value.
int	at_params_array_get (const struct at_param_list *list, size_t index, uint32_t *array, size_t *len)
	Get a parameter value as an array.
uint32_t	at_params_valid_count_get (const struct at_param_list *list)
	Get the number of valid parameters in the list.
enum at_param_type	at_params_type_get (const struct at_param_list *list, size_t index)
	Get parameter type for parameter at index.

Detailed Description

Store a list of AT command/response parameters.