forked from copterust/bmp280
-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: update README to include MSRV and features
Signed-off-by: Lachezar Lechev <[email protected]>
- Loading branch information
Showing
2 changed files
with
14 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -12,7 +12,7 @@ Include [library](https://crates.io/crates/bmp388) as a dependency in your Cargo | |
version = "<version>" | ||
``` | ||
|
||
Use embedded-hal implementation to get I2C handle and delay then create bmp388 handle: | ||
Use [`embedded-hal`](https://crates.io/crates/embedded-hal) implementation to get I2C handle and delay then create bmp388 handle: | ||
|
||
```rust | ||
extern crate bmp388; // or just use bmp388; if 2018 edition is used. | ||
|
@@ -24,10 +24,22 @@ let pres = ps.sensor_values(); | |
println!("{:?}", pres); | ||
``` | ||
|
||
|
||
## Documentation | ||
|
||
API Docs available on [docs.rs](https://docs.rs/bmp388). | ||
|
||
## Features | ||
|
||
- default: none enabled by default | ||
- `defmt-03` - enable [`[email protected]`](crates.io/crates/defmt) formatting for structs and enums | ||
- `serde` - enable [`serde`](crates.io/crates/serde) Deserialize and Serialize implementations on structs and enums | ||
- `asynch` - enable [`embedded-hal-async`](https://crates.io/crates/embedded-hal-async) implementation for the Asynchronous API. | ||
- `config-builder` - enable the typed config builder `ConfigBuilder` for setting up the sensor and initializing it. | ||
|
||
## Minimum supported Rust version (MSRV) | ||
For the blocking API the MSRV is `1.65`, however, for the asynchronies API, enabled with the feature `asynch`, the MSRV is `1.75`. | ||
|
||
## ToDo: | ||
|
||
* Implement FiFo Buffer support | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters