Microchip® Advanced Software Framework

at_ble_characteristic_t Struct Reference

Characteristic structure.

#include <at_ble_api.h>

Data Fields

at_ble_handle_t char_val_handle
 Here the stack will store the char. More...
 
at_ble_handle_t client_config_handle
 
at_ble_attr_permissions_t client_config_permissions
 
uint8_t * init_value
 initial value of this characteristic More...
 
at_ble_char_presentation_tpresentation_format
 Characteristic presentation format, this value will be stored in the relevant descriptor, if no presentation format is necessary set to NULL. More...
 
at_ble_char_properties_t properties
 Characteristic properties, values for Client Characteristic Configuration Descriptor and Server Characteristic Configuration Descriptor will be decided from this value. More...
 
at_ble_handle_t server_config_handle
 
at_ble_attr_permissions_t server_config_permissions
 
uint8_t * user_desc
 a user friendly description, this value will be stored in the relevant descriptor, if no user description is desired set to NULL More...
 
at_ble_handle_t user_desc_handle
 
uint16_t user_desc_len
 the user friendly description length, this value will be stored in the relevant descriptor, if no user description is desired set to 0 More...
 
uint16_t user_desc_max_len
 Maximum possible length for the user friendly description, this value will be stored in the relevant descriptor, if no user description is desired set to 0. More...
 
at_ble_attr_permissions_t user_desc_permissions
 
at_ble_uuid_t uuid
 Characteristic UUID. More...
 
uint16_t value_init_len
 initial value length More...
 
uint16_t value_max_len
 maximum possible length of the char. More...
 
at_ble_attr_permissions_t value_permissions
 Value permissions. More...
 

at_ble_handle_t at_ble_characteristic_t::char_val_handle

Here the stack will store the char.

value handle for future use

Referenced by at_ble_service_define(), bat_init_service(), and bat_update_char_value().

at_ble_handle_t at_ble_characteristic_t::client_config_handle
at_ble_attr_permissions_t at_ble_characteristic_t::client_config_permissions
uint8_t* at_ble_characteristic_t::init_value

initial value of this characteristic

Referenced by at_ble_service_define(), and bat_init_service().

at_ble_char_presentation_t* at_ble_characteristic_t::presentation_format

Characteristic presentation format, this value will be stored in the relevant descriptor, if no presentation format is necessary set to NULL.

Referenced by bat_init_service(), is_presentation_format_defined(), and presentation_format_define().

at_ble_char_properties_t at_ble_characteristic_t::properties

Characteristic properties, values for Client Characteristic Configuration Descriptor and Server Characteristic Configuration Descriptor will be decided from this value.

Referenced by bat_init_service(), char_permissions(), char_properties(), extended_properties_define(), is_client_conf_defined(), is_extended_properties_defined(), is_server_conf_defined(), and user_description_define().

at_ble_handle_t at_ble_characteristic_t::server_config_handle
at_ble_attr_permissions_t at_ble_characteristic_t::server_config_permissions
uint8_t* at_ble_characteristic_t::user_desc

a user friendly description, this value will be stored in the relevant descriptor, if no user description is desired set to NULL

Referenced by bat_init_service(), and user_description_define().

at_ble_handle_t at_ble_characteristic_t::user_desc_handle
uint16_t at_ble_characteristic_t::user_desc_len

the user friendly description length, this value will be stored in the relevant descriptor, if no user description is desired set to 0

Referenced by at_ble_service_define(), bat_init_service(), is_user_desc_defined(), and user_description_define().

uint16_t at_ble_characteristic_t::user_desc_max_len

Maximum possible length for the user friendly description, this value will be stored in the relevant descriptor, if no user description is desired set to 0.

Referenced by bat_init_service().

at_ble_attr_permissions_t at_ble_characteristic_t::user_desc_permissions
at_ble_uuid_t at_ble_characteristic_t::uuid

Characteristic UUID.

Referenced by at_ble_service_define(), and bat_init_service().

uint16_t at_ble_characteristic_t::value_init_len

initial value length

Referenced by at_ble_service_define(), and bat_init_service().

uint16_t at_ble_characteristic_t::value_max_len

maximum possible length of the char.

value

Referenced by at_ble_service_define(), and bat_init_service().

at_ble_attr_permissions_t at_ble_characteristic_t::value_permissions

Value permissions.

Referenced by bat_init_service(), and char_permissions().