Classes | Macros | Typedefs | Enumerations | Functions
bas.h File Reference

Battery Service API. More...

`#include "gr_includes.h"`
`#include <stdbool.h>`
`#include <stdint.h>`
Include dependency graph for bas.h:

Go to the source code of this file.

## Classes
struct | bas_evt_t
| Battery Service event. More...
struct | bas_init_t
| Battery Service init structure. More...

## Macros
#define | BAS_INSTANCE_MAX 1
| Maximum number of Battery Service instances. More...
#define | BAS_CONNECTION_MAX 10
| Maximum number of BAS connections.The value is configurable. More...
#define | BAS_LVL_MAX_LEN 1
| Maximun length of battery level value. More...
#define | BAS_CHAR_MANDATORY 0x07
| Bit mask of the mandatory characteristics in BAS. More...
#define | BAS_CHAR_LVL_NTF_SUP 0x08
| Bit mask of Battery Level notification. More...
#define | BAS_CHAR_FORMAT_SUP 0x10
| Bit mask of the Presentation Format descriptor. More...
#define | BAS_CHAR_FULL 0x1f
| Bit mask of the full characteristic. More...

## Typedefs
typedef void(* | bas_evt_handler_t) (bas_evt_t *p_evt)
| Battery Service event handler type. More...

## Enumerations
enum | bas_evt_type_t { BAS_EVT_INVALID, BAS_EVT_NOTIFICATION_ENABLED, BAS_EVT_NOTIFICATION_DISABLED }
| Battery Service event types. More...

## Functions
sdk_err_t | bas_service_init (bas_init_t bas_init[], uint8_t ins_num)
| Initialize Battery Service instances and add to the DB. More...
sdk_err_t | bas_batt_lvl_update (uint8_t conn_idx, uint8_t ins_idx, uint8_t batt_lvl)
| Update a Battery Level value. More...
uint16_t | bas_service_start_handle_get (void)
| Provide the interface for other modules to obtain the bas service start handle . More...

## Detailed Description

Battery 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 bas.h.