Element configuration

Configuration of element parameters. More...

Functions
uint32_t	access_element_location_set (uint16_t element_index, uint16_t location)
	Sets the location descriptor for an element. More...
uint32_t	access_element_location_get (uint16_t element_index, uint16_t *p_location)
	Gets the location descriptor for an element. More...
uint32_t	access_element_sig_model_count_get (uint16_t element_index, uint8_t *p_sig_model_count)
	Gets the number of Bluetooth SIG models for an element. More...
uint32_t	access_element_vendor_model_count_get (uint16_t element_index, uint8_t *p_vendor_model_count)
	Gets the number of vendor specific models for an element. More...
uint32_t	access_element_models_get (uint16_t element_index, access_model_handle_t *p_models, uint16_t *p_count)
	Gets the array of handles corresponding to an element. More...

Detailed Description

Configuration of element parameters.

Function Documentation

access_element_location_set()

uint32_t access_element_location_set	(	uint16_t	element_index,
		uint16_t	location
	)

Sets the location descriptor for an element.

Note

See the list of Bluetooth SIG location descriptors: https://www.bluetooth.com/specifications/assigned-numbers/gatt-namespace-descriptors

Parameters

[in]	element_index	Element index.
[in]	location	Location descriptor.

Return values

NRF_SUCCESS	Successfully set location descriptor.
NRF_ERROR_NOT_FOUND	Invalid element index.

access_element_location_get()

uint32_t access_element_location_get	(	uint16_t	element_index,
		uint16_t *	p_location
	)

Gets the location descriptor for an element.

Note

See the list of Bluetooth SIG location descriptors: https://www.bluetooth.com/specifications/assigned-numbers/gatt-namespace-descriptors

Parameters

[in]	element_index	Element index.
[out]	p_location	Pointer to store location descriptor.

Return values

NRF_SUCCESS	Successfully got the location descriptor.
NRF_ERROR_NULL	NULL pointer given to function.
NRF_ERROR_NOT_FOUND	Invalid element index.

access_element_sig_model_count_get()

uint32_t access_element_sig_model_count_get	(	uint16_t	element_index,
		uint8_t *	p_sig_model_count
	)

Gets the number of Bluetooth SIG models for an element.

Parameters

[in]	element_index	Element index.
[out]	p_sig_model_count	Pointer to store number of SIG models.

Return values

NRF_SUCCESS	Successfully got the number of SIG models.
NRF_ERROR_NULL	NULL pointer given to function.
NRF_ERROR_NOT_FOUND	Invalid element index.

access_element_vendor_model_count_get()

uint32_t access_element_vendor_model_count_get	(	uint16_t	element_index,
		uint8_t *	p_vendor_model_count
	)

Gets the number of vendor specific models for an element.

Parameters

[in]	element_index	Element index.
[out]	p_vendor_model_count	Pointer to store number of vendor specific models.

Return values

NRF_SUCCESS	Successfully got the number of vendor specific models.
NRF_ERROR_NULL	NULL pointer given to function.
NRF_ERROR_NOT_FOUND	Invalid element index.

access_element_models_get()

uint32_t access_element_models_get	(	uint16_t	element_index,
		access_model_handle_t *	p_models,
		uint16_t *	p_count
	)

Gets the array of handles corresponding to an element.

Parameters

[in]	element_index	Element index.
[out]	p_models	Model handle array
[in,out]	p_count	In: Maximum number of model handles that can fit in p_models array. Out: The number of model handles written to p_models array.

Return values

NRF_SUCCESS	Successfully stored all model handles for this element index.
NRF_ERROR_NULL	NULL pointer given to function.
NRF_ERROR_INVALID_LENGTH	The input array was too small for the number of handles.