Skip to main content

BatteryState

Struct BatteryState

pub struct BatteryState {Show 19 fields
    pub netname: Option<String>,
    pub channel: Option<i64>,
    pub error: Option<String>,
    pub terminal_voltage: Option<f64>,
    pub current: Option<f64>,
    pub esr: Option<f64>,
    pub soc: Option<f64>,
    pub voc: Option<f64>,
    pub enabled: Option<bool>,
    pub mode: Option<String>,
    pub model: Option<String>,
    pub capacity: Option<f64>,
    pub current_limit: Option<f64>,
    pub ocp_limit: Option<f64>,
    pub ovp_limit: Option<f64>,
    pub volt_full: Option<f64>,
    pub volt_empty: Option<f64>,
    pub ocp_tripped: Option<bool>,
    pub ovp_tripped: Option<bool>,
}

Expand description

Structured battery-simulator state from the state action on POST /battery/command. Fields are None when the individual read failed.

Fields§

§netname: Option<String>

Net name echo.

§channel: Option<i64>

Instrument channel driving this net.

§error: Option<String>

Transport-level error when the whole state gather failed.

§terminal_voltage: Option<f64>

Simulated terminal voltage (V).

§current: Option<f64>

Measured current (A).

§esr: Option<f64>

Equivalent series resistance (ohm).

§soc: Option<f64>

State of charge (%).

§voc: Option<f64>

Open-circuit voltage (V).

§enabled: Option<bool>

Whether the simulator output is enabled.

§mode: Option<String>

Simulation mode ("static" / "dynamic").

§model: Option<String>

Battery model / part number.

§capacity: Option<f64>

Battery capacity (Ah).

§current_limit: Option<f64>

Current limit (A).

§ocp_limit: Option<f64>

Over-current protection limit (A).

§ovp_limit: Option<f64>

Over-voltage protection limit (V).

§volt_full: Option<f64>

Voltage considered “full” (V).

§volt_empty: Option<f64>

Voltage considered “empty” (V).

§ocp_tripped: Option<bool>

Whether OCP has tripped.

§ovp_tripped: Option<bool>

Whether OVP has tripped.

Trait Implementations§

impl Clone for BatteryState

fn clone(&self) -> BatteryState

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl Debug for BatteryState

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for BatteryState

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

Auto Trait Implementations§

impl Freeze for BatteryState

impl RefUnwindSafe for BatteryState

impl Send for BatteryState

impl Sync for BatteryState

impl Unpin for BatteryState

impl UnsafeUnpin for BatteryState

impl UnwindSafe for BatteryState

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more