matterbridge-melcloud 1.0.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 ADDED
@@ -0,0 +1,239 @@
1
+ # <img src="https://matterbridge.io/assets/matterbridge.svg" alt="Matterbridge Logo" width="64px" height="64px">&nbsp;&nbsp;&nbsp;Matterbridge plugin template changelog
2
+
3
+ All notable changes to this project will be documented in this file.
4
+
5
+ If you like this project and find it useful, please consider giving it a star on GitHub at https://github.com/Luligu/matterbridge-plugin-template and sponsoring it.
6
+
7
+ <a href="https://www.buymeacoffee.com/luligugithub"><img src="https://matterbridge.io/assets/bmc-button.svg" alt="Buy me a coffee" width="120"></a>
8
+
9
+ All notable changes to this project will be documented in this file.
10
+
11
+ <a href="https://www.buymeacoffee.com/luligugithub"><img src="https://matterbridge.io/assets/bmc-button.svg" alt="Buy me a coffee" width="120"></a>
12
+
13
+ ## [1.0.14] - 2026-04-02
14
+
15
+ ### Changed
16
+
17
+ - [package]: Update dependencies.
18
+ - [package]: Bump `typescript-eslint` to v.8.58.0.
19
+
20
+ <a href="https://www.buymeacoffee.com/luligugithub"><img src="https://matterbridge.io/assets/bmc-button.svg" alt="Buy me a coffee" width="80"></a>
21
+
22
+ ## [1.0.13] - 2026-03-24
23
+
24
+ ### Added
25
+
26
+ - [package]: Add `CODE_OF_CONDUCT.md`.
27
+
28
+ ### Changed
29
+
30
+ - [package]: Update dependencies.
31
+ - [package]: Bump package to `automator` v.3.1.4.
32
+ - [package]: Bump `typescript` to v.6.0.2.
33
+ - [package]: Bump `typescript-eslint` to v.8.58.0.
34
+
35
+ <a href="https://www.buymeacoffee.com/luligugithub"><img src="https://matterbridge.io/assets/bmc-button.svg" alt="Buy me a coffee" width="80"></a>
36
+
37
+ ## [1.0.12] - 2026-03-20
38
+
39
+ ### Changed
40
+
41
+ - [package]: Update dependencies.
42
+ - [package]: Bump package to `automator` v.3.1.3.
43
+ - [devcontainer]: Update `Dev Container` configuration.
44
+ - [package]: Refactor `build.yml` to use matterbridge dev branch for push and main for pull requests.
45
+ - [package]: Add `type checking` script for Jest tests.
46
+ - [package]: Update actions versions in workflows.
47
+ - [package]: Bump `eslint` to v.10.1.0.
48
+
49
+ <a href="https://www.buymeacoffee.com/luligugithub"><img src="https://matterbridge.io/assets/bmc-button.svg" alt="Buy me a coffee" width="80"></a>
50
+
51
+ ## [1.0.11] - 2026-03-16
52
+
53
+ ### Changed
54
+
55
+ - [package]: Update dependencies.
56
+ - [package]: Bump package to `automator` v.3.1.2.
57
+ - [package]: Bump `eslint` to v.10.0.3.
58
+ - [package]: Bump `typescript-eslint` to v.8.57.1.
59
+ - [package]: Add `@eslint/json`.
60
+ - [package]: Add `@eslint/markdown`.
61
+ - [package]: Add `CONTRIBUTING.md`.
62
+ - [package]: Add `STYLEGUIDE.md`.
63
+
64
+ <a href="https://www.buymeacoffee.com/luligugithub"><img src="https://matterbridge.io/assets/bmc-button.svg" alt="Buy me a coffee" width="80"></a>
65
+
66
+ ## [1.0.10] - 2026-02-27
67
+
68
+ ### Added
69
+
70
+ - [devContainer]: Add the new [dev container setup](README.md).
71
+
72
+ ### Changed
73
+
74
+ - [package]: Update dependencies.
75
+ - [package]: Bump package to `automator` v.3.1.0.
76
+ - [package]: Bump `eslint` to v.10.0.2.
77
+ - [package]: Bump `typescript-eslint` to v.8.56.1.
78
+ - [package]: Replace `eslint-plugin-import` with `eslint-plugin-simple-import-sort`.
79
+
80
+ <a href="https://www.buymeacoffee.com/luligugithub"><img src="https://matterbridge.io/assets/bmc-button.svg" alt="Buy me a coffee" width="80"></a>
81
+
82
+ ## [1.0.9] - 2026-02-17
83
+
84
+ ### Added
85
+
86
+ - [select]: Add select system.
87
+ - [schema]: Add schema.
88
+ - [config]: Add defaut config.
89
+ - [config]: Add new improved config style.
90
+
91
+ ### Changed
92
+
93
+ - [package]: Bump `typescript-eslint` to v.8.56.0.
94
+ - [eslint]: Use minimatch in ignores.
95
+
96
+ <a href="https://www.buymeacoffee.com/luligugithub"><img src="https://matterbridge.io/assets/bmc-button.svg" alt="Buy me a coffee" width="80"></a>
97
+
98
+ ## [1.0.8] - 2026-02-16
99
+
100
+ ### Changed
101
+
102
+ - [package]: Update dependencies.
103
+ - [package]: Bump package to `automator` v.3.0.8.
104
+ - [package]: Bump `node-ansi-logger` to v.3.2.0.
105
+ - [package]: Bump `node-persist-manager` to v.2.0.1.
106
+ - [package]: Bump `eslint` to v.10.0.0.
107
+
108
+ <a href="https://www.buymeacoffee.com/luligugithub"><img src="https://matterbridge.io/assets/bmc-button.svg" alt="Buy me a coffee" width="80"></a>
109
+
110
+ ## [1.0.7] - 2026-02-07
111
+
112
+ ### Changed
113
+
114
+ - [package]: Update dependencies.
115
+ - [package]: Bump package to automator v.3.0.6.
116
+ - [package]: Bump node-ansi-logger to v.3.2.0.
117
+ - [vite]: Add cache under .cache/vite.
118
+ - [workflow]: Migrate to trusted publishing / OIDC. Since you can authorize only one workflow with OIDC, publish.yml now does both the publishing with tag latest (on release) and with tag dev (on schedule or manual trigger).
119
+
120
+ <a href="https://www.buymeacoffee.com/luligugithub"><img src="https://matterbridge.io/assets/bmc-button.svg" alt="Buy me a coffee" width="80"></a>
121
+
122
+ ## [1.0.6] - 2026-01-27
123
+
124
+ ### Changed
125
+
126
+ - [package]: Update dependencies.
127
+ - [package]: Bump package to automator v.3.0.2.
128
+
129
+ <a href="https://www.buymeacoffee.com/luligugithub"><img src="https://matterbridge.io/assets/bmc-button.svg" alt="Buy me a coffee" width="80"></a>
130
+
131
+ ## [1.0.5] - 2026-01-14
132
+
133
+ ### Changed
134
+
135
+ - [package]: Update dependencies.
136
+ - [package]: Bump package to automator v.3.0.0.
137
+
138
+ <a href="https://www.buymeacoffee.com/luligugithub"><img src="https://matterbridge.io/assets/bmc-button.svg" alt="Buy me a coffee" width="80"></a>
139
+
140
+ ## [1.0.4] - 2025-12-23
141
+
142
+ ### Added
143
+
144
+ - [DevContainer]: Refactored Dev Container setup. The Matterbridge instance can now be paired on native Linux hosts or WSL 2 with Docker engine CLI integration. On Docker Desktop on Windows or macOS is not possible cause Docker Desktop runs inside a VM and not directly on the host so mDNS is not supported.
145
+ - [DevContainer]: Since is now possible to pair from Dev Container, named volumes have been added to persist storage and plugins across rebuilds.
146
+
147
+ ### Changed
148
+
149
+ - [package]: Update dependencies.
150
+ - [package]: Update to the current Matterbridge signatures.
151
+ - [package]: Require Matterbridge v.3.4.0.
152
+ - [package]: Bump package to automator v.2.1.0.
153
+
154
+ <a href="https://www.buymeacoffee.com/luligugithub"><img src="https://matterbridge.io/assets/bmc-button.svg" alt="Buy me a coffee" width="80"></a>
155
+
156
+ ## [1.0.3] - 2025-11-14
157
+
158
+ ### Changed
159
+
160
+ - [package]: Update dependencies.
161
+ - [package]: Bump package to automator v.2.0.12.
162
+ - [jest]: Update jestHelpers to v.1.0.12.
163
+ - [workflows]: Use shallow clones and --no-fund --no-audit for faster builds.
164
+ - [package]: Update to the current Matterbridge signatures.
165
+
166
+ <a href="https://www.buymeacoffee.com/luligugithub"><img src="https://matterbridge.io/assets/bmc-button.svg" alt="Buy me a coffee" width="80"></a>
167
+
168
+ ## [1.0.2] - 2025-10-25
169
+
170
+ ### Changed
171
+
172
+ - [package]: Bump package to automator v. 2.0.9.
173
+ - [jest]: Update jestHelpers to v. 1.0.9.
174
+
175
+ <a href="https://www.buymeacoffee.com/luligugithub"><img src="https://matterbridge.io/assets/bmc-button.svg" alt="Buy me a coffee" width="80"></a>
176
+
177
+ ## [1.0.1] - 2025-10-17
178
+
179
+ ### Breaking Changes
180
+
181
+ - [node]: Require node.js 20.x or 22.x or 24.x (LTS versions). Node.js 18.x is no longer supported.
182
+ - [platform]: Require Matterbridge v.3.3.0.
183
+ - [platform]: Upgrade to the new PlatformMatterbridge signature.
184
+
185
+ ### Changed
186
+
187
+ - [package]: Bump package to automator version 2.0.8
188
+ - [workflows]: Ignore any .md in build.yaml.
189
+ - [workflows]: Ignore any .md in codeql.yaml.
190
+ - [workflows]: Ignore any .md in codecov.yaml.
191
+ - [template]: Update bug_report.md.
192
+ - [jest]: Update jestHelpers to v. 1.0.8.
193
+ - [workflows]: Improve speed on Node CI.
194
+ - [devcontainer]: Add the plugin name to the container.
195
+ - [devcontainer]: Improve performance of first build with shallow clone.
196
+
197
+ <a href="https://www.buymeacoffee.com/luligugithub"><img src="https://matterbridge.io/assets/bmc-button.svg" alt="Buy me a coffee" width="80"></a>
198
+
199
+ ## [1.0.0] - 2025-06-15
200
+
201
+ - First release of the Matterbridge plugin template
202
+
203
+ <a href="https://www.buymeacoffee.com/luligugithub"><img src="https://matterbridge.io/assets/bmc-button.svg" alt="Buy me a coffee" width="80"></a>
204
+
205
+ <!-- Commented out section
206
+ ## [1.0.0] - 2025-07-01
207
+
208
+ ### Added
209
+
210
+ - [Feature 1]: Description of the feature.
211
+ - [Feature 2]: Description of the feature.
212
+
213
+ ### Changed
214
+
215
+ - [Feature 3]: Description of the change.
216
+ - [Feature 4]: Description of the change.
217
+
218
+ ### Deprecated
219
+
220
+ - [Feature 5]: Description of the deprecation.
221
+
222
+ ### Removed
223
+
224
+ - [Feature 6]: Description of the removal.
225
+
226
+ ### Fixed
227
+
228
+ - [Bug 1]: Description of the bug fix.
229
+ - [Bug 2]: Description of the bug fix.
230
+
231
+ ### Security
232
+
233
+ - [Security 1]: Description of the security improvement.
234
+
235
+ <a href="https://www.buymeacoffee.com/luligugithub">
236
+ <img src="https://matterbridge.io/assets/bmc-button.svg" alt="Buy me a coffee" width="80">
237
+ </a>
238
+
239
+ -->
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/README.md ADDED
@@ -0,0 +1,163 @@
1
+ # <img src="https://matterbridge.io/assets/matterbridge.svg" alt="Matterbridge Logo" width="64px" height="64px">&nbsp;&nbsp;&nbsp;Matterbridge MelCloud Plugin
2
+
3
+ [![powered by](https://img.shields.io/badge/powered%20by-matterbridge-blue)](https://www.npmjs.com/package/matterbridge)
4
+
5
+ A Matterbridge plugin to control Mitsubishi air conditioning units via MelCloud in Matter-compatible smart home ecosystems.
6
+
7
+ ## Features
8
+
9
+ - **On/Off Control**: Turn your air conditioning on or off
10
+ - **Temperature Control**: Set target temperature
11
+ - **Mode Selection**: Switch between heating, cooling, auto, fan, and dry modes
12
+ - **Real-time Status**: Automatic polling of device state
13
+ - **Multi-device Support**: Discovers and exposes all Air-to-Air devices from your MelCloud account
14
+
15
+ ## Requirements
16
+
17
+ - [Matterbridge](https://github.com/Luligu/matterbridge) >= 3.4.0
18
+ - A MelCloud account with registered Mitsubishi air conditioning units
19
+ - Node.js >= 20.19.0
20
+
21
+ ## Installation
22
+
23
+ ```bash
24
+ npm install matterbridge-melcloud
25
+ ```
26
+
27
+ Or install via the Matterbridge frontend.
28
+
29
+ ## Configuration
30
+
31
+ Configure the plugin in the Matterbridge frontend or edit the config file directly:
32
+
33
+ ```json
34
+ {
35
+ "name": "matterbridge-melcloud",
36
+ "type": "DynamicPlatform",
37
+ "username": "your-melcloud-email@example.com",
38
+ "password": "your-melcloud-password",
39
+ "pollingInterval": 30000,
40
+ "whiteList": [],
41
+ "blackList": [],
42
+ "debug": false
43
+ }
44
+ ```
45
+
46
+ ### Configuration Options
47
+
48
+ | Option | Type | Default | Description |
49
+ | ----------------- | ------- | ---------- | ----------------------------------- |
50
+ | `username` | string | _required_ | Your MelCloud account email |
51
+ | `password` | string | _required_ | Your MelCloud account password |
52
+ | `pollingInterval` | number | 30000 | How often to poll device state (ms) |
53
+ | `whiteList` | array | [] | Only expose devices in this list |
54
+ | `blackList` | array | [] | Exclude devices in this list |
55
+ | `debug` | boolean | false | Enable debug logging |
56
+
57
+ ## Supported Devices
58
+
59
+ Currently supports **Air-to-Air** (DeviceType 0) Mitsubishi units connected via MelCloud.
60
+
61
+ ## Matter Thermostat Modes
62
+
63
+ The plugin maps MelCloud modes to Matter thermostat modes:
64
+
65
+ | MelCloud Mode | Matter Mode |
66
+ | ------------- | ----------- |
67
+ | Heating | Heat |
68
+ | Cooling | Cool |
69
+ | Auto | Auto |
70
+ | Fan | Fan Only |
71
+ | Dry | Dry |
72
+ | Off | Off |
73
+
74
+ ## Available workflows
75
+
76
+ The project has the following already configured workflows:
77
+
78
+ - build.yml: run on push and pull request and build, lint and test the plugin on node 20, 22 and 24 with ubuntu, macOS and windows.
79
+ - publish.yml: publish on npm under tag latest when you create a new release in GitHub and publish under tag dev on npm from main (or dev if it exist) branch every day at midnight UTC if there is a new commit. The workflow has been updated for trusted publishing / OIDC, so you need to setup the package npm settings to allow it (i.e. authorize publish.yml).
80
+ - codeql.yml: run CodeQL from the main branch on each push and pull request.
81
+ - codecov.yml: run CodeCov from the main branch on each push and pull request. You need a codecov account and to add your CODECOV_TOKEN to the repository secrets.
82
+
83
+ ## ⚠️ Warning: GitHub Actions Costs for Private Repositories
84
+
85
+ **Important**: If you plan to use this template in a **private repository**, be aware that GitHub Actions usage may incur costs:
86
+
87
+ - **Free tier limits**: Private repositories have limited free GitHub Actions minutes per month (2,000 minutes for free accounts).
88
+ - **Workflow intensity**: This template includes multiple workflows that run on different operating systems (Ubuntu, macOS, Windows) and Node.js versions (20, 22, 24), which can consume minutes quickly.
89
+ - **Daily automated workflows**: The dev publishing workflows run daily, which can add up over time.
90
+ - **Pricing varies by OS**: macOS runners cost 10x more than Ubuntu runners, Windows runners cost 2x more.
91
+
92
+ **Recommendations for private repos**:
93
+
94
+ - Monitor your GitHub Actions usage in your account settings.
95
+ - Consider disabling some workflows or reducing the OS/Node.js version matrix.
96
+ - Review GitHub's [pricing for Actions](https://github.com/pricing) to understand costs.
97
+ - For public repositories, GitHub Actions are free with generous limits.
98
+
99
+ ## Getting Started
100
+
101
+ 1. Create a repository from this template using the [template feature of GitHub](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template).
102
+ 2. Clone it locally and open the cloned folder project with [VS Code](https://code.visualstudio.com/). If you have docker or docker desktop, just run `code .`.
103
+ 3. When prompted, reopen in the devcontainer. VS Code will automatically build and start the development environment with all dependencies installed.
104
+ 4. Update the code and configuration files as needed for your plugin. Change the name (keep always matterbridge- at the beginning of the name), version, description, author, homepage, repository, bugs and funding in the package.json.
105
+ 5. Follow the instructions in the matterbridge [README-DEV](https://github.com/Luligu/matterbridge/blob/main/README-DEV.md) and comments in module.ts to implement your plugin logic.
106
+
107
+ ## Using the Dev Container
108
+
109
+ - Docker Desktop or Docker Engine are required to use the Dev Container.
110
+ - Devcontainer works correctly on Linux, macOS, Windows, WSL2.
111
+ - The devcontainer provides Node.js, npm, TypeScript, ESLint, Prettier, Jest, Vitest and other tools and extensions pre-installed and configured.
112
+ - The dev branch of Matterbridge is already build and installed into the Dev Container and linked to the plugin. The plugin is automatically added to matterbridge.
113
+ - The devcontainer is optimized using named mounts for node_modules, .cache and matterbridge.
114
+ - You can run, build, and test your plugin directly inside the container.
115
+ - To open a terminal in the devcontainer, use the VS Code terminal after the container starts.
116
+ - All commands (npm, tsc, matterbridge etc.) will run inside the container environment.
117
+ - All the source files are on the host.
118
+
119
+ ## Dev containers networking limitations
120
+
121
+ Dev containers have networking limitations depending on the host OS and Docker setup.
122
+
123
+ • Docker Desktop on Windows or macOS:
124
+
125
+ - Runs inside a VM
126
+ - Host networking mode is NOT available
127
+ - Use the Matterbridge Plugin Dev Container system (https://matterbridge.io/reflector/MatterbridgeDevContainer.html) for development and testing. It provides a similar environment to the native Linux setup with the following features:
128
+
129
+ ✅ Is possible to pair with an Home Assistant instance running in docker compose on the same host
130
+
131
+ ✅ mDNS works normally inside the containers
132
+
133
+ ✅ Remote and local network access (cloud services, internet APIs) work normally
134
+
135
+ ✅ Matterbridge and plugins work normally
136
+
137
+ ✅ Matterbridge frontend works normally
138
+
139
+ - Use the Matterbridge mDNS Reflector with the Matterbridge Plugin Dev Container system (https://matterbridge.io/reflector/Reflector.html) if you want to pair with a controller on the local network with the following features:
140
+
141
+ ✅ Is possible to pair with a controller running on the local network using mDNS reflector
142
+
143
+ ✅ mDNS, remote and local network access (cloud services, internet APIs) work normally
144
+
145
+ ✅ Matterbridge and plugins work normally
146
+
147
+ ✅ Matterbridge frontend works normally
148
+
149
+ • Native Linux or WSL 2 with Docker Engine CLI integration:
150
+
151
+ - ✅ Host networking IS available (with --network=host)
152
+
153
+ - ✅ Full local network access is supported
154
+
155
+ - ✅ Matterbridge and plugins work correctly, including pairing
156
+
157
+ - ✅ Matterbridge frontend works normally
158
+
159
+ ## Documentation
160
+
161
+ Refer to the Matterbridge [documentation](https://matterbridge.io) for other guidelines.
162
+
163
+ ---