ldc3114 0.2.0

Driver crate for the TI LDC3114 inductance-to-digital converter
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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

# LDC3114

Driver crate for the TI [LDC3114] Inductance-to-Digital Converter.
Compatible with [embedded-hal] and [embedded-hal-async] traits.

## Example usage

```rust
let mut inductance_sensor = Ldc3114::new(inductance_sensor_i2c);

// Set the device in configuration mode
inductance_sensor.config_mode().await.unwrap();

// Wait until the registers are ready to write
loop {
    if inductance_sensor.is_ready_to_write().await.unwrap() {
        break;
    }
    Timer::after_millis(5).await;
}

// Your setup
inductance_sensor.set_normal_scan_rate(ScanRate::Lowest).await.unwrap();
inductance_sensor.set_low_power_scan_rate(LowPowerScanRate::Low).await.unwrap();
inductance_sensor.enable_button_press_detection_algorithm(false).await.unwrap();

// Set the device in normal mode
inductance_sensor.normal_mode().await.unwrap();

// Wait until the chip is ready
loop {
    if inductance_sensor.is_chip_ready().await.unwrap() {
        break;
    }
    Timer::after_millis(5).await;
}

loop {
    // Read status to update raw data registers
    let _ = inductance_sensor.read_status().await.unwrap();
    let ch0 = inductance_sensor.read_raw_data(Channel0).await.unwrap();
    let ch1 = inductance_sensor.read_raw_data(Channel1).await.unwrap();
    let ch2 = inductance_sensor.read_raw_data(Channel2).await.unwrap();
    let ch3 = inductance_sensor.read_raw_data(Channel3).await.unwrap();
}
```

## Alternative setup

If you have many configurations to set, set up a const `DeviceConfig`:
```rust
const LDC3114_CONFIG: DeviceConfig = DeviceConfig {
    scan_rate: ScanRate::Highest,
    ..DeviceConfig::const_default()
};
```

and then call

```rust
inductance_sensor.set_device_configuration(&LDC3114_CONFIG).await.unwrap();
```

## Resources

- [Datasheet]
- [Application Note]

## License

This work is licensed under either of

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

at your option.

[LDC3114]: https://www.ti.com/product/LDC3114
[embedded-hal]: https://docs.rs/embedded-hal/latest/embedded_hal/
[embedded-hal-async]: https://docs.rs/embedded-hal-async/latest/embedded_hal_async/
[Datasheet]: https://www.ti.com/lit/gpn/ldc3114
[Application Note]: https://www.ti.com/lit/pdf/snoaa76