manchester-code 0.1.0

A no-std library to allow Manchester encoding and decoding of datagrams.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

# Manchester Encoding and Decoding

[![crates.io](https://img.shields.io/crates/v/manchester-code?style=flat-square&logo=rust)](https://crates.io/crates/manchester-code)
[![docs.rs](https://img.shields.io/badge/docs.rs-manchester--code-blue?style=flat-square)](https://docs.rs/manchester-code)
[![license](https://img.shields.io/badge/license-MIT-blue?style=flat-square-blue)](#license)
[![rustc](https://img.shields.io/badge/rustc-1.52+-blue?style=flat-square&logo=rust)](https://www.rust-lang.org)
[CI status](https://github.com/almedso/manchester-code/actions/workflows/ci.yml/badge.svg)


A `no-std` library to allow Manchester encoding and decoding of datagrams.
It requires certain deep embedded resources like timers, PWM and ISR's.


## Features

* Decode monotonically sampled data stream that is Manchester modulated
  like it is used in RC5
  * High/low IN-Activitity configuration
  * Zero or one first bit configuration
  * Big endian/ little endian configuration
  * Automatic start and end of datagram detection
  * Requires a periodic timer
* Encode
  * Big endian/ little endian configuration
  * Requires a timer ISR and a PWM (single channel)


## Example

* Check the [documentation](https://docs.rs/manchester-code)

## License

This project is licensed under

- MIT License ([`LICENSE.md`](LICENSE.md) or
  [online](https://opensource.org/licenses/MIT))

## Contributing

Your PRs and suggestions are always welcome.


### Future Work

* defmt optional
* fmt optional
* async as stream
* ci + readme reporting
* publish