Package Health Score

74 / 100

security
No known security issues
popularity
Small
maintenance
Healthy
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
5.0.0	\|	07/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
4.0.0	\|	09/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.0.47	\|	08/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.6.25	\|	12/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.5.5	\|	02/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (1,180)

GitHub Stars: 43
Forks: 15
Contributors: 30

Direct Usage Popularity

The npm package iobroker.hm-rega receives a total of 1,180 downloads a week. As such, we scored iobroker.hm-rega popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package iobroker.hm-rega, we found that it has been starred 43 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 30
Funding: Yes

With more than 10 contributors for the iobroker.hm-rega repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like iobroker.hm-rega is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 6
Open PR: 7
Last Release: 9 days ago
Last Commit: 9 days ago

Further analysis of the maintenance status of iobroker.hm-rega based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that iobroker.hm-rega demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=18.0.0

Age: 10 years
Dependencies: 4 Direct
Versions: 134
Install Size: 244 kB
Dist-tags: 1
# of Files: 37
Maintainers: 6
TS Typings: No

iobroker.hm-rega has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Logo

ioBroker HomeMatic ReGaHSS Adapter

Number of Installations

Test and Release

Connects HomeMatic CCU "Logic Layer" ("ReGaHSS") to ioBroker.

This adapter uses Sentry libraries to automatically report exceptions and code errors to the developers. For more details and for information how to disable the error reporting see Sentry-Plugin Documentation! Sentry reporting is used starting with js-controller 3.0.

Purpose

This Adapter keeps the HomeMatic CCU variables in sync with ioBroker and provides the possibility to start HomeMatic CCU programs from within ioBroker. Furthermore, this adapter can be used as a "migration helper": you can sync device/channel names, rooms, functions, and favorites from the CCU to ioBroker (this is one way only, changes in ioBroker will be overwritten once synced again – so deactivate this features after the first sync).

Install

This adapter requires one (ore more) already installed and initialized hm-rpc adapter(s) to work.

Configuration

FAQ

What are the ALARM states created in the devices object?

States which end on '_ALARM' are created by the Rega adapter, to represent service messages. The alarm has three different states NO ALARM, which indicates that there is no related alarm (service message) for the state. When a service message appears for the related state the state will change to ALARM, containing the timestamp of the alarm occurrence on the CCU in the last changed timestamp of the state (state.ls). When you change the state in ioBroker, this will acknowledge the alarm in the CCU and the service message will be gone. The alarm state in ioBroker will change to ACKNOWLEDGED still containing the occurrence timestamp in the last changed state, and the timestamp when it has been acknowledged in the state's timestamp (state.ts).

I have a HomeMatic CCU2/CCU3, how can I add it to the adapter settings?

Within the adapter settings, you added the IP address of your CCU2, then

Activate "rfd" for regular HomeMatic devices,
Activate "HomeMatic IP" if you use HomeMatic IP devices,
Activate "Virtual Devices" if you use Groups in HomeMatic (so if you combine e.g., multiple thermostats to a group)

If I modify rooms, etc. in HomeMatic, the changes are not applied right away within ioBroker.

Please reload the hm-rega adapter instance, e.g., by clicking on the reload icon of hm-rega.x (actions table) in the Instances tab. Afterward, wait about 10-20 seconds and then check both the Enums tab and the Objects (enum.xxx - make sure you enabled the expert mode). If the changes do still not appear, restart ioBroker. Then the changes should be available in ioBroker.

How can I sync the hidden/invisible variables, e.g., of HMIP-PSM?

Since version 2.4.0, it is possible to sync hidden variables. For this purpose, you have to go to the settings of hm-rega. At the Sync tab you will find Invisible variables when Variables is checked.

I want to execute my own scripts on the CCU via ioBroker. Is this possible?

Since version 2.3.0 it is possible to execute your own scripts on the CCU by using the sendTo command. E.g., getting the uptime of your CCU by the following script:

My CCU webinterface has a different port than the standard http/https protocols, thus no connection is established. How can I configure the adapter to use a custom port for the webinterface?

Until now, this is an edge case and thus no configuration in the Admin GUI is possible. This has been decided because it would confuse 10,000 users to help one user. However, the port can still be changed via the cli, using the following command:

iob set hm-rega.0 --webinterfacePort 8765

To use default port settings again, either set 443/80 according to your protocol, or set 0 for automatic selection.

const upTimeScript = `
    string stderr;
    string stdout;
    system.Exec("cat /proc/uptime | awk '// { printf $1/3600 }'", &amp;stdout, &amp;stderr);
    WriteLine(stdout);`;

sendTo('hm-rega.0', upTimeScript, res =&gt; {
    log(JSON.stringify(res), 'info');
});

My Rega API is running at another port than 8181 (HTTPS: 48181), can I use the adapter anyway?

If your Rega API is running at a non-default port (which should only happen in edge cases), we assume that you are familiar with the ioBroker CLI. You can change the port via iob set hm-rega. --homematicPort

Changelog

5.0.0 (2024-07-18)

(bluefox) required node 18
(bluefox) updated dependencies

4.0.0 (2023-09-04)

(mcm1957) required node 16 due to adapter-core 3.x.x
(bluefox) removed deprecated package - request

3.0.47 (2023-08-08)

(bluefox) Updated packages

3.0.46 (2023-03-30)

(foxriver76) fixed for controller v5 (closes #368)

3.0.44 (2023-02-20)

(foxriver76) compatibility of RSSI_DEVICE and RSSI_PEER for CCU updated (closes #352)
(foxriver76) also sync enums for a maintenance channel of rfd devices (closes #320)

3.0.43 (2022-07-28)

(foxriver76) if LGW is not reachable we now set duty cycle to null instead of -1 in all cases (closes #298)

3.0.40 (2022-04-03)

(foxriver76) if LGW is not reachable we now set duty cycle to null instead of -1

3.0.39 (2022-03-26)

(foxriver76) fixed another ValueList bug

3.0.38 (2022-03-26)

(foxriver76) fixed bug with ValueList (closes #268)

3.0.37 (2022-02-22)

(foxriver76) only delete hm-rpc objects of configured instances from enums (fixes #253)

3.0.35 (2022-01-28)

(foxriver76) do not log warning if we cannot synchronize favorites of empty string user (fixes #227)

3.0.34 (2022-01-24)

(martin-herzog/foxriver76) fixed unneeded call which lead to warnings in rega log

3.0.33 (2021-11-18)

(foxriver76) if function or room names on CCU include dots, we replace them (fixes Sentry IOBROKER-HM-REGA-3H)

3.0.32 (2021-10-14)

(foxriver76) Duty Cycle of LAN gateways can be -1 if they are disconnected (fixes #196)
(foxriver76) we now only scale on UNIT "100%" as hm-rpc does (fixes #207)

3.0.31 (2021-08-12)

(foxriver76) we fixed some sentry issues (closes #182, closes #183)

3.0.30 (2021-07-18)

(foxriver76) improved the detection of ALARM occurrences for virtual devices

3.0.29 (2021-07-01)

(foxriver76) fixed bug on ALARM datapoint creation

3.0.28 (2021-06-30)

(foxriver76) improve creation of ALARM dps even if no states provided by getDatapoints (fixes #168)

3.0.27 (2021-06-28)

(foxriver76) fixed a bug that already deleted programs were only partially deleted in ioBroker Please note: This will only work for deleted programs up from now. You have to clean up orphan programs manually

3.0.26 (2021-06-14)

(bluefox) Use name from device if channel has a default name

3.0.25 (2021-05-14)

(foxriver76) remove old code, which also scaled unit: % values and not only unit: 100 %

3.0.24 (2021-04-30)

(foxriver76) we fixed more occurrences of incorrect types (fixes #146)

3.0.23 (2021-04-30)

(foxriver76) we now correctly convert the rssi values, workaround for https://github.com/jens-maus/RaspberryMatic/issues/897
(foxriver76) we made counter states of type "number", was incorrectly "string" (closes #145)

3.0.22 (2021-04-30)

(foxriver76) parse the dutyCycle state to int (fixes #144)
(foxriver76) updated dependencies
(foxriver76) removed unneeded dependency

3.0.21 (2021-04-24)

(foxriver76) bring back io-package json readme attribute, admin does not fall back to docs as expected (fixes #135)

3.0.20 (2021-04-20)

(foxriver76) admin/controller has a bug still requiring common.title (fixes #133)

3.0.19 (2021-04-16)

(foxriver76) fixed for custom webinterface port (addresses #117)

3.0.18 (2021-04-05)

(foxriver76) local link now respects port and protocol

3.0.17 (2021-04-04)

(foxriver76) correctly identify incomplete requests

3.0.16 (2021-01-31)

(foxriver76) fixed issue with non-existing objects when using LAN-Gateways

3.0.15 (2021-01-31)

(foxriver76) Ensures that objects are created if something (devices, variables, programs) created during runtime (fixes #124)

3.0.14 (2021-01-30)

(foxriver76) fixed pot. crash after reconnecting because of existingStates array

3.0.13 (2021-01-30)

(foxriver76) ensure to not set states of non-existing RPC objects due to differences in the APIs (fixes #123)

3.0.12 (2021-01-29)

(foxriver76) we now handle some more edge case errors

3.0.10 (2021-01-27)

(foxriver76) no build needed

3.0.9 (2021-01-27)

(foxriver76) fixed gh actions

3.0.8 (2021-01-27)

(foxriver76) we now wait until objects are created before setting states (fixes #122)
(foxriver76) added release script

3.0.7 (2021-01-17)

(foxriver76) we notify the user about aborted connection by CCU during request

3.0.6 (2020-12-25)

(Hirsch-DE) don't write data points if timestamp is 0"

3.0.5 (2020-12-24)

(foxriver76) provide possibility to use custom webinterface port, please see FAQ

3.0.4 (2020-12-21)

(foxriver76) fixed enum translations (changed in API)
(foxriver76) fixed handling of "favorites" enum
this can be breaking for some users, please check your enums

2.6.25 (2020-12-16)

(foxriver76) fixed aliases being removed from enums if they contain hm-rpc.

2.6.24 (2020-11-03)

(foxriver76) now states will be accordingly marked to indicate that rega is down when receiving invalid responses

2.6.23 (2020-10-15)

(foxriver76) fixes for edge case crashes

2.6.22 (2020-09-29)

(foxriver76) fixed error where alarm states of hm-rpc instances with instance number >= 10 are created for the wrong instance (issue #111)

2.6.20 (2020-09-15)

(foxriver76) set an explicit object type on extending object (issue #109)

2.6.19 (2020-08-23)

(foxriver76) fixed issue on syncing service message counter when invisible variables are synchronized
(foxriver76) fixed issue where value list variables are a string instead of an integer

2.6.17 (2020-08-17)

(foxriver76) fixed for % scaling of float numbers

2.6.15 (2020-08-08)

(foxriver76) fixed potential issues with scaling of % values as in https://github.com/ioBroker/ioBroker.hm-rpc/issues/263

2.6.14 (2020-06-11)

(foxriver76) fixed a potential problem on enum sync, where to many channels could be deleted

2.6.11 (2020-06-11)

(foxriver76) timeout of requests increased to 90 seconds (its only important to have a timeout to prevent infinite stucking)

2.6.10 (2020-06-10)

(foxriver76) fixed crash when a user on CCU is an empty string on synchronizing favorites

2.6.9 (2020-05-29)

(foxriver76) fixed crash when we cannot determine CCU version

2.6.8 (2020-05-26)

(foxriver76) Script post requests will time out after 15 seconds to prevent stucking in queue if no answer from ccu received

2.6.7 (2020-05-11)

(foxriver76) fixed some edge cases, reported by Sentry

2.6.6 (2020-05-06)

(foxriver76) use current time as timestamp if non-existent on initial variables poll

2.6.5 (2020-04-22)

(foxriver76) improved error handling, no longer use legacy log file

2.6.4 (2020-04-13)

(foxriver76) now storing scripts in iob file storage

2.6.2 (2020-04-11)

(foxriver76) minor fixed on a ccu object

2.6.1 (2020-04-04)

(foxriver76) fixed synchronization

2.6.0 (2020-04-02)

(foxriver76) sentry plugin support added

2.5.5 (2020-02-17)

(foxriver76) we are logging the script name in still pending warning from now on

2.5.4 (2020-02-05)

(foxriver76) made port fully configurable, also with https enabled

2.5.3 (2020-01-15)

(foxriver76) improved error handling in edge cases and more verbose logging on errors

2.5.2 (2019-12-29)

(foxriver76) fixed issue which originated by undefined tclsh alias on CCU for dutycycle.fn script

2.5.1 (2019-12-14)

(foxriver76) no longer use adapter.objects
(foxriver76) js-controller v > 2 required

2.4.12 (2019-09-26)

(foxriver76) fixed bug which leads to alarm counter showing the number of service messages

2.4.10 (2019-09-17)

(foxriver76) we set enum name as a translation object again

2.4.9 (2019-09-04)

(foxriver76) fixed minor bug which prevented correct room sync
(foxriver76) in 2.4.6 we implemented the mechanism for hm-rega and rpc, in fact we should only delete hm-rpc devices, because rega will be added on ioB side (can't be done in CCU)

2.4.7 (2019-08-28)

(foxriver76) fixed another legacy bug, which prevented some enums from getting the correct name

2.4.6 (2019-08-11)

(foxriver76) only deleting hm adapter objects from enums

2.4.4 (2019-08-02)

(foxriver76) fixed enum sync and improved logging

2.4.2 (2019-07-23)

(foxriver76) lc and ts for alarm states are now valid formatted for js-controller

2.4.1 (2019-07-13)

(foxriver76) also poll invisible vars if configured

2.4.0 (2019-07-03)

(foxriver76) added possibility to synchronize hidden variables

2.3.3 (2019-04-05)

(foxriver76) added more system info states when syncing duty cycle
(foxriver76) when setting ts, do it in ms

2.3.2 (2019-03-10)

(foxriver76) when ccu sysvar is nan, replace it by null

2.3.1 (2019-03-07)

(foxriver76) also unescape %0A (\n)
(foxriver76) remove line break in a firmware version

2.3.0 (2019-02-07)

(foxriver76) implemented messagebox

2.2.2 (2019-02-04)

(foxriver76) show the correct number of service messages even if automatic checking is enabled

2.2.1 (2019-01-29)

(foxriver76) create alarm states with the correct name instead of renaming on restart
(foxriver76) fixed to enabled acknowledging servicemessages for all instance types

2.2.0 (2019-01-26)

(foxriver76) reworked alarm states, see FAQ
(foxriver76) fixed where virtual devices were not named

2.1.8 (2019-01-24)

(foxriver76) from now on we are displaying the firmware version instead of coprocessor fw version
(foxriver76) we are making sure to prevent a CCU3 being exposed as a CCU2
(foxriver76) fixed renaming of alarms on start

2.1.7 (2019-01-21)

(foxriver76) fixed the bug that all alarms of devices are in hm-rpc rfd instance or non existent if no rpc instance existed
(foxriver76) fixed bug where datapoints were not named

2.1.6 (2019-01-20)

(foxriver76) updated state when the same value is set with another timestamp
(foxriver76) reverted the duty cycle script
(foxriver76) fixed for parse errors on -inf values

2.1.3 (2019-01-14)

(foxriver76) also decode string values when setting foreign states
(foxriver76) added more translations

2.1.2 (2019-01-10)

(foxriver76) fixed duty cycle script
(foxriver76) fixed bug where state units were ignored for all except rfd

2.1.0 (2019-01-07)

(foxriver76) usage of adapter-core
(bluefox) compact mode compatibility

2.0.1 (2019-01-01)

(foxriver76) fixed error that prevented setting umlauts to system variables in ioBroker
(foxriver76) usage and application of eslint

2.0.0 (2018-11-28)

(foxriver76) Https checkbox added
(foxriver76) Https can be used instead of http
(foxriver76) Added possibility to authenticate on API
(foxriver76) de- and encryption added

1.7.2 (2018-07-29)

(bluefox) Configuration dialog was corrected

1.7.1 (2018-06-25)

(bluefox) Forbidden characters were replaced

1.7.0 (2018-01-26)

(bluefox) Ready for Admin3

1.6.6 (2017-09-23)

(AlGu1) Fixed error if Lan Interfaces exits

1.6.5 (2017-09-10)

(AlGu1) Change adapter logging of new values to debug

1.6.4 (2017-09-10)

(AlGu1) Config Settings changed to set defaults after updated adapter

1.6.3 (2017-09-06)

(AlGu1) Read values from CCU in raw format and create JSON string and object in adapter

1.6.2 (2017-09-05)

(AlGu1) dutycycle.fn script changed for better compatibility without ReGaHss Beta version

1.6.1 (2017-09-05)

(AlGu1) Error in script file fixed

1.6.0 (2017-09-05)

(AlGu1) Read DutyCycle and other params from listBidcosInterfaces

1.5.0 (2017-06-29)

(Apollon77) Also updated names of states when syncing with CCU

1.4.8 (2017-05-24)

(bluefox) Fixed values conversion for CUxD

1.4.4 (2017-02-28)

(Apollon77) small fixed (issue #23)

1.4.3 (2017-02-01)

(Apollon77) respect settings and only sync variables and programs if selected in settings (issue #22)

1.4.2 (2017-01-30)

(bluefox) remove error log in CCU by start

1.4.1 (2017-01-16)

(bluefox) merge rooms, functions and favorites with existing one

1.4.0 (2017-01-15)

(jens-maus) Add HMIP support

1.3.0 (2016-08-23)

(bluefox) updated states only if changed

1.2.1 (2016-07-15)

(nobody) fixed initial read of states

1.2.0 (2016-05-27)

(bluefox) read variables anew if connection of rfd detected
(bluefox) read alarms
(bluefox) support for acknowledgment of alarms

1.1.1 (2016-05-27)

(bluefox) fixed min/max for variables

1.1.0 (2016-04-19)

(bluefox) change timestamp and last change of states

1.0.0 (2016-04-19)

(bluefox) detect disconnection and handle it

0.3.7 (2016-04-18)

(bluefox) fixed error with polling trigger

0.3.6 (2016-03-12)

(bluefox) fixed read data points

0.3.5 (2016-03-12)

(bluefox) remove deprecated unescape

0.3.4 (2016-03-09)

(bluefox) remove deprecated unescape

0.3.3 (2016-03-01)

(bluefox) remove deprecated unescape
(bluefox) added connection state

0.3.2 (2016-03-01)

(bluefox) remove deprecated unescape

0.3.1 (2016-02-29)

(bluefox) fixed dimmer and blinds values at start

0.3.0 (2016-02-28)

(bluefox) remove deprecated unescape

0.2.1 (2015-03-25)

(bluefox) fixed "\n" in values

0.2.0 (2015-03-24)

(bluefox) implement check init function

0.1.16 (2015-01-04)

(bluefox) catch errors if states deleted

0.1.15 (2015-01-03)

(bluefox) added hm-rpc as dependency

0.1.14 (2015-01-03)

(bluefox) enabled npm install

0.1.13 (2014-12-11)

(bluefox) processed errors

0.1.12 (2014-12-10)

(bluefox) updated devices if hm-rpc updates the device list

0.1.11 (2014-12-06)

(bluefox) updated devices if hm-rpc updates the device list

0.1.10 (2014-11-21)

(bluefox) support of new naming concept with no parents and children

0.1.9 (2014-11-11)

(bluefox) fixed error with stopping adapter

0.1.8 (2014-10-22)

(bluefox) fixed error with scripts
(bluefox) added gruntfile.js and removed jscs warnings

0.1.7

(Bluefox, Hobbyquaker) fixed bug if no programs or variables exist

0.1.6

(hobbyquaker) added common.role for variables
(hobbyquaker) get state values
(hobbyquaker) queue device/channel renaming

0.1.5

(hobbyquaker) enum fixes

0.1.4

(hobbyquaker) fixes
(hobbyquaker) added settings ui

0.1.3

(hobbyquaker) common.children vs children

0.1.2

(hobbyquaker) Fixed common.children in getPrograms

0.1.1

(hobbyquaker) Fixed common.name attribute

License

The MIT License (MIT)

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.hm-rega dependencies

@iobroker/adapter-core iconv-lite axios xml2js

iobroker.hm-rega development dependencies

@alcalzone/release-script @alcalzone/release-script-plugin-iobroker @alcalzone/release-script-plugin-license @iobroker/testing chai eslint eslint-config-prettier eslint-plugin-prettier gulp mocha prettier

FAQs

What is iobroker.hm-rega?

Connects HomeMatic CCU "Logic Layer" ("ReGaHSS") to ioBroker. Visit Snyk Advisor to see a full health score report for iobroker.hm-rega, including popularity, security, maintenance & community analysis.

Is iobroker.hm-rega popular?

The npm package iobroker.hm-rega receives a total of 1,180 weekly downloads. As such, iobroker.hm-rega popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is iobroker.hm-rega well maintained?

We found that iobroker.hm-rega demonstrated a healthy version release cadence and project activity. It has a community of 30 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is iobroker.hm-rega safe to use?

The npm package iobroker.hm-rega was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 23 July-2024, at 13:48 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP