Struct hx711_spi::Hx711

pub struct Hx711<SPI> { /* private fields */ }

Represents an instance of a HX711 device

Implementations

impl<SPI, E> Hx711<SPI>where SPI: Transfer<u8, Error = E> + Write<u8, Error = E>,

pub fn new(spi: SPI) -> Self

opens a connection to a HX711 on a specified SPI.

The datasheet specifies PD_SCK high time and PD_SCK low time to be in the 0.2 to 50 us range, therefore bus speed has to be between 5 MHz and 20 kHz. 1 MHz seems to be a good choice. D is an embedded_hal implementation of DelayMs.

pub fn read(&mut self) -> Result<i32, E>

reads a value from the HX711 and returns it

Errors

Returns SPI errors and nb::Error::WouldBlock if data isn’t ready to be read from hx711

pub fn retrieve(&mut self) -> Result<i32, E>

This is for compatibility only. Use read instead.

pub fn reset(&mut self) -> Result<(), E>

Reset the chip to it’s default state. Mode is set to convert channel A with a gain factor of 128.

Errors

Returns SPI errors

pub fn set_mode(&mut self, m: Mode) -> Result<Mode, E>

Set the mode to the value specified.

Errors

Returns SPI errors

pub fn mode(&mut self) -> Mode

Get the current mode.

pub fn get_mode(&mut self) -> Mode

This is for compatibility only. Use mode instead.

pub fn disable(&mut self) -> Result<(), E>

To power down the chip the PD_SCK line has to be held in a ‘high’ state. To do this we would need to write a constant stream of binary ‘1’ to the SPI bus which would totally defy the purpose. Therefore it’s not implemented.

pub fn enable(&mut self) -> Result<(), E>

Power up / down is not implemented (see disable)

Trait Implementations

impl<SPI: Debug> Debug for Hx711<SPI>

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

Formats the value using the given formatter.