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:
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 the
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:
...HACS should auto-remind you in the HACS tab when an update is available.
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).
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 | Description |
|---|---|---|---|
| type | string | Required | custom:scheduler-card |
| domains | map | none | Configure options for multiple entities of same domain. See here for information about domain configuration options. |
| entities | map | none | Configure options for a individual entities. See here for information about entities configuration options. |
| groups | map | none | Organize the entities menu. See here for information about group configuration options. |
| discoverExisting | boolean | True | Always show the existing schedules, also if the related entities are not included in the configuration. |
| standardConfiguration | boolean | True | Use the standard configuration as a base configuration. |
discoverExisting:false and standardConfiguration: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 |
|
| 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 |
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 |
| showPercentage | 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. Currently the following languages are supported:
- English
- Nederlands
- Français
- Deutsch
- Polski
The card will automatically detect the appropriate translation based on the language setting for your user account in HA.
If you are missing your translation, please contribute by making a translation. Take the english file as a reference.
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
Currently this is not supported. But it should come soon.
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.