Merge pull request #230 from NordicSemiconductor/transporter

API Change: 'transporter' is now 'transport'
NordicSemiconductor · Jul 3, 2024 · 8af99db · 8af99db
2 parents f6ea8fa + d4c8d56
commit 8af99db
Show file tree

Hide file tree

Showing 29 changed files with 105 additions and 101 deletions.
diff --git a/Example/Example/View Controllers/Manager/BaseViewController.swift b/Example/Example/View Controllers/Manager/BaseViewController.swift
@@ -41,13 +41,13 @@ final class BaseViewController: UITabBarController {
         }
     }
 
-    var transporter: McuMgrTransport!
+    var transport: McuMgrTransport!
     var peripheral: DiscoveredPeripheral! {
         didSet {
-            let bleTransporter = McuMgrBleTransport(peripheral.basePeripheral)
-            bleTransporter.logDelegate = UIApplication.shared.delegate as? McuMgrLogDelegate
-            bleTransporter.delegate = self
-            transporter = bleTransporter
+            let bleTransport = McuMgrBleTransport(peripheral.basePeripheral)
+            bleTransport.logDelegate = UIApplication.shared.delegate as? McuMgrLogDelegate
+            bleTransport.delegate = self
+            transport = bleTransport
         }
     }
 
@@ -91,7 +91,7 @@ final class BaseViewController: UITabBarController {
     }
 
     override func viewWillDisappear(_ animated: Bool) {
-        transporter?.close()
+        transport?.close()
     }
 }
 
@@ -103,7 +103,7 @@ extension BaseViewController: PeripheralDelegate {
         self.state = state
 
         if state == .connected {
-            let defaultManager = DefaultManager(transporter: transporter)
+            let defaultManager = DefaultManager(transport: transport)
             defaultManager.logDelegate = UIApplication.shared.delegate as? McuMgrLogDelegate
             defaultManager.params { [weak self] response, error in
                 if let count = response?.bufferCount,

diff --git a/Example/Example/View Controllers/Manager/DeviceController.swift b/Example/Example/View Controllers/Manager/DeviceController.swift
@@ -54,8 +54,8 @@ class DeviceController: UITableViewController, UITextFieldDelegate {
         messageReceivedBackground.image = receivedBackground
 
         let baseController = parent as! BaseViewController
-        let transporter = baseController.transporter!
-        defaultManager = DefaultManager(transporter: transporter)
+        let transport: McuMgrTransport! = baseController.transport
+        defaultManager = DefaultManager(transport: transport)
         defaultManager.logDelegate = UIApplication.shared.delegate as? McuMgrLogDelegate
     }
 
@@ -104,7 +104,7 @@ class DeviceController: UITableViewController, UITextFieldDelegate {
                 } catch McuManagerError.mtuValueHasNotChanged {
                     // If MTU value did not change, try reassembly.
                     if let messageText = self?.messageSent.text,
-                       let bleTransport = self?.defaultManager.transporter as? McuMgrBleTransport,
+                       let bleTransport = self?.defaultManager.transport as? McuMgrBleTransport,
                        !bleTransport.chunkSendDataToMtuSize {
                         bleTransport.chunkSendDataToMtuSize = true
                         self?.send(message: messageText)

diff --git a/Example/Example/View Controllers/Manager/FileDownloadViewController.swift b/Example/Example/View Controllers/Manager/FileDownloadViewController.swift
@@ -46,9 +46,9 @@ class FileDownloadViewController: UIViewController, McuMgrViewController {
         }
     }
 
-    var transporter: McuMgrTransport! {
+    var transport: McuMgrTransport! {
         didSet {
-            fsManager = FileSystemManager(transporter: transporter)
+            fsManager = FileSystemManager(transport: transport)
             fsManager.logDelegate = UIApplication.shared.delegate as? McuMgrLogDelegate
         }
     }

diff --git a/Example/Example/View Controllers/Manager/FileUploadViewController.swift b/Example/Example/View Controllers/Manager/FileUploadViewController.swift
@@ -57,9 +57,9 @@ class FileUploadViewController: UIViewController, McuMgrViewController {
         fsManager.cancelTransfer()
     }
 
-    var transporter: McuMgrTransport! {
+    var transport: McuMgrTransport! {
         didSet {
-            fsManager = FileSystemManager(transporter: transporter)
+            fsManager = FileSystemManager(transport: transport)
             fsManager.logDelegate = UIApplication.shared.delegate as? McuMgrLogDelegate
         }
     }

diff --git a/Example/Example/View Controllers/Manager/FilesController.swift b/Example/Example/View Controllers/Manager/FilesController.swift
@@ -35,10 +35,10 @@ class FilesController: UITableViewController {
 
     override func prepare(for segue: UIStoryboardSegue, sender: Any?) {
         let baseController = parent as! BaseViewController
-        let transporter = baseController.transporter!
+        let transport = baseController.transport!
 
         var destination = segue.destination as? McuMgrViewController
-        destination?.transporter = transporter
+        destination?.transport = transport
     }
 
     override func tableView(_ tableView: UITableView, heightForRowAt indexPath: IndexPath) -> CGFloat {

diff --git a/Example/Example/View Controllers/Manager/FirmwareUpgradeViewController.swift b/Example/Example/View Controllers/Manager/FirmwareUpgradeViewController.swift
@@ -92,9 +92,9 @@ final class FirmwareUpgradeViewController: UIViewController, McuMgrViewControlle
 
     private var package: McuMgrPackage?
     private var dfuManager: FirmwareUpgradeManager!
-    var transporter: McuMgrTransport! {
+    var transport: McuMgrTransport! {
         didSet {
-            dfuManager = FirmwareUpgradeManager(transporter: transporter, delegate: self)
+            dfuManager = FirmwareUpgradeManager(transport: transport, delegate: self)
             dfuManager.logDelegate = UIApplication.shared.delegate as? McuMgrLogDelegate
         }
     }

diff --git a/Example/Example/View Controllers/Manager/FirmwareUploadViewController.swift b/Example/Example/View Controllers/Manager/FirmwareUploadViewController.swift
@@ -132,9 +132,9 @@ class FirmwareUploadViewController: UIViewController, McuMgrViewController {
     private var package: McuMgrPackage?
     private var envelope: McuMgrSuitEnvelope?
     private var imageManager: ImageManager!
-    var transporter: McuMgrTransport! {
+    var transport: McuMgrTransport! {
         didSet {
-            imageManager = ImageManager(transporter: transporter)
+            imageManager = ImageManager(transport: transport)
             imageManager.logDelegate = UIApplication.shared.delegate as? McuMgrLogDelegate
         }
     }

diff --git a/Example/Example/View Controllers/Manager/ImageController.swift b/Example/Example/View Controllers/Manager/ImageController.swift
@@ -30,10 +30,10 @@ class ImageController: UITableViewController {
 
     override func prepare(for segue: UIStoryboardSegue, sender: Any?) {
         let baseController = parent as! BaseViewController
-        let transporter = baseController.transporter!
+        let transport: McuMgrTransport! = baseController.transport
 
         var destination = segue.destination as? McuMgrViewController
-        destination?.transporter = transporter
+        destination?.transport = transport
     }
 
     override func tableView(_ tableView: UITableView, heightForRowAt indexPath: IndexPath) -> CGFloat {

diff --git a/Example/Example/View Controllers/Manager/LogsStatsController.swift b/Example/Example/View Controllers/Manager/LogsStatsController.swift
@@ -68,8 +68,8 @@ class LogsStatsController: UITableViewController {
 
     override func viewDidLoad() {
         let baseController = parent as! BaseViewController
-        let transporter = baseController.transporter!
-        statsManager = StatsManager(transporter: transporter)
+        let transport = baseController.transport!
+        statsManager = StatsManager(transport: transport)
         statsManager.logDelegate = UIApplication.shared.delegate as? McuMgrLogDelegate
     }
 

diff --git a/Example/Example/View Controllers/Manager/ResetViewController.swift b/Example/Example/View Controllers/Manager/ResetViewController.swift
@@ -19,9 +19,9 @@ class ResetViewController: UIViewController, McuMgrViewController {
     }
 
     private var defaultManager: DefaultManager!
-    var transporter: McuMgrTransport! {
+    var transport: McuMgrTransport! {
         didSet {
-            defaultManager = DefaultManager(transporter: transporter)
+            defaultManager = DefaultManager(transport: transport)
             defaultManager.logDelegate = UIApplication.shared.delegate as? McuMgrLogDelegate
         }
     }

diff --git a/Example/Example/View Controllers/Manager/SettingsViewController.swift b/Example/Example/View Controllers/Manager/SettingsViewController.swift
@@ -20,9 +20,9 @@ class SettingsViewController: UIViewController, McuMgrViewController {
     }
 
     private var basicManager: BasicManager!
-    var transporter: McuMgrTransport! {
+    var transport: McuMgrTransport! {
         didSet {
-            basicManager = BasicManager(transporter: transporter)
+            basicManager = BasicManager(transport: transport)
             basicManager.logDelegate = UIApplication.shared.delegate as? McuMgrLogDelegate
         }
     }

diff --git a/Example/Example/View Controllers/Manager/Widgets/ImagesViewController.swift b/Example/Example/View Controllers/Manager/Widgets/ImagesViewController.swift
@@ -57,11 +57,11 @@ class ImagesViewController: UIViewController , McuMgrViewController{
     private var lastResponse: McuMgrImageStateResponse?
     private var imageManager: ImageManager!
     private var defaultManager: DefaultManager!
-    var transporter: McuMgrTransport! {
+    var transport: McuMgrTransport! {
         didSet {
-            imageManager = ImageManager(transporter: transporter)
+            imageManager = ImageManager(transport: transport)
             imageManager.logDelegate = UIApplication.shared.delegate as? McuMgrLogDelegate
-            defaultManager = DefaultManager(transporter: transporter)
+            defaultManager = DefaultManager(transport: transport)
             defaultManager.logDelegate = UIApplication.shared.delegate as? McuMgrLogDelegate
         }
     }

diff --git a/Example/Example/View Controllers/Manager/Widgets/McuMgrViewController.swift b/Example/Example/View Controllers/Manager/Widgets/McuMgrViewController.swift
@@ -9,5 +9,5 @@ import iOSMcuManagerLibrary
 
 protocol McuMgrViewController {
 
-    var transporter: McuMgrTransport! { get set }
+    var transport: McuMgrTransport! { get set }
 }
diff --git a/README.md b/README.md
@@ -116,7 +116,7 @@ A `FirmwareUpgradeManager` provides an easy way to perform firmware upgrades on
 import iOSMcuManagerLibrary
 
 do {
-    // Initialize the BLE transporter using a scanned peripheral
+    // Initialize the BLE transport using a scanned peripheral
     let bleTransport = McuMgrBleTransport(cbPeripheral)
 
     // Initialize the FirmwareUpgradeManager using the transport and a delegate
@@ -224,7 +224,7 @@ Now, the issue is that there's a gap between the aforementioned API, and the out
 import iOSMcuManagerLibrary
 
 do {
-    // Initialize the BLE transporter using a scanned peripheral
+    // Initialize the BLE transport using a scanned peripheral
     let bleTransport = McuMgrBleTransport(cbPeripheral)
 
     // Initialize the FirmwareUpgradeManager using the transport and a delegate
@@ -252,7 +252,7 @@ SUIT, or [Software Update for the Internet of Things](https://datatracker.ietf.o
 import iOSMcuManagerLibrary
 
 do {
-    // Initialize the BLE transporter using a scanned peripheral
+    // Initialize the BLE transport using a scanned peripheral
     let bleTransport = McuMgrBleTransport(cbPeripheral)
 
     // Initialize the FirmwareUpgradeManager using the transport and a delegate
@@ -346,9 +346,9 @@ Setting `logDelegate` property in a manager gives access to low level logs, that
 ```swift
 import iOSMcuManagerLibrary
 
-// Initialize the BLE transporter using a scanned peripheral
+// Initialize the BLE transport using a scanned peripheral
 let bleTransport = McuMgrBleTransport(cbPeripheral)
-bleTransporter.logDelegate = UIApplication.shared.delegate as? McuMgrLogDelegate
+bleTransport.logDelegate = UIApplication.shared.delegate as? McuMgrLogDelegate
 
 // Initialize the DeviceManager using the transport and a delegate
 let deviceManager = DeviceManager(bleTransport, delegate)

diff --git a/Source/Managers/BasicManager.swift b/Source/Managers/BasicManager.swift
@@ -25,8 +25,8 @@ public class BasicManager: McuManager {
 
     // MARK: - Init
 
-    public init(transporter: McuMgrTransport) {
-        super.init(group: .basic, transporter: transporter)
+    public init(transport: McuMgrTransport) {
+        super.init(group: .basic, transport: transport)
     }
 
     // MARK: - Commands

diff --git a/Source/Managers/CrashManager.swift b/Source/Managers/CrashManager.swift
@@ -30,8 +30,8 @@ public class CrashManager: McuManager {
     // MARK: Initializers
     //**************************************************************************
 
-    public init(transporter: McuMgrTransport) {
-        super.init(group: McuMgrGroup.crash, transporter: transporter)
+    public init(transport: McuMgrTransport) {
+        super.init(group: McuMgrGroup.crash, transport: transport)
     }
 
     //**************************************************************************

diff --git a/Source/Managers/DFU/FirmwareUpgradeManager.swift b/Source/Managers/DFU/FirmwareUpgradeManager.swift
@@ -66,12 +66,12 @@ public class FirmwareUpgradeManager: FirmwareUpgradeController, ConnectionObserv
 
     // MARK: Init
 
-    public init(transporter: McuMgrTransport, delegate: FirmwareUpgradeDelegate?) {
-        self.imageManager = ImageManager(transporter: transporter)
-        self.defaultManager = DefaultManager(transporter: transporter)
-        self.basicManager = BasicManager(transporter: transporter)
-        self.suitManager = SuitManager(transporter: transporter)
-        self.suitManifestManager = SuitManifestManager(transporter: transporter)
+    public init(transport: McuMgrTransport, delegate: FirmwareUpgradeDelegate?) {
+        self.imageManager = ImageManager(transport: transport)
+        self.defaultManager = DefaultManager(transport: transport)
+        self.basicManager = BasicManager(transport: transport)
+        self.suitManager = SuitManager(transport: transport)
+        self.suitManifestManager = SuitManifestManager(transport: transport)
         self.delegate = delegate
         self.state = .none
         self.paused = false
@@ -307,7 +307,7 @@ public class FirmwareUpgradeManager: FirmwareUpgradeController, ConnectionObserv
         objc_sync_setState(.reset)
         if !paused {
             log(msg: "Sending Reset command...", atLevel: .verbose)
-            defaultManager.transporter.addObserver(self)
+            defaultManager.transport.addObserver(self)
             defaultManager.reset(callback: resetCallback)
         }
     }
@@ -639,7 +639,7 @@ public class FirmwareUpgradeManager: FirmwareUpgradeController, ConnectionObserv
                     log(msg: "Image \(image.image) (slot \(secondary.slot)) is already pending", atLevel: .warning)
                     log(msg: "Resetting the device...", atLevel: .verbose)
                     // reset() can't be called here, as it changes the state to RESET.
-                    defaultManager.transporter.addObserver(self)
+                    defaultManager.transport.addObserver(self)
                     defaultManager.reset(callback: self.resetCallback)
                     // The validate() method will be called again.
                     return
@@ -954,7 +954,7 @@ public class FirmwareUpgradeManager: FirmwareUpgradeController, ConnectionObserv
 
     /// Reconnect to the device and continue the
     private func reconnect() {
-        imageManager.transporter.connect { [weak self] result in
+        imageManager.transport.connect { [weak self] result in
             guard let self = self else {
                 return
             }

diff --git a/Source/Managers/DFU/SuitManifestManager.swift b/Source/Managers/DFU/SuitManifestManager.swift
@@ -22,8 +22,8 @@ public class SuitManifestManager {
 
     // MARK: Init
 
-    public init(transporter: McuMgrTransport) {
-        self.suitManager = SuitManager(transporter: transporter)
+    public init(transport: McuMgrTransport) {
+        self.suitManager = SuitManager(transport: transport)
         self.roles = []
         self.responses = []
     }

diff --git a/Source/Managers/DefaultManager.swift b/Source/Managers/DefaultManager.swift
@@ -46,8 +46,8 @@ public class DefaultManager: McuManager {
     // MARK: Initializers
     //**************************************************************************
 
-    public init(transporter: McuMgrTransport) {
-        super.init(group: McuMgrGroup.OS, transporter: transporter)
+    public init(transport: McuMgrTransport) {
+        super.init(group: McuMgrGroup.OS, transport: transport)
     }
 
     // MARK: - Commands
@@ -63,8 +63,9 @@ public class DefaultManager: McuManager {
     public func echo(_ echo: String, callback: @escaping McuMgrCallback<McuMgrEchoResponse>) {
         let payload: [String:CBOR] = ["d": CBOR.utf8String(echo)]
 
-        let echoPacket = McuManager.buildPacket(scheme: transporter.getScheme(), version: .SMPv2,
-                                                op: .write, flags: 0, group: McuMgrGroup.OS.rawValue,
+        let echoPacket = McuManager.buildPacket(scheme: transport.getScheme(),
+                                                version: .SMPv2, op: .write,
+                                                flags: 0, group: McuMgrGroup.OS.rawValue,
                                                 sequenceNumber: 0, commandId: ID.echo, payload: payload)
 
         guard echoPacket.count <= BasicManager.MAX_ECHO_MESSAGE_SIZE_BYTES else {

diff --git a/Source/Managers/FileSystemManager.swift b/Source/Managers/FileSystemManager.swift
@@ -25,8 +25,8 @@ public class FileSystemManager: McuManager {
 
     // MARK: Init
 
-    public init(transporter: McuMgrTransport) {
-        super.init(group: McuMgrGroup.filesystem, transporter: transporter)
+    public init(transport: McuMgrTransport) {
+        super.init(group: McuMgrGroup.filesystem, transport: transport)
     }
 
     // MARK: Download
@@ -170,7 +170,7 @@ public class FileSystemManager: McuManager {
         // can't predict how many bytes the firmware will accept in each chunk.
         uploadConfiguration = configuration
         uploadConfiguration.reassemblyBufferSize = min(uploadConfiguration.reassemblyBufferSize, UInt64(UInt16.max))
-        if let bleTransport = transporter as? McuMgrBleTransport {
+        if let bleTransport = transport as? McuMgrBleTransport {
             bleTransport.numberOfParallelWrites = configuration.pipelineDepth
             bleTransport.chunkSendDataToMtuSize = configuration.reassemblyBufferSize != 0
         }
@@ -568,11 +568,12 @@ public class FileSystemManager: McuManager {
             payload.updateValue(CBOR.unsignedInt(UInt64(data.count)), forKey: "len")
         }
         // Build the packet and return the size.
-        let packet = McuManager.buildPacket(scheme: transporter.getScheme(), version: .SMPv2, op: .write,
-                                            flags: 0, group: group.rawValue, sequenceNumber: 0,
-                                            commandId: FilesystemID.file, payload: payload)
+        let packet = McuManager.buildPacket(scheme: transport.getScheme(), version: .SMPv2,
+                                            op: .write, flags: 0, group: group.rawValue,
+                                            sequenceNumber: 0, commandId: FilesystemID.file,
+                                            payload: payload)
         var packetOverhead = packet.count + 5
-        if transporter.getScheme().isCoap() {
+        if transport.getScheme().isCoap() {
             // Add 25 bytes to packet overhead estimate for the CoAP header.
             packetOverhead = packetOverhead + 25
         }