Struct MavBatteryStatusFlags 

pub struct MavBatteryStatusFlags(/* private fields */);

MAVLink bitmask enum MAV_BATTERY_STATUS_FLAGS for development dialect.

Battery status flags for fault, health and state indication.

Implementations

impl MavBatteryStatusFlags

pub const NOT_READY_TO_USE: MavBatteryStatusFlags

MAV_BATTERY_STATUS_FLAGS_NOT_READY_TO_USE flag.

The battery is not ready to use (fly). Set if the battery has faults or other conditions that make it unsafe to fly with. Note: It will be the logical OR of other status bits (chosen by the manufacturer/integrator).

pub const CHARGING: MavBatteryStatusFlags

MAV_BATTERY_STATUS_FLAGS_CHARGING flag.

Battery is charging.

pub const CELL_BALANCING: MavBatteryStatusFlags

MAV_BATTERY_STATUS_FLAGS_CELL_BALANCING flag.

Battery is cell balancing (during charging). Not ready to use (MAV_BATTERY_STATUS_FLAGS_NOT_READY_TO_USE may be set).

pub const FAULT_CELL_IMBALANCE: MavBatteryStatusFlags

MAV_BATTERY_STATUS_FLAGS_FAULT_CELL_IMBALANCE flag.

Battery cells are not balanced. Not ready to use.

pub const AUTO_DISCHARGING: MavBatteryStatusFlags

MAV_BATTERY_STATUS_FLAGS_AUTO_DISCHARGING flag.

Battery is auto discharging (towards storage level). Not ready to use (MAV_BATTERY_STATUS_FLAGS_NOT_READY_TO_USE would be set).

pub const REQUIRES_SERVICE: MavBatteryStatusFlags

MAV_BATTERY_STATUS_FLAGS_REQUIRES_SERVICE flag.

Battery requires service (not safe to fly). This is set at vendor discretion. It is likely to be set for most faults, and may also be set according to a maintenance schedule (such as age, or number of recharge cycles, etc.).

pub const BAD_BATTERY: MavBatteryStatusFlags

MAV_BATTERY_STATUS_FLAGS_BAD_BATTERY flag.

Battery is faulty and cannot be repaired (not safe to fly). This is set at vendor discretion. The battery should be disposed of safely.

pub const PROTECTIONS_ENABLED: MavBatteryStatusFlags

MAV_BATTERY_STATUS_FLAGS_PROTECTIONS_ENABLED flag.

Automatic battery protection monitoring is enabled. When enabled, the system will monitor for certain kinds of faults, such as cells being over-voltage. If a fault is triggered then and protections are enabled then a safety fault (MAV_BATTERY_STATUS_FLAGS_FAULT_PROTECTION_SYSTEM) will be set and power from the battery will be stopped. Note that battery protection monitoring should only be enabled when the vehicle is landed. Once the vehicle is armed, or starts moving, the protections should be disabled to prevent false positives from disabling the output.

pub const FAULT_PROTECTION_SYSTEM: MavBatteryStatusFlags

MAV_BATTERY_STATUS_FLAGS_FAULT_PROTECTION_SYSTEM flag.

The battery fault protection system had detected a fault and cut all power from the battery. This will only trigger if MAV_BATTERY_STATUS_FLAGS_PROTECTIONS_ENABLED is set. Other faults like MAV_BATTERY_STATUS_FLAGS_FAULT_OVER_VOLT may also be set, indicating the cause of the protection fault.

pub const FAULT_OVER_VOLT: MavBatteryStatusFlags

MAV_BATTERY_STATUS_FLAGS_FAULT_OVER_VOLT flag.

One or more cells are above their maximum voltage rating.

pub const FAULT_UNDER_VOLT: MavBatteryStatusFlags

MAV_BATTERY_STATUS_FLAGS_FAULT_UNDER_VOLT flag.

One or more cells are below their minimum voltage rating. A battery that had deep-discharged might be irrepairably damaged, and set both MAV_BATTERY_STATUS_FLAGS_FAULT_UNDER_VOLT and MAV_BATTERY_STATUS_FLAGS_BAD_BATTERY.

pub const FAULT_OVER_TEMPERATURE: MavBatteryStatusFlags

MAV_BATTERY_STATUS_FLAGS_FAULT_OVER_TEMPERATURE flag.

Over-temperature fault.

pub const FAULT_UNDER_TEMPERATURE: MavBatteryStatusFlags

MAV_BATTERY_STATUS_FLAGS_FAULT_UNDER_TEMPERATURE flag.

Under-temperature fault.

pub const FAULT_OVER_CURRENT: MavBatteryStatusFlags

MAV_BATTERY_STATUS_FLAGS_FAULT_OVER_CURRENT flag.

Over-current fault.

pub const FAULT_SHORT_CIRCUIT: MavBatteryStatusFlags

MAV_BATTERY_STATUS_FLAGS_FAULT_SHORT_CIRCUIT flag.

Short circuit event detected. The battery may or may not be safe to use (check other flags).

pub const FAULT_INCOMPATIBLE_VOLTAGE: MavBatteryStatusFlags

MAV_BATTERY_STATUS_FLAGS_FAULT_INCOMPATIBLE_VOLTAGE flag.

Voltage not compatible with power rail voltage (batteries on same power rail should have similar voltage).

pub const FAULT_INCOMPATIBLE_FIRMWARE: MavBatteryStatusFlags

MAV_BATTERY_STATUS_FLAGS_FAULT_INCOMPATIBLE_FIRMWARE flag.

Battery firmware is not compatible with current autopilot firmware.

pub const FAULT_INCOMPATIBLE_CELLS_CONFIGURATION: MavBatteryStatusFlags

MAV_BATTERY_STATUS_FLAGS_FAULT_INCOMPATIBLE_CELLS_CONFIGURATION flag.

Battery is not compatible due to cell configuration (e.g. 5s1p when vehicle requires 6s).

pub const CAPACITY_RELATIVE_TO_FULL: MavBatteryStatusFlags

MAV_BATTERY_STATUS_FLAGS_CAPACITY_RELATIVE_TO_FULL flag.

Battery capacity_consumed and capacity_remaining values are relative to a full battery (they sum to the total capacity of the battery). This flag would be set for a smart battery that can accurately determine its remaining charge across vehicle reboots and discharge/recharge cycles. If unset the capacity_consumed indicates the consumption since vehicle power-on, as measured using a power monitor. The capacity_remaining, if provided, indicates the estimated remaining capacity on the assumption that the battery was full on vehicle boot. If unset a GCS is recommended to advise that users fully charge the battery on power on.

pub const EXTENDED: MavBatteryStatusFlags

MAV_BATTERY_STATUS_FLAGS_EXTENDED flag.

Reserved (not used). If set, this will indicate that an additional status field exists for higher status values.

impl MavBatteryStatusFlags

pub const fn empty() -> MavBatteryStatusFlags

Get a flags value with all bits unset.

pub const fn all() -> MavBatteryStatusFlags

Get a flags value with all known bits set.

pub const fn bits(&self) -> u32

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: u32) -> Option<MavBatteryStatusFlags>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u32) -> MavBatteryStatusFlags

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u32) -> MavBatteryStatusFlags

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<MavBatteryStatusFlags>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

pub const fn intersects(&self, other: MavBatteryStatusFlags) -> bool

Whether any set bits in a source flags value are also set in a target flags value.

pub const fn contains(&self, other: MavBatteryStatusFlags) -> bool

Whether all set bits in a source flags value are also set in a target flags value.

pub fn insert(&mut self, other: MavBatteryStatusFlags)

The bitwise or (|) of the bits in two flags values.

pub fn remove(&mut self, other: MavBatteryStatusFlags)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

pub fn toggle(&mut self, other: MavBatteryStatusFlags)

The bitwise exclusive-or (^) of the bits in two flags values.

pub fn set(&mut self, other: MavBatteryStatusFlags, value: bool)

Call insert when value is true or remove when value is false.

pub const fn intersection( self, other: MavBatteryStatusFlags, ) -> MavBatteryStatusFlags

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: MavBatteryStatusFlags) -> MavBatteryStatusFlags

The bitwise or (|) of the bits in two flags values.

pub const fn difference( self, other: MavBatteryStatusFlags, ) -> MavBatteryStatusFlags

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference( self, other: MavBatteryStatusFlags, ) -> MavBatteryStatusFlags

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> MavBatteryStatusFlags

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl MavBatteryStatusFlags

pub const fn iter(&self) -> Iter<MavBatteryStatusFlags>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<MavBatteryStatusFlags>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

Trait Implementations

impl Binary for MavBatteryStatusFlags

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

Formats the value using the given formatter.

impl BitAnd for MavBatteryStatusFlags

fn bitand(self, other: MavBatteryStatusFlags) -> MavBatteryStatusFlags

The bitwise and (&) of the bits in two flags values.

type Output = MavBatteryStatusFlags

The resulting type after applying the & operator.

impl BitAndAssign for MavBatteryStatusFlags

fn bitand_assign(&mut self, other: MavBatteryStatusFlags)

The bitwise and (&) of the bits in two flags values.

impl BitOr for MavBatteryStatusFlags

fn bitor(self, other: MavBatteryStatusFlags) -> MavBatteryStatusFlags

The bitwise or (|) of the bits in two flags values.

type Output = MavBatteryStatusFlags

The resulting type after applying the | operator.

impl BitOrAssign for MavBatteryStatusFlags

fn bitor_assign(&mut self, other: MavBatteryStatusFlags)

The bitwise or (|) of the bits in two flags values.

impl BitXor for MavBatteryStatusFlags

fn bitxor(self, other: MavBatteryStatusFlags) -> MavBatteryStatusFlags

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = MavBatteryStatusFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for MavBatteryStatusFlags

fn bitxor_assign(&mut self, other: MavBatteryStatusFlags)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for MavBatteryStatusFlags

fn clone(&self) -> MavBatteryStatusFlags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MavBatteryStatusFlags

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

Formats the value using the given formatter.

impl Default for MavBatteryStatusFlags

fn default() -> MavBatteryStatusFlags

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MavBatteryStatusFlags

fn deserialize<__D>( __deserializer: __D, ) -> Result<MavBatteryStatusFlags, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Extend<MavBatteryStatusFlags> for MavBatteryStatusFlags

fn extend<T>(&mut self, iterator: T)

where T: IntoIterator<Item = MavBatteryStatusFlags>,

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl Flags for MavBatteryStatusFlags

const FLAGS: &'static [Flag<MavBatteryStatusFlags>]

The set of defined flags.

type Bits = u32

The underlying bits type.

fn bits(&self) -> u32

Get the underlying bits value.

fn from_bits_retain(bits: u32) -> MavBatteryStatusFlags

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn intersects(&self, other: Self) -> bool

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

fn contains(&self, other: Self) -> bool

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

fn set(&mut self, other: Self, value: bool)

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<MavBatteryStatusFlags> for MavBatteryStatusFlags

fn from_iter<T>(iterator: T) -> MavBatteryStatusFlags

where T: IntoIterator<Item = MavBatteryStatusFlags>,

The bitwise or (|) of the bits in each flags value.

impl IntoIterator for MavBatteryStatusFlags

type Item = MavBatteryStatusFlags

The type of the elements being iterated over.

type IntoIter = Iter<MavBatteryStatusFlags>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <MavBatteryStatusFlags as IntoIterator>::IntoIter

Creates an iterator from a value.

impl LowerHex for MavBatteryStatusFlags

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

Formats the value using the given formatter.

impl NamedType for MavBatteryStatusFlags

fn sid() -> SpectaID

fn named_data_type( type_map: &mut TypeCollection, generics: &[DataType], ) -> NamedDataType

this is equivalent to Type::inline but returns a NamedDataType instead.

fn definition_named_data_type(type_map: &mut TypeCollection) -> NamedDataType

this is equivalent to [Type::definition] but returns a NamedDataType instead.

impl Not for MavBatteryStatusFlags

fn not(self) -> MavBatteryStatusFlags

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = MavBatteryStatusFlags

The resulting type after applying the ! operator.

impl Octal for MavBatteryStatusFlags

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

Formats the value using the given formatter.

impl PartialEq for MavBatteryStatusFlags

fn eq(&self, other: &MavBatteryStatusFlags) -> 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 Serialize for MavBatteryStatusFlags

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for MavBatteryStatusFlags

fn sub(self, other: MavBatteryStatusFlags) -> MavBatteryStatusFlags

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = MavBatteryStatusFlags

The resulting type after applying the - operator.

impl SubAssign for MavBatteryStatusFlags

fn sub_assign(&mut self, other: MavBatteryStatusFlags)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl Type for MavBatteryStatusFlags

fn inline(type_map: &mut TypeCollection, generics: Generics<'_>) -> DataType

Returns the definition of a type using the provided generics.

fn reference(type_map: &mut TypeCollection, generics: &[DataType]) -> Reference

Generates a datatype corresponding to a reference to this type, as determined by its category. Getting a reference to a type implies that it should belong in the type map (since it has to be referenced from somewhere), so the output of definition will be put into the type map.

impl UpperHex for MavBatteryStatusFlags

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

Formats the value using the given formatter.

impl Copy for MavBatteryStatusFlags

impl Flatten for MavBatteryStatusFlags

impl StructuralPartialEq for MavBatteryStatusFlags