nRF51 SDK - S120 SoftDevice
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages

Functions

uint32_t ble_hrs_c_init (ble_hrs_c_t *p_ble_hrs_c, ble_hrs_c_init_t *p_ble_hrs_c_init)
 Function for initializing the heart rate client module. More...
 
void ble_hrs_c_on_ble_evt (ble_hrs_c_t *p_ble_hrs_c, const ble_evt_t *p_ble_evt)
 Function for handling BLE events from the SoftDevice. More...
 
uint32_t ble_hrs_c_hrm_notif_enable (ble_hrs_c_t *p_ble_hrs_c)
 Function for requesting the peer to start sending notification of Heart Rate Measurement. More...
 

Detailed Description

Function Documentation

uint32_t ble_hrs_c_hrm_notif_enable ( ble_hrs_c_t p_ble_hrs_c)

Function for requesting the peer to start sending notification of Heart Rate Measurement.

This function will enable to notification of the Heart Rate Measurement at the peer by writing to the CCCD of the Heart Rate Measurement Characteristic.

Parameters
p_ble_hrs_cPointer to the heart rate client structure.
Return values
NRF_SUCCESSIf the SoftDevice has been requested to write to the CCCD of the peer. Otherwise, an error code. This function propagates the error code returned by the SoftDevice API sd_ble_gattc_write.
uint32_t ble_hrs_c_init ( ble_hrs_c_t p_ble_hrs_c,
ble_hrs_c_init_t p_ble_hrs_c_init 
)

Function for initializing the heart rate client module.

This function will register with the DB Discovery module. There it registers for the Heart Rate Service. Doing so will make the DB Discovery module look for the presence of a Heart Rate Service instance at the peer when a discovery is started.

Parameters
[in]p_ble_hrs_cPointer to the heart rate client structure.
[in]p_ble_hrs_c_initPointer to the heart rate initialization structure containing the initialization information.
Return values
NRF_SUCCESSOn successful initialization. Otherwise an error code. This function propagates the error code returned by the Database Discovery module API ble_db_discovery_evt_register.
void ble_hrs_c_on_ble_evt ( ble_hrs_c_t p_ble_hrs_c,
const ble_evt_t p_ble_evt 
)

Function for handling BLE events from the SoftDevice.

This function will handle the BLE events received from the SoftDevice. If a BLE event is relevant to the Heart Rate Client module, then it uses it to update interval variables and, if necessary, send events to the application.

Parameters
[in]p_ble_hrs_cPointer to the heart rate client structure.
[in]p_ble_evtPointer to the BLE event.