homebridge-shelly-matter 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +23 -0
- package/LICENSE +202 -0
- package/NOTICE +10 -0
- package/README.md +92 -0
- package/config.schema.json +129 -0
- package/dist/deviceConfig.js +22 -0
- package/dist/deviceConfig.js.map +1 -0
- package/dist/index.js +6 -0
- package/dist/index.js.map +1 -0
- package/dist/platform.js +357 -0
- package/dist/platform.js.map +1 -0
- package/dist/settings.js +3 -0
- package/dist/settings.js.map +1 -0
- package/dist/shelly/auth.js +151 -0
- package/dist/shelly/auth.js.map +1 -0
- package/dist/shelly/coapServer.js +979 -0
- package/dist/shelly/coapServer.js.map +1 -0
- package/dist/shelly/mdnsScanner.js +400 -0
- package/dist/shelly/mdnsScanner.js.map +1 -0
- package/dist/shelly/shelly.js +434 -0
- package/dist/shelly/shelly.js.map +1 -0
- package/dist/shelly/shellyComponent.js +340 -0
- package/dist/shelly/shellyComponent.js.map +1 -0
- package/dist/shelly/shellyDevice.js +1568 -0
- package/dist/shelly/shellyDevice.js.map +1 -0
- package/dist/shelly/shellyFetch.js +159 -0
- package/dist/shelly/shellyFetch.js.map +1 -0
- package/dist/shelly/shellyProperty.js +56 -0
- package/dist/shelly/shellyProperty.js.map +1 -0
- package/dist/shelly/shellyTypes.js +24 -0
- package/dist/shelly/shellyTypes.js.map +1 -0
- package/dist/shelly/shellyUtils.js +39 -0
- package/dist/shelly/shellyUtils.js.map +1 -0
- package/dist/shelly/utils/deepEqual.js +130 -0
- package/dist/shelly/utils/deepEqual.js.map +1 -0
- package/dist/shelly/utils/error.js +72 -0
- package/dist/shelly/utils/error.js.map +1 -0
- package/dist/shelly/utils/index.js +4 -0
- package/dist/shelly/utils/index.js.map +1 -0
- package/dist/shelly/utils/validate.js +182 -0
- package/dist/shelly/utils/validate.js.map +1 -0
- package/dist/shelly/wsClient.js +334 -0
- package/dist/shelly/wsClient.js.map +1 -0
- package/dist/shelly/wsServer.js +219 -0
- package/dist/shelly/wsServer.js.map +1 -0
- package/dist/shellyAccessory.js +260 -0
- package/dist/shellyAccessory.js.map +1 -0
- package/homebridge-ui/public/index.html +209 -0
- package/homebridge-ui/server.js +131 -0
- package/package.json +60 -0
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to this project will be documented in this file.
|
|
4
|
+
|
|
5
|
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
|
|
6
|
+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
|
+
|
|
8
|
+
## [0.1.0] - 2026-07-24
|
|
9
|
+
|
|
10
|
+
Initial release.
|
|
11
|
+
|
|
12
|
+
### Added
|
|
13
|
+
|
|
14
|
+
- Expose Shelly Gen 2/3 relays and plugs to Apple Home over Matter via the Homebridge 2.2 Matter API.
|
|
15
|
+
- Live power, voltage, current and cumulative energy through the Matter ElectricalPowerMeasurement / ElectricalEnergyMeasurement clusters, shown on Apple Home tiles and in the Energy view on iOS/tvOS 27+.
|
|
16
|
+
- Per-device and per-channel accessory types (light / outlet / switch) with kind-based defaults, friendly names, and hide toggles — all in a single `devices` configuration array.
|
|
17
|
+
- Multi-channel devices exposed as composed Matter bridged nodes, one endpoint per channel; accessory identity rotates cleanly when a type or composition changes.
|
|
18
|
+
- Settings GUI with mDNS auto-discovery, manual host entry for devices mDNS cannot reach, and a "Connected controllers" list showing the Matter fabrics (e.g. Apple Home, Apple Keychain) commissioned on the bridge.
|
|
19
|
+
- Shelly protocol layer (CoIoT for Gen 1, WebSocket RPC for Gen 2+, mDNS discovery, password-protected device support) vendored from [matterbridge-shelly](https://github.com/Luligu/matterbridge-shelly) by Luca Liguori (Apache-2.0) — see `NOTICE`.
|
|
20
|
+
|
|
21
|
+
### Known issues
|
|
22
|
+
|
|
23
|
+
- Requires Homebridge core Matter fixes that are not yet in a released Homebridge (composed-accessory FixedLabel/PowerSource, deferred node start). Without them, Apple Home stops responding to controls ~30 seconds after pairing. See the "Known issues" section in the README for the tracking pull requests.
|
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/NOTICE
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
homebridge-shelly-matter
|
|
2
|
+
Copyright 2026 Kerem Erkan
|
|
3
|
+
|
|
4
|
+
This product includes software developed by Luca Liguori:
|
|
5
|
+
- The Shelly protocol and device layer under src/shelly/ is derived from
|
|
6
|
+
matterbridge-shelly (https://github.com/Luligu/matterbridge-shelly),
|
|
7
|
+
Copyright Luca Liguori, licensed under the Apache License 2.0.
|
|
8
|
+
- The validation utilities under src/shelly/utils/ are derived from
|
|
9
|
+
matterbridge (https://github.com/Luligu/matterbridge),
|
|
10
|
+
Copyright Luca Liguori, licensed under the Apache License 2.0.
|
package/README.md
ADDED
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
# homebridge-shelly-matter
|
|
2
|
+
|
|
3
|
+
Expose [Shelly](https://www.shelly.com) devices to Apple Home (and other Matter controllers) through [Homebridge](https://homebridge.io) 2.x — **including live power and cumulative energy metering**, which Apple Home displays starting with iOS/tvOS 27.
|
|
4
|
+
|
|
5
|
+
HomeKit's own accessory protocol (HAP) has no energy characteristics; Matter does. Homebridge v2.2.0 added the Matter `ElectricalPowerMeasurement` and `ElectricalEnergyMeasurement` clusters to its plugin API, and this plugin bridges Shelly's native metering onto them.
|
|
6
|
+
|
|
7
|
+
## Requirements
|
|
8
|
+
|
|
9
|
+
- Homebridge **v2.2.0 or later** with [Matter enabled](https://github.com/homebridge/homebridge/wiki/Updating-To-Homebridge-v2.0) on the bridge — **plus the Matter fixes listed under [Known issues](#known-issues-homebridge-core-fixes-pending) below**
|
|
10
|
+
- Node.js 22.12+
|
|
11
|
+
- iOS/tvOS 27+ to see energy data in Apple Home (the accessories themselves work on earlier versions)
|
|
12
|
+
|
|
13
|
+
## Known issues (Homebridge core fixes pending)
|
|
14
|
+
|
|
15
|
+
This plugin exposes each device as a **composed** Matter accessory (a bridged
|
|
16
|
+
node with one endpoint per channel). Apple Home only models composed
|
|
17
|
+
accessories correctly when the parent endpoint carries `FixedLabel` and
|
|
18
|
+
`PowerSource` clusters, and reliable restarts depend on how Homebridge brings
|
|
19
|
+
its Matter node online. Both are fixed in Homebridge core, but the fixes are
|
|
20
|
+
**not in a released Homebridge yet** — they are open pull requests:
|
|
21
|
+
|
|
22
|
+
- **[homebridge/homebridge#3972](https://github.com/homebridge/homebridge/pull/3972)** — FixedLabel + PowerSource on composed parents (plus stable accessory identity and semantic tags). **Without this, controls work for ~30 seconds after pairing and then permanently stop responding** (tiles keep showing live state; commands are silently dropped). This affects every device this plugin exposes.
|
|
23
|
+
- **[homebridge/homebridge#3973](https://github.com/homebridge/homebridge/pull/3973)** — defer the Matter node coming online until registrations settle, and keep controller subscriptions alive across restarts. Without it, bridged devices may drop to "No Response" and lose their room assignments after a Homebridge restart.
|
|
24
|
+
- **[homebridge/homebridge#3974](https://github.com/homebridge/homebridge/issues/3974)** — surface commissioned controllers (fabrics) in the Homebridge UI. Until then this plugin shows them in its own settings page ("Connected controllers").
|
|
25
|
+
|
|
26
|
+
Until these ship in a Homebridge release, run a Homebridge build that includes
|
|
27
|
+
them (e.g. the maintainer's beta once merged, or a local build of the PR
|
|
28
|
+
branches). This requirement will be replaced by a concrete
|
|
29
|
+
`engines.homebridge` version floor once a release contains the fixes.
|
|
30
|
+
|
|
31
|
+
These are also **Apple Home** behaviours, not plugin bugs: the same 30-second
|
|
32
|
+
control-loss and stranded-fabric issues are being reported to Apple separately.
|
|
33
|
+
|
|
34
|
+
## Supported devices (early release)
|
|
35
|
+
|
|
36
|
+
- **Shelly Gen 2/3 relays and plugs** (Plus/Pro 1, 1PM, 2PM in switch profile, Plus Plug S, …)
|
|
37
|
+
- On/off control
|
|
38
|
+
- Live power (W), voltage, current
|
|
39
|
+
- Cumulative energy (kWh), including returned energy where the device measures it
|
|
40
|
+
- Multi-channel devices are exposed as one Matter bridged node with one outlet per channel.
|
|
41
|
+
|
|
42
|
+
Devices without supported components are discovered but skipped with a log message. Covers, dimmers, RGB, sensors, Gen 1 and BLU devices are on the roadmap — the underlying protocol layer already speaks CoIoT (Gen 1), WebSocket RPC (Gen 2+), and mDNS discovery.
|
|
43
|
+
|
|
44
|
+
## Configuration
|
|
45
|
+
|
|
46
|
+
Most configuration happens in the plugin settings UI: discovered devices appear in a table where each device (or channel of a multi-channel device) gets a friendly name, an accessory type, and a hide toggle. Everything is stored in a single `devices` array:
|
|
47
|
+
|
|
48
|
+
```json
|
|
49
|
+
{
|
|
50
|
+
"platform": "ShellyMatter",
|
|
51
|
+
"name": "ShellyMatter",
|
|
52
|
+
"mdnsDiscover": true,
|
|
53
|
+
"devices": [
|
|
54
|
+
{ "device": "shellyplus1-441793AABBCC", "name": "Office Ceiling" },
|
|
55
|
+
{ "device": "shellyplus1-441793DDEEFF", "accessoryType": "switch" },
|
|
56
|
+
{
|
|
57
|
+
"device": "shellypro2pm-EC62AABBCC",
|
|
58
|
+
"name": "Cinema",
|
|
59
|
+
"channels": [
|
|
60
|
+
{ "channel": 1, "name": "Cinema Curtain", "accessoryType": "switch", "hidden": true }
|
|
61
|
+
]
|
|
62
|
+
},
|
|
63
|
+
{ "host": "192.168.1.50", "powerMetering": false }
|
|
64
|
+
]
|
|
65
|
+
}
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
- `device` — the device id. One entry per physical device.
|
|
69
|
+
- `host` — IP address/hostname; only needed for devices mDNS cannot find (they are added directly).
|
|
70
|
+
- `name` — the name shown in the Home app.
|
|
71
|
+
- `accessoryType` — `light`, `outlet`, or `switch`. Defaults: plugs are outlets, wired relay devices are lights.
|
|
72
|
+
- `hidden` — set `true` to not expose the device (or a channel) to Matter at all.
|
|
73
|
+
- `channels` — per-channel settings for multi-channel devices (`channel` is 0-based): `name`, `accessoryType`, `hidden`. Channels without an entry use the device settings.
|
|
74
|
+
- `powerMetering` — set `false` to drop the power/energy clusters on a metering device.
|
|
75
|
+
|
|
76
|
+
Devices need no entry at all when the defaults fit - entries only record deviations.
|
|
77
|
+
|
|
78
|
+
## Changing a device's accessory type
|
|
79
|
+
|
|
80
|
+
Changing the accessory type of a device or channel deliberately re-creates its
|
|
81
|
+
Matter accessory with a fresh identity (Apple Home mishandles devices that
|
|
82
|
+
reappear with the same identity but a different device type, leaving them
|
|
83
|
+
uneditable). The re-created accessory returns to the default room - reassign
|
|
84
|
+
it once after the change.
|
|
85
|
+
|
|
86
|
+
## Uninstalling / reinstalling
|
|
87
|
+
|
|
88
|
+
If the Homebridge UI option to remove plugin data on uninstall is enabled, uninstalling this plugin also deletes the bridge's **Matter commissioning storage** — which un-pairs it from Apple Home and discards room assignments. To move or reinstall the plugin without re-pairing, keep that option off (or back up `<storage>/matter/<bridge-id>/` first); the pairing survives a plain reinstall.
|
|
89
|
+
|
|
90
|
+
## Attribution
|
|
91
|
+
|
|
92
|
+
The Shelly protocol and device layer (`src/shelly/`) is derived from [matterbridge-shelly](https://github.com/Luligu/matterbridge-shelly) by Luca Liguori, licensed under Apache-2.0 — see `NOTICE`. This plugin is an independent port to the Homebridge Matter plugin API and is not affiliated with Matterbridge or Allterco Robotics.
|
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
{
|
|
2
|
+
"pluginAlias": "ShellyMatter",
|
|
3
|
+
"pluginType": "platform",
|
|
4
|
+
"singular": true,
|
|
5
|
+
"customUi": true,
|
|
6
|
+
"customUiPath": "./homebridge-ui",
|
|
7
|
+
"headerDisplay": "Exposes Shelly devices to Apple Home over Matter, including live power and energy metering (iOS 27+). Requires Homebridge v2.2.0+ with Matter enabled on the bridge.",
|
|
8
|
+
"schema": {
|
|
9
|
+
"type": "object",
|
|
10
|
+
"properties": {
|
|
11
|
+
"name": {
|
|
12
|
+
"title": "Name",
|
|
13
|
+
"type": "string",
|
|
14
|
+
"default": "ShellyMatter",
|
|
15
|
+
"required": true
|
|
16
|
+
},
|
|
17
|
+
"mdnsDiscover": {
|
|
18
|
+
"title": "Discover devices via mDNS",
|
|
19
|
+
"type": "boolean",
|
|
20
|
+
"default": true,
|
|
21
|
+
"description": "Automatically discover Shelly devices on the local network."
|
|
22
|
+
},
|
|
23
|
+
"devices": {
|
|
24
|
+
"title": "Devices",
|
|
25
|
+
"type": "array",
|
|
26
|
+
"description": "Per-device configuration. Discovered devices appear in the table above; add a device manually only when mDNS cannot find it (set its IP address). By default plugs are shown as outlets and other devices as lights, with power metering enabled where available.",
|
|
27
|
+
"items": {
|
|
28
|
+
"type": "object",
|
|
29
|
+
"properties": {
|
|
30
|
+
"device": {
|
|
31
|
+
"title": "Device id",
|
|
32
|
+
"type": "string"
|
|
33
|
+
},
|
|
34
|
+
"host": {
|
|
35
|
+
"title": "IP address or hostname (filled automatically for discovered devices; lets the plugin work without mDNS)",
|
|
36
|
+
"type": "string"
|
|
37
|
+
},
|
|
38
|
+
"name": {
|
|
39
|
+
"title": "Name shown in the Home app",
|
|
40
|
+
"type": "string"
|
|
41
|
+
},
|
|
42
|
+
"accessoryType": {
|
|
43
|
+
"title": "Accessory type",
|
|
44
|
+
"type": "string",
|
|
45
|
+
"required": true,
|
|
46
|
+
"default": "light",
|
|
47
|
+
"oneOf": [
|
|
48
|
+
{ "title": "Light", "enum": ["light"] },
|
|
49
|
+
{ "title": "Outlet", "enum": ["outlet"] },
|
|
50
|
+
{ "title": "Switch", "enum": ["switch"] }
|
|
51
|
+
]
|
|
52
|
+
},
|
|
53
|
+
"hidden": {
|
|
54
|
+
"title": "Hide (do not expose to Matter)",
|
|
55
|
+
"type": "boolean",
|
|
56
|
+
"default": false
|
|
57
|
+
},
|
|
58
|
+
"powerMetering": {
|
|
59
|
+
"title": "Power metering (if available on device)",
|
|
60
|
+
"type": "boolean",
|
|
61
|
+
"default": true
|
|
62
|
+
},
|
|
63
|
+
"channels": {
|
|
64
|
+
"title": "Channels (multi-channel devices only)",
|
|
65
|
+
"type": "array",
|
|
66
|
+
"description": "Per-channel settings; channels without an entry use the device settings. Channel numbers are 0-based, as on the device.",
|
|
67
|
+
"condition": {
|
|
68
|
+
"functionBody": "try { const c = model.devices[arrayIndices[0]].channels; return Array.isArray(c) && c.length > 1; } catch (e) { return false; }"
|
|
69
|
+
},
|
|
70
|
+
"items": {
|
|
71
|
+
"type": "object",
|
|
72
|
+
"properties": {
|
|
73
|
+
"channel": {
|
|
74
|
+
"title": "Channel (0-based)",
|
|
75
|
+
"type": "integer",
|
|
76
|
+
"required": true,
|
|
77
|
+
"minimum": 0
|
|
78
|
+
},
|
|
79
|
+
"name": {
|
|
80
|
+
"title": "Name shown in the Home app",
|
|
81
|
+
"type": "string"
|
|
82
|
+
},
|
|
83
|
+
"accessoryType": {
|
|
84
|
+
"title": "Accessory type",
|
|
85
|
+
"type": "string",
|
|
86
|
+
"required": true,
|
|
87
|
+
"default": "light",
|
|
88
|
+
"oneOf": [
|
|
89
|
+
{ "title": "Light", "enum": ["light"] },
|
|
90
|
+
{ "title": "Outlet", "enum": ["outlet"] },
|
|
91
|
+
{ "title": "Switch", "enum": ["switch"] }
|
|
92
|
+
]
|
|
93
|
+
},
|
|
94
|
+
"hidden": {
|
|
95
|
+
"title": "Hide (do not expose to Matter)",
|
|
96
|
+
"type": "boolean",
|
|
97
|
+
"default": false
|
|
98
|
+
}
|
|
99
|
+
}
|
|
100
|
+
}
|
|
101
|
+
}
|
|
102
|
+
}
|
|
103
|
+
}
|
|
104
|
+
},
|
|
105
|
+
"username": {
|
|
106
|
+
"title": "Username",
|
|
107
|
+
"type": "string",
|
|
108
|
+
"placeholder": "admin",
|
|
109
|
+
"description": "Username for password-protected Gen 1 devices. Gen 2+ devices always use 'admin'."
|
|
110
|
+
},
|
|
111
|
+
"password": {
|
|
112
|
+
"title": "Password",
|
|
113
|
+
"type": "string",
|
|
114
|
+
"description": "Password for password-protected devices."
|
|
115
|
+
},
|
|
116
|
+
"interfaceName": {
|
|
117
|
+
"title": "Network interface",
|
|
118
|
+
"type": "string",
|
|
119
|
+
"description": "Optional network interface to use for mDNS discovery (e.g. eth0)."
|
|
120
|
+
},
|
|
121
|
+
"debug": {
|
|
122
|
+
"title": "Debug logging",
|
|
123
|
+
"type": "boolean",
|
|
124
|
+
"default": false
|
|
125
|
+
}
|
|
126
|
+
},
|
|
127
|
+
"required": ["name"]
|
|
128
|
+
}
|
|
129
|
+
}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
export const ACCESSORY_TYPES = ['light', 'outlet', 'switch'];
|
|
2
|
+
export function deviceConfigs(config) {
|
|
3
|
+
const list = config.devices;
|
|
4
|
+
return Array.isArray(list) ? list.filter((entry) => entry !== null && typeof entry === 'object') : [];
|
|
5
|
+
}
|
|
6
|
+
/** Entry for a device id; falls back to a host-only entry. */
|
|
7
|
+
export function configForDevice(config, deviceId, host) {
|
|
8
|
+
const entries = deviceConfigs(config);
|
|
9
|
+
return entries.find((entry) => entry.device === deviceId) ?? (host !== undefined ? entries.find((entry) => entry.device === undefined && entry.host === host) : undefined);
|
|
10
|
+
}
|
|
11
|
+
export function channelConfig(entry, channel) {
|
|
12
|
+
if (!Array.isArray(entry?.channels))
|
|
13
|
+
return undefined;
|
|
14
|
+
return entry.channels.find((c) => c !== null && typeof c === 'object' && c.channel === channel);
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* Default presentation: plugs are outlets, wired relay devices usually drive
|
|
18
|
+
* lights. Plug-in devices (Plug S, Plug US/UK/IT, Gen 1 Plug...) all carry
|
|
19
|
+
* 'plug' in the device id.
|
|
20
|
+
*/
|
|
21
|
+
export const defaultAccessoryType = (deviceId) => (deviceId.includes('plug') ? 'outlet' : 'light');
|
|
22
|
+
//# sourceMappingURL=deviceConfig.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"deviceConfig.js","sourceRoot":"","sources":["../src/deviceConfig.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAU,CAAC;AA2BtE,MAAM,UAAU,aAAa,CAAC,MAAsB;IAClD,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC;IAC5B,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAE,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,CAA0B,CAAC,CAAC,CAAC,EAAE,CAAC;AAClI,CAAC;AAED,8DAA8D;AAC9D,MAAM,UAAU,eAAe,CAAC,MAAsB,EAAE,QAAgB,EAAE,IAAa;IACrF,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;IACtC,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,KAAK,QAAQ,CAAC,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,KAAK,SAAS,IAAI,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;AAC7K,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,KAAqC,EAAE,OAAe;IAClF,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC;QAAE,OAAO,SAAS,CAAC;IACtD,OAAO,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,IAAI,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,CAAC,OAAO,KAAK,OAAO,CAAC,CAAC;AAClG,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,QAAgB,EAAiB,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC"}
|
package/dist/index.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE3D,eAAe,CAAC,GAAQ,EAAQ,EAAE;IAChC,GAAG,CAAC,gBAAgB,CAAC,WAAW,EAAE,aAAa,EAAE,oBAAoB,CAAC,CAAC;AACzE,CAAC,CAAC"}
|