Home > resol-vbus-core > Specification

Specification class

A specification.

Signature:

export declare class Specification

Constructors

Constructor	Modifiers	Description
(constructor)(options)		Construct a specification.

Properties

Property	Modifiers	Type	Description
deviceSpecificationById		Map<string, DeviceSpecification>	The cache of known device specifications.
packetSpecificationById		Map<string, PacketSpecification>	The cache of known packet specifications.
vsfSpecification		VsfSpecification	The VSF specification.

Methods

Method	Modifiers	Description
getDeviceSpecification(id)		Get a device specification by its ID.
getDeviceSpecification(header, which)		Get a device specification for a header and its participant.
getDeviceSpecification(channel, selfAddress, peerAddress)		Get a device specification.
getPacketFieldsForHeaders(headers)		Get a list of packet fields for the provided headers.
getPacketSpecification(id)		Get a packet specification by its ID.
getPacketSpecification(packet)		Get a packet specification for a packet.
getPacketSpecification(channel, destinationAddress, sourceAddress, command)		Get a packet specification.
parseVsfSpecification(buffer)	static	Parse a VSF buffer into its specification.