Public Attributes | |
| data | |
| hvac_mode | |
| preset_mode | |
| thermostat | |
| thermostat_index | |
| update_without_throttle | |
| vacation | |
Public Attributes inherited from homeassistant.components.climate.ClimateEntity | |
| hvac_mode | |
Public Attributes inherited from homeassistant.helpers.entity.Entity | |
| device_entry | |
| entity_id | |
| hass | |
| parallel_updates | |
| platform | |
| registry_entry | |
Private Member Functions | |
| list[str] | _sensor_devices_in_preset_mode (self, str|None preset_mode) |
| list[str] | _sensors_in_preset_mode (self, str|None preset_mode) |
Private Attributes | |
| _attr_hvac_modes | |
| _attr_unique_id | |
| _hass | |
| _last_active_hvac_mode | |
| _last_hvac_mode_before_aux_heat | |
| _preset_modes | |
| _sensors | |
Static Private Attributes | |
| list | _attr_fan_modes = [FAN_AUTO, FAN_ON] |
| bool | _attr_has_entity_name = True |
| _attr_max_humidity = DEFAULT_MAX_HUMIDITY | |
| _attr_min_humidity = DEFAULT_MIN_HUMIDITY | |
| _attr_name = None | |
| _attr_precision = PRECISION_TENTHS | |
| _attr_temperature_unit = UnitOfTemperature.FAHRENHEIT | |
| string | _attr_translation_key = "ecobee" |
| bool | _enable_turn_on_off_backwards_compatibility = False |
| _unrecorded_attributes = frozenset({ATTR_AVAILABLE_SENSORS, ATTR_ACTIVE_SENSORS}) | |
Additional Inherited Members | |
Static Public Attributes inherited from homeassistant.components.climate.ClimateEntity | |
| bool | |
| ClimateEntityFeature | |
| float | |
| None | |
Static Public Attributes inherited from homeassistant.helpers.entity.Entity | |
| bool | |
| EntityPlatform | |
| HomeAssistant | |
| None | |
| StateInfo | |
| StateType | |
| str | |
A thermostat class for Ecobee.
Definition at line 346 of file climate.py.
| None homeassistant.components.ecobee.climate.Thermostat.__init__ | ( | self, | |
| EcobeeData | data, | ||
| int | thermostat_index, | ||
| dict | thermostat, | ||
| HomeAssistant | hass | ||
| ) |
Initialize the thermostat.
Definition at line 359 of file climate.py.
|
private |
Return current sensor device name_by_user or name used in climate.
Definition at line 920 of file climate.py.
|
private |
Return current sensors used in climate.
Definition at line 911 of file climate.py.
| list homeassistant.components.ecobee.climate.Thermostat.active_sensor_devices_in_preset_mode | ( | self | ) |
Return the currently active/participating sensor devices.
Definition at line 640 of file climate.py.
| list homeassistant.components.ecobee.climate.Thermostat.active_sensors_in_preset_mode | ( | self | ) |
Return the currently active/participating sensors.
Definition at line 631 of file climate.py.
| None homeassistant.components.ecobee.climate.Thermostat.async_update | ( | self | ) |
Get the latest state from the thermostat.
Definition at line 391 of file climate.py.
| bool homeassistant.components.ecobee.climate.Thermostat.available | ( | self | ) |
Return if device is available.
Reimplemented from homeassistant.helpers.entity.Entity.
Definition at line 403 of file climate.py.
Return ecobee API comfort settings.
Definition at line 706 of file climate.py.
| def homeassistant.components.ecobee.climate.Thermostat.create_vacation | ( | self, | |
| service_data | |||
| ) |
Create a vacation with user-specified parameters.
Definition at line 962 of file climate.py.
| int | None homeassistant.components.ecobee.climate.Thermostat.current_humidity | ( | self | ) |
Return the current humidity.
Reimplemented from homeassistant.components.climate.ClimateEntity.
Definition at line 542 of file climate.py.
| float homeassistant.components.ecobee.climate.Thermostat.current_temperature | ( | self | ) |
Return the current temperature.
Reimplemented from homeassistant.components.climate.ClimateEntity.
Definition at line 437 of file climate.py.
| def homeassistant.components.ecobee.climate.Thermostat.delete_vacation | ( | self, | |
| vacation_name | |||
| ) |
Delete a vacation with the specified name.
Definition at line 1010 of file climate.py.
| DeviceInfo homeassistant.components.ecobee.climate.Thermostat.device_info | ( | self | ) |
Return device information for this ecobee thermostat.
Reimplemented from homeassistant.helpers.entity.Entity.
Definition at line 420 of file climate.py.
| dict[str, Any] | None homeassistant.components.ecobee.climate.Thermostat.extra_state_attributes | ( | self | ) |
Return device specific state attributes.
Reimplemented from homeassistant.helpers.entity.Entity.
Definition at line 582 of file climate.py.
| def homeassistant.components.ecobee.climate.Thermostat.fan | ( | self | ) |
Return the current fan status.
Definition at line 492 of file climate.py.
| def homeassistant.components.ecobee.climate.Thermostat.fan_mode | ( | self | ) |
Return the fan setting.
Reimplemented from homeassistant.components.climate.ClimateEntity.
Definition at line 499 of file climate.py.
| bool homeassistant.components.ecobee.climate.Thermostat.has_humidifier_control | ( | self | ) |
Return true if humidifier connected to thermostat and set to manual/on mode.
Definition at line 466 of file climate.py.
| def homeassistant.components.ecobee.climate.Thermostat.hold_hours | ( | self | ) |
Return user preference setting for hold duration in hours.
Definition at line 949 of file climate.py.
| def homeassistant.components.ecobee.climate.Thermostat.hold_preference | ( | self | ) |
Return user preference setting for hold time.
Definition at line 933 of file climate.py.
| def homeassistant.components.ecobee.climate.Thermostat.hvac_action | ( | self | ) |
Return current HVAC action. Ecobee returns a CSV string with different equipment that is active. We are prioritizing any heating/cooling equipment, otherwise look at drying/fanning. Idle if nothing going on. We are unable to map all actions to HA equivalents.
Reimplemented from homeassistant.components.climate.ClimateEntity.
Definition at line 550 of file climate.py.
| def homeassistant.components.ecobee.climate.Thermostat.hvac_mode | ( | self | ) |
Return current operation.
Reimplemented from homeassistant.components.climate.ClimateEntity.
Definition at line 537 of file climate.py.
Return current preset mode.
Reimplemented from homeassistant.components.climate.ClimateEntity.
Definition at line 504 of file climate.py.
Return available preset modes.
Reimplemented from homeassistant.components.climate.ClimateEntity.
Definition at line 696 of file climate.py.
| list homeassistant.components.ecobee.climate.Thermostat.remote_sensor_devices | ( | self | ) |
Return the remote sensor device name_by_user or name for the thermostat.
Definition at line 603 of file climate.py.
| list homeassistant.components.ecobee.climate.Thermostat.remote_sensor_ids_names | ( | self | ) |
Return the remote sensor device id and name_by_user for the thermostat.
Definition at line 613 of file climate.py.
| list homeassistant.components.ecobee.climate.Thermostat.remote_sensors | ( | self | ) |
Return the remote sensor names of the thermostat.
Definition at line 597 of file climate.py.
| def homeassistant.components.ecobee.climate.Thermostat.resume_program | ( | self, | |
| resume_all | |||
| ) |
Resume the thermostat schedule program.
Definition at line 817 of file climate.py.
| def homeassistant.components.ecobee.climate.Thermostat.set_auto_temp_hold | ( | self, | |
| heat_temp, | |||
| cool_temp | |||
| ) |
Set temperature hold in auto mode.
Definition at line 713 of file climate.py.
| def homeassistant.components.ecobee.climate.Thermostat.set_dst_mode | ( | self, | |
| dst_enabled | |||
| ) |
Enable/disable automatic daylight savings time.
Definition at line 1028 of file climate.py.
| def homeassistant.components.ecobee.climate.Thermostat.set_fan_min_on_time | ( | self, | |
| fan_min_on_time | |||
| ) |
Set the minimum fan on time.
Definition at line 812 of file climate.py.
Set the fan mode. Valid values are "on" or "auto".
Reimplemented from homeassistant.components.climate.ClimateEntity.
Definition at line 742 of file climate.py.
| None homeassistant.components.ecobee.climate.Thermostat.set_humidity | ( | self, | |
| int | humidity | ||
| ) |
Set the humidity level.
Reimplemented from homeassistant.components.climate.ClimateEntity.
Definition at line 793 of file climate.py.
| None homeassistant.components.ecobee.climate.Thermostat.set_hvac_mode | ( | self, | |
| HVACMode | hvac_mode | ||
| ) |
Set HVAC mode (auto, auxHeatOnly, cool, heat, off).
Reimplemented from homeassistant.components.climate.ClimateEntity.
Definition at line 803 of file climate.py.
| def homeassistant.components.ecobee.climate.Thermostat.set_mic_mode | ( | self, | |
| mic_enabled | |||
| ) |
Enable/disable Alexa mic (only for Ecobee 4).
Definition at line 1032 of file climate.py.
| def homeassistant.components.ecobee.climate.Thermostat.set_occupancy_modes | ( | self, | |
auto_away = None, |
|||
follow_me = None |
|||
| ) |
Enable/disable Smart Home/Away and Follow Me modes.
Definition at line 1036 of file climate.py.
Activate a preset.
Reimplemented from homeassistant.components.climate.ClimateEntity.
Definition at line 648 of file climate.py.
| None homeassistant.components.ecobee.climate.Thermostat.set_sensors_used_in_climate | ( | self, | |
| list[str] | device_ids, | ||
| str | None | preset_mode = None |
||
| ) |
Set the sensors used on a climate for a thermostat.
Definition at line 824 of file climate.py.
| def homeassistant.components.ecobee.climate.Thermostat.set_temp_hold | ( | self, | |
| temp | |||
| ) |
Set temperature hold in modes other than auto. Ecobee API: It is good practice to set the heat and cool hold temperatures to be the same, if the thermostat is in either heat, cool, auxHeatOnly, or off mode. If the thermostat is in auto mode, an additional rule is required. The cool hold temperature must be greater than the heat hold temperature by at least the amount in the heatCoolMinDelta property. https://www.ecobee.com/home/developer/api/examples/ex5.shtml
Definition at line 758 of file climate.py.
| None homeassistant.components.ecobee.climate.Thermostat.set_temperature | ( | self, | |
| **Any | kwargs | ||
| ) |
Set new target temperature.
Reimplemented from homeassistant.components.climate.ClimateEntity.
Definition at line 778 of file climate.py.
| dict[str, Any] homeassistant.components.ecobee.climate.Thermostat.settings | ( | self | ) |
Return the settings of the thermostat.
Definition at line 461 of file climate.py.
| ClimateEntityFeature homeassistant.components.ecobee.climate.Thermostat.supported_features | ( | self | ) |
Return the list of supported features.
Reimplemented from homeassistant.components.climate.ClimateEntity.
Definition at line 408 of file climate.py.
| int | None homeassistant.components.ecobee.climate.Thermostat.target_humidity | ( | self | ) |
Return the desired humidity set point.
Reimplemented from homeassistant.components.climate.ClimateEntity.
Definition at line 474 of file climate.py.
Return the temperature we try to reach.
Reimplemented from homeassistant.components.climate.ClimateEntity.
Definition at line 481 of file climate.py.
Return the upper bound temperature we try to reach.
Reimplemented from homeassistant.components.climate.ClimateEntity.
Definition at line 449 of file climate.py.
Return the lower bound temperature we try to reach.
Reimplemented from homeassistant.components.climate.ClimateEntity.
Definition at line 442 of file climate.py.
| float homeassistant.components.ecobee.climate.Thermostat.target_temperature_step | ( | self | ) |
Set target temperature step to halves.
Reimplemented from homeassistant.components.climate.ClimateEntity.
Definition at line 456 of file climate.py.
| None homeassistant.components.ecobee.climate.Thermostat.turn_on | ( | self | ) |
Set the thermostat to the last active HVAC mode.
Reimplemented from homeassistant.components.climate.ClimateEntity.
Definition at line 1019 of file climate.py.
|
staticprivate |
Definition at line 353 of file climate.py.
|
staticprivate |
Definition at line 355 of file climate.py.
|
private |
Definition at line 376 of file climate.py.
|
staticprivate |
Definition at line 352 of file climate.py.
|
staticprivate |
Definition at line 351 of file climate.py.
|
staticprivate |
Definition at line 354 of file climate.py.
|
staticprivate |
Definition at line 349 of file climate.py.
|
staticprivate |
Definition at line 350 of file climate.py.
|
staticprivate |
Definition at line 357 of file climate.py.
|
private |
Definition at line 370 of file climate.py.
|
staticprivate |
Definition at line 356 of file climate.py.
|
private |
Definition at line 374 of file climate.py.
|
private |
Definition at line 372 of file climate.py.
|
private |
Definition at line 373 of file climate.py.
|
private |
Definition at line 385 of file climate.py.
|
private |
Definition at line 384 of file climate.py.
|
staticprivate |
Definition at line 579 of file climate.py.
| homeassistant.components.ecobee.climate.Thermostat.data |
Definition at line 367 of file climate.py.
| homeassistant.components.ecobee.climate.Thermostat.hvac_mode |
Definition at line 444 of file climate.py.
| homeassistant.components.ecobee.climate.Thermostat.preset_mode |
Definition at line 658 of file climate.py.
| homeassistant.components.ecobee.climate.Thermostat.thermostat |
Definition at line 369 of file climate.py.
| homeassistant.components.ecobee.climate.Thermostat.thermostat_index |
Definition at line 368 of file climate.py.
| homeassistant.components.ecobee.climate.Thermostat.update_without_throttle |
Definition at line 389 of file climate.py.
| homeassistant.components.ecobee.climate.Thermostat.vacation |
Definition at line 371 of file climate.py.