An cross platform Serial library for openFrameworks.
Clone or download
Latest commit 4c93f1f Jun 2, 2018

README.md

ofxSerial

Description

A cross-platform serial addon for openFrameworks wrapping the Serial Communication Library.

Features

  • Full Port configuration via SerialDevice
    • 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 class.
  • Packet-based serial system with byte stuffing via PacketSerialDevice
    • SLIP, COBS and others packet encoding supported.
  • Cross-platform compatibility.
    • Tested on:
      • OSX
      • Windows Visual Studio
      • Windows Codeblocks / MinGW / MSYS
      • Linux
  • Robust Cross-platform port listing.
  • Arduino Examples for sanity testing.

Required Addons

  • ofxPoco (included in openFrameworks)
  • ofxIO

Getting Started

To get started, generate the example project files using the openFrameworks Project Generator.

Documentation

API documentation can be found here.

Build Status

Linux, macOS Build Status

Visual Studio, MSYS Build status

Compatibility

The stable branch of this repository is meant to be compatible with the openFrameworks stable branch, which corresponds to the latest official openFrameworks release.

The master branch of this repository is meant to be compatible with the openFrameworks master branch.

Some past openFrameworks releases are supported via tagged versions, but only stable and master branches are actively supported.

Versioning

This project uses Semantic Versioning, although strict adherence will only come into effect at version 1.0.0.

Licensing

See LICENSE.md.

Contributing

Check out the Help Wanted tag in the issues section for specific ideas or propose your own new ideas.

Pull Requests are always welcome, so if you make any improvements please feel free to float them back upstream :)

  1. Fork this repository.
  2. Create your feature branch (git checkout -b my-new-feature).
  3. Commit your changes (git commit -am 'Add some feature').
  4. Push to the branch (git push origin my-new-feature).
  5. Create new Pull Request.