General Description

API unique to AIOS designs configured as a GATT Server role.

A letter 's' is appended to the API name: Cy_BLE_AIOSS_

Functions
cy_en_ble_api_result_t	Cy_BLE_AIOSS_SetCharacteristicValue (cy_en_ble_aios_char_index_t charIndex, uint8_t charInstance, uint8_t attrSize, uint8_t *attrValue)
	Sets the characteristic value of the service in the local database. More...

cy_en_ble_api_result_t	Cy_BLE_AIOSS_GetCharacteristicValue (cy_en_ble_aios_char_index_t charIndex, uint8_t charInstance, uint8_t attrSize, uint8_t *attrValue)
	Gets the characteristic value of the service, which is a value identified by charIndex. More...

cy_en_ble_api_result_t	Cy_BLE_AIOSS_SetCharacteristicDescriptor (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_aios_char_index_t charIndex, uint8_t charInstance, cy_en_ble_aios_descr_index_t descrIndex, uint8_t attrSize, uint8_t *attrValue)
	Set a characteristic descriptor of a specified characteristic of the Automation Input Output service from the local GATT database. More...

cy_en_ble_api_result_t	Cy_BLE_AIOSS_GetCharacteristicDescriptor (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_aios_char_index_t charIndex, uint8_t charInstance, cy_en_ble_aios_descr_index_t descrIndex, uint8_t attrSize, uint8_t *attrValue)
	Gets a characteristic descriptor of a specified characteristic of the Automation Input Output service from the local GATT database. More...

cy_en_ble_api_result_t	Cy_BLE_AIOSS_SendNotification (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_aios_char_index_t charIndex, uint8_t charInstance, uint8_t attrSize, uint8_t *attrValue)
	Sends a notification with a characteristic value of the Automation Input Output service, which is a value specified by charIndex, to the client's device. More...

cy_en_ble_api_result_t	Cy_BLE_AIOSS_SendIndication (cy_stc_ble_conn_handle_t connHandle, cy_en_ble_aios_char_index_t charIndex, uint8_t charInstance, uint8_t attrSize, uint8_t *attrValue)
	Sends an indication with a characteristic value of the Automation Input Output service, which is a value specified by charIndex, to the client's device. More...

Function Documentation

◆ Cy_BLE_AIOSS_SetCharacteristicValue()

cy_en_ble_api_result_t Cy_BLE_AIOSS_SetCharacteristicValue	(	cy_en_ble_aios_char_index_t	charIndex,
		uint8_t	charInstance,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

Sets the characteristic value of the service in the local database.

Parameters

charIndex	The index of the service characteristic. Starts with zero.
charInstance	The instance number of the characteristic specified by "charIndex".
attrSize	The size (in bytes) of the characteristic value attribute.
attrValue	The pointer to the characteristic value data that should be stored in the GATT database.

Returns: A return value of type cy_en_ble_api_result_t.

Error Codes	Description
CY_BLE_SUCCESS	The request was handled successfully.
CY_BLE_ERROR_INVALID_PARAMETER	Validation of the input parameter failed.
CY_BLE_ERROR_GATT_DB_INVALID_ATTR_HANDLE	An optional characteristic is absent.

◆ Cy_BLE_AIOSS_GetCharacteristicValue()

cy_en_ble_api_result_t Cy_BLE_AIOSS_GetCharacteristicValue	(	cy_en_ble_aios_char_index_t	charIndex,
		uint8_t	charInstance,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

Gets the characteristic value of the service, which is a value identified by charIndex.

Parameters

charIndex	The index of the service characteristic. Starts with zero.
charInstance	The instance number of the characteristic specified by "charIndex".
attrSize	The size of the characteristic value attribute.
attrValue	The pointer to the location where characteristic value data should be stored.

Returns: A return value of type cy_en_ble_api_result_t.

Error Codes	Description
CY_BLE_SUCCESS	The characteristic value was read successfully.
CY_BLE_ERROR_INVALID_PARAMETER	Validation of the input parameter failed.
CY_BLE_ERROR_GATT_DB_INVALID_ATTR_HANDLE	A characteristic is absent.

◆ Cy_BLE_AIOSS_SetCharacteristicDescriptor()

cy_en_ble_api_result_t Cy_BLE_AIOSS_SetCharacteristicDescriptor	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_aios_char_index_t	charIndex,
		uint8_t	charInstance,
		cy_en_ble_aios_descr_index_t	descrIndex,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

Set a characteristic descriptor of a specified characteristic of the Automation Input Output service from the local GATT database.

Parameters

connHandle	The connection handle.
charIndex	The index of the characteristic.
charInstance	The instance number of the characteristic specified by "charIndex".
descrIndex	The index of the characteristic descriptor.
attrSize	The size of the characteristic descriptor attribute.
attrValue	The pointer to the descriptor value data to be stored in the GATT database.

Returns: A return value of type cy_en_ble_api_result_t.

Error Codes	Description
CY_BLE_SUCCESS	The characteristic descriptor value was read successfully.
CY_BLE_ERROR_INVALID_PARAMETER	Validation of the input parameter failed.
CY_BLE_ERROR_GATT_DB_INVALID_ATTR_HANDLE	A descriptor is absent.

◆ Cy_BLE_AIOSS_GetCharacteristicDescriptor()

cy_en_ble_api_result_t Cy_BLE_AIOSS_GetCharacteristicDescriptor	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_aios_char_index_t	charIndex,
		uint8_t	charInstance,
		cy_en_ble_aios_descr_index_t	descrIndex,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

Gets a characteristic descriptor of a specified characteristic of the Automation Input Output service from the local GATT database.

Parameters

connHandle	The connection handle.
charIndex	The index of the characteristic.
charInstance	The instance number of the characteristic specified by "charIndex".
descrIndex	The index of the characteristic descriptor.
attrSize	The size of the characteristic descriptor attribute.
attrValue	The pointer to the location where characteristic descriptor value data should be stored.

Returns: A return value of type cy_en_ble_api_result_t.

Error Codes	Description
CY_BLE_SUCCESS	The characteristic descriptor value was read successfully.
CY_BLE_ERROR_INVALID_PARAMETER	Validation of the input parameter failed.
CY_BLE_ERROR_GATT_DB_INVALID_ATTR_HANDLE	A descriptor is absent.

◆ Cy_BLE_AIOSS_SendNotification()

cy_en_ble_api_result_t Cy_BLE_AIOSS_SendNotification	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_aios_char_index_t	charIndex,
		uint8_t	charInstance,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

Sends a notification with a characteristic value of the Automation Input Output service, which is a value specified by charIndex, to the client's device.

On enabling notification successfully for a service characteristic, it sends out a 'Handle Value Notification', which results in CY_BLE_EVT_AIOSC_NOTIFICATION event at the GATT client's end.

Parameters

connHandle	The connection handle.
charIndex	The index of the service characteristic. Starts with zero.
charInstance	The instance number of the characteristic specified by "charIndex".
attrSize	The size of the characteristic value attribute.
attrValue	The pointer to the characteristic value data that should be sent to the client's device.

Returns: A return value of type cy_en_ble_api_result_t.

Error Codes	Description
CY_BLE_SUCCESS	The request was handled successfully.
CY_BLE_ERROR_INVALID_PARAMETER	Validation of the input parameter failed.
CY_BLE_ERROR_INVALID_OPERATION	This operation is not permitted.
CY_BLE_ERROR_GATT_DB_INVALID_ATTR_HANDLE	An optional characteristic is absent.
CY_BLE_ERROR_INVALID_STATE	Connection with the client is not established.
CY_BLE_ERROR_MEMORY_ALLOCATION_FAILED	Memory allocation failed.
CY_BLE_ERROR_NTF_DISABLED	Notification is not enabled by the client.

◆ Cy_BLE_AIOSS_SendIndication()

cy_en_ble_api_result_t Cy_BLE_AIOSS_SendIndication	(	cy_stc_ble_conn_handle_t	connHandle,
		cy_en_ble_aios_char_index_t	charIndex,
		uint8_t	charInstance,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

Sends an indication with a characteristic value of the Automation Input Output service, which is a value specified by charIndex, to the client's device.

On enabling indication successfully it sends out a 'Handle Value Indication', which results in CY_BLE_EVT_AIOSC_INDICATION or CY_BLE_EVT_GATTC_HANDLE_VALUE_IND (if service-specific callback function is not registered) event at the GATT client's end.

Parameters

connHandle	The connection handle.
charIndex	The index of the service characteristic.
charInstance	The instance number of the characteristic specified by "charIndex".
attrSize	The size of the characteristic value attribute.
attrValue	The pointer to the characteristic value data that should be sent to the client's device.

Returns: A return value of type cy_en_ble_api_result_t.

Error Codes	Description
CY_BLE_SUCCESS	The request was handled successfully.
CY_BLE_ERROR_INVALID_PARAMETER	Validation of the input parameter failed.
CY_BLE_ERROR_INVALID_OPERATION	This operation is not permitted.
CY_BLE_ERROR_GATT_DB_INVALID_ATTR_HANDLE	An optional characteristic is absent.
CY_BLE_ERROR_INVALID_STATE	Connection with the client is not established.
CY_BLE_ERROR_MEMORY_ALLOCATION_FAILED	Memory allocation failed.
CY_BLE_ERROR_IND_DISABLED	Indication is not enabled by the client.

Events

In case of successful execution (return value = CY_BLE_SUCCESS) the following events can appear:
If the AIOS service-specific callback is registered with Cy_BLE_AIOS_RegisterAttrCallback():

CY_BLE_EVT_AIOSS_INDICATION_CONFIRMED - In case the indication is successfully delivered to the peer device.

Otherwise (if the AIOS service-specific callback is not registered):

CY_BLE_EVT_GATTS_HANDLE_VALUE_CNF - In case the indication is successfully delivered to the peer device.

General Description

Functions

Function Documentation

◆ Cy_BLE_AIOSS_SetCharacteristicValue()

◆ Cy_BLE_AIOSS_GetCharacteristicValue()

◆ Cy_BLE_AIOSS_SetCharacteristicDescriptor()

◆ Cy_BLE_AIOSS_GetCharacteristicDescriptor()

◆ Cy_BLE_AIOSS_SendNotification()

◆ Cy_BLE_AIOSS_SendIndication()