hrs_client.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021 Nordic Semiconductor
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef BT_HRS_CLIENT_H_
#define BT_HRS_CLIENT_H_
 
#include <zephyr/bluetooth/conn.h>
#include <bluetooth/gatt_dm.h>
#include <zephyr/bluetooth/gatt.h>
 
#include <zephyr/sys/atomic.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum bt_hrs_client_error {
        BT_HRS_CLIENT_ERROR_CP_NOT_SUPPORTED = 0x80
};
 
enum bt_hrs_client_cp_value {
        BT_HRS_CLIENT_CP_VALUE_RESET_EE = 0x01
};
 
enum bt_hrs_client_sensor_location {
        BT_HRS_CLIENT_SENSOR_LOCATION_OTHER,
 
        BT_HRS_CLIENT_SENSOR_LOCATION_CHEST,
 
        BT_HRS_CLIENT_SENSOR_LOCATION_WRIST,
 
        BT_HRS_CLIENT_SENSOR_LOCATION_FINGER,
 
        BT_HRS_CLIENT_SENSOR_LOCATION_HAND,
 
        BT_HRS_CLIENT_SENSOR_LOCATION_EAR_LOBE,
 
        BT_HRS_CLIENT_SENSOR_LOCATION_FOOT
};
 
struct bt_hrs_flags {
        uint8_t value_format : 1;
 
        uint8_t sensor_contact_detected : 1;
 
        uint8_t sensor_contact_supported : 1;
 
        uint8_t energy_expended_present : 1;
 
        uint8_t rr_intervals_present : 1;
};
 
struct bt_hrs_client_measurement {
        struct bt_hrs_flags flags;
 
        uint8_t rr_intervals_count;
 
        uint16_t rr_intervals[CONFIG_BT_HRS_CLIENT_RR_INTERVALS_COUNT];
 
        uint16_t hr_value;
 
        uint16_t energy_expended;
};
 
/* Helper forward structure declaration representing Heart Rate Service Client instance.
 * Needed for callback declaration that are using instance structure as argument.
 */
struct bt_hrs_client;
 
typedef void (*bt_hrs_client_notify_cb)(struct bt_hrs_client *hrs_c,
                                        const struct bt_hrs_client_measurement *meas,
                                        int err);
 
typedef void (*bt_hrs_client_read_sensor_location_cb)(struct bt_hrs_client *hrs_c,
                                                      enum bt_hrs_client_sensor_location location,
                                                      int err);
 
typedef void (*bt_hrs_client_write_cb)(struct bt_hrs_client *hrs_c,
                                       uint8_t err);
 
struct bt_hrs_client_hr_meas {
        uint16_t handle;
 
        uint16_t ccc_handle;
 
        struct bt_gatt_subscribe_params notify_params;
 
        bt_hrs_client_notify_cb notify_cb;
};
 
struct bt_hrs_client_body_sensor_location {
        uint16_t handle;
 
        struct bt_gatt_read_params read_params;
 
        bt_hrs_client_read_sensor_location_cb read_cb;
};
 
struct bt_hrs_client_control_point {
        uint16_t handle;
 
        struct bt_gatt_write_params write_params;
 
        bt_hrs_client_write_cb write_cb;
};
 
struct bt_hrs_client {
        struct bt_conn *conn;
 
        struct bt_hrs_client_hr_meas measurement_char;
 
        struct bt_hrs_client_body_sensor_location sensor_location_char;
 
        struct bt_hrs_client_control_point cp_char;
 
        atomic_t state;
};
 
int bt_hrs_client_init(struct bt_hrs_client *hrs_c);
 
int bt_hrs_client_measurement_subscribe(struct bt_hrs_client *hrs_c,
                                        bt_hrs_client_notify_cb notify_cb);
 
int bt_hrs_client_measurement_unsubscribe(struct bt_hrs_client *hrs_c);
 
int bt_hrs_client_sensor_location_read(struct bt_hrs_client *hrs_c,
                                       bt_hrs_client_read_sensor_location_cb read_cb);
 
bool bt_hrs_client_has_sensor_location(struct bt_hrs_client *hrs_c);
 
int bt_hrs_client_control_point_write(struct bt_hrs_client *hrs_c,
                                      enum bt_hrs_client_cp_value value,
                                      bt_hrs_client_write_cb write_cb);
 
bool bt_hrs_client_has_control_point(struct bt_hrs_client *hrs_c);
 
int bt_hrs_client_handles_assign(struct bt_gatt_dm *dm, struct bt_hrs_client *hrs_c);
 
#ifdef __cplusplus
}
#endif
 
#endif /* BT_HRS_CLIENT_H_ */