resol-vbus
Advanced tools
You can find the work-in-progress documentation for this project here:
http://danielwippermann.github.io/resol-vbus/
The JSDoc-generated documentation is located here:
http://danielwippermann.github.io/resol-vbus/#/jsdoc
If you want to use this module in your own application, you can just install it from the npm registry:
⌘ npm install --save resol-vbus
If you want to contribute to it you might want to check out the latest version from GitHub:
⌘ git clone https://github.com/danielwippermann/resol-vbus.git
⌘ cd resol-vbus
⌘ npm install
⌘ node examples/<name>/index.js
To start a single run of the test suite just enter the following command into your shell:
⌘ npm test
To run the tests after each change to the source just enter the following command into your shell:
⌘ npm test -- --watch
ConfigurationOptimizers do not yet detect the firmware version running on the controller to be configured.
That sometimes causes configuration loads and saves to fail because unknown values are read from or written to
(e.g. using the "customizer" example on a DeltaSol MX with firmware version 1.11 or below).ConfigurationOptimizer constructs in favor of RESOL's official support.resol-vbusoptions object passed into TcpDataSourceProvider#discoverDevices
needed an ipv6 boolean value set to true. That option was removed in favor of a
family string value which defaults to "IPv4" but can be set to "IPv6" to
perform a IPv6 device discovery. In that case the two other options localAddress
and broadcastInterface are required as well. See the documentation for more details.TcpConnectionEndpoint.connectionAttemptFailed event to TcpConnectionEndpoint.extendFieldData option to DLxJsonConverter.SpecificationFile#getPacketTemplate.TcpConnection#disableReconnect.TcpConnection reconnect.SerialConnection and SerialDataSourceProviderRecorder, DLxRecorder and FileSystemRecorder
The Recorder style of interfaces was not well thought out and unreliable. This
version removes it, with no replacement!lodash dependency
Although this removal was done with great caution and a lot of test coverage, there
might be side effects we have not thought of.Datagram and Telegram support to VBusRecordingConverter.DLxRecorder class has
been deprecated, the code was refactored to use a Fetch API implementation instead.
But since the method DLxRecorder#downloadToStream expected "request"-specific options,
it had to be changed, too. This method was renamed to DLxRecorder#_downloadToStream to
indicate that it is a class-private method and its signature was changed to accept
Fetch API specific options.[BREAKING CHANGE] Replacing custom inheritance code with class syntax
Up to this version inheritance was established using a custom extend function.
Since only modern ECMAscript runtimes are supported since the last release the code was
refactored to use the ECMAscript class syntax instead. In that process the extend
function was removed, both the standalone one and the static class function that was
added to every "class".
[BREAKING CHANGE] Returning a Promise from channelListCallback callback
The TcpConnection accepts a channelListCallback. This callback gets called with the
list of channels returned from the CHANNELLIST command and a done callback.
Up to this version the return value of the channelListCallback was ignored. Starting
with this version this behaviour is changed if the return value of the callback is
a Promise:
Promise reject, the done callback is automatically called with done(reason)Promise resolves, the done callback is automatically called with
done(null, result)This allows the channelListCallback to be async.
Errors thrown by TcpConnection#connect now have a vbusPhase member describing on which
VBus-over-TCP command the error occurred
[BREAKING CHANGE] Returning a Promise from filterPacket or filterDatagram callbacks
The Connection#transceive method and many of the helper methods that use it
accept a filterPacket and/or filterDatagram callback. Those callbacks get called
with the data to filter and a done callback.
Up to this version the return value of the filter callbacks was ignored. Starting with
this version this behaviour is changed if the return value of the filter callbacks is
a Promise:
Promise rejects, the done callback is automatically called with done(reason)Promise resolves with null or undefined, the done callback is not calledPromise resolves with any other result, the done callback is automatically
called with done(null, result)This allows async filter callbacks!
Add SerialConnection#baudrate option.
Stop running Travis tests under Node 6.
Some dependency of jest does not work under Node 6 making tests break
for that target. The resol-vbus library itself might still work under
Node 6, but there is no guarantee...
Promise implementation in favor of built-in, native one.Promise return values no longer provide the finally and done methods.utils.promise, utils.Promise and utils.cancelablePromise.reportProgress and checkCanceled options to ConnectionCustomizer#transceive{Configuration,Value} as a replacement to the previously used cancelablePromise solution.Buffer support to Connection#(get|set)ValueById for values larger than 32-bit.Connection#getCaps1.Connection class.VBusRecordingConverter.Specification from a SpecificationFile.vbustouch-proxy example with text data logging feature.VBusRecordingConverter to support fast topology-only scanvbustouch-proxy examplesetRawValueFirst release to the NPM registry.
RESOL, VBus, VBus.net and others are trademarks or registered trademarks of RESOL - Elektronische Regelungen GmbH.
All other trademarks are the property of their respective owners.
The MIT License (MIT)
Copyright (c) 2013-present, Daniel Wippermann.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
FAQs
A JavaScript library for processing RESOL VBus data
We found that resol-vbus demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Axios compromise traced to social engineering, showing how attacks on maintainers can bypass controls and expose the broader software supply chain.
Security News
Node.js has paused its bug bounty program after funding ended, removing payouts for vulnerability reports but keeping its security process unchanged.
Security News
The Axios compromise shows how time-dependent dependency resolution makes exposure harder to detect and contain.