Pre-implemented Services, reusable UI components and unit testing setup

.github/workflows/build-and-test.yml

@@ -28,6 +28,7 @@ jobs:
     uses: StanfordSpezi/.github/.github/workflows/xcodebuild-or-fastlane.yml@v2
     with:
       runsonlabels: '["macOS", "self-hosted"]'
+      setupSimulators: true
       path: 'Tests/UITests'
       scheme: TestApp
       artifactname: TestApp.xcresult

.spi.yml

@@ -11,4 +11,6 @@ builder:
   configs:
     - platform: ios
       documentation_targets:
+      - BluetoothServices
       - SpeziBluetooth
+      - XCTBluetooth

Package.swift

@@ -15,14 +15,20 @@ let package = Package(
     name: "SpeziBluetooth",
     defaultLocalization: "en",
     platforms: [
-        .iOS(.v17)
+        .iOS(.v17),
+        .macCatalyst(.v17),
+        .macOS(.v14)
     ],
     products: [
+        .library(name: "BluetoothServices", targets: ["BluetoothServices"]),
+        .library(name: "BluetoothViews", targets: ["BluetoothViews"]),
         .library(name: "SpeziBluetooth", targets: ["SpeziBluetooth"]),
         .library(name: "XCTBluetooth", targets: ["XCTBluetooth"])
     ],
     dependencies: [
+        .package(url: "https://github.com/StanfordSpezi/SpeziFoundation", from: "1.0.0"),
         .package(url: "https://github.com/StanfordSpezi/Spezi", from: "1.0.0"),
+        .package(url: "https://github.com/StanfordSpezi/SpeziViews", from: "1.1.1"),
         .package(url: "https://github.com/apple/swift-nio.git", from: "2.59.0"),
         .package(url: "https://github.com/apple/swift-collections.git", from: "1.0.4")
     ],
@@ -33,21 +39,46 @@ let package = Package(
                 .product(name: "Spezi", package: "Spezi"),
                 .product(name: "NIO", package: "swift-nio"),
                 .product(name: "NIOFoundationCompat", package: "swift-nio"),
-                .product(name: "OrderedCollections", package: "swift-collections")
+                .product(name: "OrderedCollections", package: "swift-collections"),
+                // We have an issue in Xcode projects when importing XCTBluetooth in a test target that it fails
+                // to link with SpeziFoundation. lol. :)
+                .product(name: "SpeziFoundation", package: "SpeziFoundation")
             ],
             resources: [
                 .process("Resources")
             ]
         ),
         .target(
-            name: "XCTBluetooth",
+            name: "BluetoothServices",
             dependencies: [
                 .target(name: "SpeziBluetooth")
             ]
         ),
+        .target(
+            name: "BluetoothViews",
+            dependencies: [
+                .target(name: "SpeziBluetooth"),
+                .product(name: "SpeziViews", package: "SpeziViews")
+            ]
+        ),
+        .target(
+            name: "XCTBluetooth",
+            dependencies: [
+                .target(name: "SpeziBluetooth"),
+                .product(name: "NIO", package: "swift-nio")
+            ]
+        ),
+        .executableTarget(
+            name: "TestPeripheral",
+            dependencies: [
+                .target(name: "SpeziBluetooth"),
+                .target(name: "BluetoothServices")
+            ]
+        ),
         .testTarget(
             name: "SpeziBluetoothTests",
             dependencies: [
+                .target(name: "BluetoothServices"),
                 .target(name: "SpeziBluetooth"),
                 .target(name: "XCTBluetooth"),
                 .product(name: "NIO", package: "swift-nio")

README.md

@@ -105,8 +105,7 @@ class MyDevice: BluetoothDevice {
     @DeviceState(\.state)
     var state: PeripheralState
 
-    @Service(id: "180A")
-    var deviceInformation = DeviceInformationService()
+    @Service var deviceInformation = DeviceInformationService()
 
     @DeviceAction(\.connect)
     var connect
@@ -130,7 +129,7 @@ class ExampleDelegate: SpeziAppDelegate {
         Configuration {
             Bluetooth {
                 // Define which devices type to discover by what criteria .
-                // In this case we search for some custom FFF0 characteristic that is advertised.
+                // In this case we search for some custom FFF0 service that is advertised.
                 Discover(MyDevice.self, by: .advertisedService("FFF0"))
             }
         }

Sources/BluetoothServices/BluetoothServices.docc/BluetoothServices.md

@@ -0,0 +1,27 @@
+# ``BluetoothServices``
+
+Reusable Bluetooth Service implementations.
+
+<!--
+#
+# This source file is part of the Stanford Spezi open source project
+#
+# SPDX-FileCopyrightText: 2024 Stanford University and the project authors (see CONTRIBUTORS.md)
+#
+# SPDX-License-Identifier: MIT
+#
+-->
+
+## Overview
+
+This target provides reusable Bluetooth service implementations of standardized Bluetooth services.
+
+## Topics
+
+### Core Services
+
+- ``DeviceInformationService``
+
+### Health Domain
+
+- ``HealthThermometerService``

Sources/BluetoothServices/Characteristics/DateTime.swift

@@ -0,0 +1,138 @@
+//
+// This source file is part of the Stanford Spezi open-source project
+//
+// SPDX-FileCopyrightText: 2024 Stanford University and the project authors (see CONTRIBUTORS.md)
+//
+// SPDX-License-Identifier: MIT
+//
+
+import NIO
+import SpeziBluetooth
+
+
+/// Date Time characteristic to represent date and time.
+///
+/// Refer to GATT Specification Supplement, 3.70 Date Time
+public struct DateTime {
+    public enum Month: UInt8 {
+        /// Unknown month.
+        case unknown
+        /// The month January.
+        case january
+        /// The month February.
+        case february
+        /// The month March.
+        case march
+        /// The month April.
+        case april
+        /// The month Mai.
+        case mai
+        /// The month June.
+        case june
+        /// The month July.
+        case july
+        /// The month August.
+        case august
+        /// The month September.
+        case september
+        /// The month October.
+        case october
+        /// The month November.
+        case november
+        /// The month December.
+        case december
+    }
+
+    /// Year as defined by the Gregorian calendar.
+    ///
+    /// Valid range 1582 to 9999.
+    /// A value of 0 means that the year is not known. All other values are Reserved for Future Use.
+    public let year: UInt16
+    /// Month of the year as defined by the Gregorian calendar.
+    ///
+    /// Valid range 1 (January) to 12 (December).
+    /// A value of 0 means that the month is not known.
+    public let month: Month
+    /// Day of the month as defined by the Gregorian calendar.
+    ///
+    /// Valid range 1 to 31.
+    /// A value of 0 means that the day of month is not known.
+    public let day: UInt8
+    /// Number of hours past midnight.
+    ///
+    /// Valid range 0 to 23.
+    public let hours: UInt8
+    /// Number of minutes since the start of the hour.
+    ///
+    /// Valid range 0 to 59.
+    public let minutes: UInt8
+    /// Number of seconds since the start of the minute.
+    ///
+    /// Valid range 0 to 59.
+    public let seconds: UInt8
+
+
+    /// Create a new Date Time.
+    /// - Parameters:
+    ///   - year: The year.
+    ///   - month: The month.
+    ///   - day: The day.
+    ///   - hours: The hours.
+    ///   - minutes: The minutes.
+    ///   - seconds: The seconds.
+    public init(year: UInt16 = 0, month: Month = .unknown, day: UInt8 = 0, hours: UInt8, minutes: UInt8, seconds: UInt8) {
+        // swiftlint:disable:previous function_default_parameter_at_end
+        self.year = year
+        self.month = month
+        self.day = day
+        self.hours = hours
+        self.minutes = minutes
+        self.seconds = seconds
+    }
+}
+
+
+extension DateTime.Month: Equatable {}
+
+
+extension DateTime: Equatable {}
+
+
+extension DateTime.Month: ByteCodable {
+    public init?(from byteBuffer: inout ByteBuffer) {
+        guard let value = UInt8(from: &byteBuffer) else {
+            return nil
+        }
+
+        self.init(rawValue: value)
+    }
+
+    public func encode(to byteBuffer: inout ByteBuffer) {
+        rawValue.encode(to: &byteBuffer)
+    }
+}
+
+
+extension DateTime: ByteCodable {
+    public init?(from byteBuffer: inout ByteBuffer) {
+        guard let year = UInt16(from: &byteBuffer),
+              let month = Month(from: &byteBuffer),
+              let day = UInt8(from: &byteBuffer),
+              let hours = UInt8(from: &byteBuffer),
+              let minutes = UInt8(from: &byteBuffer),
+              let seconds = UInt8(from: &byteBuffer) else {
+            return nil
+        }
+
+        self.init(year: year, month: month, day: day, hours: hours, minutes: minutes, seconds: seconds)
+    }
+
+    public func encode(to byteBuffer: inout ByteBuffer) {
+        year.encode(to: &byteBuffer)
+        month.encode(to: &byteBuffer)
+        day.encode(to: &byteBuffer)
+        hours.encode(to: &byteBuffer)
+        minutes.encode(to: &byteBuffer)
+        seconds.encode(to: &byteBuffer)
+    }
+}

Sources/BluetoothServices/Characteristics/MeasurementInterval.swift

@@ -0,0 +1,58 @@
+//
+// This source file is part of the Stanford Spezi open-source project
+//
+// SPDX-FileCopyrightText: 2024 Stanford University and the project authors (see CONTRIBUTORS.md)
+//
+// SPDX-License-Identifier: MIT
+//
+
+import NIO
+import SpeziBluetooth
+
+
+/// Represents the time between measurements.
+public enum MeasurementInterval {
+    /// No periodic measurement
+    case noPeriodicMeasurement
+    /// Duration of measurement interval.
+    case duration(_ seconds: UInt16)
+}
+
+
+extension MeasurementInterval: Equatable {}
+
+
+extension MeasurementInterval: RawRepresentable {
+    public var rawValue: UInt16 {
+        switch self {
+        case .noPeriodicMeasurement:
+            0
+        case let .duration(seconds):
+            seconds
+        }
+    }
+
+    public init(rawValue: UInt16) {
+        switch rawValue {
+        case 0:
+            self = .noPeriodicMeasurement
+        default:
+            self = .duration(rawValue)
+        }
+    }
+}
+
+
+extension MeasurementInterval: ByteCodable {
+    public init?(from byteBuffer: inout ByteBuffer) {
+        guard let value = UInt16(from: &byteBuffer) else {
+            return nil
+        }
+
+        self.init(rawValue: value)
+    }
+
+    public func encode(to byteBuffer: inout ByteBuffer) {
+        rawValue.encode(to: &byteBuffer)
+    }
+}