-
Notifications
You must be signed in to change notification settings - Fork 1
/
Configuration.js
285 lines (269 loc) · 8.44 KB
/
Configuration.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
/*
* Homey Managment
* Configuration
*
* JUST FOR REFERENCE!
* Basic knowledge still needed.
*/
/*
* ======================================================= BASIC CODE =======================================================
* ================================= APP.JSON =================================
*/
{
"id": "APP_ID",
...
"drivers": [
{
"id": "DRIVER_ID",
...
"settings": [
]
}
]
}
// ================================= DRIVER.JS =================================
module.exports = new ZwaveDriver(path.basename(__dirname), {
capabilities: {
...
},
settings: {
YOUR_SETTINGS_HERE
}
});
/*
* ======================================================= TEXT =======================================================
* ================================= APP.JSON =================================
*/
{
"id": "SETTING_ID",
"type": "text",
"label": {
"en": "SHORT_DESCRIPTION"
},
"value": "DEFAULT_VALUE",
"pattern": "REGEX_PATTERN, optional",
"hint": {
"en": "DESCRIPTION, optional"
}
},
// ================================= DRIVER.JS ================================
SETTING_ID: {
index: PARAMETER_NUMBER,
size: PARAMETER_SIZE,
parser: (newValue, newSettings, deviceData) => {
// Your magic to make the value into an Buffer value
return new Buffer([]), // for 1 size parameters only
// for 1, 2 or 4 size parameters use this:
let bufferValue = new Buffer(PARAMETER_SIZE),
bufferValue.writeUIntBE(newValue, 0, PARAMETER_SIZE);
return bufferValue;
}
signed: false, // signed: false is only needed if the value range of the parameter = 0 to max (also unsigned), instead of the default signed
},
/*
* ======================================================= DROPDOWN =======================================================
* ================================= APP.JSON =================================
*/
{
"id": "SETTING_ID",
"type": "dropdown",
"label": {
"en": "SHORT_DESCRIPTION"
},
"hint": {
"en": "DESCRIPTION, optional"
},
"value": "DEFAULT_VALUE",
"values": [
{
"id": "VALUE_1",
"label": {
"en": "VALUE_1_DESCRIPTION"
}
},
{
"id": "VALUE_2",
"label": {
"en": "VALUE_2_DESCRIPTION"
}
}
]
}
// ================================= DRIVER.JS =================================
SETTING_ID: {
index: PARAMETER_NUMBER,
size: PARAMETER_SIZE,
signed: false, // signed: false is only needed if the value range of the parameter = 0 to max (also unsigned), instead of the default signed
},
/*
* ======================================================= RADIO =======================================================
* ================================= APP.JSON =================================
*/
{
"id": "SETTING_ID",
"type": "radio",
"label": {
"en": "SHORT_DESCRIPTION"
},
"hint": {
"en": "DESCRIPTION, optional"
},
"value": "DEFAULT_VALUE",
"values": [
{
"id": "VALUE_1",
"label": {
"en": "VALUE_1_DESCRIPTION"
}
},
{
"id": "VALUE_2",
"label": {
"en": "VALUE_2_DESCRIPTION"
}
}
]
}
// ================================= DRIVER.JS =================================
SETTING_ID: {
index: PARAMETER_NUMBER,
size: PARAMETER_SIZE,
signed: false, // signed: false is only needed if the value range of the parameter = 0 to max (also unsigned), instead of the default signed
},
/*
* ======================================================= CHECKBOX =======================================================
* ================================= APP.JSON =================================
*/
{
"id": "SETTING_ID",
"type": "checkbox",
"label": {
"en": "SHORT_DESCRIPTION"
},
"hint": {
"en": "DESCRIPTION, optional"
},
"value": DEFAULT_VALUE // true or false
}
// ================================= DRIVER.JS =================================
SETTING_ID: {
index: PARAMETER_NUMBER,
size: PARAMETER_SIZE,
parser: (newValue, newSettings, deviceData) => new Buffer([(newValue) ? 0, 1]), // Parser is only needed if default value true = unchecked
},
/*
* ======================================================= NUMBER =======================================================
* ================================= APP.JSON =================================
*/
{
"id": "SETTING_ID",
"type": "number",
"label": {
"en": "SHORT_DESCRIPTION"
},
"hint": {
"en": "DESCRIPTION, optional"
},
"value": DEFAULT_VALUE,
"attr": {
"min": MINIMAL_NUMBER, // recommended but optional
"max": MAXIMUM_NUMBER, // recommended but optional
"step": STEP_SIZE // optional
}
}
// ================================= DRIVER.JS ================================
SETTING_ID: {
index: PARAMETER_NUMBER,
size: PARAMETER_SIZE,
parser: newValue => new Buffer([newValue * MULTIPLIER]), // Parser is only needed if you need a multiplier to increase user friendlyness
signed: false, // signed: false is only needed if the value range of the parameter = 0 to max (also unsigned), instead of the default signed
},
/*
* ============================================ MULTIPLE SETTINGS, 1 PARAMETER ============================================
* Sometimes to increase user friendlyness you want to devide a parameter into several settings.
* This is a reference how you could handle that in the DRIVER.JS
*/
SETTING_ID_1: {
index: PARAMETER_NUMBER,
size: PARAMETER_SIZE,
parser: (newValue, newSettings, deviceData) => {
value = newValue + newSettings.SETTING_ID_2;
let buffer = new Buffer(PARAMETER_SIZE);
buffer.writeUIntBE(value, 0, PARAMETER_SIZE);
return buffer;
},
},
SETTING_ID_2: {
index: PARAMETER_NUMBER,
size: PARAMETER_SIZE,
parser: (newValue, newSettings, deviceData) => {
value = newSettings.SETTING_ID_1 + newValue;
let buffer = new Buffer(PARAMETER_SIZE);
buffer.writeUIntBE(value, 0, PARAMETER_SIZE);
return buffer;
},
},
/*
* ============================================ SETTING A PARAMETER WITH FLOW CARD ============================================
* This is not recommended to do for battery devices
* since parameters are only set when they are woken up
*/
Homey.manager('flow').on('action.FLOW_ID', (callback, args) => {
const node = module.exports.nodes[args.device['token']];
// Let the flow card fail when no device is found
if (!node) return callback('device_unavailable', false);
if (args.hasOwnProperty("FLOW_VALUE_TO_BE_USE") && typeof node.instance.CommandClass.COMMAND_CLASS_CONFIGURATION !== 'undefined') {
//Send parameter values to module
node.instance.CommandClass.COMMAND_CLASS_CONFIGURATION.CONFIGURATION_SET({
'Parameter Number': PARAMETER_NUMBER,
Level: {
Size: PARAMETER_SIZE,
Default: false
},
'Configuration Value': new Buffer([PARAMETER_VALUE]) // PARAMETER VALUE must be a DECIMAL or HEXADECIMAL value
}, (err, result) => {
// If error, stop flow card
if (err) return callback(err, false);
// If properly transmitted, change the setting and finish flow card
if (result === 'TRANSMIT_COMPLETE_OK') {
// If this parameter is not a setting(s) remove the setSetting function or use:
// `if (result === "TRANSMIT_COMPLETE_OK") return callback(null, true);`
// Set the device setting to this flow value
module.exports.setSettings(node.device_data, {
'SETTING_ID': SETTING_VALUE, // make sure the value type is the same as the setting type (IE: boolean)
});
return callback(null, true);
}
// if not completed with acknowledgment, let flow card fail
return callback(result, false);
});
}
return callback('unknown_error', false);
});
/*
* ============================================ GETTING A PARAMETER (RAW) ============================================
* To get a certain parameter's information we can use the
* "Send raw data" in the z-wave settings.
*
* NODE_ID = the node id you want the information from (Decimal or Hexadecimal)
* 0x70 = COMMAND_CLASS_CONFIGURATION
* 0x05 = CONFIGURATION_GET
* PARAMETER_NR = Parameter number you want to get (Decimal or Hexadecimal)
* only the numbers that are really present will work,
* the rest will be ignored by the device
*
* If it is a battery device, it does need to be awake.
* And not all devices will respond to the GET.
*
* Report back will be in Hexadecimal:
* COMMAND_CLASS_CONFIGURATION, data: 0x06#1#2#3#4#5#6
* 06 = CONFIGURATION_REPORT
* #1 = Parameter Number
* #2 = Parameter Size
* #3 - #6 Parameter Value (depending on size)
*
* IE size 1: 0x06050103 = parameter: 5, size: 1, value 3
* IE size 2: 0x06120201FF = parameter: 18, size: 2, value 511
* IE size 4: 0x066F0400007FFF = parameter: 111, size: 4, value 32767
*/
NODE_ID,0x70,0x05,PARAMETER_NR