Rust MCP4x digital potentiometer (digipot) driver

This is a platform-agnostic Rust driver for the MCP41xxx and MCP42xxx SPI digital potentiometers (digipot), based on the embedded-hal traits.

This driver allows you to:

• Set a channel (or all of them) to a position. See: set_position().
• Shutdown a channel (or all of them). See: shutdown().

The devices

The MCP41XXX and MCP42XXX devices are 256-position, digital potentiometers available in 10 kΩ, 50 kΩ and 100 kΩ resistance versions. The MCP41XXX is a single-channel device and is offered in an 8-pin PDIP or SOIC package. The MCP42XXX contains two independent channels in a 14-pin PDIP, SOIC or TSSOP package. The wiper position of the MCP41XXX/42XXX varies linearly and is controlled via an industry-standard SPI interface.

The devices consume <1 μA during static operation. A software shutdown feature is provided that disconnects the "A" terminal from the resistor stack and simultaneously connects the wiper to the "B" terminal. In addition, the dual MCP42XXX has a SHDN pin that performs the same function in hardware. During shutdown mode, the contents of the wiper register can be changed and the potentiometer returns from shutdown to the new value. The wiper is reset to the mid-scale position (80h) upon power-up. The RS (reset) pin implements a hardware reset and also returns the wiper to mid-scale.

The MCP42XXX SPI interface includes both the SI and SO pins, allowing daisy-chaining of multiple devices. Channel-to-channel resistance matching on the MCP42XXX varies by less than 1%.

This driver should be compatible at least with the devices: MCP41010, MCP41050, MCP41100, MCP42010, MCP42050 and MCP42100.

Datasheet:

• MCP41XXX/MCP42XXX

Usage

To use this driver, import this crate and an embedded_hal implementation, then instantiate the appropriate device. In the following examples an instance of the device MCP41x will be created as an example. Other devices can be created with similar methods like: Mcp4x::new_mcp42x(...).

Please find additional examples using hardware in this repository: driver-examples

use mcp4x::{Channel, Mcp4x};
use linux_embedded_hal::{Pin, Spidev};

fn main() {
    let spi = Spidev::open("/dev/spidev0.0").unwrap();
    let chip_select = Pin::new(25);

    let mut mcp41x = Mcp4x::new_mcp41x(spi, chip_select);

    mcp41x.set_position(Channel::Ch0, 50).unwrap();

    // Get SPI device and CS pin back
    let (_spi, _chip_select) = mcp41x.destroy_mcp41x();
}

Support

For questions, issues, feature requests, and other changes, please file an issue in the github project.

License

Licensed under either of

• Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contributing

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.