Struct canadensis_data_types::reg::udral::service::battery::error_0_1::Error

#[repr(C, packed)]
pub struct Error {
    pub value: u8,
}

reg.udral.service.battery.Error.0.1

Fixed size 1 bytes

Generic error codes reported by the service provider. An error is reported when the corresponding parameter exceeds its safe operating area (SOA) as defined by the vendor; see https://en.wikipedia.org/wiki/Safe_operating_area. As long as an error condition is present, the service health should not be NOMINAL.

If there are multiple error conditions present, the most severe one should be reported. The severity ordering is implementation-defined. Barring special requirements, it is recommended to give preference to errors whose code is smaller (e.g., BAD_BATTERY trumps TEMPERATURE_COLD).

Fields

value: u8

saturated uint8

Always aligned, size 8 bits

Implementations

impl Error

pub const NONE: u8 = 0u8

Normal operation.

pub const BAD_BATTERY: u8 = 10u8

The battery should not be used anymore. Detection criteria are implementation-defined.

pub const NEEDS_SERVICE: u8 = 11u8

The battery requires offline maintenance.

pub const BMS_ERROR: u8 = 20u8

An internal error in the battery management system, not related to the battery itself.

pub const CONFIGURATION: u8 = 30u8

The battery/BMS/node/service configuration is missing or invalid.

pub const OVERDISCHARGE: u8 = 50u8

The battery is discharged beyond the design limits and may have incurred damage.

pub const OVERLOAD: u8 = 51u8

The charge or discharge rate exceeds the safe operating limits.

pub const CELL_OVERVOLTAGE: u8 = 60u8

pub const CELL_UNDERVOLTAGE: u8 = 61u8

Voltage of one of the battery cells exceeds its SOA.

pub const CELL_COUNT: u8 = 62u8

The sum of cell voltages is far from the total pack voltage. The threshold is implementation-defined.

pub const TEMPERATURE_HOT: u8 = 100u8

pub const TEMPERATURE_COLD: u8 = 101u8

At least one cell is above/below the temperature SOA.

Trait Implementations

impl AsBytes for Errorwhere u8: AsBytes,

fn as_bytes(&self) -> &[u8]

Gets the bytes of this value.

fn as_bytes_mut(&mut self) -> &mut [u8]where Self: FromBytes,

Gets the bytes of this value mutably.

fn write_to<B>(&self, bytes: B) -> Option<()>where B: ByteSliceMut,

Writes a copy of self to bytes.

fn write_to_prefix<B>(&self, bytes: B) -> Option<()>where B: ByteSliceMut,

Writes a copy of self to the prefix of bytes.

fn write_to_suffix<B>(&self, bytes: B) -> Option<()>where B: ByteSliceMut,

Writes a copy of self to the suffix of bytes.

impl DataType for Error

const EXTENT_BYTES: Option<u32> = None

This type is sealed.

impl Deserialize for Error

fn deserialize(cursor: &mut ReadCursor<'_>) -> Result<Self, DeserializeError>where Self: Sized,

Deserializes a value and returns it

fn deserialize_zero_copy(cursor: &mut ReadCursor<'_>) -> Selfwhere Self: Sized + AsBytes + FromBytes,

Deserializes a value from a slice of bytes and returns it

fn deserialize_from_bytes(bytes: &[u8]) -> Result<Self, DeserializeError>where Self: Sized,

A convenience function that creates a cursor around the provided bytes and calls deserialize

impl FromBytes for Errorwhere u8: FromBytes,

fn read_from<B>(bytes: B) -> Option<Self>where B: ByteSlice, Self: Sized,

Reads a copy of Self from bytes.

fn read_from_prefix<B>(bytes: B) -> Option<Self>where B: ByteSlice, Self: Sized,

Reads a copy of Self from the prefix of bytes.

fn read_from_suffix<B>(bytes: B) -> Option<Self>where B: ByteSlice, Self: Sized,

Reads a copy of Self from the suffix of bytes.

fn new_zeroed() -> Selfwhere Self: Sized,

Creates an instance of Self from zeroed bytes.

impl Serialize for Error

fn size_bits(&self) -> usize

Returns the size of the encoded form of this value, in bits

fn serialize(&self, cursor: &mut WriteCursor<'_>)

Serializes this value into a buffer

fn serialize_to_bytes(&self, bytes: &mut [u8])

A convenience function that creates a cursor around the provided bytes and calls serialize

impl Message for Error