EEG Device Pairing

.github/workflows/beta-deployment.yml

@@ -29,3 +29,4 @@ jobs:
       runsonlabels: '["macOS-13"]'
       fastlanelane: beta
       setupsigning: true
+      checkout_submodules: true

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

@@ -20,13 +20,6 @@ jobs:
   swiftlint:
     name: SwiftLint
     uses: StanfordBDHG/.github/.github/workflows/swiftlint.yml@v2
-  codeql:
-    name: CodeQL
-    uses: StanfordBDHG/.github/.github/workflows/xcodebuild-or-fastlane.yml@v2
-    with:
-      codeql: true
-      xcodeversion: '14.3.1'
-      fastlanelane: codeql
   buildandtest:
     name: Build and Test
     uses: StanfordBDHG/.github/.github/workflows/xcodebuild-or-fastlane.yml@v2
@@ -35,8 +28,6 @@ jobs:
       runsonlabels: '["macOS", "self-hosted"]'
       setupfirebaseemulator: true
       customcommand: "firebase emulators:exec 'fastlane test'"
-    secrets:
-      checkout_token: ${{ secrets.MUSE_PATH }}
   uploadcoveragereport:
     name: Upload Coverage Report
     needs: buildandtest

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "Muse.framework"]
+	path = Muse.framework
+	url = [email protected]:StanfordBDHG/MuseSDK.git

.gitmodules.license

@@ -0,0 +1,5 @@
+This source file is part of the Neurodevelopment Assessment and Monitoring System (NAMS) project
+
+SPDX-FileCopyrightText: 2023 Stanford University and the project authors (see CONTRIBUTORS.md)
+
+SPDX-License-Identifier: MIT

NAMS.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -225,6 +225,15 @@
         "version" : "0.4.2"
       }
     },
+    {
+      "identity" : "swift-collections",
+      "kind" : "remoteSourceControl",
+      "location" : "https://github.com/apple/swift-collections.git",
+      "state" : {
+        "revision" : "a902f1823a7ff3c9ab2fba0f992396b948eda307",
+        "version" : "1.0.5"
+      }
+    },
     {
       "identity" : "swift-protobuf",
       "kind" : "remoteSourceControl",

NAMS.xcodeproj/xcshareddata/xcschemes/NAMS Muse.xcscheme

@@ -0,0 +1,66 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Scheme
+   version = "1.7">
+   <BuildAction
+      parallelizeBuildables = "YES"
+      buildImplicitDependencies = "YES">
+      <BuildActionEntries>
+         <BuildActionEntry
+            buildForTesting = "YES"
+            buildForRunning = "YES"
+            buildForProfiling = "YES"
+            buildForArchiving = "YES"
+            buildForAnalyzing = "YES">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "A926D7642AB7A552000C4C2F"
+               BuildableName = "NAMS Muse.app"
+               BlueprintName = "NAMS Muse"
+               ReferencedContainer = "container:NAMS.xcodeproj">
+            </BuildableReference>
+         </BuildActionEntry>
+      </BuildActionEntries>
+   </BuildAction>
+   <TestAction
+      buildConfiguration = "Test"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      shouldAutocreateTestPlan = "YES">
+   </TestAction>
+   <LaunchAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      launchStyle = "0"
+      useCustomWorkingDirectory = "NO"
+      ignoresPersistentStateOnLaunch = "NO"
+      debugDocumentVersioning = "YES"
+      debugServiceExtension = "internal"
+      allowLocationSimulation = "YES">
+      <BuildableProductRunnable
+         runnableDebuggingMode = "0">
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "A926D7642AB7A552000C4C2F"
+            BuildableName = "NAMS Muse.app"
+            BlueprintName = "NAMS Muse"
+            ReferencedContainer = "container:NAMS.xcodeproj">
+         </BuildableReference>
+      </BuildableProductRunnable>
+   </LaunchAction>
+   <ProfileAction
+      buildConfiguration = "Release"
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      savedToolIdentifier = ""
+      useCustomWorkingDirectory = "NO"
+      debugDocumentVersioning = "YES">
+   </ProfileAction>
+   <AnalyzeAction
+      buildConfiguration = "Debug">
+   </AnalyzeAction>
+   <ArchiveAction
+      buildConfiguration = "Release"
+      revealArchiveInOrganizer = "YES">
+   </ArchiveAction>
+</Scheme>

NAMS.xcodeproj/xcshareddata/xcschemes/NAMS Muse.xcscheme.license

@@ -0,0 +1,6 @@
+
+This source file is part of the Stanford Spezi Template Application project
+
+SPDX-FileCopyrightText: 2023 Stanford University
+
+SPDX-License-Identifier: MIT

NAMS.xcodeproj/xcshareddata/xcschemes/NAMS.xcscheme

@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1500"
    version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"
@@ -33,28 +32,6 @@
             default = "YES">
          </TestPlanReference>
       </TestPlans>
-      <Testables>
-         <TestableReference
-            skipped = "NO">
-            <BuildableReference
-               BuildableIdentifier = "primary"
-               BlueprintIdentifier = "653A255C28338800005D4D48"
-               BuildableName = "NAMSTests.xctest"
-               BlueprintName = "NAMSTests"
-               ReferencedContainer = "container:NAMS.xcodeproj">
-            </BuildableReference>
-         </TestableReference>
-         <TestableReference
-            skipped = "NO">
-            <BuildableReference
-               BuildableIdentifier = "primary"
-               BlueprintIdentifier = "653A256628338800005D4D48"
-               BuildableName = "NAMSUITests.xctest"
-               BlueprintName = "NAMSUITests"
-               ReferencedContainer = "container:NAMS.xcodeproj">
-            </BuildableReference>
-         </TestableReference>
-      </Testables>
    </TestAction>
    <LaunchAction
       buildConfiguration = "Debug"
@@ -76,28 +53,6 @@
             ReferencedContainer = "container:NAMS.xcodeproj">
          </BuildableReference>
       </BuildableProductRunnable>
-      <CommandLineArguments>
-         <CommandLineArgument
-            argument = "--disableFirebase"
-            isEnabled = "NO">
-         </CommandLineArgument>
-         <CommandLineArgument
-            argument = "--testSchedule"
-            isEnabled = "NO">
-         </CommandLineArgument>
-         <CommandLineArgument
-            argument = "--showOnboarding"
-            isEnabled = "NO">
-         </CommandLineArgument>
-         <CommandLineArgument
-            argument = "--skipOnboarding"
-            isEnabled = "NO">
-         </CommandLineArgument>
-         <CommandLineArgument
-            argument = "--useFirebaseEmulator"
-            isEnabled = "NO">
-         </CommandLineArgument>
-      </CommandLineArguments>
       <LocationScenarioReference
          identifier = "com.apple.dt.IDEFoundation.CurrentLocationScenarioIdentifier"
          referenceType = "1">
@@ -109,16 +64,15 @@
       savedToolIdentifier = ""
       useCustomWorkingDirectory = "NO"
       debugDocumentVersioning = "YES">
-      <BuildableProductRunnable
-         runnableDebuggingMode = "0">
+      <MacroExpansion>
          <BuildableReference
             BuildableIdentifier = "primary"
             BlueprintIdentifier = "653A254C283387FE005D4D48"
             BuildableName = "NAMS.app"
             BlueprintName = "NAMS"
             ReferencedContainer = "container:NAMS.xcodeproj">
          </BuildableReference>
-      </BuildableProductRunnable>
+      </MacroExpansion>
    </ProfileAction>
    <AnalyzeAction
       buildConfiguration = "Debug">

NAMS/Bluetooth/BluetoothManager.swift

@@ -0,0 +1,36 @@
+//
+// This source file is part of the Stanford Spezi open-source project
+//
+// SPDX-FileCopyrightText: 2023 Stanford University and the project authors (see CONTRIBUTORS.md)
+//
+// SPDX-License-Identifier: MIT
+//
+
+import CoreBluetooth
+
+
+class BluetoothManager: NSObject, ObservableObject, CBCentralManagerDelegate {
+    private let bluetoothManager: CBCentralManager
+    private let dispatchQueue: DispatchQueue
+
+    @Published private(set) var bluetoothState: CBManagerState
+
+    override init() {
+        // We use a separate dispatch queue, be aware that all delegate calls are not getting on the main thread.
+        // So make sure to interact with @Published properties only via the main thread
+        self.dispatchQueue = DispatchQueue(label: "CBCentralManager")
+        self.bluetoothManager = CBCentralManager(delegate: nil, queue: dispatchQueue)
+        self.bluetoothState = bluetoothManager.state
+
+        super.init()
+
+        // CBCentralManager declares the delegate as weak
+        self.bluetoothManager.delegate = self // cannot use self before super.init()
+    }
+
+    func centralManagerDidUpdateState(_ central: CBCentralManager) {
+        Task { @MainActor in
+            self.bluetoothState = central.state
+        }
+    }
+}

NAMS/EEG/EEGChannelMark.swift

@@ -0,0 +1,43 @@
+//
+// This source file is part of the Stanford Spezi open-source project
+//
+// SPDX-FileCopyrightText: 2023 Stanford University and the project authors (see CONTRIBUTORS.md)
+//
+// SPDX-License-Identifier: MIT
+//
+
+import Charts
+import SwiftUI
+
+
+struct EEGChannelMark: ChartContent {
+    private let time: TimeInterval
+    private let reading: EEGReading
+
+    var body: some ChartContent {
+        LineMark(
+            x: .value("Seconds", time),
+            y: .value("Micro-Volt", reading.value)
+        )
+            .lineStyle(StrokeStyle(lineWidth: 2.0))
+            .foregroundStyle(by: .value("Channel", reading.channel.rawValue))
+    }
+
+
+    init(time: TimeInterval, reading: EEGReading) {
+        self.time = time
+        self.reading = reading
+    }
+}
+
+
+#if DEBUG
+struct EEGChannelMark_Previews: PreviewProvider {
+    static let randomSamples = EEGMeasurementGenerator(sampleRate: 60)
+
+    static var previews: some View {
+        let generated = randomSamples.generateRecording(sampleTime: 5, recordingOffset: 10)
+        EEGChart(measurements: generated.data.suffix(from: 0), for: .af7, baseTime: generated.baseTime)
+    }
+}
+#endif

NAMS/EEG/EEGChart.swift

@@ -0,0 +1,93 @@
+//
+// This source file is part of the Stanford Spezi open-source project
+//
+// SPDX-FileCopyrightText: 2023 Stanford University and the project authors (see CONTRIBUTORS.md)
+//
+// SPDX-License-Identifier: MIT
+//
+
+import Charts
+import SwiftUI
+
+
+struct EEGChart: View {
+    private let measurements: ArraySlice<EEGSeries>
+    private let channel: EEGChannel
+    /// The base time interval since 1970.
+    private let baseTime: TimeInterval?
+
+    private var lowerScale: TimeInterval {
+        if let first = measurements.first,
+           let baseTime {
+            return max(0, first.timestamp.timeIntervalSince1970 - baseTime)
+        }
+        return 0
+    }
+
+    private var upperScale: TimeInterval {
+        if let last = measurements.last,
+           let baseTime {
+            return max(1, last.timestamp.timeIntervalSince1970 - baseTime)
+        }
+        return 1
+    }
+
+    var body: some View {
+        Chart(measurements) { series in
+            // base time exists if there is at least one measurement
+            let baseTime = baseTime ?? 0
+
+            EEGChannelMark(time: max(0.0, series.timestamp.timeIntervalSince1970 - baseTime), reading: series.reading(for: channel))
+        }
+            .chartXScale(domain: lowerScale...upperScale)
+            .chartXAxis {
+                AxisMarks(values: .automatic(desiredCount: 12)) { value in
+                    if let doubleValue = value.as(Double.self),
+                       let intValue = value.as(Int.self) {
+                        if doubleValue - Double(intValue) == 0 {
+                            AxisTick(stroke: .init(lineWidth: 1))
+                                .foregroundStyle(.gray)
+                            AxisValueLabel {
+                                Text("\(intValue)s")
+                            }
+                            AxisGridLine(stroke: .init(lineWidth: 1))
+                                .foregroundStyle(.gray)
+                        } else {
+                            AxisGridLine(stroke: .init(lineWidth: 1))
+                                .foregroundStyle(.gray.opacity(0.25))
+                        }
+                    }
+                }
+            }
+            .chartYAxis {
+                AxisMarks(values: .automatic(desiredCount: 14)) { _ in
+                    AxisGridLine(stroke: .init(lineWidth: 1))
+                        .foregroundStyle(.gray.opacity(0.25))
+                }
+            }
+            .chartPlotStyle {
+                $0.border(Color.gray)
+            }
+            .frame(height: 200)
+    }
+
+
+    init(measurements: ArraySlice<EEGSeries>, for channel: EEGChannel, baseTime: TimeInterval?) {
+        self.measurements = measurements
+        self.channel = channel
+        self.baseTime = baseTime
+    }
+}
+
+
+#if DEBUG
+struct EEGChart_Previews: PreviewProvider {
+    static let randomSamples = EEGMeasurementGenerator(sampleRate: 60)
+
+    static var previews: some View {
+        let generated = randomSamples.generateRecording(sampleTime: 5, recordingOffset: 10)
+        EEGChart(measurements: generated.data.suffix(from: 0), for: .af7, baseTime: generated.baseTime)
+        EEGChart(measurements: generated.data.suffix(from: 0), for: .af8, baseTime: generated.baseTime)
+    }
+}
+#endif