Skip to content

Home > resol-vbus-core-nodejs > NetLiveTransceiverEndpointConstructorOptions

NetLiveTransceiverEndpointConstructorOptions interface

The options for the constructor of NetLiveTransceiverEndpoint.

Signature:

typescript
export interface NetLiveTransceiverEndpointConstructorOptions

Properties

Property

Modifiers

Type

Description

canSwitchToDataMode?

() => Promise<void>

(Optional) The callback to verify switching to data mode.

channel?

number

(Optional) The currently selected 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

(Optional) The response after accepting a new connection.

liveTransceiverOptions?

LiveTransceiverConstructorOptions

(Optional) The options to create the live transceiver with.

skipCommandPhase?

boolean

(Optional) Whether the transceiver should skip the command phase and directly go into data mode.

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.