https://github.com/FrancisLab/hass-climate-scheduler
A Home Assistant component to define climate profiles and facilitate automation of climate entities.
https://github.com/FrancisLab/hass-climate-scheduler
climate-control hacs hass hassio-addons home-assistant home-assistant-custom home-automation hvac-control
Last synced: 20 days ago
JSON representation
A Home Assistant component to define climate profiles and facilitate automation of climate entities.
- Host: GitHub
- URL: https://github.com/FrancisLab/hass-climate-scheduler
- Owner: FrancisLab
- License: mit
- Created: 2021-03-08T02:00:32.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-07-03T21:51:34.000Z (almost 2 years ago)
- Last Synced: 2024-02-14T21:16:08.586Z (about 1 year ago)
- Topics: climate-control, hacs, hass, hassio-addons, home-assistant, home-assistant-custom, home-automation, hvac-control
- Language: Python
- Homepage:
- Size: 67.4 KB
- Stars: 19
- Watchers: 3
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Home Assistant Climate Scheduler
A [Home Assistant](https://www.home-assistant.io/) component to facilitate the automation of climate entities. A scheduler controls its assigned climate entities based on user defined profiles and schedules. Each scheduler is represented as a switch entity which can be toggled on or off. Each scheduler registers an input_select entity which can be used to switch between profiles.
## Installation
Install the custom component using [HACS](https://hacs.xyz/) (recommended), or manually by copying `custom_components\climate_scheduler` to your `config\custom_components` directory.
[](https://github.com/custom-components/hacs)
## Configuration
### Component Configuration
```yaml
climate_scheduler:
update_interval: "00:10:00"
```
| Variable | Description | Type | Default |
| --------------- | --------------------------------------------------------------- | ------------------------------- | -------- |
| update_interval | How often schedulers should attempt to update climate entities. | Optional Positive Time HH:MM:SS | 00:15:00 |
### Scheduler Configuration
Each scheduler is registered as a switch entity. Each scheduler must be assigned at least one profile.
**Schedulers**
```yaml
switch:
- platform: climate_scheduler
name: Bedroom
default_state: True
default_profile: "Override"
climate_entities:
- climate.bedroom
profiles:
# See Profiles section
```
| Variable | Description | Type | Default |
| ---------------- | --------------------------------- | ----------------------- | ------------------- |
| **profiles** | Climate profiles of the scheduler | Required List[Profiles] | |
| name | Name of the scheduler | Optional String | "Climate Scheduler" |
| default_state | Initial state of scheduler | Optional Bool | False |
| default_profile | Initial profile of scheduler | Optional String | Id of 1st profile |
| climate_entities | Climate entities to control | Optional List[String] | [] |
**Profiles**
Profiles define when and how to configure climate entities. At least one must be provided per scheduler. Multiple profiles can be defined to make it easy to swith between different presets via UI or automations.
```yaml
...
profiles:
- id: "Bedroom Heating"
default_hvac_mode: "heat"
default_fan_mode: "auto"
default_swing_mode: "auto"
default_min_temp: 22
schedule:
# See Scheuldes section
```
| Variable | Description | Type | Default |
| ------------------ | --------------------------------------------------------------------------- | ------------------------ | ------- |
| **id** | Name of the profile. Must be unique in list. | Required String | |
| default_hvac_mode | HVAC mode to use when none specified by schedule entry | Optional String | None |
| default_fan_mode | Fan mode to use when none specified by schedule entry | Optional String | None |
| default_swing_mode | Swing mode to use when none specified by schedule entry | Optional String | None |
| default_min_temp | Default min temperature to set when none specified by schedule entry | Optional Float | None |
| default_max_temp | Default max temperature to set when none specified by schedule entry | Optional Float | None |
| schedule | List of schedule entries defining climate changes to apply at certain times | Optional List[Schedules] | None |
**Schedules**
A schedule is an optional list of times at which the target climate changes. If none are provided the scheduler will only set default values if any are presence. Having a single entry will cause the scheduler to set the desired values at all time. Having multiple entries will have the scheduler update climate entities at the specific time.
```yaml
...
schedule:
# Heat quietly during morning. Rely on default temp
- time: "06:30:00"
fan_mode: "superQuiet"
swing_mode: "vertical"
# Heat during the day. Relying on default values
- time: "07:30:00"
# Lower temperature during the night with quiet heating
- time: "20:30:00"
fan_mode: "superQuiet"
swing_mode: "vertical"
min_temp: 17.5
```
| Variable | Description | Type | Default |
| ---------- | ------------------------------------------------------------ | ----------------------------------- | ------------------------------------------------- |
| **time** | Time where the climate must be updated | Required Time (HH:MM:SS) < 24:00:00 | |
| hvac_mode | HVAC mode to set at time | Optional String | Default value from profile if any, otherwise none |
| fan_mode | Fan mode to set at time | Optional String | Default value from profile if any, otherwise none |
| swing_mode | Swing mode to set at time | Optional String | Default value from profile if any, otherwise none |
| min_temp | Min temperature to set at time. Use with relevant HVAC modes | Optional Float | Default value from profile if any, otherwise none |
| max_temp | Max temperature to set at time. Use with relevant HVAC modes | Optional Float | Default value from profile if any, otherwise none |
## Tips & Tricks
### Organizing & Sharing Profiles
You can define profiles in their own separate yaml files and share them across schedulers.
In `configuration.yaml`:
```yaml
- platform: climate_scheduler
name: Bedroom
default_profile: "Override"
climate_entities:
- climate.bedroom
profiles:
- !include climate_profiles/bedroom/heating.yaml
- !include climate_profiles/bedroom/cooling.yaml
- !include climate_profiles/common/override.yaml
- !include climate_profiles/common/away.yaml
- !include climate_profiles/common/vacation.yaml
- platform: climate_scheduler
name: Living Room
default_profile: "Override"
climate_entities:
- climate.living_room
profiles:
- !include climate_profiles/common/heating.yaml
- !include climate_profiles/common/cooling.yaml
- !include climate_profiles/common/override.yaml
- !include climate_profiles/common/away.yaml
- !include climate_profiles/common/vacation.yaml
```
Example content of `climate_profiles\bedroom\heating.yaml`
```yaml
# Climate profile for winter. Only allows heating.
id: "Bedroom Heating"
default_hvac_mode: "heat"
default_fan_mode: "auto"
default_swing_mode: "auto"
default_min_temp: 22
schedule:
# Heat quietly during morning. Rely on default temp
- time: "06:30:00"
fan_mode: "superQuiet"
swing_mode: "vertical"
# Heat during the day. Relying on default values
- time: "07:30:00"
# Lower temperature during the night with quiet heating
- time: "20:30:00"
fan_mode: "superQuiet"
swing_mode: "vertical"
min_temp: 17.5
```
### Overrides
It's often useful to disable a scheduler and assume manual control over climate entities. This can either be done by turning off the climate scheduler entity directly, or by defining and choosing an empty profile. In both cases, the scheduler won't make any changes to its assigned climate entities.
Override profile example:
```yaml
...
profiles:
- id: "Override"
```
### Static Profiles
Profiles with a constant climate configuration can be defined either with default values or with a single schedule entry.
Default Values:
```yaml
...
profiles:
- id: "Away"
default_hvac_mode: "heat_cool"
default_fan_mode: "auto"
default_swing_mode: "auto"
default_min_temp: 17
default_max_temp: 27
```
Single Schedule Entry:
```yaml
...
profiles:
- id: "Away"
schedule:
- time: "00:00:00"
hvac_mode: "heat_cool"
fan_mode: "auto"
swing_mode: "auto"
min_temp: 17
max_temp: 27
```
### Controlling Schedulers via UI
You can add the climate scheduler entity and its profile picker entity to your LoveLace UI to manually control them.
### Controlling Schedulers via Automation
Each scheduler registers a switch entity. The switch can be controlled with switch service calls:
- switch.toggle
- switch.turn_on
- switch.turn_off
Each scheduler registers a select_input entity for picking profiles. The profiles can be picked with input_select service calls:
- input_select.select_option
- And other less relevant input_select service calls. (Using input_select.set_options to change the content of the picker might result in undefined behavior)