https://github.com/dbrgn/shtcx-rs
Platform agnostic Rust driver for the Sensirion SHTCx temperature/humidity sensors.
https://github.com/dbrgn/shtcx-rs
Last synced: 10 months ago
JSON representation
Platform agnostic Rust driver for the Sensirion SHTCx temperature/humidity sensors.
- Host: GitHub
- URL: https://github.com/dbrgn/shtcx-rs
- Owner: dbrgn
- License: apache-2.0
- Created: 2019-12-26T15:04:33.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-05-13T11:47:51.000Z (about 2 years ago)
- Last Synced: 2025-01-11T18:46:52.990Z (over 1 year ago)
- Language: Rust
- Size: 212 KB
- Stars: 13
- Watchers: 6
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# Rust SHTCx / SHTWx Driver
[![Build status][workflow-badge]][workflow]
[![Crates.io Version][crates-io-badge]][crates-io]
[![Crates.io Downloads][crates-io-download-badge]][crates-io-download]
![No Std][no-std-badge]
This is a platform agnostic Rust driver for the Sensirion SHTCx and SHTWx
temperature / humidity sensor series, based on the
[`embedded-hal`](https://github.com/rust-embedded/embedded-hal) traits.
Tested with the following sensors:
- [SHTC1](https://www.sensirion.com/shtc1/)
- [SHTC3](https://www.sensirion.com/shtc3/)
- [SHTW2](https://www.sensirion.com/shtw2/)
Docs: https://docs.rs/shtcx
## The Device
The Sensirion SHTCx series offers low-power high-precision digital temperature
and humidity sensors that communicate over the I²C bus.
The SHTWx series uses the same protocol, but in a wafer-level chip-scale
package (WLCSP).
## Status
- [x] Measure temperature and humidity
- [x] Get device identifier
- [x] Sleep / Wakeup commands
- [x] Soft reset command
- [x] Support for low power mode
- [x] CRC checks
- [x] Docs
## Examples
There are a few examples in the `examples` directory: The `linux-`
example queries the sensor a few times using `linux-embedded-hal`, while the
`monitor-` example implements a terminal based real-time graphical
temperature/humidity monitoring tool.
## 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.
[workflow]: https://github.com/dbrgn/shtcx-rs/actions?query=workflow%3ACI
[workflow-badge]: https://img.shields.io/github/actions/workflow/status/dbrgn/shtcx-rs/ci.yml?branch=main
[crates-io]: https://crates.io/crates/shtcx
[crates-io-badge]: https://img.shields.io/crates/v/shtcx.svg?maxAge=3600
[crates-io-download]: https://crates.io/crates/shtcx
[crates-io-download-badge]: https://img.shields.io/crates/d/shtcx.svg?maxAge=3600
[no-std-badge]: https://img.shields.io/badge/no__std-yes-blue