homebridge-velux 0.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/LICENSE +201 -0
- package/README.md +71 -0
- package/cli/velux.js +15 -0
- package/config.schema.json +47 -0
- package/homebridge-velux.png +0 -0
- package/index.js +17 -0
- package/lib/VeluxAccessory.js +37 -0
- package/lib/VeluxGateway.js +189 -0
- package/lib/VeluxPlatform.js +112 -0
- package/lib/VeluxService.js +127 -0
- package/package.json +55 -0
- package/velux.png +0 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img src="homebridge-velux.png" height="200px">
|
|
3
|
+
</p>
|
|
4
|
+
<span align="center">
|
|
5
|
+
|
|
6
|
+
# Homebridge Velux
|
|
7
|
+
[](https://www.npmjs.com/package/homebridge-velux)
|
|
8
|
+
[](https://www.npmjs.com/package/homebridge-velux)
|
|
9
|
+
[](https://discord.gg/bXmnUwXQR9)
|
|
10
|
+
<!-- [](https://github.com/homebridge/homebridge/wiki/Verified-Plugins) -->
|
|
11
|
+
|
|
12
|
+
[](https://github.com/ebaauw/homebridge-velux/issues)
|
|
13
|
+
[](https://github.com/ebaauw/homebridge-velux/pulls)
|
|
14
|
+
[](https://standardjs.com)
|
|
15
|
+
|
|
16
|
+
</span>
|
|
17
|
+
|
|
18
|
+
## Homebridge plugin for Velux Integra KLF 200 gateway
|
|
19
|
+
Copyright © 2025 Erik Baauw. All rights reserved.
|
|
20
|
+
|
|
21
|
+
This [Homebridge](https://github.com/homebridge/homebridge) plugin exposes to Apple's [HomeKit](http://www.apple.com/ios/home/) Velux Integra devices connected to a Velux Integra KLF 200 gateway. The KLF 200 provides a local API, unlike the newer Velux Active gateway. This plugin does not support the Velux Active gateway.
|
|
22
|
+
|
|
23
|
+
Currenlty, Homebridge Velux supports motorised roller blinds.
|
|
24
|
+
|
|
25
|
+
It provides the following features:
|
|
26
|
+
- Monitoring the connected device state from HomeKit
|
|
27
|
+
- Current position;
|
|
28
|
+
- Controlling the connected device from HomeKit:
|
|
29
|
+
- Setting target position;
|
|
30
|
+
- Support for multiple KLF 200 gateways;
|
|
31
|
+
- Includes `velux` command-line utility for troubleshooting.
|
|
32
|
+
|
|
33
|
+
Homebridge Velux exposes an accessory for each connected device.
|
|
34
|
+
<!-- See the [Wiki](https://github.com/ebaauw/homebridge-velux/wiki/Velux-Accessory) for details. -->
|
|
35
|
+
|
|
36
|
+
### Prerequisites
|
|
37
|
+
Homebridge Velux communicates with the Velux Integra KLF 200 gateway using its local API, described in the _Technical Specification for KLF 200 API io-homecontrol® Gateway_ version 3.18 from 2019/12/10. The gatway needs to be at firmware version [2.0.0.71](https://www.velux.com/klf200).
|
|
38
|
+
|
|
39
|
+
You need to connect the KLF 200 to your network using its wired Ethernet interface, as the API is only exposed on this interface.
|
|
40
|
+
The WiFi interface only works as an access point.
|
|
41
|
+
The web-based configuration of the gateway, including pairing devices, is only available on the WiFi interface.
|
|
42
|
+
|
|
43
|
+
Note that the API password is the password of the WiFi access point, not that of on the web-based configuration.
|
|
44
|
+
|
|
45
|
+
### Configuration
|
|
46
|
+
Homebridge Velux needs a list of KLF 200 gateways, and their WiFi passwords.
|
|
47
|
+
<!-- See the [Wiki](https://github.com/ebaauw/homebridge-velux/wiki/Configuration) for details. -->
|
|
48
|
+
|
|
49
|
+
Best configure Homebridge Velux through the Homebridge UI.
|
|
50
|
+
|
|
51
|
+
### Command-Line Utility
|
|
52
|
+
Homebridge Velux include the `velux` command line utility, to interact with a KLF 200 gateway.
|
|
53
|
+
Run `velux -h` for more info.
|
|
54
|
+
|
|
55
|
+
### Troubleshooting
|
|
56
|
+
Make sure your KLF 200 gateway has been configured correctly, before setting up Homebridge Velux.
|
|
57
|
+
<!-- See the [Wiki](https://github.com/ebaauw/homebridge-velux/wiki/Gateway-Setup) for details. -->
|
|
58
|
+
I do not have the bandwidth to provide support on setting up your gateway.
|
|
59
|
+
|
|
60
|
+
I developed this plugin for my solar-powered, motorised back-out roller blinds.
|
|
61
|
+
I would expect Homebridge Velux to work with other blinds, as long as they use the same actuator type, 640.
|
|
62
|
+
|
|
63
|
+
If you like support for other device types, please open an [issue](https://github.com/ebaauw/homebridge-velux/issues) on GitHub, listing the output of `velux info`.
|
|
64
|
+
|
|
65
|
+
#### Getting Help
|
|
66
|
+
I do not have the bandwidth to help you setting up your KLF 200 gateway.
|
|
67
|
+
|
|
68
|
+
<!-- If you have a question about Homebridge Velux, please post a message to the **#velux** channel of the Homebridge community on [Discord](https://discord.gg/bXmnUwXQR9). -->
|
|
69
|
+
|
|
70
|
+
If you encounter a problem with Homebridge Velux, or want to request a feature or support for a particular device, please open an issue on [GitHub](https://github.com/ebaauw/homebridge-velux/issues).
|
|
71
|
+
Please include the output of `velux info` and the relevant messages in the Homebridge log.
|
package/cli/velux.js
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
|
|
3
|
+
// velux.js
|
|
4
|
+
//
|
|
5
|
+
// Command line interface to Velux Integra KLF 200 gateway.
|
|
6
|
+
// Copyright © 2025 Erik Baauw. All rights reserved.
|
|
7
|
+
|
|
8
|
+
import { createRequire } from 'node:module'
|
|
9
|
+
|
|
10
|
+
import { VeluxTool } from 'hb-velux-tools/VeluxTool'
|
|
11
|
+
|
|
12
|
+
const require = createRequire(import.meta.url)
|
|
13
|
+
const packageJson = require('../package.json')
|
|
14
|
+
|
|
15
|
+
new VeluxTool(packageJson).main()
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
{
|
|
2
|
+
"pluginAlias": "Velux",
|
|
3
|
+
"pluginType": "platform",
|
|
4
|
+
"singular": true,
|
|
5
|
+
"headerDisplay": "Homebridge plugin for Velux Integra KLF 200 gateway",
|
|
6
|
+
"footerDisplay": "",
|
|
7
|
+
"schema": {
|
|
8
|
+
"type": "object",
|
|
9
|
+
"properties": {
|
|
10
|
+
"name": {
|
|
11
|
+
"description": "Plugin name as displayed in the Homebridge log.",
|
|
12
|
+
"type": "string",
|
|
13
|
+
"required": true,
|
|
14
|
+
"default": "Velux"
|
|
15
|
+
},
|
|
16
|
+
"hosts": {
|
|
17
|
+
"title": "Hosts",
|
|
18
|
+
"notitle": true,
|
|
19
|
+
"type": "array",
|
|
20
|
+
"items": {
|
|
21
|
+
"type": "object",
|
|
22
|
+
"properties": {
|
|
23
|
+
"host": {
|
|
24
|
+
"title": "Host",
|
|
25
|
+
"description": "IP address or hostname (and port) of KLF 200 gatway. Default port: 51200.",
|
|
26
|
+
"type": "string",
|
|
27
|
+
"required": true
|
|
28
|
+
},
|
|
29
|
+
"password": {
|
|
30
|
+
"title": "Password",
|
|
31
|
+
"description": "The WiFi assword of the FLF 200 gateway.",
|
|
32
|
+
"type": "string",
|
|
33
|
+
"required": true
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
},
|
|
38
|
+
"timeout": {
|
|
39
|
+
"title": "Timeout",
|
|
40
|
+
"description": "Timeout in seconds. Default: 15.",
|
|
41
|
+
"type": "integer",
|
|
42
|
+
"minimum": 1,
|
|
43
|
+
"maximum": 60
|
|
44
|
+
}
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
}
|
|
Binary file
|
package/index.js
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
// homebridge-velux/index.js
|
|
2
|
+
// Copyright © 2025 Erik Baauw. All rights reserved.
|
|
3
|
+
//
|
|
4
|
+
// Homebridge plugin for Velux Integra KLF 200 gateway.
|
|
5
|
+
|
|
6
|
+
import { createRequire } from 'node:module'
|
|
7
|
+
|
|
8
|
+
import { VeluxPlatform } from './lib/VeluxPlatform.js'
|
|
9
|
+
|
|
10
|
+
const require = createRequire(import.meta.url)
|
|
11
|
+
const packageJson = require('./package.json')
|
|
12
|
+
|
|
13
|
+
function main (homebridge) {
|
|
14
|
+
VeluxPlatform.loadPlatform(homebridge, packageJson, 'Velux', VeluxPlatform)
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
export { main as default }
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
// homebridge-velux/lib/VeluxAccessory.js
|
|
2
|
+
// Copyright © 2025 Erik Baauw. All rights reserved.
|
|
3
|
+
//
|
|
4
|
+
// Homebridge plugin for Velux Integra KLF 200 gateway.
|
|
5
|
+
|
|
6
|
+
import { AccessoryDelegate } from 'homebridge-lib/AccessoryDelegate'
|
|
7
|
+
|
|
8
|
+
import { VeluxService } from './VeluxService.js'
|
|
9
|
+
|
|
10
|
+
class WindowCovering extends AccessoryDelegate {
|
|
11
|
+
constructor (gateway, params = {}) {
|
|
12
|
+
super(gateway.platform, params)
|
|
13
|
+
this.gateway = gateway
|
|
14
|
+
this.client = gateway.client
|
|
15
|
+
this.log(
|
|
16
|
+
'%s [%d]: %s %s [%s] at %d%%', params.name, params.payload.nodeId,
|
|
17
|
+
params.manufacturer, params.model, params.payload.actuatorType,
|
|
18
|
+
params.payload.currentPosition
|
|
19
|
+
)
|
|
20
|
+
this.service = new VeluxService.WindowCovering(this, params)
|
|
21
|
+
this.manageLogLevel(this.service.characteristicDelegate('logLevel'))
|
|
22
|
+
|
|
23
|
+
setImmediate(() => {
|
|
24
|
+
this.emit('initialised')
|
|
25
|
+
})
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
update (payload) {
|
|
29
|
+
this.service.update(payload)
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
class VeluxAccessory {
|
|
34
|
+
static get WindowCovering () { return WindowCovering }
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
export { VeluxAccessory }
|
|
@@ -0,0 +1,189 @@
|
|
|
1
|
+
// homebridge-velux/lib/VeluxGateway.js
|
|
2
|
+
// Copyright © 2025 Erik Baauw. All rights reserved.
|
|
3
|
+
//
|
|
4
|
+
// Homebridge plugin for Velux Integra KLF 200 gateway.
|
|
5
|
+
|
|
6
|
+
import { timeout, toHexString } from 'homebridge-lib'
|
|
7
|
+
import { Delegate } from 'homebridge-lib/Delegate'
|
|
8
|
+
|
|
9
|
+
import { VeluxClient } from 'hb-velux-tools/VeluxClient'
|
|
10
|
+
|
|
11
|
+
import { VeluxAccessory } from './VeluxAccessory.js'
|
|
12
|
+
|
|
13
|
+
class VeluxGateway extends Delegate {
|
|
14
|
+
constructor (platform, params = {}) {
|
|
15
|
+
super(platform, params.name)
|
|
16
|
+
this.nodeIdList = []
|
|
17
|
+
this.accessories = {}
|
|
18
|
+
|
|
19
|
+
this.client = new VeluxClient({
|
|
20
|
+
host: params.host,
|
|
21
|
+
password: params.password,
|
|
22
|
+
timeout: platform.config.timeout
|
|
23
|
+
})
|
|
24
|
+
this.client
|
|
25
|
+
.on('connect', (host) => { this.debug('connected to %s', host) })
|
|
26
|
+
.on('disconnect', (host) => { this.debug('disconnected from %s', host) })
|
|
27
|
+
.on('error', (error) => {
|
|
28
|
+
if (error.request == null) {
|
|
29
|
+
this.warn('error: %s', error)
|
|
30
|
+
return
|
|
31
|
+
}
|
|
32
|
+
if (error.request.params == null) {
|
|
33
|
+
this.log('request %d: %s', error.request.id, error.request.cmdName)
|
|
34
|
+
} else {
|
|
35
|
+
this.log(
|
|
36
|
+
'request %d: %s %j', error.request.id, error.request.cmdName,
|
|
37
|
+
error.request.params
|
|
38
|
+
)
|
|
39
|
+
}
|
|
40
|
+
this.warn('request %d: error: %s', error.request.id, error)
|
|
41
|
+
})
|
|
42
|
+
.on('request', (request) => {
|
|
43
|
+
if (request.params == null) {
|
|
44
|
+
this.debug('request %d: %s', request.id, request.cmdName)
|
|
45
|
+
} else {
|
|
46
|
+
this.debug(
|
|
47
|
+
'request %d: %s %j', request.id, request.cmdName, request.params
|
|
48
|
+
)
|
|
49
|
+
}
|
|
50
|
+
if (request.data == null) {
|
|
51
|
+
this.vdebug(
|
|
52
|
+
'request %d: %s [%s]', request.id, request.cmdName,
|
|
53
|
+
toHexString(request.cmd, 4)
|
|
54
|
+
)
|
|
55
|
+
} else {
|
|
56
|
+
this.vdebug(
|
|
57
|
+
'request %d: %s [%s]: %s', request.id, request.cmdName,
|
|
58
|
+
toHexString(request.cmd, 4), toHexString(request.data)
|
|
59
|
+
)
|
|
60
|
+
}
|
|
61
|
+
})
|
|
62
|
+
.on('response', (response) => {
|
|
63
|
+
if (response.response == null) {
|
|
64
|
+
this.debug('request %d: ok', response.request.id)
|
|
65
|
+
} else {
|
|
66
|
+
this.debug(
|
|
67
|
+
'request %d: response: %j', response.request.id, response.response
|
|
68
|
+
)
|
|
69
|
+
}
|
|
70
|
+
})
|
|
71
|
+
.on('notification', (notification) => {
|
|
72
|
+
const req = notification.request != null
|
|
73
|
+
? 'request ' + notification.request.id + ': '
|
|
74
|
+
: ''
|
|
75
|
+
if (notification.data == null) {
|
|
76
|
+
this.vdebug(
|
|
77
|
+
'%s%s [%s]', req, notification.cmdName,
|
|
78
|
+
toHexString(notification.cmd, 4)
|
|
79
|
+
)
|
|
80
|
+
} else {
|
|
81
|
+
this.vdebug(
|
|
82
|
+
'%s%s [%s]: %s', req, notification.cmdName,
|
|
83
|
+
toHexString(notification.cmd, 4), toHexString(notification.data)
|
|
84
|
+
)
|
|
85
|
+
}
|
|
86
|
+
if (notification.payload == null) {
|
|
87
|
+
this.debug('%s%s', req, notification.cmdName)
|
|
88
|
+
} else {
|
|
89
|
+
this.debug('%s%s: %j', req, notification.cmdName, notification.payload)
|
|
90
|
+
}
|
|
91
|
+
this.accessories?.[notification?.payload?.nodeId]?.update(notification?.payload)
|
|
92
|
+
})
|
|
93
|
+
.on('send', (data) => {
|
|
94
|
+
this.vvdebug('send %s', toHexString(data))
|
|
95
|
+
})
|
|
96
|
+
.on('data', (data) => {
|
|
97
|
+
this.vvdebug('received %s', toHexString(data))
|
|
98
|
+
})
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
async init () {
|
|
102
|
+
try {
|
|
103
|
+
this.log('connecting...')
|
|
104
|
+
await this.client.connect()
|
|
105
|
+
const { softwareVersion } = await this.client.request(VeluxClient.commands.GW_GET_VERSION_REQ)
|
|
106
|
+
const { api } = await this.client.request(VeluxClient.commands.GW_GET_PROTOCOL_VERSION_REQ)
|
|
107
|
+
const nodes = {}
|
|
108
|
+
let nodeList = await this.client.request(VeluxClient.commands.GW_CS_GET_SYSTEMTABLE_DATA_REQ)
|
|
109
|
+
for (const node of nodeList) {
|
|
110
|
+
nodes[node.nodeId] = node
|
|
111
|
+
}
|
|
112
|
+
nodeList = await this.client.request(VeluxClient.commands.GW_GET_ALL_NODES_INFORMATION_REQ)
|
|
113
|
+
for (const node of nodeList) {
|
|
114
|
+
Object.assign(nodes[node.nodeId], node)
|
|
115
|
+
}
|
|
116
|
+
this.log('KLF 200 v%s, api v%s: %d nodes', softwareVersion, api, Object.keys(nodes).length)
|
|
117
|
+
for (const id in nodes) {
|
|
118
|
+
this.nodeIdList.push(id)
|
|
119
|
+
const node = nodes[id]
|
|
120
|
+
const params = {
|
|
121
|
+
name: node.name,
|
|
122
|
+
id: node.serialNumber,
|
|
123
|
+
manufacturer: node.manufacturer,
|
|
124
|
+
model: node.model,
|
|
125
|
+
firmware: '' + node.buildNumber,
|
|
126
|
+
payload: node
|
|
127
|
+
}
|
|
128
|
+
switch (node.actuatorType) {
|
|
129
|
+
case 0x0280:
|
|
130
|
+
this.accessories[id] = new VeluxAccessory.WindowCovering(this, params)
|
|
131
|
+
break
|
|
132
|
+
default:
|
|
133
|
+
this.warn(
|
|
134
|
+
'%s [%s]: ignoring unsupported node type %d', node.name, node.serialNumber,
|
|
135
|
+
node.actuatorType
|
|
136
|
+
)
|
|
137
|
+
continue
|
|
138
|
+
}
|
|
139
|
+
}
|
|
140
|
+
this.updateLogLevel()
|
|
141
|
+
this.initialised = true
|
|
142
|
+
this.debug('initialised')
|
|
143
|
+
this.emit('initialised')
|
|
144
|
+
} catch (error) {
|
|
145
|
+
if (!(error instanceof VeluxClient.Error)) {
|
|
146
|
+
this.warn(error)
|
|
147
|
+
}
|
|
148
|
+
await this.client.disconnect()
|
|
149
|
+
await timeout(600 * 1000)
|
|
150
|
+
return this.init()
|
|
151
|
+
}
|
|
152
|
+
}
|
|
153
|
+
|
|
154
|
+
get logLevel () { return this._logLevel }
|
|
155
|
+
|
|
156
|
+
updateLogLevel () {
|
|
157
|
+
let logLevel = 0
|
|
158
|
+
for (const id in this.accessories) {
|
|
159
|
+
logLevel = Math.max(logLevel, this.accessories[id].logLevel)
|
|
160
|
+
}
|
|
161
|
+
this._logLevel = logLevel
|
|
162
|
+
}
|
|
163
|
+
|
|
164
|
+
async heartbeat (beat) {
|
|
165
|
+
if (!this.initialised) {
|
|
166
|
+
return
|
|
167
|
+
}
|
|
168
|
+
if (!this.client.connected) {
|
|
169
|
+
if (beat % 60 !== 0) {
|
|
170
|
+
return
|
|
171
|
+
}
|
|
172
|
+
await this.client.connect()
|
|
173
|
+
}
|
|
174
|
+
if (beat % 600 === 0) {
|
|
175
|
+
await this.client.request(VeluxClient.commands.GW_HOUSE_STATUS_MONITOR_ENABLE_REQ)
|
|
176
|
+
}
|
|
177
|
+
if (beat % 10 === 0 && this.nodeIdList.length > 0) {
|
|
178
|
+
await this.client.request(VeluxClient.commands.GW_STATUS_REQUEST_REQ, {
|
|
179
|
+
nodeIds: this.nodeIdList
|
|
180
|
+
})
|
|
181
|
+
}
|
|
182
|
+
}
|
|
183
|
+
|
|
184
|
+
async shutdown () {
|
|
185
|
+
return this.client.disconnect()
|
|
186
|
+
}
|
|
187
|
+
}
|
|
188
|
+
|
|
189
|
+
export { VeluxGateway }
|
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
// homebridge-velux/lib/VeluxPlatform.js
|
|
2
|
+
// Copyright © 2025 Erik Baauw. All rights reserved.
|
|
3
|
+
//
|
|
4
|
+
// Homebridge plugin for Velux Integra KLF 200 gateway.
|
|
5
|
+
|
|
6
|
+
// import { once } from 'node:events'
|
|
7
|
+
|
|
8
|
+
import { OptionParser } from 'homebridge-lib/OptionParser'
|
|
9
|
+
import { Platform } from 'homebridge-lib/Platform'
|
|
10
|
+
|
|
11
|
+
import { VeluxGateway } from './VeluxGateway.js'
|
|
12
|
+
|
|
13
|
+
class VeluxPlatform extends Platform {
|
|
14
|
+
constructor (log, configJson, homebridge) {
|
|
15
|
+
super(log, configJson, homebridge)
|
|
16
|
+
this.parseConfigJson(configJson)
|
|
17
|
+
|
|
18
|
+
this.gateways = {}
|
|
19
|
+
|
|
20
|
+
this
|
|
21
|
+
.once('heartbeat', this.init)
|
|
22
|
+
.on('heartbeat', this.heartbeat)
|
|
23
|
+
.on('shutdown', this.shutdown)
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
parseConfigJson (configJson) {
|
|
27
|
+
this.config = {
|
|
28
|
+
name: 'Velux',
|
|
29
|
+
timeout: 15,
|
|
30
|
+
hosts: []
|
|
31
|
+
}
|
|
32
|
+
const optionParser = new OptionParser(this.config, true)
|
|
33
|
+
optionParser
|
|
34
|
+
.stringKey('name')
|
|
35
|
+
.stringKey('platform')
|
|
36
|
+
.arrayKey('hosts')
|
|
37
|
+
.intKey('timeout', 1, 60)
|
|
38
|
+
.on('userInputError', (message) => {
|
|
39
|
+
this.warn('config.json: %s', message)
|
|
40
|
+
})
|
|
41
|
+
try {
|
|
42
|
+
optionParser.parse(configJson)
|
|
43
|
+
const validHosts = []
|
|
44
|
+
for (const i in this.config.hosts) {
|
|
45
|
+
const host = this.config.hosts[i]
|
|
46
|
+
const config = {
|
|
47
|
+
port: 51200
|
|
48
|
+
}
|
|
49
|
+
const optionParser = new OptionParser(config, true)
|
|
50
|
+
optionParser
|
|
51
|
+
.hostKey()
|
|
52
|
+
.stringKey('name')
|
|
53
|
+
.stringKey('password')
|
|
54
|
+
.on('userInputError', (error) => {
|
|
55
|
+
this.warn('config.json: hosts[%d]: %s', i, error)
|
|
56
|
+
})
|
|
57
|
+
try {
|
|
58
|
+
optionParser.parse(host)
|
|
59
|
+
if (config.hostname == null || config.password == null) {
|
|
60
|
+
continue
|
|
61
|
+
}
|
|
62
|
+
validHosts.push({
|
|
63
|
+
host: config.hostname + ':' + config.port,
|
|
64
|
+
name: config.name ?? config.hostname,
|
|
65
|
+
password: config.password
|
|
66
|
+
})
|
|
67
|
+
} catch (error) {
|
|
68
|
+
this.error(error)
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
this.config.hosts = validHosts
|
|
72
|
+
this.debug('config: %j', this.config)
|
|
73
|
+
} catch (error) {
|
|
74
|
+
this.error(error)
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
async init (beat) {
|
|
79
|
+
const jobs = []
|
|
80
|
+
|
|
81
|
+
for (const host of this.config.hosts) {
|
|
82
|
+
try {
|
|
83
|
+
const gateway = new VeluxGateway(this, host)
|
|
84
|
+
jobs.push(gateway.init())
|
|
85
|
+
this.gateways[host] = gateway
|
|
86
|
+
} catch (error) {
|
|
87
|
+
this.error(error)
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
for (const job of jobs) {
|
|
91
|
+
await job
|
|
92
|
+
}
|
|
93
|
+
this.debug('initialised')
|
|
94
|
+
this.emit('initialised')
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
async heartbeat (beat) {
|
|
98
|
+
try {
|
|
99
|
+
for (const id in this.gateways) {
|
|
100
|
+
this.gateways[id].heartbeat(beat)
|
|
101
|
+
}
|
|
102
|
+
} catch (error) { this.warn('heartbeat error %s', error) }
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
async shutdown () {
|
|
106
|
+
for (const id in this.gateways) {
|
|
107
|
+
await this.gateways[id].shutdown()
|
|
108
|
+
}
|
|
109
|
+
}
|
|
110
|
+
}
|
|
111
|
+
|
|
112
|
+
export { VeluxPlatform }
|
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
// homebridge-deconz/lib/VeluxService.js
|
|
2
|
+
// Copyright © 2025 Erik Baauw. All rights reserved.
|
|
3
|
+
//
|
|
4
|
+
// Homebridge plugin for Velux Integra KLF 200 gateway.
|
|
5
|
+
|
|
6
|
+
import { timeout } from 'hb-lib-tools'
|
|
7
|
+
|
|
8
|
+
import { ServiceDelegate } from 'homebridge-lib/ServiceDelegate'
|
|
9
|
+
|
|
10
|
+
import { VeluxClient } from 'hb-velux-tools/VeluxClient'
|
|
11
|
+
|
|
12
|
+
class WindowCovering extends ServiceDelegate {
|
|
13
|
+
constructor (accessory, params) {
|
|
14
|
+
params.Service = accessory.Services.hap.WindowCovering
|
|
15
|
+
super(accessory, params)
|
|
16
|
+
this.client = accessory.client
|
|
17
|
+
|
|
18
|
+
this.addCharacteristicDelegate({
|
|
19
|
+
key: 'currentPosition',
|
|
20
|
+
Characteristic: this.Characteristics.hap.CurrentPosition,
|
|
21
|
+
unit: '%'
|
|
22
|
+
})
|
|
23
|
+
|
|
24
|
+
this.addCharacteristicDelegate({
|
|
25
|
+
key: 'targetPosition',
|
|
26
|
+
Characteristic: this.Characteristics.hap.TargetPosition,
|
|
27
|
+
unit: '%'
|
|
28
|
+
}).on('didSet', async (value, fromHomeKit) => {
|
|
29
|
+
if (!fromHomeKit) {
|
|
30
|
+
return
|
|
31
|
+
}
|
|
32
|
+
const position = 100 - value
|
|
33
|
+
try {
|
|
34
|
+
await this.client.request(VeluxClient.commands.GW_COMMAND_SEND_REQ, {
|
|
35
|
+
position,
|
|
36
|
+
nodeIds: [params.payload.nodeId]
|
|
37
|
+
})
|
|
38
|
+
} catch (error) { this.warn(error) }
|
|
39
|
+
})
|
|
40
|
+
|
|
41
|
+
this.addCharacteristicDelegate({
|
|
42
|
+
key: 'positionState',
|
|
43
|
+
Characteristic: this.Characteristics.hap.PositionState
|
|
44
|
+
})
|
|
45
|
+
|
|
46
|
+
this.addCharacteristicDelegate({
|
|
47
|
+
key: 'holdPosition',
|
|
48
|
+
Characteristic: this.Characteristics.hap.HoldPosition
|
|
49
|
+
}).on('didSet', async () => {
|
|
50
|
+
try {
|
|
51
|
+
await this.client.request(VeluxClient.commands.GW_COMMAND_SEND_REQ, {
|
|
52
|
+
position: 'current',
|
|
53
|
+
nodeIds: [params.payload.nodeId]
|
|
54
|
+
})
|
|
55
|
+
} catch (error) { this.warn(error) }
|
|
56
|
+
this.log('stop')
|
|
57
|
+
})
|
|
58
|
+
|
|
59
|
+
this.addCharacteristicDelegate({
|
|
60
|
+
key: 'motorSpeed',
|
|
61
|
+
Characteristic: this.Characteristics.my.MotorSpeed,
|
|
62
|
+
unit: '',
|
|
63
|
+
props: {
|
|
64
|
+
unit: '',
|
|
65
|
+
minValue: 0,
|
|
66
|
+
maxValue: 2,
|
|
67
|
+
minStep: 1
|
|
68
|
+
}
|
|
69
|
+
}).on('didSet', async (value, fromHomeKit) => {
|
|
70
|
+
if (!fromHomeKit) {
|
|
71
|
+
return
|
|
72
|
+
}
|
|
73
|
+
const speed = ['default', 'slow', 'fast'](value)
|
|
74
|
+
this.log('set speed to %s', speed)
|
|
75
|
+
})
|
|
76
|
+
|
|
77
|
+
this.addCharacteristicDelegate({
|
|
78
|
+
key: 'positionChange',
|
|
79
|
+
Characteristic: this.Characteristics.my.PositionChange
|
|
80
|
+
}).on('didSet', async (value) => {
|
|
81
|
+
if (value !== 0) {
|
|
82
|
+
this.log('change position by %s', value)
|
|
83
|
+
await timeout(this.platform.config.waitTimeReset)
|
|
84
|
+
this.values.positionChange = 0
|
|
85
|
+
}
|
|
86
|
+
})
|
|
87
|
+
this.values.positionChange = 0
|
|
88
|
+
|
|
89
|
+
this.addCharacteristicDelegate({
|
|
90
|
+
key: 'logLevel',
|
|
91
|
+
Characteristic: this.Characteristics.my.LogLevel,
|
|
92
|
+
value: accessory.logLevel
|
|
93
|
+
}).on('didSet', (value, fromHomeKit) => {
|
|
94
|
+
if (fromHomeKit) {
|
|
95
|
+
accessory.gateway.updateLogLevel()
|
|
96
|
+
}
|
|
97
|
+
})
|
|
98
|
+
|
|
99
|
+
this.update(params.payload)
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
update (payload) {
|
|
103
|
+
this.debug('event: %j', payload)
|
|
104
|
+
if (!isNaN(parseInt(payload.currentPosition))) {
|
|
105
|
+
this.values.currentPosition = 100 - payload.currentPosition
|
|
106
|
+
}
|
|
107
|
+
if (!isNaN(parseInt(payload.targetPosition))) {
|
|
108
|
+
this.values.targetPosition = 100 - payload.targetPosition
|
|
109
|
+
}
|
|
110
|
+
if (payload.state != null) {
|
|
111
|
+
this.values.positionState = payload.state !== 4
|
|
112
|
+
? this.Characteristics.hap.PositionState.STOPPED
|
|
113
|
+
: this.values.positionState = this.values.targetPosition > this.values.currentPosition
|
|
114
|
+
? this.Characteristics.hap.PositionState.INCREASING
|
|
115
|
+
: this.Characteristics.hap.PositionState.DECREASING
|
|
116
|
+
}
|
|
117
|
+
if (payload.velocity != null) {
|
|
118
|
+
this.values.motorSpeed = { slow: 0, default: 1, fast: 2 }[payload.velocity]
|
|
119
|
+
}
|
|
120
|
+
}
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
class VeluxService {
|
|
124
|
+
static get WindowCovering () { return WindowCovering }
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
export { VeluxService }
|
package/package.json
ADDED
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "homebridge-velux",
|
|
3
|
+
"description": "Homebridge plugin for Velux Integra KLF 200 gateway",
|
|
4
|
+
"displayName": "Homebridge Velux",
|
|
5
|
+
"author": "Erik Baauw",
|
|
6
|
+
"maintainers": [
|
|
7
|
+
"ebaauw"
|
|
8
|
+
],
|
|
9
|
+
"license": "Apache-2.0",
|
|
10
|
+
"version": "0.0.0",
|
|
11
|
+
"keywords": [
|
|
12
|
+
"homebridge-plugin",
|
|
13
|
+
"homekit",
|
|
14
|
+
"velux",
|
|
15
|
+
"integra",
|
|
16
|
+
"klf200",
|
|
17
|
+
"klf"
|
|
18
|
+
],
|
|
19
|
+
"type": "module",
|
|
20
|
+
"main": "index.js",
|
|
21
|
+
"bin": {
|
|
22
|
+
"velux": "cli/velux.js"
|
|
23
|
+
},
|
|
24
|
+
"engines": {
|
|
25
|
+
"homebridge": "^1.8.5||^2.0.0-beta",
|
|
26
|
+
"node": "^22||^20||^18",
|
|
27
|
+
"klf200": "3.14"
|
|
28
|
+
},
|
|
29
|
+
"dependencies": {
|
|
30
|
+
"hb-velux-tools": "~0.0.2",
|
|
31
|
+
"homebridge-lib": "~7.1.2"
|
|
32
|
+
},
|
|
33
|
+
"scripts": {
|
|
34
|
+
"prepare": "standard",
|
|
35
|
+
"test": "standard && echo \"Error: no test specified\" && exit 1"
|
|
36
|
+
},
|
|
37
|
+
"repository": {
|
|
38
|
+
"type": "git",
|
|
39
|
+
"url": "git+https://github.com/ebaauw/homebridge-velux.git"
|
|
40
|
+
},
|
|
41
|
+
"bugs": {
|
|
42
|
+
"url": "https://github.com/ebaauw/homebridge-velux/issues"
|
|
43
|
+
},
|
|
44
|
+
"homepage": "https://github.com/ebaauw/homebridge-velux#readme",
|
|
45
|
+
"funding": [
|
|
46
|
+
{
|
|
47
|
+
"type": "github",
|
|
48
|
+
"url": "https://github.com/sponsors/ebaauw"
|
|
49
|
+
},
|
|
50
|
+
{
|
|
51
|
+
"type": "paypal",
|
|
52
|
+
"url": "https://www.paypal.me/ebaauw/EUR"
|
|
53
|
+
}
|
|
54
|
+
]
|
|
55
|
+
}
|
package/velux.png
ADDED
|
Binary file
|