Home > resol-vbus-core > LiveTransceiver

LiveTransceiver class

A transceiver for live VBus data.

Signature:

export declare class LiveTransceiver

Constructors

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

Properties

Property	Modifiers	Type	Description
decoder		LiveDecoder	The live decoder used for reception.
encoder		LiveEncoder	The live encoder used for transmission.
onDatagram?		(dgram: Datagram) => void	(Optional) Callback for received datagrams.
onIdle?		() => void	(Optional) Callback when the encoder part is currently idle.
onPacket?		(packet: Packet) => void	(Optional) Callback for received packets.
onTelegram?		(tgram: Telegram) => void	(Optional) Callback for received telegrams.
selfAddress		number	The address used by the transceiver.

Methods

Method	Modifiers	Description
beginBulkValueTransaction(peerAddress, txTimeoutS, options)		Begin a bulk value transaction.
commitBulkValueTransaction(peerAddress, options)		Commit a bulk value transaction.
decode(buffer, start, end)		Decode a chunk of VBus live data.
getCaps1(peerAddress, options)		Get the capabilities (part 1).
getEncoder()		Get the encoder.
getStorageActivity(peerAddress, options)		Get the storage activity state.
getValueByIndex(peerAddress, valueIndex, options)		Get a (menu) value.
getValueIdHashByIndex(peerAddress, valueIndex, options)		Get the ID hash of a (menu) value by its index.
getValueIndexByIdHash(peerAddress, valueIdHash, options)		Get the index of a (menu) value by its ID hash.
performAction(options)		Perform an action.
ping(peerAddress, param16, param32, options)		Ping another peer.
releaseBus(peerAddress, options)		Hand back bus control to the master.
rollbackBulkValueTransaction(peerAddress, options)		Rollback a bulk value transaction.
setBulkValueByIndex(peerAddress, valueIndex, value, options)		Set a value during a bulk value transaction.
setValueByIndex(peerAddress, valueIndex, value, options)		Set a (menu) value.
waitForAnyHeader(timeoutMs)		Wait for any VBus header.
waitForFreeBus(timeoutMs)		Wait for the master's datagram to offer the bus control.