├── .gitignore ├── LICENSE ├── README.md ├── docs ├── block.png ├── block.puml └── device.jpg ├── ds3231.py ├── eink.py └── main.py /.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 GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 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 General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Blackout Logger 2 | 3 | A miniature device that's keeping track of power outages. 4 | 5 | ![](docs/device.jpg) 6 | ### [Video in action](https://twitter.com/dr2mod/status/1591815766994980866) 7 | 8 | ### Hardware 9 | * Raspberry Pi Pico 10 | * Precision RTC Module (DS3231) 11 | * Waveshare eink 3.7 12 | 13 | 14 | ### Software 15 | #### MicroPython 16 | The software is written in MicroPython 1.19.1 17 | 18 | 1. Download the MicroPython UF2. 19 | 2. Push and hold the BOOTSEL button and plug your Pico into the USB port of your computer. Release the BOOTSEL button after your Pico is connected. 20 | 3. It will mount as a Mass Storage Device called RPI-RP2. 21 | 4. Drag and drop the MicroPython UF2 file onto the RPI-RP2 volume. 22 | 23 | #### rshell 24 | To upload and configure your Pico Solar System you will need to install rshell. Make sure you have _pip_ installed. 25 | ``` 26 | pip3 install rshell 27 | ``` 28 | 29 | #### Installing Pico Solar System 30 | 1. Download Pico Solar System 31 | ``` 32 | git clone https://github.com/dr-mod/blackout-logger.git 33 | ``` 34 | 2. Open the directory with the source code 35 | ``` 36 | cd blackout-logger 37 | ``` 38 | 3. Copy required python files to your pico 39 | ``` 40 | rshell 41 | cp *.py /pyboard/ 42 | ``` 43 | 4. Set time & configure the RTC module 44 | ``` 45 | repl 46 | 47 | import time 48 | import ds3231 49 | rtc = ds3231.ds3231() 50 | rtc.set_time(time.time()) 51 | ``` 52 | To account for a timezone you might want to apply an offset to the UTC timestamp in seconds: 53 | ``` 54 | rtc.set_time(time.time() + 60 * 60 * (+ OFFSET_IN_HOURS) ) 55 | ``` 56 | 57 | ### Support the project 58 | If you would like to support what I do and keep me caffeinated, you can do it here: 59 | 60 | [!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/drmod) 61 | -------------------------------------------------------------------------------- /docs/block.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dr-mod/blackout-logger/0689228ee0c03a91f512c6e5dad353d78d68605f/docs/block.png -------------------------------------------------------------------------------- /docs/block.puml: -------------------------------------------------------------------------------- 1 | @startuml 2 | start 3 | :read expected powercut flag; 4 | if (Expected powercut?) then (no) 5 | 6 | :read saved on_timestamp & last_timestamp; 7 | :calculate blackout timeframe 8 | append timeframe to the file; 9 | :save current time to on_timestamp; 10 | else (yes) 11 | :clear extected powercut flag; 12 | endif 13 | :save current time to last_timestamp; 14 | :find last x of blackout from file; 15 | :full update of the display; 16 | :display blackouts; 17 | while (Always) 18 | :save current time to last_timestamp; 19 | :partial update of the display; 20 | :light sleep for 30 seconds; 21 | endwhile 22 | -[hidden]-> 23 | detach 24 | @enduml -------------------------------------------------------------------------------- /docs/device.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dr-mod/blackout-logger/0689228ee0c03a91f512c6e5dad353d78d68605f/docs/device.jpg -------------------------------------------------------------------------------- /ds3231.py: -------------------------------------------------------------------------------- 1 | from machine import Pin, I2C 2 | import time 3 | import binascii 4 | 5 | class ds3231(object): 6 | address = 0x68 7 | start_reg = 0x00 8 | alarm1_reg = 0x07 9 | control_reg = 0x0e 10 | status_reg = 0x0f 11 | 12 | def __init__(self, i2c_port = 0, i2c_scl = 21, i2c_sda = 20): 13 | try: 14 | self.bus = I2C(i2c_port, scl=Pin(i2c_scl), sda=Pin(i2c_sda)) 15 | self.bus.readfrom_mem(int(self.address), int(self.start_reg), 7) 16 | except OSError: 17 | # Fall back to i2c port 1 (pins 6,7) used by earlier, but still common, versions of the Waveshare RTC module 18 | self.bus = I2C(1, scl=Pin(7), sda=Pin(6)) 19 | self.bus.readfrom_mem(int(self.address), int(self.start_reg), 7) 20 | 21 | def set_time(self, new_time): 22 | ti = time.localtime(new_time) 23 | hour = "%02d" % ti[3] 24 | minute = "%02d" % ti[4] 25 | second = "%02d" % ti[5] 26 | week = "%02d" % (ti[6] + 1) 27 | year = str(ti[0])[2:4] 28 | month = "%02d" % ti[1] 29 | day = "%02d" % ti[2] 30 | now_time = binascii.unhexlify( 31 | (second + " " + minute + " " + hour + " " + week + " " + day + " " + month + " " + year).replace(' ', '')) 32 | self.bus.writeto_mem(int(self.address), int(self.start_reg), now_time) 33 | 34 | def read_time(self): 35 | t = self.bus.readfrom_mem(int(self.address), int(self.start_reg), 7) 36 | second = int("%02x" % (t[0] & 0x7F)) 37 | minute = int("%02x" % (t[1] & 0x7F)) 38 | hour = int("%02x" % (t[2] & 0x3F)) 39 | # week = (t[3] & 0x07) - 1 40 | day = int("%02x" % (t[4] & 0x3F)) 41 | month = int("%02x" % (t[5] & 0x1F)) 42 | year = int("20%x" % t[6]) 43 | return time.mktime((year, month, day, hour, minute, second, 0, 0)) -------------------------------------------------------------------------------- /eink.py: -------------------------------------------------------------------------------- 1 | # ***************************************************************************** 2 | # * | File : Pico_ePaper-3.7.py 3 | # * | Author : Waveshare team 4 | # * | Function : Electronic paper driver 5 | # * | Info : 6 | # *---------------- 7 | # * | This version: V1.0 8 | # * | Date : 2021-06-01 9 | # # | Info : python demo 10 | # ----------------------------------------------------------------------------- 11 | # Permission is hereby granted, free of charge, to any person obtaining a copy 12 | # of this software and associated documnetation files (the "Software"), to deal 13 | # in the Software without restriction, including without limitation the rights 14 | # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 15 | # copies of the Software, and to permit persons to whom the Software is 16 | # furished to do so, subject to the following conditions: 17 | # 18 | # The above copyright notice and this permission notice shall be included in 19 | # all copies or substantial portions of the Software. 20 | # 21 | # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 22 | # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 23 | # FITNESS OR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 24 | # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 25 | # LIABILITY WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 26 | # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 27 | # THE SOFTWARE. 28 | # 29 | 30 | from machine import Pin, SPI 31 | import framebuf 32 | import utime 33 | 34 | # Display resolution 35 | EPD_WIDTH = 280 36 | EPD_HEIGHT = 480 37 | 38 | RST_PIN = 12 39 | DC_PIN = 8 40 | CS_PIN = 9 41 | BUSY_PIN = 13 42 | 43 | EPD_3IN7_lut_4Gray_GC =[ 44 | 0x2A,0x06,0x15,0x00,0x00,0x00,0x00,0x00,0x00,0x00,#1 45 | 0x28,0x06,0x14,0x00,0x00,0x00,0x00,0x00,0x00,0x00,#2 46 | 0x20,0x06,0x10,0x00,0x00,0x00,0x00,0x00,0x00,0x00,#3 47 | 0x14,0x06,0x28,0x00,0x00,0x00,0x00,0x00,0x00,0x00,#4 48 | 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,#5 49 | 0x00,0x02,0x02,0x0A,0x00,0x00,0x00,0x08,0x08,0x02,#6 50 | 0x00,0x02,0x02,0x0A,0x00,0x00,0x00,0x00,0x00,0x00,#7 51 | 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,#8 52 | 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,#9 53 | 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,#10 54 | 0x22,0x22,0x22,0x22,0x22 55 | ] 56 | 57 | EPD_3IN7_lut_1Gray_GC =[ 58 | 0x2A,0x05,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,#1 59 | 0x05,0x2A,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,#2 60 | 0x2A,0x15,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,#3 61 | 0x05,0x0A,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,#4 62 | 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,#5 63 | 0x00,0x02,0x03,0x0A,0x00,0x02,0x06,0x0A,0x05,0x00,#6 64 | 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,#7 65 | 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,#8 66 | 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,#9 67 | 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,#10 68 | 0x22,0x22,0x22,0x22,0x22 69 | ] 70 | 71 | EPD_3IN7_lut_1Gray_DU =[ 72 | 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,#1 73 | 0x01,0x2A,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00, 74 | 0x0A,0x55,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,#3 75 | 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00, 76 | 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,#5 77 | 0x00,0x00,0x05,0x05,0x00,0x05,0x03,0x05,0x05,0x00, 78 | 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,#7 79 | 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00, 80 | 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,#9 81 | 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00, 82 | 0x22,0x22,0x22,0x22,0x22 83 | ] 84 | 85 | EPD_3IN7_lut_1Gray_A2 =[ 86 | 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,#1 87 | 0x0A,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,#2 88 | 0x05,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,#3 89 | 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,#4 90 | 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,#5 91 | 0x00,0x00,0x03,0x05,0x00,0x00,0x00,0x00,0x00,0x00,#6 92 | 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,#7 93 | 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,#8 94 | 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,#9 95 | 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,#10 96 | 0x22,0x22,0x22,0x22,0x22 97 | ] 98 | 99 | class EPD_3in7: 100 | def __init__(self): 101 | self.reset_pin = Pin(RST_PIN, Pin.OUT) 102 | 103 | self.busy_pin = Pin(BUSY_PIN, Pin.IN, Pin.PULL_UP) 104 | self.cs_pin = Pin(CS_PIN, Pin.OUT) 105 | self.width = EPD_WIDTH 106 | self.height = EPD_HEIGHT 107 | 108 | self.lut_4Gray_GC = EPD_3IN7_lut_4Gray_GC 109 | self.lut_1Gray_GC = EPD_3IN7_lut_1Gray_GC 110 | self.lut_1Gray_DU = EPD_3IN7_lut_1Gray_DU 111 | self.lut_1Gray_A2 = EPD_3IN7_lut_1Gray_A2 112 | 113 | self.black = 0x00 114 | self.white = 0xff 115 | self.darkgray = 0xaa 116 | self.grayish = 0x55 117 | 118 | 119 | self.spi = SPI(1) 120 | self.spi.init(baudrate=4000_000) 121 | self.dc_pin = Pin(DC_PIN, Pin.OUT) 122 | 123 | 124 | self.buffer_1Gray = bytearray(self.height * self.width // 8) 125 | self.buffer_4Gray = bytearray(self.height * self.width // 4) 126 | self.image1Gray = framebuf.FrameBuffer(self.buffer_1Gray, self.width, self.height, framebuf.MONO_HLSB) 127 | self.image4Gray = framebuf.FrameBuffer(self.buffer_4Gray, self.width, self.height, framebuf.GS2_HMSB) 128 | 129 | self.EPD_3IN7_4Gray_init() 130 | self.EPD_3IN7_4Gray_Clear() 131 | utime.sleep_ms(500) 132 | 133 | def digital_write(self, pin, value): 134 | pin.value(value) 135 | 136 | def digital_read(self, pin): 137 | return pin.value() 138 | 139 | def delay_ms(self, delaytime): 140 | utime.sleep(delaytime / 1000.0) 141 | 142 | def spi_writebyte(self, data): 143 | self.spi.write(bytearray(data)) 144 | 145 | def module_exit(self): 146 | self.digital_write(self.reset_pin, 0) 147 | 148 | # Hardware reset 149 | def reset(self): 150 | self.digital_write(self.reset_pin, 1) 151 | self.delay_ms(30) 152 | self.digital_write(self.reset_pin, 0) 153 | self.delay_ms(3) 154 | self.digital_write(self.reset_pin, 1) 155 | self.delay_ms(30) 156 | 157 | def send_command(self, command): 158 | self.digital_write(self.dc_pin, 0) 159 | self.digital_write(self.cs_pin, 0) 160 | self.spi_writebyte([command]) 161 | self.digital_write(self.cs_pin, 1) 162 | 163 | def send_data(self, data): 164 | self.digital_write(self.dc_pin, 1) 165 | self.digital_write(self.cs_pin, 0) 166 | self.spi_writebyte([data]) 167 | self.digital_write(self.cs_pin, 1) 168 | 169 | def ReadBusy(self): 170 | print("e-Paper busy") 171 | while(self.digital_read(self.busy_pin) == 1): # 0: idle, 1: busy 172 | self.delay_ms(10) 173 | self.delay_ms(200) 174 | print("e-Paper busy release") 175 | 176 | def Load_LUT(self,lut): 177 | self.send_command(0x32) 178 | for count in range(0, 105): 179 | if lut == 0 : 180 | self.send_data(self.lut_4Gray_GC[count]) 181 | elif lut == 1 : 182 | self.send_data(self.lut_1Gray_GC[count]) 183 | elif lut == 2 : 184 | self.send_data(self.lut_1Gray_DU[count]) 185 | elif lut == 3 : 186 | self.send_data(self.lut_1Gray_A2[count]) 187 | else: 188 | print("There is no such lut ") 189 | 190 | def EPD_3IN7_4Gray_init(self): 191 | 192 | self.reset() # SWRESET 193 | 194 | self.send_command(0x12) 195 | self.delay_ms(300) 196 | 197 | self.send_command(0x46) 198 | self.send_data(0xF7) 199 | self.ReadBusy() 200 | self.send_command(0x47) 201 | self.send_data(0xF7) 202 | self.ReadBusy() 203 | 204 | self.send_command(0x01) # setting gaet number 205 | self.send_data(0xDF) 206 | self.send_data(0x01) 207 | self.send_data(0x00) 208 | 209 | self.send_command(0x03) # set gate voltage 210 | self.send_data(0x00) 211 | 212 | self.send_command(0x04) # set source voltage 213 | self.send_data(0x41) 214 | self.send_data(0xA8) 215 | self.send_data(0x32) 216 | 217 | self.send_command(0x11) # set data entry sequence 218 | self.send_data(0x03) 219 | 220 | self.send_command(0x3C) # set border 221 | self.send_data(0x03) 222 | 223 | self.send_command(0x0C) # set booster strength 224 | self.send_data(0xAE) 225 | self.send_data(0xC7) 226 | self.send_data(0xC3) 227 | self.send_data(0xC0) 228 | self.send_data(0xC0) 229 | 230 | self.send_command(0x18) # set internal sensor on 231 | self.send_data(0x80) 232 | 233 | self.send_command(0x2C) # set vcom value 234 | self.send_data(0x44) 235 | 236 | self.send_command(0x37) # set display option, these setting turn on previous function 237 | self.send_data(0x00) 238 | self.send_data(0x00) 239 | self.send_data(0x00) 240 | self.send_data(0x00) 241 | self.send_data(0x00) 242 | self.send_data(0x00) 243 | self.send_data(0x00) 244 | self.send_data(0x00) 245 | self.send_data(0x00) 246 | self.send_data(0x00) 247 | 248 | self.send_command(0x44) # setting X direction start/end position of RAM 249 | self.send_data(0x00) 250 | self.send_data(0x00) 251 | self.send_data(0x17) 252 | self.send_data(0x01) 253 | 254 | self.send_command(0x45) # setting Y direction start/end position of RAM 255 | self.send_data(0x00) 256 | self.send_data(0x00) 257 | self.send_data(0xDF) 258 | self.send_data(0x01) 259 | 260 | self.send_command(0x22) # Display Update Control 2 261 | self.send_data(0xCF) 262 | 263 | def EPD_3IN7_1Gray_init(self): 264 | self.reset() 265 | 266 | self.send_command(0x12) 267 | self.delay_ms(300) 268 | 269 | self.send_command(0x46) 270 | self.send_data(0xF7) 271 | self.ReadBusy() 272 | self.send_command(0x47) 273 | self.send_data(0xF7) 274 | self.ReadBusy() 275 | 276 | self.send_command(0x01) # setting gaet number 277 | self.send_data(0xDF) 278 | self.send_data(0x01) 279 | self.send_data(0x00) 280 | 281 | self.send_command(0x03) # set gate voltage 282 | self.send_data(0x00) 283 | 284 | self.send_command(0x04) # set source voltage 285 | self.send_data(0x41) 286 | self.send_data(0xA8) 287 | self.send_data(0x32) 288 | 289 | self.send_command(0x11) # set data entry sequence 290 | self.send_data(0x03) 291 | 292 | self.send_command(0x3C) # set border 293 | self.send_data(0x03) 294 | 295 | self.send_command(0x0C) # set booster strength 296 | self.send_data(0xAE) 297 | self.send_data(0xC7) 298 | self.send_data(0xC3) 299 | self.send_data(0xC0) 300 | self.send_data(0xC0) 301 | 302 | self.send_command(0x18) # set internal sensor on 303 | self.send_data(0x80) 304 | 305 | self.send_command(0x2C) # set vcom value 306 | self.send_data(0x44) 307 | 308 | self.send_command(0x37) # set display option, these setting turn on previous function 309 | self.send_data(0x00) # can switch 1 gray or 4 gray 310 | self.send_data(0xFF) 311 | self.send_data(0xFF) 312 | self.send_data(0xFF) 313 | self.send_data(0xFF) 314 | self.send_data(0x4F) 315 | self.send_data(0xFF) 316 | self.send_data(0xFF) 317 | self.send_data(0xFF) 318 | self.send_data(0xFF) 319 | 320 | self.send_command(0x44) # setting X direction start/end position of RAM 321 | self.send_data(0x00) 322 | self.send_data(0x00) 323 | self.send_data(0x17) 324 | self.send_data(0x01) 325 | 326 | self.send_command(0x45) # setting Y direction start/end position of RAM 327 | self.send_data(0x00) 328 | self.send_data(0x00) 329 | self.send_data(0xDF) 330 | self.send_data(0x01) 331 | 332 | self.send_command(0x22) # Display Update Control 2 333 | self.send_data(0xCF) 334 | 335 | def EPD_3IN7_4Gray_Clear(self): 336 | high = self.height 337 | if( self.width % 8 == 0) : 338 | wide = self.width // 8 339 | else : 340 | wide = self.width // 8 + 1 341 | 342 | self.send_command(0x49) 343 | self.send_data(0x00) 344 | self.send_command(0x4E) 345 | self.send_data(0x00) 346 | self.send_data(0x00) 347 | self.send_command(0x4F) 348 | self.send_data(0x00) 349 | self.send_data(0x00) 350 | 351 | self.send_command(0x24) 352 | for j in range(0, high): 353 | for i in range(0, wide): 354 | self.send_data(0Xff) 355 | 356 | self.send_command(0x4E) 357 | self.send_data(0x00) 358 | self.send_data(0x00) 359 | 360 | self.send_command(0x4F) 361 | self.send_data(0x00) 362 | self.send_data(0x00) 363 | 364 | self.send_command(0x26) 365 | for j in range(0, high): 366 | for i in range(0, wide): 367 | self.send_data(0Xff) 368 | 369 | self.Load_LUT(0) 370 | self.send_command(0x22) 371 | self.send_data(0xC7) 372 | 373 | self.send_command(0x20) 374 | self.ReadBusy() 375 | 376 | def EPD_3IN7_1Gray_Clear(self): 377 | 378 | high = self.height 379 | if( self.width % 8 == 0) : 380 | wide = self.width // 8 381 | else : 382 | wide = self.width // 8 + 1 383 | 384 | self.send_command(0x4E) 385 | self.send_data(0x00) 386 | self.send_data(0x00) 387 | self.send_command(0x4F) 388 | self.send_data(0x00) 389 | self.send_data(0x00) 390 | 391 | self.send_command(0x24) 392 | for j in range(0, high): 393 | for i in range(0, wide): 394 | self.send_data(0Xff) 395 | 396 | 397 | self.Load_LUT(1) 398 | 399 | self.send_command(0x20) 400 | self.ReadBusy() 401 | 402 | def EPD_3IN7_4Gray_Display(self,Image): 403 | 404 | self.send_command(0x49) 405 | self.send_data(0x00) 406 | 407 | 408 | self.send_command(0x4E) 409 | self.send_data(0x00) 410 | self.send_data(0x00) 411 | 412 | 413 | self.send_command(0x4F) 414 | self.send_data(0x00) 415 | self.send_data(0x00) 416 | 417 | self.send_command(0x24) 418 | for i in range(0, 16800): 419 | temp3=0 420 | for j in range(0, 2): 421 | temp1 = Image[i*2+j] 422 | for k in range(0, 2): 423 | temp2 = temp1&0x03 424 | if(temp2 == 0x03): 425 | temp3 |= 0x01 # white 426 | elif(temp2 == 0x00): 427 | temp3 |= 0x00 # black 428 | elif(temp2 == 0x02): 429 | temp3 |= 0x01 # gray1 430 | else: # 0x01 431 | temp3 |= 0x00 # gray2 432 | temp3 <<= 1 433 | 434 | temp1 >>= 2 435 | temp2 = temp1&0x03 436 | if(temp2 == 0x03): # white 437 | temp3 |= 0x01; 438 | elif(temp2 == 0x00): # black 439 | temp3 |= 0x00; 440 | elif(temp2 == 0x02): 441 | temp3 |= 0x01 # gray1 442 | else: # 0x01 443 | temp3 |= 0x00 # gray2 444 | 445 | if (( j!=1 ) | ( k!=1 )): 446 | temp3 <<= 1 447 | 448 | temp1 >>= 2 449 | 450 | self.send_data(temp3) 451 | # new data 452 | self.send_command(0x4E) 453 | self.send_data(0x00) 454 | self.send_data(0x00) 455 | 456 | 457 | self.send_command(0x4F) 458 | self.send_data(0x00) 459 | self.send_data(0x00) 460 | 461 | self.send_command(0x26) 462 | for i in range(0, 16800): 463 | temp3=0 464 | for j in range(0, 2): 465 | temp1 = Image[i*2+j] 466 | for k in range(0, 2): 467 | temp2 = temp1&0x03 468 | if(temp2 == 0x03): 469 | temp3 |= 0x01 # white 470 | elif(temp2 == 0x00): 471 | temp3 |= 0x00 # black 472 | elif(temp2 == 0x02): 473 | temp3 |= 0x00 # gray1 474 | else: # 0x01 475 | temp3 |= 0x01 # gray2 476 | temp3 <<= 1 477 | 478 | temp1 >>= 2 479 | temp2 = temp1&0x03 480 | if(temp2 == 0x03): # white 481 | temp3 |= 0x01; 482 | elif(temp2 == 0x00): # black 483 | temp3 |= 0x00; 484 | elif(temp2 == 0x02): 485 | temp3 |= 0x00 # gray1 486 | else: # 0x01 487 | temp3 |= 0x01 # gray2 488 | 489 | if (( j!=1 ) | ( k!=1 )): 490 | temp3 <<= 1 491 | 492 | temp1 >>= 2 493 | 494 | self.send_data(temp3) 495 | 496 | self.Load_LUT(0) 497 | 498 | self.send_command(0x22) 499 | self.send_data(0xC7) 500 | 501 | self.send_command(0x20) 502 | 503 | self.ReadBusy() 504 | 505 | def EPD_3IN7_1Gray_Display(self,Image): 506 | 507 | high = self.height 508 | if( self.width % 8 == 0) : 509 | wide = self.width // 8 510 | else : 511 | wide = self.width // 8 + 1 512 | 513 | self.send_command(0x49) 514 | self.send_data(0x00) 515 | 516 | self.send_command(0x4E) 517 | self.send_data(0x00) 518 | self.send_data(0x00) 519 | self.send_command(0x4F) 520 | self.send_data(0x00) 521 | self.send_data(0x00) 522 | 523 | self.send_command(0x24) 524 | for j in range(0, high): 525 | for i in range(0, wide): 526 | self.send_data(Image[i + j * wide]) 527 | 528 | 529 | self.Load_LUT(1) 530 | 531 | self.send_command(0x20) 532 | self.ReadBusy() 533 | 534 | def EPD_3IN7_1Gray_Display_Part(self,Image): 535 | 536 | high = self.height 537 | if( self.width % 8 == 0) : 538 | wide = self.width // 8 539 | else : 540 | wide = self.width // 8 + 1 541 | 542 | self.send_command(0x44) 543 | self.send_data(0x00) 544 | self.send_data(0x00) 545 | self.send_data((self.width-1) & 0xff) 546 | self.send_data(((self.width-1)>>8) & 0x03) 547 | self.send_command(0x45) 548 | self.send_data(0x00) 549 | self.send_data(0x00) 550 | self.send_data((self.height-1) & 0xff) 551 | self.send_data(((self.height-1)>>8) & 0x03) 552 | 553 | self.send_command(0x4E) # SET_RAM_X_ADDRESS_COUNTER 554 | self.send_data(0x00) 555 | self.send_data(0x00) 556 | 557 | self.send_command(0x4F) # SET_RAM_Y_ADDRESS_COUNTER 558 | self.send_data(0x00) 559 | self.send_data(0x00) 560 | 561 | self.send_command(0x24) 562 | for j in range(0, high): 563 | for i in range(0, wide): 564 | self.send_data(Image[i + j * wide]) 565 | 566 | self.Load_LUT(2) 567 | self.send_command(0x20) 568 | self.ReadBusy() 569 | 570 | def Sleep(self): 571 | self.send_command(0X50) 572 | self.send_data(0xf7) 573 | self.send_command(0X02) # power off 574 | self.send_command(0X07) # deep sleep 575 | self.send_data(0xA5) 576 | 577 | if __name__=='__main__': 578 | 579 | epd = EPD_3in7() 580 | 581 | epd.image1Gray.fill(0xff) 582 | epd.image4Gray.fill(0xff) 583 | 584 | epd.image4Gray.text("Waveshare", 5, 10, epd.black) 585 | epd.image4Gray.text("Pico_ePaper-3.7", 5, 40, epd.black) 586 | epd.image4Gray.text("Raspberry Pico", 5, 70, epd.black) 587 | epd.EPD_3IN7_4Gray_Display(epd.buffer_4Gray) 588 | epd.delay_ms(500) 589 | 590 | epd.image4Gray.vline(10, 90, 60, epd.black) 591 | epd.image4Gray.vline(90, 90, 60, epd.black) 592 | epd.image4Gray.hline(10, 90, 80, epd.black) 593 | epd.image4Gray.hline(10, 150, 80, epd.black) 594 | epd.image4Gray.line(10, 90, 90, 150, epd.black) 595 | epd.image4Gray.line(90, 90, 10, 150, epd.black) 596 | epd.EPD_3IN7_4Gray_Display(epd.buffer_4Gray) 597 | epd.delay_ms(500) 598 | 599 | epd.image4Gray.rect(10, 180, 50, 80, epd.black) 600 | epd.image4Gray.fill_rect(70, 180, 50, 80, epd.black) 601 | epd.EPD_3IN7_4Gray_Display(epd.buffer_4Gray) 602 | epd.delay_ms(500) 603 | 604 | epd.image4Gray.fill_rect(0, 270, 280, 30, epd.black) 605 | epd.image4Gray.text('GRAY1 with black background',5, 281, epd.white) 606 | epd.image4Gray.text('GRAY2 with white background',5, 311, epd.grayish) 607 | epd.image4Gray.text('GRAY3 with white background',5, 341, epd.darkgray) 608 | epd.image4Gray.text('GRAY4 with white background',5, 371, epd.black) 609 | epd.EPD_3IN7_4Gray_Display(epd.buffer_4Gray) 610 | epd.delay_ms(500) 611 | 612 | 613 | epd.EPD_3IN7_1Gray_init() 614 | for i in range(0, 10): 615 | epd.image1Gray.fill_rect(0, 430, 280, 10, epd.white) 616 | epd.image1Gray.text(str(i), 136, 431, epd.black) 617 | epd.EPD_3IN7_1Gray_Display_Part(epd.buffer_1Gray) 618 | 619 | 620 | 621 | 622 | epd.Sleep() 623 | 624 | 625 | -------------------------------------------------------------------------------- /main.py: -------------------------------------------------------------------------------- 1 | import time 2 | import machine 3 | import ds3231 4 | from micropython import const 5 | from collections import deque 6 | from eink import EPD_3in7 7 | 8 | SAVED_TIMESTAMP = const("last_ts.txt") 9 | ON_TIMESTAMP = const("on_ts.txt") 10 | EXPECTED_POWERCUT_FLAG = const("flag.txt") 11 | BLACKOUT_LOG = const("log.txt") 12 | 13 | 14 | def main(): 15 | ecp = expected_powercut() 16 | if not ecp: 17 | log_blackout(read_last_time(), time.time()) 18 | save_on_time() 19 | print(const("Not expected powercut")) 20 | save_last_time() 21 | epd = initial_eink() 22 | epd.EPD_3IN7_1Gray_init() 23 | while True: 24 | save_last_time() 25 | current = format_full_date(time.time()) 26 | epd.image1Gray.fill_rect(120, 431, 165, 48, epd.white) 27 | epd.image1Gray.text(current[1], 115, 431, epd.black) 28 | epd.image1Gray.text(current[0], 115, 447, epd.black) 29 | epd.EPD_3IN7_1Gray_Display_Part(epd.buffer_1Gray) 30 | machine.lightsleep(30000) 31 | 32 | 33 | def display_log(epd): 34 | try: 35 | log_entries = tail(BLACKOUT_LOG) 36 | y = 41 37 | while True: 38 | entry = log_entries.popleft().strip() 39 | epd.image4Gray.text(entry, 15, y, epd.black) 40 | # epd.image4Gray.text(entry,5, y, epd.darkgray) 41 | y = y + 16 42 | print(entry) 43 | except Exception: 44 | pass 45 | 46 | 47 | def format_full_date(time_v): 48 | w = ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"] 49 | m = ["Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"] 50 | ti = time.localtime(time_v) 51 | f_date = "%s %02d %s %d " % (w[ti[6]], ti[2], m[ti[1] - 1], ti[0]) 52 | f_time = "%02d:%02d" % (ti[3], ti[4]) 53 | return (f_date, f_time) 54 | 55 | 56 | def initial_eink(): 57 | epd = EPD_3in7() 58 | epd.image1Gray.fill(0xff) 59 | epd.image4Gray.fill(0xff) 60 | epd.image4Gray.fill_rect(0, 0, 280, 30, epd.black) 61 | epd.image4Gray.text('Blackouts log', 5, 11, epd.white) 62 | epd.image4Gray.fill_rect(0, 300, 280, 30, epd.black) 63 | epd.image4Gray.text('Current session', 5, 311, epd.white) 64 | # epd.image4Gray.text('GRAY2 with white background', 5, 311, epd.grayish) 65 | # epd.image4Gray.text('GRAY3 with white background', 5, 341, epd.darkgray) 66 | # epd.image4Gray.text('GRAY4 with white background', 5, 371, epd.black) 67 | epd.image4Gray.text('Beginning ->', 5, 341, epd.darkgray) 68 | epd.image4Gray.text('Last check ->', 5, 431, epd.darkgray) 69 | on_date_time = format_full_date(read_on_time()) 70 | epd.image4Gray.text(on_date_time[1], 115, 341, epd.black) 71 | epd.image4Gray.text(on_date_time[0], 115, 357, epd.black) 72 | 73 | display_log(epd) 74 | epd.EPD_3IN7_4Gray_Display(epd.buffer_4Gray) 75 | return epd 76 | 77 | 78 | def tail(filename, n=16): 79 | d = deque((), n) 80 | with open(filename) as f: 81 | for line in f: 82 | d.append(line) 83 | return d 84 | 85 | 86 | def log_blackout(from_time, to_time): 87 | on_ti = time.localtime(from_time) 88 | last_ti = time.localtime(to_time) 89 | entry = "%s - %s\n" % (format_time(on_ti), format_time(last_ti)) 90 | with open(BLACKOUT_LOG, "a") as f: 91 | f.write(entry) 92 | 93 | 94 | def format_time(ti): 95 | return "%02d:%02d:%02d/%02d.%02d" % (ti[3], ti[4], ti[5], ti[2], ti[1]) 96 | 97 | 98 | def init_rtc(): 99 | ds = ds3231.ds3231() 100 | set_internal_time(ds.read_time()) 101 | 102 | 103 | def set_internal_time(utc_time): 104 | rtc_base_mem = const(0x4005c000) 105 | atomic_bitmask_set = const(0x2000) 106 | (year, month, day, hour, minute, second, wday, yday) = time.localtime(utc_time) 107 | machine.mem32[rtc_base_mem + 4] = (year << 12) | (month << 8) | day 108 | machine.mem32[rtc_base_mem + 8] = ((hour << 16) | (minute << 8) | second) | (((wday + 1) % 7) << 24) 109 | machine.mem32[rtc_base_mem + atomic_bitmask_set + 0xc] = 0x10 110 | 111 | 112 | def save_last_time(): 113 | save_time(SAVED_TIMESTAMP) 114 | 115 | 116 | def read_last_time(): 117 | return read_time(SAVED_TIMESTAMP) 118 | 119 | 120 | def save_on_time(): 121 | save_time(ON_TIMESTAMP) 122 | 123 | 124 | def read_on_time(): 125 | return read_time(ON_TIMESTAMP) 126 | 127 | 128 | def read_time(file_name): 129 | t = 0 130 | try: 131 | f = open(file_name, 'r') 132 | t = int(f.readline()) 133 | f.close() 134 | except Exception: 135 | pass 136 | return t 137 | 138 | 139 | def save_time(file_name): 140 | with open(file_name, 'w') as f: 141 | f.write(str(time.time())) 142 | 143 | 144 | def expected_powercut(): 145 | t = False 146 | try: 147 | with open(EXPECTED_POWERCUT_FLAG, 'r') as f: 148 | a = int(f.readline()) 149 | if a != 0: 150 | t = True 151 | except Exception: 152 | t = False 153 | if t: 154 | with open(EXPECTED_POWERCUT_FLAG, 'w') as f: 155 | f.write("0") 156 | return t 157 | 158 | 159 | init_rtc() 160 | main() 161 | --------------------------------------------------------------------------------