"""Command-related enums and parameters used by device commands.""" # ruff: noqa: S105 # Enum values contain "PASS" in API names (e.g. PassAPC), not passwords import sys from enum import unique # Since we support Python versions lower than 3.11, we use # a backport for StrEnum when needed. if sys.version_info >= (3, 11): from enum import StrEnum else: from backports.strenum import ( # ty: ignore[unresolved-import] StrEnum, # type: ignore[import] ) @unique class OverkizCommand(StrEnum): """Device commands used by Overkiz.""" ACTIVATE_CALENDAR = "activateCalendar" ACTIVATE_OPTION = "activateOption" ADD_LOCK_LEVEL = "addLockLevel" ADVANCED_REFRESH = "advancedRefresh" ADVANCED_SOMFY_DISCOVER = "advancedSomfyDiscover" ALARM_OFF = "alarmOff" ALARM_ON = "alarmOn" ALARM_PARTIAL_1 = "alarmPartial1" ALARM_PARTIAL_2 = "alarmPartial2" ALARM_ZONE_ON = "alarmZoneOn" ARM = "arm" ARM_PARTIAL_DAY = "armPartialDay" ARM_PARTIAL_NIGHT = "armPartialNight" BIND = "bind" BINDING_NETWORK = "bindingNetwork" BIP = "bip" BLINK_MODEM_LED = "blinkModemLed" CANCEL_ABSENCE = "cancelAbsence" CANCEL_HEATING_LEVEL = "cancelHeatingLevel" CANCEL_HOLIDAY_MODE = "cancelHolidayMode" CHECK_EVENT_TRIGGER = "checkEventTrigger" CLEAR_CREDENTIALS = "clearCredentials" CLOSE = "close" CLOSE_NETWORK = "closeNetwork" CLOSE_NETWORK_MANAGEMENT = "closeNetworkManagement" CLOSE_SLATS = "closeSlats" CONFIGURE_HOLIDAY_MODE = "configureHolidayMode" CYCLE = "cycle" DEACTIVATE_CALENDAR = "deactivateCalendar" DEACTIVATE_OPTION = "deactivateOption" DELAYED_STOP_IDENTIFY = "delayedStopIdentify" DELETE_CONTROLLERS = "deleteControllers" DEPLOY = "deploy" DING_DONG = "dingDong" DISARM = "disarm" DISCOVER = "discover" DISCOVER_1_WAY_CONTROLLER = "discover1WayController" DISCOVER_ACTUATORS = "discoverActuators" DISCOVER_SENSORS = "discoverSensors" DISCOVER_SOMFY_UNSET_ACTUATORS = "discoverSomfyUnsetActuators" DOWN = "down" EXIT_DEROGATION = "exitDerogation" FAST_BACKWARD = "fastBackward" FAST_BIP_SEQUENCE = "fastBipSequence" FAST_FORWARD = "fastForward" GET_ALL_PLAYING_INFO = "getAllPlayingInfo" GET_CLOSURE = "getClosure" GET_CURRENT_TRANSPORT_ACTIONS = "getCurrentTransportActions" GET_GROUP_MUTE = "getGroupMute" GET_GROUP_VOLUME = "getGroupVolume" GET_LEVEL = "getLevel" GET_LOWER_CLOSURE = "getLowerClosure" GET_MEDIA_ELEMENTS = "getMediaElements" GET_MEDIA_INFO = "getMediaInfo" GET_MUTE = "getMute" GET_NAME = "getName" GET_POSITION_INFO = "getPositionInfo" GET_SONOS_FAVORITES = "getSonosFavorites" GET_SONOS_PLAYLIST = "getSonosPlaylist" GET_TRANSPORT_INFO = "getTransportInfo" GET_UPPER_CLOSURE = "getUpperClosure" GET_VOLUME = "getVolume" GLOBAL_CONTROL = "globalControl" GO_TO_ALIAS = "goToAlias" IDENTIFY = "identify" INCREASING_FREQUENCY_BIP = "increasingFrequencyBip" IS_FAILED_DEVICE = "isFailedDevice" JOIN_NETWORK = "joinNetwork" KEEP_ONE_WAY_CONTROLLERS_AND_DELETE_NODE = "keepOneWayControllersAndDeleteNode" LEAVE_NETWORK = "leaveNetwork" LOCK = "lock" LONG_BIP = "longBip" LOWER_CLOSE = "lowerClose" LOWER_DOWN = "lowerDown" LOWER_OPEN = "lowerOpen" LOWER_UP = "lowerUp" MEMORIZED_VOLUME = "memorizedVolume" MUTE = "mute" MUTE_GROUP = "muteGroup" MY = "my" NEXT = "next" NO_PERSON_INSIDE = "noPersonInside" OFF = "off" OFFLINE = "offline" ON = "on" ONLINE = "online" ON_WITH_INTERNAL_TIMER = "onWithInternalTimer" ON_WITH_TIMER = "onWithTimer" OPEN = "open" OPEN_CONFIGURATION = "openConfiguration" OPEN_NETWORK = "openNetwork" OPEN_NETWORK_MANAGEMENT = "openNetworkManagement" OPEN_NETWORK_WITH_COMMISSIONING_MANAGEMENT = ( "openNetworkWithCommissioningManagement" ) OPEN_SLATS = "openSlats" PAIR = "pair" PAIR_ONE_WAY_CONTROLLER = "pairOneWayController" PARTIAL = "partial" PARTIAL_POSITION = "partialPosition" PAUSE = "pause" PERSON_INSIDE = "personInside" PLAY = "play" PLAY_URI = "playURI" PREVIOUS = "previous" REBOOT_MODEM = "rebootModem" REFRESH_ABSENCE_END_DATE = "refreshAbsenceEndDate" REFRESH_ABSENCE_MODE = "refreshAbsenceMode" REFRESH_ABSENCE_SCHEDULING_AVAILABILITY = "refreshAbsenceSchedulingAvailability" REFRESH_ABSENCE_START_DATE = "refreshAbsenceStartDate" REFRESH_ACTIVE_MODE = "refreshActiveMode" REFRESH_AIRPLANE_MODE = "refreshAirplaneMode" REFRESH_ALARM_DELAY = "refreshAlarmDelay" REFRESH_ALARM_STATUS = "refreshAlarmStatus" REFRESH_ANTI_LEGIONELLOSIS = "refreshAntiLegionellosis" REFRESH_AUTO_PROGRAM = "refreshAutoProgram" REFRESH_AWAY_MODE_DURATION = "refreshAwayModeDuration" REFRESH_BATTERY_LEVEL = "refreshBatteryLevel" REFRESH_BATTERY_STATUS = "refreshBatteryStatus" REFRESH_BINDING_TABLE = "refreshBindingTable" REFRESH_BOILER_INSTALLATION_OPTION = "refreshBoilerInstallationOption" REFRESH_BOOST_END_DATE = "refreshBoostEndDate" REFRESH_BOOST_MODE = "refreshBoostMode" REFRESH_BOOST_MODE_DURATION = "refreshBoostModeDuration" REFRESH_BOOST_MODE_PARAMETERS = "refreshBoostModeParameters" REFRESH_BOOST_START_DATE = "refreshBoostStartDate" REFRESH_BOTTOM_TANK_WATER_TEMPERATURE = "refreshBottomTankWaterTemperature" REFRESH_CO2_HISTORY = "refreshCO2History" REFRESH_COMFORT_COOLING_TARGET_TEMPERATURE = ( "refreshComfortCoolingTargetTemperature" ) REFRESH_COMFORT_HEATING_TARGET_TEMPERATURE = ( "refreshComfortHeatingTargetTemperature" ) REFRESH_COMFORT_TARGET_DWH_TEMPERATURE = "refreshComfortTargetDHWTemperature" REFRESH_COMFORT_TEMPERATURE = "refreshComfortTemperature" REFRESH_CONTROLLER_ADDRESS = "refreshControllerAddress" REFRESH_CUMULATED_LOWERING = "refreshCumulatedLowering" REFRESH_CURRENT_ALARM_MODE = "refreshCurrentAlarmMode" REFRESH_CURRENT_OPERATING_MODE = "refreshCurrentOperatingMode" REFRESH_CURRENT_WORKING_RATE = "refreshCurrentWorkingRate" REFRESH_DATE_TIME = "refreshDateTime" REFRESH_DELETION_CANCELATION = "refreshDeletionCancelation" REFRESH_DEROGATED_TARGET_TEMPERATURE = "refreshDerogatedTargetTemperature" REFRESH_DEROGATION = "refreshDerogation" REFRESH_DEROGATION_REMAINING_TIME = "refreshDerogationRemainingTime" REFRESH_DEVICE_SERIAL_NUMBER = "refreshDeviceSerialNumber" REFRESH_DHWCAPACITY = "refreshDHWCapacity" REFRESH_DHWERROR = "refreshDHWError" REFRESH_DHW_MODE = "refreshDHWMode" REFRESH_DRYING_DURATION = "refreshDryingDuration" REFRESH_DRYING_PARAMETERS = "refreshDryingParameters" REFRESH_ECO_COOLING_TARGET_TEMPERATURE = "refreshEcoCoolingTargetTemperature" REFRESH_ECO_HEATING_TARGET_TEMPERATURE = "refreshEcoHeatingTargetTemperature" REFRESH_ECO_TARGET_DWH_TEMPERATURE = "refreshEcoTargetDHWTemperature" REFRESH_ECO_TEMPERATURE = "refreshEcoTemperature" REFRESH_EFFECTIVE_TEMPERATURE_SETPOINT = "refreshEffectiveTemperatureSetpoint" REFRESH_ELECTRICAL_EXTRA_MANAGEMENT = "refreshElectricalExtraManagement" REFRESH_ELECTRIC_ENERGY_CONSUMPTION = "refreshElectricEnergyConsumption" REFRESH_ENERGY_SAVING = "refreshEnergySaving" REFRESH_ERROR_CODE = "refreshErrorCode" REFRESH_EXPECTED_NUMBER_OF_SHOWER = "refreshExpectedNumberOfShower" REFRESH_EXTRACTION_OPTION = "refreshExtractionOption" REFRESH_GPRSREGISTRATION = "refreshGPRSRegistration" REFRESH_GSMREGISTRATION = "refreshGSMRegistration" REFRESH_HEATING_DEROGATION_AVAILABILITY = "refreshHeatingDerogationAvailability" REFRESH_HEATING_LEVEL = "refreshHeatingLevel" REFRESH_HEATING_STATUS = "refreshHeatingStatus" REFRESH_IDENTIFIER = "refreshIdentifier" REFRESH_INSTALLATION = "refreshInstallation" REFRESH_INTRUSION_DETECTED = "refreshIntrusionDetected" REFRESH_LOCAL_LEAD_TIME = "refreshLocalLeadTime" REFRESH_MANUFACTURER_NAME = "refreshManufacturerName" REFRESH_MANUFACTURER_SPECIFIC = "refreshManufacturerSpecific" REFRESH_MAXIMUM_COOLING_TARGET_TEMPERATURE = ( "refreshMaximumCoolingTargetTemperature" ) REFRESH_MAXIMUM_HEATING_TARGET_TEMPERATURE = ( "refreshMaximumHeatingTargetTemperature" ) REFRESH_MAXIMUM_TARGET_TEMPERATURE = "refreshMaximumTargetTemperature" REFRESH_MEMORIZED_1_ORIENTATION = "refreshMemorized1Orientation" REFRESH_MEMORIZED_1_POSITION = "refreshMemorized1Position" REFRESH_MIDDLE_WATER_TEMPERATURE = "refreshMiddleWaterTemperature" REFRESH_MIDDLE_WATER_TEMPERATURE_IN = "refreshMiddleWaterTemperatureIn" REFRESH_MINIMUM_COOLING_TARGET_TEMPERATURE = ( "refreshMinimumCoolingTargetTemperature" ) REFRESH_MINIMUM_HEATING_TARGET_TEMPERATURE = ( "refreshMinimumHeatingTargetTemperature" ) REFRESH_MODEL = "refreshModel" REFRESH_MODE_SETTINGS = "refreshModeSettings" REFRESH_NATIVE_FUNCTIONAL_LEVEL = "refreshNativeFunctionalLevel" REFRESH_NEIGHBOR_TABLE = "refreshNeighborTable" REFRESH_NETWORK = "refreshNetwork" REFRESH_OCCUPANCY = "refreshOccupancy" REFRESH_ON_OFF_STATE = "refreshOnOffState" REFRESH_OPERATING_MODE = "refreshOperatingMode" REFRESH_OPERATING_MODE_CAPABILITIES = "refreshOperatingModeCapabilities" REFRESH_OPERATING_RANGE = "refreshOperatingRange" REFRESH_OPERATING_TIME = "refreshOperatingTime" REFRESH_OPERATOR_CONFIG = "refreshOperatorConfig" REFRESH_OPERATOR_NAME = "refreshOperatorName" REFRESH_PASS_APC_COOLING_MODE = "refreshPassAPCCoolingMode" REFRESH_PASS_APC_COOLING_PROFILE = "refreshPassAPCCoolingProfile" REFRESH_PASS_APC_HEATING_MODE = "refreshPassAPCHeatingMode" REFRESH_PASS_APC_HEATING_PROFILE = "refreshPassAPCHeatingProfile" REFRESH_PEAK_NOTICE = "refreshPeakNotice" REFRESH_PEAK_WARNING = "refreshPeakWarning" REFRESH_POD_MODE = "refreshPodMode" REFRESH_POWER_AND_TENSION = "refreshPowerAndTension" REFRESH_POWER_HEAT_ELECTRICAL = "refreshPowerHeatElectrical" REFRESH_PRODUCT_TYPE = "refreshProductType" REFRESH_PROGRAMMING_SLOTS = "refreshProgrammingSlots" REFRESH_RATE_MANAGEMENT = "refreshRateManagement" REFRESH_RELATIVE_HUMIDITY = "refreshRelativeHumidity" REFRESH_ROOM_DELETION_THRESHOLD = "refreshRoomDeletionThreshold" REFRESH_ROUTING_TABLE = "refreshRoutingTable" REFRESH_RSSILEVEL = "refreshRSSILevel" REFRESH_SECURED_POSITION_TEMPERATURE = "refreshSecuredPositionTemperature" REFRESH_SENSORS_STATE = "refreshSensorsState" REFRESH_SETPOINT_LOWERING_TEMPERATURE_IN_PROG_MODE = ( "refreshSetpointLoweringTemperatureInProgMode" ) REFRESH_SET_POINT_MODE = "refreshSetPointMode" REFRESH_SIMCARD_STATUS = "refreshSIMCardStatus" REFRESH_SIREN_STATUS = "refreshSirenStatus" REFRESH_SMART_GRID_OPTION = "refreshSmartGridOption" REFRESH_SSVERROR_6 = "refreshSSVError6" REFRESH_STATE = "refreshState" REFRESH_SYNCHRONISATION_REQUEST = "refreshSynchronisationRequest" REFRESH_TARGET_DWH_TEMPERATURE = "refreshTargetDHWTemperature" REFRESH_TARGET_TEMPERATURE = "refreshTargetTemperature" REFRESH_TEMPERATURE = "refreshTemperature" REFRESH_TEMPERATURE_PROBE_CALIBRATION_OFFSET = ( "refreshTemperatureProbeCalibrationOffset" ) REFRESH_THERMAL_SCHEDULING_AVAILABILITY = "refreshThermalSchedulingAvailability" REFRESH_THERMOSTAT_SETPOINT_SUPPORTED = "refreshThermostatSetpointSupported" REFRESH_THERMOSTAT_SET_POINT = "refreshThermostatSetPoint" REFRESH_TIME_PROGRAM = "refreshTimeProgram" REFRESH_TIME_PROGRAM_BY_ID = "refreshTimeProgramById" REFRESH_TOWEL_DRYER_TEMPORARY_STATE = "refreshTowelDryerTemporaryState" REFRESH_TOWEL_DRYER_TIME_PROGRAM = "refreshTowelDryerTimeProgram" REFRESH_UPDATE_STATUS = "refreshUpdateStatus" REFRESH_VENTILATION_CONFIGURATION_MODE = "refreshVentilationConfigurationMode" REFRESH_VENTILATION_STATE = "refreshVentilationState" REFRESH_WAKE_UP_INTERVAL = "refreshWakeUpInterval" REFRESH_WATER_CONSUMPTION = "refreshWaterConsumption" REFRESH_WATER_TARGET_TEMPERATURE = "refreshWaterTargetTemperature" REFRESH_WATER_TEMPERATURE = "refreshWaterTemperature" REFRESH_ZONES_NUMBER = "refreshZonesNumber" REFRESH_ZONES_PASS_APC_COOLING_PROFILE = "refreshZonesPassAPCCoolingProfile" REFRESH_ZONES_PASS_APC_HEATING_PROFILE = "refreshZonesPassAPCHeatingProfile" REFRESH_ZONES_TARGET_TEMPERATURE = "refreshZonesTargetTemperature" REFRESH_ZONES_TEMPERATURE = "refreshZonesTemperature" REFRESH_ZONES_TEMPERATURE_SENSOR_AVAILABILITY = ( "refreshZonesTemperatureSensorAvailability" ) REFRESH_ZONES_THERMAL_CONFIGURATION = "refreshZonesThermalConfiguration" REMOVE_FAILED_NODE = "removeFailedNode" REMOVE_LOCK_LEVEL = "removeLockLevel" REPLACE_FAILED_DEVICE = "replaceFailedDevice" RESET = "reset" RESET_LOCK_LEVELS = "resetLockLevels" RESET_NETWORK_SECURITY = "resetNetworkSecurity" RESET_VENTILATION = "resetVentilation" REST = "rest" RESUME = "resume" REWIND = "rewind" RIGHT = "right" RING = "ring" RING_WITH_DOUBLE_SIMPLE_SEQUENCE = "ringWithDoubleSimpleSequence" RING_WITH_SINGLE_SIMPLE_SEQUENCE = "ringWithSingleSimpleSequence" RING_WITH_THREE_SIMPLE_SEQUENCE = "ringWithThreeSimpleSequence" RUN_MANUFACTURER_SETTINGS_COMMAND = "runManufacturerSettingsCommand" SAVE_ALIAS = "saveAlias" SEND_IOKEY = "sendIOKey" SEND_PRIVATE = "sendPrivate" SET_ABSENCE_COOLING_TARGET_TEMPERATURE = "setAbsenceCoolingTargetTemperature" SET_ABSENCE_END_DATE = "setAbsenceEndDate" SET_ABSENCE_END_DATE_TIME = "setAbsenceEndDateTime" SET_ABSENCE_HEATING_TARGET_TEMPERATURE = "setAbsenceHeatingTargetTemperature" SET_ABSENCE_MODE = "setAbsenceMode" SET_ABSENCE_START_DATE = "setAbsenceStartDate" SET_ABSENCE_START_DATE_TIME = "setAbsenceStartDateTime" SET_ACTIVE_COOLING_TIME_PROGRAM = "setActiveCoolingTimeProgram" SET_ACTIVE_HEATING_TIME_PROGRAM = "setActiveHeatingTimeProgram" SET_ACTIVE_MODE = "setActiveMode" SET_AIRPLANE_MODE = "setAirplaneMode" SET_AIR_DEMAND_MODE = "setAirDemandMode" SET_ALARM_DELAY = "setAlarmDelay" SET_ALARM_STATUS = "setAlarmStatus" SET_ALL_MODE_TEMPERATURES = "setAllModeTemperatures" SET_ANTI_LEGIONELLOSIS = "setAntiLegionellosis" SET_AUTO_MANU_MODE = "setAutoManuMode" SET_AWAY_MODE_DURATION = "setAwayModeDuration" SET_BOILER_INSTALLATION_OPTION = "setBoilerInstallationOption" SET_BOOST_END_DATE = "setBoostEndDate" SET_BOOST_MODE = "setBoostMode" SET_BOOST_MODE_DURATION = "setBoostModeDuration" SET_BOOST_ON_OFF_STATE = "setBoostOnOffState" SET_BOOST_START_DATE = "setBoostStartDate" SET_CALENDAR = "setCalendar" SET_CIE_COLOR_SPACE_XY = "setCieColorSpaceXY" SET_CLOSURE = "setClosure" SET_CLOSURE_AND_LINEAR_SPEED = "setClosureAndLinearSpeed" SET_CLOSURE_AND_ORIENTATION = "setClosureAndOrientation" SET_COLOR_TEMPERATURE = "setColorTemperature" SET_COMFORT_COOLING_TARGET_TEMPERATURE = "setComfortCoolingTargetTemperature" SET_COMFORT_HEATING_TARGET_TEMPERATURE = "setComfortHeatingTargetTemperature" SET_COMFORT_TARGET_DHW_TEMPERATURE = "setComfortTargetDHWTemperature" SET_COMFORT_TARGET_TEMPERATURE = "setComfortTargetTemperature" SET_COMFORT_TEMPERATURE = "setComfortTemperature" SET_COMMUNICATION_TEST = "setCommunicationTest" SET_CONFIG_STATE = "setConfigState" SET_CONTROL_DHW = "setControlDHW" SET_CONTROL_DHW_SETTING_TEMPERATURE = "setControlDHWSettingTemperature" SET_COOLING_ON_OFF = "setCoolingOnOffState" SET_COOLING_TARGET_TEMPERATURE = "setCoolingTargetTemperature" SET_COUNTRY_CODE = "setCountryCode" SET_CTB = "setCTB" SET_CURRENT_OPERATING_MODE = "setCurrentOperatingMode" SET_DATE_TIME = "setDateTime" SET_DELETION_CANCELATION = "setDeletionCancelation" SET_DEPLOYMENT = "setDeployment" SET_DEROGATED_TARGET_TEMPERATURE = "setDerogatedTargetTemperature" SET_DEROGATION = "setDerogation" SET_DEROGATION_ON_OFF_STATE = "setDerogationOnOffState" SET_DEROGATION_TIME = "setDerogationTime" SET_DHW_MODE = "setDHWMode" SET_DHW_ON_OFF_STATE = "setDHWOnOffState" SET_DRYING_DURATION = "setDryingDuration" SET_ECO_COOLING_TARGET_TEMPERATURE = "setEcoCoolingTargetTemperature" SET_ECO_HEATING_TARGET_TEMPERATURE = "setEcoHeatingTargetTemperature" SET_ECO_TARGET_DHW_TEMPERATURE = "setEcoTargetDHWTemperature" SET_ECO_TARGET_TEMPERATURE = "setEcoTargetTemperature" SET_ECO_TEMPERATURE = "setEcoTemperature" SET_ELECTRICAL_EXTRA_MANAGEMENT = "setElectricalExtraManagement" SET_EXPECTED_NUMBER_OF_SHOWER = "setExpectedNumberOfShower" SET_EXPECTED_PRESENCE = "setExpectedPresence" SET_EXTRACTION_OPTION = "setExtractionOption" SET_FORCE_HEATING = "setForceHeating" SET_FROST_PROTECTION_TARGET_TEMPERATURE = "setFrostProtectionTargetTemperature" SET_GROUP_VOLUME = "setGroupVolume" SET_HALTED_TARGET_TEMPERATURE = "setHaltedTargetTemperature" SET_HEATING_COOLING_AUTO_SWITCH = "setHeatingCoolingAutoSwitch" SET_HEATING_LEVEL = "setHeatingLevel" SET_HEATING_LEVEL_FOR_TRIGGER = "setHeatingLevelForTrigger" SET_HEATING_LEVEL_WITH_TIMER = "setHeatingLevelWithTimer" SET_HEATING_ON_OFF = "setHeatingOnOffState" SET_HEATING_TARGET_TEMPERATURE = "setHeatingTargetTemperature" SET_HOLIDAYS = "setHolidays" SET_HOLIDAYS_TARGET_TEMPERATURE = "setHolidaysTargetTemperature" SET_HSB = "setHSB" SET_HUE_AND_SATURATION = "setHueAndSaturation" SET_INSTALLATION = "setInstallation" SET_INTENSITY = "setIntensity" SET_INTENSITY_WITH_TIMER = "setIntensityWithTimer" SET_INTERNAL_TIMER = "setInternalTimer" SET_INTRUSION_DETECTED = "setIntrusionDetected" SET_LEVEL = "setLevel" SET_LIGHTING_LED_MODEM_MODE = "setLightingLedModemMode" SET_LIGHTING_LED_POD_MODE = "setLightingLedPodMode" SET_LOWER_CLOSURE = "setLowerClosure" SET_LOWER_POSITION = "setLowerPosition" SET_MANU_AND_SET_POINT_MODES = "setManuAndSetPointModes" SET_MAXIMUM_COOLING_TARGET_TEMPERATURE = "setMaximumCoolingTargetTemperature" SET_MAXIMUM_HEATING_TARGET_TEMPERATURE = "setMaximumHeatingTargetTemperature" SET_MAXIMUM_TEMPERATURE = "setMaximumTemperature" SET_MEDIA_ELEMENT = "setMediaElement" SET_MEMORIZED_1_ORIENTATION = "setMemorized1Orientation" SET_MEMORIZED_1_POSITION = "setMemorized1Position" SET_MEMORIZED_SIMPLE_VOLUME = "setMemorizedSimpleVolume" SET_MINIMUM_COOLING_TARGET_TEMPERATURE = "setMinimumCoolingTargetTemperature" SET_MINIMUM_HEATING_TARGET_TEMPERATURE = "setMinimumHeatingTargetTemperature" SET_MINIMUM_TEMPERATURE = "setMinimumTemperature" SET_MODE = "setMode" SET_MODEM_LED_OFF = "setModemLedOff" SET_MODEM_LED_ON = "setModemLedOn" SET_MODE_TEMPERATURE = "setModeTemperature" SET_NAME = "setName" SET_NATIVE_LEVELS_LIST = "setNativeLevelsList" SET_OCCUPANCY = "setOccupancy" SET_OCCUPANCY_ACTIVATION = "setOccupancyActivation" SET_ON_OFF = "setOnOff" SET_OPEN_WINDOW_DETECTION_ACTIVATION = "setOpenWindowDetectionActivation" SET_OPERATING_MODE = "setOperatingMode" SET_OPERATING_RANGE = "setOperatingRange" SET_OPERATOR_CONFIG = "setOperatorConfig" SET_ORIENTATION = "setOrientation" SET_PASS_APC_COOLING_MODE = "setPassAPCCoolingMode" SET_PASS_APC_DHW_MODE = "setPassAPCDHWMode" SET_PASS_APC_HEATING_MODE = "setPassAPCHeatingMode" SET_PASS_APC_OPERATING_MODE = "setPassAPCOperatingMode" SET_PEAK_NOTICE = "setPeakNotice" SET_PEAK_WARNING = "setPeakWarning" SET_PEDESTRIAN_POSITION = "setPedestrianPosition" SET_PICTO_VALUE = "setPictoValue" SET_POD_LED_OFF = "setPodLedOff" SET_POD_LED_ON = "setPodLedOn" SET_POSITION = "setPosition" SET_POSITION_AND_LINEAR_SPEED = "setPositionAndLinearSpeed" SET_PREVIOUS_TARGET_TEMPERATURE = "setPreviousTargetTemperature" SET_PROGRAMMING_SLOTS = "setProgrammingSlots" SET_RATE_MANAGEMENT = "setRateManagement" SET_RGB = "setRGB" SET_ROOM_DELETION_THRESHOLD = "setRoomDeletionThreshold" SET_SCHEDULING_TYPE = "setSchedulingType" SET_SECURED_ORIENTATION = "setSecuredOrientation" SET_SECURED_POSITION = "setSecuredPosition" SET_SECURED_POSITION_TEMPERATURE = "setSecuredPositionTemperature" SET_SETPOINT_LOWERING_TEMPERATURE_IN_PROG_MODE = ( "setSetpointLoweringTemperatureInProgMode" ) SET_SET_POINT_TYPE_AND_TARGET_TEMPERATURE = "setSetPointTypeAndTargetTemperature" SET_SIMPIN_CODE = "setSIMPinCode" SET_SIREN_STATUS = "setSirenStatus" SET_SMART_GRID_OPTION = "setSmartGridOption" SET_TARGET_ALARM_MODE = "setTargetAlarmMode" SET_TARGET_DHW_TEMPERATURE = "setTargetDHWTemperature" SET_TARGET_INFRA_CONFIG = "setTargetInfraConfig" SET_TARGET_MODE = "setTargetMode" SET_TARGET_MODE_ALIAS = "setTargetModeAlias" SET_TARGET_TEMPERATURE = "setTargetTemperature" SET_TARGET_WAKE_UP_INTERVAL = "setTargetWakeUpInterval" SET_TEMPERATURE_PROBE_CALIBRATION_OFFSET = "setTemperatureProbeCalibrationOffset" SET_THERMOSTAT_SETPOINT = "setThermostatSetpoint" SET_THERMOSTAT_SETTING_CONTROL_ZONE_1 = "setThermostatSettingControlZone1" SET_TIMELINE_POSITION = "setTimelinePosition" SET_TIME_PROGRAM = "setTimeProgram" SET_TIME_PROGRAM_BY_ID = "setTimeProgramById" SET_TOWEL_DRYER_BOOST_MODE_DURATION = "setTowelDryerBoostModeDuration" SET_TOWEL_DRYER_OPERATING_MODE = "setTowelDryerOperatingMode" SET_TOWEL_DRYER_TEMPORARY_STATE = "setTowelDryerTemporaryState" SET_TOWEL_DRYER_TIME_PROGRAM = "setTowelDryerTimeProgram" SET_TWINNING_EXIT = "setTwinningExit" SET_UPPER_AND_LOWER_CLOSURE = "setUpperAndLowerClosure" SET_UPPER_AND_LOWER_POSITION = "setUpperAndLowerPosition" SET_UPPER_CLOSURE = "setUpperClosure" SET_UPPER_POSITION = "setUpperPosition" SET_VALVE_SETTINGS = "setValveSettings" SET_VENTILATION_CONFIGURATION_MODE = "setVentilationConfigurationMode" SET_VENTILATION_MODE = "setVentilationMode" SET_VOLUME = "setVolume" SET_WAKE_UP_INTERVAL = "setWakeUpInterval" SET_WATER_TARGET_TEMPERATURE = "setWaterTargetTemperature" SET_WATER_TEMPERATURE = "setWaterTemperature" SET_WEATHER_STATUS = "setWeatherStatus" SET_WIFI_MODE = "setWifiMode" SET_XYB = "setXYB" SHARE_NETWORK = "shareNetwork" SHORT_BIP = "shortBip" SIREN = "siren" STANDARD = "standard" START = "start" START_EXCLUSION = "startExclusion" START_EXCLUSION_WITH_MODE = "startExclusionWithMode" START_IDENTIFY = "startIdentify" START_INCLUSION = "startInclusion" START_INCLUSION_WITH_MODE = "startInclusionWithMode" START_INCLUSION_WITH_MODE_AND_SECURITY_LEVEL = ( "startInclusionWithModeAndSecurityLevel" ) START_LEARN = "startLearn" START_LEARN_WITH_MODE = "startLearnWithMode" STOP = "stop" STOP_BLINK_MODEM_LED = "stopBlinkModemLed" STOP_EXCLUSION = "stopExclusion" STOP_IDENTIFY = "stopIdentify" STOP_INCLUSION = "stopInclusion" STOP_LEARN = "stopLearn" TAKE_PICTURE = "takePicture" TAKE_PICTURE_SEQUENCE = "takePictureSequence" TEST = "test" TILT = "tilt" TILT_DOWN = "tiltDown" TILT_NEGATIVE = "tiltNegative" TILT_POSITIVE = "tiltPositive" TILT_UP = "tiltUp" TRESPASS = "trespass" UNBIND = "unbind" UNDEPLOY = "undeploy" UNINSTALLED = "uninstalled" UNLOCK = "unlock" UNMUTE = "unmute" UNMUTE_GROUP = "unmuteGroup" UNPAIR_ALL_ONE_WAY_CONTROLLERS = "unpairAllOneWayControllers" UNPAIR_ALL_ONE_WAY_CONTROLLERS_AND_DELETE_NODE = ( "unpairAllOneWayControllersAndDeleteNode" ) UNPAIR_ONE_WAY_CONTROLLER = "unpairOneWayController" UP = "up" UPDATE = "update" UPPER_CLOSE = "upperClose" UPPER_DOWN = "upperDown" UPPER_OPEN = "upperOpen" UPPER_UP = "upperUp" WINK = "wink" @unique class OverkizCommandParam(StrEnum): """Parameter used by Overkiz commands and/or states.""" A = "A" ABSENCE = "absence" ACCUMULATION_DOMESTIC_HOT_WATER = "accumulationDomesticHotWater" ACTIVE = "active" ADJUSTMENT = "adjustment" AIR_CONDITIONING = "airConditioning" ALERT = "alert" ALWAYS = "always" ANTIFREEZE = "antifreeze" ARMED = "armed" ARMED_DAY = "armedDay" ARMED_NIGHT = "armedNight" AT_HOME_MODE = "atHomeMode" AUTO = "auto" AUTOCHANGEOVER = "autochangeover" AUTOCOOLING = "autocooling" AUTOHEATING = "autoheating" AUTO_COOLING = "autoCooling" AUTO_HEATING = "autoHeating" AUTO_MODE = "autoMode" AVAILABLE = "available" AWAY = "away" AWAYCOOL = "awaycool" AWAYHEAT = "awayheat" AWAY_MODE = "awayMode" B = "B" BASE = "base" BASIC = "basic" BOILER = "boiler" BOILER_OPTIMISING = "boilerOptimising" BOILER_PRIORITY = "boilerPriority" BOOST = "boost" BOTH = "both" BY_PASS = "by_pass" C = "C" CIRCULATOR = "circulator" CLEAN = "clean" CLOSE = "close" CLOSED = "closed" COMFORT = "comfort" COMFORT_1 = "comfort-1" COMFORT_2 = "comfort-2" COMFORT_LEVEL1 = "comfortLevel1" COMFORT_LEVEL2 = "comfortLevel2" COMFORT_LEVEL3 = "comfortLevel3" COMFORT_LEVEL4 = "comfortLevel4" CONVECTOR = "convector" COOLING = "cooling" CT = "ct" CYCLIC = "cyclic" DATE = "date" DATE_SCHEDULING = "dateScheduling" DAY_OFF = "day-off" DEACTIVE = "deactive" DEAD = "dead" DEHUMIDIFY = "dehumidify" DELETION_CANCELATION = "deletion cancelation" # value with space DEROGATION = "derogation" DETECTED = "detected" DIRTY = "dirty" DISABLE = "disable" DISABLED = "disabled" DISARMED = "disarmed" DOUBLE_FLOW_CONTROLLED_MECHANICAL_VENTILATION = ( "doubleFlowControlledMechanicalVentilation" ) DOUBLE_PRESS = "doublePress" DOWN = "down" DRY = "dry" DRYING = "drying" ECO = "eco" ENABLE = "enable" ENABLED = "enabled" ENERGYCOOL = "energycool" ENERGYHEAT = "energyheat" ENERGY_DEMAND_STATUS = "energyDemandStatus" ENVIRONMENT_PROTECTION = "environmentProtection" EXTERNAL = "external" EXTERNAL_GATEWAY = "externalGateway" EXTERNAL_SCHEDULING = "externalScheduling" EXTERNAL_SETPOINT = "externalSetpoint" EXTRA_BOILER = "extraBoiler" EXTRA_SOLAR = "extraSolar" FAILED = "failed" FALSE = "false" FAN = "fan" FAST_EXTRACTION_SPEED = "fastExtractionSpeed" FINISHED = "finished" FORBIDDEN = "forbidden" FORWARD = "forward" FREE = "free" FREEZE_MODE = "freezeMode" FROSTPROTECTION = "frostprotection" FULL = "full" FULLPOWER = "fullpower" FULL_CLOSED = "full_closed" FULL_OPEN = "full_open" FURNACE = "furnace" FURTHER_NOTICE = "further_notice" GEOFENCING_MODE = "geofencingMode" GOOD = "good" HEATER = "heater" HEATING = "heating" HEATING_AND_COOLING = "heatingAndCooling" HEATING_AND_COOLING_COMMON_SCHEDULING = "heatingAndCoolingCommonScheduling" HEATING_AND_COOLING_SEPARATED_SCHEDULING = "heatingAndCoolingSeparatedScheduling" HEAT_PUMP = "heatPump" HEAT_PUMP_OPTIMISING = "heatPumpOptimising" HEAT_PUMP_PRIORITY = "heatPumpPriority" HI = "hi" HIGH = "high" HIGHEST = "highest" HIGH_DEMAND = "high demand" # not a typo... HOLIDAYS = "holidays" HORIZONTAL = "horizontal" HS = "hs" HUMAN_PROTECTION = "humanProtection" HYBRID = "hybrid" INACTIVE = "inactive" INCREASE = "increase" INTERNAL = "internal" INTERNAL_SCHEDULING = "internalScheduling" IN_PROGRESS = "inProgress" KEPT = "kept" KO = "KO" LO = "lo" LOCAL_USER = "localUser" LOCKED = "locked" LOCK_KEY = "lock_key" LONG_PEAK = "long peak" # value with space LONG_PEAK_WARNING = "long peak warning" # value with space LONG_PRESS = "longPress" LOST = "lost" LOW = "low" LOWSPEED = "lowspeed" LOW_BATTERY = "lowBattery" LOW_EXTRACTION_SPEED = "lowExtractionSpeed" LSC = "LSC" MAINTENANCE_REQUIRED = "maintenanceRequired" MANU = "manu" MANUAL = "manual" MANUAL_ECO_ACTIVE = "manualEcoActive" MANUAL_ECO_INACTIVE = "manualEcoInactive" MANUAL_MODE = "manualMode" MAX = "max" MAX_SETPOINT = "max_setpoint" MED = "med" MEDIUM = "medium" MEMORIZED_VOLUME = "memorizedVolume" MIN_SETPOINT = "min_setpoint" MOIST = "moist" MYSELF = "myself" NEXT_MODE = "nextMode" NO = "no" NONE = "none" NORMAL = "normal" NOT_DETECTED = "notDetected" NO_DEFECT = "noDefect" NO_DELETION_CANCELATION = "no deletion cancelation" # value with space NO_EXTRACTION = "noExtraction" NO_PEAK = "no peak" # value with space NO_PERSON_INSIDE = "noPersonInside" NO_WARNING = "no warning" # value with space NUMBER_OF_DAYS_SCHEDULING = "numberOfDaysScheduling" OFF = "off" OFFLINE = "offline" OK = "OK" ON = "on" ONLINE = "online" ONLY_THERMODYNAMIC = "onlyThermodynamic" ON_OFF_LIGHT = "onOffLight" OPEN = "open" OPENED = "opened" OPEN_WINDOW = "open_window" PAC24H_ELEC24H = "pac24h_elec24h" PAC_PROG_ELEC_PROG = "pacProg_elecProg" PAIRING = "pairing" PARTIAL = "partial" PARTIAL_1 = "partial1" PARTIAL_2 = "partial2" PAUSE = "pause" PEDESTRIAN = "pedestrian" PENDING = "pending" PERFORMANCE = "performance" PERMANENT_HEATING = "permanentHeating" PERSON_INSIDE = "personInside" PLAYING = "playing" PRESSED = "pressed" PROG = "prog" PROGRAM = "program" RAIN = "rain" RECOMMENDED = "recommended" REGISTERED = "registered" RELAUNCH = "relaunch" RESET = "reset" REWIND = "rewind" SAAC = "SAAC" SECURED = "secured" SECURITY = "security" SFC = "SFC" SHORT = "short" SHORT_PEAK = "short peak" # value with space SHORT_PEAK_WARNING = "short peak warning" # value with space SILENCE = "silence" SILENT = "silent" SIMPLE_PRESS = "simplePress" SINGLE_FLOW_CONTROLLED_MECHANICAL_VENTILATION = ( "singleFlowControlledMechanicalVentilation" ) SLEEPING_MODE = "sleepingMode" SOS = "sos" STANDARD = "standard" STANDBY = "standby" STARTED = "started" STOP = "stop" STOPPED = "stopped" SUDDEN_DROP_MODE = "suddenDropMode" TEMPERATURE = "temperature" TEMPERATURE_OFFSET = "temperature_offset" THERMODYNAMIC_DOMESTIC_HOT_WATER = "thermodynamicDomesticHotWater" TILT = "tilt" TILT_NEGATIVE = "tiltNegative" TILT_POSITIVE = "tiltPositive" TIMER = "timer" TOP = "top" TOTAL = "total" TRIPLE_PRESS = "triplePress" TRUE = "true" UNAVAILABLE = "unavailable" UNDETECTED = "undetected" UNINSTALLED = "uninstalled" UNKNOWN = "unknown" UNSUITABLE = "unsuitable" UP = "up" UPS = "UPS" USER = "user" USER_LEVEL1 = "userLevel1" USER_LEVEL2 = "userLevel2" VERTICAL = "vertical" VERY_LONG_PRESS = "veryLongPress" VERY_LOW = "verylow" WANTED = "wanted" WIND = "wind" XY = "xy" ZONE_1 = "zone1" ZONE_2 = "zone2" ZONE_CONTROLLER = "zoneController" @unique class CommandMode(StrEnum): """Execution mode flags for commands (e.g., high priority or geolocated).""" HIGH_PRIORITY = "highPriority" GEOLOCATED = "geolocated" INTERNAL = "internal"