MMM-ModuleScheduler - Module Schedules and Notifications

ianperrin

@Alvinger interesting, I’ll check it out.

You may also be interested in taking a look at MMM-Remote-Control. It contains a heap of functions to control your mirror (including turning the monitor off and on, rebooting the pi, restarting the MM process etc) remotely.

I’ve been working with @Jopyth to expose this functionality via the use of sendNotification.

This should allow schedules like:

notification_schedule: [
    {notification: 'REMOTE_ACTION', schedule: '30 9 * * *', payload: {action: 'MONITOROFF'}},
    {notification: 'REMOTE_ACTION', schedule: '30 18 * * *', payload: {action: 'MONITORON'}}
]

Check out the repository on GitHub - the latest code includes this capability

Jopyth

@ianperrin The actions available are now also documented in the readme, so noone has to dig through all the code neccessarily. See this section, a table is down below.

Alvinger

@ianperrin @Jopyth: sorry, wasn’t aware that MMM-Remote-Control had that ability. I would recommend MMM-Remote-Control instead of MMM-tvservice to the general user as it covers all functionality needed.

MMM-tvservice is more for the linux enthusiast who wants a program to do one thing and one thing only. I am not running MagicMirror through PM2 but rather directly via systemd so I cannot use all functionality of MMM-Remote-Control without editing the source. Also, as I am running through systemd I do not need to prefix the commands with sudo as the service already runs as root.

MichMich

Very awesome work on this module! It might be interesting to look at the new show/hide mechanism: https://forum.magicmirror.builders/topic/241/revising-the-show-hide-mechanism/9

MichMich

One other feature request:

It would be nice if there is a way to schedule a hide show based on a classname. This way I can give all my modules a class like “day” and “night”, and make a schedule:

 {
        module: 'MMM-ModuleScheduler',
        config: {
            visibility_schedule: [
                {classes: 'day', schedule: {from: '0 6 * * *', to: '0 22 * * *' }},
                {classes: 'night',  schedule: {from: '0 22 * * *', to: '0 6 * * *' }}
            ]
        }
},

ianperrin

@MichMich said in MMM-ModuleScheduler:

One other feature request:

It would be nice if there is a way to schedule a hide show based on a classname. This way I can give all my modules a class like “day” and “night”, and make a schedule:

Great idea. I was planning on adding a global module_schedule functionality, i.e. the ability to hide all modules at 10pm, rather than having to configure multiple schedules on a per-module basis.

I think the idea of class-based module groups makes for an interesting extension of the idea.

So to take your config example, if the global schedule definition includes the classes property, only those modules with that class are affected. If the global schedule definition omits the classes field then all modules are affected.

One for next week I suspect!

MichMich

An other small suggestion: delay all show effects with the a delay equal to the animation time. This way all Modules that will need to hide will nicely hide before any new modules fade in.

ianperrin

@MichMich - some great ideas, keep them coming.

I’ve created issues (or rather enhancements) for these on GitHub - https://github.com/ianperrin/MMM-ModuleScheduler/issues. Feel free to review, comment etc.

Mr.Meeseeks

Is it required to restart mm/server if a scheduler configuration is changed, add, removed?
Thanks

ianperrin

@Mr.Meeseeks Apologies for missing this one.

The schedules are set up after the ALL_MODULES_STARTED or DOM_OBJECTS_CREATED notifications have been received from the core. So a restart should not be required and a refresh of the browser should be sufficient to pick up config changes.

cowboysdude

In retrospect I only wanted to be able to hide a module now and then LOL

NEVER thought it would turn into such an awesome module!!!

Thanks @ianperrin !!!

Mitchfarino

@cowboysdude @ianperrin how would would I implement a schedule so that a module appeared for 5 minutes, then disappear and reappear in 5 minutes time?

I’ve tried this

module_schedule: { */5 * * * * },

2nd edit- I thought I’d got it with this…

module_schedule: { from: '*/2 * * * *', to: '*/3 * * * *'},

cowboysdude

@Mitchfarino said in MMM-ModuleScheduler:

@cowboysdude @ianperrin how would would I implement a schedule so that a module appeared for 5 minutes, then disappear and reappear in 5 minutes time?

I’ve tried this
module_schedule: { */5 * * * * },
2nd edit- I thought I’d got it with this…
module_schedule: { from: '*/2 * * * *', to: '*/3 * * * *'},

Yes that should make it run every five minutes…

Copy and try this without brackets…

'*/5 * * * *'

example - schedule: ‘30 9 * * *’,

ianperrin

@Mitchfarino said in MMM-ModuleScheduler:

@cowboysdude @ianperrin how would would I implement a schedule so that a module appeared for 5 minutes, then disappear and reappear in 5 minutes time?

Try this

module_schedule: {from: '0/10 * * * *',  to: '5/10 * * * *'},

Which should equate to the module being

shown every 10 minutes starting from 0 minutes past the hour, i.e. 0, 10, 20 etc
hidden every 10 minutes starting from 5 minutes past the hour, i.e. 5, 15, 25 etc

Mitchfarino

@ianperrin cheers mate!

I’ll have a look tonight!

Fantastic module by the way

ianperrin

@Mitchfarino said in MMM-ModuleScheduler:

@ianperrin cheers mate!

I’ll have a look tonight!

Fantastic module by the way

Thank you and no worries.

Unfortunately, I’ve just done a quick test with the expressions I posted above and they didn’t work. :(

If you check the cron expressions i suggested using crontab.guru, it would appear they are non-standard. Therefore, I suspect they are not supported by the node cron module.

Not to worry, there’s always a solution! crontab.org states that step values can be used in conjunction with ranges. So the expressions I believe you require are as follows:

module_schedule: {from: '0-59/10 * * * *',  to: '5-59/10 * * * *'},

MichMich

Any ETA for https://github.com/ianperrin/MMM-ModuleScheduler/issues/4 and https://github.com/ianperrin/MMM-ModuleScheduler/issues/6?

ianperrin

@MichMich said in MMM-ModuleScheduler:

Any ETA for https://github.com/ianperrin/MMM-ModuleScheduler/issues/4 and https://github.com/ianperrin/MMM-ModuleScheduler/issues/6?

Wow - someone is keen ;)

The first iteration of #4 has been committed. Global schedules can now be added to show/hide/dim all modules - see the updated documentation for more info.

On the to list is to

add support for showing/hiding/dimming modules in groups
add the ability to exclude specific modules from the global schedules

#6 comes afterwards when I can switch my dev environment to the develop branch

ianperrin

@MichMich

one schedule can now be used to hide/show/dim all modules - see global scheduling
one schedule can now be create to hide/show/dim a group of modules - see group schedules

To do:

add the ability to exclude specific modules from the global/group schedules
unit and regression tests ;)

MichMich

Nice work! LockStrings are not yet implemented, right? Until then I can’t use the module.