homebridge-homematicip-multichannel 1.4.0

package/CHANGELOG.md

@@ -0,0 +1,396 @@
+## 1.4.0 (2026-05-17)
+
+### Improvements
+
+- **HmIPW-DRS8 / HmIPW-DRS4 / HmIP-BS2 / HmIP-PCBS2 / HmIP-MOD-OC8 / HmIP-WHS2 / HmIP-DRSI4**:
+  All switch channels are now exposed as individual HomeKit Switch services (multi-channel
+  support, originally added in master via @gkminix's work, is now part of a tagged release).
+- **Switches**: Add `ConfiguredName` characteristic per channel so channel-specific labels
+  are displayed in the Home app, and provide a sensible default name when the device label
+  is empty.
+- **Switches**: Migrate cached accessories from older single-service layout by removing the
+  orphaned legacy Switch service that was created without a subtype.
+- **MULTI_MODE_INPUT_SWITCH_CHANNEL**: State updates from this channel type are now applied
+  (previously only handled at registration time).
+
+### Packaging
+
+- Add `prepare` script and `files` allowlist so the plugin can be installed straight from
+  a GitHub fork (`npm i github:<user>/homebridge-homematicip`) and still ship a built
+  `dist/` directory.
+
+## 1.3.1 (2024-01-13)
+
+### New devices
+
+- **HmIP-DRDI3**: Added multichannel dimmer (@smhex)
+- **HmIP-FSI16**: Added switch actor for 16A (@gkminix)
+
+### Improvements
+
+- **General**: Version bumps of dependencies
+
+## 1.2.0 (2023-11-01)
+
+### New devices
+
+- **HmIP-SWO**: Added weather sensors: HmIP-SWO-B, HmIP-SWO-PL, HmIP-SWO-PR
+
+### Improvements
+
+- **Thermostats**: Added eve compatible valve position as custom characteristic
+- **General**: Unified HmIPHeatingThermostat, HmIPWallMountedThermostat
+- **General**: Fixed missing fakegato statistics
+- **General**: Limited fakegato updates
+- **General**: Version bumps of dependencies
+
+### Bugfix
+
+- **General**: Works with Node.js >= 20
+
+## 1.0.1 (2022-09-05)
+
+### Bugfix
+
+- **Switches**: Fixed "characteristic was supplied illegal value: null"
+
+## 1.1.0 (2022-10-12)
+
+### Improvements
+
+- **WallMountedThermostat**: Improved handling of heating/cooling state (@aceg1k)
+- **WallMountedThermostat**: Guard against unnecessary API calls (@aceg1k)
+- **API call limited**: Added reservoir and ability to prioritize API calls (@aceg1k)
+- **General**: Version bumps of dependencies
+
+## 1.0.1 (2022-09-05)
+
+### Bugfix
+
+- **Switches**: Fixed "characteristic was supplied illegal value: null"
+
+## 1.0.0 (2022-08-31)
+
+### New devices
+
+- **HmIP-BLS**: Added support for HmIP-BLS door lock sensor (Many thanks to @smhex)
+
+### Improvements
+
+- **ClimateSensor**: Added switch to force a thermostat device to act as a climate sensor (Many thanks to @ohueter)
+- **General**: It's time for version 1.0.0!
+- **General**: Version bumps of dependencies.
+
+## 0.8.0 (2022-05-11)
+
+### New devices
+
+- **HmIP-DLS**: Added support for HmIP-DLS door lock sensor (Many thanks to @smhex)
+
+### Improvements
+
+- **General**: Version bumps of dependencies.
+- **General**: Switched to pnpm instead of npm.
+
+### Bugfix
+
+- **SecuritySystem**: Fixed erroneous state change within the home app.
+
+## 0.7.2 (2021-12-29)
+
+### Improvements
+
+- **HmIP-MOD**: Added "lightSwitch" config option to disable light switch if not available.
+- **General**: Reduced verbosity of log messages. Some frequent log messages have log level debug now.
+
+### Bugfix
+
+- **General**: Fixed removal of cached accessories which were removed from HmIP cloud.
+
+## 0.7.1 (2021-12-21)
+
+### Improvements
+
+- **General**: Added per-device config. All devices can be hidden by setting config.json option "hidden": true. See
+  [GitHub Wiki](https://github.com/marcsowen/homebridge-homematicip/wiki) for details.
+- **HmIP-DLD**: New option "openLatch". When set to true, opening the lock will open the door completely by pulling
+  the door latch.
+
+### Bugfix
+
+- **HmIP-DLD**: Lock target state was not always updated correctly displaying an opening/closing animation in Home app.
+
+## 0.7.0 (2021-12-18)
+
+### New devices
+
+- **HmIP-DLD**: Added support for HmIP door lock drive - thanks to @adrianoje for borrowing me his HmIP-DLD!
+
+### Improvements
+
+- **General**: Version bumps of dependencies.
+
+## 0.6.0 (2021-11-26)
+
+### Improvements
+
+- **Elgato EVE history service**: Support for graphical temperature/humidity plots when using EVE app. The history is 
+  stored on the filesystem of the server running this plugin (e.g. your Raspberry Pi). Many thanks to @dmalch for 
+  implementing this feature.
+- **General**: Clean-up and version bumps.
+
+## 0.5.2 (2021-10-07)
+
+### New devices
+
+- **HmIP-eTRV-E**: Added support for HmIP Thermostat "Evo" - thanks to Sven Liebert for adding support.
+
+### Improvements
+
+- **HmIPHeatingThermostat**: Extend min/max set temperature range to 5-30 degrees.
+
+### Bugfix
+
+- **General**: Version bumps for dependencies. I'm still using 3.0.0-beta9 of node-fetch since all projects need to
+switch from "commonJS" to "ESM" starting from node-fetch 3.0.0. This caused problems for some users.
+(https://github.com/marcsowen/homebridge-homematicip/issues/165) 
+
+## 0.5.1 (2021-07-29)
+
+### Bugfix
+
+- **General**: Version bumps for dependencies. Solves an issue with node-fetch for newer installations.
+
+## 0.5.0 (2021-05-15)
+
+### Improvements
+
+- **HmIP-STH/STHD**: Device is now a thermostat instead of a simple climate sensor. The target temperature is usually
+  extracted from the device channel. In case of the HmIP-STH the target temperature is determined from the heating group
+  since the device channel doesn't provide this kind of information.
+- **General**: Log messages contain a unit symbol where applicable.
+- **General**: Removed now long-running Hclean-up code for obsolete services and characteristics
+
+## 0.4.3 (2021-03-23)
+
+### Bugfix
+
+- **Dimmer**: Fixed turning dimmer on with Siri.
+
+## 0.4.2 (2021-03-23)
+
+### Bugfix
+
+- **Dimmer**: Fixed "flashing" of dimmer while changing dim level.
+
+## 0.4.1 (2021-03-21)
+
+### New devices
+
+- **Dimmer**: Added dimmer devices: HmIP-PDT, HmIP-BDT, HmIP-FDT, HmIPW-DRD3
+
+## 0.4.0 (2021-03-19)
+
+### New devices
+
+- **MotionDetector**: Added motion detector style devices: HmIP-SMI, HmIP-SMO-A, HmIP-SMI55
+- **PresenceDetector**: Added presence detector: HmIP-SPI
+
+## 0.3.7 (2021-03-13)
+
+### Bugfix
+
+- **General**: Fixed tampered state mapping.
+
+## 0.3.6 (2021-03-13)
+
+### Improvements
+
+- **ContactSensor**: Added sabotage state (tampered state) for contact sensors which support it.
+
+### Bugfix
+
+- **General**: Fixed low battery display for all devices with sabotage channel.
+
+## 0.3.5 (2021-03-13)
+
+### Improvements
+
+- **SmokeDetector**: Removed obsolete tampered characteristic.
+
+## 0.3.4 (2021-03-13)
+
+### Bugfix
+
+- **General**: Prevent warning messages about missing characteristics.
+
+## 0.3.3 (2021-03-13)
+
+### Improvements
+
+- **General**: Removed obsolete battery services and characteristics.
+
+## 0.3.2 (2021-03-13)
+
+### Improvements
+
+- **ContactSensor**: Removed obsolete current door state characteristic.
+
+## 0.3.1 (2021-03-13)
+
+### Improvements
+
+- **ContactSensor**: Removed additional "window" service which prevents display of two window sensors when there is only
+  one.
+- **RotaryHandleSensor**: Use window service for the rotary handle sensor exclusively. Removed contact service for this
+  device.
+
+## 0.3.0 (2021-02-28)
+
+### New devices
+
+- **SecuritySystem**: Added security system including internal and external alarm zones. This is definitely beta, so 
+  please don't trust the alarm to go off inside HomeKit. Also check the HomematicIP app to be sure the right alarm
+  setting is applied.
+
+### Improvements
+
+- **ContactSensor**: Added "window" service to contact sensor. The window service supports "tilted" windows by
+  displaying a current position of 50%.
+- **General**: Only add battery service if device actually has a battery.
+- **General**: Removed now optional characteristics "battery level" and "charging state" which are not supported by
+  HomematicIP anyway.
+
+## 0.2.5 (2021-02-12)
+
+### Improvements
+
+- **Shutter/Blind**: Improved target position behavior even further. Now target always follows the current position. The
+spinning progress indicator was actually spinning because current and target position were not the same.
+
+## 0.2.4 (2021-02-12)
+
+### Improvements
+
+- **General**: Removed all push button type devices. I haven't figured out a way to get push events from the HmIP-Cloud.
+My guess is it is not possible. Now those devices not shown as unsupported devices in the Home App.
+  
+## 0.2.3 (2021-02-12)
+
+### New devices
+
+- **HmIP-eTRV-C**: Heating-thermostat compact without display
+
+### Improvements
+
+- **HmIP-eTRV**: Fixed update of valve position. Show valve position changes in logs.
+- **HmIP-eTRV**: Valve position > 0 indicates current cooling/heating state: HEAT. Valve position = 0 indicates current
+  heating cooling/heating state: OFF.
+- **HmIP-eTRV**: Added logs for setting ignored values (target cooling/heating mode, display units).
+- **HmIP-eTRV**: Target cooling/heating mode is now ignored. Will be used for future mapping of custom states.
+- **HmIP-eTRV**: Show changes of valve state in logs.
+
+### Bugfix
+
+- **Shutter/Blind**: Fixed spinning progress indicator in Home app.
+- **HmIP-eTRV-C**: HmIP-eTRV-C was listed but not actually supported. 
+
+## 0.2.2 (2021-02-11)
+
+### New devices
+
+- **HmIP-SLO**: Light Sensor outdoor
+
+### Improvements
+
+- **General**: Added API call rate limiter to prevent 60 minutes IP blocks by eq-3 when using fast firing GUI elements
+like the shutter slider in EVE app.
+- **SwitchMeasuring**: Show power and energy with less decimal places.
+- **Shutter/Blind**: Show shutter and slats level without decimal places.
+- **General**: Minor code cleanup.
+
+## 0.2.1 (2021-02-07)
+
+### Improvements
+
+- **WallMountedThermostat**: Added info log when changing target heating/cooling state or display unit. These changes 
+  are ignored.
+
+### Bug Fixes
+
+- **General**: Fixed dependency problem preventing plugin to start.
+
+## 0.2.0 (2021-02-04)
+
+### Improvements
+
+- **Switch**: Split switch device into switch and measuring switch device to expose more features.
+- **SwitchMeasuring**: Added EVE characteristics ElectricPower and ElectricalEnergy for measuring switches. Those values
+  can be viewed e.g. by using the EVE App on iOS.
+- **General**: Code clean-up. Removed dozens of unused home references.
+- **General**: Removed unused weather device.
+- **WallMountedThermostat**: Target heating mode is now AUTO by default. Current heating mode depends on cooling state
+of heating group.
+  
+## 0.1.5 (2021-02-02)
+
+### Improvements
+
+- **GarageDoor**: Introduced assumed target position. Enhanced state logic.
+
+### Bug Fixes
+
+- **Blind**: Set correct (current) shutter level when setting slats level. This should prevent the shutter from going
+all the way up when changing slats level.
+
+## 0.1.4 (2021-02-01)
+
+### Improvements
+
+- **GarageDoor**: Removed explicit target door position which is not known anyway. This might improve display
+  of animation in Home App.
+
+## 0.1.3 (2021-02-01)
+
+### New devices
+
+- **HmIP-FBL**: Blind Actuator - flush-mount
+- **HmIP-BBL**: Blind Actuator - brand-mount
+
+## 0.1.2 (2021-01-29)
+
+### Improvements
+
+- **General**: Automatically remove unsupported devices from cache
+
+## 0.1.1 (2021-01-28)
+
+### Improvements
+
+- **GarageDoor**: Further optimized target door state by updating it asynchronously.
+
+### Bug Fixes
+
+- **WaterSensor**: Hopefully fixed "This callback function has already been called by someone else; it can only be
+  called one time." bug. Removed humidity detector for now.
+- **ClimateSensor**: Fixed a bug where outside temperatures below zero won't be accepted by HomeKit.
+
+## 0.1.0 (2021-01-28)
+
+### New devices
+
+- **HmIP-SWD (Water sensor)**. The sensor exposes two services: Moisture detector and water level detector.
+
+### Improvements
+
+- **GarageDoor**: Display light state as ON/OFF instead of true/false
+- **HomeControllerAccessPoint**: Removed the device completely. It was not useful anyway and confused people why there
+  was still light burning in the house.
+- **SmokeDetector**: Smoke alarm is only triggered when the device itself is detecting smoke. In this way the alarm
+displayed on your device is showing the sensor where the smoke actually was detected, not all the smoke sensors in the 
+  house.
+  
+### Bug Fixes
+
+- **GarageDoor**: Fixes target door state update when OPEN/CLOSE was triggered by external app
+- **SmokeDetector**: Removed erroneous tampered state detection when instead it was really a burglar alarm.

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.