mpr121-hal 0.5.0

MPR121 proximity capacitive touch sensor controller hal driver implementation.
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
65
66
67
68
69
70
71
72
73
74

# MPR121-hal

<!-- markdown-link-check-disable -->
[![crates.io](https://img.shields.io/crates/v/mpr121-hal.svg)](https://crates.io/crates/mpr121-hal)
<!-- markdown-link-check-enable -->
[![docs.rs](https://img.shields.io/docsrs/mpr121-hal?style=plastic)](https://docs.rs/mpr121-hal/latest/)
 [![MegaLinter](https://github.com/SiebenCorgie/mpr121-hal/actions/workflows/mega-linter.yaml/badge.svg)](https://github.com/SiebenCorgie/mpr121-hal/actions/workflows/mega-linter.yaml) [![Continuous Build](https://github.com/SiebenCorgie/mpr121-hal/actions/workflows/continuous-build.yaml/badge.svg?branch=main)](https://github.com/SiebenCorgie/mpr121-hal/actions/workflows/continuous-build.yaml)

[![dependency status](https://deps.rs/repo/gitlab/tendsinmende/mpr121-hal/status.svg)](https://deps.rs/repo/gitlab/tendsinmende/mpr121-hal)

[Mpr121](https://www.nxp.com/docs/en/data-sheet/MPR121.pdf) proximity capacitive touch sensor controller driver.
Used for instance on the [Adafruit Mpr121 module](https://www.adafruit.com/product/1982).

## Overview
<!-- markdown-link-check-disable -->
The crate uses the [embeded-hal](https://crates.io/crates/embedded-hal) crate to provided a generic implementation for multiple HALs alongside [embedded-hal-async](https://crates.io/crates/embedded-hal-async) for async support.
It uses [maybe-async](https://crates.io/crates/maybe-async) to provide a single API for both sync and async implementations.
Simply use either the `sync` or `async` feature to enable the desired implementation.
If both features are enabled cargo will fail to compile the project.
<!-- markdown-link-check-enable -->

The implementation provides a similar API to the C++ Adafruit library.
It should work with similar boards using the Mpr121 as well.

## Examples

Within the [examples](./examples/) directory there is an [ESP32S3](https://esp32s3.com/tinys3.html) example using the [MPR121 Adafruit Breakout Board](https://www.adafruit.com/product/1982) and the [Embassy Framework](https://github.com/embassy-rs/embassy) that runs in complete Async.

There is a [Simple Sync Script](./examples/os_sync_basic.rs) that runs on Mac/Linux using a [FTD232H I2C Adapter](https://shop.pimoroni.com/products/adafruit-ft232h-breakout-general-purpose-usb-to-gpio-spi-i2c?variant=1004798821) that uses the library in Synchronous mode.
You may need to Install the following sys dependencies to run the sync example.
You do not need any sys dependencies for the esp32 example or to use the driver on any other platform:

### MacOS

```bash
brew install libusb
brew install libftdi
```

### Linux

```bash
sudo apt update
sudo apt install libftdi1 libftdi1-dev
```

Then to run the example do the following:

```bash
cargo run --example os_sync_basic --no-default-features --features sync
```

More information on this can be found [here](https://github.com/dysonltd/tmag5273/blob/main/examples/README.md).

## Development

If you want to extend this crate, have a look at the [development notes](DEVELOPMENT.md) on how to get started with testing and linting the project.

## 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.

### Contributing

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.