Crate resol_vbus

resol-vbus.rs

A Rust library for processing RESOL VBus data.

Features

• TBD

Modules

live_data_decoder	Functions in this module can be used to decode byte slices of data conforming to the VBus protocol specification into the respective Data variants.
live_data_encoder	Functions in the module can be used to convert a Data variant into the respective live representation according to the VBus protocol specification.
recording_decoder	Functions in this module allow to decode a byte stream conforming to the VBus Recording File Format.
utils	A module containing utitlities functions for processing VBus data.

Structs

BlobReader	A buffering reader.
DataSet	A DataSet contains a set of unique Data.
Datagram	The Datagram type stores information according to the VBus protocol version 2.x.
DeviceSpec	Contains information about a VBus device.
DeviceTemplate	Contains information about a VBus device.
FileListReader	Chains multiple files together in a single Read object.
Header	All VBus data types consist of a Header element.
LiveDataReader	Allows reading Data variants from a Read trait object.
LiveDataWriter	Allows writing the live represenation of Data variants to a Write trait object.
LocalizedText	Combines three TextIndex values for each of the supported languages to form a localized text.
LocalizedTextIndex	A numeric reference to a LocalizedText instance.
Packet	The Packet type stores information according to the VBus protocol version 1.x.
PacketFieldFormatter	A helper type for formatting raw values.
PacketFieldSpec	Contains information about a VBus packet field.
PacketSpec	Contains information about a VBus packet and its fields.
PacketTemplate	Contains information about a VBus packet.
PacketTemplateField	Contains information about a field with the frame data payload of a VBus packet.
PacketTemplateFieldPart	Contains information about one part of a packet field's raw value.
RecordingReader	Allows reading Data variants from a Read trait object.
Specification	The Specification type contains information about known devices and packets.
SpecificationFile	Contains the information from a VSF1 file.
Telegram	The Telegram type stores information according to the VBus protocol version 3.x.
TextIndex	A numeric reference to a Text.
TypeId	A numeric reference to a Type instance.
Unit	A physical unit.
UnitFamilyId	A numeric reference to an UnitFamily instance.
UnitId	A numeric reference to an Unit instance.

Enums

Data	Data is a type that contains one of the supported VBus protocol data variants.
Error	A list of errors that can occur if the VSF1 data cannot be parsed.
Language	Languages supported by VSF1 specification.
StreamBlobLength	Provides information whether a slice of bytes contains a valid blob of data.
Type	A type to describe different data types within the packet fields.
UnitFamily	One of the unit families supported by the VSF1 specification.

Functions

get_power_of_ten

Get the "power of 10" value for common "n"s and calculate it otherwise.

Type Definitions

Result

A specialized Result for this module.