Add README

This commit is contained in:
Robert Sammelson 2023-05-20 00:20:46 -04:00
parent 344f159170
commit 3d7c88b4cb
No known key found for this signature in database
GPG key ID: 92F1F04EDB06B9E9

21
README.md Normal file
View file

@ -0,0 +1,21 @@
# `obd2`
This library provides a user-friendly interface to automatically configure an
[ELM327](https://github.com/rsammelson/obd2/blob/master/docs/ELM327DSH.pdf)
[OBD-II](https://en.wikipedia.org/wiki/OBD-II) to UART interface through an FTDI UART to USB interface (the entire
setup is easily available online as an OBD-II to USB interface), and then send commands and receive data from a
vehicle.
## Usage
```rs
use obd2::{commands::Obd2DataRetrieval, device::Elm327, Obd2};
fn main() -> Result<(), obd2::Error> {
let mut device = Obd2::<Elm327>::default();
println!("VIN: {}", device.get_vin()?);
Ok(())
}
```
See the docs for more: https://docs.rs/obd2/