MMM-ModuleScheduler - Module Schedules and Notifications

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.

cowboysdude

I’m using it like this… but it’s not working for some reason:

{
module: ‘MMM-ModuleScheduler’,
config: {
global_schedule: [
// SHOW MODULES WITH THE CLASS ‘daytime_scheduler’ AT 06:00 AND HIDE AT 22:00 EVERY DAY
{from: ‘50 6 * * *’, to: ‘0 9 * * *’, groupClass: ‘scheduler_mfm’},
{from: ‘50 6 * * *’, to: ‘0 23 * * *’, groupClass: ‘scheduler_mfd’},
{from: ‘0 6 * * *’, to: ‘0 23 * * *’, groupClass: ‘scheduler_sat’},
{from: ‘0 6 * * *’, to: ‘0 23 * * *’, groupClass: ‘scheduler_sun’},
{from: ‘0 6 * * *’, to: ‘0 23 * * *’, groupClass: ‘scheduler_nflg’},
{from: ‘0 6 * * *’, to: ‘0 23 * * *’, groupClass: ‘scheduler_nflng’}
]
}
},

Then for example a module:

         {
		module: 'compliments',
		position: 'lower_third',      
                    classes: 'scheduler_mfm'
	},

I did update the module with ‘git pull’ so that’s okay but it’s not rendering correctly and shutting the module ‘off’

Did I miss something simple again? :)

ianperrin

@cowboysdude - During my testing of the global scheduling feature, I identified an issue which meant the initial state of the modules may not have been correct. I’ve committed a potential fix for this which may fix your issue too so please feel free to git pull again and test.

If it doesn’t work, can you let me know what is output in the logs pm2 logs mm - you should see something like the following for each of your global schedules

MMM-ModuleScheduler is creating a global schedule for scheduler_mfm modules using '50 6 * * *' and '0 9 * * *' with dim level undefined
MMM-ModuleScheduler is hiding scheduler_mfm modules
MMM-ModuleScheduler has created the global schedule for scheduler_mfm modules
MMM-ModuleScheduler will next show scheduler_mfm modules at Tue Nov 01 2016 06:50:00 GMT+0000 (UTC)
MMM-ModuleScheduler will next hide scheduler_mfm modules at Tue Nov 01 2016 09:00:00 GMT+0000 (UTC)

The second line in the above log example will only appear if the schedule means that the modules affected it should be initially hidden

ianperrin

@MichMich said in MMM-ModuleScheduler:

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

LockStrings should now be supported - feel free to test and let me know if it works as expected!

cowboysdude

Will give it a try! Thanks @ianperrin !

anatius

Hi,

I am trying to dim my mirror at nighttime - on weekdays between 10PM and 7AM, on weekends between 10Pm and 8AM. However, the below code does not do the trick - where is my mistake?

  		{
			module: 'MMM-ModuleScheduler',
			config: {
				global_schedule: [ 
					{from: '0 7 * * 1-5', to: '0 20 * * 1-5', dimLevel: '30'},					
					{from: '0 8 * * 0,6', to: '0 20 * * 0,6', dimLevel: '30'},					
				]
			}
		},

ianperrin

@anatius The config looks okay, can you check the output of the log pm2 logs mm once you have started MM2 and viewed it in a browser then post the results here?

It should look something like:

MMM-ModuleScheduler received INITIALISE_SCHEDULER
MMM-ModuleScheduler is setting the config
MMM-ModuleScheduler is removing all scheduled jobs
MMM-ModuleScheduler received CREATE_NOTIFICATION_SCHEDULE
MMM-ModuleScheduler received CREATE_GLOBAL_SCHEDULE
MMM-ModuleScheduler is creating a global schedule for all modules using "0 7 * * 1-5" and "0 20 * * 1-5" with dim level 30
MMM-ModuleScheduler is dimming all modules
MMM-ModuleScheduler has created the global schedule for all modules
MMM-ModuleScheduler will next show all modules at Mon Dec 19 2016 07:00:00 GMT+0000 (UTC)
MMM-ModuleScheduler will next dim all modules at Mon Dec 19 2016 20:00:00 GMT+0000 (UTC)
MMM-ModuleScheduler is creating a global schedule for all modules using "0 8 * * 0,6" and "0 20 * * 0,6" with dim level 30
MMM-ModuleScheduler is dimming all modules
MMM-ModuleScheduler has created the global schedule for all modules
MMM-ModuleScheduler will next show all modules at Sat Dec 24 2016 08:00:00 GMT+0000 (UTC)
MMM-ModuleScheduler will next dim all modules at Sat Dec 24 2016 20:00:00 GMT+0000 (UTC)

anatius

@ianperrin

Hi Ian,

Below is the relevant output of the log (error log is empty). Note that now (Monday at 3 PM) all modules are dimmed though they should not be…

MMM-ModuleScheduler received INITIALISE_SCHEDULER
MMM-ModuleScheduler is setting the config
MMM-ModuleScheduler is removing all scheduled jobs
MMM-ModuleScheduler received CREATE_NOTIFICATION_SCHEDULE
MMM-ModuleScheduler received CREATE_GLOBAL_SCHEDULE
MMM-ModuleScheduler is creating a global schedule for all modules using "0 7 * * 1-5" and "0 20 * * 1-5" with dim level 30
MMM-ModuleScheduler has created the global schedule for all modules
MMM-ModuleScheduler will next show all modules at Tue Dec 20 2016 07:00:00 GMT+0100 (CET)
MMM-ModuleScheduler will next dim all modules at Mon Dec 19 2016 20:00:00 GMT+0100 (CET)
MMM-ModuleScheduler is creating a global schedule for all modules using "0 8 * * 0,6" and "0 20 * * 0,6" with dim level 30
MMM-ModuleScheduler is dimming all modules
MMM-ModuleScheduler has created the global schedule for all modules
MMM-ModuleScheduler will next show all modules at Sat Dec 24 2016 08:00:00 GMT+0100 (CET)
MMM-ModuleScheduler will next dim all modules at Sat Dec 24 2016 20:00:00 GMT+0100 (CET)

Many thanks for your support!
Christian

ianperrin

Hi @anatius (Christian)

Okay, I think I see the problem, and a fix is in the works, its just going to take a little time until I can finish it.

I’ve created an issue on github which contains more details on why this is happening.

Until the fix is in place, you have two (understandably sub-optimal) options

leave the mirror running and it should self-correct after the next 8pm and/or 7/8am depending on when it is started :(
temporarily use the same expression for all days of the week, e.g.

global_schedule: [ {from: '0 7 * * *', to: '0 20 * * *', dimLevel: '30'} ]