@homebridge-plugins/homebridge-matter 0.3.0 → 0.3.1

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.
Files changed (4) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/README.md +29 -35
  3. package/dist/homebridge-ui/public/index.html +34 -17
  4. package/package.json +4 -4
package/CHANGELOG.md CHANGED
@@ -2,6 +2,13 @@
2
2
 
3
3
  All notable changes to `@homebridge-plugins/homebridge-matter` will be documented in this file.
4
4
 
5
+ ## v0.3.1 (2025-10-26)
6
+
7
+ ### Changes
8
+
9
+ - move api doc to github repo wiki
10
+ - support links alignment with github wiki
11
+
5
12
  ## v0.3.0 (2025-10-26)
6
13
 
7
14
  ### Changes
package/README.md CHANGED
@@ -21,53 +21,47 @@ Homebridge plugin to showcase examples of Matter devices in Homebridge.
21
21
 
22
22
  This plugin provides example implementations of Matter device types in Homebridge:
23
23
 
24
- - **21+ Matter Device Types**: Complete implementations across all major Matter device categories
25
24
  - **Demonstration & Testing**: Perfect for developers building Matter plugins or testing Matter integrations
26
25
  - **Example Code Reference**: Clean, documented examples showing how to implement Matter devices in Homebridge
27
- - **Apple Home Compatible**: Special support for devices like robotic vacuum cleaners that require dedicated bridges
28
- - **Production Ready**: Built on the official Matter specification with proper cluster implementations
26
+ - **Apple Home Compatible**: Works seamlessly with Apple Home and other Matter ecosystems
29
27
 
30
- #### Supported Matter Device Types
28
+ ### Prerequisites
31
29
 
32
- **Section 4: Lighting Devices** (Matter Spec § 4) - 5 devices
33
- - On/Off Light
34
- - Dimmable Light
35
- - Colour Temperature Light
36
- - Colour Light (HS)
37
- - Extended Colour Light (HS+CCT)
30
+ - To use this plugin, you will need to already have:
31
+ - [Node](https://nodejs.org): latest version of `v20`, `v22` or `v24` - any other major version is not supported.
32
+ - [Homebridge](https://homebridge.io): `>=2.0.0-beta.31` - refer to link for more information and installation instructions.
38
33
 
39
- **Section 5: Smart Plugs/Actuators** (Matter Spec § 5) - 1 device
40
- - On/Off Outlet
34
+ ### Getting Started
41
35
 
42
- **Section 6: Switches & Controllers** (Matter Spec § 6) - 1 device
43
- - On/Off Light Switch
36
+ - [Home](https://github.com/homebridge-plugins/homebridge-matter/wiki/Home)
37
+ - [Enabling Matter](https://github.com/homebridge-plugins/homebridge-matter/wiki/Enabling-Matter)
44
38
 
45
- **Section 7: Sensors** (Matter Spec § 7) - 7 devices
46
- - Contact Sensor
47
- - Light Sensor
48
- - Motion Sensor (Occupancy)
49
- - Temperature Sensor
50
- - Humidity Sensor
51
- - Smoke/CO Alarm
52
- - Water Leak Detector
39
+ ### Development Guide
53
40
 
54
- **Section 8: Closure Devices** (Matter Spec § 8) - 3 devices
55
- - Door Lock
56
- - Window Blind
57
- - Venetian Blind (with Tilt)
41
+ - [Introduction](https://github.com/homebridge-plugins/homebridge-matter/wiki/Introduction)
42
+ - [Core Concepts](https://github.com/homebridge-plugins/homebridge-matter/wiki/Core-Concepts)
43
+ - [Getting Started](https://github.com/homebridge-plugins/homebridge-matter/wiki/Getting-Started)
44
+ - [State Management](https://github.com/homebridge-plugins/homebridge-matter/wiki/State-Management)
45
+ - [Monitoring External Changes](https://github.com/homebridge-plugins/homebridge-matter/wiki/Monitoring-External-Changes)
46
+ - [Best Practices](https://github.com/homebridge-plugins/homebridge-matter/wiki/Best-Practices)
47
+ - [Advanced Patterns](https://github.com/homebridge-plugins/homebridge-matter/wiki/Advanced-Patterns)
58
48
 
59
- **Section 9: HVAC** (Matter Spec § 9) - 2 devices
60
- - Thermostat
61
- - Fan
49
+ ### Reference
62
50
 
63
- **Section 12: Robotic Devices** (Matter Spec § 12) - 1 device
64
- - Robotic Vacuum Cleaner (published as an external accessory on a dedicated Matter bridge)
51
+ - [API Reference](https://github.com/homebridge-plugins/homebridge-matter/wiki/API-Reference)
52
+ - [Matter Types](https://github.com/homebridge-plugins/homebridge-matter/wiki/Matter-Types)
53
+ - [Value Conversions](https://github.com/homebridge-plugins/homebridge-matter/wiki/Value-Conversions)
65
54
 
66
- ### Prerequisites
55
+ ### Device Reference
67
56
 
68
- - To use this plugin, you will need to already have:
69
- - [Node](https://nodejs.org): latest version of `v20`, `v22` or `v24` - any other major version is not supported.
70
- - [Homebridge](https://homebridge.io): `>=2.0.0-alpha.81 <2.0.0-beta.0` - refer to link for more information and installation instructions.
57
+ - [Lighting Devices (§4)](https://github.com/homebridge-plugins/homebridge-matter/wiki/Section-4-Lighting)
58
+ - [Smart Plugs/Actuators (§5)](https://github.com/homebridge-plugins/homebridge-matter/wiki/Section-5-Smart-Plugs)
59
+ - [Switches & Controllers (§6)](https://github.com/homebridge-plugins/homebridge-matter/wiki/Section-6-Switches)
60
+ - [Sensors (§7)](https://github.com/homebridge-plugins/homebridge-matter/wiki/Section-7-Sensors)
61
+ - [Closure Devices (§8)](https://github.com/homebridge-plugins/homebridge-matter/wiki/Section-8-Closure)
62
+ - [HVAC (§9)](https://github.com/homebridge-plugins/homebridge-matter/wiki/Section-9-HVAC)
63
+ - [Robotic Devices (§12)](https://github.com/homebridge-plugins/homebridge-matter/wiki/Section-12-Robotic)
64
+ - [Custom Devices](https://github.com/homebridge-plugins/homebridge-matter/wiki/Custom-Devices)
71
65
 
72
66
  ### Help/About
73
67
 
package/dist/homebridge-ui/public/index.html CHANGED
@@ -70,7 +70,7 @@
70
70
  role="alert"
71
71
  style="display: none; border-left: 4px solid #dc3545;"
72
72
  >
73
- <strong>⚠️ Experimental:</strong> This plugin is still in development and should be considered experimental
73
+ ⚠️ Homebridge Matter support and this plugin are still in development and should be considered <strong>experimental</strong>.
74
74
  </div>
75
75
  <div
76
76
  id="disabledBanner"
@@ -153,25 +153,45 @@
153
153
  <div id="pageSupport" class="mt-4" style="display: none;">
154
154
  <p class="text-center lead">Thank you for using <strong>homebridge-matter</strong></p>
155
155
  <p class="text-center">The links below will take you to our GitHub wiki</p>
156
- <h4>Setup</h4>
156
+ <h4>Getting Started</h4>
157
157
  <ul>
158
- <li>
159
- <a href="https://github.com/homebridge/homebridge/wiki/How-to-Install-Alternate-Plugin-Versions" target="_blank"
160
- >Beta Version</a
161
- >
162
- </li>
158
+ <li><a href="https://github.com/homebridge-plugins/homebridge-matter/wiki/Home" target="_blank">Home</a></li>
159
+ <li><a href="https://github.com/homebridge-plugins/homebridge-matter/wiki/Enabling-Matter" target="_blank">Enabling Matter</a></li>
160
+ </ul>
161
+ <h4>Development Guide</h4>
162
+ <ul>
163
+ <li><a href="https://github.com/homebridge-plugins/homebridge-matter/wiki/Introduction" target="_blank">Introduction</a></li>
164
+ <li><a href="https://github.com/homebridge-plugins/homebridge-matter/wiki/Core-Concepts" target="_blank">Core Concepts</a></li>
165
+ <li><a href="https://github.com/homebridge-plugins/homebridge-matter/wiki/Getting-Started" target="_blank">Getting Started</a></li>
166
+ <li><a href="https://github.com/homebridge-plugins/homebridge-matter/wiki/State-Management" target="_blank">State Management</a></li>
167
+ <li><a href="https://github.com/homebridge-plugins/homebridge-matter/wiki/Monitoring-External-Changes" target="_blank">Monitoring External Changes</a></li>
168
+ <li><a href="https://github.com/homebridge-plugins/homebridge-matter/wiki/Best-Practices" target="_blank">Best Practices</a></li>
169
+ <li><a href="https://github.com/homebridge-plugins/homebridge-matter/wiki/Advanced-Patterns" target="_blank">Advanced Patterns</a></li>
170
+ </ul>
171
+ <h4>Reference</h4>
172
+ <ul>
173
+ <li><a href="https://github.com/homebridge-plugins/homebridge-matter/wiki/API-Reference" target="_blank">API Reference</a></li>
174
+ <li><a href="https://github.com/homebridge-plugins/homebridge-matter/wiki/Matter-Types" target="_blank">Matter Types</a></li>
175
+ <li><a href="https://github.com/homebridge-plugins/homebridge-matter/wiki/Value-Conversions" target="_blank">Value Conversions</a></li>
176
+ </ul>
177
+ <h4>Device Reference</h4>
178
+ <ul>
179
+ <li><a href="https://github.com/homebridge-plugins/homebridge-matter/wiki/Section-4-Lighting" target="_blank">Lighting Devices (§4)</a></li>
180
+ <li><a href="https://github.com/homebridge-plugins/homebridge-matter/wiki/Section-5-Smart-Plugs" target="_blank">Smart Plugs/Actuators (§5)</a></li>
181
+ <li><a href="https://github.com/homebridge-plugins/homebridge-matter/wiki/Section-6-Switches" target="_blank">Switches &amp; Controllers (§6)</a></li>
182
+ <li><a href="https://github.com/homebridge-plugins/homebridge-matter/wiki/Section-7-Sensors" target="_blank">Sensors (§7)</a></li>
183
+ <li><a href="https://github.com/homebridge-plugins/homebridge-matter/wiki/Section-8-Closure" target="_blank">Closure Devices (§8)</a></li>
184
+ <li><a href="https://github.com/homebridge-plugins/homebridge-matter/wiki/Section-9-HVAC" target="_blank">HVAC (§9)</a></li>
185
+ <li><a href="https://github.com/homebridge-plugins/homebridge-matter/wiki/Section-12-Robotic" target="_blank">Robotic Devices (§12)</a></li>
186
+ <li><a href="https://github.com/homebridge-plugins/homebridge-matter/wiki/Custom-Devices" target="_blank">Custom Devices</a></li>
163
187
  </ul>
164
188
  <h4>Help/About</h4>
165
189
  <ul>
166
190
  <li>
167
- <a href="https://github.com/homebridge-plugins/homebridge-matter/issues/new/choose" target="_blank"
168
- >Support Request</a
169
- >
191
+ <a href="https://github.com/homebridge-plugins/homebridge-matter/issues/new/choose" target="_blank">Support Request</a>
170
192
  </li>
171
193
  <li>
172
- <a href="https://github.com/homebridge-plugins/homebridge-matter/blob/latest/CHANGELOG.md" target="_blank"
173
- >Changelog</a
174
- >
194
+ <a href="https://github.com/homebridge-plugins/homebridge-matter/blob/latest/CHANGELOG.md" target="_blank">Changelog</a>
175
195
  </li>
176
196
  <li>
177
197
  <a href="https://github.com/sponsors/bwp91" target="_blank">About Me</a>
@@ -179,11 +199,8 @@
179
199
  </ul>
180
200
  <h4>Credits</h4>
181
201
  <ul>
182
- <li>
183
- To the developers of <a href="https://github.com/matter-js/matter.js" target="_blank">matter.js</a> who make the Matter integration possible.
184
- </li>
202
+ <li>To the developers of <a href="https://github.com/matter-js/matter.js" target="_blank">matter.js</a> who make the Matter integration possible.</li>
185
203
  </ul>
186
-
187
204
  <h4>Disclaimer</h4>
188
205
  <ul>
189
206
  <li>
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "displayName": "Homebridge Matter",
4
4
  "alias": "Matter",
5
5
  "type": "module",
6
- "version": "0.3.0",
6
+ "version": "0.3.1",
7
7
  "description": "Homebridge plugin to showcase examples of Matter devices in Homebridge.",
8
8
  "author": {
9
9
  "name": "bwp91",
@@ -49,7 +49,7 @@
49
49
  "main": "dist/index.js",
50
50
  "engines": {
51
51
  "node": "^20.18.0 || ^22.10.0 || ^24.0.0",
52
- "homebridge": ">=2.0.0-alpha.81 <2.0.0-beta.0"
52
+ "homebridge": ">=2.0.0-alpha.0 <2.0.0-beta.0 || >=2.0.0-beta.31"
53
53
  },
54
54
  "scripts": {
55
55
  "build": "rimraf ./dist && tsc && npm run plugin-ui",
@@ -62,9 +62,9 @@
62
62
  "@homebridge/plugin-ui-utils": "^2.1.1-beta.0"
63
63
  },
64
64
  "devDependencies": {
65
- "@antfu/eslint-config": "^6.0.0",
65
+ "@antfu/eslint-config": "^6.1.0",
66
66
  "@types/node": "^24.9.1",
67
- "homebridge": "2.0.0-alpha.81",
67
+ "homebridge": "^2.0.0-beta.31",
68
68
  "rimraf": "^6.0.1",
69
69
  "ts-node": "^10.9.2",
70
70
  "typescript": "^5.9.3"