mirror of
https://github.com/kidfromjupiter/nearby.git
synced 2026-09-16 15:36:12 -04:00
[BLE Refactor] Merge platform/implementation/ble_v2.h to /cal/api/ble.h for Advertising defintions.
PiperOrigin-RevId: 428145899
This commit is contained in:
edwinwu
committed by
Copybara-Service
Copybara-Service
parent
0e6620c970
commit
659f0a659c
+99
-34
@@ -1,4 +1,4 @@
|
||||
// Copyright 2020 Google LLC
|
||||
// Copyright 2021 Google LLC
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
@@ -23,16 +23,19 @@
|
||||
#include "absl/time/time.h"
|
||||
#include "absl/types/optional.h"
|
||||
#include "third_party/nearby/cpp/cal/base/ble_types.h"
|
||||
|
||||
namespace nearby {
|
||||
namespace cal {
|
||||
namespace api {
|
||||
|
||||
// TODO(b/213835576): Refactor BlePeripheral. The one in BluetoothAdapter should
|
||||
// be considered, too.
|
||||
class BlePeripheral {
|
||||
public:
|
||||
virtual ~BlePeripheral() {}
|
||||
virtual std::string GetName() const = 0;
|
||||
virtual std::string GetAddress() const = 0;
|
||||
virtual ByteArray GetAdvertisementBytes() const = 0;
|
||||
virtual location::nearby::ByteArray GetAdvertisementBytes() const = 0;
|
||||
};
|
||||
|
||||
struct ScanResult {
|
||||
@@ -42,9 +45,12 @@ struct ScanResult {
|
||||
absl::Time timestamp;
|
||||
};
|
||||
|
||||
// https://developer.android.com/reference/android/bluetooth/BluetoothGattCharacteristic
|
||||
//
|
||||
// Representation of a GATT characteristic.
|
||||
class GattCharacteristic {
|
||||
public:
|
||||
virtual ~GattCharacteristic() {}
|
||||
virtual ~GattCharacteristic() = default;
|
||||
|
||||
enum class Permission {
|
||||
kUnknown = 0,
|
||||
@@ -61,7 +67,10 @@ class GattCharacteristic {
|
||||
kLast,
|
||||
};
|
||||
|
||||
virtual std::string GetServiceUuid() = 0;
|
||||
virtual std::string GetUuid() const = 0;
|
||||
|
||||
// Returns the UUID of the containing GATT service.
|
||||
virtual std::string GetServiceUuid() const = 0;
|
||||
};
|
||||
|
||||
class ClientGattConnection {
|
||||
@@ -72,10 +81,11 @@ class ClientGattConnection {
|
||||
virtual absl::optional<GattCharacteristic*> GetCharacteristic(
|
||||
absl::string_view service_uuid,
|
||||
absl::string_view characteristic_uuid) = 0;
|
||||
virtual absl::optional<ByteArray> ReadCharacteristic(
|
||||
virtual absl::optional<location::nearby::ByteArray> ReadCharacteristic(
|
||||
const GattCharacteristic& characteristic) = 0;
|
||||
virtual bool WriteCharacteristic(const GattCharacteristic& characteristic,
|
||||
const ByteArray& value) = 0;
|
||||
virtual bool WriteCharacteristic(
|
||||
const GattCharacteristic& characteristic,
|
||||
const location::nearby::ByteArray& value) = 0;
|
||||
virtual void Disconnect() = 0;
|
||||
virtual bool SetCharacteristicNotification(
|
||||
const GattCharacteristic& characteristic, bool enable) = 0;
|
||||
@@ -85,7 +95,7 @@ class ServerGattConnection {
|
||||
public:
|
||||
virtual ~ServerGattConnection() {}
|
||||
virtual bool SendCharacteristic(const GattCharacteristic& characteristic,
|
||||
const ByteArray& value) = 0;
|
||||
const location::nearby::ByteArray& value) = 0;
|
||||
};
|
||||
|
||||
class ClientGattConnectionLifeCycleCallback {
|
||||
@@ -96,26 +106,55 @@ class ClientGattConnectionLifeCycleCallback {
|
||||
virtual void onCharacteristicRead(ClientGattConnection* connection) = 0;
|
||||
};
|
||||
|
||||
class ServerGattConnectionLifeCycleCallback {
|
||||
public:
|
||||
virtual ~ServerGattConnectionLifeCycleCallback() {}
|
||||
virtual void OnCharacteristicSubscription(
|
||||
ServerGattConnection* connection,
|
||||
const GattCharacteristic& characteristic) = 0;
|
||||
virtual void OnCharacteristicUnsubscription(
|
||||
ServerGattConnection* connection,
|
||||
const GattCharacteristic& characteristic) = 0;
|
||||
// Callback for asynchronous events on the server side of a GATT connection.
|
||||
struct ServerGattConnectionCallback {
|
||||
// Called when a remote peripheral connected to us and subscribed to one of
|
||||
// our characteristics.
|
||||
std::function<void(const ServerGattConnection& connection,
|
||||
const GattCharacteristic& characteristic)>
|
||||
characteristic_subscription_cb;
|
||||
|
||||
// Called when a remote peripheral unsubscribed from one of our
|
||||
// characteristics.
|
||||
std::function<void(ServerGattConnection& connection,
|
||||
const GattCharacteristic& characteristic)>
|
||||
characteristic_unsubscription_cb;
|
||||
};
|
||||
|
||||
// https://developer.android.com/reference/android/bluetooth/BluetoothGattServer
|
||||
//
|
||||
// Representation of a BLE GATT server.
|
||||
class GattServer {
|
||||
public:
|
||||
virtual ~GattServer() {}
|
||||
virtual ~GattServer() = default;
|
||||
|
||||
// Creates a characteristic and adds it to the GATT server under the given
|
||||
// characteristic and service UUIDs. Returns no value upon error.
|
||||
//
|
||||
// Characteristics of the same service UUID should be put under one
|
||||
// service rather than many services with the same UUID.
|
||||
//
|
||||
// If the INDICATE property is included, the characteristic should include the
|
||||
// official Bluetooth Client Characteristic Configuration descriptor with UUID
|
||||
// 0x2902 and a WRITE permission. This allows remote clients to write to this
|
||||
// descriptor and subscribe for characteristic changes. For more information
|
||||
// about this descriptor, please go to:
|
||||
// https://www.bluetooth.com/specifications/Gatt/viewer?attributeXmlFile=org.bluetooth.descriptor.Gatt.client_characteristic_configuration.xml
|
||||
virtual std::unique_ptr<GattCharacteristic> CreateCharacteristic(
|
||||
absl::string_view service_uuid, absl::string_view characteristic_uuid,
|
||||
const std::set<GattCharacteristic::Permission>& permissions,
|
||||
const std::set<GattCharacteristic::Property>& properties) = 0;
|
||||
virtual bool UpdateCharacteristic(const GattCharacteristic& characteristic,
|
||||
const ByteArray& value) = 0;
|
||||
const std::vector<GattCharacteristic::Permission>& permissions,
|
||||
const std::vector<GattCharacteristic::Property>& properties) = 0;
|
||||
|
||||
// https://developer.android.com/reference/android/bluetooth/BluetoothGattCharacteristic.html#setValue(byte[])
|
||||
//
|
||||
// Locally updates the value of a characteristic and returns whether or not it
|
||||
// was successful.
|
||||
// TODO(b/213835576): Refactor GattCharacteristic as a POD struct type.
|
||||
virtual bool UpdateCharacteristic(
|
||||
const GattCharacteristic& characteristic,
|
||||
const location::nearby::ByteArray& value) = 0;
|
||||
|
||||
// Stops a GATT server.
|
||||
virtual void Stop() = 0;
|
||||
};
|
||||
|
||||
@@ -123,33 +162,53 @@ class BleSocket {
|
||||
public:
|
||||
virtual ~BleSocket() {}
|
||||
virtual api::BlePeripheral& GetRemotePeripheral() = 0;
|
||||
virtual Exception Write(const ByteArray& message) = 0;
|
||||
virtual Exception Close() = 0;
|
||||
virtual InputStream& GetInputStream() = 0;
|
||||
virtual OutputStream& GetOutputStream() = 0;
|
||||
virtual location::nearby::Exception Write(
|
||||
const location::nearby::ByteArray& message) = 0;
|
||||
virtual location::nearby::Exception Close() = 0;
|
||||
virtual location::nearby::InputStream& GetInputStream() = 0;
|
||||
virtual location::nearby::OutputStream& GetOutputStream() = 0;
|
||||
};
|
||||
|
||||
class BleSocketLifeCycleCallback {
|
||||
public:
|
||||
virtual ~BleSocketLifeCycleCallback() {}
|
||||
virtual void OnMessageReceived(BleSocket* socket,
|
||||
const ByteArray& message) = 0;
|
||||
virtual void OnMessageReceived(
|
||||
BleSocket* socket, const location::nearby::ByteArray& message) = 0;
|
||||
virtual void OnDisconnected(BleSocket* socket) = 0;
|
||||
};
|
||||
|
||||
class ServerBleSocketLifeCycleCallback : public BleSocketLifeCycleCallback {
|
||||
public:
|
||||
~ServerBleSocketLifeCycleCallback() override {}
|
||||
virtual void OnSocketEstablished(BleSocket* socket) = 0;
|
||||
virtual void OnSocketEstablished(BleSocket& socket) = 0;
|
||||
};
|
||||
|
||||
// The main BLE medium used inside of Nearby. This serves as the entry point for
|
||||
// all BLE and GATT related operations.
|
||||
class BleMedium {
|
||||
public:
|
||||
using Mtu = uint32_t;
|
||||
virtual ~BleMedium() {}
|
||||
virtual bool StartAdvertising(
|
||||
const BleAdvertisementData& advertisement_data) = 0;
|
||||
virtual void StopAdvertising(const std::string& service_id) = 0;
|
||||
|
||||
virtual ~BleMedium() = default;
|
||||
|
||||
// https://developer.android.com/reference/android/bluetooth/le/BluetoothLeAdvertiser.html#startAdvertising(android.bluetooth.le.AdvertiseSettings,%20android.bluetooth.le.AdvertiseData,%20android.bluetooth.le.AdvertiseData,%20android.bluetooth.le.AdvertiseCallback)
|
||||
//
|
||||
// Starts BLE advertising and returns whether or not it was successful.
|
||||
//
|
||||
// Power mode should be interpreted in the following way:
|
||||
// LOW:
|
||||
// - TX power = medium
|
||||
// HIGH:
|
||||
// - TX power = high
|
||||
virtual bool StartAdvertising(const BleAdvertisementData& advertising_data,
|
||||
const BleAdvertisementData& scan_response_data,
|
||||
PowerMode power_mode) = 0;
|
||||
|
||||
// https://developer.android.com/reference/android/bluetooth/le/BluetoothLeAdvertiser.html#stopAdvertising(android.bluetooth.le.AdvertiseCallback)
|
||||
//
|
||||
// Stops advertising.
|
||||
virtual bool StopAdvertising() = 0;
|
||||
|
||||
class ScanCallback {
|
||||
public:
|
||||
virtual ~ScanCallback() {}
|
||||
@@ -161,8 +220,13 @@ class BleMedium {
|
||||
PowerMode power_mode,
|
||||
const ScanCallback& scan_callback) = 0;
|
||||
virtual void StopScanning() = 0;
|
||||
|
||||
// https://developer.android.com/reference/android/bluetooth/BluetoothManager#openGattServer(android.content.Context,%20android.bluetooth.BluetoothGattServerCallback)
|
||||
//
|
||||
// Starts a GATT server. Returns a nullptr upon error.
|
||||
virtual std::unique_ptr<GattServer> StartGattServer(
|
||||
const ServerGattConnectionLifeCycleCallback& callback) = 0;
|
||||
ServerGattConnectionCallback callback) = 0;
|
||||
|
||||
virtual bool StartListeningForIncomingBleSockets(
|
||||
const ServerBleSocketLifeCycleCallback& callback) = 0;
|
||||
virtual void StopListeningForIncomingBleSockets() = 0;
|
||||
@@ -177,4 +241,5 @@ class BleMedium {
|
||||
} // namespace api
|
||||
} // namespace cal
|
||||
} // namespace nearby
|
||||
|
||||
#endif // CAL_API_BLE_H_
|
||||
|
||||
Reference in New Issue
Block a user