Added license, setup.py and docs for Github.

Author: basilfx

LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2014 Bas Stottelaar
+
+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.

README.md

@@ -0,0 +1,36 @@
+# python-tinylink
+Frame-based streaming protocol for embedded applications.
+
+## Introduction
+This is a Python module to provide a bi-directional frame-based streaming protocol for low-speed embedded applications, such as serial connected devices. It allowes the receiver to 'jump into' a stream of data frames. Every frame starts with a preamble, so the receiver can synchronize. Any mismatch in checksum will the receiver.
+
+A payload is optional. A reserved `RESET` flag can be used to indicate that the link should be reset, for instance when the receiver is ready and the sender restart.
+
+The format of the frame is as follows:
+
+```
+| 0xAA 0x55 0xAA 0x55 | AA AA BB BB CC | XX XX .. .. .. .. XX XX YY YY YY YY |
+| Preamble            | Header         | Body (optional)                     |
+
+Fields:
+A = Length
+B = Flags
+C = XOR checksum over header
+X = Body payload (max. 65536 bytes)
+Y = CRC32 checksum over header + body
+```
+
+Error correction is not implemented by this protocol and the bytes are not aligned. The endianness is customizable.
+
+## Statechart diagram
+Below is a simplified statechart diagram of the protocol.
+![Alt text](docs/statechart.png)
+
+## Installation
+The latest development version can be installed via `pip install git+https://github.com/basilfx/python-tinylink`.
+
+## Tests
+Tests can be executed with `nose`. Check the `tests/` folder for more information.
+
+## License
+See the `LICENSE` file (MIT license).

docs/statechart.dot

@@ -0,0 +1,31 @@
+digraph G {
+    rankdir=TD
+    edge[fontsize="11" arrowhead=open]
+
+    start[shape=circle, style=filled, label=""]
+
+    waiting_for_preamble[shape=box, style=rounded, label="Waiting for\npreamble"]
+    receiving_header[shape=box, style=rounded, label="Receiving\nheader"]
+    receiving_body[shape=box, style=rounded, label="Receiving\nbody"]
+
+    output_reset_frame[shape=box, style=rounded, label="Output\nreset frame"]
+    output_data_frame[shape=box, style=rounded, label="Output\ndata frame"]
+
+    start -> waiting_for_preamble
+
+    waiting_for_preamble -> waiting_for_preamble[label="Byte received"]
+    waiting_for_preamble -> receiving_header[label="Preamble detected"]
+
+    receiving_header -> receiving_header[label="Byte received"]
+    receiving_header -> receiving_body[label="Header complete,\nbody expected"]
+    receiving_header -> waiting_for_preamble[label="Header invalid"]
+
+    receiving_header -> output_reset_frame[label="Header complete,\nreset frame"]
+    output_reset_frame -> waiting_for_preamble
+
+    receiving_body -> receiving_body[label="Byte received"]
+    receiving_body -> waiting_for_preamble[label="Body invalid"]
+
+    receiving_body -> output_data_frame[label="Body complete,\ndata frame"]
+    output_data_frame -> waiting_for_preamble
+}

docs/statechart.png

@@ -0,0 +1,23 @@
+from setuptools import setup
+
+# Setup definitions
+setup(
+    name="python-tinylink",
+    version="1.0",
+    description="Streaming frame protocol library for embedded applications.",
+    author="Bas Stottelaar",
+    author_email="basstottelaar@gmail.com",
+    py_modules=["tinylink"],
+    license = "MIT",
+    keywords = "python embedded arm tinylink streaming serial",
+    test_suite="tests",
+    classifiers = [
+        "Development Status :: 5 - Production/Stable",
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: MIT License",
+        "Topic :: System :: Networking",
+        "Topic :: Software Development :: Embedded Systems",
+        "Programming Language :: Python :: 2",
+        "Programming Language :: Python :: 2.7",
+    ],
+)