vato007/SwiftSerial
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Yeo Kheng Meng
2016-10-29 17:48:52 +08:00
committed by GitHub
parent e73ea6056d
commit 3e4b905e7b
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -166,6 +166,11 @@ func readUntilChar(_ terminator: CChar) throws -> String
``` ```
Keep reading until the specified CChar is encountered. Return the string read so far without that value. Keep reading until the specified CChar is encountered. Return the string read so far without that value.
```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()`.
### Writing data to the port ### Writing data to the port
There are several functions you can use to write data. All functions here are blocking till all the data has been written. All functions can throw `PortError.mustBeOpen`. There are several functions you can use to write data. All functions here are blocking till all the data has been written. All functions can throw `PortError.mustBeOpen`.
@@ -185,6 +190,11 @@ func writeBytes(from buffer: UnsafeMutablePointer<UInt8>, size: Int) throws -> I
``` ```
Function for those that want to mess with unsafe pointers. You have to specify how many bytes have to be written. Will return how many bytes actually written. Function for those that want to mess with unsafe pointers. You have to specify how many bytes have to be written. Will return how many bytes actually written.
```swift
func writeChar(_ character: UnicodeScalar) throws -> Int{
```
Writes only one character. Will return `1` if successful. This function internally calls `writeString()`. Pull requests for a better way of doing this is appreciated.
### Closing the port ### Closing the port
Just do `serialPort.closePort()` to close the port once you are done using it. Just do `serialPort.closePort()` to close the port once you are done using it.