diff options
| author | Jakob Odersky <jodersky@gmail.com> | 2013-02-27 16:18:02 +0100 |
|---|---|---|
| committer | Jakob Odersky <jodersky@gmail.com> | 2013-02-27 16:18:02 +0100 |
| commit | 5b00baec28e8e7976636df86f30bc3a6412f8203 (patch) | |
| tree | 0611676f6db1f9a2253cd6510a90ed9b951fee2d | |
| parent | 8f2c29b19fae18076a872326f3d947b74920c5e9 (diff) | |
| download | ace-5b00baec28e8e7976636df86f30bc3a6412f8203.tar.gz ace-5b00baec28e8e7976636df86f30bc3a6412f8203.tar.bz2 ace-5b00baec28e8e7976636df86f30bc3a6412f8203.zip | |
add README
| -rw-r--r-- | README.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..e48073d --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# Arduino Communication protocol, Ensured (ACE) + +The purpose of the Arduino Communication protocol, Ensured (ACE) is to provide reliable and reactive communication between a micro controller and a computer (or two micro controllers). The main features of the protocol are reliability, in a sense that the communicating parties know if a sent message was received or not, and reactivity, i.e. the main program loop is not blocked whilst waiting for a message response. + +This project contains two reference implementations of ACE: the first, written in C is designed to be run on an Arduino; the second, written in Scala is designed to be run a computer. See the specification and the implementations for additional information. + +## License +Copyright (c) 2013 Jakob Odersky +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions +are met: +1. Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. +2. Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. +3. The name of the author may not be used to endorse or promote products + derived from this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |