IPS Server Functions

General Description

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

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

Functions
cy_en_ble_api_result_t	Cy_BLE_IPSS_SetCharacteristicValue (cy_en_ble_ips_char_index_t charIndex, 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_IPSS_GetCharacteristicValue (cy_en_ble_ips_char_index_t charIndex, 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_IPSS_SetCharacteristicDescriptor (cy_en_ble_ips_char_index_t charIndex, cy_en_ble_ips_descr_index_t descrIndex, uint8_t attrSize, uint8_t *attrValue)
	Set a characteristic descriptor of a specified characteristic of the Indoor Positioning service from the local GATT database. More...
cy_en_ble_api_result_t	Cy_BLE_IPSS_GetCharacteristicDescriptor (cy_en_ble_ips_char_index_t charIndex, cy_en_ble_ips_descr_index_t descrIndex, uint8_t attrSize, uint8_t *attrValue)
	Gets a characteristic descriptor of a specified characteristic of the Indoor Positioning service from the local GATT database. More...

Function Documentation

Cy_BLE_IPSS_SetCharacteristicValue()

cy_en_ble_api_result_t Cy_BLE_IPSS_SetCharacteristicValue	(	cy_en_ble_ips_char_index_t	charIndex,
		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.
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.

NOTE: when advertisement is active this API uses Cy_BLE_GAPP_UpdateAdvScanData() to update the advertisement packet. In the case of successful execution (return value = CY_BLE_SUCCESS) the event CY_BLE_EVT_GAPP_UPDATE_ADV_SCAN_DATA_COMPLETE appears.

Cy_BLE_IPSS_GetCharacteristicValue()

cy_en_ble_api_result_t Cy_BLE_IPSS_GetCharacteristicValue	(	cy_en_ble_ips_char_index_t	charIndex,
		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.
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 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_IPSS_SetCharacteristicDescriptor()

cy_en_ble_api_result_t Cy_BLE_IPSS_SetCharacteristicDescriptor	(	cy_en_ble_ips_char_index_t	charIndex,
		cy_en_ble_ips_descr_index_t	descrIndex,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

Set a characteristic descriptor of a specified characteristic of the Indoor Positioning service from the local GATT database.

Parameters

charIndex	The index of the characteristic.
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 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_IPSS_GetCharacteristicDescriptor()

cy_en_ble_api_result_t Cy_BLE_IPSS_GetCharacteristicDescriptor	(	cy_en_ble_ips_char_index_t	charIndex,
		cy_en_ble_ips_descr_index_t	descrIndex,
		uint8_t	attrSize,
		uint8_t *	attrValue
	)

Gets a characteristic descriptor of a specified characteristic of the Indoor Positioning service from the local GATT database.

Parameters

charIndex	The index of the characteristic.
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 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.