nRF Connect SDK Bare Metal API 2.0.99
Loading...
Searching...
No Matches
Heart Rate Service Client

Heart Rate Service Client. More...

Data Structures

struct  ble_hrs_measurement
 Heart Rate Measurement received from the peer. More...
 
struct  ble_hrs_handles
 Database for handles related to the Heart Rate Service found on the peer. More...
 
struct  ble_hrs_client_evt
 Heart Rate Event. More...
 
struct  ble_hrs_client
 Heart Rate Client. More...
 
struct  ble_hrs_client_config
 Heart Rate Client configuration structure. More...
 

Macros

#define BLE_HRS_CLIENT_DEF(_name)
 Macro for defining a ble_hrs_client instance.
 

Typedefs

typedef void(* ble_hrs_client_evt_handler_t) (struct ble_hrs_client *hrs_client, const struct ble_hrs_client_evt *evt)
 Event handler type.
 

Enumerations

enum  ble_hrs_client_evt_type { BLE_HRS_CLIENT_EVT_DISCOVERY_COMPLETE , BLE_HRS_CLIENT_EVT_HRM_NOTIFICATION , BLE_HRS_CLIENT_EVT_ERROR }
 HRS Client event type. More...
 

Functions

uint32_t ble_hrs_client_init (struct ble_hrs_client *hrs_client, const struct ble_hrs_client_config *hrs_client_config)
 Initialize the Heart Rate Client module.
 
void ble_hrs_client_on_ble_evt (const ble_evt_t *ble_evt, void *ble_hrs_client)
 Bluetooth LE event handler for the Heart Rate Service Client.
 
uint32_t ble_hrs_client_hrm_notif_enable (struct ble_hrs_client *hrs_client)
 Request the peer to start sending notification of Heart Rate Measurement.
 
uint32_t ble_hrs_client_hrm_notif_disable (struct ble_hrs_client *hrs_client)
 Request the peer to stop sending notification of Heart Rate Measurement.
 
void ble_hrs_on_db_disc_evt (struct ble_hrs_client *hrs_client, const struct ble_db_discovery_evt *evt)
 Handle events from the Database Discovery module.
 
uint32_t ble_hrs_client_handles_assign (struct ble_hrs_client *hrs_client, uint16_t conn_handle, const struct ble_hrs_handles *peer_hrs_handles)
 Assign handles to an instance of hrs_c.
 

Detailed Description

Heart Rate Service Client.

This library contains the APIs and types exposed by the Heart Rate Service Client library. The application can use these APIs and types to perform the discovery of Heart Rate Service at the peer and to interact with it.

Warning
Currently, this library only supports the Heart Rate Measurement characteristic. This means that it is able to enable notification of the characteristic at the peer and is able to receive Heart Rate Measurement notifications from the peer. It does not support the Body Sensor Location and the Heart Rate Control Point characteristics. When a Heart Rate Measurement is received, this library decodes only the Heart Rate Measurement value field (both 8-bit and 16-bit) and RR intervals and provides it to the application.