Reorganize commands module

src/commands/implementation.rs

@@ -1,31 +1,6 @@
-//! High level OBD-II interface
+use crate::{commands::Obd2DataRetrieval, Error, Obd2Device, Result};
 
-use std::fmt;
-
-use crate::{Error, Obd2Device, Result};
-
-/// Trait for devices that can retrieve data over OBD-II
-///
-/// Automatically impelemted for implementors of [Obd2Device].
-pub trait Obd2DataRetrieval: private::Sealed {
-    /// 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 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>;
-}
+use super::{Dtc, DtcsInfo};
 
 impl<T: Obd2Device> Obd2DataRetrieval for T {
     fn get_vin(&mut self) -> Result<String> {
@@ -106,50 +81,3 @@ impl<T: Obd2Device> Obd2DataRetrieval for T {
         Ok(self.obd_command_cnt_len::<1, 1>(0x01, 0x0C)?[0][0])
     }
 }
-
-/// DTC (diagnostic trouble code) metadata
-#[derive(Debug)]
-#[non_exhaustive]
-pub struct DtcsInfo {
-    /// Whether the "check engine" light is illuminated
-    pub malfunction_indicator_light: bool,
-
-    /// Number of DTCs for this ECU
-    pub dtc_count: u8,
-
-    /// Bit field showing availability of seven common tests; the upper bit is currently unused.
-    pub common_test_availability: u8,
-
-    /// Whether the engine is Diesel
-    pub is_compression_engine: bool,
-
-    /// Bit field showing availability of sixteen engine-specific tests. What the tests are is
-    /// based on the value of `is_compression_engine`.
-    pub specific_test_availability: u16,
-}
-
-/// An individual trouble code from an ECU
-#[derive(Debug)]
-pub enum Dtc {
-    Powertrain(u16),
-    Chassis(u16),
-    Body(u16),
-    Network(u16),
-}
-
-impl fmt::Display for Dtc {
-    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        let (c, n) = match self {
-            Self::Powertrain(n) => ('P', n),
-            Self::Chassis(n) => ('C', n),
-            Self::Body(n) => ('B', n),
-            Self::Network(n) => ('U', n),
-        };
-        f.write_fmt(format_args!("{}{:03X}", c, n))
-    }
-}
-
-mod private {
-    pub trait Sealed {}
-    impl<T: super::Obd2Device> Sealed for T {}
-}

src/commands/mod.rs

@@ -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 {}
+}

src/commands/types.rs

@@ -0,0 +1,43 @@
+use std::fmt;
+
+/// DTC (diagnostic trouble code) metadata
+#[derive(Debug)]
+#[non_exhaustive]
+pub struct DtcsInfo {
+    /// Whether the "check engine" light is illuminated
+    pub malfunction_indicator_light: bool,
+
+    /// Number of DTCs for this ECU
+    pub dtc_count: u8,
+
+    /// Bit field showing availability of seven common tests; the upper bit is currently unused.
+    pub common_test_availability: u8,
+
+    /// Whether the engine is Diesel
+    pub is_compression_engine: bool,
+
+    /// Bit field showing availability of sixteen engine-specific tests. What the tests are is
+    /// based on the value of `is_compression_engine`.
+    pub specific_test_availability: u16,
+}
+
+/// An individual trouble code from an ECU
+#[derive(Debug)]
+pub enum Dtc {
+    Powertrain(u16),
+    Chassis(u16),
+    Body(u16),
+    Network(u16),
+}
+
+impl fmt::Display for Dtc {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        let (c, n) = match self {
+            Self::Powertrain(n) => ('P', n),
+            Self::Chassis(n) => ('C', n),
+            Self::Body(n) => ('B', n),
+            Self::Network(n) => ('U', n),
+        };
+        f.write_fmt(format_args!("{}{:03X}", c, n))
+    }
+}