Struct anyleaf::rtd::Rtd

pub struct Rtd<CS: OutputPin> { /* fields omitted */ }

A struct used to describe the RTD. Owns the cs pin.

Implementations

impl<CS: OutputPin> Rtd<CS>

pub fn new<SPI, E>(spi: &mut SPI, cs: CS, type_: RtdType, wires: Wires) -> Self where
    SPI: Write<u8, Error = E> + Transfer<u8, Error = E>, 

pub fn configure<SPI, E>(
    &mut self,
    spi: &mut SPI,
    vbias: Vbias,
    conversion_mode: ConversionMode,
    one_shot: OneShot,
    filter_mode: FilterMode
) -> Result<(), E> where
    SPI: Write<u8, Error = E> + Transfer<u8, Error = E>, 

Updates the devices configuration.

Arguments

• vbias - Set to true to enable V_BIAS voltage, which is required to correctly perform conversion.Clone
• conversion_mode - true to automatically perform conversion, otherwise normally off.
• one_shot - Only perform detection once if set to true, otherwise repeats conversion.
• sensor_type - Define whether a two, three or four wire sensor is used.Clone
• filter_mode - Specify the mains frequency that should be used to filter out noise, e.g. 50Hz in Europe.

Remarks

This will update the configuration register of the MAX31865 register. If the device doesn’t properly react to this, add a delay after calling new to increase the time that the chip select line is set high.

Note: The correct sensor configuration also requires changes to the PCB! Make sure to read the datasheet concerning this.

pub fn read_raw<SPI, E, D: DelayMs<u8>>(
    &mut self,
    spi: &mut SPI,
    delay: &mut D
) -> Result<u16, E> where
    SPI: Write<u8, Error = E> + Transfer<u8, Error = E>, 

Read the raw RTD value.

Remarks

The raw value is the value of the combined MSB and LSB registers. The first 15 bits specify the ohmic value in relation to the reference resistor (i.e. 2^15 - 1 would be the exact same resistance as the reference resistor). See manual for further information. The last bit specifies if the conversion was successful.

pub fn read_resistance<SPI, E, D: DelayMs<u8>>(
    &mut self,
    spi: &mut SPI,
    delay: &mut D
) -> Result<f32, E> where
    SPI: Write<u8, Error = E> + Transfer<u8, Error = E>, 

Measure RTD resistance, in Ohms.

pub fn read<SPI, E, D: DelayMs<u8>>(
    &mut self,
    spi: &mut SPI,
    delay: &mut D
) -> Result<f32, E> where
    SPI: Write<u8, Error = E> + Transfer<u8, Error = E>, 

Measure temperature, in Celsius

pub fn read_config<SPI, E>(&mut self, spi: &mut SPI) -> Result<[bool; 8], E> where
    SPI: Write<u8, Error = E> + Transfer<u8, Error = E>, 

Return the configuration register data.

pub fn fault_status<SPI, E>(&mut self, spi: &mut SPI) -> Result<[bool; 6], E> where
    SPI: Write<u8, Error = E> + Transfer<u8, Error = E>, 

Find the fault status. See Table 7.

pub fn calibrate<SPI, E, D: DelayMs<u8>>(
    &mut self,
    spi: &mut SPI,
    delay: &mut D
) -> Result<(), E> where
    SPI: Write<u8, Error = E> + Transfer<u8, Error = E>, 

todo: Sort this out.

Set the calibration reference resistance. This can be used to calibrate inaccuracies of both the reference resistor and the PT100 element.

Arguments

• calib - A 32 bit integer specifying the reference resistance in ohms multiplied by 100, e.g. 40000 for 400 Ohms

Remarks

You can perform calibration by putting the sensor in boiling (100 degrees Celcius) water and then measuring the raw value using read_raw. Calculate calib as (13851 << 15) / raw >> 1.

pub fn _is_ready<I: InputPin<Error = E>, E>(&self, rdy: I) -> Result<bool, E>

Determine if a new conversion is available

Remarks

When the module is finished converting the temperature it sets the ready pin to low. It is automatically returned to high upon reading the RTD registers.