From 203cc6b9fb4f49d2e431d6d001d93c531f15cfdf Mon Sep 17 00:00:00 2001 From: Nicholas Orlowsky Date: Tue, 18 Mar 2025 21:39:20 -0400 Subject: [PATCH] update README --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9992303..bd23d92 100644 --- a/README.md +++ b/README.md @@ -9,13 +9,20 @@ vehicle. ## Usage ```rs -use obd2::{commands::Obd2DataRetrieval, device::Elm327, Obd2}; +use obd2::{commands::Obd2DataRetrieval, device::{Elm327, FTDIDevice}, Obd2}; fn main() -> Result<(), obd2::Error> { - let mut device = Obd2::::default(); + let mut device = Obd2::>::new(Elm327::new(FTDIDevice::new()?)?)?; println!("VIN: {}", device.get_vin()?); Ok(()) } ``` +alternatively, you could use a serial port provided by your operating system such as +/dev/ttyUSB0 on unix-like systems + +``` +let mut device = Obd2::>::new(Elm327::new(SerialPort::new("/dev/ttyUSB0")?)?)?; +``` + See the docs for more: https://docs.rs/obd2/