Home > resol-vbus-core-nodejs

resol-vbus-core-nodejs package

Node.js library for handling RESOL VBus data.

This library is part of the resol-vbus-core ecosystem.

• [Documentation](https://resol-vbus-core.bugstu.be/) - [Code](https://codeberg.org/DanielWippermann/resol-vbus-core)

Classes

Class	Description
NetLiveTransceiver	A TCP socket based live transceiver.
NetLiveTransceiverBridge	A helper class that pumps data between a socket and a VBus live transceiver.
NetLiveTransceiverEndpoint	A TCP socket based endpoint for the NetLiveTransceiver.

Functions

Function	Description
createNetDiscoverEndpoint(type, options)	Create a discover endpoint that replies to broadcast queries.
fetchDeviceInformation(host, port)	Fetch device information from the public web service API.
netDiscover(options)	Discover LAN-enabled RESOL devices.
netDiscoverIPv4(options)	Discover LAN-enabled RESOL devices using IPv4.
netDiscoverIPv6(options)	Discover LAN-enabled RESOL devices using IPv6.

Interfaces

Interface	Description
CreateNetDiscoverEndpointOptions	Options for the createNetDiscoverEndpoint function.
NetDiscoverOptions	The options for the constructor of NetDiscover.
NetLiveTransceiverChannelInfo	The info about a VBus channel.
NetLiveTransceiverConstructorOptions	The options for the constructor of NetLiveTransceiver.
NetLiveTransceiverEndpointChannelInfo	The info about a VBus channel.
NetLiveTransceiverEndpointConstructorOptions	The options for the constructor of NetLiveTransceiverEndpoint.

Type Aliases

Type Alias	Description
NetLiveTransceiverConnectionState	The state the transceiver connection can be in.