]> git.basschouten.com Git - openhab-addons.git/blob
c29e7063ab0f6734f377be6aba16c6fca1a293f1
[openhab-addons.git] /
1 /**
2  * Copyright (c) 2010-2023 Contributors to the openHAB project
3  *
4  * See the NOTICE file(s) distributed with this work for additional
5  * information.
6  *
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
10  *
11  * SPDX-License-Identifier: EPL-2.0
12  */
13 package org.openhab.binding.deconz.internal;
14
15 import org.eclipse.jdt.annotation.NonNullByDefault;
16 import org.openhab.core.library.types.PercentType;
17 import org.openhab.core.thing.ThingTypeUID;
18 import org.openhab.core.thing.type.ChannelTypeUID;
19
20 /**
21  * The {@link BindingConstants} class defines common constants, which are
22  * used across the whole binding.
23  *
24  * @author David Graeff - Initial contribution
25  */
26 @NonNullByDefault
27 public class BindingConstants {
28     public static final String BINDING_ID = "deconz";
29
30     // List of all Thing Type UIDs
31     public static final ThingTypeUID BRIDGE_TYPE = new ThingTypeUID(BINDING_ID, "deconz");
32
33     // sensors
34     public static final ThingTypeUID THING_TYPE_PRESENCE_SENSOR = new ThingTypeUID(BINDING_ID, "presencesensor");
35     public static final ThingTypeUID THING_TYPE_POWER_SENSOR = new ThingTypeUID(BINDING_ID, "powersensor");
36     public static final ThingTypeUID THING_TYPE_CONSUMPTION_SENSOR = new ThingTypeUID(BINDING_ID, "consumptionsensor");
37     public static final ThingTypeUID THING_TYPE_DAYLIGHT_SENSOR = new ThingTypeUID(BINDING_ID, "daylightsensor");
38     public static final ThingTypeUID THING_TYPE_COLOR_CONTROL = new ThingTypeUID(BINDING_ID, "colorcontrol");
39     public static final ThingTypeUID THING_TYPE_SWITCH = new ThingTypeUID(BINDING_ID, "switch");
40     public static final ThingTypeUID THING_TYPE_LIGHT_SENSOR = new ThingTypeUID(BINDING_ID, "lightsensor");
41     public static final ThingTypeUID THING_TYPE_TEMPERATURE_SENSOR = new ThingTypeUID(BINDING_ID, "temperaturesensor");
42     public static final ThingTypeUID THING_TYPE_HUMIDITY_SENSOR = new ThingTypeUID(BINDING_ID, "humiditysensor");
43     public static final ThingTypeUID THING_TYPE_PRESSURE_SENSOR = new ThingTypeUID(BINDING_ID, "pressuresensor");
44     public static final ThingTypeUID THING_TYPE_OPENCLOSE_SENSOR = new ThingTypeUID(BINDING_ID, "openclosesensor");
45     public static final ThingTypeUID THING_TYPE_WATERLEAKAGE_SENSOR = new ThingTypeUID(BINDING_ID,
46             "waterleakagesensor");
47     public static final ThingTypeUID THING_TYPE_FIRE_SENSOR = new ThingTypeUID(BINDING_ID, "firesensor");
48     public static final ThingTypeUID THING_TYPE_ALARM_SENSOR = new ThingTypeUID(BINDING_ID, "alarmsensor");
49     public static final ThingTypeUID THING_TYPE_VIBRATION_SENSOR = new ThingTypeUID(BINDING_ID, "vibrationsensor");
50     public static final ThingTypeUID THING_TYPE_BATTERY_SENSOR = new ThingTypeUID(BINDING_ID, "batterysensor");
51     public static final ThingTypeUID THING_TYPE_CARBONMONOXIDE_SENSOR = new ThingTypeUID(BINDING_ID,
52             "carbonmonoxidesensor");
53     public static final ThingTypeUID THING_TYPE_AIRQUALITY_SENSOR = new ThingTypeUID(BINDING_ID, "airqualitysensor");
54     public static final ThingTypeUID THING_TYPE_MOISTURE_SENSOR = new ThingTypeUID(BINDING_ID, "moisturesensor");
55
56     // Special sensor - Thermostat
57     public static final ThingTypeUID THING_TYPE_THERMOSTAT = new ThingTypeUID(BINDING_ID, "thermostat");
58
59     // lights
60     public static final ThingTypeUID THING_TYPE_ONOFF_LIGHT = new ThingTypeUID(BINDING_ID, "onofflight");
61     public static final ThingTypeUID THING_TYPE_DIMMABLE_LIGHT = new ThingTypeUID(BINDING_ID, "dimmablelight");
62     public static final ThingTypeUID THING_TYPE_COLOR_TEMPERATURE_LIGHT = new ThingTypeUID(BINDING_ID,
63             "colortemperaturelight");
64     public static final ThingTypeUID THING_TYPE_COLOR_LIGHT = new ThingTypeUID(BINDING_ID, "colorlight");
65     public static final ThingTypeUID THING_TYPE_EXTENDED_COLOR_LIGHT = new ThingTypeUID(BINDING_ID,
66             "extendedcolorlight");
67     public static final ThingTypeUID THING_TYPE_WINDOW_COVERING = new ThingTypeUID(BINDING_ID, "windowcovering");
68     public static final ThingTypeUID THING_TYPE_WARNING_DEVICE = new ThingTypeUID(BINDING_ID, "warningdevice");
69     public static final ThingTypeUID THING_TYPE_DOORLOCK = new ThingTypeUID(BINDING_ID, "doorlock");
70
71     // groups
72     public static final ThingTypeUID THING_TYPE_LIGHTGROUP = new ThingTypeUID(BINDING_ID, "lightgroup");
73
74     // sensor channel ids
75     public static final String CHANNEL_PRESENCE = "presence";
76     public static final String CHANNEL_ENABLED = "enabled";
77     public static final String CHANNEL_LAST_UPDATED = "last_updated";
78     public static final String CHANNEL_LAST_SEEN = "last_seen";
79     public static final String CHANNEL_POWER = "power";
80     public static final String CHANNEL_CONSUMPTION = "consumption";
81     public static final String CHANNEL_CONSUMPTION_2 = "consumption2";
82     public static final String CHANNEL_VOLTAGE = "voltage";
83     public static final String CHANNEL_CURRENT = "current";
84     public static final String CHANNEL_VALUE = "value";
85     public static final String CHANNEL_TEMPERATURE = "temperature";
86     public static final String CHANNEL_HUMIDITY = "humidity";
87     public static final String CHANNEL_PRESSURE = "pressure";
88     public static final String CHANNEL_LIGHT = "light";
89     public static final String CHANNEL_LIGHT_LUX = "lightlux";
90     public static final String CHANNEL_LIGHT_LEVEL = "light_level";
91     public static final String CHANNEL_DARK = "dark";
92     public static final String CHANNEL_DAYLIGHT = "daylight";
93     public static final String CHANNEL_BUTTON = "button";
94     public static final String CHANNEL_BUTTONEVENT = "buttonevent";
95     public static final String CHANNEL_GESTURE = "gesture";
96     public static final String CHANNEL_GESTUREEVENT = "gestureevent";
97     public static final String CHANNEL_OPENCLOSE = "open";
98     public static final String CHANNEL_WATERLEAKAGE = "waterleakage";
99     public static final String CHANNEL_FIRE = "fire";
100     public static final String CHANNEL_ALARM = "alarm";
101     public static final String CHANNEL_TAMPERED = "tampered";
102     public static final String CHANNEL_VIBRATION = "vibration";
103     public static final String CHANNEL_BATTERY_LEVEL = "battery_level";
104     public static final String CHANNEL_BATTERY_LOW = "battery_low";
105     public static final String CHANNEL_CARBONMONOXIDE = "carbonmonoxide";
106     public static final String CHANNEL_AIRQUALITY = "airquality";
107     public static final String CHANNEL_AIRQUALITYPPB = "airqualityppb";
108     public static final String CHANNEL_MOISTURE = "moisture";
109     public static final String CHANNEL_HEATSETPOINT = "heatsetpoint";
110     public static final String CHANNEL_THERMOSTAT_MODE = "mode";
111     public static final String CHANNEL_THERMOSTAT_LOCKED = "locked";
112     public static final String CHANNEL_TEMPERATURE_OFFSET = "offset";
113     public static final String CHANNEL_THERMOSTAT_ON = "on";
114     public static final String CHANNEL_VALVE_POSITION = "valve";
115     public static final String CHANNEL_WINDOW_OPEN = "windowopen";
116     public static final String CHANNEL_EXTERNAL_WINDOW_OPEN = "externalwindowopen";
117
118     // group + light channel ids
119     public static final String CHANNEL_SWITCH = "switch";
120     public static final String CHANNEL_BRIGHTNESS = "brightness";
121     public static final String CHANNEL_COLOR_TEMPERATURE = "color_temperature";
122     public static final String CHANNEL_COLOR = "color";
123     public static final String CHANNEL_POSITION = "position";
124     public static final String CHANNEL_ALERT = "alert";
125     public static final String CHANNEL_ALL_ON = "all_on";
126     public static final String CHANNEL_ANY_ON = "any_on";
127     public static final String CHANNEL_LOCK = "lock";
128     public static final String CHANNEL_EFFECT = "effect";
129     public static final String CHANNEL_EFFECT_SPEED = "effectSpeed";
130     public static final String CHANNEL_SCENE = "scene";
131     public static final String CHANNEL_ONTIME = "ontime";
132
133     // channel uids
134     public static final ChannelTypeUID CHANNEL_EFFECT_TYPE_UID = new ChannelTypeUID(BINDING_ID, CHANNEL_EFFECT);
135     public static final ChannelTypeUID CHANNEL_EFFECT_SPEED_TYPE_UID = new ChannelTypeUID(BINDING_ID,
136             CHANNEL_EFFECT_SPEED);
137
138     // Thing configuration
139     public static final String CONFIG_HOST = "host";
140     public static final String CONFIG_HTTP_PORT = "httpPort";
141     public static final String CONFIG_APIKEY = "apikey";
142     public static final String PROPERTY_UDN = "UDN";
143     public static final String CONFIG_ID = "id";
144     public static final String UNIQUE_ID = "uid";
145
146     public static final String PROPERTY_CT_MIN = "ctmin";
147     public static final String PROPERTY_CT_MAX = "ctmax";
148
149     // CT value range according to ZCL Spec
150     public static final int ZCL_CT_UNDEFINED = 0; // 0x0000
151     public static final int ZCL_CT_MIN = 1;
152     public static final int ZCL_CT_MAX = 65279; // 0xFEFF
153     public static final int ZCL_CT_INVALID = 65535; // 0xFFFF
154
155     public static final double HUE_FACTOR = 65535 / 360.0;
156     public static final int BRIGHTNESS_MIN = 0;
157     public static final int BRIGHTNESS_MAX = 254;
158     public static final double BRIGHTNESS_FACTOR = BRIGHTNESS_MAX / PercentType.HUNDRED.doubleValue();
159 }