Struct mavlink::development::MavBatteryStatusFlags

pub struct MavBatteryStatusFlags { /* private fields */ }

Available on crate feature development only.

Battery status flags for fault, health and state indication.

Implementations

impl MavBatteryStatusFlags

pub const MAV_BATTERY_STATUS_FLAGS_NOT_READY_TO_USE: Self = _

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 MAV_BATTERY_STATUS_FLAGS_CHARGING: Self = _

Battery is charging.

pub const MAV_BATTERY_STATUS_FLAGS_CELL_BALANCING: Self = _

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

pub const MAV_BATTERY_STATUS_FLAGS_FAULT_CELL_IMBALANCE: Self = _

Battery cells are not balanced. Not ready to use.

pub const MAV_BATTERY_STATUS_FLAGS_AUTO_DISCHARGING: Self = _

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

pub const MAV_BATTERY_STATUS_FLAGS_REQUIRES_SERVICE: Self = _

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 MAV_BATTERY_STATUS_FLAGS_BAD_BATTERY: Self = _

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 MAV_BATTERY_STATUS_FLAGS_PROTECTIONS_ENABLED: Self = _

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 MAV_BATTERY_STATUS_FLAGS_FAULT_PROTECTION_SYSTEM: Self = _

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 MAV_BATTERY_STATUS_FLAGS_FAULT_OVER_VOLT: Self = _

One or more cells are above their maximum voltage rating.

pub const MAV_BATTERY_STATUS_FLAGS_FAULT_UNDER_VOLT: Self = _

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 MAV_BATTERY_STATUS_FLAGS_FAULT_OVER_TEMPERATURE: Self = _

Over-temperature fault.

pub const MAV_BATTERY_STATUS_FLAGS_FAULT_UNDER_TEMPERATURE: Self = _

Under-temperature fault.

pub const MAV_BATTERY_STATUS_FLAGS_FAULT_OVER_CURRENT: Self = _

Over-current fault.

pub const MAV_BATTERY_STATUS_FLAGS_FAULT_SHORT_CIRCUIT: Self = _

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

pub const MAV_BATTERY_STATUS_FLAGS_FAULT_INCOMPATIBLE_VOLTAGE: Self = _

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

pub const MAV_BATTERY_STATUS_FLAGS_FAULT_INCOMPATIBLE_FIRMWARE: Self = _

Battery firmware is not compatible with current autopilot firmware.

pub const MAV_BATTERY_STATUS_FLAGS_FAULT_INCOMPATIBLE_CELLS_CONFIGURATION: Self = _

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

pub const MAV_BATTERY_STATUS_FLAGS_CAPACITY_RELATIVE_TO_FULL: Self = _

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 MAV_BATTERY_STATUS_FLAGS_EXTENDED: Self = _

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

pub const fn empty() -> Self

Returns an empty set of flags.

pub const fn all() -> Self

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

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

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

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

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u32) -> Self

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

Safety

The caller of the bitflags! macro can chose to allow or disallow extra bits for their bitflags type.

The caller of from_bits_unchecked() has to ensure that all bits correspond to a defined flag or that extra bits are valid for this bitflags type.

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

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

Returns true if there are flags common to both self and other.

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

Returns true if all of the flags in other are contained within self.

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

Inserts or removes the specified flags depending on the passed value.

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

Returns the intersection between the flags in self and other.

Specifically, the returned set contains only the flags which are present in both self and other.

This is equivalent to using the & operator (e.g. ops::BitAnd), as in flags & other.

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

Returns the union of between the flags in self and other.

Specifically, the returned set contains all flags which are present in either self or other, including any which are present in both (see Self::symmetric_difference if that is undesirable).

This is equivalent to using the | operator (e.g. ops::BitOr), as in flags | other.

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

Returns the difference between the flags in self and other.

Specifically, the returned set contains all flags present in self, except for the ones present in other.

It is also conceptually equivalent to the “bit-clear” operation: flags & !other (and this syntax is also supported).

This is equivalent to using the - operator (e.g. ops::Sub), as in flags - other.

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

Returns the symmetric difference between the flags in self and other.

Specifically, the returned set contains the flags present which are present in self or other, but that are not present in both. Equivalently, it contains the flags present in exactly one of the sets self and other.

This is equivalent to using the ^ operator (e.g. ops::BitXor), as in flags ^ other.

pub const fn complement(self) -> Self

Returns the complement of this set of flags.

Specifically, the returned set contains all the flags which are not set in self, but which are allowed for this type.

Alternatively, it can be thought of as the set difference between Self::all() and self (e.g. Self::all() - self)

This is equivalent to using the ! operator (e.g. ops::Not), as in !flags.

impl MavBatteryStatusFlags

pub const DEFAULT: Self = Self::MAV_BATTERY_STATUS_FLAGS_NOT_READY_TO_USE

Trait Implementations

impl Binary for MavBatteryStatusFlags

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

Formats the value using the given formatter.

impl BitAnd for MavBatteryStatusFlags

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

Returns the intersection between the two sets of flags.

type Output = MavBatteryStatusFlags

The resulting type after applying the & operator.

impl BitAndAssign for MavBatteryStatusFlags

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

impl BitOr for MavBatteryStatusFlags

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

Returns the union of the two sets of flags.

type Output = MavBatteryStatusFlags

The resulting type after applying the | operator.

impl BitOrAssign for MavBatteryStatusFlags

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

impl BitXor for MavBatteryStatusFlags

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

Returns the left flags, but with all the right flags toggled.

type Output = MavBatteryStatusFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for MavBatteryStatusFlags

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

impl Clone for MavBatteryStatusFlags

fn clone(&self) -> MavBatteryStatusFlags

Returns a copy 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

Formats the value using the given formatter.

impl Default for MavBatteryStatusFlags

fn default() -> Self

Returns the “default value” for a type.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Extend<MavBatteryStatusFlags> for MavBatteryStatusFlags

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

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 FromIterator<MavBatteryStatusFlags> for MavBatteryStatusFlags

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

Creates a value from an iterator.

impl Hash for MavBatteryStatusFlags

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LowerHex for MavBatteryStatusFlags

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

Formats the value using the given formatter.

impl Not for MavBatteryStatusFlags

fn not(self) -> Self

Returns the complement of this set of flags.

type Output = MavBatteryStatusFlags

The resulting type after applying the ! operator.

impl Octal for MavBatteryStatusFlags

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

Formats the value using the given formatter.

impl Ord for MavBatteryStatusFlags

fn cmp(&self, other: &MavBatteryStatusFlags) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

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 PartialOrd for MavBatteryStatusFlags

fn partial_cmp(&self, other: &MavBatteryStatusFlags) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for MavBatteryStatusFlags

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for MavBatteryStatusFlags

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

Returns the set difference of the two sets of flags.

type Output = MavBatteryStatusFlags

The resulting type after applying the - operator.

impl SubAssign for MavBatteryStatusFlags

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

impl UpperHex for MavBatteryStatusFlags

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

Formats the value using the given formatter.

impl Copy for MavBatteryStatusFlags

impl Eq for MavBatteryStatusFlags

impl StructuralPartialEq for MavBatteryStatusFlags