bcs.h File Reference

Body Composition Service API. More...

#include "gr_includes.h"
#include "custom_config.h"
#include "ble_prf_utils.h"
#include <stdint.h>
#include <stdbool.h>
+ Include dependency graph for bcs.h:

Go to the source code of this file.

Classes

struct  bcs_meas_flag_t
 Body composition Measurement flag data. More...
 
struct  bcs_meas_val_t
 Body composition Measurement data. More...
 
struct  bcs_evt_t
 Body Composition Service event. More...
 
struct  bcs_init_t
 Body Composition Service Init variable. More...
 

Macros

#define BCS_CONNECTION_MAX   10
 Maximum number of Body Composition Service connections. More...
 
#define BCS_MEAS_VAL_LEN_MAX   20
 Maximum length of BC Measurment value. More...
 
#define BCS_FEAT_VAL_LEN_MAX   4
 Maximum length of BC Feature value. More...
 
#define INDI_PAYLOAD_HEADER_LEN   3
 The length of indication payload header. More...
 
#define NUM_PACKETS   2
 Measurement Packet numbers. More...
 
#define MEAS_PACKET_FIRST   0
 The first Measurement Packet. More...
 
#define MEAS_PACKET_SUB   1
 The second Measurement Packet. More...
 
#define BCS_CACHE_MEAS_NUM_MAX   25
 Maximum number of cache muasurements value for each user. More...
 
#define BCS_MEAS_UNSUCCESS   0xFFFF
 Measurement unsuccessful. More...
 
#define BCS_MEAS_FLAG_DEFAULT   0x01FF
 Measurement default flag. More...
 
#define BCS_CHAR_FEAT_MANDATORY   0x3F
 Bit mask for mandatory characteristic in BCS. More...
 

Typedefs

typedef void(* bcs_evt_handler_t) (bcs_evt_t *p_evt)
 Body Composition Service event handler type. More...
 

Enumerations

enum  bcs_meas_flag_bits {
  BCS_MEAS_FLAG_UNIT_SI = 0x0000, BCS_MEAS_FLAG_UNIT_IMPERIAL = 0x0001, BCS_MEAS_FLAG_DATE_TIME_PRESENT = 0x0002, BCS_MEAS_FLAG_USER_ID_PRESENT = 0x0004,
  BCS_MEAS_FLAG_BASAL_METABOLISM = 0x0008, BCS_MEAS_FLAG_MUSCLE_PERCENTAGE = 0x0010, BCS_MEAS_FLAG_MUSCLE_MASS = 0x0020, BCS_MEAS_FLAG_FAT_FREE_MASS = 0x0040,
  BCS_MEAS_FLAG_SOFT_LEAN_MASS = 0x0080, BCS_MEAS_FLAG_BODY_WATER_MASS = 0x0100, BCS_MEAS_FLAG_IMPEDANCE = 0x0200, BCS_MEAS_FLAG_WEIGHT = 0x0400,
  BCS_MEAS_FLAG_HEIGHT = 0x0800, BCS_MEAS_FLAG_MUTI_PACKET = 0x1000
}
 Body Composition Measurement Flags. More...
 
enum  bcs_feature_t {
  BCS_FEAT_TIME_STAMP = 0x00000001, BCS_FEAT_MULTI_USER = 0x00000002, BCS_FEAT_BASAL_METABOLISM = 0x00000004, BCS_FEAT_MUSCLE_PERCENTAGE = 0x00000008,
  BCS_FEAT_MUSCLE_MASS = 0x00000010, BCS_FEAT_FAT_FREE_MASS = 0x00000020, BCS_FEAT_SOFT_LEAN_MASS = 0x00000040, BCS_FEAT_BODY_WATER_MASS = 0x00000080,
  BCS_FEAT_IMPEDANCE = 0x00000100, BCS_FEAT_WEIGHT = 0x00000200, BCS_FEAT_HEIGHT = 0x00000400, BCS_FEAT_MASS_RES_500G = 0x00000800,
  BCS_FEAT_MASS_RES_200G = 0x00001000, BCS_FEAT_MASS_RES_100G = 0x00001800, BCS_FEAT_MASS_RES_50G = 0x00002000, BCS_FEAT_MASS_RES_20G = 0x00002800,
  BCS_FEAT_MASS_RES_10G = 0x00003000, BCS_FEAT_MASS_RES_5G = 0x00003800, BCS_FEAT_HEIGHT_RES_10MM = 0x00008000, BCS_FEAT_HEIGHT_RES_5MM = 0x00010000,
  BCS_FEAT_HEIGHT_RES_1MM = 0x00018000, BCS_FEAT_FULL_BIT = 0x0001BFFF
}
 Body Composition Feature characteristic bit values. More...
 
enum  bcs_mass_res_t {
  BCS_MASS_RES_500G, BCS_MASS_RES_200G, BCS_MASS_RES_100G, BCS_MASS_RES_50G,
  BCS_MASS_RES_20G, BCS_MASS_RES_10G, BCS_MASS_RES_5G
}
 BCS Weight Measurement resolutions. More...
 
enum  bcs_height_res_t { BCS_HEIGHT_RES_10MM, BCS_HEIGHT_RES_5MM, BCS_HEIGHT_RES_1MM }
 BCS Height Measurement resolutions. More...
 
enum  bcs_unit_t { BCS_UNIT_SI, BCS_UNIT_IMPERIAL }
 BCS unit types. More...
 
enum  bcs_evt_type_t {
  BCS_EVT_INVALID, BCS_EVT_MEAS_INDICATION_ENABLE, BCS_EVT_MEAS_INDICATION_DISABLE, BCS_EVT_MEAS_INDICATION_CPLT,
  BCS_EVT_MEAS_READ_CHARACTERISTIC
}
 Body Composition Service event type. More...
 

Functions

sdk_err_t bcs_service_init (bcs_init_t *p_bcs_init)
 Initialize a Body Composition Service instance and add in the DB. More...
 
sdk_err_t bcs_measurement_send (uint8_t conn_idx, bcs_meas_val_t *p_meas, uint8_t cache_num)
 Send Body Composition Measurement indication. More...
 
uint16_t * bcs_start_handle_get (void)
 Get the pointer to the start handle of Body Composition Service. More...
 

Detailed Description

Body Composition Service API.

Attention
Copyright (c) 2019 GOODIX

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of GOODIX nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDERS AND CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file bcs.h.