You can find the work-in-progress documentation for this project here:
The JSDoc-generated documentation is located here:
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:
In addition to that the project is configured to watch its own files for modification and rerun the documentation generator and test suite every time you hit save on a file. To run that just enter the following command into your shell:
⌘ gulp watch
FileSystemRecorderclass 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).
ConfigurationOptimizersdo 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).
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-2016, 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.