Home > resol-vbus-core-script > ScriptDollar

ScriptDollar interface

The type of the $ argument passed to the defineScript handler.

Signature:

export interface ScriptDollar<S>

Properties

Property	Modifiers	Type	Description
core		typeof core	The resol-vbus-core package.
coreVsf		typeof coreVsf	The resol-vbus-core-vsf package.
specification		core.Specification	The loaded specification.

Methods

Method	Description
connect()	Establish all connections.
createDatagram(options)	Create a Datagram.
createPacket(options)	Create a Packet.
createTelegram(options)	Create a Telegram.
delay(ms)	Delay execution for the provided time.
disconnect()	Disconnect all connections.
getChannelCount()	Get number of connected channels.
getLiveTransceiver(channel)	Get a LiveTransceiver for the provided channel.
onDatagram(fn)	Add a callback for Datagrams.
onIdle(fn)	Add a callback for idle events.
onJunkData(fn)	Add a callback for incoming junk data events.
onPacket(fn)	Add a callback for Packets.
onRawData(fn)	Add a callback for incoming raw data events.
onTelegram(fn)	Add a callback for Telegrams.
registerService(service)	Register a service that can be used from other scripts.
send(channel, data)	Send raw data.
send(header)	Semd a Header.