Module resol_vbus::specification_file

A module that parses the contents of a VBus Specification File Version 1 (VSF1).

The VBus Specification File format is used to provide information about VBus Protocol Version 1.x Packets and their frame data payload. The file contains:

See the RESOL VBus Specification File Format v1 for details.

Structs

DeviceTemplate	Contains information about a VBus device.
LocalizedText	Combines three TextIndex values for each of the supported languages to form a localized text.
LocalizedTextIndex	A numeric reference to a LocalizedText instance.
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.
SpecificationFile	Contains the information from a VSF1 file.
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

Error	A list of errors that can occur if the VSF1 data cannot be parsed.
Language	Languages supported by VSF1 specification.
Type	A type to describe different data types within the packet fields.
UnitFamily	One of the unit families supported by the VSF1 specification.

Type Definitions

Result

A specialized Result for this module.