Skip to content

An Home Assistant AddOn to schedule entities on/off on weekly base

Notifications You must be signed in to change notification settings

acseven/SimpleScheduler

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

92 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SimpleScheduler

A Home Assistant AddOn to schedule switches and lights on a weekly base in a visual way without coding.
You can keep all the schedules in one place and add/change in a few clicks, even in your mobile app.

SimpleScheduler

SimpleScheduler

Installation

Add the repository and then the addon by clickin on the badges:


If someting goes wrong, you can install it manually.
You can add the URL of this page in your "add-on store" as a new repository:
Configuration > Add-ons, Backups & Supervisor > ADD-ON STORE button in bottom right corner > three dots in top right corner > Repositories
Click refresh and you will find the add-on "Simple Scheduler" listed.

Type of scheduler

There are two kind of scheduler:

  • Daily: you can set a ON/OFF time (or a list of them) and than you choose on which weekdays you want to enable them.
  • Weekly: you can set a different ON/OFF time (or list of them) for every single day of the week.\

"A picture is worth a thousand words", so if you take a look at the screenshot it will be even more clear.

How to use it

The add-on is very easy and intuitive (or, at least, that's what I hope)
Once installed, open the GUI, click on the round plus button in the bottom right and choose your schedule type.
Choose one or more entity from the dropdown, fill the ON time (in 24 hours format with leading zero, as suggested) and select the weekdays. Do the same for the OFF time and click "save". That's it!

Advanced Feature

If you need more advanced feature:

  • You can set multiple time in the same scheduler: just write them in the field separated by spaces.
  • You can use the words sunrise and sunset and also add an offset (in minutes) to it if you need (e.g: sunrise+30 or sunset-60 )
  • You can set the brightness of a light. Write 16:30>B30 turn on the light at 30%.
  • You can set the temperature of a climate. Write 16:30>T22.5 to turn on the climate and set the temperature to 22.5°
  • You can set the temperature of a climate without turning it on. Write 16:30>TO22.5 to set the temperature to 22.5°
  • You can set the position of a cover. Write 16:30>P25 will set the cover at 25%
  • You can set the fan speed. Write 16:30>F25 will turn on the fan at 25%
  • Brightess/Temperature/Position only work in the "TURN ON" section (obviously)!
  • It's not mandatory to add both ON and OFF time. You can leave one of them empty if you don't need it. For example, you want to turn off a light every day at 22:00, but you don't need to turn it on.
  • You can also choose to disable a schedule: the schedule will stay there, but it will not be executed until you will enable it back
  • You can drag the rows to sort them, so you can keep them organized as you like!

Look at the picture above to see all this things in actions (and combined!).

Frontend switch to enable/disable (with MQTT)

If you want to enable/disable schedulers in frontend and/or automation, you can achieve that through MQTT. This feature is disabled by default, because it require a working MQTT server (broker) and Home Assistant MQTT integration. Take a look at the MQTT.MD file to know more.

Retry on unavailable

By default, SimpleScheduler will retry 3 times if an entity is unavailable. The first retry happens after 5 second, the other ones every minutes. You can change the numbers of retry in the addon options.

Hidden scheduler details

When you have a lot of schedulers the view can become messy. As a default, all the scheduler details are hidden, so you can have a clear look. You can toggle the visibility with the eye icon near the name. If you prefer to have all the schedule always visible, you can easily achive that by setting details_uncovered: true in the addon configuration

Dark theme

If you prefer a dark theme, you can activate it in the addon configuration by setting dark_theme: true

Translation

The default text language is English. They are very few words. If you want to translate them, you just need to take a look at the configuration section of the addon. Rewrite the words you would like to have in your language and restart the addon. For the weekdays, as you can easily understand, only the first two chars are used.

Two words about the stored data

Every schedule (or row, if you prefer) is a JSON file stored in the [share/simplescheduler] folder under the SAMBA share. This gives the chance to the data to "survive" to an addon upgrade or reinstallation. You can easily backup and restore them in case of failure. In the same way, you can (accidentally?) delete them. So be aware of that.

Last but not least

If you want to convince me to stay up at night to work on this, just buy me a beer 🍺 You may say that regular people need coffee to do that. Well, I'm not a regular person.

- - - - - F A Q - - - - - F A Q - - - - - F A Q - - - - - F A Q - - - - - F A Q - - - - - F A Q - - - - -

I set a timer but it switchs on/off at a wrong time
Be sure to set the correct timezone in Settings->General
You can read the TimeZone currently used by the addon in the bottom gray row

I set a timer but it doesn't switch on/off
The time MUST be set in HH:MM format
Be sure to input time with leading zeros, e.g: 08:30
Seconds are not allowed
Also check the previous point (timezone). Maybe it works but at the wrong time!

After update the addon doesn't seem to work
It seems that sometimes the update process fails
Try to uninstall the addon and install it again.

I would like to add a condition
Probably this will never happen
It's tricky and I should remove the word "simple" from the addon name
By the way, you can easily solve this by creating a script that check the condition and then call the script from the scheduler

I get a "returned a non-zero code" error during update/install
Take a look here: arthurdent75#65 (comment)

About

An Home Assistant AddOn to schedule entities on/off on weekly base

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • PHP 90.8%
  • CSS 7.3%
  • Shell 1.4%
  • Dockerfile 0.5%