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.digitalstrom.internal.lib.serverconnection.constants;
  14
  15 /**
  16  * The {@link JSONApiResponseKeysEnum} contains digitalSTROM-JSON response keys.
  17  *
  18  * @author Alexander Betker - Initial contribution
  19  * @author Michael Ochel completely changed and updated only methods remained
  20  * @author Matthias Siegele completely changed and updated only methods remained
  21  */
  22 public enum JSONApiResponseKeysEnum {
  23
  24     // GENERAL
  25     OK("ok"),
  26     MESSAGE("message"),
  27     RESULT("result"),
  28
  29     // STRUCTURE
  30     APARTMENT("apartment"),
  31     DS_METERS("dSMeters"),
  32     ZONES("zones"),
  33     CIRCUITS("circuits"),
  34     DEVICES("devices"),
  35     GROUPS("groups"),
  36     REACHABLE_SCENES("reachableScenes"),
  37
  38     // SENSORS
  39     // device
  40     CONSUMPTION("consumption"),
  41     SENSOR_VALUE("sensorValue"),
  42     SENSOR_INDEX("sensorIndex"),
  43     METER_VALUE("meterValue"),
  44     TYPE("type"),
  45
  46     // meter sensors
  47     POWER_CONSUMPTION("powerConsumption"),
  48     ENERGY_METER_VALUE("energyMeterValue"),
  49     ENERGY_METER_VALUE_WS("energyMeterValueWs"),
  50     RESOLUTIONS("resolutions"),
  51     RESOLUTION("resolution"),
  52     SERIES("series"),
  53     UNIT("unit"),
  54     VALUES("values"),
  55     DATE("date"),
  56
  57     // zone/apartment sensors
  58     SENSOR_TYPE("sensorType"),
  59     TEMPERATION_VALUE("TemperatureValue"),
  60     TEMPERATION_VALUE_TIME("TemperatureValueTime"),
  61     HUMIDITY_VALUE("HumidityValue"),
  62     HUMIDITY_VALUE_TIME("HumidityValueTime"),
  63     BRIGHTNESS_VALUE("BrightnessValue"),
  64     BRIGHTNESS_VALUE_TIME("BrightnessValueTime"),
  65     CO2_CONCENTRATION_VALUE("CO2ConcentrationValue"),
  66     CO2_CONCENTRATION_VALUE_TIME("CO2ConcentrationValueTime"),
  67     SENSORS("sensors"),
  68     WEATHER_ICON_ID("WeatherIconId"),
  69     WEATHER_CONDITION_ID("WeatherConditionId"),
  70     WEATHER_SERVICE_ID("WeatherServiceId"),
  71     WEATHER_SERVICE_TIME("WeatherServiceTime"),
  72
  73     // IDs
  74     DSID("dSID"),
  75     DSUID("dSUID"),
  76     DSID_LOWER_CASE("dsid"),
  77     METER_DSID("meterDSID"),
  78     ZONE_ID("ZoneID"),
  79     ZONE_ID_Lower_Z("zoneID"),
  80     DSUID_LOWER_CASE("dsuid"),
  81     GROUP_ID("groupID"),
  82     METER_ID("meterID"),
  83     ID("id"),
  84     SCENE_ID("sceneID"),
  85     NAME("name"),
  86     DISPLAY_ID("DisplayID"),
  87
  88     // DEVICE
  89     // status
  90     IS_PRESENT("isPresent"),
  91     IS_VALID("isValid"),
  92     IS_ON("isOn"),
  93     PRESENT("present"),
  94     ON("on"),
  95     // descriptions
  96     FUNCTION_ID("functionID"),
  97     PRODUCT_REVISION("productRevision"),
  98     PRODUCT_ID("productID"),
  99     HW_INFO("hwInfo"),
 100     OUTPUT_MODE("outputMode"),
 101     BUTTON_ID("buttonID"),
 102     HAS_TAG("hasTag"),
 103     TAGS("tags"),
 104     REVISION_ID("revisionID"),
 105
 106     // channel
 107     OUTPUT_CHANNELS("outputChannels"),
 108
 109     // config
 110     CLASS("class"),
 111     INDEX("index"),
 112     VALUE("value"),
 113
 114     DONT_CARE("dontCare"),
 115     LOCAL_PRIO("localPrio"),
 116     SPECIAL_MODE("specialMode"),
 117     FLASH_MODE("flashMode"),
 118     LEDCON_INDEX("ledconIndex"),
 119     DIM_TIME_INDEX("dimtimeIndex"),
 120     UP("up"),
 121     DOWN("down"),
 122
 123     // event table
 124     TEST("test"),
 125     ACTION("action"),
 126     HYSTERSIS("hysteresis"),
 127     VALIDITY("validity"),
 128
 129     // EVENTS
 130     EVENTS("events"),
 131     PROPERTIES("properties"),
 132     EVENT_INDEX("eventIndex"),
 133     EVENT_NAME("eventName"),
 134
 135     // SYSTEM & LOGIN
 136     VERSION("version"),
 137     TIME("time"),
 138     TOKEN("token"),
 139     APPLICATION_TOKEN("applicationToken"),
 140
 141     SELF("self"),
 142
 143     // CLIMATE
 144     IS_CONFIGURED("IsConfigured"),
 145     CONTROL_MODE("ControlMode"),
 146     CONTROL_STATE("ControlState"),
 147     CONTROL_DSUID("ControlDSUID"),
 148     OPERATION_MODE("OperationMode"),
 149     TEMPERATURE_VALUE("TemperatureValue"),
 150     NOMINAL_VALUE("NominalValue"),
 151     CONTROL_VALUE("ControlValue"),
 152     TEMPERATURE_VALUE_TIME("TemperatureValueTime"),
 153     NOMINAL_VALUE_TIME("NominalValueTime"),
 154     CONTROL_VALUE_TIME("ControlValueTime"),
 155     CTRL_T_RECENT("CtrlTRecent"),
 156     CTRL_T_REFERENCE("CtrlTReference"),
 157     CTRL_T_ERROR("CtrlTError"),
 158     CTRL_T_ERROR_PREV("CtrlTErrorPrev"),
 159     CTRL_INTEGRAL("CtrlIntegral"),
 160     CTRL_YP("CtrlYp"),
 161     CTRL_YI("CtrlYi"),
 162     CTRL_YD("CtrlYd"),
 163     CTRL_Y("CtrlY"),
 164     CTRL_ANTI_WIND_UP("CtrlAntiWindUp"),
 165     REFERENCE_ZONE("ReferenceZone"),
 166     CTRL_OFFSET("CtrlOffset"),
 167     EMERGENCY_VALUE("EmergencyValue"),
 168     CTRL_KP("CtrlKp"),
 169     CTRL_TS("CtrlTs"),
 170     CTRL_TI("CtrlTi"),
 171     CTRL_KD("CtrlKd"),
 172     CTRL_MIN("CtrlImin"),
 173     CTRL_MAX("CtrlImax"),
 174     CTRL_Y_MIN("CtrlYmin"),
 175     CTRL_Y_MAX("CtrlYmax"),
 176     CTRL_KEEP_FLOOR_WARM("CtrlKeepFloorWarm"),
 177
 178     // UNDEF
 179     COLOR_SELECT("colorSelect"),
 180     MODE_SELECT("modeSelect"),
 181     DIM_MODE("dimMode"),
 182     RGB_MODE("rgbMode"),
 183     GROUP_COLOR_MODE("groupColorMode"),
 184     SOURCE("source"),
 185     IS_SCENE_DEVICE("isSceneDevice"),
 186
 187     // Circuit
 188     HW_VERSION("hwVersion"),
 189     HW_VERSION_STRING("hwVersionString"),
 190     SW_VERSION("swVersion"),
 191     ARM_SW_VERSION("armSwVersion"),
 192     DSP_SW_VERSION("dspSwVersion"),
 193     API_VERSION("apiVersion"),
 194     HW_NAME("hwName"),
 195     BUS_MEMBER_TYPE("busMemberType"),
 196     HAS_DEVICES("hasDevices"),
 197     HAS_METERING("hasMetering"),
 198     VDC_CONFIG_URL("VdcConfigURL"),
 199     VDC_MODEL_UID("VdcModelUID"),
 200     VDC_HARDWARE_GUID("VdcHardwareGuid"),
 201     VDC_HARDWARE_MODEL_GUID("VdcHardwareModelGuid"),
 202     VDC_VENDOR_GUID("VdcVendorGuid"),
 203     VDC_OEM_GUID("VdcOemGuid"),
 204     IGNORE_ACTIONS_FROM_NEW_DEVICES("ignoreActionsFromNewDevices"),
 205
 206     DS_METER_DSID("DSMeterDSID"),
 207     HW_INFO_UPPER_HW("HWInfo"),
 208     VALID("valid"),
 209     VALUE_DS("valueDS"),
 210     TIMESTAMP("timestamp"),
 211     SENSOR_INPUTS("sensorInputs"),
 212     GROUP("group"),
 213     LAST_CALL_SCENE("lastCalledScene"),
 214     ANGLE("angle"),
 215
 216     // Binary inputs
 217     BINARY_INPUTS("binaryInputs"),
 218     STATE("state"),
 219     STATE_VALUE("stateValue"),
 220     TARGET_GROUP_TYPE("targetGroupType"),
 221     TARGET_GROUP("targetGroup"),
 222     INPUT_TYPE("inputType"),
 223     INPUT_ID("inputId");
 224
 225     private final String key;
 226
 227     private JSONApiResponseKeysEnum(String key) {
 228         this.key = key;
 229     }
 230
 231     /**
 232      * Returns the key.
 233      *
 234      * @return key
 235      */
 236     public String getKey() {
 237         return key;
 238     }
 239 }