Release 1.2.3

Author: davidcairns

Example/ButterflyImagingKitExample.xcodeproj/project.pbxproj

@@ -311,7 +311,7 @@
 					"$(inherited)",
 					"@executable_path/Frameworks",
 				);
-				MARKETING_VERSION = 1.2.2;
+				MARKETING_VERSION = 1.2.3;
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				SUPPORTED_PLATFORMS = "iphoneos iphonesimulator";
 				SUPPORTS_MACCATALYST = NO;
@@ -344,7 +344,7 @@
 					"$(inherited)",
 					"@executable_path/Frameworks",
 				);
-				MARKETING_VERSION = 1.2.2;
+				MARKETING_VERSION = 1.2.3;
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				SUPPORTED_PLATFORMS = "iphoneos iphonesimulator";
 				SUPPORTS_MACCATALYST = NO;
@@ -384,7 +384,7 @@
 			repositoryURL = "https://github.com/ButterflyNetwork/ImagingSDK-iOS";
 			requirement = {
 				kind = exactVersion;
-				version = 1.2.2;
+				version = 1.2.3;
 			};
 		};
 /* End XCRemoteSwiftPackageReference section */

Example/ButterflyImagingKitExample/ButterflyImagingKitExampleApp.swift

@@ -1,4 +1,4 @@
-/// Copyright 2012-2024 (C) Butterfly Network, Inc.
+/// Copyright 2012-2025 (C) Butterfly Network, Inc.
 
 import SwiftUI
 

Example/ButterflyImagingKitExample/ContentView.swift

@@ -1,4 +1,4 @@
-/// Copyright 2012-2024 (C) Butterfly Network, Inc.
+/// Copyright 2012-2025 (C) Butterfly Network, Inc.
 
 import ButterflyImagingKit
 import SwiftUI
@@ -32,8 +32,7 @@ struct ContentView: View {
                                 await model.connectSimulatedProbe()
                             }
                         }
-                    } else if model.probe?.state == .ready,
-                              !model.availablePresets.isEmpty {
+                    } else if !model.availablePresets.isEmpty {
                         if model.probe?.isSimulated == true {
                             Button("Disconnect simulated probe") {
                                 Task {
@@ -190,8 +189,15 @@ struct ContentView: View {
                 availablePresets = state.availablePresets
             }
 
-            Task { try? await imaging.startup(clientKey: clientKey) }
+            Task { try? await model.startup(clientKey: clientKey) }
         }
+        .alert(
+            "Error",
+            isPresented: $model.showingAlert,
+            presenting: model.alertError,
+            actions: { _ in Button("OK", role: .cancel) { model.clearError() } },
+            message: { detail in Text("Error: \(String(describing: detail))") }
+        )
     }
 }
 

Example/ButterflyImagingKitExample/Helpers.swift

@@ -1,4 +1,4 @@
-/// Copyright 2012-2024 (C) Butterfly Network, Inc.
+/// Copyright 2012-2025 (C) Butterfly Network, Inc.
 
 import ButterflyImagingKit
 import Foundation

Example/ButterflyImagingKitExample/Model.swift

@@ -1,4 +1,4 @@
-/// Copyright 2012-2024 (C) Butterfly Network, Inc.
+/// Copyright 2012-2025 (C) Butterfly Network, Inc.
 
 import ButterflyImagingKit
 import UIKit
@@ -23,6 +23,9 @@ class Model: ObservableObject {
     @Published var updating = false
     @Published var updateProgress: TimedProgress?
 
+    @Published var alertError: Error? { didSet { showingAlert = (alertError != nil) } }
+    @Published var showingAlert: Bool = false
+
     private let imaging = ButterflyImaging.shared
 
     static var shared: Model = Model()
@@ -67,9 +70,14 @@ class Model: ObservableObject {
                 stage = .ready
             }
         case .startingImaging:
+            // If we have an image then we are “imaging”.
             if image != nil {
                 stage = .imaging
             }
+            // If the user disconnects the probe while we are starting imaging, revert.
+            if state.probe.state == .disconnected {
+                stopImaging()
+            }
         case .imaging:
             if state.probe.state == .disconnected {
                 stopImaging()
@@ -86,12 +94,21 @@ class Model: ObservableObject {
         var parameters: PresetParameters? = nil
 
         // Send custom initial depth if it represents a change from the default one.
-        if let preset,
-           let depth,
-           preset.defaultDepth.converted(to: .centimeters).value != depth {
+        if
+            let preset,
+            let depth,
+            preset.defaultDepth.converted(to: .centimeters).value != depth
+        {
             parameters = PresetParameters(depth: .centimeters(depth))
         }
-        Task { try? await imaging.startImaging(preset: preset, parameters: parameters) }
+        Task {
+            do {
+                try await imaging.startImaging(preset: preset, parameters: parameters)
+            } catch {
+                alertError = error
+                print("Failed to startImaging, with error: \(error)")
+            }
+        }
     }
 
     func connectSimulatedProbe() async {
@@ -106,6 +123,15 @@ class Model: ObservableObject {
         inProgress = false
     }
 
+    func startup(clientKey: String) async throws {
+        do {
+            try await imaging.startup(clientKey: clientKey)
+        } catch {
+            alertError = error
+            print("Failed to start up backend, with error: \(error)")
+        }
+    }
+
     func stopImaging() {
         stage = .ready
         imaging.stopImaging()
@@ -127,4 +153,8 @@ class Model: ObservableObject {
         }
         updating = false
     }
+
+    func clearError() {
+        alertError = nil
+    }
 }

Example/ButterflyImagingKitExample/QuickStartView.swift

@@ -1,4 +1,4 @@
-/// Copyright 2012-2024 (C) Butterfly Network, Inc.
+/// Copyright 2012-2025 (C) Butterfly Network, Inc.
 
 import ButterflyImagingKit
 import SwiftUI

Package.swift

@@ -2,9 +2,9 @@
 
 import PackageDescription
 
-// Release: https://github.com/ButterflyNetwork/ButterflySDKIOS/releases/tag/1.2.2
-let binaryUrl = "https://sdk.butterflynetwork.com/garden/ButterflyImagingKit/1.2.2/ButterflyImagingKit.xcframework.zip"
-let binaryChecksum = "9726bddcd5566173961bde4e180dae7ac6e32b9fa73bca781cf331a6e53eebd5"
+// Release: https://github.com/ButterflyNetwork/ButterflySDKIOS/releases/tag/1.2.3
+let binaryUrl = "https://sdk.butterflynetwork.com/garden/ButterflyImagingKit/1.2.3/ButterflyImagingKit.xcframework.zip"
+let binaryChecksum = "aafa340a3224a9c0c8af3ff040ac9d6d1792bde11b2cc9095a26e62deba9edef"
 
 let package = Package(
     name: "Butterfly",

README.md

@@ -19,7 +19,7 @@ The SDK consists of a few key objects:
 
 ## Requirements
 
-* Built and tested using Xcode 15.0.1 and macOS Sonoma 14.5.
+* Built and tested using Xcode 16.0 and macOS Sonoma 14.6.
 * Available for iOS 16.0 or newer.
 * Apps developed using the SDK should only be installed on [Butterfly supported devices](https://support.butterflynetwork.com/hc/en-us/sections/360004521832-Mobile-Devices).
 * Not compatible with beta software.
@@ -122,4 +122,4 @@ And you should be good to go!
 
 ## License
 
-Copyright 2012-2024 (C) Butterfly Network, Inc.
+Copyright 2012-2025 (C) Butterfly Network, Inc.