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/classes.list.html
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
FileSystemRecorder
class sometimes writes invalid JSON into its “SyncState.json” file causing it to not
being able to restore and recover from that when the app using the recorder restarts (e.g. the “vbustouch-proxy”
example).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.[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!
SerialConnection#baudrate
option.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
examplesetRawValue
First 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-2020, 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.