This is a Lovelace card for Home Assistant that can be used to create a time schedule for your smart devices. You can create new rules, modify existing rules and temporarily disable rules.
The card works on top of the scheduler custom component. You will need it this as well.
See it in action:
click to show installation instructions
HACS installation:
- Add
https://github.com/nielsfaber/scheduler-cardas a custom frontend repository. - Click on "Install" under the new card that just popped up.
Manual installation
-
Download the latest release of
scheduler-card.jshere and place it intowww/scheduler-card. -
Add a reference to the card in the resources section of
ui-lovelace.yaml:
resources:
- url: /local/scheduler-card/scheduler-card.js?v=0
type: module- Add the card in the view where you want it to be shown:
type: custom:scheduler-card
domains:
...
entities:
...
groups:
...click to show updating instructions
Updating via HACS: HACS should auto-remind you in the HACS tab when an update is available.
Updating manually:
Use git pull for manual installation updates.
Since most browsers will cache the Lovelace card code, you can force a refresh of the browser by editing the entry in the resources: section in ui-lovelace.yaml, by updating the version to ?v=(n+1) (where n the current value).
🚧 WIP More usage instructions should follow soon.
Click the button 'add item' in the bottom of the card, to start creating a schedule.
The card scans the entities in your HA configuration and suitable candidates should automatically show up in this view.
Groups Since HA may contain many entities, the card divides the entities into different groups. Clicking a group automatically will show the entities contained in the group.
The groups that are displayed are depending on your HA configuration. Typically the groups are based on the domain of your entities. If you want to make changes to the groups, you can do this by defining groups configuration.
Entities The entities that you can to control with the scheduler show up here. Clicking a entity automatically will show the actions that you can program for this entity.
Typically an entity is a device in your house, but you can also control an automation, script, input_boolean, etc. If you are missing one or more entities, you can add these yourself using the entities or domains configuration.
Actions The actions that you can perform for the selected entity show up here. Typically an action is to either 'turn on' or 'turn off' a device. But some entities have more capabilities. If you are missing an action, you can add it yourself to either entity or the complete domain (group) using the actions configuration.
Actions can contain a variable setting (e.g. turn on a lamp at specific brightness, or change the setpoint for a thermostat). These can be defined in the next page.
After clicking the 'next' button, a new view appears. This view is used for choosing when the schedule should be active.
Choose the days of the week for which the schedule should be active.
Every day the default option. The schedule will perform the action every day at the specified time.
Weekdays perform action only on monday thru friday. Typically weekdays are the same as working days, but it may depend on your country. Holidays are not taken into account as of yet.
Custom choose your own days. A list with all days of the week appears. You can select one or more days by clicking them.
🚧 WIP rename every day to daily
🚧 WIP rename weekdays to workdays, and take into account holidays and the actual workdays in your country using the workday sensor
🚧 WIP add weekends and make it the opposite of workdays
🚧 WIP add option to choose the first day of the week
📍 Updated in v1.3.0. May contain bugs.
The time at which you want schedule to be activated can be set using the timepicker.
The timepicker shows the current time setting, and features arrow buttons to increase or decrease the hour and minutes. Note that you can infinitely loop through time. The step size for minutes is 10 minutes by default, but can be configured to your preference.
If you have the AM/PM option enabled, 12-hour format will be used. You can click on the button to switch between AM and PM.
Sunrise / sunset mode
If you have the sun integration in HA, a button with sun/moon icon shows up on the right. This is the mode button, which allows you to switch from a fixed time, to time relative to sunrise or sunset.
The card allows you to choose a time that is 2 hours around sunrise or sunset. The button will be disabled if the current time is not in this range.
In sunrise/sunset mode, the timepicker will show the offset relative to sunrise/sunset. The time offset is automatically calculated from fixed time. The sunrise/sunrise button will show a sun icon when offset is relative to sunrise, or a moon icon when offset is relative sunset. The before/after button indicates whether the offset is applied in positive direction (so triggers after sunrise/sunset), or in negative direction (before sunrise/sunset). Also here, buttons can be clicked to toggle.
Configuration is not mandatory. Out of the box, the card should already find most of your HA entities and provide some basic actions for each. If you want to modify which entities and/or actions can be used, then keep reading.
| Name | Type | Default | Available from | Description |
|---|---|---|---|---|
| type | string | Required | - | custom:scheduler-card |
| domains | map | none | v1.0.0 | Configure options for multiple entities of same domain. See here for information about domain configuration options. |
| entities | map | none | v1.0.0 | Configure options for a individual entities. See here for information about entities configuration options. |
| groups | map | none | v1.0.0 | Organize the entities menu. See here for information about group configuration options. |
| discover_existing | boolean | True | v1.2.0 | Always show the existing schedules, also if the related entities are not included in the configuration. |
| standard_configuration | boolean | True | v1.2.0 | Use the standard configuration as a base configuration. |
| title | boolean or string | True | v1.2.8 | Provide your own name to overwrite the title of the card, or set to false to hide the title. |
| am_pm | boolean | False | v1.3.0 | Use AM/PM time notation (instead of 24 hours notation) |
| time_step | number | 10 | v1.3.0 | Set the time step (in minutes) for the time picker |
discover_existing:false and standard_configuration:false in both cards to avoid duplicates.
The standard configuration is intended to help you started without needing coding (yaml) skills.
Included in the standard configuration:
| Device type/domain | Supported actions | Remarks |
|---|---|---|
| light | Turn on Turn off |
Brightness is configurable from 0-100% |
| switch | Turn on Turn off |
|
| cover | Open Close Set position |
Position is configurable from 0-100% |
| climate | Set temperature Turn off |
Temperature is configurable from 10-30C |
| fan | Turn on Turn off |
Are you missing something that should be long in the standard configuration? Let me know
With the domains configuration you can specify configuration options for multiple HA entities of the same type (domain).
include or exclude option to filter the entity_ids that you want to add.
| Name | Type | Default | Description |
|---|---|---|---|
| domain | key | Required | Entity domain from home assistant |
| actions | list | none | See actions |
| icon | string | none | Displayed icon for entities in the domain (overwrites HA config) |
| include | list | none | Filter the entities for this domain, only add the entity_ids in this list |
| exclude | list | none | Filter the entities for this domain, leave out the entity_ids in this list |
Scenario: "I want to be able to turn on/off all the lamps in my house"
domains:
light:
actions:
- service: turn_on
- service: turn_offScenario: “I have a lot of lights in my house, but i only want to control some of them with the scheduler.”
Use the include option to specify which lights you want to add:
domain:
light:
include:
- light.my_light_1
- light.my_light_2
- light.my_light_3
# rest of domain config (actions, icon, ...)Scenario: “I have a lot of lights in my house, but i only want to control all but some of them with the scheduler.”
Use the exclude option to specify which lights you want to be ignored:
domain:
light:
exclude:
- light.my_light_that_i_never_use
# rest of domain config (actions, icon, ...)With the entities configuration you can specify configuration for specific HA entities.
configuration in combination with domains configuration, the configurations will be merged. The entities configuration will overwrite domains configuration.
| Name | Type | Default | Description |
|---|---|---|---|
| entity | key | Required | Entity id from home assistant |
| actions | list | none | See actions |
| name | string | (take from HA config) | Displayed name for entity |
| icon | string | (take from HA config) | Displayed icon for entity |
For adding an action to turn on a light with 40% brightness, and styling the light with a custom icon and name:
entities:
light.my_lamp:
name: "Dining light"
icon: ceiling-light
actions:
- service: turn_on
service_data:
brightness: 40
name: "Turn on at 40%"
icon: lightbulb-on-outlineResult:
An action defines what needs to be done when a schedule timer expires.
An action is similar to a service call in HA. It requires a service with optionally additional parameters given by service_data.
Actions are linked to their entities, so the entity ID is sent together with the service call, it is not needed to add it to the service_data).
| Name | Type | Default | Description |
|---|---|---|---|
| service | string | Required | Service to be executed |
| service_data | map | none | Additional parameters to use for the service call |
| variable | map | none | Add a variable. See action variable |
| name | string | (same as service) | Displayed name for action |
| icon | string | "flash" | Displayed icon for action |
📍 Introduced in v1.2.6
Some devices allow to operate on a variable working point. For example lights can be dimmed with a brightness, fans can spin at a speed etc.
By providing an action variable, the card allows you to choose the setting you want to apply with the action.
| Name | Type | Default | Description |
|---|---|---|---|
| field | string | Required | field name in the service_data that is represented by this variable |
| name | string | same as field | Name under which the variable is visible in the card |
| unit | string | " " | Displayed unit |
| min | number | 0 | Minimum value that can be set |
| max | number | 255 | Maximum value that can be set |
| step | number | 1 | Step size |
| optional | boolean | false | Setting the variable is optional, the action can also be executed without this variable. If optional:true is provided, a checkbox will be shown that needs to be selected to apply the variable |
| show_percentage | boolean | false | Show slider in percentage instead of from min to max. |
The Xiaomi Air Purifier can be controlled using the xiaomi miio integration. To be able to set the speed of this device in your action, you can use:
- service: xiaomi_miio.fan_set_favorite_level
name: "set speed"
variable:
field: level
name: "Speed"
min: 1
max: 16
You can now select the speed for this action in the schedule editor:
The groups configuration provides the capability of organizing the entities.
groups.
entities and domains in your groups are also included in their specific configurations, else they will not show up.
| Name | Type | Default | Description |
|---|---|---|---|
| group_id | key | Required | Identifier for group |
| name | string | (same as group_id) | Displayed name for group |
| icon | string | none | Displayed icon for group |
| entities | list | none | entities to be added in this group |
| domains | list | none | domains to be added in this group |
Simple example: Place all light entities in group labelled "lighting" (this is part of the standard configuration):
groups:
lights:
name: "Lighting"
icon: ceiling-light
domains: [light]Result:
The card is available in multiple languages. The card will automatically detect the appropriate translation based on the language setting for your user account in HA.
Currently the following languages are supported:
| Language | Code(s) | Available from | Status / Remarks |
|---|---|---|---|
| Deutsch | de | v1.2.3 | |
| English | en | v1.0.0 | Default language. |
| Eesti | et | v1.4.0 | |
| Español | es, es_419 | v1.2.8 | |
| Français | fr | v1.2.3 | |
| Magyar | hu | v1.3.0 | |
| Polski | pl | v1.2.6 | |
| Português | pt, pt-br | v1.3.0 | Translation is brazilian Portuguese, improvements may be needed for native Portuguese. |
| Русский | ru | v1.2.8 | |
| Nederlands | nl | v1.2.2 | |
| Norsk | no, nb, nn | v1.2.8 |
The translations are maintained by users. If you are missing a translation, or a translation needs to be improved, please contribute. Take the english file as a starting point.
The standard configuration uses Celsius as unit. If you prefer Fahrenheit, then simply overwrite it.
domains:
climate:
icon: thermometer
actions:
- service: set_temperature
variable:
field: temperature
unit: "F"
min: 50
max: 80
From within the scheduler-card, there is unfortunately no such functionality in place. There are two alternative ways:
1. Use an automation to control when the schedule is running
Create an automation that checks for the condition, and based on this, enables or disables the schedule.
Run service switch.turn_off or switch.turn_on with the entity_id matching your schedule.
Main disadvantage: the entity_id of a schedule is not easy to read: they are randomly generated, and the entity_id does not tell anything about the related entity.
2. Use an script to check the condition before execution of the action
Create a script that checks for the condition, and if it passes, executes the action.
Use the scheduler to execute this script (instead of the actual entity you want to control).
Currently this is considered the best option.
Main disadvantage: you will have to add configuration to the card to make the script selectable in the scheduler-card. The result will look less pretty than with other entities.
Example: Turn on my thermostat at X degrees. but only if my window is closed
First create the script (for setting up scripts see here):
my_script:
fields:
temperature: {} # allow temperature as variable field
sequence: # sequence for multiple steps, aborts if a step fails
- condition: state # check the condition
entity_id: binary_sensor.my_window
state: 'off'
- service: climate.set_temperature # update the temperature
data_template:
entity_id: climate.my_thermostat
temperature: "{{ temperature }}"
To add the newly created script to HA you need to restart HA (or run 'reload scripts').
Now, add the script entity to the card:
type: custom:scheduler-card
(...)
entities:
script.my_script:
name: My thermostat script
actions:
- service: script.my_script # service is the same as entity_id for scripts
name: set temperature
variable: # add action variable to show a slider for choosing the temperature
field: temperatureIn your browser, open the console log. This is usually accessible from the developer tools (MS Edge: F12, Chrome: ctrl+shift+i). There should be a badge titled "SCHEDULER-CARD" with the version number included.
This error suggests that the scheduler-component is not running. Please do NOT file an issue in this repo.
Good question, ask the developers!
But let's see if we can get convince them to adopt this scheduler, simply by making it awesome :)
If you have an issue with this card, please report it here.