Home > resol-vbus-core-toolbox

resol-vbus-core-toolbox package

Scripting utility for 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
ArgParser	A command-line argument parser.
EventBus	The event bus for exchanging EventBusEvents.
NetConnection	A Connection using network sockets.
Script	A script.
ScriptEngine	The script engine.
SerialPortConnection	A connection using serialport.SerialPort.
VirtualConnection	A virtual, in-memory, loopback-only connection.

Abstract Classes

Abstract Class	Description
Connection	A connection to a VBus live data source.

Functions

Function	Description
main(args)	The main function.
parseCommandLineArgs(args)	Parse command line arguments.
parseConfig(configContents, filename)	Transpile the config script.

Interfaces

Interface	Description
CliConfigFromFile	A pseudo-connection config using the --config option.
CliParserFailure	The result in case of a failure to parse command-line args.
CliParserOptions	The result in case of a success to parse command-line args.
CliParserOutput	The result in case of a direct output produced by command-line args.
Config	The configuration.
EventBusEvents	Events that can be exchanged over the EventBus.
NetConnectionCliConfig	A net-based connection config using the --host option.
NetConnectionConfig	A connection using the NetLiveTransceiver.
ParsedConfig	The result of the parseConfig function.
ScriptConstructorOptions	Options for the constructor of Script.
SerialPortConnectionCliConfig	A serial-port-based connection config using the --path option.
SerialPortConnectionConfig	A connection using the SerialPort.
VirtualConnectionCliConfig	A virtual connection config using the --virtual option.
VirtualConnectionConfig	A virtual connection that simply receives its own echo.

Namespaces

Namespace	Description
utils

Type Aliases

Type Alias	Description
CliParserResult	The result of parseCommandLineArgs.
ConfigExports	The type of the exports object passed into the module running defineConfig().
ConfigFunction	The type of the function running defineConfig().
ConfigModule	The type of the module object passed into the module running defineConfig().
ConnectionCliConfig	One of the connection config variants.
ConnectionConfig	The configuration for the different kinds of connections.
RequireConfigFunction	The type of the require function passed into the module running defineConfig().