Cypress PSoC 6 Bluetooth Low Energy Middleware Library 3.60
Functions
LE Ping API
BLE Common API » BLE Common Core Functions

General Description

The API are used for enable user to use LE Ping feature of BLE Stack.

Functions

cy_en_ble_api_result_t Cy_BLE_WriteAuthPayloadTimeout (cy_stc_ble_auth_payload_info_t *param)
 This function sets the Authentication Payload timeout in the BLE Controller for LE_PING feature. More...
 
cy_en_ble_api_result_t Cy_BLE_ReadAuthPayloadTimeout (cy_stc_ble_auth_payload_info_t *param)
 This function reads the Authentication Payload timeout set in the BLE Controller for LE_PING feature. More...
 

Function Documentation

◆ Cy_BLE_WriteAuthPayloadTimeout()

cy_en_ble_api_result_t Cy_BLE_WriteAuthPayloadTimeout ( cy_stc_ble_auth_payload_info_t *  param)

This function sets the Authentication Payload timeout in the BLE Controller for LE_PING feature.

Refer to Bluetooth 5.0 core specification, Volume 6, Part B, section 4.6.5 for LE Ping operation.

The 'CY_BLE_EVT_WRITE_AUTH_PAYLOAD_TO_COMPLETE' event is triggered on successful setting of the Authentication Payload timeout for LE_PING feature.

The 'CY_BLE_EVT_LE_PING_AUTH_TIMEOUT' event is triggered if the peer device has not responded with the valid MIC packet within the application configured ping authentication time.

Parameters
paramParameter is of type 'cy_stc_ble_auth_payload_info_t ' param->bdHandle: Peer device handle. param->authPayloadTimeout: Variable containing authentication timeout value to be written to the BLE Controller. Details on this parameter are as given below:
  • Value Range = 0x0001 to 0xFFFF
  • Default Value (N) = 3000 (30 seconds)
  • Time Calculation = N x 10 ms
  • Time Range = 10 ms to 655,350 ms
Returns
cy_en_ble_api_result_t: Return value indicates whether the function succeeded or failed. Following are the possible error codes.
Errors codes Description
CY_BLE_SUCCESS On successful operation.
CY_BLE_ERROR_INVALID_PARAMETER On specifying NULL as input parameter.
CY_BLE_ERROR_NO_DEVICE_ENTITY If connection does not exist for corresponding 'bdHandle'.
CY_BLE_ERROR_MEMORY_ALLOCATION_FAILED If Memory allocation failed.
CY_BLE_ERROR_INSUFFICIENT_RESOURCES If BLE Stack resources are unavailable.

◆ Cy_BLE_ReadAuthPayloadTimeout()

cy_en_ble_api_result_t Cy_BLE_ReadAuthPayloadTimeout ( cy_stc_ble_auth_payload_info_t *  param)

This function reads the Authentication Payload timeout set in the BLE Controller for LE_PING feature.

Refer to Bluetooth 5.0 core specification, Volume 6, Part B, section 4.6.5 for LE Ping operation.

Timeout is informed through event 'CY_BLE_EVT_READ_AUTH_PAYLOAD_TO_COMPLETE'

Parameters
paramParameter is of type 'cy_stc_ble_auth_payload_info_t ' param->bdHandle: Peer device handle. param->authPayloadTimeout: to be ignored.
Returns
cy_en_ble_api_result_t: Return value indicates whether the function succeeded or failed. Following are the possible error codes.
Errors codes Description
CY_BLE_SUCCESS On successful operation.
CY_BLE_ERROR_INVALID_PARAMETER On specifying NULL as input parameter.
CY_BLE_ERROR_NO_DEVICE_ENTITY If connection does not exist for corresponding 'bdHandle'.
CY_BLE_ERROR_MEMORY_ALLOCATION_FAILED If Memory allocation failed.
CY_BLE_ERROR_INSUFFICIENT_RESOURCES If BLE Stack resources are unavailable.