Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Former-commit-id: 0ad1709
  • Loading branch information
bakercp committed Jul 11, 2014
1 parent e30f820 commit 2b9cf3c
Showing 1 changed file with 28 additions and 7 deletions.
35 changes: 28 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,34 @@
ofxSerial
=========

An alternative serial object for openFrameworks.
A serial addon for openFrameworks.

Tested and working on:
## Features
- Full Port configuration via [SerialDevice](https://github.com/bakercp/ofxSerial/blob/master/libs/ofxSerial/include/ofx/IO/SerialDevice.h)
- baud rate
- data bits
- parity
- stop bits
- Full Flow Control
- CTS get / set
- DSR get / set
- RI get / set
- CD get / set
- Read/write blocking control via custom timeouts.
- Event-driven serial via [BufferedSerial](https://github.com/bakercp/ofxSerial/blob/master/libs/ofxSerial/include/ofx/IO/BufferedSerialDevice.h) class.
- Packet-based serial system with byte stuffing via [PacketSerialDevice](https://github.com/bakercp/ofxSerial/blob/master/libs/ofxSerial/include/ofx/IO/PacketSerialDevice.h)
- Cross-platform compatibility.
- Tested on:
- OSX
- Windows Visual Studio
- Windows Codeblocks / MinGW
- Linux
- Robust Cross-platform port listing.

- OSX
- Windows Visual Studio
- Windows Codeblocks / MinGW
- Linux
- Arduino Examples for sanity testing.

Requires https://github.com/bakercp/ofxIO
## Requirements
- https://github.com/bakercp/ofxIO

## Built With
- https://github.com/wjwwood/serial

0 comments on commit 2b9cf3c

Please sign in to comment.