Merge pull request #441 from NordicSemiconductor/develop

Version 4.10.4

Author: philips77

Example/Podfile.lock

@@ -1,5 +1,5 @@
 PODS:
-  - iOSDFULibrary (4.10.3):
+  - iOSDFULibrary (4.10.4):
     - ZIPFoundation (= 0.9.11)
   - ZIPFoundation (0.9.11)
 
@@ -15,7 +15,7 @@ EXTERNAL SOURCES:
     :path: "../"
 
 SPEC CHECKSUMS:
-  iOSDFULibrary: 7aade51a907d01ca9a87055003cd232b09efd78f
+  iOSDFULibrary: 5d41d0ac69418d63755195db5f46e99588ae7d48
   ZIPFoundation: b1f0de4eed33e74a676f76e12559ab6b75990197
 
 PODFILE CHECKSUM: 16697609d795697cac6384a823bc962ccbddb9d0

Example/Pods/Local Podspecs/iOSDFULibrary.podspec.json

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>PreviewsEnabled</key>
+	<false/>
+</dict>
+</plist>

Example/Pods/Manifest.lock

@@ -56,7 +56,7 @@ let package = Package(
   dependencies: [
     .package(
       url: "https://github.com/NordicSemiconductor/IOS-Pods-DFU-Library", 
-      .upToNextMajor(from: "<Desired Version, e.g. 4.10.2>")
+      .upToNextMajor(from: "<Desired Version, e.g. 4.10.4>")
     )
   ],
   targets: [.target(name: "<Your Target Name>", dependencies: ["NordicDFU"])]

Example/Pods/Target Support Files/iOSDFULibrary-iOS/iOSDFULibrary-iOS-Info.plist

@@ -1,4 +1,10 @@
 ### Changelog
+- **4.10.4**
+   - Fix for compilation error in Xcode 13 related to change in iOS API (#433, #439).
+   - Improvement: State validation (#434, #435, #437).
+   - Imporvement: Unnecessary fields removed from `SecureDFUExecutor` (#438).
+   - Improvement: Accepting garbage after valid data in notifications (#440, #436).
+   
 - **4.10.3**
    - Project compilation available for Arm Simulators (#423).
 

Example/Pods/Target Support Files/iOSDFULibrary-macOS/iOSDFULibrary-macOS-Info.plist

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name             = "iOSDFULibrary"
-  s.version          = "4.10.3"
+  s.version          = "4.10.4"
   s.summary          = "This repository contains a tested library for iOS 9+ devices to perform Device Firmware Update on the nRF5x devices"
   s.description      = <<-DESC
 The nRF5x Series chips are flash-based SoCs, and as such they represent the most flexible solution available. A key feature of the nRF5x Series and their associated software architecture and S-Series SoftDevices is the possibility for Over-The-Air Device Firmware Upgrade (OTA-DFU). See Figure 1. OTA-DFU allows firmware upgrades to be issued and downloaded to products in the field via the cloud and so enables OEMs to fix bugs and introduce new features to products that are already out on the market. This brings added security and flexibility to product development when using the nRF5x Series SoCs.

Example/iOSDFULibrary.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings

@@ -109,6 +109,9 @@ import Foundation
     /// Error raised when the CRC reported by the remote device does not match.
     /// Service has done 3 attempts to send the data.
     case crcError                             = 309
+    /// The service went into an invalid state. The service will try to close
+    /// without crashing. Recovery to a know state is not possible.
+    case invalidInternalState                 = 500
 
     /// Returns whether the error has been returned by the remote device or
     /// occurred locally.

README.md

@@ -142,7 +142,7 @@ internal struct Response {
     let status        : DFUResultCode
 
     init?(_ data: Data) {
-        guard data.count == 3,
+        guard data.count >= 3,
               let opCode = DFUOpCode(rawValue: data[0]),
               let requestOpCode = DFUOpCode(rawValue: data[1]),
               let status = DFUResultCode(rawValue: data[2]),
@@ -165,7 +165,7 @@ internal struct PacketReceiptNotification {
     let bytesReceived : UInt32
 
     init?(_ data: Data) {
-        guard data.count == 5,
+        guard data.count >= 5,
               let opCode = DFUOpCode(rawValue: data[0]),
               opCode == .packetReceiptNotification else {
             return nil
@@ -216,13 +216,20 @@ internal struct PacketReceiptNotification {
      - parameter report:  Method called in case of an error.
      */
     func enableNotifications(onSuccess success: Callback?, onError report: ErrorCallback?) {
+        // Get the peripheral object.
+        #if swift(>=5.5)
+        guard let peripheral = characteristic.service?.peripheral else {
+            report?(.invalidInternalState, "Assert characteristic.service?.peripheral != nil failed")
+            return
+        }
+        #else
+        let peripheral = characteristic.service.peripheral
+        #endif
+        
         // Save callbacks.
         self.success = success
         self.report  = report
 
-        // Get the peripheral object.
-        let peripheral = characteristic.service.peripheral
-        
         // Set the peripheral delegate to self.
         peripheral.delegate = self
 
@@ -240,15 +247,22 @@ internal struct PacketReceiptNotification {
      - parameter report:  Method called in case of an error.
      */
     func send(_ request: Request, onSuccess success: Callback?, onError report: ErrorCallback?) {
+        // Get the peripheral object.
+        #if swift(>=5.5)
+        guard let peripheral = characteristic.service?.peripheral else {
+            report?(.invalidInternalState, "Assert characteristic.service?.peripheral != nil failed")
+            return
+        }
+        #else
+        let peripheral = characteristic.service.peripheral
+        #endif
+        
         // Save callbacks and parameter.
         self.success   = success
         self.report    = report
         self.request   = request
         self.resetSent = false
 
-        // Get the peripheral object.
-        let peripheral = characteristic.service.peripheral
-        
         // Set the peripheral delegate to self.
         peripheral.delegate = self
 
@@ -287,16 +301,23 @@ internal struct PacketReceiptNotification {
     func waitUntilUploadComplete(onSuccess success: Callback?,
                                  onPacketReceiptNofitication proceed: ProgressCallback?,
                                  onError report: ErrorCallback?) {
+        // Get the peripheral object.
+        #if swift(>=5.5)
+        guard let peripheral = characteristic.service?.peripheral else {
+            report?(.invalidInternalState, "Assert characteristic.service?.peripheral != nil failed")
+            return
+        }
+        #else
+        let peripheral = characteristic.service.peripheral
+        #endif
+        
         // Save callbacks. The proceed callback will be called periodically whenever
         // a packet receipt notification is received. It resumes uploading.
         self.success = success
         self.proceed = proceed
         self.report  = report
         self.uploadStartTime = CFAbsoluteTimeGetCurrent()
 
-        // Get the peripheral object.
-        let peripheral = characteristic.service.peripheral
-        
         // Set the peripheral delegate to self.
         peripheral.delegate = self
     }

changelog.md

@@ -63,11 +63,19 @@ internal class DFUPacket: DFUCharacteristic {
      Sends the firmware sizes in format [softdevice size, bootloader size, application size],
      where each size is a UInt32 number.
 
-     - parameter size: Sizes of firmware in the current part.
+     - parameter size:   Sizes of firmware in the current part.
+     - parameter report: Method called in case of an error.
      */
-    func sendFirmwareSize(_ size: DFUFirmwareSize) {
+    func sendFirmwareSize(_ size: DFUFirmwareSize, onError report: ErrorCallback?) {
         // Get the peripheral object
+        #if swift(>=5.5)
+        guard let peripheral = characteristic.service?.peripheral else {
+            report?(.invalidInternalState, "Assert characteristic.service?.peripheral != nil failed")
+            return
+        }
+        #else
         let peripheral = characteristic.service.peripheral
+        #endif
 
         let data = Data()
             + size.softdevice.littleEndian
@@ -84,12 +92,20 @@ internal class DFUPacket: DFUCharacteristic {
     /**
      Sends the application firmware size in format [application size] (UInt32).
 
-     - parameter size: Sizes of firmware in the current part.
-                       Only the application size may be grater than 0.
+     - parameter size:   Sizes of firmware in the current part.
+                         Only the application size may be grater than 0.
+     - parameter report: Method called in case of an error.
      */
-    func sendFirmwareSize_v1(_ size: DFUFirmwareSize) {
+    func sendFirmwareSize_v1(_ size: DFUFirmwareSize, onError report: ErrorCallback?) {
         // Get the peripheral object.
+        #if swift(>=5.5)
+        guard let peripheral = characteristic.service?.peripheral else {
+            report?(.invalidInternalState, "Assert characteristic.service?.peripheral != nil failed")
+            return
+        }
+        #else
         let peripheral = characteristic.service.peripheral
+        #endif
 
         let data = Data() + size.application.littleEndian
 
@@ -103,11 +119,19 @@ internal class DFUPacket: DFUCharacteristic {
     /**
      Sends the whole content of the data object.
 
-     - parameter data: The data to be sent.
+     - parameter data:   The data to be sent.
+     - parameter report: Method called in case of an error.
      */
-    func sendInitPacket(_ data: Data) {
+    func sendInitPacket(_ data: Data, onError report: ErrorCallback?) {
         // Get the peripheral object.
+        #if swift(>=5.5)
+        guard let peripheral = characteristic.service?.peripheral else {
+            report?(.invalidInternalState, "Assert characteristic.service?.peripheral != nil failed")
+            return
+        }
+        #else
         let peripheral = characteristic.service.peripheral
+        #endif
 
         // Data may be sent in up-to-20-bytes packets.
         var offset: UInt32 = 0
@@ -139,11 +163,20 @@ internal class DFUPacket: DFUCharacteristic {
      - parameter firmware: The firmware to be sent.
      - parameter progress: An optional progress delegate.
      - parameter queue:    The queue to dispatch progress events on.
+     - parameter report:   Method called in case of an error.     
      */
     func sendNext(_ prnValue: UInt16, packetsOf firmware: DFUFirmware,
-                  andReportProgressTo progress: DFUProgressDelegate?, on queue: DispatchQueue) {
+                  andReportProgressTo progress: DFUProgressDelegate?, on queue: DispatchQueue,
+                  onError report: ErrorCallback?) {
         // Get the peripheral object.
+        #if swift(>=5.5)
+        guard let peripheral = characteristic.service?.peripheral else {
+            report?(.invalidInternalState, "Assert characteristic.service?.peripheral != nil failed")
+            return
+        }
+        #else
         let peripheral = characteristic.service.peripheral
+        #endif
 
         // Some super complicated computations...
         let bytesTotal   = UInt32(firmware.data.count)

iOSDFULibrary.podspec

@@ -61,13 +61,20 @@ internal typealias VersionCallback = (_ major: UInt8, _ minor: UInt8) -> Void
      - parameter report:  Method called on error of if version is not supported.
      */
     func readVersion(onSuccess success: VersionCallback?, onError report: ErrorCallback?) {
+        // Get the peripheral object.
+        #if swift(>=5.5)
+        guard let peripheral = characteristic.service?.peripheral else {
+            report?(.invalidInternalState, "Assert characteristic.service?.peripheral != nil failed")
+            return
+        }
+        #else
+        let peripheral = characteristic.service.peripheral
+        #endif
+        
         // Save callbacks.
         self.success = success
         self.report = report
 
-        // Get the peripheral object.
-        let peripheral = characteristic.service.peripheral
-        
         // Set the peripheral delegate to self.
         peripheral.delegate = self
 

iOSDFULibrary/Classes/Implementation/DFUServiceDelegate.swift

@@ -66,7 +66,7 @@ internal class LegacyDFUExecutor : DFUExecutor, LegacyDFUPeripheralDelegate {
     func peripheralDidBecomeReady() {
         if firmware.initPacket == nil && peripheral.isInitPacketRequired() {
             error(.extendedInitPacketRequired, didOccurWithMessage:
-                "The init packet is required by the target device")
+                  "The init packet is required by the target device")
             return
         }
         delegate {
@@ -101,7 +101,7 @@ internal class LegacyDFUExecutor : DFUExecutor, LegacyDFUPeripheralDelegate {
         } else {
             // Operation can not be continued.
             error(.remoteLegacyDFUNotSupported, didOccurWithMessage:
-                "Updating Softdevice or Bootloader is not supported")
+                  "Updating Softdevice or Bootloader is not supported")
         }
     }
 
@@ -140,7 +140,7 @@ internal class LegacyDFUExecutor : DFUExecutor, LegacyDFUPeripheralDelegate {
             peripheral.start()
         } else {
             error(.remoteLegacyDFUInvalidState, didOccurWithMessage:
-                "Peripheral is in an invalid state, please try to reset and start over again.")
+                  "Peripheral is in an invalid state, please try to reset and start over again.")
         }
     }
 
@@ -157,8 +157,9 @@ internal class LegacyDFUExecutor : DFUExecutor, LegacyDFUPeripheralDelegate {
         // received by the DFU target before sending a new Packet Receipt Notification.
         // After receiving status Success it will send the firmware.
         peripheral.sendFirmware(firmware,
-                                withPacketReceiptNotificationNumber: initiator.packetReceiptNotificationParameter,
-                                andReportProgressTo: initiator.progressDelegate,
-                                on: initiator.progressDelegateQueue)
+            withPacketReceiptNotificationNumber: initiator.packetReceiptNotificationParameter,
+            andReportProgressTo: initiator.progressDelegate,
+            on: initiator.progressDelegateQueue
+        )
     }
 }