mcp2210 0.2.0

Microchip MCP2210 communication library
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

<!--
SPDX-FileCopyrightText: 2018-2022 Joonas Javanainen <joonas.javanainen@gmail.com>

SPDX-License-Identifier: CC0-1.0
-->

# mcp2210-rs: Microchip MCP2210 library

Minimum Rust version: 1.63

[MCP2210 datasheet](http://ww1.microchip.com/downloads/en/devicedoc/22288a.pdf)

[![Build Status](https://github.com/Gekkio/mcp2210-rs/actions/workflows/ci/badge.svg)](https://github.com/Gekkio/mcp2210-rs/actions)
[![Latest release on crates.io](https://img.shields.io/crates/v/mcp2210.svg)](https://crates.io/crates/mcp2210)
[![Documentation on docs.rs](https://docs.rs/mcp2210/badge.svg)](https://docs.rs/mcp2210)

To use `mcp2210`, you'll need to add it and `hidapi` to your dependencies.

```bash
cargo add mcp2210 hidapi
```

### ⚠️ WARNING: This code sends 0xaa55 on the MCP2210's SPI bus. If you have a device connected to the SPI bus, ensure this will not harm it. ⚠️

This code sends 0xaa55 on the MCP2210's SPI bus MOSI pin and asserts that the same data is simultaneously recieved at the MISO pin. The circuit required for this is simply a wire between the MOSI and MISO pins of the MCP2210 and no real slave device.

```rust
use hidapi::HidApi;
use mcp2210::{open_first, Commands, SpiMode, SpiTransferSettings};

fn main() {
    let hidapi_context = HidApi::new().expect("Could not create hidapi context");
    let mut mcp = open_first(&hidapi_context).expect("Failed to connect");
    mcp.set_spi_transfer_settings(&SpiTransferSettings {
        bit_rate: 1_000,
        bytes_per_tx: 2,
        spi_mode: SpiMode::Mode0,
        ..Default::default()
    })
    .expect("Failed to set settings");
    let mut buf = Vec::new();
    mcp.spi_transfer_to_end(&[0xaa, 0x55], &mut buf)
        .expect("SPI transfer failed");
    assert_eq!(buf, [0xaa, 0x55]);
}
```

## License

Licensed under either of

 * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
 * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

at your option.

### Contribution

Unless you explicitly state otherwise, any contribution intentionally
submitted for inclusion in the work by you, as defined in the Apache-2.0
license, shall be dual licensed as above, without any additional terms or
conditions.