ashv2 1.2.9

Implementation of the Asynchronous Serial Host (ASH) protocol.
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
51
52
53
54
55
56
57
58
59
60
61
62
63
64

# ashv2

Asynchronous Serial Host protocol, version 2

## Documentation

The official protocol description can be found
at [silabs.com](https://www.silabs.com/documents/public/user-guides/ug101-uart-gateway-protocol-reference.pdf).

## Usage

This library provides the struct `Transceiver` which implements the ASHv2 protocol.

It is to be initialized with the underlying serial port and the request and response channels used so send and receive
data via the ASHv2 protocol.

```rust
use std::sync::Arc;
use std::sync::atomic::AtomicBool;
use std::thread::spawn;

use ashv2::Transceiver;
use serialport;
use tokio::sync::mpsc;

#[tokio::main]
async fn main() {
    let (request_tx, request_rx) = mpsc::channel(32);
    let (response_tx, mut response_rx) = mpsc::channel(32);

    let serial_port = serialport::new("/dev/ttyUSB0", 115200)
        .open()
        .expect("Failed to open serial port");

    let mut transceiver = Transceiver::new(serial_port, request_rx, response_tx);
    spawn(|| transceiver.run(Arc::new(AtomicBool::new(true))));

    // Example: Sending a request
    let request_data = vec![0x01, 0x02, 0x03];
    request_tx
        .send(request_data.into_iter().collect())
        .await
        .expect("Failed to send request");

    // Example: Receiving a response
    if let Some(response) = response_rx.recv().await {
        println!("Received response: {:?}", response);
    }
}
```

## Legal

This project is free software and is not affiliated with Siliconlabs.

## Contribution guidelines

* Use `cargo fmt`
* Check code with `cargo clippy`

## Credits

* Special thanks to *Simon Farnsworth*, *Kevin Reid* and the rest of the great community
  at [users.rust-lang.org](https://users.rust-lang.org/).