hmc5983 0.1.3

HMC5983 magnetometer driver for embedded hal
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

/*
Copyright (c) 2020 Todd Stellanova
LICENSE: BSD3 (see LICENSE file)
*/

pub mod spi;
pub use self::spi::SpiInterface;

pub mod i2c;
pub use self::i2c::I2cInterface;

/// A method of communicating with the device
pub trait SensorInterface {
    /// Interface associated error type
    type InterfaceError;

    /// Read a block from a specific register
    /// `reg`: The register address to read from
    /// `recv_buf`: The buffer to receive into
    fn read_block(
        &mut self,
        reg: u8,
        recv_buf: &mut [u8],
    ) -> Result<(), Self::InterfaceError>;

    /// Write a value to a register
    fn write_reg(
        &mut self,
        reg: u8,
        val: u8,
    ) -> Result<(), Self::InterfaceError>;
}