Reorganize commands module

This commit is contained in:
Robert Sammelson 2023-05-17 21:09:42 -04:00
parent cd0242b796
commit 61dba62f5d
No known key found for this signature in database
GPG key ID: 92F1F04EDB06B9E9
3 changed files with 87 additions and 74 deletions

42
src/commands/mod.rs Normal file
View file

@ -0,0 +1,42 @@
//! High level OBD-II interface
mod implementation;
mod types;
pub use types::{Dtc, DtcsInfo};
use crate::Result;
/// Trait for devices that can retrieve data over OBD-II
///
/// Automatically implemented for implementors of [Obd2Device](crate::Obd2Device).
pub trait Obd2DataRetrieval: private::Sealed {
/// Check which getters are supported by the current vehicle
// fn get_support() -> Obd2FunctionSupport;
/// Retreive the VIN (vehicle identification number)
///
/// This should match the number printed on the vehicle, and is a good command for checking
/// that the OBD-II interface is working correctly.
fn get_vin(&mut self) -> Result<String>;
/// Get DTC (diagnostic trouble code) metadata for each ECU
fn get_dtc_info(&mut self) -> Result<Vec<DtcsInfo>>;
/// Get DTCs for each ECU
fn get_dtcs(&mut self) -> Result<Vec<Vec<Dtc>>>;
/// Get the calculated engine
// fn get_engine_load(&mut self) -> Result<u8>;
/// Get the RPM in increments of 0.25
fn get_rpm(&mut self) -> Result<f32>;
/// Get the speed in km/h
fn get_speed(&mut self) -> Result<u8>;
}
mod private {
pub trait Sealed {}
impl<T: crate::Obd2Device> Sealed for T {}
}