Home > resol-vbus-core

resol-vbus-core package

ECMAScript library for handling RESOL VBus data.

This library is the foundation of the resol-vbus-core ecosystem.

• [Documentation](https://resol-vbus-core.bugstu.be/) - [Code](https://codeberg.org/DanielWippermann/resol-vbus-core)

Classes

Class	Description
ConfigurationOptimizer	Optimize the list of configurable values based on the controller's configuration.
Datagram	A VBus version 2.x datagram.
DeviceSpecification	A device specification.
Header	A VBus header, the base primitive for all other VBus data variants.
HeaderSet	A set of unique VBus Headers.
LiveDecoder	A decoder for live VBus data.
LiveEncoder	A live VBus protocol encoder.
LiveTransceiver	A transceiver for live VBus data.
Packet	A VBus version 1.x packet.
PacketField	A packet field.
PacketFieldSpecification	A packet field specification.
PacketSpecification	A packet specification.
RecordingDecoder	A decoder of the VBus Recording File Format.
Specification	A specification.
Telegram	A VBus version 3.x telegram.
TimestampInterval	A helper class managing timestamp-based interval events.

Functions

Function	Description
calcAndCompareChecksum(version, buffer, start, end)	Calculate the checksum and compare it to the stored one.
calcAndSetChecksum(version, buffer, start, end)	Calculate the checksum and store it.
calcChecksum(version, buffer, start, end)	Calculate the checksum for provided VBus version.
calcChecksumV0(buffer, start, end)	Calculate the checksum for minor VBus version 0 content.
calcChecksumV1(buffer, start, end)	Calculate the checksum for minor VBus version 1 content.
encodeChannelRecord(timestamp, channel)	Encode a type 77 "Channel" record.
encodeDatagramRecord(dgram)	Encode a Datagram into a type 66 record.
encodeHeaderRecord(header)	Encode any Header into a type 66 record.
encodeHeaderSetRecords(headerSet)	Encode a HeaderSet into its records.
encodeHeaderSetRecords(headerSet, joinBuffers)	Encode a HeaderSet into its records.
encodeHeaderSetRecords(headerSet, joinBuffers)	Encode a HeaderSet into its records.
encodePacketRecord(packet)	Encode a Packet into a type 66 record.
encodeStartOfHeaderSetRecord(timestamp)	Encode a type 44 "Start-Of-Header-Set" record.
encodeTelegramRecord(tgram)	Encode a Telegram into a type 66 record.
extractSeptett(srcBuffer, srcStart, srcEnd, dstBuffer, dstStart)	Extract the septett byte from the payload.
injectSeptett(srcBuffer, srcStart, srcEnd, dstBuffer, dstStart)	Inject the septett byte back into the payload.
liveDecodeDatagram(buffer, channel)	Decode a datagram.
liveDecodePacket(buffer, channel)	Decode a packet.
liveDecodeTelegram(buffer, channel)	Decode a telegram.
liveEncode(input)	Encode a VBus header into its live protocol representation.
liveEncodeDatagram(dgram)	Encode a VBus datagram into its live protocol representation.
liveEncodePacket(packet)	Encode a VBus packet into its live protocol representation.
liveEncodeTelegram(tgram)	Encode a VBus telegram into its live protocol representation.
parseConfigurationOptimizerFile(buffer)	Parses a buffer containing a data based on the "Configuration Optimizer File Format v2" specification.

Interfaces

Interface	Description
ConfigurationOptimizerEnumValueType	A enumeration value type mapping numerical values to identifiers.
ConfigurationOptimizerEnumValueTypeValue	A numerical value that can be mapped to an identifier.
ConfigurationOptimizerFile	The contents of a configuration optimizer file.
ConfigurationOptimizerRule	A rule to determine a list of values to ignore based on another value.
ConfigurationOptimizerValue	A controller value that can be configured over the VBus.
DatagramConstructorOptions	Options for the constructor of Datagram.
DeviceSpecificationConstructorOptions	Options for the constructor of DeviceSpecification.
HeaderConstructorOptions	The options for the constructor of Header.
HeaderSetConstructorOptions	Options for the constructor of HeaderSet.
LiveDecoderConstructorOptions	The options for the constructor of LiveDecoder.
LiveEncoderConstructorOptions	Options for the constructor of LiveEncoder.
LiveTransceiverActionOptions	Options for action methods.
LiveTransceiverActionTriesAndTimeouts	Options for several action methods.
LiveTransceiverConstructorOptions	Options for the constructor of LiveTransceiver.
PacketConstructorOptions	Options for the constructor of Packet.
PacketFieldConstructorOptions	Options for the constructor of PacketField.
PacketSpecificationConstructorOptions	Options for the constructor of PacketSpecification.
RecordingDecoderConstructorOptions	The options for the constructor of RecordingDecoder.
RecordingDecoderRecord	A record.
SpecificationConstructorOptions	Options for the constructor of the Specification.
TelegramConstructorOptions	The options passed to the constructor of Telegram.
TimestampIntervalConstructorOptions	The options passed to the constructor of TimestampInterval.
VsfDeviceTemplate	A VSF device template.
VsfLocalizedText	A VSF localized text.
VsfPacketTemplate	A VSF packet template.
VsfPacketTemplateField	A VSF packet template field.
VsfPacketTemplateFieldPart	A VSF packet template field part.
VsfSpecification	The root of a VSF specification.
VsfType	A VSF type.
VsfUnit	A VSF unit.
VsfUnitFamily	A VSF unit family.

Namespaces

Namespace	Description
utils

Variables

Variable	Description
ConfigurationOptimizerRuleOperatorIsBetween	The rule operator for "is between args[0] and args[1], inclusively".
ConfigurationOptimizerRuleOperatorIsEqualTo	The rule operator for "is equal to args[0]".
ConfigurationOptimizerRuleOperatorIsNotEqualTo	The rule operator for "is not equal to args [0]".

Type Aliases

Type Alias	Description
ConfigurationOptimizerRuleOperator	The type of all possible rule operators.
LiveDecoderEventHandler	The event handler used for several callbacks.
LiveEncoderPhase	The phases of the internal state machine.