IAS Server and Client Function

group group_ble_service_api_IAS_server_client

These are API common to both GATT Client role and GATT Server role.

You may use them in either roles.

No letter is appended to the API name: Cy_BLE_IAS_

Functions

cy_en_ble_api_result_t Cy_BLE_IASS_Init(const cy_stc_ble_iass_config_t *config)

This function initializes server of the Immediate Alert service.

Error Codes

Description

CY_BLE_SUCCESS

The function completed successfully.

CY_BLE_ERROR_INVALID_PARAMETER

On specifying NULL as input parameter.

CY_BLE_ERROR_MEMORY_ALLOCATION_FAILED

Buffer overflow in the registration callback.

Return

cy_en_ble_api_result_t : Return value indicates whether the function succeeded or failed. The following are possible error codes.

Parameters
  • config: Configuration structure for the IAS.

cy_en_ble_api_result_t Cy_BLE_IASC_Init(const cy_stc_ble_iasc_config_t *config)

This function initializes client of the Immediate Alert service.

Error Codes

Description

CY_BLE_SUCCESS

The function completed successfully.

CY_BLE_ERROR_INVALID_PARAMETER

On specifying NULL as input parameter.

CY_BLE_ERROR_MEMORY_ALLOCATION_FAILED

Buffer overflow in the registration callback.

Return

cy_en_ble_api_result_t : Return value indicates whether the function succeeded or failed. The following are possible error codes.

Parameters
  • config: Configuration structure for the IAS.

void Cy_BLE_IAS_RegisterAttrCallback(cy_ble_callback_t callbackFunc)

Registers a callback function for service-specific attribute operations.

Service-specific Write Requests from the peer device will not be handled with an unregistered callback function.

Parameters
  • callbackFunc: An application layer event callback function to receive events from the PSoC 6 BLE Middleware. The definition of cy_ble_callback_t for IAS service is:

    typedef void (* cy_ble_callback_t) (uint32_t eventCode, void *eventParam), where:

    • eventCode: Indicates the event that triggered this callback (e.g. CY_BLE_EVT_IASS_WRITE_CHAR_CMD).

    • eventParam: Contains the parameters corresponding to the current event; (e.g. pointer to cy_stc_ble_ias_char_value_t structure that contains details of the characteristic for which the notification enabled event was triggered).