Initial release

Fork of nrf51-sdk by Lancaster University

Embed: (wiki syntax)

« Back to documentation index

ble_add_char_params_t Struct Reference

ble_add_char_params_t Struct Reference
[Common service definitions]

Add characteristic parameters structure. More...

#include <ble_srv_common.h>

Data Fields

uint16_t uuid
 Characteristic UUID (16 bits UUIDs).
uint8_t uuid_type
 Base UUID.
uint16_t max_len
 Maximum length of the characteristic value.
uint16_t init_len
 Initial length of the characteristic value.
uint8_t * p_init_value
 Initial encoded value of the characteristic.
bool is_var_len
 Indicates if the characteristic value has variable length.
ble_gatt_char_props_t char_props
 Characteristic properties.
bool is_defered_read
 Indicate if deferred read operations are supported.
bool is_defered_write
 Indicate if deferred write operations are supported.
security_req_t read_access
 Security requirement for reading the characteristic value.
security_req_t write_access
 Security requirement for writing the characteristic value.
security_req_t cccd_write_access
 Security requirement for writing the characteristic's CCCD.
bool is_value_user
 Indicate if the content of the characteristic is to be stored in the application (user) or in the stack.
ble_add_char_user_desc_tp_user_descr
 Pointer to user descriptor if needed.
ble_gatts_char_pf_tp_presentation_format
 Pointer to characteristic format if needed.

Detailed Description

Add characteristic parameters structure.

This structure contains the parameters needed to use the characteristic_add function.

Definition at line 297 of file ble_srv_common.h.


Field Documentation

Security requirement for writing the characteristic's CCCD.

Definition at line 310 of file ble_srv_common.h.

Characteristic properties.

Definition at line 305 of file ble_srv_common.h.

uint16_t init_len

Initial length of the characteristic value.

Definition at line 302 of file ble_srv_common.h.

Indicate if deferred read operations are supported.

Definition at line 306 of file ble_srv_common.h.

Indicate if deferred write operations are supported.

Definition at line 307 of file ble_srv_common.h.

Indicate if the content of the characteristic is to be stored in the application (user) or in the stack.

Definition at line 311 of file ble_srv_common.h.

bool is_var_len

Indicates if the characteristic value has variable length.

Definition at line 304 of file ble_srv_common.h.

uint16_t max_len

Maximum length of the characteristic value.

Definition at line 301 of file ble_srv_common.h.

uint8_t* p_init_value

Initial encoded value of the characteristic.

Definition at line 303 of file ble_srv_common.h.

Pointer to characteristic format if needed.

Definition at line 313 of file ble_srv_common.h.

Pointer to user descriptor if needed.

Definition at line 312 of file ble_srv_common.h.

Security requirement for reading the characteristic value.

Definition at line 308 of file ble_srv_common.h.

uint16_t uuid

Characteristic UUID (16 bits UUIDs).

Definition at line 299 of file ble_srv_common.h.

uint8_t uuid_type

Base UUID.

If 0, the Bluetooth SIG UUID will be used. Otherwise, this should be a value returned by sd_ble_uuid_vs_add when adding the base UUID.

Definition at line 300 of file ble_srv_common.h.

Security requirement for writing the characteristic value.

Definition at line 309 of file ble_srv_common.h.