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 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385
//! # Device configuration
//!
//! Instead of directly writing do configuration registers, the client offers a generic abstraction.
//!
//! ## Example
//!
//! For full details s. [Configuration] struct.
//!
//! ````
//! use ltc681x::config::{Cell, Configuration};
//! use ltc681x::example::{ExampleCSPin, ExampleSPIBus};
//! use ltc681x::ltc6813::LTC6813;
//! use ltc681x::monitor::{LTC681X, LTC681XClient};
//!
//! // Single LTC6813 device
//! let spi_bus = ExampleSPIBus::default();
//! let cs_pin = ExampleCSPin{};
//! let mut client: LTC681X<_, _, _, LTC6813, 1> = LTC681X::ltc6813(spi_bus, cs_pin);
//!
//! let mut config = Configuration::default();
//!
//! // Set over-voltage limit to 4.25 V
//! config.set_ov_comp_voltage(4_250_000).unwrap();
//!
//! // Sets under-voltage limit to 3.0 V
//! config.set_uv_comp_voltage(3_000_000).unwrap();
//!
//! // Turn on discharge switch for cell 6 and 9
//! config.discharge_cell(Cell::Cell6);
//! config.discharge_cell(Cell::Cell9);
//!
//! client.write_configuration([config]).unwrap();
//! ````
//!
//! ## Multiple devices in daisy-chain
//!
//! Writing to multiple devices in daisy-chain is supported, by providing an array item per device:
//! ````
//!# use ltc681x::config::{Cell, Configuration};
//!# use ltc681x::example::{ExampleCSPin, ExampleSPIBus};
//!# use ltc681x::ltc6813::LTC6813;
//!# use ltc681x::monitor::{LTC681X, LTC681XClient};
//!#
//!# // Single LTC6813 device
//!# let spi_bus = ExampleSPIBus::default();
//!# let cs_pin = ExampleCSPin{};
//! // 3 devices in daisy chain
//! let mut client: LTC681X<_, _, _, LTC6813, 3> = LTC681X::ltc6813(spi_bus, cs_pin);
//!
//! let mut config = [
//! Configuration::default(),
//! Configuration::default(),
//! Configuration::default()
//! ];
//!
//! config[0].set_ov_comp_voltage(4_100_000);
//! config[1].set_ov_comp_voltage(4_200_000);
//! config[2].set_ov_comp_voltage(4_300_000);
//!
//! client.write_configuration(config).unwrap();
//! ````
//!
use core::fmt::{Display, Formatter};
/// Abstracted configuration of configuration register(s)
#[derive(Debug, Clone)]
pub struct Configuration {
/// Computed value of register A
pub(crate) register_a: [u8; 6],
/// Computed value of register B,
pub(crate) register_b: [u8; 6],
}
impl Default for Configuration {
fn default() -> Self {
Self {
register_a: [
0b1111_1000,
0b0000_0000,
0b0000_0000,
0b0000_0000,
0b0000_0000,
0b0000_0000,
],
register_b: [
0b0000_1111,
0b0000_0000,
0b0000_0000,
0b0000_0000,
0b0000_0000,
0b0000_0000,
],
}
}
}
/// GPIO pins of LTC681X device.
/// Depending on the device type, not all pins may be available.
/// Configuring a pin that is not physically available has no effect.
#[derive(Copy, Clone, Eq, PartialEq, Debug)]
pub enum GPIO {
GPIO1,
GPIO2,
GPIO3,
GPIO4,
GPIO5,
GPIO6,
GPIO7,
GPIO8,
GPIO9,
}
/// Cell indexes of the LTC681X device.
/// Depending on the device type, not all cells may be available.
/// Configuring a cell that is not physically available has no effect.
#[derive(Copy, Clone, Eq, PartialEq, Debug)]
pub enum Cell {
Cell1,
Cell2,
Cell3,
Cell4,
Cell5,
Cell6,
Cell7,
Cell8,
Cell9,
Cell10,
Cell11,
Cell12,
Cell13,
Cell14,
Cell15,
Cell16,
Cell17,
Cell18,
}
/// Timeout duration for discharge timer
#[derive(Copy, Clone, Eq, PartialEq, Debug)]
pub enum DischargeTimeout {
Disabled = 0x0,
HalfMinute = 0x1,
OneMinute = 0x2,
TwoMinutes = 0x3,
ThreeMinutes = 0x4,
FourMinutes = 0x5,
FiveMinutes = 0x6,
TenMinutes = 0x7,
FifteenMinutes = 0x8,
TwentyMinutes = 0x9,
ThirtyMinutes = 0xA,
FortyMinutes = 0xB,
SixtyMinutes = 0xC,
SeventyFiveMinutes = 0xD,
NinetyMinutes = 0xE,
TwoHours = 0xF,
}
/// Digital Redundancy Path Selection
#[derive(Copy, Clone, Debug)]
pub enum DigitalRedundancyPath {
/// Redundancy is applied sequentially to ADC1, ADC2 and ADC3 digital paths during cell conversions
/// and applied to ADC1 during AUX and STATUS conversions
All = 0x0,
/// Redundancy is applied only to ADC1 digital path
ADC1 = 0x1,
/// Redundancy is applied only to ADC2 digital path
ADC2 = 0x2,
/// Redundancy is applied only to ADC3 digital path
ADC3 = 0x3,
}
/// Given voltage is out-of-range for fitting in 12 bit integer
#[derive(Debug)]
pub struct VoltageOutOfRangeError {}
impl Display for VoltageOutOfRangeError {
fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result {
write!(f, "Voltage overflows 12-bit integer")
}
}
impl Configuration {
/// Enables pull-down of the given GPIO pin
pub fn enable_gpio_pull_down(&mut self, pin: GPIO) {
match pin {
GPIO::GPIO1 => self.register_a[0] &= 0b1111_0111,
GPIO::GPIO2 => self.register_a[0] &= 0b1110_1111,
GPIO::GPIO3 => self.register_a[0] &= 0b1101_1111,
GPIO::GPIO4 => self.register_a[0] &= 0b1011_1111,
GPIO::GPIO5 => self.register_a[0] &= 0b0111_1111,
GPIO::GPIO6 => self.register_b[0] &= 0b1111_1110,
GPIO::GPIO7 => self.register_b[0] &= 0b1111_1101,
GPIO::GPIO8 => self.register_b[0] &= 0b1111_1011,
GPIO::GPIO9 => self.register_b[0] &= 0b1111_0111,
}
}
/// Enables pull-down of the given GPIO pin
pub fn disable_gpio_pull_down(&mut self, pin: GPIO) {
match pin {
GPIO::GPIO1 => self.register_a[0] |= 0b0000_1000,
GPIO::GPIO2 => self.register_a[0] |= 0b0001_0000,
GPIO::GPIO3 => self.register_a[0] |= 0b0010_0000,
GPIO::GPIO4 => self.register_a[0] |= 0b0100_0000,
GPIO::GPIO5 => self.register_a[0] |= 0b1000_0000,
GPIO::GPIO6 => self.register_b[0] |= 0b0000_0001,
GPIO::GPIO7 => self.register_b[0] |= 0b0000_0010,
GPIO::GPIO8 => self.register_b[0] |= 0b0000_0100,
GPIO::GPIO9 => self.register_b[0] |= 0b0000_1000,
}
}
/// References remain powered up until watchdog timeout
pub fn enable_reference_power(&mut self) {
self.register_a[0] |= 0b0000_0100
}
/// References shut down after conversions (Default)
pub fn disable_reference_power(&mut self) {
self.register_a[0] &= 0b1111_1011
}
/// Enables the discharge timer for discharge switches
pub fn enable_discharge_timer(&mut self) {
self.register_a[0] |= 0b0000_0010
}
/// Disables the discharge timer
pub fn disable_discharge_timer(&mut self) {
self.register_a[0] &= 0b1111_1101
}
/// Sets the under-voltage comparison voltage in uV
pub fn set_uv_comp_voltage(&mut self, voltage: u32) -> Result<(), VoltageOutOfRangeError> {
if voltage == 0 {
self.register_a[1] = 0x0;
self.register_a[2] &= 0b1111_0000;
return Ok(());
}
if !(3200..=6553600).contains(&voltage) {
return Err(VoltageOutOfRangeError {});
}
let value = ((voltage / 1600) - 1) as u16;
self.register_a[1] = value as u8;
self.register_a[2] &= 0b1111_0000;
self.register_a[2] |= (value >> 8) as u8;
Ok(())
}
/// Sets the over-voltage comparison voltage in uV
pub fn set_ov_comp_voltage(&mut self, voltage: u32) -> Result<(), VoltageOutOfRangeError> {
if voltage == 0 {
self.register_a[2] &= 0b0000_1111;
self.register_a[3] = 0x0;
return Ok(());
}
if !(1600..=6552000).contains(&voltage) {
return Err(VoltageOutOfRangeError {});
}
let value = (voltage / 1600) as u16;
self.register_a[3] = (value >> 4) as u8;
self.register_a[2] &= 0b0000_1111;
self.register_a[2] |= (value << 4) as u8;
Ok(())
}
/// Turn ON Shorting Switch for Cell x
pub fn discharge_cell(&mut self, cell: Cell) {
match cell {
Cell::Cell1 => self.register_a[4] |= 0b0000_0001,
Cell::Cell2 => self.register_a[4] |= 0b0000_0010,
Cell::Cell3 => self.register_a[4] |= 0b0000_0100,
Cell::Cell4 => self.register_a[4] |= 0b0000_1000,
Cell::Cell5 => self.register_a[4] |= 0b0001_0000,
Cell::Cell6 => self.register_a[4] |= 0b0010_0000,
Cell::Cell7 => self.register_a[4] |= 0b0100_0000,
Cell::Cell8 => self.register_a[4] |= 0b1000_0000,
Cell::Cell9 => self.register_a[5] |= 0b0000_0001,
Cell::Cell10 => self.register_a[5] |= 0b0000_0010,
Cell::Cell11 => self.register_a[5] |= 0b0000_0100,
Cell::Cell12 => self.register_a[5] |= 0b0000_1000,
Cell::Cell13 => self.register_b[0] |= 0b0001_0000,
Cell::Cell14 => self.register_b[0] |= 0b0010_0000,
Cell::Cell15 => self.register_b[0] |= 0b0100_0000,
Cell::Cell16 => self.register_b[0] |= 0b1000_0000,
Cell::Cell17 => self.register_b[1] |= 0b0000_0001,
Cell::Cell18 => self.register_b[1] |= 0b0000_0010,
}
}
/// Sets the discharge timeout
pub fn set_discharge_timeout(&mut self, timeout: DischargeTimeout) {
self.register_a[5] &= 0b0000_1111;
self.register_a[5] |= (timeout as u8) << 4;
}
/// Alternative ADC modes 14kHz, 3kHz, 1kHz or 2kHz
pub fn set_alternative_adc_modes(&mut self) {
self.register_a[0] |= 0b0000_0001
}
/// Default ADC modes 27kHz, 7kHz, 422Hz or 26Hz
pub fn set_default_adc_modes(&mut self) {
self.register_a[0] &= 0b1111_1110
}
/// Forces the digital redundancy comparison for ADC Conversions to fail
pub fn force_digital_redundancy_fail(&mut self) {
self.register_b[1] |= 0b0100_0000;
}
/// Sets the digital redundancy path
pub fn set_digital_redundancy_path(&mut self, selection: DigitalRedundancyPath) {
self.register_b[1] &= 0b1100_1111;
self.register_b[1] |= (selection as u8) << 4;
}
/// Enables the discharge timer monitor function if the DTEN Pin is Asserted
/// Otherwise (default) the discharge dimer monitor function is disabled. The normal discharge
/// timer function will be enabled if the DTEN pin is asserted
pub fn enable_discharge_monitor(&mut self) {
self.register_b[1] |= 0b0000_1000;
}
}
impl PartialEq<Self> for Configuration {
fn eq(&self, other: &Self) -> bool {
self.register_a == other.register_a && self.register_b == other.register_b
}
}
impl Eq for Configuration {}
impl From<usize> for Cell {
fn from(index: usize) -> Self {
match index {
0 => Cell::Cell1,
1 => Cell::Cell2,
2 => Cell::Cell3,
3 => Cell::Cell4,
4 => Cell::Cell5,
5 => Cell::Cell6,
6 => Cell::Cell7,
7 => Cell::Cell8,
8 => Cell::Cell9,
9 => Cell::Cell10,
10 => Cell::Cell11,
11 => Cell::Cell12,
12 => Cell::Cell13,
13 => Cell::Cell14,
14 => Cell::Cell15,
15 => Cell::Cell16,
16 => Cell::Cell17,
17 => Cell::Cell18,
_ => Cell::Cell1,
}
}
}
impl From<usize> for GPIO {
fn from(index: usize) -> Self {
match index {
0 => GPIO::GPIO1,
1 => GPIO::GPIO2,
2 => GPIO::GPIO3,
3 => GPIO::GPIO4,
4 => GPIO::GPIO5,
5 => GPIO::GPIO6,
6 => GPIO::GPIO7,
7 => GPIO::GPIO8,
8 => GPIO::GPIO9,
_ => GPIO::GPIO1,
}
}
}