Struct BatteryState

pub struct BatteryState {

    pub header: Option<Header>,
    pub voltage: f64,
    pub temperature: f64,
    pub current: f64,
    pub charge: f64,
    pub capacity: f64,
    pub design_capacity: f64,
    pub percentage: f64,
    pub power_supply_status: i32,
    pub power_supply_health: i32,
    pub power_supply_technology: i32,
    pub present: bool,
    pub cell_voltage: Vec<f64>,
    pub cell_temperature: Vec<f64>,
    pub location: String,
    pub serial_number: String,
}

Fields

header: Option<Header>

voltage: f64

Voltage in Volts (Mandatory)

temperature: f64

Temperature in Degrees Celsius (If unmeasured NaN)

current: f64

Negative when discharging (A) (If unmeasured NaN)

charge: f64

Current charge in Ah (If unmeasured NaN)

capacity: f64

Capacity in Ah (last full capacity) (If unmeasured NaN)

design_capacity: f64

Capacity in Ah (design capacity) (If unmeasured NaN)

percentage: f64

Charge percentage on 0 to 1 range (If unmeasured NaN)

power_supply_status: i32

The charging status as reported. Values defined above

power_supply_health: i32

The battery health metric. Values defined above

power_supply_technology: i32

The battery chemistry. Values defined above

present: bool

True if the battery is present

cell_voltage: Vec<f64>

An array of individual cell voltages for each cell in the pack

cell_temperature: Vec<f64>

If individual voltages unknown but number of cells known set each to NaN

An array of individual cell temperatures for each cell in the pack

location: String

If individual temperatures unknown but number of cells known set each to NaN

The location into which the battery is inserted. (slot number or plug)

serial_number: String

The best approximation of the battery serial number

Implementations

impl BatteryState

pub fn power_supply_status(&self) -> PowerSupplyStatus

Returns the enum value of power_supply_status, or the default if the field is set to an invalid enum value.

pub fn set_power_supply_status(&mut self, value: PowerSupplyStatus)

Sets power_supply_status to the provided enum value.

pub fn power_supply_health(&self) -> PowerSupplyHealth

Returns the enum value of power_supply_health, or the default if the field is set to an invalid enum value.

pub fn set_power_supply_health(&mut self, value: PowerSupplyHealth)

Sets power_supply_health to the provided enum value.

pub fn power_supply_technology(&self) -> PowerSupplyTechnology

Returns the enum value of power_supply_technology, or the default if the field is set to an invalid enum value.

pub fn set_power_supply_technology(&mut self, value: PowerSupplyTechnology)

Sets power_supply_technology to the provided enum value.

Trait Implementations

impl Clone for BatteryState

fn clone(&self) -> BatteryState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BatteryState

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

Formats the value using the given formatter.

impl Default for BatteryState

fn default() -> Self

Returns the “default value” for a type.

impl Message for BatteryState

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for BatteryState

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for BatteryState