Struct BatteryWiring 

pub struct BatteryWiring {
    pub part: Part,
    pub bus: String,
    pub address: Option<u8>,
    pub empty_volts: f32,
    pub full_volts: f32,
}

The battery the node runs from, read as a voltage to set how often it samples.

A node with none samples at its profile’s active cadence, as on mains power.

Fields

part: Part

The power monitor across the battery: ina219 or ina226.

bus: String

The I2C bus the monitor is on, or sim.

address: Option<u8>

The monitor’s I2C address, when it is not the part’s usual one.

empty_volts: f32

The voltage the battery reads when it is empty.

full_volts: f32

The voltage the battery reads when it is full.

Implementations

impl BatteryWiring

pub fn charge(&self, volts: f32) -> f32

Turns the battery’s voltage into a state of charge.

Arguments

• volts - the voltage the monitor read.

Returns

The charge from 0 to 1, on a straight line from empty to full; a reading outside the two is held to the nearer end.

Examples

use pamoja_profile::wiring::{BatteryWiring, Part};

let battery = BatteryWiring {
    part: Part::Ina219,
    bus: "/dev/i2c-1".to_owned(),
    address: None,
    empty_volts: 3.3,
    full_volts: 4.2,
};
assert!((battery.charge(3.75) - 0.5).abs() < 1e-6);
assert_eq!(battery.charge(5.0), 1.0);

Trait Implementations

impl Clone for BatteryWiring

fn clone(&self) -> BatteryWiring

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BatteryWiring

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BatteryWiring

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for BatteryWiring

fn eq(&self, other: &BatteryWiring) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for BatteryWiring

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for BatteryWiring