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.io.homekit.internal;
  14
  15 import java.util.HashMap;
  16 import java.util.Map;
  17 import java.util.Optional;
  18
  19 /**
  20  * Characteristics are used by complex accessories that can't be represented by
  21  * a single item (i.e. a thermostat)
  22  *
  23  * @author Andy Lintner - Initial contribution
  24  */
  25 public enum HomekitCharacteristicType {
  26     /*
  27      * It is illegal to have a characteristic type also be a device type
  28      */
  29     EMPTY("Empty"), // used in case only accessory type but no characteristic provided
  30
  31     NAME("Name"),
  32     MANUFACTURER("Manufacturer"),
  33     MODEL("Model"),
  34     SERIAL_NUMBER("SerialNumber"),
  35     FIRMWARE_REVISION("FirmwareRevision"),
  36     HARDWARE_REVISION("HardwareRevision"),
  37     IDENTIFY("Identify"),
  38
  39     BATTERY_LOW_STATUS("BatteryLowStatus"),
  40     ACTIVE_STATUS("ActiveStatus"),
  41     ISCONFIGURED("IsConfigured"),
  42     SERVICELABELIDX("ServiceLabelIndex"),
  43     INUSE_STATUS("InUseStatus"),
  44     FAULT_STATUS("FaultStatus"),
  45     TAMPERED_STATUS("TamperedStatus"),
  46     OBSTRUCTION_STATUS("ObstructionStatus"),
  47     ON_STATE("OnState"),
  48     CONTACT_SENSOR_STATE("ContactSensorState"),
  49
  50     MOTION_DETECTED_STATE("MotionDetectedState"),
  51     OCCUPANCY_DETECTED_STATE("OccupancyDetectedState"),
  52     SMOKE_DETECTED_STATE("SmokeDetectedState"),
  53
  54     CARBON_MONOXIDE_DETECTED_STATE("CarbonMonoxideDetectedState"),
  55     CARBON_MONOXIDE_LEVEL("CarbonMonoxideLevel"),
  56     CARBON_MONOXIDE_PEAK_LEVEL("CarbonMonoxidePeakLevel"),
  57
  58     CARBON_DIOXIDE_DETECTED_STATE("CarbonDioxideDetectedState"),
  59     CARBON_DIOXIDE_LEVEL("CarbonDioxideLevel"),
  60     CARBON_DIOXIDE_PEAK_LEVEL("CarbonDioxidePeakLevel"),
  61
  62     RELATIVE_HUMIDITY("RelativeHumidity"),
  63     LEAK_DETECTED_STATE("LeakDetectedState"),
  64     HOLD_POSITION("HoldPosition"),
  65
  66     TARGET_POSITION("TargetPosition"),
  67     CURRENT_POSITION("CurrentPosition"),
  68     POSITION_STATE("PositionState"),
  69     CURRENT_HORIZONTAL_TILT_ANGLE("CurrentHorizontalTiltAngle"),
  70     CURRENT_VERTICAL_TILT_ANGLE("CurrentVerticalTiltAngle"),
  71     TARGET_HORIZONTAL_TILT_ANGLE("TargetHorizontalTiltAngle"),
  72     TARGET_VERTICAL_TILT_ANGLE("TargetVerticalTiltAngle"),
  73     CURRENT_TILT_ANGLE("CurrentTiltAngle"),
  74     TARGET_TILT_ANGLE("TargetTiltAngle"),
  75
  76     HUE("Hue"),
  77     BRIGHTNESS("Brightness"),
  78     SATURATION("Saturation"),
  79     COLOR_TEMPERATURE("ColorTemperature"),
  80
  81     CURRENT_FAN_STATE("CurrentFanState"),
  82     TARGET_FAN_STATE("TargetFanState"),
  83     ROTATION_DIRECTION("RotationDirection"),
  84     ROTATION_SPEED("RotationSpeed"),
  85     SWING_MODE("SwingMode"),
  86     LOCK_CONTROL("LockControl"),
  87
  88     CURRENT_TEMPERATURE("CurrentTemperature"),
  89     TARGET_HEATING_COOLING_STATE("TargetHeatingCoolingMode"),
  90     CURRENT_HEATING_COOLING_STATE("CurrentHeatingCoolingMode"),
  91     TARGET_TEMPERATURE("TargetTemperature"),
  92     TEMPERATURE_UNIT("TemperatureUnit"),
  93
  94     LOCK_CURRENT_STATE("LockCurrentState"),
  95     LOCK_TARGET_STATE("LockTargetState"),
  96
  97     DURATION("Duration"),
  98     REMAINING_DURATION("RemainingDuration"),
  99
 100     SECURITY_SYSTEM_CURRENT_STATE("CurrentSecuritySystemState"),
 101     SECURITY_SYSTEM_TARGET_STATE("TargetSecuritySystemState"),
 102
 103     VOLUME("Volume"),
 104     MUTE("Mute"),
 105     LIGHT_LEVEL("LightLevel"),
 106
 107     CURRENT_DOOR_STATE("CurrentDoorState"),
 108     TARGET_DOOR_STATE("TargetDoorState"),
 109     TARGET_HEATER_COOLER_STATE("TargetHeaterCoolerState"),
 110     CURRENT_HEATER_COOLER_STATE("CurrentHeaterCoolerState"),
 111     COOLING_THRESHOLD_TEMPERATURE("CoolingThresholdTemperature"),
 112     HEATING_THRESHOLD_TEMPERATURE("HeatingThresholdTemperature"),
 113
 114     AIR_QUALITY("AirQuality"),
 115     OZONE_DENSITY("OzoneDensity"),
 116     NITROGEN_DIOXIDE_DENSITY("NitrogenDioxideDensity"),
 117     SULPHUR_DIOXIDE_DENSITY("SulphurDioxideDensity"),
 118     PM25_DENSITY("PM25Density"),
 119     PM10_DENSITY("PM10Density"),
 120     VOC_DENSITY("VOCDensity"),
 121
 122     BATTERY_LEVEL("BatteryLevel"),
 123     BATTERY_CHARGING_STATE("BatteryChargingState"),
 124
 125     CURRENT_SLAT_STATE("CurrentSlatState"),
 126
 127     CURRENT_MEDIA_STATE("CurrentMediaState"),
 128     TARGET_MEDIA_STATE("TargetMediaState"),
 129     CONFIGURED_NAME("ConfiguredName"),
 130
 131     ACTIVE("Active"),
 132
 133     FILTER_CHANGE_INDICATION("FilterChangeIndication"),
 134     FILTER_LIFE_LEVEL("FilterLifeLevel"),
 135     FILTER_RESET_INDICATION("FilterResetIndication"),
 136
 137     ACTIVE_IDENTIFIER("ActiveIdentifier"),
 138     REMOTE_KEY("RemoteKey"),
 139     SLEEP_DISCOVERY_MODE("SleepDiscoveryMode"),
 140     POWER_MODE("PowerMode"),
 141     CLOSED_CAPTIONS("ClosedCaptions"),
 142     PICTURE_MODE("PictureMode"),
 143
 144     CONFIGURED("Configured"),
 145     INPUT_SOURCE_TYPE("InputSourceType"),
 146     CURRENT_VISIBILITY("CurrentVisibility"),
 147     IDENTIFIER("Identifier"),
 148     INPUT_DEVICE_TYPE("InputDeviceType"),
 149     TARGET_VISIBILITY_STATE("TargetVisibilityState"),
 150
 151     VOLUME_SELECTOR("VolumeSelector"),
 152     VOLUME_CONTROL_TYPE("VolumeControlType"),
 153
 154     PROGRAM_MODE("ProgramMode"),
 155     SERVICE_LABEL("ServiceLabel"),
 156     SERVICE_INDEX("ServiceIndex");
 157
 158     private static final Map<String, HomekitCharacteristicType> TAG_MAP = new HashMap<>();
 159
 160     static {
 161         for (HomekitCharacteristicType type : HomekitCharacteristicType.values()) {
 162             TAG_MAP.put(type.tag, type);
 163         }
 164     }
 165
 166     private final String tag;
 167
 168     private HomekitCharacteristicType(String tag) {
 169         this.tag = tag;
 170     }
 171
 172     public String getTag() {
 173         return tag;
 174     }
 175
 176     /**
 177      * get characteristicType from String
 178      *
 179      * @param tag the tag string
 180      * @return characteristicType or null if not found
 181      */
 182     public static Optional<HomekitCharacteristicType> valueOfTag(String tag) {
 183         return Optional.ofNullable(TAG_MAP.get(tag));
 184     }
 185
 186     @Override
 187     public String toString() {
 188         return tag;
 189     }
 190 }