SpeziDevices

https://github.com/stanfordspezi/spezidevices
Admin
SpeziDevices is a Swift package that provides support for interactions with Bluetooth devices,...
Tokens:2,795
Snippets:45
Trust Score:9.8
License:MIT
Update:5 months ago
Show doc for...
Tokens:
Raw
### Implement PairableDevice Protocol

Source: https://github.com/stanfordspezi/spezidevices/blob/main/Sources/SpeziDevices/SpeziDevices.docc/SpeziDevices.md

Adopt the `PairableDevice` protocol for your custom device to enable pairing. Register the device with the `PairedDevices` module using `configure(device:accessing:_:_:)`.

```swift
import SpeziDevices

class MyDevice: PairableDevice {
    @DeviceState(\.id) var id
    @DeviceState(\.name) var name
    @DeviceState(\.state) var state
    @DeviceState(\.advertisementData) var advertisementData
    @DeviceState(\.nearby) var nearby

    @Service var deviceInformation = DeviceInformationService()

    @DeviceAction(\.connect) var connect
    @DeviceAction(\.disconnect) var disconnect

    var isInPairingMode: Bool {
        // determine if a nearby device is in pairing mode
    }

    @Dependency private var pairedDevices: PairedDevices?

    required init() {}

    func configure() {
        pairedDevices?.configure(device: self, accessing: $state, $advertisementData, $nearby)
    }

    func handleSuccessfulPairing() { // called on events where a device can be considered paired (e.g., incoming notifications)
        pairedDevices?.signalDevicePaired(self)
    }
}
```

--------------------------------

### Display Paired Devices with DevicesView

Source: https://github.com/stanfordspezi/spezidevices/blob/main/Sources/SpeziDevicesUI/SpeziDevicesUI.docc/SpeziDevicesUI.md

Use `DevicesView` to display paired devices in a grid layout and initiate device discovery. This view requires an `appName` and can include custom content for pairing instructions.

```swift
struct MyHomeView: View {
    var body: some View {
        TabView {
            NavigationStack {
                DevicesView(appName: "Example") {
                    Text("Provide helpful pairing instructions to the user.")
                }
            }
                .tabItem {
                    Label("Devices", systemImage: "sensor.fill")
                }
        }
    }
}
```

--------------------------------

### Implement HealthDevice Protocol

Source: https://github.com/stanfordspezi/spezidevices/blob/main/Sources/SpeziDevices/SpeziDevices.docc/SpeziDevices.md

Adopt the `HealthDevice` protocol for your custom device to collect health measurements. Register the device's measurement service with the `HealthMeasurements` module using `configureReceivingMeasurements(for:on:)`.

```swift
import SpeziDevices

class MyDevice: HealthDevice {
    @Service var deviceInformation = DeviceInformationService()
    @Service var weightScale = WeightScaleService()

    @Dependency private var measurements: HealthMeasurements?

    required init() {}

    func configure() {
        measurements?.configureReceivingMeasurements(for: self, on: weightScale)
    }
}
```

--------------------------------

### Display and Manage Measurements

Source: https://github.com/stanfordspezi/spezidevices/blob/main/Sources/SpeziDevices/SpeziDevices.docc/SpeziDevices.md

Use `MeasurementsRecordedSheet` to display new measurements to the user and handle saving them to your external data store. This view is presented when `shouldPresentMeasurements` is true.

```swift
import SpeziDevices
import SpeziDevicesUI

struct MyHomeView: View {
    @Environment(HealthMeasurements.self) private var measurements

    var body: some View {
        @Bindable var measurements = measurements
        ContentView()
            .sheet(isPresented: $measurements.shouldPresentMeasurements) {
                MeasurementsRecordedSheet { measurement in
                    // handle saving the measurement
                }
            }
    }
}
```

--------------------------------

### Configure Omron Devices in Bluetooth Module

Source: https://github.com/stanfordspezi/spezidevices/blob/main/Sources/SpeziOmron/SpeziOmron.docc/SpeziOmron.md

Configure the Bluetooth module to discover Omron blood pressure cuffs and weight scales by their advertised services. Ensure PairedDevices and HealthMeasurements modules are configured if needed.

```swift
import SpeziBluetooth
import SpeziBluetoothServices
import SpeziDevices
import SpeziOmron

class ExampleAppDelegate: SpeziAppDelegate {
    override var configuration: Configuration {
        Configuration {
            Bluetooth {
                Discover(OmronBloodPressureCuff.self, by: .advertisedService(BloodPressureService.self))
                Discover(OmronWeightScale.self, by: .advertisedService(WeightScaleService.self))
            }

            // If required, configure the PairedDevices and HealthMeasurements modules
            PairedDevices()
            HealthMeasurements()
        }
    }
}
```

--------------------------------

### Display Pending Measurements with MeasurementsRecordedSheet

Source: https://github.com/stanfordspezi/spezidevices/blob/main/Sources/SpeziDevicesUI/SpeziDevicesUI.docc/SpeziDevicesUI.md

Present pending measurements using `MeasurementsRecordedSheet`. This view is typically presented modally and requires access to the `HealthMeasurements` environment object. Ensure `HealthMeasurements` is configured in your `SpeziAppDelegate`.

```swift
struct MyHomeView: View {
    @Environment(HealthMeasurements.self) private var measurements

    var body: some View {
        @Bindable var measurements = measurements
        ContentView()
            .sheet(isPresented: $measurements.shouldPresentMeasurements) {
                MeasurementsRecordedSheet { samples in
                    // save the array of HKSamples
                }
            }
    }
}
```
Tokens:
Raw