# Serial Communication Library for android

This is the android support for Cross-platform, Serial Port library.

<big>The android library is not strictly tested. You should test it yourself and handle any issue.</big>

### Documentation

Website: http://wjwwood.github.com/serial/

Native API Documentation: http://wjwwood.github.com/serial/doc/1.1.0/index.html
Java API Documentation: See android/doc

### Dependencies

To build the lib:
* NDK r10 (http://developer.android.com/intl/zh-cn/ndk/downloads/index.html)

To open the sample project:
* Android Studio 1.5

### Install

Get the code:

    git clone https://github.com/chzhong/serial.git

Build:

    cd android/library/src/main/jni
    ndk-build

Use:

Copy android/library to your project folder a reference it as a library project.
See android/sample for an example.

### License

The MIT License

Copyright (c) 2012 William Woodall, John Harrison

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

### Authors

William Woodall <wjwwood@gmail.com>
John Harrison <ash.gti@gmail.com>

### Contact

William Woodall <william@osrfoundation.org>
