Struct resol_vbus::specification_file::SpecificationFile

pub struct SpecificationFile {
    pub datecode: i32,
    pub texts: Vec<String>,
    pub localized_texts: Vec<LocalizedText>,
    pub units: Vec<Unit>,
    pub device_templates: Vec<DeviceTemplate>,
    pub packet_templates: Vec<PacketTemplate>,
}

Contains the information from a VSF1 file.

Fields

datecode: i32

Date of VSF creation in format ‘YYYMMDD’

texts: Vec<String>

List of texts.

localized_texts: Vec<LocalizedText>

List of localized texts.

units: Vec<Unit>

List of units.

device_templates: Vec<DeviceTemplate>

List of device templates.

packet_templates: Vec<PacketTemplate>

List of packet templates.

Implementations

impl SpecificationFile

pub fn from_bytes(bytes: &[u8]) -> Result<SpecificationFile>

Construct a new SpecificationFile from a byte slice of VSF1 data.

pub fn new_default() -> SpecificationFile

Construct a new SpecificationFile from the embedded default VSF data.

pub fn text_by_index(&self, idx: &TextIndex) -> &str

Get text by its index.

pub fn localized_text_by_index(
    &self,
    idx: &LocalizedTextIndex,
    language: Language
) -> &str

Get localized text by its index and language.

pub fn unit_family_by_id(&self, id: &UnitFamilyId) -> UnitFamily

Get UnitFamily by its ID.

pub fn unit_by_id(&self, id: &UnitId) -> &Unit

Get Unit by its index.

pub fn unit_by_unit_code(&self, unit_code: &str) -> Option<&Unit>

Get Unit by unit code.

pub fn type_by_id(&self, id: &TypeId) -> Type

Get Type by its ID.

pub fn find_device_template(
    &self,
    self_address: u16,
    peer_address: u16
) -> Option<&DeviceTemplate>

Find a DeviceTemplate matching the self and peer addresses.

pub fn find_packet_template(
    &self,
    destination_address: u16,
    source_address: u16,
    command: u16
) -> Option<&PacketTemplate>

Find a PacketTemplate matching the destination and source addresses as well as the command.

pub fn convert_value(
    &self,
    value: f64,
    src_unit: &Unit,
    dst_unit: &Unit
) -> Result<f64>

Convert a value from one Unit to another.

Trait Implementations

impl Debug for SpecificationFile

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

Formats the value using the given formatter.