├── .github └── ISSUE_TEMPLATE │ └── bug_report.md ├── .gitignore ├── LICENSE ├── README.rst ├── compile.sh ├── mcron ├── __init__.py ├── decorators.py └── version.py ├── setup.py └── tests.py /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: Create a report to help us improve 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Describe the bug** 11 | A clear and concise description of what the bug is. 12 | 13 | **To Reproduce** 14 | Steps to reproduce the behavior: 15 | For example a piece of code that can be pasted into a micropython console. 16 | 17 | **Details (please complete the following information):** 18 | - Device board: [e.g. ESP32] 19 | - Micropython version: [e.g. 1.12, name or URL fork] 20 | - Library version [e.g. 0.1] 21 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | pip-wheel-metadata/ 24 | share/python-wheels/ 25 | *.egg-info/ 26 | .installed.cfg 27 | *.egg 28 | MANIFEST 29 | 30 | # PyInstaller 31 | # Usually these files are written by a python script from a template 32 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 33 | *.manifest 34 | *.spec 35 | 36 | # Installer logs 37 | pip-log.txt 38 | pip-delete-this-directory.txt 39 | 40 | # Unit test / coverage reports 41 | htmlcov/ 42 | .tox/ 43 | .nox/ 44 | .coverage 45 | .coverage.* 46 | .cache 47 | nosetests.xml 48 | coverage.xml 49 | *.cover 50 | *.py,cover 51 | .hypothesis/ 52 | .pytest_cache/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | target/ 76 | 77 | # Jupyter Notebook 78 | .ipynb_checkpoints 79 | 80 | # IPython 81 | profile_default/ 82 | ipython_config.py 83 | 84 | # pyenv 85 | .python-version 86 | 87 | # pipenv 88 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 89 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 90 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 91 | # install all needed dependencies. 92 | #Pipfile.lock 93 | 94 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 95 | __pypackages__/ 96 | 97 | # Celery stuff 98 | celerybeat-schedule 99 | celerybeat.pid 100 | 101 | # SageMath parsed files 102 | *.sage.py 103 | 104 | # Environments 105 | .env 106 | .venv 107 | env/ 108 | venv/ 109 | ENV/ 110 | env.bak/ 111 | venv.bak/ 112 | 113 | # Spyder project settings 114 | .spyderproject 115 | .spyproject 116 | 117 | # Rope project settings 118 | .ropeproject 119 | 120 | # mkdocs documentation 121 | /site 122 | 123 | # mypy 124 | .mypy_cache/ 125 | .dmypy.json 126 | dmypy.json 127 | 128 | # Pyre type checker 129 | .pyre/ 130 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | .. role:: bash(code) 2 | :language: bash 3 | 4 | .. role:: python(code) 5 | :language: python 6 | 7 | *************************** 8 | MicroCRON for MicroPython 9 | *************************** 10 | 11 | MicroCRON is a time-based task scheduling program. 12 | 13 | The library was designed after the experience with its larger predecessor SimpleCRON_. The current library focuses 14 | on minimalism of code while keeping maximum functionality. It takes 3 times less memory than SimpleCRON_. 15 | It needs about 3kB of memory to work. 16 | 17 | The software was tested under micropython 1.12 (esp32, esp8266). 18 | 19 | What you can do with this library: 20 | ################################## 21 | 22 | * Run any task at precisely defined intervals 23 | * Delete and add tasks while the program is running. 24 | * Run the task a certain number of times and many more. 25 | 26 | Library working principle: 27 | ########################## 28 | 29 | Generally, the working principle is, in a pseudo-code: 30 | 31 | .. code-block:: 32 | 33 | insert(action_period, action_pointers, 'minute_5s', callback) 34 | 35 | while (the hardware timer is running): 36 | current_action_period_pointer = current_time % action_period 37 | if current_action_period_pointer in action_pointers: 38 | run callback 39 | 40 | We have almost complete freedom to choose the action_period as long as it is greater than zero. 41 | 42 | The action_pointers variable should contain data of "set" or "range" type. 43 | 44 | When we want to use irregular points in time we use "set". Otherwise, you can use "range". This gives us minimal 45 | memory overhead and at the same time a lot of freedom in defining when actions are to start. 46 | 47 | Requirements: 48 | ############# 49 | 50 | * The board on which the micropython is installed(v1.12) 51 | * The board must have support for hardware timers. 52 | 53 | Install 54 | ####### 55 | You can install using the upip: 56 | 57 | .. code-block:: python 58 | 59 | import upip 60 | upip.install("micropython-mcron") 61 | 62 | or 63 | 64 | .. code-block:: bash 65 | 66 | micropython -m upip install -p modules micropython-mcron 67 | 68 | You can clone this repository, and install it manually: 69 | 70 | .. code-block:: bash 71 | 72 | git clone https://github.com/fizista/micropython-mcron.git 73 | cd ./micropython-mcron 74 | 75 | Simple examples 76 | ############### 77 | 78 | Simple code run every 5 seconds: 79 | 80 | .. code-block:: python 81 | 82 | import utime 83 | import mcron 84 | import mcron.decorators 85 | 86 | c = 0 87 | 88 | def counter(callback_id, current_time, callback_memory): 89 | global c 90 | c += 1 91 | print('call: %s %s' % (c, utime.localtime())) 92 | 93 | mcron.init_timer() 94 | mcron.insert(mcron.PERIOD_MINUTE, range(0, mcron.PERIOD_MINUTE, 5), 'minute_5s', counter) 95 | 96 | Start the task at exactly 6:30 a.m. and 10:30 p.m. every day. 97 | 98 | .. code-block:: python 99 | 100 | mcron.insert(mcron.PERIOD_DAY, {6 * 60 * 60 + 30 * 60, 22 * 60 * 60 + 30 * 60}, 'day_6_30__22_30', callback) 101 | 102 | Start the task 4 times a day. 103 | 104 | .. code-block:: python 105 | 106 | mcron.insert(mcron.PERIOD_DAY, range(0, mcron.PERIOD_DAY, mcron.PERIOD_DAY // 4), 'day_x4', callback) 107 | 108 | Start the task every 11 seconds from now. 109 | 110 | .. code-block:: python 111 | 112 | mcron.insert(11, {0}, '11s_now', callback, from_now=True) 113 | 114 | Start the task every 11 seconds. 115 | 116 | .. code-block:: python 117 | 118 | mcron.insert(11, {0}, '11s', callback) 119 | 120 | Start the task successfully three times. Start this task every 5 seconds. 121 | 122 | .. code-block:: python 123 | 124 | mcron.insert( 125 | mcron.PERIOD_MINUTE, range(0, mcron.PERIOD_MINUTE, 5), 'minute_5s_3x_suc', 126 | mcron.decorators.successfully_run_times(3)(lambda *a, **k: utime.time() % 10 == 0) 127 | ) 128 | 129 | Start the task three times. Start this task every 5 seconds. 130 | 131 | .. code-block:: python 132 | 133 | mcron.insert( 134 | mcron.PERIOD_MINUTE, range(0, mcron.PERIOD_MINUTE, 5), 'minute_5s_3x', 135 | mcron.decorators.run_times(3)(callback) 136 | ) 137 | 138 | Remove the action: 139 | 140 | .. code-block:: python 141 | 142 | mcron.remove('action_id') 143 | 144 | Remove all actions: 145 | 146 | .. code-block:: python 147 | 148 | mcron.remove_all() 149 | 150 | Capturing action errors is possible by replacing and/or adding your own function. 151 | 152 | .. code-block:: python 153 | 154 | def my_exception_processor(e): 155 | send_exception_to_server(e) 156 | write_exception_to_disk(e) 157 | 158 | mcron.callback_exception_processors.append(my_exception_processor) 159 | 160 | Important notes: 161 | ################ 162 | 163 | * If the execution time of all tasks is longer than (1000ms - 1.5 * _timer_period), then the TLPTimeException exception 164 | is thrown. This tells you that a task is blocking the device, and probably prevents the execution of the next action 165 | in the next second. It will be up to the programmer what he will do after intercepting this error. He can do nothing, 166 | and he can run the missed tasks. 167 | * If there are several functions to run at a given time, then they are started without a specific order. 168 | 169 | How to test 170 | ########### 171 | 172 | Copy the tests.py file from the https://github.com/fizista/micropython-mcron.git repository to your test board 173 | and run the command on this device: 174 | 175 | .. code-block:: python 176 | 177 | import tests 178 | 179 | ******************* 180 | Support and license 181 | ******************* 182 | 183 | If you have found a mistake or other problem, write in the issues. 184 | 185 | If you need a different license for this library (e.g. commercial), 186 | please contact me: fizista+mcron@gmail.com. 187 | 188 | 189 | .. _SimpleCRON: https://github.com/fizista/micropython-scron -------------------------------------------------------------------------------- /compile.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | OUTPUT=./build 4 | 5 | if [ -d "$OUTPUT" ]; then 6 | rm -r "$OUTPUT" 7 | fi 8 | 9 | mkdir "$OUTPUT" 10 | 11 | function compile() { 12 | FILE_PATH="$1" 13 | 14 | file_name=$(basename $FILE_PATH) 15 | file_name="${file_name%.*}.mpy" 16 | file_dir=$(dirname $FILE_PATH) 17 | 18 | 19 | out_dir="${OUTPUT}/${file_dir}" 20 | out_path="$out_dir/$file_name" 21 | mp_path="${FILE_PATH%.*}.mpy" 22 | mp_path="${FILE_PATH:2}" 23 | 24 | if [ ! -d "$out_dir" ]; then 25 | mkdir "$out_dir" 26 | fi 27 | 28 | echo "Compile $FILE_PATH => $out_path" 29 | 30 | MP_FILE_PATH="${FILE_PATH%.*}.mpy" 31 | 32 | #mpy-cross -mno-unicode -o "$out_path" -s "$mp_path" "$FILE_PATH" 33 | #mpy-cross -march=xtensa -X emit=native "$FILE_PATH" &>/dev/null || mpy-cross -march=xtensa "$FILE_PATH" 34 | mpy-cross "$FILE_PATH" 35 | mv "$MP_FILE_PATH" "$out_dir" 36 | } 37 | 38 | for file_path in ./mcron/*.py 39 | do 40 | compile "$file_path" 41 | done 42 | 43 | compile "./tests.py" 44 | -------------------------------------------------------------------------------- /mcron/__init__.py: -------------------------------------------------------------------------------- 1 | import utime 2 | import machine 3 | 4 | PERIOD_CENTURY = const(100 * 365 * 24 * 60 * 60) # Warning: average value 5 | PERIOD_YEAR = const(365 * 24 * 60 * 60) # Warning: average value 6 | PERIOD_MONTH = const((365 * 24 * 60 * 60) // 12) # Warning: average value 7 | PERIOD_WEEK = const(7 * 24 * 60 * 60) 8 | PERIOD_DAY = const(24 * 60 * 60) 9 | PERIOD_HOUR = const(60 * 60) 10 | PERIOD_MINUTE = const(60) 11 | 12 | # { 13 | # : { 14 | # period_steps: [, , ...] 15 | # } 16 | # } 17 | timer_table = {} 18 | 19 | # { 20 | # : {} 21 | # } 22 | memory_table = {} 23 | 24 | # { 25 | # : 26 | # } 27 | callback_table = {} 28 | 29 | # machine.Timer instance 30 | timer = None 31 | 32 | # A list of functions that process the captured exception, received from the running callback. 33 | # processor_exception_function(exception_instance) 34 | callback_exception_processors = [lambda e: print('Callback EXCEPTION: %s' % e)] 35 | 36 | STEP_TYPE_RANGE = const(1) 37 | STEP_TYPE_SET = const(2) 38 | 39 | _last_run_time = None 40 | _timer_period = None # You have to turn the timer on by: init_timer 41 | _max_time_task_calls = None # You have to turn the timer on by: init_timer 42 | 43 | 44 | class TLPTimeException(Exception): 45 | """ 46 | Too long processing time. 47 | The maximum time is: 1000 [ms] - 1.5 * period [ms] 48 | """ 49 | pass 50 | 51 | 52 | def insert(period, period_steps, callback_id, callback, period_offset=0, from_now=False): 53 | """ 54 | 55 | Examples: 56 | * Starting once after XX seconds. 57 | insert(+1, {}, 'callback-id', run_times(1)(), from_now=True) 58 | * Running twice a day at 23:59 and 6:00 a.m. 59 | insert(mcron.PERIOD_DAY, {23 * 59 * 59, 6 * 60 * 60}, 'callback-id', ) 60 | 61 | :param period: A period of time during which the steps are repeated. 62 | :type period: int 63 | :param period_steps: The steps where the callbacks are called. The steps must be integer type. 64 | :type period_steps: range or set 65 | :param callback_id: 66 | :type callback_id: str 67 | :param callback: callable(callback_id, current_time, callback_memory) 68 | :type callback: callable 69 | :param period_offset: The beginning of the period is shifted by the set value. 70 | :type period_offset: int 71 | :param from_now: The period will start when the task is added. 72 | :return: 73 | """ 74 | global timer_table, memory_table, callback_table, callback_exception_processors 75 | 76 | if callback_id in callback_table: 77 | raise Exception('Callback ID - exists') 78 | 79 | if type(period) is not int: 80 | raise TypeError('period is not int') 81 | 82 | if from_now: 83 | period_offset = -1 * utime.time() % period 84 | 85 | if type(period_offset) is not int: 86 | raise TypeError('period_offset is not int') 87 | 88 | if type(period_steps).__name__ == 'range': 89 | period_steps = (STEP_TYPE_RANGE,) + (period_steps.start, period_steps.stop, period_steps.step) 90 | elif type(period_steps).__name__ == 'set': 91 | period_steps = (STEP_TYPE_SET,) + tuple(period_steps) 92 | else: 93 | raise Exception('period_steps wrong type') 94 | 95 | for s in period_steps[1:]: 96 | if type(s) is not int: 97 | raise TypeError('period step is not int %s' % str(period_steps)) 98 | 99 | callback_table[callback_id] = callback 100 | 101 | period_info = (period, period_offset) 102 | if period_info in timer_table: 103 | period_data = timer_table[period_info] 104 | else: 105 | period_data = {} 106 | timer_table[period_info] = period_data 107 | 108 | if period_steps in period_data: 109 | callback_ids = period_data[period_steps] 110 | else: 111 | callback_ids = set() 112 | period_data[period_steps] = callback_ids 113 | callback_ids.add(callback_id) 114 | 115 | 116 | def remove(callback_id): 117 | global timer_table, memory_table, callback_table 118 | to_del_pi = [] 119 | for period_info, period_data in timer_table.items(): 120 | to_del_ps = [] 121 | for period_steps, callback_ids in period_data.items(): 122 | if callback_id in callback_ids: 123 | callback_ids.remove(callback_id) 124 | if callback_id in memory_table: 125 | memory_table.pop(callback_id) 126 | if len(callback_ids) <= 0: 127 | to_del_ps.append(period_steps) 128 | for period_steps in to_del_ps: 129 | period_data.pop(period_steps) 130 | del to_del_ps 131 | if not period_data: 132 | to_del_pi.append(period_info) 133 | for period_info in to_del_pi: 134 | timer_table.pop(period_info) 135 | del to_del_pi 136 | if callback_id in callback_table: 137 | callback_table.pop(callback_id) 138 | 139 | 140 | def remove_all(): 141 | global callback_table 142 | for cid in callback_table.keys(): 143 | remove(cid) 144 | 145 | 146 | def get_actions(current_time): 147 | global timer_table, memory_table, callback_table, callback_exception_processors 148 | for period_info, period_data in timer_table.items(): 149 | period, period_offset = period_info 150 | period_pointer = (current_time + period_offset) % period 151 | for period_steps, callback_ids in period_data.items(): 152 | if STEP_TYPE_SET == period_steps[0] and period_pointer in period_steps[1:] or \ 153 | STEP_TYPE_RANGE == period_steps[0] and period_pointer in range(*period_steps[1:]): 154 | yield from callback_ids 155 | 156 | 157 | def run_actions(current_time): 158 | global timer_table, memory_table, callback_table, callback_exception_processors 159 | for callback_id in get_actions(current_time): 160 | callback_memory = memory_table.setdefault(callback_id, {}) 161 | action_callback = callback_table[callback_id] 162 | 163 | try: 164 | action_callback(callback_id, current_time, callback_memory) 165 | except Exception as e: 166 | for processor in callback_exception_processors: 167 | processor(e) 168 | 169 | 170 | def run_actions_callback(*args, **kwargs): 171 | global timer_table, memory_table, callback_table, callback_exception_processors, _last_run_time, _timer_period, _max_time_task_calls 172 | 173 | current_time = utime.time() 174 | if current_time == _last_run_time: 175 | return 176 | _last_run_time = current_time 177 | start = utime.ticks_ms() 178 | 179 | run_actions(current_time) 180 | 181 | stop = utime.ticks_ms() 182 | processing_time = utime.ticks_diff(stop, start) 183 | if processing_time > _max_time_task_calls: 184 | e = TLPTimeException(current_time, processing_time, ' '.join(get_actions(current_time))) 185 | for processor in callback_exception_processors: 186 | processor(e) 187 | 188 | 189 | def init_timer(timer_id=3, timer_period=250): 190 | """ 191 | 192 | :param timer_id: 193 | :param timer_period: Number of milliseconds between run_actions calls. The recommended value is 250ms. For values greater than 1000ms some action calls may be omitted. 194 | :type timer_period: int 195 | :return: 196 | """ 197 | global timer, _timer_period, _max_time_task_calls, timer 198 | _timer_period = timer_period 199 | _max_time_task_calls = 1000 - 1.5 * _timer_period 200 | timer = machine.Timer(timer_id) 201 | timer.init(period=_timer_period, mode=machine.Timer.PERIODIC, callback=run_actions_callback) 202 | -------------------------------------------------------------------------------- /mcron/decorators.py: -------------------------------------------------------------------------------- 1 | import mcron 2 | 3 | RUN_TIMES_MEM_ID = const(2) 4 | 5 | 6 | def run_times(times): 7 | """ 8 | The decorator determines how many times the given callback can be started. 9 | 10 | :param times: number of start-ups 11 | :return: 12 | """ 13 | 14 | def decorator(callback): 15 | def wrapper(callback_id, current_time, callback_memory): 16 | callback_memory[RUN_TIMES_MEM_ID] = callback_memory.setdefault(RUN_TIMES_MEM_ID, 0) + 1 17 | out = callback(callback_id, current_time, callback_memory) 18 | if callback_memory[RUN_TIMES_MEM_ID] >= times: 19 | mcron.remove(callback_id) 20 | return out 21 | 22 | return wrapper 23 | 24 | return decorator 25 | 26 | 27 | SUCCESSFULLY_RUN_TIMES_MEM_ID = const(3) 28 | 29 | 30 | def successfully_run_times(times): 31 | """ 32 | The decorator determines how many times the given callback can be started. 33 | 34 | Launching a task is considered correct only if the callback returns True. 35 | 36 | :param times: number of start-ups 37 | :return: 38 | """ 39 | MEM_ID = '__srt' 40 | 41 | def decorator(callback): 42 | def wrapper(callback_id, current_time, callback_memory): 43 | out = callback(callback_id, current_time, callback_memory) 44 | callback_memory[SUCCESSFULLY_RUN_TIMES_MEM_ID] = \ 45 | callback_memory.setdefault(SUCCESSFULLY_RUN_TIMES_MEM_ID, 0) + int(bool(out)) 46 | if callback_memory[SUCCESSFULLY_RUN_TIMES_MEM_ID] >= times: 47 | mcron.remove(callback_id) 48 | return out 49 | 50 | return wrapper 51 | 52 | return decorator 53 | 54 | 55 | CALL_COUNTER_MEM_ID = const(4) 56 | 57 | 58 | def call_counter(callback): 59 | """ 60 | Decorator counts the number of callback calls. 61 | 62 | The number of calls is stored in memory[call_counter.ID]. 63 | 64 | :param callback: 65 | :return: 66 | """ 67 | 68 | def decorator(callback_id, current_time, callback_memory): 69 | callback_memory[CALL_COUNTER_MEM_ID] = callback_memory.setdefault(CALL_COUNTER_MEM_ID, 0) + 1 70 | return callback(callback_id, current_time, callback_memory) 71 | 72 | return decorator 73 | 74 | 75 | def debug_call(callback): 76 | """ 77 | The decorator displays information about the current call 78 | 79 | :param callback: 80 | :return: 81 | """ 82 | 83 | @call_counter 84 | def wrap(callback_id, current_time, callback_memory): 85 | import utime 86 | print( 87 | 'START call(%3d): %25s, pointer%18s' % ( 88 | callback_memory[CALL_COUNTER_MEM_ID], 89 | callback_id, 90 | str(utime.localtime(current_time)) 91 | ) 92 | ) 93 | mem_before = dict([(k, d) for k, d in callback_memory.items() if not k.startswith('__')]) 94 | print(' Memory before call: %s' % mem_before) 95 | out = callback(callback_id, current_time, callback_memory) 96 | mem_after = dict([(k, d) for k, d in callback_memory.items() if not k.startswith('__')]) 97 | print(' Memory after call: %s' % mem_after) 98 | print( 99 | 'END call(%3d): %25s, pointer%18s' % ( 100 | callback_memory[CALL_COUNTER_MEM_ID], 101 | callback_id, 102 | str(utime.localtime(current_time)) 103 | ) 104 | ) 105 | print() 106 | return out 107 | 108 | return wrap 109 | -------------------------------------------------------------------------------- /mcron/version.py: -------------------------------------------------------------------------------- 1 | __version__ = '1.1.2' 2 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | import sys 2 | from pathlib import Path 3 | 4 | __dir__ = Path(__file__).absolute().parent 5 | # Remove current dir from sys.path, otherwise setuptools will peek up our 6 | # module instead of system's. 7 | sys.path.pop(0) 8 | from setuptools import setup 9 | 10 | sys.path.append("..") 11 | import sdist_upip 12 | 13 | exec(open('mcron/version.py').read()) 14 | 15 | 16 | def read(file_relative): 17 | file = __dir__ / file_relative 18 | with open(str(file)) as f: 19 | return f.read() 20 | 21 | 22 | setup( 23 | name='micropython-mcron', 24 | version=__version__, 25 | description='MicroCRON for MicroPython.', 26 | long_description=read('README.rst'), 27 | long_description_content_type="text/x-rst", 28 | url='https://github.com/fizista/micropython-mcron', 29 | author='Wojciech Banaś', 30 | author_email='fizista@gmail.com', 31 | maintainer='Wojciech Banaś', 32 | maintainer_email='fizista+mcron@gmail.com', 33 | license='AGPL3', 34 | classifiers=[ 35 | 'Programming Language :: Python', 36 | 'Programming Language :: Python :: Implementation :: MicroPython', 37 | ], 38 | keywords='cron scheduler micropython', 39 | cmdclass={'sdist': sdist_upip.sdist}, 40 | packages=['mcron'], 41 | project_urls={ 42 | 'Bug Reports': 'https://github.com/fizista/micropython-mcron/issues', 43 | 'Documentation': 'https://fizista.github.io/micropython-mcron/', 44 | 'Source': 'https://github.com/fizista/micropython-mcron', 45 | }, 46 | ) 47 | -------------------------------------------------------------------------------- /tests.py: -------------------------------------------------------------------------------- 1 | import utime 2 | import machine 3 | import mcron 4 | from mcron import insert, remove, remove_all, PERIOD_WEEK, PERIOD_DAY, PERIOD_HOUR, PERIOD_MINUTE, \ 5 | run_actions_callback, callback_table, memory_table 6 | from mcron.decorators import run_times, successfully_run_times, call_counter, debug_call 7 | 8 | 9 | def set_time(year, month, day, hour, minute, second): 10 | machine.RTC().datetime((year, month, day, 0, hour, minute, second, 0)) 11 | t = utime.time() 12 | lt = utime.localtime(t) 13 | print('Current time: %s (%s)' % (str(lt), t)) 14 | 15 | 16 | test_callback_used = False 17 | 18 | 19 | def test_time(year, month, day, hour, minute, second, callback_used): 20 | global test_callback_used 21 | test_callback_used = False 22 | set_time(year, month, day, hour, minute, second) 23 | run_actions_callback() 24 | if callback_used != test_callback_used: 25 | raise Exception('The callback function %s' % 'must be used' if callback_used else 'cannot be used') 26 | 27 | 28 | test_title = '' 29 | 30 | 31 | def test_start(title=''): 32 | global test_title 33 | print('START: %s' % title) 34 | test_title = title 35 | 36 | 37 | def test_end(): 38 | global test_title 39 | remove_all() 40 | print('END: %s' % test_title) 41 | test_title = '' 42 | 43 | 44 | def mini_debug(callback_id, current_time, callback_memory): 45 | global test_callback_used 46 | print('CB: %10s (%s) %s %s' % (callback_id, current_time, callback_memory, utime.localtime(current_time))) 47 | test_callback_used = True 48 | 49 | 50 | def mini_debug_call(f): 51 | def deco(callback_id, current_time, callback_memory): 52 | mini_debug(callback_id, current_time, callback_memory) 53 | return f(callback_id, current_time, callback_memory) 54 | 55 | return deco 56 | 57 | 58 | def test_remove() 59 | mcron.insert(mcron.PERIOD_DAY, {0}, "test_remove", mini_debug) 60 | mcron.remove("test_remove") 61 | if mcron.callback_table.get("test_remove") is not None: 62 | raise Exception("The callback function was not removed") 63 | 64 | 65 | mcron.init_timer() 66 | mcron.timer.deinit() 67 | 68 | test_start('minute_15s') 69 | insert(PERIOD_MINUTE, range(0, PERIOD_MINUTE, 15), 'minute_15s', mini_debug) 70 | test_time(2020, 12, 24, 15, 30, 0, True) 71 | test_time(2020, 12, 24, 15, 30, 20, False) 72 | test_time(2020, 12, 24, 15, 30, 30, True) 73 | test_time(2020, 12, 24, 15, 30, 31, False) 74 | test_time(2020, 12, 24, 15, 30, 45, True) 75 | test_end() 76 | 77 | test_start('hour_60s') 78 | insert(PERIOD_HOUR, range(0, PERIOD_HOUR, 60), 'hour_60s', mini_debug) 79 | test_time(2020, 12, 24, 15, 30, 0, True) 80 | test_time(2020, 12, 24, 15, 30, 0, False) # We cannot allow callbacks to be restarted at the same time 81 | for i in range(1, 60): 82 | test_time(2020, 12, 24, 15, 30, i, False) 83 | test_end() 84 | 85 | test_start('minute_5s_3x_suc') 86 | insert(PERIOD_MINUTE, range(0, PERIOD_MINUTE, 5), 'minute_5s_3x_suc', 87 | successfully_run_times(3)(mini_debug_call(lambda *a, **k: utime.time() % 10 == 0))) 88 | test_time(2020, 12, 24, 15, 30, 21, False) 89 | test_time(2020, 12, 24, 15, 30, 25, True) # Call return False 90 | test_time(2020, 12, 24, 15, 30, 23, False) 91 | test_time(2020, 12, 24, 15, 30, 30, True) # Call return True 1 92 | test_time(2020, 12, 24, 15, 30, 35, True) # Call return False 93 | test_time(2020, 12, 24, 15, 30, 40, True) # Call return True 2 94 | test_time(2020, 12, 24, 15, 30, 50, True) # Call return True 3 95 | test_time(2020, 12, 24, 15, 31, 0, False) 96 | test_time(2020, 12, 24, 15, 31, 5, False) 97 | test_time(2020, 12, 24, 15, 31, 10, False) 98 | assert len(callback_table) == 0 99 | test_end() 100 | 101 | test_start('minute_5s_3x') 102 | insert(PERIOD_MINUTE, range(0, PERIOD_MINUTE, 5), 'minute_5s_3x', 103 | run_times(3)(mini_debug_call(lambda *a, **k: utime.time() % 10 == 0))) 104 | test_time(2020, 12, 24, 15, 30, 21, False) 105 | test_time(2020, 12, 24, 15, 30, 25, True) # Call return False 1 106 | test_time(2020, 12, 24, 15, 30, 23, False) 107 | test_time(2020, 12, 24, 15, 30, 30, True) # Call return True 2 108 | test_time(2020, 12, 24, 15, 30, 35, True) # Call return False 3 109 | test_time(2020, 12, 24, 15, 30, 40, False) 110 | test_time(2020, 12, 24, 15, 30, 50, False) 111 | test_time(2020, 12, 24, 15, 31, 0, False) 112 | test_time(2020, 12, 24, 15, 31, 5, False) 113 | test_time(2020, 12, 24, 15, 31, 10, False) 114 | assert len(callback_table) == 0 115 | test_end() 116 | 117 | test_start('minute_5s_cc7') 118 | insert(PERIOD_MINUTE, range(0, PERIOD_MINUTE, 5), 'minute_5s_cc7', 119 | call_counter(mini_debug_call(lambda *a, **k: utime.time() % 10 == 0))) 120 | test_time(2020, 12, 24, 15, 30, 21, False) 121 | test_time(2020, 12, 24, 15, 30, 25, True) # 1 122 | test_time(2020, 12, 24, 15, 30, 23, False) 123 | test_time(2020, 12, 24, 15, 30, 30, True) # 2 124 | test_time(2020, 12, 24, 15, 30, 35, True) # 3 125 | test_time(2020, 12, 24, 15, 30, 40, True) # 4 126 | test_time(2020, 12, 24, 15, 30, 50, True) # 5 127 | test_time(2020, 12, 24, 15, 31, 0, True) # 6 128 | test_time(2020, 12, 24, 15, 31, 5, True) # 7 129 | test_time(2020, 12, 24, 15, 31, 10, True) # 8 130 | assert list(memory_table['minute_5s_cc7'].values())[0] == 8 131 | test_end() 132 | 133 | # Start the task at exactly 6:30 a.m. and 10:30 p.m. every day. 134 | test_start('day_6_30__22_30') 135 | insert(PERIOD_DAY, {6 * 60 * 60 + 30 * 60, 22 * 60 * 60 + 30 * 60}, 'day_6_30__22_30', mini_debug) 136 | test_time(2020, 12, 24, 5, 30, 21, False) 137 | test_time(2020, 12, 24, 6, 30, 0, True) 138 | test_time(2020, 12, 24, 6, 30, 1, False) 139 | test_time(2020, 12, 24, 22, 30, 0, True) 140 | test_end() 141 | 142 | # Start the task 4 times a day 143 | test_start('day_x4') 144 | insert(PERIOD_DAY, range(0, PERIOD_DAY, PERIOD_DAY // 4), 'day_x4', mini_debug) 145 | test_time(2020, 12, 24, 0, 0, 0, True) 146 | test_time(2020, 12, 24, 0, 0, 1, False) 147 | test_time(2020, 12, 24, 6, 0, 0, True) 148 | test_time(2020, 12, 24, 12, 0, 0, True) 149 | test_time(2020, 12, 24, 18, 0, 0, True) 150 | test_end() 151 | 152 | # Start the task every 11 seconds from now. 153 | test_start('11s_now') 154 | test_time(2020, 12, 24, 6, 6, 6, False) 155 | insert(11, {0}, '11s_now', mini_debug, from_now=True) 156 | test_time(2020, 12, 24, 6, 6, 6 + 11, True) 157 | test_time(2020, 12, 24, 6, 6, 6 + 11 + 1, False) 158 | test_time(2020, 12, 24, 6, 6, 6 + 11 * 2, True) 159 | test_time(2020, 12, 24, 6, 6, 6 + 11 * 3, True) 160 | test_end() 161 | 162 | # Start the task every 11 seconds. 163 | test_start('11s') 164 | test_time(2020, 12, 24, 6, 6, 6, False) 165 | insert(11, {0}, '11s', mini_debug, from_now=False) 166 | test_time(2020, 12, 24, 6, 6, 6 + 11, False) 167 | test_time(2020, 12, 24, 6, 6, 6 + 11 + 1, False) 168 | test_time(2020, 12, 24, 6, 6, 6 + 11 * 2, False) 169 | test_time(2020, 12, 24, 6, 6, 6 + 11 * 3, False) 170 | test_time(2020, 12, 24, 6, 6, 9, True) 171 | test_time(2020, 12, 24, 6, 6, 9 + 11, True) 172 | test_time(2020, 12, 24, 6, 6, 9 + 11 * 2, True) 173 | test_time(2020, 12, 24, 6, 6, 9 + 11 * 3, True) 174 | test_time(2020, 12, 24, 6, 6, 9 + 11 * 4, True) 175 | test_end() 176 | 177 | 178 | test_start('remove') 179 | test_remove() 180 | test_end() 181 | --------------------------------------------------------------------------------