git.basschouten.com Git - openhab-addons.git/blob

   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.knx.internal;
  14
  15 import java.util.Set;
  16
  17 import org.eclipse.jdt.annotation.NonNullByDefault;
  18 import org.openhab.core.thing.ThingTypeUID;
  19
  20 /**
  21  * The {@link KNXBindingConstants} class defines common constants, which are
  22  * used across the whole binding.
  23  *
  24  * @author Karel Goderis - Initial contribution
  25  */
  26 @NonNullByDefault
  27 public class KNXBindingConstants {
  28
  29     public static final String BINDING_ID = "knx";
  30
  31     // Global config
  32     public static final String CONFIG_DISABLE_UOM = "disableUoM";
  33     public static boolean disableUoM = false;
  34
  35     // Thing Type UIDs
  36     public static final ThingTypeUID THING_TYPE_IP_BRIDGE = new ThingTypeUID(BINDING_ID, "ip");
  37     public static final ThingTypeUID THING_TYPE_SERIAL_BRIDGE = new ThingTypeUID(BINDING_ID, "serial");
  38     public static final ThingTypeUID THING_TYPE_DEVICE = new ThingTypeUID(BINDING_ID, "device");
  39
  40     // Property IDs
  41     public static final String DEVICE_MASK_VERSION = "deviceMaskVersion";
  42     public static final String DEVICE_PROFILE = "deviceProfile";
  43     public static final String DEVICE_MEDIUM_TYPE = "deviceMediumType";
  44     public static final String FRIENDLY_NAME = "deviceName";
  45     public static final String MANUFACTURER_NAME = "manufacturerName";
  46     public static final String MANUFACTURER_SERIAL_NO = "manufacturerSerialNumber";
  47     public static final String MANUFACTURER_HARDWARE_TYPE = "manufacturerHardwareType";
  48     public static final String MANUFACTURER_FIRMWARE_REVISION = "manufacturerFirmwareRevision";
  49     public static final String MANUFACTURER_ORDER_INFO = "manufacturerOrderInfo";
  50     public static final String MAX_APDU_LENGTH = "maxApduLength";
  51
  52     // Thing Configuration parameters
  53     public static final String IP_ADDRESS = "ipAddress";
  54     public static final String IP_CONNECTION_TYPE = "type";
  55     public static final String LOCAL_IP = "localIp";
  56     public static final String LOCAL_SOURCE_ADDRESS = "localSourceAddr";
  57     public static final String PORT_NUMBER = "portNumber";
  58     public static final String SERIAL_PORT = "serialPort";
  59     public static final String USE_CEMI = "useCemi";
  60     public static final String ROUTER_BACKBONE_GROUP_KEY = "routerBackboneGroupKey";
  61     public static final String TUNNEL_USER_ID = "tunnelUserId";
  62     public static final String TUNNEL_USER_PASSWORD = "tunnelUserPassword";
  63     public static final String TUNNEL_DEVICE_AUTHENTICATION = "tunnelDeviceAuthentication";
  64
  65     // The default multicast ip address (see <a
  66     // href="http://www.iana.org/assignments/multicast-addresses/multicast-addresses.xml">iana</a> EIBnet/IP
  67     public static final String DEFAULT_MULTICAST_IP = "224.0.23.12";
  68
  69     // Channel Type IDs
  70     public static final String CHANNEL_COLOR = "color";
  71     public static final String CHANNEL_COLOR_CONTROL = "color-control";
  72     public static final String CHANNEL_CONTACT = "contact";
  73     public static final String CHANNEL_CONTACT_CONTROL = "contact-control";
  74     public static final String CHANNEL_DATETIME = "datetime";
  75     public static final String CHANNEL_DATETIME_CONTROL = "datetime-control";
  76     public static final String CHANNEL_DIMMER = "dimmer";
  77     public static final String CHANNEL_DIMMER_CONTROL = "dimmer-control";
  78     public static final String CHANNEL_NUMBER = "number";
  79     public static final String CHANNEL_NUMBER_CONTROL = "number-control";
  80     public static final String CHANNEL_ROLLERSHUTTER = "rollershutter";
  81     public static final String CHANNEL_ROLLERSHUTTER_CONTROL = "rollershutter-control";
  82     public static final String CHANNEL_STRING = "string";
  83     public static final String CHANNEL_STRING_CONTROL = "string-control";
  84     public static final String CHANNEL_SWITCH = "switch";
  85     public static final String CHANNEL_SWITCH_CONTROL = "switch-control";
  86
  87     public static final Set<String> CONTROL_CHANNEL_TYPES = Set.of( //
  88             CHANNEL_COLOR_CONTROL, //
  89             CHANNEL_CONTACT_CONTROL, //
  90             CHANNEL_DATETIME_CONTROL, //
  91             CHANNEL_DIMMER_CONTROL, //
  92             CHANNEL_NUMBER_CONTROL, //
  93             CHANNEL_ROLLERSHUTTER_CONTROL, //
  94             CHANNEL_STRING_CONTROL, //
  95             CHANNEL_SWITCH_CONTROL //
  96     );
  97
  98     public static final String CHANNEL_RESET = "reset";
  99
 100     // Channel Configuration parameters
 101     public static final String GA = "ga";
 102     public static final String HSB_GA = "hsb";
 103     public static final String INCREASE_DECREASE_GA = "increaseDecrease";
 104     public static final String POSITION_GA = "position";
 105     public static final String REPEAT_FREQUENCY = "frequency";
 106     public static final String STOP_MOVE_GA = "stopMove";
 107     public static final String SWITCH_GA = "switch";
 108     public static final String UP_DOWN_GA = "upDown";
 109 }