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

   1 /**
   2  * Copyright (c) 2010-2024 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.miele.internal;
  14
  15 import org.eclipse.jdt.annotation.NonNullByDefault;
  16 import org.openhab.core.thing.ThingTypeUID;
  17
  18 /**
  19  * The {@link MieleBindingConstants} class defines common constants, which are
  20  * used across the whole binding.
  21  *
  22  * @author Karel Goderis - Initial contribution
  23  * @author Martin Lepsy - added constants for support of WiFi devices and protocol
  24  * @author Jacob Laursen - Fixed multicast and protocol support (ZigBee/LAN)
  25  */
  26 @NonNullByDefault
  27 public class MieleBindingConstants {
  28
  29     public static final String BINDING_ID = "miele";
  30     public static final String APPLIANCE_ID = "uid";
  31     public static final String MIELE_CLASS = "com.miele.xgw3000.gateway.hdm.deviceclasses.Miele";
  32
  33     // Properties
  34     public static final String PROPERTY_DEVICE_CLASS = "deviceClass";
  35     public static final String PROPERTY_PROTOCOL_ADAPTER = "protocolAdapter";
  36     public static final String PROPERTY_CONNECTION_TYPE = "connectionType";
  37     public static final String PROPERTY_CONNECTION_BAUD_RATE = "connectionBaudRate";
  38
  39     // JSON-RPC property names
  40     public static final String EXTENDED_DEVICE_STATE_PROPERTY_NAME = "extendedDeviceState";
  41     public static final String STATE_PROPERTY_NAME = "state";
  42     public static final String PROGRAM_ID_PROPERTY_NAME = "programId";
  43     public static final String PHASE_PROPERTY_NAME = "phase";
  44     public static final String RAW_PHASE_PROPERTY_NAME = "rawPhase";
  45     public static final String START_TIME_PROPERTY_NAME = "startTime";
  46     public static final String FINISH_TIME_PROPERTY_NAME = "finishTime";
  47
  48     // Shared Channel ID's
  49     public static final String STATE_TEXT_CHANNEL_ID = "state";
  50     public static final String STATE_CHANNEL_ID = "rawState";
  51     public static final String PROGRAM_TEXT_CHANNEL_ID = "program";
  52     public static final String PROGRAM_CHANNEL_ID = "rawProgram";
  53     public static final String PHASE_TEXT_CHANNEL_ID = "phase";
  54     public static final String PHASE_CHANNEL_ID = "rawPhase";
  55     public static final String SUPERCOOL_CHANNEL_ID = "supercool";
  56     public static final String SUPERFREEZE_CHANNEL_ID = "superfreeze";
  57     public static final String SWITCH_CHANNEL_ID = "switch";
  58     public static final String START_CHANNEL_ID = "start";
  59     public static final String END_CHANNEL_ID = "end";
  60     public static final String FINISH_CHANNEL_ID = "finish";
  61     public static final String ENERGY_CONSUMPTION_CHANNEL_ID = "energyConsumption";
  62     public static final String WATER_CONSUMPTION_CHANNEL_ID = "waterConsumption";
  63
  64     // List of all Thing Type UIDs
  65     public static final ThingTypeUID THING_TYPE_XGW3000 = new ThingTypeUID(BINDING_ID, "xgw3000");
  66     public static final ThingTypeUID THING_TYPE_DISHWASHER = new ThingTypeUID(BINDING_ID, "dishwasher");
  67     public static final ThingTypeUID THING_TYPE_OVEN = new ThingTypeUID(BINDING_ID, "oven");
  68     public static final ThingTypeUID THING_TYPE_FRIDGE = new ThingTypeUID(BINDING_ID, "fridge");
  69     public static final ThingTypeUID THING_TYPE_DRYER = new ThingTypeUID(BINDING_ID, "tumbledryer");
  70     public static final ThingTypeUID THING_TYPE_HOB = new ThingTypeUID(BINDING_ID, "hob");
  71     public static final ThingTypeUID THING_TYPE_FRIDGEFREEZER = new ThingTypeUID(BINDING_ID, "fridgefreezer");
  72     public static final ThingTypeUID THING_TYPE_HOOD = new ThingTypeUID(BINDING_ID, "hood");
  73     public static final ThingTypeUID THING_TYPE_WASHINGMACHINE = new ThingTypeUID(BINDING_ID, "washingmachine");
  74     public static final ThingTypeUID THING_TYPE_COFFEEMACHINE = new ThingTypeUID(BINDING_ID, "coffeemachine");
  75
  76     // Miele devices classes
  77     public static final String MIELE_DEVICE_CLASS_COFFEE_SYSTEM = "CoffeeSystem";
  78     public static final String MIELE_DEVICE_CLASS_DISHWASHER = "Dishwasher";
  79     public static final String MIELE_DEVICE_CLASS_FRIDGE = "Fridge";
  80     public static final String MIELE_DEVICE_CLASS_FRIDGE_FREEZER = "FridgeFreezer";
  81     public static final String MIELE_DEVICE_CLASS_HOB = "Hob";
  82     public static final String MIELE_DEVICE_CLASS_HOOD = "Hood";
  83     public static final String MIELE_DEVICE_CLASS_OVEN = "Oven";
  84     public static final String MIELE_DEVICE_CLASS_TUMBLE_DRYER = "TumbleDryer";
  85     public static final String MIELE_DEVICE_CLASS_WASHING_MACHINE = "WashingMachine";
  86
  87     // Miele appliance states
  88     public static final int STATE_UNKNOWN = 0;
  89     public static final int STATE_OFF = 1;
  90     public static final int STATE_STAND_BY = 2;
  91     public static final int STATE_PROGRAMMED = 3;
  92     public static final int STATE_WAITING_TO_START = 4;
  93     public static final int STATE_RUNNING = 5;
  94     public static final int STATE_PAUSED = 6;
  95     public static final int STATE_END = 7;
  96     public static final int STATE_FAILURE = 8;
  97     public static final int STATE_ABORT = 9;
  98     public static final int STATE_IDLE = 10;
  99     public static final int STATE_RINSE_HOLD = 11;
 100     public static final int STATE_SERVICE = 12;
 101     public static final int STATE_SUPER_FREEZING = 13;
 102     public static final int STATE_SUPER_COOLING = 14;
 103     public static final int STATE_SUPER_HEATING = 15;
 104     public static final int STATE_LOCKED = 145;
 105     public static final int STATE_NOT_CONNECTED = 255;
 106
 107     // Miele missing string prefixes
 108     public static final String MISSING_STATE_TEXT_PREFIX = "state.";
 109     public static final String MISSING_PROGRAM_TEXT_PREFIX = "program.";
 110     public static final String MISSING_PHASE_TEXT_PREFIX = "phase.";
 111
 112     // Miele appliance localization text prefixes
 113     public static final String MIELE_COFFEE_MACHINE_TEXT_PREFIX = "coffeemachine.";
 114     public static final String MIELE_DISHWASHER_TEXT_PREFIX = "dishwasher.";
 115     public static final String MIELE_OVEN_TEXT_PREFIX = "oven.";
 116     public static final String MIELE_TUMBLE_DRYER_TEXT_PREFIX = "tumbledryer.";
 117     public static final String MIELE_WASHING_MACHINE_TEXT_PREFIX = "washingmachine.";
 118
 119     // Bridge config properties
 120     public static final String HOST = "ipAddress";
 121     public static final String INTERFACE = "interface";
 122     public static final String USER_NAME = "userName";
 123     public static final String PASSWORD = "password";
 124     public static final String LANGUAGE = "language";
 125     public static final String REMOVAL_GRACE_PERIOD = "removalGracePeriod";
 126 }