Merge pull request #14 from nallick/swift-tools-version-5

Update SPM to swift-tools-version:5.0

Examples/SwiftSerialExample/Package.swift

@@ -1,8 +1,20 @@
+// swift-tools-version:5.0
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+
 import PackageDescription
 
 let package = Package(
     name: "SwiftSerialExample",
     dependencies: [
-    	.Package(url: "https://github.com/yeokm1/SwiftSerial.git", majorVersion: 0)
+        .package(url: "https://github.com/yeokm1/SwiftSerial.git", from: "0.1.1")
+    ],
+    targets: [
+        // Targets are the basic building blocks of a package. A target can define a module or a test suite.
+        // Targets can depend on other targets in this package, and on products in packages which this package depends on.
+        .target(
+            name: "SwiftSerialExample",
+            dependencies: ["SwiftSerial"],
+            path: "Sources"
+        ),
     ]
 )

Examples/SwiftSerialExample/Sources/main.swift

@@ -32,9 +32,9 @@ do {
                            transmitRate: .baud9600,
                            minimumBytesToRead: 1)
 
-    print("Writing test string <\(testString)> of \(testString.characters.count) characters to serial port")
+    print("Writing test string <\(testString)> of \(testString.count) characters to serial port")
 
-    var bytesWritten = try serialPort.writeString(testString)
+    let bytesWritten = try serialPort.writeString(testString)
 
     print("Successfully wrote \(bytesWritten) bytes")
     print("Waiting to receive what was written...")
@@ -54,7 +54,7 @@ do {
     var multiLineString: String = ""
 
 
-    for i in 1...numberOfMultiNewLineTest { 
+    for _ in 1...numberOfMultiNewLineTest { 
         multiLineString += testString + "\n"
     }
 

Examples/SwiftSerialIM/Package.swift

@@ -1,8 +1,20 @@
+// swift-tools-version:5.0
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+
 import PackageDescription
 
 let package = Package(
     name: "SwiftSerialIM",
     dependencies: [
-    	.Package(url: "https://github.com/yeokm1/SwiftSerial.git", majorVersion: 0)
+        .package(url: "https://github.com/yeokm1/SwiftSerial.git", from: "0.1.1")
+    ],
+    targets: [
+        // Targets are the basic building blocks of a package. A target can define a module or a test suite.
+        // Targets can depend on other targets in this package, and on products in packages which this package depends on.
+        .target(
+            name: "SwiftSerialIM",
+            dependencies: ["SwiftSerial"],
+            path: "Sources"
+        ),
     ]
 )

Examples/SwiftSerialIM/Sources/main.swift

@@ -44,10 +44,10 @@ func printToScreenFrom(myself: Bool, characterToPrint: UnicodeScalar){
 
     if(myturn && !myself){
         myturn = false
-        print("\nOther: ", terminator:"")
+        print("\n\nOther: ", terminator:"")
     } else if (!myturn && myself){
         myturn = true
-        print("\nMe: ", terminator:"")
+        print("\n\nMe: ", terminator:"")
     }
 
     print(characterToPrint, terminator:"")
@@ -95,6 +95,7 @@ do {
         observer in
 
         backgroundRead()
+        return nil
     }
 
     pthread_create(&readingThread, nil, pthreadFunc, nil)
@@ -112,7 +113,7 @@ do {
 
 
     while true {
-        var enteredKey = getKeyPress()
+        let enteredKey = getKeyPress()
         printToScreenFrom(myself: true, characterToPrint: enteredKey)
         var _ = try serialPort.writeChar(enteredKey)
     }

Package.swift

@@ -1,5 +1,19 @@
+// swift-tools-version:5.0
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+
 import PackageDescription
 
 let package = Package(
-    name: "SwiftSerial"
+    name: "SwiftSerial",
+	products: [
+		.library(name: "SwiftSerial", targets: ["SwiftSerial"]),
+	],
+	dependencies: [],
+	targets: [
+		.target(
+			name: "SwiftSerial",
+			dependencies: [],
+			path: "Sources"
+		),
+	]
 )

README.md

@@ -1,5 +1,5 @@
 # SwiftSerial
-A Swift 3 Linux and Mac library for reading and writing to serial ports. This library has been tested to work on macOS Sierra, Linux Mint 18 (based on Ubuntu 16.04) and on the [Raspberry Pi 3 on Ubuntu 16.04](https://wiki.ubuntu.com/ARM/RaspberryPi). Other platforms using Ubuntu like the Beaglebone might work as well.
+A Swift Linux and Mac library for reading and writing to serial ports. This library has been tested to work on macOS Mojove, Linux Mint 18 (based on Ubuntu 16.04) and on the [Raspberry Pi 3 on Ubuntu 16.04](https://wiki.ubuntu.com/ARM/RaspberryPi) and Raspberry Pi 4 on Raspian Buster. Other platforms using Ubuntu like the Beaglebone might work as well.
 
 This library is an improvement over my previous now deprecated library [SwiftLinuxSerial](https://github.com/yeokm1/SwiftLinuxSerial) which was less Swifty and supported only Linux. This library is thanks largely to [Jay Jun](https://github.com/jayjun). His original pull request can be found [here](https://github.com/yeokm1/SwiftLinuxSerial/pull/1).
 
@@ -9,10 +9,23 @@ This library is an improvement over my previous now deprecated library [SwiftLin
 <a href="https://developer.apple.com/swift"><img src="https://img.shields.io/badge/swift3-compatible-orange.svg?style=flat" alt="Swift 3 compatible" /></a>
 <a href="https://raw.githubusercontent.com/uraimo/SwiftyGPIO/master/LICENSE"><img src="http://img.shields.io/badge/license-MIT-blue.svg?style=flat" alt="License: MIT" /></a>
 
+## Talk on this library
+
+I gave a talk on this library and one of its examples SwiftSerialIM. Click on the links below to see the slides and video.
+
+[![My slides on slideshare](first-slide.png)](http://www.slideshare.net/yeokm1/a-science-project-swift-serial-chat)
+
+[![](http://img.youtube.com/vi/6PWP1eZo53s/0.jpg)](https://www.youtube.com/watch?v=6PWP1eZo53s)
+
 ## Mac OS Preparation
 
 You should have Xcode 8 installed with the command line tools.
 
+To develop app with XCode, enable the App Sandbox capability in Xcode, and under Hardware, select USB. (Mac Apps are sandboxed and you need the USB entitlement.)
+<img src="https://user-images.githubusercontent.com/5688874/55690960-6ff8fb00-5998-11e9-9df6-7e3ebe50e19a.png" alt="Swift 3.0">
+
+
+
 ## Linux System Preparation
 
 Before using this library, I assume you already have Ubuntu installed and fully updated on your system or single-board computer. To get Ubuntu installed on the Raspberry Pi, use this [link](https://wiki.ubuntu.com/ARM/RaspberryPi).
@@ -63,7 +76,7 @@ To get started quickly, you can take a look at my example projects [here](Exampl
 
 ### Example 1: Loopback Test
 
-In order to run this example properly, you need to connect one of your (USB/UART) serial ports in a loopback manner. Basically, you short the TX and RX pins of the serial port.
+In order to run this example properly, you need to connect one of your (USB/UART) serial ports in a loopback manner. Basically, you short the TX and RX pins of the serial port. This library currently only support the `/dev/cu.*` variant on Mac. Read the beginning of the API usage section for more details.
 
 ```bash
 git clone https://github.com/yeokm1/SwiftSerial.git
@@ -79,7 +92,7 @@ sudo ./.build/debug/SwiftSerialExample /dev/ttyUSB0
 #If all goes well you should see a series of messages informing you that data transmitted has been received properly.
 ```
 
-### Example 2: An chat app between 2 machines
+### Example 2: A chat app between 2 machines
 
 In order to run this example properly, you need 2 machines connected by a [null-modem cable](https://en.wikipedia.org/wiki/Null_modem) or 2 USB-Serial adapters with the TX-RX pins connected to each other. Run a copy of my program on both machines.
 
@@ -104,7 +117,7 @@ Add SwiftSerial as a dependency to your project by editing the `Package.swift` f
 let package = Package(
     name: "NameOfMyProject",
     dependencies: [
-        .Package(url: "https://github.com/yeokm1/SwiftSerial.git", majorVersion: 0),
+        .package(url: "https://github.com/yeokm1/SwiftSerial.git", from: "0.1.1"),
         ...
     ]
     ...
@@ -124,7 +137,7 @@ let serialPort: SerialPort = SerialPort(path: portName)
 ```
 Supply the portname that you wish to open like `/dev/ttyUSB0` or `/dev/cu.usbserial`.
 
-For Macs, this library currently only works with the `/dev/cu.*` ports instead of the `/dev/tty.*`. I have enabled blocking on the serial port to prevent high CPU usage which will prevent the `/dev/tty.*` from working. Read more about the differences between the two [here](http://stackoverflow.com/questions/8632586/macos-whats-the-difference-between-dev-tty-and-dev-cu). If there is an problem, open an issue describing your situation and let me look into it.
+For Macs, this library currently only works with the `/dev/cu.*` ports instead of the `/dev/tty.*`. I have enabled blocking on the serial port to prevent high CPU usage which will prevent the `/dev/tty.*` from working. Read more about the differences between the two [here](http://stackoverflow.com/questions/8632586/macos-whats-the-difference-between-dev-tty-and-dev-cu). If there is a problem, open an issue describing your situation and let me look into it.
 
 ### Opening the Serial Port
 
@@ -188,10 +201,15 @@ func readUntilChar(_ terminator: CChar) throws -> String
 ```
 Keep reading until the specified CChar is encountered. Return the string read so far without that value.
 
+```swift
+func readByte() throws -> UInt8
+```
+Read only one byte. This works best if `minimumBytesToRead` has been set to `1` when opening the port. This function internally calls `readBytes()`.
+
 ```swift
 func readChar() throws -> UnicodeScalar
 ```
-Read only one character. This works best if `minimumBytesToRead` has been set to `1` when opening the port. This function internally calls `readBytes()`.
+Read only one character. This works best if `minimumBytesToRead` has been set to `1` when opening the port. This function internally calls `readByte()`.
 
 ### Writing data to the port
 

Sources/SwiftSerial.swift

@@ -209,6 +209,8 @@ public enum PortError: Int32, Error {
     case mustReceiveOrTransmit
     case mustBeOpen
     case stringsMustBeUTF8
+    case unableToConvertByteToCharacter
+    case deviceNotConnected
 }
 
 public class SerialPort {
@@ -371,6 +373,12 @@ extension SerialPort {
             throw PortError.mustBeOpen
         }
 
+        var s: stat = stat()
+        fstat(fileDescriptor, &s)
+        if s.st_nlink != 1 {
+            throw PortError.deviceNotConnected
+        }
+
         let bytesRead = read(fileDescriptor, buffer, size)
         return bytesRead
     }
@@ -378,7 +386,7 @@ extension SerialPort {
     public func readData(ofLength length: Int) throws -> Data {
         let buffer = UnsafeMutablePointer<UInt8>.allocate(capacity: length)
         defer {
-            buffer.deallocate(capacity: length)
+            buffer.deallocate()
         }
 
         let bytesRead = try readBytes(into: buffer, size: length)
@@ -417,13 +425,16 @@ extension SerialPort {
         var data = Data()
         let buffer = UnsafeMutablePointer<UInt8>.allocate(capacity: 1)
         defer {
-            buffer.deallocate(capacity: 1)
+            buffer.deallocate()
         }
 
         while true {
             let bytesRead = try readBytes(into: buffer, size: 1)
 
             if bytesRead > 0 {
+                if ( buffer[0] > 127) {
+                    throw PortError.unableToConvertByteToCharacter
+                }
                 let character = CChar(buffer[0])
 
                 if character == terminator {
@@ -446,22 +457,26 @@ extension SerialPort {
         return try readUntilChar(newlineChar)
     }
 
-    public func readChar() throws -> UnicodeScalar {
+    public func readByte() throws -> UInt8 {
         let buffer = UnsafeMutablePointer<UInt8>.allocate(capacity: 1)
 
         defer {
-            buffer.deallocate(capacity: 1)
+            buffer.deallocate()
         }
 
         while true {
             let bytesRead = try readBytes(into: buffer, size: 1)
 
             if bytesRead > 0 {
-                let character = UnicodeScalar(buffer[0])
+                return buffer[0]
-                return character     
+            }
         }
     }
 
+    public func readChar() throws -> UnicodeScalar {
+        let byteRead = try readByte()
+        let character = UnicodeScalar(byteRead)
+        return character
     }
 
 }
@@ -483,7 +498,7 @@ extension SerialPort {
         let size = data.count
         let buffer = UnsafeMutablePointer<UInt8>.allocate(capacity: size)
         defer {
-            buffer.deallocate(capacity: size)
+            buffer.deallocate()
         }
 
         data.copyBytes(to: buffer, count: size)