wss.h File Reference

Weight Scale 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 wss.h:

Go to the source code of this file.

Classes

struct  wss_meas_val_t
 Weight Scale Measurement data. More...
 
struct  wss_evt_t
 Weight Scale Service event. More...
 
struct  wss_init_t
 Weight Scale Service Init variable. More...
 

Macros

#define WSS_CONNECTION_MAX   10
 Maximum number of Weight Scale Service connections. More...
 
#define WSS_MEAS_VAL_LEN_MAX   15
 Maximum length of Weight Measurment value. More...
 
#define WSS_CACHE_MEAS_NUM_MAX   25
 Maximum number of cache muasurements value for each user. More...
 
#define WSS_FEAT_VAL_LEN_MAX   1
 Maximum length of WS Feature value. More...
 
#define WSS_MEAS_UNSUCCESS   0xFFFF
 Measurement Unsuccessful. More...
 
#define WSS_CHAR_FEAT_MANDATORY   0x7F
 Bit mask for mandatory characteristic in WSS. More...
 

Typedefs

typedef void(* wss_evt_handler_t) (wss_evt_t *p_evt)
 Weight Scale Service event handler type. More...
 

Enumerations

enum  wss_meas_flag_bits {
  WSS_MEAS_FLAG_UNIT_SI = 0x00, WSS_MEAS_FLAG_UNIT_IMPERIAL = 0x01, WSS_MEAS_FLAG_DATE_TIME_PRESENT = 0x02, WSS_MEAS_FLAG_USER_ID_PRESENT = 0x04,
  WSS_MEAS_FLAG_BMI_HEIGHT_PRESENT = 0x08
}
 Weight Scale Measurement Flags. More...
 
enum  wss_feature_t {
  WSS_FEAT_TIME_STAMP = 0x00000001, WSS_FEAT_MULTI_USER = 0x00000002, WSS_FEAT_BMI = 0x00000004, WSS_FEAT_MASS_RES_500G = 0x00000008,
  WSS_FEAT_MASS_RES_200G = 0x00000010, WSS_FEAT_MASS_RES_100G = 0x00000018, WSS_FEAT_MASS_RES_50G = 0x00000020, WSS_FEAT_MASS_RES_20G = 0x00000028,
  WSS_FEAT_MASS_RES_10G = 0x00000030, WSS_FEAT_MASS_RES_5G = 0x00000038, WSS_FEAT_HEIGHT_RES_10MM = 0x00000080, WSS_FEAT_HEIGHT_RES_5MM = 0x00000100,
  WSS_FEAT_HEIGHT_RES_1MM = 0x00000180, WSS_FEAT_FULL_BIT = 0x000001BF
}
 Weight Scale Feature characteristic bit values. More...
 
enum  wss_mass_res_t {
  WSS_MASS_RES_500G, WSS_MASS_RES_200G, WSS_MASS_RES_100G, WSS_MASS_RES_50G,
  WSS_MASS_RES_20G, WSS_MASS_RES_10G, WSS_MASS_RES_5G
}
 WSS Weight Measurement resolutions. More...
 
enum  wss_height_res_t { WSS_HEIGHT_RES_10MM, WSS_HEIGHT_RES_5MM, WSS_HEIGHT_RES_1MM }
 WSS Height Measurement resolutions. More...
 
enum  wss_unit_t { WSS_UNIT_SI, WSS_UNIT_IMPERIAL }
 WSS unit types. More...
 
enum  wss_evt_type_t {
  WSS_EVT_INVALID, WSS_EVT_MEAS_INDICATION_ENABLE, WSS_EVT_MEAS_INDICATION_DISABLE, WSS_EVT_MEAS_INDICATION_CPLT,
  WSS_EVT_MEAS_READ_CHARACTERISTIC
}
 Weight Scale Service event type. More...
 

Functions

sdk_err_t wss_service_init (wss_init_t *p_wss_init, uint16_t *p_bcs_start_handle)
 Initialize a Weight Scale Service instance and add in the DB. More...
 
sdk_err_t wss_measurement_send (uint8_t conn_idx, wss_meas_val_t *p_meas, uint8_t cache_num)
 Send Weight Scale Measurement indication. More...
 

Detailed Description

Weight Scale 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 wss.h.