- Connects to various RESOL VBus devices
- Processes live and recorded VBus data streams
- Discovers LAN-enabled RESOL devices on the local network
- Allows to send parameterization commands to a controller
- Synchronizes recorded VBus data from a RESOL datalogger to your local file system
- Converts recorded VBus data into human or machine readable formats, optionally allowing to filter the output
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
- All current RESOL controllers with VBus
- RESOL DL2 Datalogger
- RESOL DL3 Datalogger
- RESOL KM2 Communication module
- RESOL VBus/LAN interface adapter
- RESOL VBus/USB interface adapter
- RESOL VBus.net
- RESOL VBus Google Group
- RESOL VBus Protocol Specification
- RESOL VBus Packet List
- RESOL VBus Recording File Format
- RESOL VBus Specification File Format v1
- RESOL VBus over TCP Specification
- RESOL DL2 (v2) & DL3 Data Download API
- The
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).
- Remove current
ConfigurationOptimizer
constructs in favor of RESOL's official support.
- [BREAKING CHANGE] Dropping support for Node.js versions < 16
- [BREAKING CHANGE] Changed IPv6 device discovery support activation.
Previously the
options
object passed intoTcpDataSourceProvider#discoverDevices
needed anipv6
boolean value set totrue
. That option was removed in favor of afamily
string value which defaults to"IPv4"
but can be set to"IPv6"
to perform a IPv6 device discovery. In that case the two other optionslocalAddress
andbroadcastInterface
are required as well. See the documentation for more details. - Add verifiers for VBus-over-TCP commands to
TcpConnectionEndpoint
. - Add
connectionAttemptFailed
event toTcpConnectionEndpoint
.
- Add
extendFieldData
option toDLxJsonConverter
. - Add
SpecificationFile#getPacketTemplate
. - Add password and channel checks to TCP endpoint. (#93)
- Add
TcpConnection#disableReconnect
. - Correctly propagate errors during
TcpConnection
reconnect.
- Fix bugs in
SerialConnection
andSerialDataSourceProvider
- [BREAKING CHANGE] Removed
Recorder
,DLxRecorder
andFileSystemRecorder
TheRecorder
style of interfaces was not well thought out and unreliable. This version removes it, with no replacement! - [BREAKING CHANGE] Removed
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.
- Update several dependencies to fix security issues.
- Update VBus specification file to 20220206.
- Add support for CRC7 in protocols using minor version 1.
- Add
Datagram
andTelegram
support toVBusRecordingConverter
.
- [BREAKING CHANGE] Replaced the deprecated "request" dependency with Fetch API impl
Since the "request" dependency that was used in the
DLxRecorder
class has been deprecated, the code was refactored to use a Fetch API implementation instead. But since the methodDLxRecorder#downloadToStream
expected "request"-specific options, it had to be changed, too. This method was renamed toDLxRecorder#_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 customextend
function. Since only modern ECMAscript runtimes are supported since the last release the code was refactored to use the ECMAscriptclass
syntax instead. In that process theextend
function was removed, both the standalone one and the static class function that was added to every "class". -
[BREAKING CHANGE] Returning a
Promise
fromchannelListCallback
callback TheTcpConnection
accepts achannelListCallback
. This callback gets called with the list of channels returned from theCHANNELLIST
command and adone
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 aPromise
:- if the
Promise
reject, thedone
callback is automatically called withdone(reason)
- if the
Promise
resolves, thedone
callback is automatically called withdone(null, result)
This allows the
channelListCallback
to beasync
. - if the
-
Errors thrown by
TcpConnection#connect
now have avbusPhase
member describing on which VBus-over-TCP command the error occurred
- [BREAKING CHANGE] Dropping support for Node.js versions < 12
-
[BREAKING CHANGE] Returning a
Promise
fromfilterPacket
orfilterDatagram
callbacks TheConnection#transceive
method and many of the helper methods that use it accept afilterPacket
and/orfilterDatagram
callback. Those callbacks get called with the data to filter and adone
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
:- if the
Promise
rejects, thedone
callback is automatically called withdone(reason)
- if the
Promise
resolves withnull
orundefined
, thedone
callback is not called - if the
Promise
resolves with any other result, thedone
callback is automatically called withdone(null, result)
This allows
async
filter callbacks! - if the
-
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. Theresol-vbus
library itself might still work under Node 6, but there is no guarantee...
- This version contains several breaking changes! You have been warned...
- Refactor code to make use of ES2018 features (using Babel to back-support up to Node.js 6)
- Remove custom
Promise
implementation in favor of built-in, native one. Promise
return values no longer provide thefinally
anddone
methods.- Remove
utils.promise
,utils.Promise
andutils.cancelablePromise
. - Add
reportProgress
andcheckCanceled
options toConnectionCustomizer#transceive{Configuration,Value}
as a replacement to the previously usedcancelablePromise
solution.
- Add RESOL DeltaSol C configuration optimizer.
- Add support for VBus-over-TCP wrapped in TLS.
- Add
Buffer
support toConnection#(get|set)ValueById
for values larger than 32-bit. - Add
Connection#getCaps1
. - Add bulk value transaction support to
Connection
class. - Add support to generate and parse "type 9" comment records using
VBusRecordingConverter
. - Make it easier to create a
Specification
from aSpecificationFile
. - Extend
vbustouch-proxy
example with text data logging feature. - Update dependencies.
- Some minor bug fixes.
- Use VSF binary file to load VBus specification data
- Add support to read and write raw data in VBus recordings
- Extend
VBusRecordingConverter
to support fast topology-only scan - Code clean up
- Several minor bug fixes
- Update VBus specification data
- Several minor bug fixes
- Improve configuration optimizers and their discovery
- Update VBus specification data
- Add configuration optimizers for RESOL DeltaSol SLT
- Add BlockType support
- Update VBus specification data
- Add configuration optimizers for RESOL DeltaSol MX and BS/4 v2
- Add a simple JSON live data server example
- Add some documentation
- Several bug fixes
- Add
vbustouch-proxy
example - Add support for rounding floating point numbers
- Fix a floating point bug caused by
setRawValue
- Added support for setting packet field values
- Several bug fixes
- Finalized support for customizing controller configuration.
- Several bug fixes.
- Completed Recorder class by adding support for recording
- Added unit conversion to VBus specification
- Several bug fixes.
- Extended Converter and VBusRecordingConverter to support object mode in stream (for performance reason)
- Fixed several bugs
- Increased test coverage and completed documentation.
First release to the NPM registry.
- Thorsten Müller
- Paul Hanna
- Sabine Käß
- Andrew Thompson (@thompsa)
- @t9zx
- @SurfGargano
- @epenet
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.