bas_c.h File Reference

Battery Service Client API. More...

#include "gr_includes.h"
#include "ble_prf_types.h"
#include "custom_config.h"
#include <stdint.h>
#include <stdbool.h>

Go to the source code of this file.

Classes

struct  bas_c_handles_t
 Handles on the connected peer device needed to interact with it. More...
 
struct  bas_c_evt_t
 Battery Service Client event. More...
 

Macros

#define BAS_C_CONNECTION_MAX   10
 

Typedefs

typedef void(* bas_c_evt_handler_t) (bas_c_evt_t *p_evt)
 Battery Service Client event handler type. More...
 

Enumerations

enum  bas_c_evt_type_t {
  BAS_C_EVT_INVALID,
  BAS_C_EVT_DISCOVERY_COMPLETE,
  BAS_C_EVT_DISCOVERY_FAIL,
  BAS_C_EVT_BAT_LEVEL_NTF_SET_SUCCESS,
  BAS_C_EVT_BAT_LEVEL_NTF_SET_ERR,
  BAS_C_EVT_BAT_LEVE_RECEIVE
}
 Battery Service Client event type. More...
 

Functions

sdk_err_t bas_client_init (bas_c_evt_handler_t evt_handler)
 Register BAS Client event handler. More...
 
sdk_err_t bas_c_disc_srvc_start (uint8_t conn_idx)
 Discovery Battery Service on peer. More...
 
sdk_err_t bas_c_bat_level_notify_set (uint8_t conn_idx, bool is_enable)
 Enable or disable peer Battery Level characteristic notify. More...
 
sdk_err_t bas_c_bat_level_read (uint8_t conn_idx)
 Read Battery Level characteristic value. More...
 

Detailed Description

Battery Service Client 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 bas_c.h.