iobroker-community-adapters / iobroker.myvbus

ioBroker Adapter for Resol VBus

ioBroker.myvbus

Tests:

ioBroker Adapter for Resol VBus

This adapter connects ioBroker to various VBus-based devices using resol-vbus, a JavaScript library for the acquisition of RESOL VBus data, provided by Daniel Wippermann.

https://github.com/danielwippermann/resol-vbus

https://www.npmjs.com/package/resol-vbus

Features

• Enables reading of the measurement data from various RESOL(R) VBus(R) devices - preferably solar and system controllers from the DeltaSol(R) series including built-in heat quantity meters (HQM) - using DL3 or DL2 data loggers, KM2 communication modules, VBus/LAN interface adapters or serial/LAN gateways locally via TCP/IP.
• Device access using the VBus/USB serial interface adapter or via VBus.net(R) using DLx/KMx is also supported.
• Processes live VBus data streams and makes them available as ioBroker states.
• Values are updated with a configurable cycle time.
• Reading or setting the VBus device configuration parameters is not supported. The tools provided by Resol should be used for this, e.g. via VBus.net or the parameterization tool RPT.
  A derived version of this adapter supporting control of VBus devices is available at https://github.com/Grizzelbee/ioBroker.resol
• Reading DL3 channel 0 (sensors directly connected to the DL3 device) is not supported due to limitations of the DL3 interface.

Configuration hints

• The connection device type e.g. VBus/LAN or DL2 must be explicitly selected, otherwise no connection will be established.
• TCP connection port: The default setting 7053 should not be changed
• Device password: The password which you have set in your connection device (default: vbus)
• DL3 channel: Only relevant for DL3/DL2Plus - leave at "None" for all other connection devices.
  (allowed values: 1-6, channel 0 cannot be read out)
• Update interval: The time between updates of the measured values (default 30s)
• The correct settings for direct LAN access for VBus/LAN, DL3, DL2, KM2 are:
  • Connection Device: VBus/LAN or KM2/DL2 or DL3/DL2Plus
  • Device Address: IP address (e.g. 192.168.178.188) or FullyQualifiedHostName (e.g. myKM2.fritz.box)
• The correct settings for the DL3, DL2, KM2 access via VBus.net are:
  • Connection Device: DL3/DL2Plus or DL2/KM2
  • Device Address: vbus.net (or vbus.io) - both without http:// and Via identifier!
  • Via Tag: YourViaIdentifier (e.g. d1234567890) - without http:// before or .vbus.io behind

Changelog

0.3.0 (2024-01-24) - 2024 maintenance release

• (pdbjjens) New: Use JSON config UI
• (pdbjjens) New: Support ioBroker discovery
• (pdbjjens) Change: node>=16, js-contoller>=4 and admin>=6 required
• (pdbjjens) Updated dependencies
• (pdbjjens) Fix: Set info.connection false when reconnecting

0.2.5 (2023-03-14)

• (pdbjjens) Updated dependencies
• (pdbjjens) Fix: reconnect handling for serial connections

0.2.4 (2023-03-01)

• (pdbjjens) Fix password check

0.2.3 (2023-02-27) - 2023 maintenance release

• (pdbjjens) Updated dependencies
• (pdbjjens) New: Use adapter-dev instead of gulp translate
• (pdbjjens) Fix: error handling for serial connections

0.2.2 (2022-02-11)

• Updated dependencies
• Compatibility check for js-controller 4.0
• Support for js-controller 1.x dropped

Legal Notices

RESOL, VBus, VBus.net, DeltaSol and others are trademarks or registered trademarks of RESOL - Elektronische Regelungen GmbH https://www.resol.de/en

All other trademarks are the property of their respective owners. The authors are in no way endorsed by or affiliated with RESOL GmbH, or any associated subsidiaries, logos or trademarks.

License

MIT License

Copyright (c) 2024 Jens-Peter Jensen [email protected]

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.

iobroker.myvbus's Issues

Action required: Greenkeeper could not be activated 🚨

---

☝️ Important announcement: Greenkeeper will be saying goodbye 👋 and passing the torch to Snyk on June 3rd, 2020! Find out how to migrate to Snyk and more at greenkeeper.io

---

🚨 You need to enable Continuous Integration on Greenkeeper branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet.
We recommend using:

• CircleCI
• Travis CI
• Buildkite
• CodeShip
• Azure Pipelines
• TeamCity
• Buddy
• AppVeyor
  But Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please click the 'fix repo' button on account.greenkeeper.io.

Compatibility check and testing for Node.js 14 and 16

Dear Adapter developer,

Node.js 14 is now available for a year and Node.js 16 was release just some days ago and will become LTS by October 2021. We plan to update the ioBroker Node.js recommendation (currently 12.x) to 14.x later this year.

Please check your adapter with Node.js 14 especially, and ideally also directly with Node.js 16

Please add both versions to the adapter testing which is executed on commits.

If your adapter requires a certain minimum version of Node.js please set the 'engine' setting in package.json accordingly! Please also do this if the adapter is not able to work in certain Node.js versions, so that ioBroker can prevent users from installing te adapter if not compatible!

On questions please talk to us at ioBroker/ioBroker.js-controller#1138

Please close the issue after you checked it.

Thank you very much for your support!

Bump resol-vbus lib from 0.21.0 to 0.23.0

Describe the bug
resol-vbus lib is dropping support for Node.js versions < 12

Expected behavior
Dropping support for Node.js versions < 12 also in myvbus

Versions:

• Adapter version: <0.1.x>
• JS-Controller version: <3.3.x>
• Node version: <>=12>
• Operating system: <linux, windows>

Integrate into ioBroker discovery

enable ioBroker.discovery to find VBus devices in local network

Resol VBus/USB not updating in docker container

Describe the bug
Adapter is configured as standard and /dev/ttyACM0 is made availabe through portainer for docker.
First time start of the adapter the data objects are created but afterwards no update of any value will happen

To Reproduce
Steps to reproduce the behavior:

1. install ioBroker in docker container with privillaged rights and passthrough of device /dev/ttyACM0
2. ioBroker started in docker
3. MyVBus adapter installed in ioBroker and configured as mentioned above
4. Start MyVBus adapter will create all data object with initial correct values
5. Automatic Update (60 sec) will not update any information for any data object (all show updated timestamp but no change of data). received data: [] (is empty when only logging info) received data: [{"id":"00_0010_2211_10_0100_000_2_0","name":"Temperature sensor 1","rawValue":10.200000000000001,"deviceName":"DeltaSol CS Plus","deviceId":"0022110010","addressId":8721,"unitId":"DegreesCelsius","unitText":".........] will always show the same entry for every timestamp (details in full log)

Expected behavior
Updated values (esp. "System time" as it logs every min)

Screenshots & Logfiles

iobroker.2023-04-12.log.gz

Versions:

• Adapter version: 0.2.5
• JS-Controller version: image v8.0.0 build 2023-04-07T23:45:19+00:00
• Node version: v18.15.0
• Operating system: Linux raspberrypi 6.1.19-v8+ #1637 SMP PREEMPT Tue Mar 14 11:11:47 GMT 2023 aarch64
• Docker version: 20.10.5+dfsg1, build 55c4c88

Additional context
N/A

Compatibility check to js-controller 3.3 and Admin5 React UI

Dear Adapter developer,

with js-controller 3.2 and js-controller 3.3 some additional checks were added to make sure that created objects match to the specifications and also written state values match to the object definition.

If something is not correct this is logged as 'warning' or 'info' log.

Please take the time to verify your adapter by ideally starting with a fresh instance and do some actions and verify the log. If you see a warn log there from these checks please adjust the adapter and fix the relevant cases.

For questions please refer to ioBroker/ioBroker.js-controller#1301

Additionally we are preparing Admin 5 which will have a completely rewritten UI. Please install Admin 5, activate that new UI and verify that the configuration of you adapter works as expected also there.

More informations on Admin 5 can be found in Forum https://forum.iobroker.net/topic/44282/test-adapter-admin-5-0-x-alpha-der-neuen-ui

Please close the issue after you checked it.

Thank you very much for your support!

Compatibility check to js-controller 4.0

Dear Adapter developer,

with js-controller 4.0 object definitions are now also checked that min/max in only provided for number/mixed objects and that the type of the default value matches to the object type.

If something is not correct this is logged as 'warning' or 'info' log.

Please also make sure to update to the lastest @iobroker/testing dependency 2.5.4 or to accept the PR from Apollon77 for legacy testing!

Please spent some time to verify your adapter by ideally starting with a fresh instance and do some actions and verify the log. If you see a warn or info log there from these checks please adjust the adapter and fix the relevant cases.

For questions please refer to ioBroker/ioBroker.js-controller#1749

Please close the issue after you checked it.

Thank you very much for your support to get the best experience for the growing numbers of ioBroker users!

Compatibility check and testing for Node.js 14 and 16

Dear Adapter developer,

Node.js 14 is now available for a year and Node.js 16 was release just some days ago and will become LTS by October 2021. We plan to update the ioBroker Node.js recommendation (currently 12.x) to 14.x later this year.

Please check your adapter with Node.js 14 especially, and ideally also directly with Node.js 16

Please add both versions to the adapter testing which is executed on commits.

If your adapter requires a certain minimum version of Node.js please set the 'engine' setting in package.json accordingly! Please also do this if the adapter is not able to work in certain Node.js versions, so that ioBroker can prevent users from installing te adapter if not compatible!

On questions please talk to us at ioBroker/ioBroker.js-controller#1138

Please close the issue after you checked it.

Thank you very much for your support!

Please add you adapter to our repository

We saw your adapter and if it is ready please request that it is added to the repository. With this it becomes available for all users. Please consult https://github.com/ioBroker/ioBroker.repositories#add-a-new-adapter-to-the-latest-repository and the following sections for more details.
If you need help, contact us in the forum https://forum.iobroker.net/ or in the developer chat https://github.com/iobroker-community-adapters/info .

Thank you for your support.

Release script: Action required

Hi, it looks like you are using @alcalzone/release-script to manage your releases.
When updating to the latest version, you need to remove the following line from your .github/workflows/test-and-release.yml if you want the releases to keep working:

  deploy:
    # Trigger this step only when a commit on master is tagged with a version number
    if: |
      contains(github.event.head_commit.message, '[skip ci]') == false &&
      github.event_name == 'push' &&
-     github.event.base_ref == 'refs/heads/master' &&
      startsWith(github.ref, 'refs/tags/v')

It may also look like this one:

  deploy:
    # Trigger this step only when a commit on master is tagged with a version number
    if: |
      contains(github.event.head_commit.message, '[skip ci]') == false &&
      github.event_name == 'push' &&
-     github.event.base_ref == 'refs/heads/main' &&
      startsWith(github.ref, 'refs/tags/v')

Need to refactor onReady method

This method is with more than 300 line much to large. Split it to a few methods.

An in-range update of snyk is breaking the build 🚨

---

🚨 Reminder! Less than one month left to migrate your repositories over to Snyk before Greenkeeper says goodbye on June 3rd! 💜 🚚💨 💚

Find out how to migrate to Snyk at greenkeeper.io

---

The dependency snyk was updated from 1.320.2 to 1.320.3.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

snyk is a direct dependency of this project, and it is very likely causing it to break. If other packages depend on yours, this update is probably also breaking those in turn.

Status Details

• ❌ continuous-integration/travis-ci/push: The Travis CI build could not complete due to an error (Details).
• ❌ Travis CI - Branch: The build errored.

---

Release Notes for v1.320.3

1.320.3 (2020-05-13)

Bug Fixes

• enable mvn plugin logging when running with -d (5414755)

Commits

The new version differs by 6 commits.

• 6e7fb38 Merge pull request #1119 from snyk/fix/enable-mvn-logging
• 5414755 fix: enable mvn plugin logging when running with -d
• 505720d Merge pull request #1117 from snyk/chore/release-notes-review-fix
• 649c770 chore: release notes preview fix.
• 6e448ca Merge pull request #1114 from snyk/chore/run-tests-on-linux
• a67adee chore: update test:acceptance include root tests

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

---

Your Greenkeeper Bot 🌴

Update stable version in repo from 0.0.0 to 0.2.5

Think about adding version 0.2.5 to stable repository.

Version: stable=0.0.0 (0 days old) => latest=0.2.5 (104 days old)
Installs: stable=0 (0%), latest=35 (27.13%), total=129
Click to edit

Please add to stable repository if adapter is working for users

Think about to fix the issues found by adapter checker

I am an automatic service that looks for possible errors in ioBroker and creates an issue for it. The link below leads directly to the test:

https://adapter-check.iobroker.in/?q=https://raw.githubusercontent.com/iobroker-community-adapters/ioBroker.myvbus

• [E154] common.dependencies must contain {"js-controller": ">=2.0.0"} or {"js-controller": ">=3.0.0"}
• [E605] No actual year found in copyright. Please add "Copyright (c) 2022 Jens-Peter Jensen [email protected]" at the end of README.md
• [E701] No actual year found in LICENSE. Please add "Copyright (c) 2022 Jens-Peter Jensen [email protected]" at the start of LICENSE

Thanks,
your automatic adapter checker.

deviceMajorVersion auslesen ?

Describe the bug
Ein User vom Resol Adapter hat den MX V2. Wie ich jetzt rausgefunden habe, benötigt createOptimizer unter options die Angabe deviceMajorVersion.

Wie kann ich die deviceMajorVersion vom MX Controller bekommen ?

To Reproduce
Steps to reproduce the behavior:

1. Go to '...'
2. Click on '...'
3. Scroll down to '....'
4. See error

Expected behavior
A clear and concise description of what you expected to happen.

Screenshots & Logfiles
If applicable, add screenshots and logfiles to help explain your problem.

Versions:

• Adapter version:
• JS-Controller version:
• Node version:
• Operating system:

Additional context
Add any other context about the problem here.

Compatibility check to js-controller 3.3 and Admin5 React UI

Dear Adapter developer,

with js-controller 3.2 and js-controller 3.3 some additional checks were added to make sure that created objects match to the specifications and also written state values match to the object definition.

If something is not correct this is logged as 'warning' or 'info' log.

Please take the time to verify your adapter by ideally starting with a fresh instance and do some actions and verify the log. If you see a warn log there from these checks please adjust the adapter and fix the relevant cases.

For questions please refer to ioBroker/ioBroker.js-controller#1301

Additionally we are preparing Admin 5 which will have a completely rewritten UI. Please install Admin 5, activate that new UI and verify that the configuration of you adapter works as expected also there.

More informations on Admin 5 can be found in Forum https://forum.iobroker.net/topic/44282/test-adapter-admin-5-0-x-alpha-der-neuen-ui

Please close the issue after you checked it.

Thank you very much for your support!

Think about to fix the issues found by adapter checker

I am an automatic service that looks for possible errors in ioBroker and creates an issue for it. The link below leads directly to the test:

https://adapter-check.iobroker.in/?q=https://raw.githubusercontent.com/iobroker-community-adapters/ioBroker.myvbus

• [E154] common.dependencies must contain {"js-controller": ">=2.0.0"} or {"js-controller": ">=3.0.0"}
• [E605] No actual year found in copyright. Please add "Copyright (c) 2022 Jens-Peter Jensen [email protected]" at the end of README.md
• [E701] No actual year found in LICENSE. Please add "Copyright (c) 2022 Jens-Peter Jensen [email protected]" at the start of LICENSE

Thanks,
your automatic adapter checker.

An in-range update of @types/node is breaking the build 🚨

---

☝️ Important announcement: Greenkeeper will be saying goodbye 👋 and passing the torch to Snyk on June 3rd, 2020! Find out how to migrate to Snyk and more at greenkeeper.io

---

The devDependency @types/node was updated from 13.13.1 to 13.13.2.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

@types/node is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details

• ❌ continuous-integration/travis-ci/push: The Travis CI build failed (Details).
• ❌ Travis CI - Branch: The build failed.

---

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

---

Your Greenkeeper Bot 🌴