Home > resol-vbus-core-nodejs > NetLiveTransceiverEndpoint

NetLiveTransceiverEndpoint class

A TCP socket based endpoint for the NetLiveTransceiver.

Signature:

export declare class NetLiveTransceiverEndpoint

Constructors

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

Properties

Property	Modifiers	Type	Description
bridge		NetLiveTransceiverBridge | null	The bridge.
canSwitchToDataMode?		() => Promise<void>	(Optional) The callback to verify switching to data mode.
channel?		number	(Optional) The provided VBus channel.
getChannelList?		() => Promise<NetLiveTransceiverEndpointChannelInfo[]>	(Optional) The callback to get a list of active channels.
handleUnknownCommand?		(line: string) => Promise<string>	(Optional) The callback to handle unknown commands.
helloResponse		string	The response after accepting a new connection.
liveTransceiver		LiveTransceiver	The live transceiver.
password?		string	(Optional) The provided password.
skipCommandPhase		boolean	Whether the transceiver should skip the command phase and directly go into data mode.
socket		net.Socket | null	The current socket.
verifyChannel?		(channel: number) => Promise<void>	(Optional) The callback to verify the provided channel.
verifyPassword?		(password: string) => Promise<void>	(Optional) The callback to verify the provided password.
verifyViaTag?		(viaTag: string) => Promise<void>	(Optional) The callback to verify the provided via tag.
viaTag?		string	(Optional) The provided via tag.

Methods

Method	Modifiers	Description
connect()		Connect to the live VBus stream, optionally performing the VBus-over-TCP handshake.
disconnect()		Disconnect from the live VBus stream.