Skip to content

Commit

Permalink
editing README
Browse files Browse the repository at this point in the history
  • Loading branch information
Dennis Evangelista committed Nov 14, 2018
1 parent 259c84e commit 9d66a3e
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,20 @@
# spektrum
# spektrum
### Dennis Evangelista
This library provides mbed support for Spektrum serial receivers.

## Obtaining the library
Source code is revision controlled using Git and hosted in a Github repository.
```bash
git clone ssh://git@github.com/devangel77b/spektrum.git
git pull
```
The ```dev``` branch is bleeding edge; ```master``` branch is reasonably up to date.

## Using the library
The main part of the library are two classes for Spektrum (receiver) and BindPlug, which allows binding a transmitter to the receiver. In addition, a convenience function for converting 0-2048 values to PwmOut pulsewidths (600-2100us, centered at 900us) is provided (```spektrum_us()```).

## Contributors
D Evangelista

## Acknowledgements
The code is based on an earlier Spektrum code by (that german guy).

0 comments on commit 9d66a3e

Please sign in to comment.