ecu_diagnostics 0.105.0

A rust crate for ECU diagnostic servers and communication APIs
//!  Provides methods to reset the ECU in order to simulate power cycling and resetting memory regions
//!
use crate::{
    dynamic_diag::{DynamicDiagSession, EcuNRC},
    DiagError, DiagServerResult,
};

pub use automotive_diag::uds::ResetType;
use automotive_diag::uds::{UdsCommand, UdsError};
use automotive_diag::ByteWrapper::Standard;

impl DynamicDiagSession {
    /// Asks the ECU to perform a hard reset. See [ResetType::HardReset] for more details
    ///
    /// ## Parameters
    /// * server - The UDS Diagnostic server
    pub fn uds_ecu_hard_reset(&self) -> DiagServerResult<()> {
        self.send_command_with_response(UdsCommand::ECUReset, &[ResetType::HardReset.into()])?;
        Ok(())
    }

    /// Asks the ECU to perform a key off/on reset. See [ResetType::KeyOffReset] for more details
    ///
    /// ## Parameters
    /// * server - The UDS Diagnostic server
    pub fn uds_ecu_key_off_on_reset(&self) -> DiagServerResult<()> {
        self.send_command_with_response(UdsCommand::ECUReset, &[ResetType::KeyOffReset.into()])?;
        Ok(())
    }

    /// Asks the ECU to perform a soft reset. See [ResetType::SoftReset] for more details
    ///
    /// ## Parameters
    /// * server - The UDS Diagnostic server
    pub fn uds_ecu_soft_reset(&self) -> DiagServerResult<()> {
        self.send_command_with_response(UdsCommand::ECUReset, &[ResetType::SoftReset.into()])?;
        Ok(())
    }

    /// Asks the ECU to enable rapid power shutdown mode. See [ResetType::EnableRapidPowerShutDown] for more details
    ///
    /// ## Parameters
    /// * server - The UDS Diagnostic server
    ///
    /// ## Returns
    /// If successful, this function will return the minimum time in seconds that the ECU will remain in the power-down sequence
    pub fn uds_enable_rapid_power_shutdown(&self) -> DiagServerResult<u8> {
        let res = self.send_command_with_response(
            UdsCommand::ECUReset,
            &[ResetType::EnableRapidPowerShutDown.into()],
        )?;
        match res.get(2) {
            Some(&time) if time == 0xFF => Err(DiagError::ECUError {
                code: UdsError::GeneralReject.into(),
                def: Some(Standard(UdsError::GeneralReject).desc()),
            }), // General reject
            Some(&time) => Ok(time),
            None => Err(DiagError::InvalidResponseLength),
        }
    }

    /// Asks the ECU to disable rapid power shutdown mode
    ///
    /// ## Parameters
    /// * server - The UDS Diagnostic server
    pub fn uds_disable_rapid_power_shutdown(&self) -> DiagServerResult<()> {
        self.send_command_with_response(
            UdsCommand::ECUReset,
            &[ResetType::DisableRapidPowerShutDown.into()],
        )?;
        Ok(())
    }
}