Package: micropython-scron
Simple CRON for MicroPythonSimpleCRON is a time-based task scheduling program inspired by the well-known
CRON program for Unix systems.Before you use this library, you may be interested in a similarMicroCRONlibrary that needs 3 times less memory
to operate. It was written based on experience with the current library.The software was tested under micropython 1.10 (esp32, esp8266) and python 3.5.Note: The library does not work properly under theLoboris MicroPythonport,
read this issue#3.Project documentation.What you can do with this library:Run any task at precisely defined intervalsDelete and add tasks while the program is running.Run the task a certain number of times and many more.Requirements:The board on which the micropython is installed(v1.10)The board must have support for hardware timers.InstallYou can install using the upip:importupipupip.install("micropython-scron")ormicropython-mupipinstall-pmodulesmicropython-scronYou can also clone this repository, and install it manually:gitclonehttps://github.com/fizista/micropython-scron.gitcd./micropython-scron./flash-src.shESP8266The library on this processor must be compiled into binary code.The MicroPython cross compiler is needed for this.If you already have the mpy-cross command available, then run the bash script:./compile.shand then upload the library to the device, e.g. using the following script:./flash-byte.shImportant!An even better solution is to integrate this module into the firmware.
The module takes up much less RAM.To do this, copy thescronmodule tomicropython/ports/esp8266/modules.
Then compile the sources, and upload them to your device.Simple examplesImportant!You have to add the following lines of code if your application does not periodically run more actions
than the maximum timer time. Calls should be more often than about 5 minutes.simple_cron.add('null',lambda*a,**k:None,seconds=0,minutes=range(0,59,5),removable=False)Simple code to run every second:fromscron.weekimportsimple_cron# OR# SimpleCRON single-class library, with minimal recursion depth.# This is mainly for ESP8266, because we have very few possible recursions.fromscron.cweekimportsimple_cron# Depending on the device, you need to add a task that# will be started at intervals shorter than the longest# time the timer can count.simple_cron.add('null',lambda*a,**k:None,seconds=0,minutes=range(0,59,5),removable=False)simple_cron.add('helloID',lambda*a,**k:print('hello'))simple_cron.run()Code, which is activated once a Sunday at 12:00.00:simple_cron.add('Sunday12.00',lambda*a,**k:print('wake-up call'),weekdays=6,hours=12,minutes=0,seconds=0)Every second minute:simple_cron.add('Every second minute',lambda*a,**k:print('second call'),minutes=range(0,59,2),seconds=0)Other usage samples can be found in the ‘examples’ directory.How to use itSomewhere in your code you have to add the following code,
and from then on SimpleCRON is ready to use.fromscron.weekimportsimple_cronsimple_cron.run()# You have to run it once. This initiates the SimpleCRON action,# and reserve one timmer.To add a task you are using:simple_cron.add(<callback_id_string>,<callback>,...)CallbacksExample of a callback:defsome_counter(scorn_instance,callback_name,pointer,memory):if'counter'inmemory:memory['counter']+=1else:memory['counter']=1where:scorn_instance- SimpleCRON instance, in this case scron.weekend.simple_croncallback_name- Callback IDpointer- This is an indicator of the time in which the task was to be run.
Example: (6, 13, 5, 10).  This is(Sunday,1 p.m.,minutes 5,seconds 10)memory- Shared memory for this particular callback, between all calls.
By default this is a dictionary.If for some reason a running callback throws an exception,
then it is possible to process this event with special functions.
The default exception processing function is print().To add new processing functions for callback exceptions, simply add them to the list below:simple_cron.callback_exception_processors(processor_function)where:processor_function is function(exception_instance)Important notes:If a task takes a very long time, it blocks the execution of other tasks!If there are several functions to run at a given time, then they are
started without a specific order.If the time has been changed (time synchronization with the network,
own time change), run thesimple_cron._sync_time()function,
which will set a specific point in time. Without this setting,
it may happen that some callbacks will not be started.What has not been tested:SimpleCRON operation during sleepHow to testFirst install the following things:gitclonehttps://github.com/fizista/micropython-scron.gitcdmicropython-scron/micropython-mupipinstall-pmodulesmicropython-unittestmicropython-mupipinstall-pmodulesmicropython-timeThen run the tests:./run_tests.shTesting directly on the device:pipinstallpyserialadafruit-ampy./run_tests_esp.shupload_combined./run_tests_esp.shrun/dev/ttyUSB0./run_tests_esp.shupload./run_tests_esp.shrun/dev/ttyUSB0Support and licenseIf you have found a mistake or other problem, write in the issues.If you need a different license for this library (e.g. commercial),
please contact me:fizista+scron@gmail.com.