modules day and time Depending represented

cowboysdude

It’s turning anything off with 'classes: ‘scheduler’, attached no matter what time you set it for ;)

ianperrin

@cowboysdude said in modules day and time Depending represented:

Only thing I can see wrong is the speed [decreased] of loading the mirror!

As part of the install process, npm install needs to be run to install the dependency on node-cron. This can take a little time, but is only required once. Having completed the install, I’m not seeing the performance issues you mention so we might need to look into that a little further.

ianperrin

@cowboysdude said in modules day and time Depending represented:

It’s turning anything off with 'classes: ‘scheduler’, attached no matter what time you set

The expected functionality is that the module is shown between the dates specified, so once the module has done it’s thing, it hides the modules and they are not shown until the next ‘from’ date.

In more detail, it should follow the following process once it receives the notification (DOM_OBJECTS_CREATED) that all modules have been loaded:

It checks each module to see if it contains the ‘scheduler’ class
If yes, it checks whether the module config includes the ‘module_scheduler’ option
if yes, it checks whether the option includes the ‘from’ and ‘to’ properties
if yes, it creates the cron jobs to show (‘from’) and hide (‘to’) the module
if the next show (‘from’) date for the module is in the future and less than the next hide (‘to’) date, it hides the module
when the ‘from’ cron job is triggered, it sends a notification to show the module
when the ‘to’ cron job is triggered, it sends a notification to hide the module

Now, as this is work in progress I haven’t had time to check all permutations of modules and cron expressions. However, it’s logging is rather verbose so please do check out the console log (pm2 logs mm) to see what it thinks it is doing!

If you find problems, can you post your config (or at the least, which module you are trying to schedule and the values for the module_scheduler option?

Thanks

ianperrin

Earlier versions of the module would create duplicate cron jobs if the Mirror recreated the modules (e.g. after a page refresh in the browser). The current version attempts to resolve this.

Trailblazers who’ve already grabbed a copy of the module please run git pull from the module directory - see https://github.com/ianperrin/MMM-ModuleScheduler#updating for more details

cowboysdude

@ianperrin said in modules day and time Depending represented:

@cowboysdude said in modules day and time Depending represented:

Only thing I can see wrong is the speed [decreased] of loading the mirror!

As part of the install process, npm install needs to be run to install the dependency on node-cron. This can take a little time, but is only required once. Having completed the install, I’m not seeing the performance issues you mention so we might need to look into that a little further.

No no it’s only an issue one time … after it loads the first time it’s fine thereafter :)

cowboysdude

Did the git pull and it’s working to perfection… Thank you!!!

cowboysdude

Now here’s a challenge for you LOL

Say you’d like a module to appear at 7 am until 8 am then again at 5pm until 11pm could it be worked so it could be set up like this:

{
module: ‘calendar’,
header: ‘US Holidays’,
position: ‘top_left’,
classes: ‘scheduler’,
config: {
// DISPLAY THE CALENDAR BETWEEN 09:00 and 18:00 ON WEDNESDAYS
schedule1: {from: ‘0 7 * * 3’, to: ‘0 8 * * 3’ },
schedule2: {from: ‘0 17 * * 3’, to: ‘0 23 * * 3’ },
calendars: [
{
symbol: 'calendar-check-o ',
url: ‘webcal://www.calendarlabs.com/templates/ical/US-Holidays.ics’
}
]
}
},

Just a thought but it could be useful :) My other thought was to enter the module twice and run it the way it’s written… going to test that :)

I tested that and that works ! :) The logic of the mirror just loads the modules [if in the config correctly] will load it as many times as you want! So I had it come on at 7 and go off at 8:30 then back on at 8:32 and that worked great! Not sure how hard it would be to change it to work but could just add another layer to the module :)

ianperrin

@cowboysdude - rather than add two instances of the module, try the following expressions:

module_schedule: {from: '0 7,17 * * *', to: '0 8,23 * * *'}

This should create a schedule with jobs to show the module at 07:00hrs and 17:00hrs, and jobs to hide the module at 08:00hrs and 23:00hrs

I can see there are use cases where multiple schedules might be required, so I’ve created an enhancement request on github to cover that one - https://github.com/ianperrin/MMM-ModuleScheduler/issues/2

cowboysdude

@ianperrin Thank you! I’ll give that a go when I get home from work. This module is just about the handiest things I have seen!!!

I guess had I investigated cron I could have found that out myself… sorry.

With this I no longer wish the pi to ‘go to sleep’… I just show certain things at certain times and always leave the time and date on… it’s just amazing!!! You don’t realize how useful and important something sometimes until you have it!

Thanks again!

shashank

@ianperrin I installed this modules and it found working fine.

ianperrin

@shashank - great to hear - and thanks for the feedback.

ianperrin

@cowboysdude said in modules day and time Depending represented:

I guess had I investigated cron I could have found that out myself… sorry.

Glad to help and no need to apologise at all

Mitchfarino

Not implemented this yet @ianperrin , but this is an incredible contribution. We can make much more use of the modules now, rather than being limited to a certain number

cowboysdude

@Mitchfarino said in modules day and time Depending represented:

Not implemented this yet @ianperrin , but this is an incredible contribution. We can make much more use of the modules now, rather than being limited to a certain number

This should be right in the install!! :)

bjoern

WORKS FINE! Thanks!

shashank

@shashank i configured this scheduler today with Calendar and Wunderground, after the end time the module will not disappear, i need to stop and start the MM.

{
module: ‘calendar’,
header: ‘US Holidays’,
position: ‘top_left’,
classes: ‘scheduler’,
config: {
// DISPLAY THE CALENDAR BETWEEN 09:00 and 18:00 ON WEDNESDAYS
module_schedule: {from: ‘0 9 * * FRI’, to: ‘20 21 * * SAT’ },
calendars: [
{
symbol: 'calendar-check-o ',
url: ‘webcal://www.calendarlabs.com/templates/ical/US-Holidays.ics’
}
]
}
},

ianperrin

@shashank said in modules day and time Depending represented:
Looking at your config, I can see a couple of potential issues

Firstly, make sure you use straight apostrophes (') not curly ones (‘ ’).

Secondly, the expressions in the module_schedule config option (module_schedule: {from: '0 9 * * FRI', to: '20 21 * * SAT' },) should schedule the calendar so it is displayed at 09:00 on Friday and be hidden at 21:20 on Saturday.

Is this what you intended? If so, check the logs (pm2 logs mm), you should see something like this.

MMM-ModuleScheduler received CREATE_MODULE_SCHEDULE
MMM-ModuleScheduler is scheduling calendar using '0 9 * * FRI' and '20 21 * * SAT'
MMM-ModuleScheduler has scheduled calendar
MMM-ModuleScheduler will next show calendar at Fri Sep 23 2016 09:00:00 GMT+0000 (UTC)
MMM-ModuleScheduler will next hide calendar at Sat Sep 17 2016 21:20:00 GMT+0000 (UTC)

Note the last two lines will vary depending on when start the mirror. In the example above started the mirror at 17:00 on Saturday, so the next ‘show’ (from) date is next friday (23rd) and the next hide (to) date is tonight.

Hope this helps

Mitchfarino

@ianperrin

Sorry for the odd question, will this work on a windows PC?

I’m testing the mirror on the PC before I deploy to my Pi, and this module doesn’t seem to be working

ianperrin

@Mitchfarino I’ve not tested the module on windows myself, so I can’t say for sure.

The module requires the cron package so make sure this has been installed by running npm install from the module folder.

You could then check whether cron works on windows by entering the following from the command prompt

cd MagicMirror/modules/MMM-ModuleScheduler
node

Once the node prompt appears, enter the following

var CronJob = require('cron').CronJob;
var testJob = new CronJob({cronTime: '* * * * * *', onTick: function() { console.log('Firing every second'); }, onComplete: function() { console.log('Stopping'); }, start: true});
console.log('Scheduled for ' + testJob.nextDate().toDate());

You should see a telling you when the module is next scheduled for and another message every second the expression is fired (pressCTRL-C twice to stop!)

If we’ve got this far cron is working successfully. What do the logs ( pm2 logs mm ) say? Could you post your config options?