Home > resol-vbus-core-nodejs > NetLiveTransceiver

NetLiveTransceiver class

A TCP socket based live transceiver.

Signature:

export declare class NetLiveTransceiver

Constructors

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

Properties

Property	Modifiers	Type	Description
bridge		NetLiveTransceiverBridge | null	The current bridge.
channel?		number | ((channels: NetLiveTransceiverChannelInfo[]) => Promise<number | null>)	(Optional) The channel to connect to.
connectionState		NetLiveTransceiverConnectionState	The current connection state.
liveTransceiver		LiveTransceiver	The live transceiver.
nextReconnectTimeout		number	The next reconnect timeout.
onConnectionStateChange?		(newConnectionState: NetLiveTransceiverConnectionState) => void	(Optional) The callback to report connection state changes to.
password?		string	(Optional) The password to connect with.
skipCommandPhase		boolean	Whether the transceiver should skip the command phase and directly go into data mode.
socket		net.Socket | null	The current socket.
socketOptions		net.NetConnectOpts	The options to connect the socket with.
viaTag?		string	(Optional) The via tag to connect with.

Methods

Method	Modifiers	Description
_setConnectionState(newConnectionState)		Set the current connection state.
connect()		Connect to the live VBus stream, optionally performing the VBus-over-TCP handshake.
disconnect()		Disconnect from the live VBus stream.
getConnectionState()		Get the current connection state.