2 * Copyright (c) 2010-2024 Contributors to the openHAB project
4 * See the NOTICE file(s) distributed with this work for additional
7 * This program and the accompanying materials are made available under the
8 * terms of the Eclipse Public License 2.0 which is available at
9 * http://www.eclipse.org/legal/epl-2.0
11 * SPDX-License-Identifier: EPL-2.0
13 package org.openhab.binding.velbus.internal;
17 import org.eclipse.jdt.annotation.NonNullByDefault;
18 import org.openhab.core.thing.ThingTypeUID;
21 * The {@link VelbusBindingConstants} class defines common constants, which are
22 * used across the whole binding.
24 * @author Cedric Boon - Initial contribution
27 public class VelbusBindingConstants {
29 public static final String BINDING_ID = "velbus";
32 public static final ThingTypeUID BRIDGE_THING_TYPE = new ThingTypeUID(BINDING_ID, "bridge");
33 public static final ThingTypeUID NETWORK_BRIDGE_THING_TYPE = new ThingTypeUID(BINDING_ID, "networkbridge");
35 // generic thing types
36 public static final ThingTypeUID THING_TYPE_VMB1BL = new ThingTypeUID(BINDING_ID, "vmb1bl");
37 public static final ThingTypeUID THING_TYPE_VMB1BLS = new ThingTypeUID(BINDING_ID, "vmb1bls");
38 public static final ThingTypeUID THING_TYPE_VMB1DM = new ThingTypeUID(BINDING_ID, "vmb1dm");
39 public static final ThingTypeUID THING_TYPE_VMB1LED = new ThingTypeUID(BINDING_ID, "vmb1led");
40 public static final ThingTypeUID THING_TYPE_VMB1RY = new ThingTypeUID(BINDING_ID, "vmb1ry");
41 public static final ThingTypeUID THING_TYPE_VMB1RYNO = new ThingTypeUID(BINDING_ID, "vmb1ryno");
42 public static final ThingTypeUID THING_TYPE_VMB1RYNOS = new ThingTypeUID(BINDING_ID, "vmb1rynos");
43 public static final ThingTypeUID THING_TYPE_VMB1RYS = new ThingTypeUID(BINDING_ID, "vmb1rys");
44 public static final ThingTypeUID THING_TYPE_VMB1TS = new ThingTypeUID(BINDING_ID, "vmb1ts");
45 public static final ThingTypeUID THING_TYPE_VMB2BL = new ThingTypeUID(BINDING_ID, "vmb2bl");
46 public static final ThingTypeUID THING_TYPE_VMB2BLE = new ThingTypeUID(BINDING_ID, "vmb2ble");
47 public static final ThingTypeUID THING_TYPE_VMB2PBN = new ThingTypeUID(BINDING_ID, "vmb2pbn");
48 public static final ThingTypeUID THING_TYPE_VMB4AN = new ThingTypeUID(BINDING_ID, "vmb4an");
49 public static final ThingTypeUID THING_TYPE_VMB4DC = new ThingTypeUID(BINDING_ID, "vmb4dc");
50 public static final ThingTypeUID THING_TYPE_VMB4RY = new ThingTypeUID(BINDING_ID, "vmb4ry");
51 public static final ThingTypeUID THING_TYPE_VMB4RYLD = new ThingTypeUID(BINDING_ID, "vmb4ryld");
52 public static final ThingTypeUID THING_TYPE_VMB4RYNO = new ThingTypeUID(BINDING_ID, "vmb4ryno");
53 public static final ThingTypeUID THING_TYPE_VMB6IN = new ThingTypeUID(BINDING_ID, "vmb6in");
54 public static final ThingTypeUID THING_TYPE_VMB6PBN = new ThingTypeUID(BINDING_ID, "vmb6pbn");
55 public static final ThingTypeUID THING_TYPE_VMB7IN = new ThingTypeUID(BINDING_ID, "vmb7in");
56 public static final ThingTypeUID THING_TYPE_VMB8IR = new ThingTypeUID(BINDING_ID, "vmb8ir");
57 public static final ThingTypeUID THING_TYPE_VMB8PB = new ThingTypeUID(BINDING_ID, "vmb8pb");
58 public static final ThingTypeUID THING_TYPE_VMB8PBU = new ThingTypeUID(BINDING_ID, "vmb8pbu");
59 public static final ThingTypeUID THING_TYPE_VMBDME = new ThingTypeUID(BINDING_ID, "vmbdme");
60 public static final ThingTypeUID THING_TYPE_VMBDMI = new ThingTypeUID(BINDING_ID, "vmbdmi");
61 public static final ThingTypeUID THING_TYPE_VMBDMIR = new ThingTypeUID(BINDING_ID, "vmbdmir");
62 public static final ThingTypeUID THING_TYPE_VMBEL1 = new ThingTypeUID(BINDING_ID, "vmbel1");
63 public static final ThingTypeUID THING_TYPE_VMBEL2 = new ThingTypeUID(BINDING_ID, "vmbel2");
64 public static final ThingTypeUID THING_TYPE_VMBEL4 = new ThingTypeUID(BINDING_ID, "vmbel4");
65 public static final ThingTypeUID THING_TYPE_VMBELO = new ThingTypeUID(BINDING_ID, "vmbelo");
66 public static final ThingTypeUID THING_TYPE_VMBELPIR = new ThingTypeUID(BINDING_ID, "vmbelpir");
67 public static final ThingTypeUID THING_TYPE_VMBGP1 = new ThingTypeUID(BINDING_ID, "vmbgp1");
68 public static final ThingTypeUID THING_TYPE_VMBGP1_2 = new ThingTypeUID(BINDING_ID, "vmbgp1-2");
69 public static final ThingTypeUID THING_TYPE_VMBGP2 = new ThingTypeUID(BINDING_ID, "vmbgp2");
70 public static final ThingTypeUID THING_TYPE_VMBGP2_2 = new ThingTypeUID(BINDING_ID, "vmbgp2-2");
71 public static final ThingTypeUID THING_TYPE_VMBGP4 = new ThingTypeUID(BINDING_ID, "vmbgp4");
72 public static final ThingTypeUID THING_TYPE_VMBGP4_2 = new ThingTypeUID(BINDING_ID, "vmbgp4-2");
73 public static final ThingTypeUID THING_TYPE_VMBGP4PIR = new ThingTypeUID(BINDING_ID, "vmbgp4pir");
74 public static final ThingTypeUID THING_TYPE_VMBGP4PIR_2 = new ThingTypeUID(BINDING_ID, "vmbgp4pir-2");
75 public static final ThingTypeUID THING_TYPE_VMBGPO = new ThingTypeUID(BINDING_ID, "vmbgpo");
76 public static final ThingTypeUID THING_TYPE_VMBGPOD = new ThingTypeUID(BINDING_ID, "vmbgpod");
77 public static final ThingTypeUID THING_TYPE_VMBGPOD_2 = new ThingTypeUID(BINDING_ID, "vmbgpod-2");
78 public static final ThingTypeUID THING_TYPE_VMBMETEO = new ThingTypeUID(BINDING_ID, "vmbmeteo");
79 public static final ThingTypeUID THING_TYPE_VMBPIRC = new ThingTypeUID(BINDING_ID, "vmbpirc");
80 public static final ThingTypeUID THING_TYPE_VMBPIRM = new ThingTypeUID(BINDING_ID, "vmbpirm");
81 public static final ThingTypeUID THING_TYPE_VMBPIRO = new ThingTypeUID(BINDING_ID, "vmbpiro");
82 public static final ThingTypeUID THING_TYPE_VMBRFR8S = new ThingTypeUID(BINDING_ID, "vmbrfr8s");
83 public static final ThingTypeUID THING_TYPE_VMBVP1 = new ThingTypeUID(BINDING_ID, "vmbvp1");
84 public static final ThingTypeUID THING_TYPE_VMBKP = new ThingTypeUID(BINDING_ID, "vmbkp");
85 public static final ThingTypeUID THING_TYPE_VMBIN = new ThingTypeUID(BINDING_ID, "vmbin");
86 public static final ThingTypeUID THING_TYPE_VMB4PB = new ThingTypeUID(BINDING_ID, "vmb4pb");
89 public static final Set<ThingTypeUID> BRIDGE_THING_TYPES_UIDS = Set.of(BRIDGE_THING_TYPE,
90 NETWORK_BRIDGE_THING_TYPE);
91 public static final Set<ThingTypeUID> SUPPORTED_THING_TYPES_UIDS = Set.of(THING_TYPE_VMB1BL, THING_TYPE_VMB1BLS,
92 THING_TYPE_VMB1DM, THING_TYPE_VMB1LED, THING_TYPE_VMB1RY, THING_TYPE_VMB1RYNO, THING_TYPE_VMB1RYNOS,
93 THING_TYPE_VMB1RYS, THING_TYPE_VMB1TS, THING_TYPE_VMB2BL, THING_TYPE_VMB2BLE, THING_TYPE_VMB2PBN,
94 THING_TYPE_VMB4AN, THING_TYPE_VMB4DC, THING_TYPE_VMB4RY, THING_TYPE_VMB4RYLD, THING_TYPE_VMB4RYNO,
95 THING_TYPE_VMB6IN, THING_TYPE_VMB6PBN, THING_TYPE_VMB7IN, THING_TYPE_VMB8IR, THING_TYPE_VMB8PB,
96 THING_TYPE_VMB8PBU, THING_TYPE_VMBDME, THING_TYPE_VMBDMI, THING_TYPE_VMBDMIR, THING_TYPE_VMBEL1,
97 THING_TYPE_VMBEL2, THING_TYPE_VMBEL4, THING_TYPE_VMBELO, THING_TYPE_VMBELPIR, THING_TYPE_VMBGP1,
98 THING_TYPE_VMBGP1_2, THING_TYPE_VMBGP2, THING_TYPE_VMBGP2_2, THING_TYPE_VMBGP4, THING_TYPE_VMBGP4_2,
99 THING_TYPE_VMBGP4PIR, THING_TYPE_VMBGP4PIR_2, THING_TYPE_VMBGPO, THING_TYPE_VMBGPOD, THING_TYPE_VMBGPOD_2,
100 THING_TYPE_VMBMETEO, THING_TYPE_VMBPIRC, THING_TYPE_VMBPIRM, THING_TYPE_VMBPIRO, THING_TYPE_VMBRFR8S,
101 THING_TYPE_VMBVP1, THING_TYPE_VMBKP, THING_TYPE_VMBIN, THING_TYPE_VMB4PB);
103 // Velbus module types
104 public static final byte MODULE_TYPE_VMB8PB = 0x01;
105 public static final byte MODULE_TYPE_VMB1RY = 0x02;
106 public static final byte MODULE_TYPE_VMB1BL = 0x03;
107 public static final byte MODULE_TYPE_VMB6IN = 0x05;
108 public static final byte MODULE_TYPE_VMB1DM = 0x07;
109 public static final byte MODULE_TYPE_VMB4RY = 0x08;
110 public static final byte MODULE_TYPE_VMB2BL = 0x09;
111 public static final byte MODULE_TYPE_VMB8IR = 0x0A;
112 public static final byte MODULE_TYPE_VMB1TS = 0x0C;
113 public static final byte MODULE_TYPE_VMB1LED = 0x0F;
114 public static final byte MODULE_TYPE_VMB4RYLD = 0x10;
115 public static final byte MODULE_TYPE_VMB4RYNO = 0x11;
116 public static final byte MODULE_TYPE_VMB4DC = 0x12;
117 public static final byte MODULE_TYPE_VMBDME = 0x14;
118 public static final byte MODULE_TYPE_VMBDMI = 0x15;
119 public static final byte MODULE_TYPE_VMB8PBU = 0x16;
120 public static final byte MODULE_TYPE_VMB6PBN = 0x17;
121 public static final byte MODULE_TYPE_VMB2PBN = 0x18;
122 public static final byte MODULE_TYPE_VMB1RYNO = 0x1B;
123 public static final byte MODULE_TYPE_VMB2BLE = 0x1D;
124 public static final byte MODULE_TYPE_VMBGP1 = 0x1E;
125 public static final byte MODULE_TYPE_VMBGP2 = 0x1F;
126 public static final byte MODULE_TYPE_VMBGP4 = 0x20;
127 public static final byte MODULE_TYPE_VMBGPO = 0x21;
128 public static final byte MODULE_TYPE_VMB7IN = 0x22;
129 public static final byte MODULE_TYPE_VMBGPOD = 0x28;
130 public static final byte MODULE_TYPE_VMB1RYNOS = 0x29;
131 public static final byte MODULE_TYPE_VMBPIRM = 0x2A;
132 public static final byte MODULE_TYPE_VMBPIRC = 0x2B;
133 public static final byte MODULE_TYPE_VMBPIRO = 0x2C;
134 public static final byte MODULE_TYPE_VMBGP4PIR = 0x2D;
135 public static final byte MODULE_TYPE_VMB1BLS = 0x2E;
136 public static final byte MODULE_TYPE_VMBDMIR = 0x2F;
137 public static final byte MODULE_TYPE_VMBRFR8S = 0x30;
138 public static final byte MODULE_TYPE_VMBMETEO = 0x31;
139 public static final byte MODULE_TYPE_VMB4AN = 0x32;
140 public static final byte MODULE_TYPE_VMBVP1 = 0x33;
141 public static final byte MODULE_TYPE_VMBEL1 = 0x34;
142 public static final byte MODULE_TYPE_VMBEL2 = 0x35;
143 public static final byte MODULE_TYPE_VMBEL4 = 0x36;
144 public static final byte MODULE_TYPE_VMBELO = 0x37;
145 public static final byte MODULE_TYPE_VMBELPIR = 0x38;
146 public static final byte MODULE_TYPE_VMBGP1_2 = 0x3A;
147 public static final byte MODULE_TYPE_VMBGP2_2 = 0x3B;
148 public static final byte MODULE_TYPE_VMBGP4_2 = 0x3C;
149 public static final byte MODULE_TYPE_VMBGPOD_2 = 0x3D;
150 public static final byte MODULE_TYPE_VMBGP4PIR_2 = 0x3E;
151 public static final byte MODULE_TYPE_VMB1RYS = 0x41;
152 public static final byte MODULE_TYPE_VMBKP = 0x42;
153 public static final byte MODULE_TYPE_VMBIN = 0x43;
154 public static final byte MODULE_TYPE_VMB4PB = 0x44;
157 public static final byte COMMAND_PUSH_BUTTON_STATUS = 0x00;
158 public static final byte COMMAND_SWITCH_RELAY_OFF = 0x01;
159 public static final byte COMMAND_SWITCH_RELAY_ON = 0x02;
160 public static final byte COMMAND_SWITCH_BLIND_OFF = 0x04;
161 public static final byte COMMAND_BLIND_UP = 0x05;
162 public static final byte COMMAND_BLIND_DOWN = 0x06;
163 public static final byte COMMAND_SET_VALUE = 0x07;
164 public static final byte COMMAND_SLIDER_STATUS = 0x0F;
165 public static final byte COMMAND_RESTORE_LAST_DIMVALUE = 0x11;
166 public static final byte COMMAND_BLIND_POS = 0x1C;
167 public static final byte COMMAND_SENSOR_RAW_DATA = (byte) 0xA9;
168 public static final byte COMMAND_LIGHT_VALUE_REQUEST = (byte) 0xAA;
169 public static final byte COMMAND_TEXT = (byte) 0xAC;
170 public static final byte COMMAND_DAYLIGHT_SAVING_STATUS = (byte) 0xAF;
171 public static final byte COMMAND_SUBTYPE = (byte) 0xB0;
172 public static final byte COMMAND_SET_REALTIME_DATE = (byte) 0xB7;
173 public static final byte COMMAND_DIMMERCONTROLLER_STATUS = (byte) 0xB8;
174 public static final byte COMMAND_TEMP_SENSOR_SETTINGS_PART4 = (byte) 0xB9;
175 public static final byte COMMAND_COUNTER_STATUS_REQUEST = (byte) 0xBD;
176 public static final byte COMMAND_COUNTER_STATUS = (byte) 0xBE;
177 public static final byte COMMAND_SET_ALARM_CLOCK = (byte) 0xC3;
178 public static final byte COMMAND_TEMP_SENSOR_SETTINGS_PART3 = (byte) 0xC6;
179 public static final byte COMMAND_READ_MEMORY_BLOCK = (byte) 0xC9;
180 public static final byte COMMAND_MEMORY_DATA_BLOCK = (byte) 0xCC;
181 public static final byte COMMAND_SET_REALTIME_CLOCK = (byte) 0xD8;
182 public static final byte COMMAND_SWITCH_TO_COMFORT_MODE = (byte) 0xDB;
183 public static final byte COMMAND_SWITCH_TO_DAY_MODE = (byte) 0xDC;
184 public static final byte COMMAND_SWITCH_TO_NIGHT_MODE = (byte) 0xDD;
185 public static final byte COMMAND_SWITCH_TO_SAFE_MODE = (byte) 0xDE;
186 public static final byte COMMAND_SET_COOLING_MODE = (byte) 0xDF;
187 public static final byte COMMAND_SET_HEATING_MODE = (byte) 0xE0;
188 public static final byte COMMAND_SET_TEMP = (byte) 0xE4;
189 public static final byte COMMAND_SENSOR_READOUT_REQUEST = (byte) 0xE5;
190 public static final byte COMMAND_SENSOR_TEMPERATURE = (byte) 0xE6;
191 public static final byte COMMAND_TEMP_SENSOR_SETTINGS_REQUEST = (byte) 0xE7;
192 public static final byte COMMAND_TEMP_SENSOR_SETTINGS_PART1 = (byte) 0xE8;
193 public static final byte COMMAND_TEMP_SENSOR_SETTINGS_PART2 = (byte) 0xE9;
194 public static final byte COMMAND_TEMP_SENSOR_STATUS = (byte) 0xEA;
195 public static final byte COMMAND_BLIND_STATUS = (byte) 0xEC;
196 public static final byte COMMAND_MODULE_STATUS = (byte) 0xED;
197 public static final byte COMMAND_DIMMER_STATUS = (byte) 0xEE;
198 public static final byte COMMAND_MODULE_NAME_REQUEST = (byte) 0xEF;
199 public static final byte COMMAND_MODULE_NAME_PART1 = (byte) 0xF0;
200 public static final byte COMMAND_MODULE_NAME_PART2 = (byte) 0xF1;
201 public static final byte COMMAND_MODULE_NAME_PART3 = (byte) 0xF2;
202 public static final byte COMMAND_CLEAR_LED = (byte) 0xF5;
203 public static final byte COMMAND_SET_LED = (byte) 0xF6;
204 public static final byte COMMAND_SLOW_BLINK_LED = (byte) 0xF7;
205 public static final byte COMMAND_FAST_BLINK_LED = (byte) 0xF8;
206 public static final byte COMMAND_VERY_FAST_BLINK_LED = (byte) 0xF9;
207 public static final byte COMMAND_STATUS_REQUEST = (byte) 0xFA;
208 public static final byte COMMAND_RELAY_STATUS = (byte) 0xFB;
209 public static final byte COMMAND_WRITE_DATA_TO_MEMORY = (byte) 0xFC;
210 public static final byte COMMAND_READ_DATA_FROM_MEMORY = (byte) 0xFD;
211 public static final byte COMMAND_MEMORY_DATA = (byte) 0xFE;
212 public static final byte COMMAND_MODULE_TYPE = (byte) 0xFF;
213 public static final byte ALL_CHANNELS = (byte) 0xFF;
216 public static final String PORT = "port";
217 public static final String ADDRESS = "address";
218 public static final String REFRESH_INTERVAL = "refresh";
219 public static final String COUNTER1_PULSE_MULTIPLIER = "COUNTER1_PULSE_MULTIPLIER";
220 public static final String COUNTER2_PULSE_MULTIPLIER = "COUNTER2_PULSE_MULTIPLIER";
221 public static final String COUNTER3_PULSE_MULTIPLIER = "COUNTER3_PULSE_MULTIPLIER";
222 public static final String COUNTER4_PULSE_MULTIPLIER = "COUNTER4_PULSE_MULTIPLIER";
223 public static final String RECONNECTION_INTERVAL = "reconnectionInterval";
224 public static final String TIME_UPDATE_INTERVAL = "timeUpdateInterval";
225 public static final String MODULE_SERIAL_NUMBER = "serial number";
226 public static final String MODULE_MEMORY_MAP_VERSION = "memory map version";
227 public static final String MODULE_BUILD = "build";
228 public static final String CHANNEL = "CH";
229 public static final String SUB_ADDRESS = "subaddress";
230 public static final String DIMSPEED = "dimspeed";
233 public static final String CHANNEL_BRIDGE_CLOCK_ALARM1_ENABLED = "bridgeClockAlarm#clockAlarm1Enabled";
234 public static final String CHANNEL_BRIDGE_CLOCK_ALARM1_WAKEUP_HOUR = "bridgeClockAlarm#clockAlarm1WakeupHour";
235 public static final String CHANNEL_BRIDGE_CLOCK_ALARM1_WAKEUP_MINUTE = "bridgeClockAlarm#clockAlarm1WakeupMinute";
236 public static final String CHANNEL_BRIDGE_CLOCK_ALARM1_BEDTIME_HOUR = "bridgeClockAlarm#clockAlarm1BedtimeHour";
237 public static final String CHANNEL_BRIDGE_CLOCK_ALARM1_BEDTIME_MINUTE = "bridgeClockAlarm#clockAlarm1BedtimeMinute";
238 public static final String CHANNEL_BRIDGE_CLOCK_ALARM2_ENABLED = "bridgeClockAlarm#clockAlarm2Enabled";
239 public static final String CHANNEL_BRIDGE_CLOCK_ALARM2_WAKEUP_HOUR = "bridgeClockAlarm#clockAlarm2WakeupHour";
240 public static final String CHANNEL_BRIDGE_CLOCK_ALARM2_WAKEUP_MINUTE = "bridgeClockAlarm#clockAlarm2WakeupMinute";
241 public static final String CHANNEL_BRIDGE_CLOCK_ALARM2_BEDTIME_HOUR = "bridgeClockAlarm#clockAlarm2BedtimeHour";
242 public static final String CHANNEL_BRIDGE_CLOCK_ALARM2_BEDTIME_MINUTE = "bridgeClockAlarm#clockAlarm2BedtimeMinute";
243 public static final String CHANNEL_MODULE_CLOCK_ALARM1_ENABLED = "clockAlarm#clockAlarm1Enabled";
244 public static final String CHANNEL_MODULE_CLOCK_ALARM1_TYPE = "clockAlarm#clockAlarm1Type";
245 public static final String CHANNEL_MODULE_CLOCK_ALARM1_WAKEUP_HOUR = "clockAlarm#clockAlarm1WakeupHour";
246 public static final String CHANNEL_MODULE_CLOCK_ALARM1_WAKEUP_MINUTE = "clockAlarm#clockAlarm1WakeupMinute";
247 public static final String CHANNEL_MODULE_CLOCK_ALARM1_BEDTIME_HOUR = "clockAlarm#clockAlarm1BedtimeHour";
248 public static final String CHANNEL_MODULE_CLOCK_ALARM1_BEDTIME_MINUTE = "clockAlarm#clockAlarm1BedtimeMinute";
249 public static final String CHANNEL_MODULE_CLOCK_ALARM2_ENABLED = "clockAlarm#clockAlarm2Enabled";
250 public static final String CHANNEL_MODULE_CLOCK_ALARM2_TYPE = "clockAlarm#clockAlarm2Type";
251 public static final String CHANNEL_MODULE_CLOCK_ALARM2_WAKEUP_HOUR = "clockAlarm#clockAlarm2WakeupHour";
252 public static final String CHANNEL_MODULE_CLOCK_ALARM2_WAKEUP_MINUTE = "clockAlarm#clockAlarm2WakeupMinute";
253 public static final String CHANNEL_MODULE_CLOCK_ALARM2_BEDTIME_HOUR = "clockAlarm#clockAlarm2BedtimeHour";
254 public static final String CHANNEL_MODULE_CLOCK_ALARM2_BEDTIME_MINUTE = "clockAlarm#clockAlarm2BedtimeMinute";
257 public static final Integer DELAY_SEND_CLOCK_ALARM_UPDATE = 10000;