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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
|
/*
* Copyright (C) 2016 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef ANDROID_INCLUDE_BLE_SCANNER_H
#define ANDROID_INCLUDE_BLE_SCANNER_H
#include <bluetooth/uuid.h>
#include <raw_address.h>
#include <stdint.h>
#include <memory>
#include <vector>
#include "bt_common_types.h"
#include "bt_gatt_client.h"
#include "bt_gatt_types.h"
/** Callback invoked when batchscan reports are obtained */
typedef void (*batchscan_reports_callback)(int client_if, int status,
int report_format, int num_records,
std::vector<uint8_t> data);
/** Callback invoked when batchscan storage threshold limit is crossed */
typedef void (*batchscan_threshold_callback)(int client_if);
/** Track ADV VSE callback invoked when tracked device is found or lost */
typedef void (*track_adv_event_callback)(
btgatt_track_adv_info_t* p_track_adv_info);
/** Callback for scan results */
typedef void (*scan_result_callback)(uint16_t event_type, uint8_t addr_type,
RawAddress* bda, uint8_t primary_phy,
uint8_t secondary_phy,
uint8_t advertising_sid, int8_t tx_power,
int8_t rssi, uint16_t periodic_adv_int,
std::vector<uint8_t> adv_data,
RawAddress* original_bda);
typedef struct {
scan_result_callback scan_result_cb;
batchscan_reports_callback batchscan_reports_cb;
batchscan_threshold_callback batchscan_threshold_cb;
track_adv_event_callback track_adv_event_cb;
} btgatt_scanner_callbacks_t;
class AdvertisingTrackInfo {
public:
uint8_t scanner_id;
uint8_t filter_index;
uint8_t advertiser_state;
uint8_t advertiser_info_present;
RawAddress advertiser_address;
uint8_t advertiser_address_type;
uint8_t tx_power;
int8_t rssi;
uint16_t time_stamp;
uint8_t adv_packet_len;
std::vector<uint8_t> adv_packet;
uint8_t scan_response_len;
std::vector<uint8_t> scan_response;
};
/**
* LE Scanning related callbacks invoked from from the Bluetooth native stack
* All callbacks are invoked on the JNI thread
*/
class ScanningCallbacks {
public:
virtual ~ScanningCallbacks() = default;
virtual void OnScannerRegistered(const bluetooth::Uuid app_uuid,
uint8_t scannerId, uint8_t status) = 0;
virtual void OnSetScannerParameterComplete(uint8_t scannerId,
uint8_t status) = 0;
virtual void OnScanResult(uint16_t event_type, uint8_t addr_type,
RawAddress bda, uint8_t primary_phy,
uint8_t secondary_phy, uint8_t advertising_sid,
int8_t tx_power, int8_t rssi,
uint16_t periodic_adv_int,
std::vector<uint8_t> adv_data) = 0;
virtual void OnTrackAdvFoundLost(
AdvertisingTrackInfo advertising_track_info) = 0;
virtual void OnBatchScanReports(int client_if, int status, int report_format,
int num_records,
std::vector<uint8_t> data) = 0;
virtual void OnBatchScanThresholdCrossed(int client_if) = 0;
virtual void OnPeriodicSyncStarted(int reg_id, uint8_t status,
uint16_t sync_handle,
uint8_t advertising_sid,
uint8_t address_type, RawAddress address,
uint8_t phy, uint16_t interval) = 0;
virtual void OnPeriodicSyncReport(uint16_t sync_handle, int8_t tx_power,
int8_t rssi, uint8_t status,
std::vector<uint8_t> data) = 0;
virtual void OnPeriodicSyncLost(uint16_t sync_handle) = 0;
virtual void OnPeriodicSyncTransferred(int pa_source, uint8_t status,
RawAddress address) = 0;
};
class BleScannerInterface {
public:
virtual ~BleScannerInterface() = default;
using RegisterCallback =
base::Callback<void(uint8_t /* scanner_id */, uint8_t /* btm_status */)>;
using Callback = base::Callback<void(uint8_t /* btm_status */)>;
using EnableCallback =
base::Callback<void(uint8_t /* action */, uint8_t /* btm_status */)>;
using FilterParamSetupCallback =
base::Callback<void(uint8_t /* avbl_space */, uint8_t /* action_type */,
uint8_t /* btm_status */)>;
using FilterConfigCallback =
base::Callback<void(uint8_t /* filt_type */, uint8_t /* avbl_space */,
uint8_t /* action */, uint8_t /* btm_status */)>;
/** Registers a scanner with the stack */
virtual void RegisterScanner(const bluetooth::Uuid& app_uuid,
RegisterCallback) = 0;
/** Unregister a scanner from the stack */
virtual void Unregister(int scanner_id) = 0;
/** Start or stop LE device scanning */
virtual void Scan(bool start) = 0;
/** Setup scan filter params */
virtual void ScanFilterParamSetup(
uint8_t client_if, uint8_t action, uint8_t filt_index,
std::unique_ptr<btgatt_filt_param_setup_t> filt_param,
FilterParamSetupCallback cb) = 0;
/** Configure a scan filter condition */
virtual void ScanFilterAdd(int filter_index, std::vector<ApcfCommand> filters,
FilterConfigCallback cb) = 0;
/** Clear all scan filter conditions for specific filter index*/
virtual void ScanFilterClear(int filt_index, FilterConfigCallback cb) = 0;
/** Enable / disable scan filter feature*/
virtual void ScanFilterEnable(bool enable, EnableCallback cb) = 0;
/** Sets the LE scan interval and window in units of N*0.625 msec */
virtual void SetScanParameters(int scanner_id, std::vector<uint32_t> scan_interval,
std::vector<uint32_t> scan_window,
Callback cb) = 0;
/* Configure the batchscan storage */
virtual void BatchscanConfigStorage(int client_if, int batch_scan_full_max,
int batch_scan_trunc_max,
int batch_scan_notify_threshold,
Callback cb) = 0;
/* Enable batchscan */
virtual void BatchscanEnable(int scan_mode, int scan_interval,
int scan_window, int addr_type, int discard_rule,
Callback cb) = 0;
/* Disable batchscan */
virtual void BatchscanDisable(Callback cb) = 0;
/* Read out batchscan reports */
virtual void BatchscanReadReports(int client_if, int scan_mode) = 0;
using StartSyncCb =
base::Callback<void(uint8_t status, uint16_t sync_handle,
uint8_t advertising_sid, uint8_t address_type,
RawAddress address, uint8_t phy, uint16_t interval)>;
using SyncReportCb =
base::Callback<void(uint16_t sync_handle, int8_t tx_power, int8_t rssi,
uint8_t status, std::vector<uint8_t> data)>;
using SyncLostCb = base::Callback<void(uint16_t sync_handle)>;
virtual void StartSync(uint8_t sid, RawAddress address, uint16_t skip,
uint16_t timeout, StartSyncCb start_cb,
SyncReportCb report_cb, SyncLostCb lost_cb) = 0;
virtual void StartSync(uint8_t sid, RawAddress address, uint16_t skip,
uint16_t timeout, int reg_id) = 0;
virtual void StopSync(uint16_t handle) = 0;
virtual void RegisterCallbacks(ScanningCallbacks* callbacks) = 0;
virtual void CancelCreateSync(uint8_t sid, RawAddress address) = 0;
using SyncTransferCb =
base::Callback<void(uint8_t /*status*/, RawAddress /*addr*/)>;
virtual void TransferSync(RawAddress address, uint16_t service_data,
uint16_t sync_handle, SyncTransferCb cb) = 0;
virtual void TransferSetInfo(RawAddress address, uint16_t service_data,
uint8_t adv_handle, SyncTransferCb cb) = 0;
virtual void SyncTxParameters(RawAddress addr, uint8_t mode, uint16_t skip,
uint16_t timeout, StartSyncCb start_cb) = 0;
virtual void TransferSync(RawAddress address, uint16_t service_data,
uint16_t sync_handle, int pa_source) = 0;
virtual void TransferSetInfo(RawAddress address, uint16_t service_data,
uint8_t adv_handle, int pa_source) = 0;
virtual void SyncTxParameters(RawAddress addr, uint8_t mode, uint16_t skip,
uint16_t timeout, int reg_id) = 0;
};
#endif /* ANDROID_INCLUDE_BLE_SCANNER_H */
|
