Crate resol_vbus

resol-vbus.rs

A Rust library for processing RESOL VBus data.

Features

• Provides types for different VBus data versions
• Processes live and recorded VBus data streams
• Converts binary VBus data into human or machine readable format

Planned, but not yet implemented features

• Discovers LAN-enabled RESOL devices on the local network
• Allows to send parameterization commands to a controller
• Improve filtering and conversion of VBus data fields

Supported Devices & Services

• All current RESOL controllers with VBus
• RESOL DL2 Datalogger
• RESOL DL3 Datalogger
• RESOL VBus/LAN interface adapter
• RESOL VBus/USB interface adapter
• RESOL VBus.net

Technical Information & Specifications

• RESOL VBus Google Group
• RESOL VBus Protocol Specification
• RESOL VBus Packet List
• RESOL VBus Recording File Format
• RESOL VBus Specification File Format v1
• RESOL VBus over TCP Specification
• RESOL DL2 (v1) Data Download API
• RESOL DL2 (v2) & DL3 Data Download API

Examples

TBD

Reexports

pub use specification_file::Language;

pub use specification_file::SpecificationFile;

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.
specification_file	A module that parses the contents of a VBus Specification File Version 1 (VSF1).
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.
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.
LiveDataRecordingReader	A RecordingReader for type 0x88 live data recordings.
LiveDataWriter	Allows writing the live represenation of Data variants to a Write trait object.
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.
RecordingReader	Allows reading Data variants from a Read trait object.
Specification	The Specification type contains information about known devices and packets.
Telegram	The Telegram type stores information according to the VBus protocol version 3.x.

Enums

Data	Data is a type that contains one of the supported VBus protocol data variants.
StreamBlobLength	Provides information whether a slice of bytes contains a valid blob of data.

Functions

get_power_of_ten

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