Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rust-embedded/rust-i2cdev

Rust library for interfacing with i2c devices under Linux
https://github.com/rust-embedded/rust-i2cdev

embedded i2c i2c-bus linux rust

Last synced: 3 days ago
JSON representation

Rust library for interfacing with i2c devices under Linux

Awesome Lists containing this project

README 

        
# Rust I2cdev



[![Build Status](https://github.com/rust-embedded/rust-i2cdev/workflows/CI/badge.svg)](https://github.com/rust-embedded/rust-i2cdev/actions)

[![Version](https://img.shields.io/crates/v/i2cdev.svg)](https://crates.io/crates/i2cdev)

[![License](https://img.shields.io/crates/l/i2cdev.svg)](https://github.com/rust-embedded/rust-i2cdev/blob/master/README.md#license)

![Minimum Supported Rust Version](https://img.shields.io/badge/rustc-1.60+-blue.svg)



[Documentation](https://docs.rs/i2cdev)



The Rust `i2cdev` crate seeks to provide full access to the Linux i2cdev

driver interface in Rust without the need to wrap any C code or directly make

low-level system calls.  The documentation for the i2cdev interace can

be found at https://www.kernel.org/doc/Documentation/i2c/dev-interface and

in the [lm-sensors projects](http://www.lm-sensors.org/).



Device driver developers should consider building on top of the

[embedded-hal](https://crates.io/crates/embedded-hal) traits rather than

directly coupling to this library. An implementation of those generic traits for

Linux can be found in

[linux-embedded-hal](https://crates.io/crates/linux-embedded-hal) which, at

present, uses this crate as the backend for I2C.



## Example/API



The source includes an example of using the library to talk to a Wii

Nunchuck (which has an i2c interface).

[Go View the Example](https://github.com/rust-embedded/rust-i2cdev/blob/master/examples/nunchuck.rs).



The [Documentation](https://docs.rs/i2cdev) contains a quick overview of how to get started with an i2c device.



In addition to the Read/Write traits, the following methods are

available via the [I2CDevice trait](https://rust-embedded.github.io/rust-i2cdev/i2cdev/core/trait.I2CDevice.html).



## Features



The following features are implemented and planned for the library:



- [x] Implement the Read trait

- [x] Implement the Write trait

- [x] Implement SMBus Methods

- [x] Add Tests/Example for SMBus Methods

- [x] Add sensor library for handy sensors (and examples)

- [ ] Add higher-level APIs/Macros for simplifying access to devices

      with large register sets

- [ ] Add Support for Non-SMBus ioctl methods

- [ ] Add examples for non-smbus ioctl methods

- [ ] Unit Testing



## Cross Compiling



Most likely, the machine you are running on is not your development

machine (although it could be).  In those cases, you will need to

cross-compile.  See  for pointers.



## Minimum Supported Rust Version (MSRV)



This crate is guaranteed to compile on stable Rust 1.65.0 and up. It *might*

compile with older versions but that may change in any new patch release.



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



## Code of Conduct



Contribution to this crate is organized under the terms of the [Rust Code of

Conduct][CoC], the maintainer of this crate, the [Embedded Linux Team][team], promises

to intervene to uphold that code of conduct.



[CoC]: CODE_OF_CONDUCT.md

[team]: https://github.com/rust-embedded/wg#the-embedded-linux-team