Struct mcp3425::Voltage

pub struct Voltage { /* private fields */ }

A voltage measurement.

Implementations

impl Voltage

pub fn from_millivolts(millivolts: i16) -> Self

Create a new Voltage instance from a millivolt measurement.

Examples found in repository

src/lib.rs (line 514)

    fn calculate_voltage(
        &self,
        measurement: i16,
        resolution: &Resolution,
    ) -> Result<Voltage, Error<E>> {
        // Handle saturation / out of range values
        if measurement == resolution.max() {
            return Err(Error::VoltageTooHigh);
        } else if measurement == resolution.min() {
            return Err(Error::VoltageTooLow);
        }

        let converted =
            measurement as i32 * (REF_MILLIVOLTS * 2) as i32 / (1 << resolution.res_bits()) as i32;
        // The "allow" annotation is needed because there are different Voltage
        // types, depending on the build flags.
        #[allow(clippy::useless_conversion)]
        Ok(Voltage::from_millivolts((converted as i16).into()))
    }

pub fn as_millivolts(&self) -> i16

Return the voltage in millivolts.

pub fn as_volts(&self) -> f32

Return the voltage in volts.

Trait Implementations

impl Clone for Voltage

fn clone(&self) -> Voltage

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Voltage

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<Voltage> for Voltage

fn eq(&self, other: &Voltage) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Voltage

impl Eq for Voltage

impl StructuralEq for Voltage

impl StructuralPartialEq for Voltage