diff --git a/Example/Example/Base.lproj/Main.storyboard b/Example/Example/Base.lproj/Main.storyboard
index 68260b5..7cbff01 100644
--- a/Example/Example/Base.lproj/Main.storyboard
+++ b/Example/Example/Base.lproj/Main.storyboard
@@ -1451,8 +1451,8 @@
-
-
+
@@ -1473,8 +1473,8 @@
-
-
+
+
@@ -1844,7 +1844,7 @@
-
+
@@ -1855,8 +1855,8 @@
-
-
+
+
@@ -1868,8 +1868,8 @@
-
-
+
+
diff --git a/Example/Example/Util/PeripheralState+String.swift b/Example/Example/Util/PeripheralState+String.swift
deleted file mode 100644
index 7a37e4b..0000000
--- a/Example/Example/Util/PeripheralState+String.swift
+++ /dev/null
@@ -1,23 +0,0 @@
-/*
- * Copyright (c) 2018 Nordic Semiconductor ASA.
- *
- * SPDX-License-Identifier: Apache-2.0
- */
-
-
-import Foundation
-import iOSMcuManagerLibrary
-
-extension PeripheralState: CustomStringConvertible {
-
- public var description: String {
- switch self {
- case .connecting: return "CONNECTING..."
- case .initializing: return "INITIALIZING..."
- case .connected: return "CONNECTED"
- case .disconnecting: return "DISCONNECTING..."
- case .disconnected: return "DISCONNECTED"
- }
- }
-
-}
diff --git a/Example/Example/Util/StringConvertibles.swift b/Example/Example/Util/StringConvertibles.swift
new file mode 100644
index 0000000..5a46ee4
--- /dev/null
+++ b/Example/Example/Util/StringConvertibles.swift
@@ -0,0 +1,49 @@
+/*
+ * Copyright (c) 2018 Nordic Semiconductor ASA.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+
+import Foundation
+import iOSMcuManagerLibrary
+
+extension PeripheralState: CustomStringConvertible {
+
+ public var description: String {
+ switch self {
+ case .connecting: return "CONNECTING..."
+ case .initializing: return "INITIALIZING..."
+ case .connected: return "CONNECTED"
+ case .disconnecting: return "DISCONNECTING..."
+ case .disconnected: return "DISCONNECTED"
+ }
+ }
+
+}
+
+extension BootloaderInfoResponse.Mode: CustomStringConvertible {
+
+ public var description: String {
+ switch self {
+ case .unknown:
+ return "Unknown"
+ case .singleApplication:
+ return "Single application"
+ case .swapUsingScratch:
+ return "Swap using scratch partition"
+ case .overwrite:
+ return "Overwrite (upgrade-only)"
+ case .swapNoScratch:
+ return "Swap without scratch"
+ case .directXIPNoRevert:
+ return "Direct-XIP without revert"
+ case .directXIPWithRevert:
+ return "Direct-XIP with revert"
+ case .RAMLoader:
+ return "RAM Loader"
+ }
+ }
+
+}
+
diff --git a/Example/Example/View Controllers/Manager/FileUploadViewController.swift b/Example/Example/View Controllers/Manager/FileUploadViewController.swift
index 8778d9e..fe75be6 100644
--- a/Example/Example/View Controllers/Manager/FileUploadViewController.swift
+++ b/Example/Example/View Controllers/Manager/FileUploadViewController.swift
@@ -160,9 +160,8 @@ extension FileUploadViewController: UIDocumentMenuDelegate, UIDocumentPickerDele
do {
return try Data(contentsOf: url)
} catch {
- print("Error reading file: \(error)")
status.textColor = .systemRed
- status.text = "COULD NOT OPEN FILE"
+ status.text = error.localizedDescription
return nil
}
}
diff --git a/Example/Example/View Controllers/Manager/FirmwareUpgradeViewController.swift b/Example/Example/View Controllers/Manager/FirmwareUpgradeViewController.swift
index 63d9e4b..629b6cf 100644
--- a/Example/Example/View Controllers/Manager/FirmwareUpgradeViewController.swift
+++ b/Example/Example/View Controllers/Manager/FirmwareUpgradeViewController.swift
@@ -111,7 +111,7 @@ final class FirmwareUpgradeViewController: UIViewController, McuMgrViewControlle
// MARK: - Logic
private func setSwapTime() {
- let alertController = UIAlertController(title: "Swap Time (in seconds)", message: nil, preferredStyle: .actionSheet)
+ let alertController = UIAlertController(title: "Swap time (in seconds)", message: nil, preferredStyle: .actionSheet)
let seconds = [0, 5, 10, 20, 30, 40]
seconds.forEach { numberOfSeconds in
alertController.addAction(UIAlertAction(title: "\(numberOfSeconds) seconds", style: .default) {
@@ -124,7 +124,7 @@ final class FirmwareUpgradeViewController: UIViewController, McuMgrViewControlle
}
private func setPipelineDepth() {
- let alertController = UIAlertController(title: "Number of Buffers", message: nil, preferredStyle: .actionSheet)
+ let alertController = UIAlertController(title: "Number of buffers", message: nil, preferredStyle: .actionSheet)
let values = [2, 3, 4, 5, 6]
values.forEach { value in
let title = value == values.first ? "Disabled" : "\(value)"
@@ -139,11 +139,12 @@ final class FirmwareUpgradeViewController: UIViewController, McuMgrViewControlle
}
private func setByteAlignment() {
- let alertController = UIAlertController(title: "Byte Alignment", message: nil, preferredStyle: .actionSheet)
+ let alertController = UIAlertController(title: "Byte alignment", message: nil, preferredStyle: .actionSheet)
ImageUploadAlignment.allCases.forEach { alignmentValue in
- alertController.addAction(UIAlertAction(title: alignmentValue.description, style: .default) {
+ let text = "\(alignmentValue)"
+ alertController.addAction(UIAlertAction(title: text, style: .default) {
action in
- self.dfuByteAlignment.text = alignmentValue.description
+ self.dfuByteAlignment.text = text
self.dfuManagerConfiguration.byteAlignment = alignmentValue
})
}
@@ -158,9 +159,9 @@ final class FirmwareUpgradeViewController: UIViewController, McuMgrViewControlle
guard dfuManagerConfiguration.pipelineDepth == 1 || dfuManagerConfiguration.byteAlignment != .disabled else {
dfuManagerConfiguration.byteAlignment = FirmwareUpgradeConfiguration().byteAlignment
- dfuByteAlignment.text = dfuManagerConfiguration.byteAlignment.description
+ dfuByteAlignment.text = "\(dfuManagerConfiguration.byteAlignment)"
- let alert = UIAlertController(title: "Byte Alignment Setting Changed", message: """
+ let alert = UIAlertController(title: "Byte alignment setting changed", message: """
Pipelining requires a Byte Alignment setting to be applied, otherwise chunk offsets can't be predicted as more Data is sent.
""", preferredStyle: .alert)
alert.addAction(UIAlertAction(title: "OK", style: .default, handler: nil))
@@ -171,9 +172,10 @@ final class FirmwareUpgradeViewController: UIViewController, McuMgrViewControlle
}
private func selectMode(for package: McuMgrPackage) {
- let alertController = UIAlertController(title: "Select Mode", message: nil, preferredStyle: .actionSheet)
+ let alertController = UIAlertController(title: "Select mode", message: nil, preferredStyle: .actionSheet)
FirmwareUpgradeMode.allCases.forEach { upgradeMode in
- alertController.addAction(UIAlertAction(title: upgradeMode.description, style: .default) {
+ let text = "\(upgradeMode)"
+ alertController.addAction(UIAlertAction(title: text, style: .default) {
action in
self.dfuManagerConfiguration.upgradeMode = upgradeMode
self.startFirmwareUpgrade(package: package)
@@ -200,9 +202,8 @@ final class FirmwareUpgradeViewController: UIViewController, McuMgrViewControlle
do {
try dfuManager.start(images: package.images, using: dfuManagerConfiguration)
} catch {
- print("Error reading hash: \(error)")
status.textColor = .systemRed
- status.text = "ERROR"
+ status.text = error.localizedDescription
actionStart.isEnabled = false
}
}
@@ -282,7 +283,7 @@ extension FirmwareUpgradeViewController: FirmwareUpgradeDelegate {
actionSelect.isEnabled = true
eraseSwitch.isEnabled = true
status.textColor = .systemRed
- status.text = "\(error.localizedDescription)"
+ status.text = error.localizedDescription
status.numberOfLines = 0
dfuSpeed.isHidden = true
}
@@ -359,15 +360,14 @@ extension FirmwareUpgradeViewController: UIDocumentMenuDelegate, UIDocumentPicke
dfuSwapTime.numberOfLines = 0
dfuNumberOfBuffers.text = dfuManagerConfiguration.pipelineDepth == 1 ? "Disabled" : "\(dfuManagerConfiguration.pipelineDepth + 1)"
dfuNumberOfBuffers.numberOfLines = 0
- dfuByteAlignment.text = dfuManagerConfiguration.byteAlignment.description
+ dfuByteAlignment.text = "\(dfuManagerConfiguration.byteAlignment)"
dfuByteAlignment.numberOfLines = 0
} catch {
- print("Error reading hash: \(error)")
fileName.text = url.lastPathComponent
fileSize.text = ""
fileHash.text = ""
status.textColor = .systemRed
- status.text = "Error Loading File: \(error.localizedDescription)"
+ status.text = error.localizedDescription
status.numberOfLines = 0
actionStart.isEnabled = false
}
diff --git a/Example/Example/View Controllers/Manager/FirmwareUploadViewController.swift b/Example/Example/View Controllers/Manager/FirmwareUploadViewController.swift
index 5359b35..31aa74e 100644
--- a/Example/Example/View Controllers/Manager/FirmwareUploadViewController.swift
+++ b/Example/Example/View Controllers/Manager/FirmwareUploadViewController.swift
@@ -39,7 +39,7 @@ class FirmwareUploadViewController: UIViewController, McuMgrViewController {
}
@IBAction func setNumberOfBuffers(_ sender: UIButton) {
- let alertController = UIAlertController(title: "Number of Buffers", message: nil, preferredStyle: .actionSheet)
+ let alertController = UIAlertController(title: "Number of buffers", message: nil, preferredStyle: .actionSheet)
let values = [2, 3, 4, 5, 6]
values.forEach { value in
let title = value == values.first ? "Disabled" : "\(value)"
@@ -54,11 +54,12 @@ class FirmwareUploadViewController: UIViewController, McuMgrViewController {
}
@IBAction func setDfuAlignment(_ sender: UIButton) {
- let alertController = UIAlertController(title: "Byte Alignment", message: nil, preferredStyle: .actionSheet)
+ let alertController = UIAlertController(title: "Byte alignment", message: nil, preferredStyle: .actionSheet)
ImageUploadAlignment.allCases.forEach { alignmentValue in
- alertController.addAction(UIAlertAction(title: alignmentValue.description, style: .default) {
+ let text = "\(alertController)"
+ alertController.addAction(UIAlertAction(title: text, style: .default) {
action in
- self.dfuByteAlignment.text = alignmentValue.description
+ self.dfuByteAlignment.text = text
self.uploadConfiguration.byteAlignment = alignmentValue
})
}
@@ -66,7 +67,7 @@ class FirmwareUploadViewController: UIViewController, McuMgrViewController {
}
@IBAction func setChunkSize(_ sender: Any) {
- let alertController = UIAlertController(title: "Set Chunk Size", message: "0 means Default (MTU Size)", preferredStyle: .alert)
+ let alertController = UIAlertController(title: "Set chunk size", message: "0 means default (MTU size)", preferredStyle: .alert)
alertController.addTextField { (textField) in
textField.placeholder = "\(self.uploadConfiguration.reassemblyBufferSize)"
textField.keyboardType = .decimalPad
@@ -272,7 +273,7 @@ extension FirmwareUploadViewController: UIDocumentMenuDelegate, UIDocumentPicker
fileHash.numberOfLines = 0
dfuNumberOfBuffers.text = uploadConfiguration.pipelineDepth == 1 ? "Disabled" : "\(uploadConfiguration.pipelineDepth + 1)"
- dfuByteAlignment.text = uploadConfiguration.byteAlignment.description
+ dfuByteAlignment.text = "\(uploadConfiguration.byteAlignment)"
dfuChunkSize.text = "\(uploadConfiguration.reassemblyBufferSize)"
status.textColor = .primary
@@ -283,7 +284,7 @@ extension FirmwareUploadViewController: UIDocumentMenuDelegate, UIDocumentPicker
fileSize.text = ""
fileHash.text = ""
status.textColor = .systemRed
- status.text = "INVALID FILE"
+ status.text = "Invalid file"
actionStart.isEnabled = false
}
(parent as! ImageController).innerViewReloaded()
diff --git a/Example/Example/View Controllers/Manager/Widgets/ImagesViewController.swift b/Example/Example/View Controllers/Manager/Widgets/ImagesViewController.swift
index 99f42be..0df6dd3 100644
--- a/Example/Example/View Controllers/Manager/Widgets/ImagesViewController.swift
+++ b/Example/Example/View Controllers/Manager/Widgets/ImagesViewController.swift
@@ -74,10 +74,10 @@ class ImagesViewController: UIViewController , McuMgrViewController{
return
}
- let alertController = UIAlertController(title: "Select Image", message: nil, preferredStyle: .actionSheet)
+ let alertController = UIAlertController(title: "Select image", message: nil, preferredStyle: .actionSheet)
for image in responseImages {
guard !image.confirmed else { continue }
- let title = "Image \(image.image!), Slot \(image.slot!)"
+ let title = "Image \(image.image!), slot \(image.slot!)"
alertController.addAction(UIAlertAction(title: title, style: .default) { action in
callback(image.hash)
})
diff --git a/Example/nRF Connect Device Manager.xcodeproj/project.pbxproj b/Example/nRF Connect Device Manager.xcodeproj/project.pbxproj
index f93159b..e863ebb 100644
--- a/Example/nRF Connect Device Manager.xcodeproj/project.pbxproj
+++ b/Example/nRF Connect Device Manager.xcodeproj/project.pbxproj
@@ -35,7 +35,7 @@
BD5A285F20CB44B00061F0EE /* Assets.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = BD5A285E20CB44B00061F0EE /* Assets.xcassets */; };
BD5A286220CB44B00061F0EE /* LaunchScreen.storyboard in Resources */ = {isa = PBXBuildFile; fileRef = BD5A286020CB44B00061F0EE /* LaunchScreen.storyboard */; };
E7F00904AD78FC61457F0B06 /* Pods_nRF_Connect_Device_Manager.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = C75D2DC863EB4235DE2F466B /* Pods_nRF_Connect_Device_Manager.framework */; };
- F07D73AC2AE9AE3A00ED6B9A /* PeripheralState+String.swift in Sources */ = {isa = PBXBuildFile; fileRef = F07D73AB2AE9AE3A00ED6B9A /* PeripheralState+String.swift */; };
+ F07D73AC2AE9AE3A00ED6B9A /* StringConvertibles.swift in Sources */ = {isa = PBXBuildFile; fileRef = F07D73AB2AE9AE3A00ED6B9A /* StringConvertibles.swift */; };
/* End PBXBuildFile section */
/* Begin PBXFileReference section */
@@ -72,7 +72,7 @@
BD5A286320CB44B00061F0EE /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = ""; };
C75D2DC863EB4235DE2F466B /* Pods_nRF_Connect_Device_Manager.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_nRF_Connect_Device_Manager.framework; sourceTree = BUILT_PRODUCTS_DIR; };
E9EB68FC3504F79AE1891044 /* Pods-nRF Connect Device Manager.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-nRF Connect Device Manager.debug.xcconfig"; path = "Target Support Files/Pods-nRF Connect Device Manager/Pods-nRF Connect Device Manager.debug.xcconfig"; sourceTree = ""; };
- F07D73AB2AE9AE3A00ED6B9A /* PeripheralState+String.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "PeripheralState+String.swift"; sourceTree = ""; };
+ F07D73AB2AE9AE3A00ED6B9A /* StringConvertibles.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = StringConvertibles.swift; sourceTree = ""; };
/* End PBXFileReference section */
/* Begin PBXFrameworksBuildPhase section */
@@ -142,7 +142,7 @@
524DCFD8210B4241000E110D /* UIColor.swift */,
AA02AA5B2796E67E003040D5 /* UTI.swift */,
AA02AA592796E57E003040D5 /* McuMgrPackage.swift */,
- F07D73AB2AE9AE3A00ED6B9A /* PeripheralState+String.swift */,
+ F07D73AB2AE9AE3A00ED6B9A /* StringConvertibles.swift */,
);
path = Util;
sourceTree = "";
@@ -371,7 +371,7 @@
524DCFD4210B1C17000E110D /* DeviceController.swift in Sources */,
5215762D212320F300C21B0C /* LogsStatsController.swift in Sources */,
BD5A285820CB44AF0061F0EE /* AppDelegate.swift in Sources */,
- F07D73AC2AE9AE3A00ED6B9A /* PeripheralState+String.swift in Sources */,
+ F07D73AC2AE9AE3A00ED6B9A /* StringConvertibles.swift in Sources */,
5215762F2125B59400C21B0C /* FilesController.swift in Sources */,
521576332126FFBE00C21B0C /* FileDownloadViewController.swift in Sources */,
5266273824ACA883008F528C /* NordicButton.swift in Sources */,
diff --git a/Source/Managers/BasicManager.swift b/Source/Managers/BasicManager.swift
index f56c178..00bf29f 100644
--- a/Source/Managers/BasicManager.swift
+++ b/Source/Managers/BasicManager.swift
@@ -51,15 +51,15 @@ public enum BasicManagerError: UInt64, Error, LocalizedError {
public var errorDescription: String? {
switch self {
case .noError:
- return "No Error Has Occurred"
+ return "Success"
case .unknown:
- return "An Unknown Error Occurred"
+ return "Unknown error"
case .flashOpenFailed:
- return "Opening Flash Area Failed"
+ return "Opening flash area failed"
case .flashConfigQueryFailed:
- return "Querying Flash Area Parameters Failed"
+ return "Querying flash area parameters failed"
case .flashEraseFailed:
- return "Erasing Flash Area Failed"
+ return "Erasing flash area failed"
}
}
}
diff --git a/Source/Managers/DFU/FirmwareUpgradeManager.swift b/Source/Managers/DFU/FirmwareUpgradeManager.swift
index f677e55..4c4f901 100644
--- a/Source/Managers/DFU/FirmwareUpgradeManager.swift
+++ b/Source/Managers/DFU/FirmwareUpgradeManager.swift
@@ -1025,11 +1025,11 @@ extension FirmwareUpgradeError: LocalizedError {
case .unknown(let message):
return message
case .invalidResponse(let response):
- return "Invalid response: \(response)."
+ return "Invalid response: \(response)"
case .connectionFailedAfterReset:
- return "Connection failed after reset."
+ return "Connection failed after reset"
case .untestedImageFound(let image, let slot):
- return "Image \(image) Slot \(slot) found to be not Tested after Reset. After Reset, all Uploaded Images are expected to have been Tested (Verified)."
+ return "Image \(image), slot \(slot) found to be not Tested after Reset"
}
}
@@ -1054,7 +1054,7 @@ public enum FirmwareUpgradeState {
// MARK: - FirmwareUpgradeMode
//******************************************************************************
-public enum FirmwareUpgradeMode: Codable, CustomStringConvertible, CaseIterable {
+public enum FirmwareUpgradeMode: Codable, CustomDebugStringConvertible, CaseIterable {
/// When this mode is set, the manager will send the test and reset commands
/// to the device after the upload is complete. The device will reboot and
/// will run the new image on its next boot. If the new image supports
@@ -1081,14 +1081,14 @@ public enum FirmwareUpgradeMode: Codable, CustomStringConvertible, CaseIterable
/// test it before confirming.
case testAndConfirm
- public var description: String {
+ public var debugDescription: String {
switch self {
case .testOnly:
- return "Test Only"
+ return "Test only"
case .confirmOnly:
- return "Confirm Only"
+ return "Confirm only"
case .testAndConfirm:
- return "Test And Confirm"
+ return "Test and Confirm"
}
}
}
diff --git a/Source/Managers/DefaultManager.swift b/Source/Managers/DefaultManager.swift
index 2613f44..ee3d77c 100644
--- a/Source/Managers/DefaultManager.swift
+++ b/Source/Managers/DefaultManager.swift
@@ -208,11 +208,11 @@ public enum OSManagerError: UInt64, Error, LocalizedError {
case .noError:
return "Success"
case .unknown:
- return "An Unknown Error Occurred"
+ return "Unknown Error"
case .invalidFormat:
- return "Provided Format Value Is Not Valid"
+ return "Provided format value is not valid"
case .queryNotRecognized:
- return "Query Was Not Recognized (i.e. No Answer)"
+ return "Query was not recognized (i.e. no answer)"
}
}
}
diff --git a/Source/Managers/FileSystemManager.swift b/Source/Managers/FileSystemManager.swift
index 8183c75..6b87b99 100644
--- a/Source/Managers/FileSystemManager.swift
+++ b/Source/Managers/FileSystemManager.swift
@@ -620,37 +620,37 @@ public enum FileSystemManagerError: UInt64, Error, LocalizedError {
case .noError:
return "Success"
case .unknown:
- return "An Unknown Error Occurred"
+ return "Unknown error"
case .invalidName:
- return "Specified File Name Is Not Valid"
+ return "Specified file name is not valid"
case .notFound:
- return "Specified File Name Does Not Exist"
+ return "Specified file name does not exist"
case .isDirectory:
- return "Specified File Name Is a Directory, Not a File"
+ return "Specified file name is a directory, not a file"
case .openFailed:
- return "Error Occurred Whilst Attempting to Open File"
+ return "Error occurred whilst attempting to open file"
case .seekFailed:
- return "Error Occurred Whilst Attempting to Seek to an Offset In a File"
+ return "Error occurred whilst attempting to seek to an offset in a file"
case .readFailed:
- return "Error Occurred Whilst Attempting to Read Data From a File"
+ return "Error occurred whilst attempting to read data from a file"
case .truncateFailed:
- return "Error Occurred Whilst Attempting to Truncate a File"
+ return "Error occurred whilst attempting to truncate a file"
case .deleteFailed:
- return "Error Occurred Whilst Attempting to Delete a File"
+ return "Error occurred whilst attempting to delete a file"
case .writeFailed:
- return "Error Occurred Whilst Attempting to Write Data to a File"
+ return "Error occurred whilst attempting to write data to a file"
case .invalidOffset:
- return "Specified Data Offset Within a File Is Invalid"
+ return "Specified data offset within a file is invalid"
case .offsetLargerThanFile:
- return "Requested Offset Is Larger Than the Size of The File on the device"
+ return "Requested offset is larger than the size of the file on the device"
case .checksumHashNotFound:
- return "Requested Hash or CheckSum Was Not Found or Is Not Supported"
+ return "Requested hash or checksum was not found or is not supported"
case .mountingPointNotFound:
- return "Requested Mounting Point Was Not Found or Is Not Mounted"
+ return "Requested mounting point was not found or is not mounted"
case .readOnlyFilesystem:
- return "Specified Mount Point Only Supports Read-Only Operations"
+ return "Specified mount point only supports read-only operations"
case .emptyFile:
- return "Requested Operation Cannot Be Performed Due to File Being Empty with No Contents"
+ return "Requested operation cannot be performed due to file being empty with no contents"
}
}
}
diff --git a/Source/Managers/ImageManager.swift b/Source/Managers/ImageManager.swift
index c9b3698..f8c7139 100644
--- a/Source/Managers/ImageManager.swift
+++ b/Source/Managers/ImageManager.swift
@@ -575,7 +575,7 @@ public class ImageManager: McuManager {
// MARK: - ImageUploadAlignment
-public enum ImageUploadAlignment: UInt64, Codable, CaseIterable, CustomStringConvertible {
+public enum ImageUploadAlignment: UInt64, Codable, CaseIterable, CustomDebugStringConvertible {
case disabled = 0
case twoByte = 2
@@ -583,9 +583,9 @@ public enum ImageUploadAlignment: UInt64, Codable, CaseIterable, CustomStringCon
case eightByte = 8
case sixteenByte = 16
- public var description: String {
- guard self != .disabled else { return "Disabled" }
- return "\(rawValue)-Byte"
+ public var debugDescription: String {
+ guard self != .disabled else { return "disabled" }
+ return "\(rawValue)-byte"
}
}
@@ -610,7 +610,7 @@ public enum ImageUploadError: Error, LocalizedError {
case .offsetMismatch:
return "Response payload reports package offset does not match expected value"
case .invalidUploadSequenceNumber(let sequenceNumber):
- return "Received Response for Unknown Sequence Number \(sequenceNumber)"
+ return "Received Response for unknown Sequence Number \(sequenceNumber)"
}
}
}
@@ -658,71 +658,71 @@ public enum ImageManagerError: UInt64, Error, LocalizedError {
case .noError:
return "Success"
case .unknown:
- return "An Unknown Error Occurred"
+ return "Unknown error"
case .flashConfigurationQueryFailure:
- return "Failed to Query Flash Area Configuration"
+ return "Failed to query flash area configuration"
case .noImage:
- return "There's No Image in the Slot"
+ return "There's no image in the slot"
case .noTLVs:
- return "Slot Image Is Missing TLV Information"
+ return "Slot image is missing TLV information"
case .invalidTLV:
- return "Slot Image Has an Invalid TLV Type and/or Length"
+ return "Slot image has an invalid TLV type and/or length"
case .tlvHashCollision:
- return "Slot Image Has Multiple Hash TLVs, Which Is Invalid"
+ return "Slot image has multiple hash TLVs, which is invalid"
case .tlvInvalidSize:
- return "Slot Image Has an Invalid TLV Size"
+ return "Slot image has an invalid TLV size"
case .hashNotFound:
- return "Slot Image Has No Hash TLV"
+ return "Slot image has no hash TLV"
case .fullSlots:
- return "There Is No Free Slot to Place The Image"
+ return "There is no free slot to place the image"
case .flashOpenFailed:
- return "Flash Area Opening Failed"
+ return "Flash area opening failed"
case .flashReadFailed:
- return "Flash Area Reading Failed"
+ return "Flash area reading failed"
case .flashWriteFailed:
- return "Flash Area Writing Failed"
+ return "Flash area writing failed"
case .flashEraseFailed:
- return "Flash Area Erasing Failed"
+ return "Flash area erasing failed"
case .invalidSlot:
- return "Given Slot Is Not Valid"
+ return "Given slot is not valid"
case .mallocFailed:
- return "Insufficient Heap Memory (Malloc Failed)"
+ return "Insufficient heap memory (malloc failed)"
case .flashContextAlreadySet:
- return "Flash Context Is Already Set"
+ return "Flash context is already set"
case .flashContextNotSet:
- return "Flash Context Is Not Set"
+ return "Flash context is not set"
case .flashAreaNull:
- return "Device For The Flash Area Is Null"
+ return "device for the flash area is null"
case .invalidPageOffset:
- return "Invalid Page Number Offset"
+ return "Invalid page number offset"
case .missingOffset:
- return "Required Offset Parameter Not Found"
+ return "Required offset parameter not found"
case .missingLength:
- return "Required Length Parameter Not Found"
+ return "Required length parameter not found"
case .invalidImageHeader:
- return "Image Length Is Smaller Than The Size Of an Image Header"
+ return "Image length is smaller than the size of an image header"
case .invalidImageHeaderMagic:
- return "Image Header Magic Value Does Not Match The Expected Value"
+ return "Image header magic value does not match the expected value"
case .invalidHash:
- return "Invalid Hash Parameter"
+ return "Invalid hash parameter"
case .invalidFlashAddress:
- return "Image Load Address Does Not Match The Address of The Flash Area"
+ return "Image load address does not match the address of the flash area"
case .versionGetFailed:
- return "Failed to Get Version of Currently Running Application"
+ return "Failed to get version of currently running application"
case .newerCurrentVersion:
- return "Currently Running Application Is Newer Than Uploading Version"
+ return "Currently running application is newer than uploading version"
case .imageAlreadyPending:
- return "Image Operation Already Pending"
+ return "Image operation already pending"
case .invalidImageVectorTable:
- return "Image Vector Table Is Invalid"
+ return "Image vector table is invalid"
case .invalidImageTooLarge:
- return "Image Is Too Large to Fit"
+ return "Image is too large to fit"
case .invalidImageDataOverrun:
- return "Data Sent Is Larger than the Provided Image Size"
+ return "Data sent is larger than the provided image size"
case .imageConfirmationDenied:
- return "Image Confirmation Denied"
+ return "Image confirmation denied"
case .imageSettingTestToActiveDenied:
- return "Setting Active Slot to Test Is Not Allowed"
+ return "Setting active slot to test is not allowed"
}
}
}
diff --git a/Source/Managers/SettingsManager.swift b/Source/Managers/SettingsManager.swift
index 10de41e..908aa04 100644
--- a/Source/Managers/SettingsManager.swift
+++ b/Source/Managers/SettingsManager.swift
@@ -64,19 +64,19 @@ public enum SettingsManagerError: UInt64, Error, LocalizedError {
case .noError:
return "Success"
case .unknown:
- return "An Unknown Error Occurred"
+ return "Unknown error"
case .keyTooLong:
- return "Given Key Name Is Too Long to Be Used"
+ return "Provided key name is too long to be used"
case .keyNotFound:
- return "Given Key Name Does Not Exist"
+ return "Provided key name does not exist"
case .readNotSupported:
- return "Desired Key Name Does Not Support Being Read"
+ return "Provided key name does not support being read"
case .rootKeyNotFound:
- return "Desired Root Key Name Does Not Exist"
+ return "Provided root key name does not exist"
case .writeNotSupported:
- return "Desired dKey Name Does Not Support Write Operation"
+ return "Provided key name does not support write operation"
case .deleteNotSupported:
- return "Given Key Name Does Not Support Delete Operation"
+ return "Provided key name does not support delete operation"
}
}
}
diff --git a/Source/Managers/StatsManager.swift b/Source/Managers/StatsManager.swift
index 0479e6e..9a36957 100644
--- a/Source/Managers/StatsManager.swift
+++ b/Source/Managers/StatsManager.swift
@@ -65,15 +65,15 @@ public enum StatsManagerError: UInt64, Error, LocalizedError {
case .noError:
return "Success"
case .unknown:
- return "An Unknown Error Occurred"
+ return "Unknown error"
case .invalidGroup:
- return "Statistic Group Not Found"
+ return "Statistic group not found"
case .invalidStatName:
- return "Statistic Name Not Found"
+ return "Statistic name not found"
case .invalidStatSize:
- return "Size Of The Statistic Cannot Be Handled"
+ return "Size of the statistic cannot be handled"
case .abortedWalk:
- return "Walkthrough Of Statistics Was Aborted"
+ return "Walkthrough of statistics was aborted"
}
}
}
diff --git a/Source/McuManager.swift b/Source/McuManager.swift
index c9db632..a26efc5 100644
--- a/Source/McuManager.swift
+++ b/Source/McuManager.swift
@@ -333,11 +333,11 @@ public enum McuMgrGroup: UInt16 {
/// The mcu manager operation defines whether the packet sent is a read/write
/// and request/response.
-public enum McuMgrVersion: UInt8, CustomStringConvertible {
+public enum McuMgrVersion: UInt8, CustomDebugStringConvertible {
case SMPv1 = 0
case SMPv2 = 1
- public var description: String {
+ public var debugDescription: String {
switch self {
case .SMPv1:
return "SMPv1"
@@ -460,31 +460,42 @@ extension McuMgrReturnCode: CustomStringConvertible {
public var description: String {
switch self {
case .ok:
- return "OK (RC: \(rawValue))"
+ return "OK"
case .unknown:
- return "Unknown error (RC: \(rawValue))"
+ return "Unknown error"
case .noMemory:
- return "No Memory (RC: \(rawValue))"
+ return "No memory"
case .inValue:
- return "Invalid Value (RC: \(rawValue))"
+ return "Invalid value"
case .timeout:
- return "Timeout (RC: \(rawValue))"
+ return "Timeout"
case .noEntry:
- return "No Entry (RC: \(rawValue))" // For Filesystem Operations, Does Your Mounting Point Match Your Target Firmware / Device?
+ return "No entry" // For Filesystem Operations, Does Your Mounting Point Match Your Target Firmware / Device?
case .badState:
- return "Bad State (RC: \(rawValue))"
+ return "Bad state"
case .responseIsTooLong:
- return "Response is Too Long (RC: \(rawValue))"
+ return "Response is too long"
case .unsupported:
- return "Not Supported (RC: \(rawValue))"
+ return "Not supported"
case .corruptPayload:
- return "Corrupt Payload (RC: \(rawValue))"
+ return "Corrupt payload"
case .busy:
- return "Busy processing previous SMP Request (RC: \(rawValue)). Try again later."
+ return "Busy, try again later" // Busy processing previous SMP Request
case .accessDenied:
- return "Access Denied (RC: \(rawValue))" // Are You Trying to Downgrade to a Lower Image Version?
+ return "Access denied" // Are You Trying to Downgrade to a Lower Image Version?
default:
return "Unrecognized (RC: \(rawValue))"
}
}
}
+
+extension McuMgrReturnCode: CustomDebugStringConvertible {
+
+ public var debugDescription: String {
+ if case .unrecognized = self {
+ return description
+ }
+ return "\(description) (RC: \(rawValue))"
+ }
+
+}
diff --git a/Source/McuMgrResponse.swift b/Source/McuMgrResponse.swift
index 13cfdb7..8f4988d 100644
--- a/Source/McuMgrResponse.swift
+++ b/Source/McuMgrResponse.swift
@@ -222,19 +222,13 @@ open class McuMgrResponse: CBORMappable {
}
}
-extension McuMgrResponse: CustomStringConvertible {
-
- public var description: String {
- return payload?.description ?? "nil"
- }
-}
-
extension McuMgrResponse: CustomDebugStringConvertible {
/// String representation of the response.
public var debugDescription: String {
return "Header: \(self.header!), Payload: \(payload?.description ?? "nil")"
}
+
}
//******************************************************************************
@@ -251,9 +245,9 @@ extension McuMgrResponseParseError: LocalizedError {
public var errorDescription: String? {
switch self {
case .invalidDataSize:
- return "Invalid data size."
+ return "Invalid data size"
case .invalidPayload:
- return "Invalid payload."
+ return "Invalid payload"
}
}
@@ -403,7 +397,7 @@ public final class AppInfoResponse: McuMgrResponse {
public final class BootloaderInfoResponse: McuMgrResponse {
- public enum Mode: Int, Codable, CustomStringConvertible {
+ public enum Mode: Int, Codable, CustomDebugStringConvertible {
case unknown = -1
case singleApplication = 0
case swapUsingScratch = 1
@@ -413,24 +407,24 @@ public final class BootloaderInfoResponse: McuMgrResponse {
case directXIPWithRevert = 5
case RAMLoader = 6
- public var description: String {
+ public var debugDescription: String {
switch self {
case .unknown:
- return "MCUboot is in single application mode."
+ return "Unknown"
case .singleApplication:
- return "MCUboot is in single application mode."
+ return "Single application"
case .swapUsingScratch:
- return "MCUboot is in swap using scratch partition mode."
+ return "Swap using scratch partition"
case .overwrite:
- return "MCUboot is in overwrite (upgrade-only) mode."
+ return "Overwrite (upgrade-only)"
case .swapNoScratch:
- return "MCUboot is in swap without scratch mode."
+ return "Swap without scratch"
case .directXIPNoRevert:
- return "MCUboot is in DirectXIP without revert mode."
+ return "Direct-XIP without revert"
case .directXIPWithRevert:
- return "MCUboot is in DirectXIP with revert mode."
+ return "Direct-XIP with revert"
case .RAMLoader:
- return "MCUboot is in RAM loader mode."
+ return "RAM Loader"
}
}
}