1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
|
#ifndef __BLE_H__
#define __BLE_H__
/*
* Android BLE Library -- Provides utility functions to control BLE features
*
* Copyright (C) 2013 João Paulo Rechi Vita
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of the
* the Free Software Foundation; either version 2 of the License, or
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*
*/
/** @file
*
* \mainpage
*
* \section intro_sec Introduction
*
* This document describes the libble API, a BLE library for Android which sits
* on top of libhardware. The objective of this library is to abstract away
* some libhardware specifics, exposing only what is necessary to create BLE
* bindings to higher-level languages.
*
* Due to Bluedroid and/or libhardware architectural restrictions no more than
* one process can access the Bluetooth resources on the system at the same
* time. That means that only one program that makes use of libble can run on
* the system at a certain time and that Bluetooth should be disabled in the
* Android GUI (if running).
*/
/**
* Type that represents a callback function to inform that BLE is enabled and
* available to be used.
*/
typedef void (*ble_enable_cb_t)(void);
/**
* Type that represents a callback function to inform an adapter state change.
*
* @param state The new state of the adapter: 0 disabled, 1 enabled.
*/
typedef void (*ble_adapter_state_cb_t)(uint8_t state);
/**
* Type that represents a callback function to notify of a new found device
* during a scanning session.
*
* @param address A pointer to a 6 element array representing each part of the
* Bluetooth address of the found device, where the
* most-significant byte is on position 0 and the
* least-sifnificant byte is on position 5.
* @param rssi The RSSI of the found device.
* @param adv_data A pointer to the advertising data of the found device.
*/
typedef void (*ble_scan_cb_t)(const uint8_t *address, int rssi,
const uint8_t *adv_data);
/**
* List of callbacks for BLE operations.
*/
typedef struct ble_cbs {
ble_enable_cb_t enable_cb;
ble_adapter_state_cb_t adapter_state_cb;
ble_scan_cb_t scan_cb;
} ble_cbs_t;
/**
* Initialize the BLE stack and necessary interfaces and power on the adapter.
*
* @param cbs List of callbacks for BLE operations.
*
* @return 0 on success.
* @return Negative value on failure.
*/
int ble_enable(ble_cbs_t cbs);
/**
* Power off the adapter, cleanup the BLE features and shutdown the stack.
*
* @return 0 on success.
* @return Negative value on failure.
*/
int ble_disable();
/**
* Starts a LE scan procedure on the adapter.
*
* Scan will run indefinitelly until ble_scan_stop() is called.
*
* @return 0 if scan has been started.
* @return 1 if adapter is already scanning.
* @return -1 if failed to request scan start.
*/
int ble_start_scan();
/**
* Stops a running LE scan procedure on the adapter.
*
* @return 0 if scan has been stopped.
* @return 1 if adapter is not scanning.
* @return -1 if failed to request scan stop.
*/
int ble_stop_scan();
#endif
|
