simpleble 0.0.1

data/vendor/simpleble/simpleble/include/simpleble/Adapter.h

@@ -0,0 +1,102 @@
+#pragma once
+
+#include <functional>
+#include <memory>
+#include <string>
+#include <vector>
+
+#include <simpleble/export.h>
+
+#include <simpleble/Exceptions.h>
+#include <simpleble/Peripheral.h>
+#include <simpleble/Types.h>
+
+namespace SimpleBLE {
+
+class AdapterBase;
+
+/**
+ * Bluetooth Adapter.
+ *
+ * A default-constructed Adapter object is not initialized. Calling any method
+ * other than `initialized()` on an uninitialized Adapter will throw an exception
+ * of type `SimpleBLE::NotInitialized`.
+ *
+ * NOTE: This class is intended to be used by the user only. Library developers
+ * should use shared pointers to `AdapterBase` instead.
+ */
+class SIMPLEBLE_EXPORT Adapter {
+  public:
+    Adapter() = default;
+    virtual ~Adapter() = default;
+
+    bool initialized() const;
+
+    /**
+     * Retrieve the underlying OS object/handle.
+     *
+     * For certain compatibility with external libraries, we sometimes need to
+     * expose the actual OS handle to the user. This is particularly important
+     * for MacOS right now.
+     */
+    void* underlying() const;
+
+    std::string identifier();
+    BluetoothAddress address();
+
+    /**
+     * Control the power state of the adapter.
+     *
+     * NOTE: The power on/off functionality is only supported on Windows and Linux (implementation pending).
+     *       On other platforms, this method will do nothing.
+     * NOTE: Callbacks are currently a placeholder for future implementation.
+     */
+    void power_on();
+    void power_off();
+    bool is_powered();
+    void set_callback_on_power_on(std::function<void()> on_power_on);
+    void set_callback_on_power_off(std::function<void()> on_power_off);
+
+    void scan_start();
+    void scan_stop();
+    void scan_for(int timeout_ms);
+    bool scan_is_active();
+    std::vector<Peripheral> scan_get_results();
+
+    void set_callback_on_scan_start(std::function<void()> on_scan_start);
+    void set_callback_on_scan_stop(std::function<void()> on_scan_stop);
+    void set_callback_on_scan_updated(std::function<void(Peripheral)> on_scan_updated);
+    void set_callback_on_scan_found(std::function<void(Peripheral)> on_scan_found);
+
+    /**
+     * Retrieve a list of all paired peripherals.
+     *
+     * NOTE:This method is currently only supported by the Linux, Windows and Android backends.
+     */
+    std::vector<Peripheral> get_paired_peripherals();
+
+    /**
+     * Retrieve a list of all connected peripherals.
+     *
+     * NOTE: This method is currently only supported by the Windows backend. (More backends coming soon.)
+     */
+    std::vector<Peripheral> get_connected_peripherals();
+
+    static bool bluetooth_enabled();
+
+    /**
+     * Fetches a list of all available adapters from all available backends.
+     *
+     * This will cause backends to be instantiated/initialized and adapters
+     * too.
+     */
+    static std::vector<Adapter> get_adapters();
+
+  protected:
+    AdapterBase* operator->();
+    const AdapterBase* operator->() const;
+
+    std::shared_ptr<AdapterBase> internal_;
+};
+
+}  // namespace SimpleBLE

data/vendor/simpleble/simpleble/include/simpleble/AdapterSafe.h

@@ -0,0 +1,58 @@
+#pragma once
+
+#include <simpleble/export.h>
+
+#include <simpleble/Adapter.h>
+#include <simpleble/PeripheralSafe.h>
+#include <memory>
+#include <optional>
+#include <vector>
+
+namespace SimpleBLE {
+
+namespace Safe {
+
+/**
+ * Wrapper around the Adapter class that provides a noexcept interface.
+ *
+ * We use instances of this class directly and not through shared_ptr because
+ * this is just a wrapper around the Adapter class, which is already managed by
+ * shared_ptr.
+ */
+class SIMPLEBLE_EXPORT Adapter {
+  public:
+    Adapter(SimpleBLE::Adapter& adapter);
+    Adapter(SimpleBLE::Adapter&& adapter);
+    virtual ~Adapter() = default;
+
+    std::optional<std::string> identifier() noexcept;
+    std::optional<BluetoothAddress> address() noexcept;
+
+    bool scan_start() noexcept;
+    bool scan_stop() noexcept;
+    bool scan_for(int timeout_ms) noexcept;
+    std::optional<bool> scan_is_active() noexcept;
+    std::optional<std::vector<SimpleBLE::Safe::Peripheral>> scan_get_results() noexcept;
+
+    bool set_callback_on_scan_start(std::function<void()> on_scan_start) noexcept;
+    bool set_callback_on_scan_stop(std::function<void()> on_scan_stop) noexcept;
+    bool set_callback_on_scan_updated(std::function<void(SimpleBLE::Safe::Peripheral)> on_scan_updated) noexcept;
+    bool set_callback_on_scan_found(std::function<void(SimpleBLE::Safe::Peripheral)> on_scan_found) noexcept;
+
+    std::optional<std::vector<SimpleBLE::Safe::Peripheral>> get_paired_peripherals() noexcept;
+
+    static std::optional<bool> bluetooth_enabled() noexcept;
+    static std::optional<std::vector<SimpleBLE::Safe::Adapter>> get_adapters() noexcept;
+
+    /**
+     * Cast to the underlying adapter object.
+     */
+    operator SimpleBLE::Adapter() const noexcept;
+
+  protected:
+    SimpleBLE::Adapter internal_;
+};
+
+}  // namespace Safe
+
+}  // namespace SimpleBLE

data/vendor/simpleble/simpleble/include/simpleble/Characteristic.h

@@ -0,0 +1,39 @@
+#pragma once
+
+#include <memory>
+
+#include <simpleble/export.h>
+
+#include <simpleble/Descriptor.h>
+#include <simpleble/Exceptions.h>
+#include <simpleble/Types.h>
+
+namespace SimpleBLE {
+
+class CharacteristicBase;
+
+class SIMPLEBLE_EXPORT Characteristic {
+  public:
+    Characteristic() = default;
+    virtual ~Characteristic() = default;
+
+    bool initialized() const;
+
+    BluetoothUUID uuid();
+    std::vector<Descriptor> descriptors();
+    std::vector<std::string> capabilities();
+
+    bool can_read();
+    bool can_write_request();
+    bool can_write_command();
+    bool can_notify();
+    bool can_indicate();
+
+  protected:
+    CharacteristicBase* operator->();
+    const CharacteristicBase* operator->() const;
+
+    std::shared_ptr<CharacteristicBase> internal_;
+};
+
+}  // namespace SimpleBLE

data/vendor/simpleble/simpleble/include/simpleble/Config.h

@@ -0,0 +1,55 @@
+#pragma once
+#include <chrono>
+
+namespace SimpleBLE {
+namespace Config {
+    namespace SimpleBluez {
+        inline static std::chrono::steady_clock::duration connection_timeout = std::chrono::seconds(2);
+        inline static std::chrono::steady_clock::duration disconnection_timeout = std::chrono::seconds(1);
+
+        static void reset() {
+            connection_timeout = std::chrono::seconds(2);
+            disconnection_timeout = std::chrono::seconds(1);
+        }
+    }
+
+    namespace WinRT {
+        inline static bool experimental_use_own_mta_apartment = true;
+        inline static bool experimental_reinitialize_winrt_apartment_on_main_thread = false;
+
+        static void reset() {
+            experimental_use_own_mta_apartment = true;
+            experimental_reinitialize_winrt_apartment_on_main_thread = false;
+        }
+    }
+
+    namespace CoreBluetooth {
+        static void reset() {}
+    }
+
+    namespace Android {
+        enum class ConnectionPriorityRequest {
+            DISABLED = -1,
+            BALANCED = 0,
+            HIGH = 1,
+            LOW_POWER = 2,
+            DCK = 3
+        };
+
+        inline static ConnectionPriorityRequest connection_priority_request = ConnectionPriorityRequest::DISABLED;
+
+        static void reset() {
+            connection_priority_request = ConnectionPriorityRequest::DISABLED;
+        }
+    }
+
+    namespace Base {
+        static void reset_all() {
+            SimpleBluez::reset();
+            WinRT::reset();
+            CoreBluetooth::reset();
+            Android::reset();
+        }
+    }
+}  // namespace Config
+}  // namespace SimpleBLE

data/vendor/simpleble/simpleble/include/simpleble/Descriptor.h

@@ -0,0 +1,30 @@
+#pragma once
+
+#include <memory>
+
+#include <simpleble/export.h>
+
+#include <simpleble/Exceptions.h>
+#include <simpleble/Types.h>
+
+namespace SimpleBLE {
+
+class DescriptorBase;
+
+class SIMPLEBLE_EXPORT Descriptor {
+  public:
+    Descriptor() = default;
+    virtual ~Descriptor() = default;
+
+    bool initialized() const;
+
+    BluetoothUUID uuid();
+
+  protected:
+    DescriptorBase* operator->();
+    const DescriptorBase* operator->() const;
+
+    std::shared_ptr<DescriptorBase> internal_;
+};
+
+}  // namespace SimpleBLE

data/vendor/simpleble/simpleble/include/simpleble/Exceptions.h

@@ -0,0 +1,72 @@
+#pragma once
+
+#include <stdexcept>
+#include <string>
+
+#include <simpleble/export.h>
+
+#include "Types.h"
+
+namespace SimpleBLE {
+
+namespace Exception {
+
+class SIMPLEBLE_EXPORT BaseException : public std::runtime_error {
+  public:
+    BaseException(const std::string& __arg) : std::runtime_error(__arg) {}
+};
+
+class SIMPLEBLE_EXPORT NotInitialized : public BaseException {
+  public:
+    NotInitialized();
+};
+
+class SIMPLEBLE_EXPORT NotConnected : public BaseException {
+  public:
+    NotConnected();
+};
+
+class SIMPLEBLE_EXPORT InvalidReference : public BaseException {
+  public:
+    InvalidReference();
+};
+
+class SIMPLEBLE_EXPORT ServiceNotFound : public BaseException {
+  public:
+    ServiceNotFound(BluetoothUUID uuid);
+};
+
+class SIMPLEBLE_EXPORT CharacteristicNotFound : public BaseException {
+  public:
+    CharacteristicNotFound(BluetoothUUID uuid);
+};
+
+class SIMPLEBLE_EXPORT DescriptorNotFound : public BaseException {
+  public:
+    DescriptorNotFound(BluetoothUUID uuid);
+};
+
+class SIMPLEBLE_EXPORT OperationNotSupported : public BaseException {
+  public:
+    OperationNotSupported();
+};
+
+class SIMPLEBLE_EXPORT OperationFailed : public BaseException {
+  public:
+    OperationFailed();
+    OperationFailed(const std::string& err_msg);
+};
+
+class SIMPLEBLE_EXPORT WinRTException : public BaseException {
+  public:
+    WinRTException(int32_t err_code, const std::string& err_msg);
+};
+
+class SIMPLEBLE_EXPORT CoreBluetoothException : public BaseException {
+  public:
+    CoreBluetoothException(const std::string& err_msg);
+};
+
+}  // namespace Exception
+
+}  // namespace SimpleBLE

data/vendor/simpleble/simpleble/include/simpleble/Logging.h

@@ -0,0 +1,73 @@
+#pragma once
+
+#include <cstdint>
+#include <functional>
+#include <mutex>
+#include <string>
+
+#include <simpleble/export.h>
+
+namespace SimpleBLE {
+
+namespace Logging {
+
+enum Level : int {
+    None = 0,
+    Fatal,
+    Error,
+    Warn,
+    Info,
+    Debug,
+    Verbose,
+};
+
+// clang-format off
+using Callback = std::function<void(
+    Level,
+    const std::string& module,
+    const std::string& file,
+    uint32_t line,
+    const std::string& function,
+    const std::string& message)>;
+// clang-format on
+
+class SIMPLEBLE_EXPORT Logger {
+  public:
+    static Logger* get();
+
+    void set_level(Level level);
+    Level get_level();
+
+    void set_callback(Callback callback);
+    bool has_callback();
+
+    void log_default_stdout();
+    void log_default_file();
+    void log_default_file(const std::string path);
+
+    // clang-format off
+    void log(
+        Level level,
+        const std::string& module,
+        const std::string& file,
+        uint32_t line,
+        const std::string& function,
+        const std::string& message);
+    // clang-format on
+
+  private:
+    Logger();
+    ~Logger();
+    Logger(Logger& other) = delete;          // Remove copy constructor
+    void operator=(const Logger&) = delete;  // Remove copy assignment
+
+    static std::string level_to_str(Level level);
+
+    Level level_{Level::Info};
+    Callback callback_{nullptr};
+    std::recursive_mutex mutex_;
+};
+
+}  // namespace Logging
+
+}  // namespace SimpleBLE

data/vendor/simpleble/simpleble/include/simpleble/Peripheral.h

@@ -0,0 +1,82 @@
+#pragma once
+
+#include <cstdint>
+#include <functional>
+#include <map>
+#include <memory>
+#include <string>
+#include <vector>
+
+#include <simpleble/export.h>
+
+#include <simpleble/Exceptions.h>
+#include <simpleble/Service.h>
+#include <simpleble/Types.h>
+
+namespace SimpleBLE {
+
+class PeripheralBase;
+
+class SIMPLEBLE_EXPORT Peripheral {
+  public:
+    Peripheral() = default;
+    virtual ~Peripheral() = default;
+
+    bool initialized() const;
+    void* underlying() const;
+
+    std::string identifier();
+    BluetoothAddress address();
+    BluetoothAddressType address_type();
+    int16_t rssi();
+
+    /**
+     * @brief Provides the advertised transmit power in dBm.
+     *
+     * @note If the field has not been advertised by the peripheral,
+     *       the returned value will be -32768.
+     */
+    int16_t tx_power();
+    uint16_t mtu();
+
+    void connect();
+    void disconnect();
+    bool is_connected();
+    bool is_connectable();
+    bool is_paired();
+    void unpair();
+
+    /**
+     * @brief Provides a list of all services that are available on the peripheral.
+     *
+     * @note If the peripheral is not connected, it will return a list of services
+     *       that were advertised by the device.
+     */
+    std::vector<Service> services();
+    std::map<uint16_t, ByteArray> manufacturer_data();
+
+    /* Calling any of the methods below when the device is not connected will throw
+       Exception::NotConnected */
+    // clang-format off
+    ByteArray read(BluetoothUUID const& service, BluetoothUUID const& characteristic);
+    void write_request(BluetoothUUID const& service, BluetoothUUID const& characteristic, ByteArray const& data);
+    void write_command(BluetoothUUID const& service, BluetoothUUID const& characteristic, ByteArray const& data);
+    void notify(BluetoothUUID const& service, BluetoothUUID const& characteristic, std::function<void(ByteArray payload)> callback);
+    void indicate(BluetoothUUID const& service, BluetoothUUID const& characteristic, std::function<void(ByteArray payload)> callback);
+    void unsubscribe(BluetoothUUID const& service, BluetoothUUID const& characteristic);
+
+    ByteArray read(BluetoothUUID const& service, BluetoothUUID const& characteristic, BluetoothUUID const& descriptor);
+    void write(BluetoothUUID const& service, BluetoothUUID const& characteristic, BluetoothUUID const& descriptor, ByteArray const& data);
+    // clang-format on
+
+    void set_callback_on_connected(std::function<void()> on_connected);
+    void set_callback_on_disconnected(std::function<void()> on_disconnected);
+
+  protected:
+    PeripheralBase* operator->();
+    const PeripheralBase* operator->() const;
+
+    std::shared_ptr<PeripheralBase> internal_;
+};
+
+}  // namespace SimpleBLE

data/vendor/simpleble/simpleble/include/simpleble/PeripheralSafe.h

@@ -0,0 +1,64 @@
+#pragma once
+
+#include <memory>
+#include <optional>
+
+#include <simpleble/export.h>
+
+#include <simpleble/Peripheral.h>
+#include <simpleble/Service.h>
+
+namespace SimpleBLE {
+
+namespace Safe {
+
+class SIMPLEBLE_EXPORT Peripheral {
+  public:
+    Peripheral(SimpleBLE::Peripheral& peripheral);
+    Peripheral(SimpleBLE::Peripheral&& peripheral);
+    virtual ~Peripheral() = default;
+
+    std::optional<std::string> identifier() noexcept;
+    std::optional<BluetoothAddress> address() noexcept;
+    std::optional<BluetoothAddressType> address_type() noexcept;
+    std::optional<int16_t> rssi() noexcept;
+    std::optional<int16_t> tx_power() noexcept;
+    std::optional<uint16_t> mtu() noexcept;
+
+    bool connect() noexcept;
+    bool disconnect() noexcept;
+    std::optional<bool> is_connected() noexcept;
+    std::optional<bool> is_connectable() noexcept;
+    std::optional<bool> is_paired() noexcept;
+    bool unpair() noexcept;
+
+    std::optional<std::vector<Service>> services() noexcept;
+    std::optional<std::map<uint16_t, ByteArray>> manufacturer_data() noexcept;
+
+    // clang-format off
+    std::optional<ByteArray> read(BluetoothUUID const& service, BluetoothUUID const& characteristic) noexcept;
+    bool write_request(BluetoothUUID const& service, BluetoothUUID const& characteristic, ByteArray const& data) noexcept;
+    bool write_command(BluetoothUUID const& service, BluetoothUUID const& characteristic, ByteArray const& data) noexcept;
+    bool notify(BluetoothUUID const& service, BluetoothUUID const& characteristic, std::function<void(ByteArray payload)> callback) noexcept;
+    bool indicate(BluetoothUUID const& service, BluetoothUUID const& characteristic, std::function<void(ByteArray payload)> callback) noexcept;
+    bool unsubscribe(BluetoothUUID const& service, BluetoothUUID const& characteristic) noexcept;
+
+    std::optional<ByteArray> read(BluetoothUUID const& service, BluetoothUUID const& characteristic, BluetoothUUID const& descriptor) noexcept;
+    bool write(BluetoothUUID const& service, BluetoothUUID const& characteristic, BluetoothUUID const& descriptor, ByteArray const& data) noexcept;
+    // clang-format on
+
+    bool set_callback_on_connected(std::function<void()> on_connected) noexcept;
+    bool set_callback_on_disconnected(std::function<void()> on_disconnected) noexcept;
+
+    /**
+     * Get the underlying peripheral object.
+     */
+    operator SimpleBLE::Peripheral() const noexcept;
+
+  protected:
+    SimpleBLE::Peripheral internal_;
+};
+
+}  // namespace Safe
+
+}  // namespace SimpleBLE

data/vendor/simpleble/simpleble/include/simpleble/Service.h

@@ -0,0 +1,34 @@
+#pragma once
+
+#include <memory>
+#include <vector>
+
+#include <simpleble/export.h>
+
+#include <simpleble/Exceptions.h>
+#include <simpleble/Types.h>
+#include "simpleble/Characteristic.h"
+
+namespace SimpleBLE {
+
+class ServiceBase;
+
+class SIMPLEBLE_EXPORT Service {
+  public:
+    Service() = default;
+    virtual ~Service() = default;
+
+    bool initialized() const;
+
+    BluetoothUUID uuid();
+    ByteArray data();
+    std::vector<Characteristic> characteristics();
+
+  protected:
+    const ServiceBase* operator->() const;
+    ServiceBase* operator->();
+
+    std::shared_ptr<ServiceBase> internal_;
+};
+
+}  // namespace SimpleBLE

data/vendor/simpleble/simpleble/include/simpleble/SimpleBLE.h

@@ -0,0 +1,8 @@
+#pragma once
+
+#include <simpleble/Config.h>
+#include <simpleble/Adapter.h>
+#include <simpleble/AdapterSafe.h>
+#include <simpleble/Peripheral.h>
+#include <simpleble/PeripheralSafe.h>
+#include <simpleble/Utils.h>

data/vendor/simpleble/simpleble/include/simpleble/Types.h

@@ -0,0 +1,49 @@
+#pragma once
+
+#include <cstdint>
+#include <string>
+#include <vector>
+#include "kvn/kvn_bytearray.h"
+
+/**
+ * @file Types.h
+ * @brief Defines types and enumerations used throughout the SimpleBLE library.
+ */
+
+namespace SimpleBLE {
+
+using BluetoothAddress = std::string;
+
+// IDEA: Extend BluetoothUUID to include a `uuid` function that
+// returns the same string, but provides a homogeneous interface.
+using BluetoothUUID = std::string;
+
+/**
+ * @typedef ByteArray
+ * @brief Represents a byte array using kvn::bytearray from the external library.
+ */
+using ByteArray = kvn::bytearray;
+
+#ifdef ANDROID
+#pragma push_macro("ANDROID")
+#undef ANDROID
+#define ANDROID_WAS_DEFINED
+#endif
+
+enum class OperatingSystem {
+    WINDOWS,
+    MACOS,
+    IOS,
+    LINUX,
+    ANDROID,
+};
+
+#ifdef ANDROID_WAS_DEFINED
+#pragma pop_macro("ANDROID")
+#undef ANDROID_WAS_DEFINED
+#endif
+
+// TODO: Add to_string functions for all enums.
+enum BluetoothAddressType : int32_t { PUBLIC = 0, RANDOM = 1, UNSPECIFIED = 2 };
+
+}  // namespace SimpleBLE

data/vendor/simpleble/simpleble/include/simpleble/Utils.h

@@ -0,0 +1,13 @@
+#pragma once
+
+#include <simpleble/export.h>
+
+#include <simpleble/Types.h>
+
+namespace SimpleBLE {
+
+OperatingSystem SIMPLEBLE_EXPORT get_operating_system();
+
+std::string SIMPLEBLE_EXPORT get_simpleble_version();
+
+}  // namespace SimpleBLE