Home > resol-vbus-core > LiveDecoder

LiveDecoder class

A decoder for live VBus data.

Signature:

export declare class LiveDecoder

Constructors

Constructor	Modifiers	Description
(constructor)(options)		Construct a live decoder.

Properties

Property	Modifiers	Type	Description
buffer		Uint8Array	The internal buffer.
bufferIndex		number	The index inside the buffer up to which data has been written.
channel		number	The VBus channel.
onDatagram		LiveDecoderEventHandler<Datagram> | null	Callback to inform when a datagram was decoded.
onJunkData		LiveDecoderEventHandler<Uint8Array> | null	Callback to inform when invalid data was decoded.
onPacket		LiveDecoderEventHandler<Packet> | null	Callback to inform when a packet was decoded.
onRawData		LiveDecoderEventHandler<Uint8Array> | null	Callback to inform when raw data was received.
onTelegram		LiveDecoderEventHandler<Telegram> | null	Callback to inform when a telegram was decoded.

Methods

Method	Modifiers	Description
decode(providedBuffer, start, end)		Decode a chunk of data.
reset()		Reset the decoder.