homebridge-echonet-lite-plus 0.7.0 → 0.7.2

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 0.7.2
+
+- Clarified how HEMS commonly uses ECHONET Lite and why some HEMS-compatible devices may be discoverable by this plugin.
+- Documented that standard ECHONET Lite air-conditioner temperature control uses 1°C steps, while manufacturer-specific local APIs may support 0.5°C.
+- Rejected fractional numeric writes that an ECHONET property schema cannot represent instead of silently rounding them.
+
+## 0.7.1
+
+- Added a bilingual `NOTICE-MRA.md` identifying the ECHONET Consortium as the copyright holder and documenting the source of the bundled MRA data.
+- Clarified that the plugin's MIT License does not alter the copyright, license, or other terms applicable to the MRA data.
+- Hardened ECHONET Lite property-map parsing against malformed and duplicate EPC entries, based on findings from the separately developed ECHONET Lite engine/core implementation.
+- Documented that this standalone package and Homebridge ECHONET Lite Engine Plus are mutually exclusive and must not be enabled together on the same Homebridge host.
+
 ## 0.7.0
 
 - Kept disabled devices out of Apple Home while retaining the complete discovered-device registry in the settings UI.

package/NOTICE-MRA.md

@@ -0,0 +1,29 @@
+# Machine Readable Appendix (MRA) Notice
+
+This package includes Machine Readable Appendix Version 1.4.0 data published by the ECHONET Consortium.
+
+Copyright in the MRA data belongs to the ECHONET Consortium.
+
+Source:
+
+- [ECHONET Consortium — Machine Readable Appendix](https://echonet.jp/spec_mra_rr3/)
+
+The MIT License of `homebridge-echonet-lite-plus` applies to the plugin source code. It does not alter the copyright, license, or other terms applicable to the MRA data.
+
+The ECHONET Consortium is preparing general guidance for credit and license notices for secondary distribution. This project will review and update this notice if relevant official guidance is published.
+
+---
+
+# Machine Readable Appendix（MRA）に関する表示
+
+本パッケージには、エコーネットコンソーシアムが公開するMachine Readable Appendix Version 1.4.0のデータを同梱しています。
+
+MRAデータの著作権は、エコーネットコンソーシアムに帰属します。
+
+出典：
+
+- [エコーネットコンソーシアム — Machine Readable Appendix](https://echonet.jp/spec_mra_rr3/)
+
+`homebridge-echonet-lite-plus`のMITライセンスはプラグインのソースコードに適用されるものであり、MRAデータに適用される著作権、ライセンスその他の条件を変更するものではありません。
+
+エコーネットコンソーシアムから二次配布時のクレジット・ライセンス表記に関する公式方針が公開された場合、本プロジェクトは内容を確認し、必要に応じて本表示を更新します。

package/README.md

@@ -6,7 +6,19 @@ LAN内の ECHONET Lite 機器と直接通信し、HomeKit に公開するHomebri
 
 ECHONET ConsortiumのMachine Readable Appendix Version 1.4.0を同梱し、EPCの名称、アクセス規則、数値型、符号、倍率、状態enumの読書きをMRAから解決します。HomeKitサービスへの割当ては、MRAで変換したプロパティ名を使用します。
 
-MRAはECHONET Consortiumが公開する参考データです。本プラグインのMITライセンスはMRA自体の著作権や利用条件を変更するものではありません。
+MRAデータの著作権はエコーネットコンソーシアムに帰属します。出典およびライセンス適用範囲の詳細は、同梱の[NOTICE-MRA.md](NOTICE-MRA.md)を参照してください。本プラグインのMITライセンスはMRAデータの著作権、ライセンスその他の条件を変更するものではありません。
+
+## HEMSとECHONET Liteの関係
+
+HEMS（Home Energy Management System）は、家庭内の電力・発電量・ガス・水道などを見える化し、家電や住宅設備を管理・制御するシステムです。
+
+ECHONET Liteは、HEMSを構成するコントローラーと、エアコン、照明、給湯器、分電盤などの機器が通信するために広く利用されている共通規格です。そのため、ECHONET Liteという名称を意識していなくても、ご自宅にある「HEMS対応機器」がECHONET Lite対応機器である場合があります。
+
+本プラグインは、LAN内のECHONET Lite対応機器と直接通信し、対応する機能をHomebridge／Appleホームへ橋渡しします。メーカーがApple HomeやHomeKitへ直接対応していないHEMS対応機器でも、ECHONET Liteで通信できる場合は、本プラグインから検出・操作できる可能性があります。
+
+ECHONET Liteの利用先はHEMSだけに限定されません。家電制御、住宅設備管理、セキュリティ、見守りなどにも利用されています。また、本プラグインはECHONET Liteによる機器通信を扱うものであり、エネルギー最適化、料金計算、需要予測などを行うHEMSそのものではありません。
+
+なお、HEMS対応と表示されているすべての機器を操作できるとは限りません。ネットワークへの接続方法、メーカー独自の制限、機器が公開しているECHONET Liteプロパティ、HomeKitで表現可能な機能などによって対応範囲が異なります。
 
 ## 動作要件とインストール
 
@@ -22,6 +34,19 @@ npm install -g homebridge-echonet-lite-plus
 
 インストール後、プラグイン設定を開いて対象ネットワークを確認し、Child Bridgeを再起動してください。既存バージョンから更新する場合も設定は引き継がれます。
 
+## Engine Plusとの排他的利用
+
+本パッケージは、ECHONET Liteの探索・通信からHomeKit公開までを単独で行うStandalone版です。
+
+別パッケージの`homebridge-echonet-lite-engine-plus`は、ECHONET Lite通信を共有Engineへ集約してメーカー別プラグイン等へ配信する構成です。両パッケージは同じ役割のECHONET Lite通信部分を持つため、排他的に選択してください。
+
+- 同一Homebridgeホストで両方を同時に有効化しないでください。
+- Standalone版を使用する場合は、Engine Plusおよびそれを利用する構成を無効化してください。
+- Engine Plus構成へ移行する場合は、本Standalone版を停止してからEngine Plusを有効化してください。
+- 両方を同時に動かすと、UDP/3610の待受け、機器探索、状態取得、操作要求が競合する可能性があります。
+
+This package is the standalone implementation. It is mutually exclusive with `homebridge-echonet-lite-engine-plus`; do not enable both on the same Homebridge host.
+
 ## 対応方針
 
 ECHONET Liteの機器クラスとプロパティを、意味が一致するHomeKitサービスへ割り当てます。HomeKitに対応する型がない計測値を、照度や湿度など別の値へ偽装することはありません。
@@ -49,6 +74,12 @@ Appleのホームアプリには電力・発電量・EV残量・水道・ガス
 
 ECHONET Liteとして存在していても、HomeKit上で安全かつ自然に表現できない機器クラスは検出一覧にのみ表示し、対応マッピングを実装するまでHomeKitへは公開しません。
 
+### エアコンの設定温度単位
+
+本Standalone版は、家庭用エアコンの標準ECHONET Liteプロパティ「温度設定値」（EPC `B3`）に合わせ、設定温度を1℃単位で扱います。EPC `B3`では0.5℃を表現できないため、Appleホーム上で0.5℃単位を選択できるようにしても、その値を標準ECHONET Lite通信でそのまま実機へ送ることはできません。
+
+Engine Plus構成のメーカー別プラグインでは、メーカーが提供する対応ローカルAPIなど、0.5℃を表現できる別の操作経路が設定されている場合に限り、0.5℃単位へ対応することがあります。標準ECHONET Lite通信へフォールバックする場合は1℃単位です。
+
 ## 構成
 
 HomebridgeをECHONET Lite機器と同じLANで動かし、設定画面で自動探索を有効にします。複数NIC環境では対象ネットワークを指定してください。

package/config.schema.json

@@ -4,7 +4,7 @@
   "singular": true,
   "customUi": true,
   "customUiPath": "./homebridge-ui",
-  "headerDisplay": "## ECHONET Lite Plus\nDirectly discovers ECHONET Lite devices on your LAN and exposes them to HomeKit. MQTT is not required.  \nLAN内のECHONET Lite機器を直接探索し、HomeKitへ追加します。MQTTは不要です。",
+  "headerDisplay": "## ECHONET Lite Plus\nDirectly discovers ECHONET Lite devices on your LAN and exposes them to HomeKit. MQTT is not required. Do not enable this standalone plugin together with Homebridge ECHONET Lite Engine Plus on the same Homebridge host.  \nLAN内のECHONET Lite機器を直接探索し、HomeKitへ追加します。MQTTは不要です。本単独版とHomebridge ECHONET Lite Engine Plusは排他的に使用し、同一Homebridge上で同時に有効化しないでください。",
   "footerDisplay": "Set **Log Level / ログレベル** to Debug only while troubleshooting, then return it to Info.  \n問題調査時だけDebugへ変更し、確認後はInfoへ戻してください。",
   "schema": {
     "type": "object",

package/dist/mra.js

@@ -45,7 +45,13 @@ class MraRepository {
             if (typeof value === 'number' && Number.isFinite(value)) {
                 for (const number of this.schemasOfType(schema, 'number')) {
                     const multiple = number.multiple ?? 1, size = this.sizeOf(number.format), signed = number.format?.startsWith('int') ?? false;
-                    const n = Math.round(value / multiple);
+                    const scaled = value / multiple;
+                    // Do not silently round a value that the ECHONET schema cannot
+                    // represent. For example, the standard air-conditioner B3 property
+                    // is an integer Celsius value, so 25.5°C must not become 26°C.
+                    if (!Number.isInteger(scaled))
+                        continue;
+                    const n = scaled;
                     if ((number.minimum !== undefined && n < number.minimum) || (number.maximum !== undefined && n > number.maximum))
                         continue;
                     const min = signed ? -(2 ** (size * 8 - 1)) : 0, max = signed ? 2 ** (size * 8 - 1) - 1 : 2 ** (size * 8) - 1;

package/dist/platform.js

@@ -273,7 +273,11 @@ class EchonetLitePlatform {
         this.api.updatePlatformAccessories([a]);
     }
     propertyRequests(map) {
-        const bytes = map.match(/../g)?.map(v => parseInt(v, 16)) ?? [];
+        if (!/^(?:[0-9a-f]{2})+$/i.test(map))
+            return {};
+        const bytes = map.match(/../g)?.map(v => Number.parseInt(v, 16)) ?? [];
+        if (!bytes.length || bytes.some(Number.isNaN))
+            return {};
         const epcs = [];
         if (bytes[0] <= 15) {
             for (let i = 1; i <= bytes[0] && i < bytes.length; i++)
@@ -284,7 +288,7 @@ class EchonetLitePlatform {
                 for (let bit = 0; bit < 8; bit++)
                     if ((bytes[i + 1] ?? 0) & (1 << bit))
                         epcs.push(((bit + 8) * 16 + i).toString(16));
-        return Object.fromEntries(epcs.filter(epc => !['d6', '9d', '9e', '9f'].includes(epc)).map(epc => [epc, '']));
+        return Object.fromEntries([...new Set(epcs.map(epc => epc.toLowerCase()))].filter(epc => !['d6', '9d', '9e', '9f'].includes(epc)).map(epc => [epc, '']));
     }
     scheduleFacilitySync() {
         if (this.facilitySyncTimer)

package/homebridge-ui/public/index.html

@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8">
   <meta name="viewport" content="width=device-width,initial-scale=1">
-  <link rel="stylesheet" href="style.css?v=0.7.0">
+  <link rel="stylesheet" href="style.css?v=0.7.1">
 </head>
 <body>
   <div class="elsp-shell">

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "homebridge-echonet-lite-plus",
-  "version": "0.7.0",
-  "description": "Expose ECHONET Lite devices directly to HomeKit",
+  "version": "0.7.2",
+  "description": "Standalone Homebridge plugin for ECHONET Lite devices",
   "author": "ECHONET Lite Plus contributors",
   "license": "MIT",
   "homepage": "https://github.com/sylpied/homebridge-echonet-lite-plus#readme",
@@ -20,6 +20,7 @@
     "README.md",
     "CHANGELOG.md",
     "LICENSE",
+    "NOTICE-MRA.md",
     "work/MRA_v1.4.0.zip"
   ],
   "keywords": [