commit 1ae9ebaafbb2f99a678afce653acbb5f2d8788e5 Author: Paul Warren Date: Fri Nov 22 19:34:26 2019 +1100 Initial import after n embarassing credentials incidient :) diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..7a4c5db --- /dev/null +++ b/.gitignore @@ -0,0 +1,38 @@ +# Credentials +credential.h + +# emacs files +*~ + +# Prerequisites +*.d + +# Compiled Object files +*.slo +*.lo +*.o +*.obj + +# Precompiled Headers +*.gch +*.pch + +# Compiled Dynamic libraries +*.so +*.dylib +*.dll + +# Fortran module files +*.mod +*.smod + +# Compiled Static libraries +*.lai +*.la +*.a +*.lib + +# Executables +*.exe +*.out +*.app diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..76e8fbd --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# EPClock +ESP8226 Arduino based ePaper clock + +Using a Waveshare 4.3" UART module and an ESP8226 R1 Mini from Jaycar Australia, which is a D1 Mini in Arduino. + +## Required Libraries + +Timezone: [https://github.com/JChristensen/Timezone]() +NTPClient: [https://github.com/arduino-libraries/NTPClient]() + + +## Connections + +* WakeUp -> D7 +* Reset - D8 +* DOUT -> D5 +* DIN -> D6 + + +## Creating Images for each digit + +Use Images/create_images.py edit for font choice! The current images are in FreeMono. \ No newline at end of file diff --git a/build.sh b/build.sh new file mode 100755 index 0000000..f7df11d --- /dev/null +++ b/build.sh @@ -0,0 +1,40 @@ +#!/bin/bash + +opt=$1 +case $opt in + -u) ~/bin/arduino --upload -v --port /dev/ttyUSB0 --board esp8266:esp8266:d1_mini:baud=460800,ip=lm6f esp_time.ino + ;; + *) ~/bin/arduino --verify -v --board esp8266:esp8266:d1_mini:baud=460800,ip=lm6f esp_time.ino + ;; +esac + + + + + + +# /home/pwarren/Projects/arduino-1.8.10/arduino-builder +# -dump-prefs +# -logger=machine +# -hardware /home/pwarren/Projects/arduino-1.8.10/hardware +# -hardware /home/pwarren/.arduino15/packages +# -tools /home/pwarren/Projects/arduino-1.8.10/tools-builder +# -tools /home/pwarren/Projects/arduino-1.8.10/hardware/tools/avr +# -tools /home/pwarren/.arduino15/packages +# -built-in-libraries /home/pwarren/Projects/arduino-1.8.10/libraries +# -libraries /home/pwarren/Arduino/libraries +# -fqbn=esp8266:esp8266:d1_mini:xtal=80,vt=flash,exception=legacy,ssl=all,eesz=4M2M,ip=lm6f,dbg=Disabled,lvl=None____,wipe=none,baud=460800 +# -vid-pid=1A86_7523 +# -ide-version=10810 +# -build-path /tmp/arduino_build_589661 +# -warnings=all +# -build-cache /tmp/arduino_cache_275875 +# -prefs=build.warn_data_percentage=75 +# -prefs=runtime.tools.xtensa-lx106-elf-gcc.path=/home/pwarren/.arduino15/packages/esp8266/tools/xtensa-lx106-elf-gcc/2.5.0-4-b40a506 +# -prefs=runtime.tools.xtensa-lx106-elf-gcc-2.5.0-4-b40a506.path=/home/pwarren/.arduino15/packages/esp8266/tools/xtensa-lx106-elf-gcc/2.5.0-4-b40a506 +# -prefs=runtime.tools.python3.path=/home/pwarren/.arduino15/packages/esp8266/tools/python3/3.7.2-post1 -prefs=runtime.tools.python3-3.7.2-post1.path=/home/pwarren/.arduino15/packages/esp8266/tools/python3/3.7.2-post1 +# -prefs=runtime.tools.mklittlefs.path=/home/pwarren/.arduino15/packages/esp8266/tools/mklittlefs/2.5.0-4-69bd9e6 +# -prefs=runtime.tools.mklittlefs-2.5.0-4-69bd9e6.path=/home/pwarren/.arduino15/packages/esp8266/tools/mklittlefs/2.5.0-4-69bd9e6 +# -prefs=runtime.tools.mkspiffs.path=/home/pwarren/.arduino15/packages/esp8266/tools/mkspiffs/2.5.0-4-b40a506 +# -prefs=runtime.tools.mkspiffs-2.5.0-4-b40a506.path=/home/pwarren/.arduino15/packages/esp8266/tools/mkspiffs/2.5.0-4-b40a506 +# -verbose /tmp/arduino_modified_sketch_422089/IPv6.ino diff --git a/epd.cpp b/epd.cpp new file mode 100644 index 0000000..1ff7469 --- /dev/null +++ b/epd.cpp @@ -0,0 +1,766 @@ +/********************************************************************************************************* +* +* File : epd.c +* Hardware Environment: +* Build Environment : RealView MDK-ARM Version: 4.74 +* Version : V1.0 +* By : V +* +* (c) Copyright 2005-2014, WaveShare +* http://www.waveshare.net +* All Rights Reserved +* +*********************************************************************************************************/ +#include "epd.h" +#include +#include + + +const int wake_up = D7; +const int reset = D8; + +SoftwareSerial mySerial(D5,D6); + +/* +command define +*/ +static const unsigned char _cmd_handshake[8] = {0xA5, 0x00, 0x09, CMD_HANDSHAKE, 0xCC, 0x33, 0xC3, 0x3C}; //CMD_HANDSHAKE +static const unsigned char _cmd_read_baud[8] = {0xA5, 0x00, 0x09, CMD_READ_BAUD, 0xCC, 0x33, 0xC3, 0x3C}; //CMD_READ_BAUD +static const unsigned char _cmd_stopmode[8] = {0xA5, 0x00, 0x09, CMD_STOPMODE, 0xCC, 0x33, 0xC3, 0x3C}; //CMD_STOPMODE +static const unsigned char _cmd_update[8] = {0xA5, 0x00, 0x09, CMD_UPDATE, 0xCC, 0x33, 0xC3, 0x3C}; //CMD_UPDATE +static const unsigned char _cmd_load_font[8] = {0xA5, 0x00, 0x09, CMD_LOAD_FONT, 0xCC, 0x33, 0xC3, 0x3C}; //CMD_LOAD_FONT +static const unsigned char _cmd_load_pic[8] = {0xA5, 0x00, 0x09, CMD_LOAD_PIC, 0xCC, 0x33, 0xC3, 0x3C}; //CMD_LOAD_PIC + + + + +static unsigned char _cmd_buff[CMD_SIZE]; + + + +/* +private function +*/ +static void _putchars(const unsigned char * ptr, int n); +static unsigned char _verify(const void * ptr, int n); + + + +/******************************************************************************* +* Function Name : static void _putchars(const unsigned char * ptr, int n) +* Description : +* Input : +* Output : None +* Return : +* Attention : None +*******************************************************************************/ +static void _putchars(const unsigned char * ptr, int n) +{ + int i, x; + + for(i = 0; i < n; i++) + { + x = ptr[i]; + mySerial.write(x); + } +} +/******************************************************************************* +* Function Name : static unsigned char _verify(const void * ptr, int n) +* Description : +* Input : ptr + n +* Output : None +* Return : +*******************************************************************************/ +static unsigned char _verify(const void * ptr, int n) +{ + int i; + unsigned char * p = (unsigned char *)ptr; + unsigned char result; + + for(i = 0, result = 0; i < n; i++) + { + result ^= p[i]; + } + + return result; +} + + + + +/******************************************************************************* +* Function Name : void epd_init(void) +* Description : +* Input : +* Output : None +* Return : +* Attention : None +*******************************************************************************/ +void epd_init(void) +{ + mySerial.begin(115200); + pinMode(wake_up, OUTPUT); + digitalWrite(wake_up, LOW); + pinMode(reset, OUTPUT); + digitalWrite(reset, LOW); +} +/******************************************************************************* +* Function Name : void epd_reset(void) +* Description : +* Input : +* Output : None +* Return : +* Attention : None +*******************************************************************************/ +void epd_reset(void) +{ + digitalWrite(reset, LOW); + delayMicroseconds(1000); + digitalWrite(reset, HIGH); + delayMicroseconds(5000); + digitalWrite(reset, LOW); + delay(3000); +} +/******************************************************************************* +* Function Name : void epd_init(void) +* Description : +* Input : +* Output : None +* Return : +* Attention : None +*******************************************************************************/ +void epd_wakeup(void) +{ + digitalWrite(wake_up, LOW); + delayMicroseconds(1000); + digitalWrite(wake_up, HIGH); + delayMicroseconds(50000); + digitalWrite(wake_up, LOW); + delay(10); +} + +/******************************************************************************* +* Function Name : void epd_handshake(void) +* Description : +* Input : +* Output : None +* Return : +* Attention : None +*******************************************************************************/ +void epd_handshake(void) +{ + memcpy(_cmd_buff, _cmd_handshake, 8); + _cmd_buff[8] = _verify(_cmd_buff, 8); + + _putchars(_cmd_buff, 9); +} +/******************************************************************************* +* Function Name : void epd_set_baud(long baud) +* Description : set uart baud +* Input : +* Output : None +* Return : +* Attention : None +*******************************************************************************/ +void epd_set_baud(long baud) +{ + _cmd_buff[0] = FRAME_B; + + _cmd_buff[1] = 0x00; + _cmd_buff[2] = 0x0D; + + _cmd_buff[3] = CMD_SET_BAUD; + + _cmd_buff[4] = (baud >> 24) & 0xFF; + _cmd_buff[5] = (baud >> 16) & 0xFF; + _cmd_buff[6] = (baud >> 8) & 0xFF; + _cmd_buff[7] = baud & 0xFF; + + _cmd_buff[8] = FRAME_E0; + _cmd_buff[9] = FRAME_E1; + _cmd_buff[10] = FRAME_E2; + _cmd_buff[11] = FRAME_E3; + _cmd_buff[12] = _verify(_cmd_buff, 12); + + _putchars(_cmd_buff, 13); + + delay(10); + mySerial.begin(baud); +} +/******************************************************************************* +* Function Name : void epd_read_baud(void) +* Description : read uart baud +* Input : +* Output : None +* Return : +* Attention : None +*******************************************************************************/ +void epd_read_baud(void) +{ + memcpy(_cmd_buff, _cmd_read_baud, 8); + _cmd_buff[8] = _verify(_cmd_buff, 8); + + _putchars(_cmd_buff, 9); +} +/******************************************************************************* +* Function Name : void epd_set_memory(unsigned char mode) +* Description : +* Input : +* Output : None +* Return : +* Attention : None +*******************************************************************************/ +void epd_set_memory(unsigned char mode) +{ + _cmd_buff[0] = FRAME_B; + + _cmd_buff[1] = 0x00; + _cmd_buff[2] = 0x0A; + + _cmd_buff[3] = CMD_MEMORYMODE; + + _cmd_buff[4] = mode; + + _cmd_buff[5] = FRAME_E0; + _cmd_buff[6] = FRAME_E1; + _cmd_buff[7] = FRAME_E2; + _cmd_buff[8] = FRAME_E3; + _cmd_buff[9] = _verify(_cmd_buff, 9); + + _putchars(_cmd_buff, 10); +} + +/******************************************************************************* +* Function Name : void epd_enter_stopmode(void) +* Description : +* Input : +* Output : None +* Return : +* Attention : None +*******************************************************************************/ +void epd_enter_stopmode(void) +{ + memcpy(_cmd_buff, _cmd_stopmode, 8); + _cmd_buff[8] = _verify(_cmd_buff, 8); + + _putchars(_cmd_buff, 9); +} +/******************************************************************************* +* Function Name : void epd_update(void) +* Description : +* Input : +* Output : None +* Return : +* Attention : None +*******************************************************************************/ +void epd_update(void) +{ + memcpy(_cmd_buff, _cmd_update, 8); + _cmd_buff[8] = _verify(_cmd_buff, 8); + + _putchars(_cmd_buff, 9); +} +/******************************************************************************* +* Function Name : void epd_screen_rotation(unsigned char mode) +* Description : +* Input : +* Output : None +* Return : +* Attention : None +*******************************************************************************/ +void epd_screen_rotation(unsigned char mode) +{ + _cmd_buff[0] = FRAME_B; + + _cmd_buff[1] = 0x00; + _cmd_buff[2] = 0x0A; + + _cmd_buff[3] = CMD_SCREEN_ROTATION; + + _cmd_buff[4] = mode; + + _cmd_buff[5] = FRAME_E0; + _cmd_buff[6] = FRAME_E1; + _cmd_buff[7] = FRAME_E2; + _cmd_buff[8] = FRAME_E3; + _cmd_buff[9] = _verify(_cmd_buff, 9); + + _putchars(_cmd_buff, 10); +} +/******************************************************************************* +* Function Name : void epd_load_font(void) +* Description : +* Input : +* Output : None +* Return : +* Attention : None +*******************************************************************************/ +void epd_load_font(void) +{ + memcpy(_cmd_buff, _cmd_load_font, 8); + _cmd_buff[8] = _verify(_cmd_buff, 8); + + _putchars(_cmd_buff, 9); +} +/******************************************************************************* +* Function Name : void epd_load_pic(void) +* Description : +* Input : +* Output : None +* Return : +* Attention : None +*******************************************************************************/ +void epd_load_pic(void) +{ + memcpy(_cmd_buff, _cmd_load_pic, 8); + _cmd_buff[8] = _verify(_cmd_buff, 8); + + _putchars(_cmd_buff, 9); +} +/******************************************************************************* +* Function Name : void epd_set_color(unsigned char color, unsigned char bkcolor) +* Description : +* Input : +* Output : None +* Return : +* Attention : None +*******************************************************************************/ +void epd_set_color(unsigned char color, unsigned char bkcolor) +{ + _cmd_buff[0] = FRAME_B; + + _cmd_buff[1] = 0x00; + _cmd_buff[2] = 0x0B; + + _cmd_buff[3] = CMD_SET_COLOR; + + _cmd_buff[4] = color; + _cmd_buff[5] = bkcolor; + + _cmd_buff[6] = FRAME_E0; + _cmd_buff[7] = FRAME_E1; + _cmd_buff[8] = FRAME_E2; + _cmd_buff[9] = FRAME_E3; + _cmd_buff[10] = _verify(_cmd_buff, 10); + + _putchars(_cmd_buff, 11); +} +/******************************************************************************* +* Function Name : void epd_set_en_font(unsigned char font) +* Description : +* Input : +* Output : None +* Return : +* Attention : None +*******************************************************************************/ +void epd_set_en_font(unsigned char font) +{ + _cmd_buff[0] = FRAME_B; + + _cmd_buff[1] = 0x00; + _cmd_buff[2] = 0x0A; + + _cmd_buff[3] = CMD_SET_EN_FONT; + + _cmd_buff[4] = font; + + _cmd_buff[5] = FRAME_E0; + _cmd_buff[6] = FRAME_E1; + _cmd_buff[7] = FRAME_E2; + _cmd_buff[8] = FRAME_E3; + _cmd_buff[9] = _verify(_cmd_buff, 9); + + _putchars(_cmd_buff, 10); +} +/******************************************************************************* +* Function Name : void epd_set_ch_font(unsigned char font) +* Description : +* Input : +* Output : None +* Return : +* Attention : None +*******************************************************************************/ +void epd_set_ch_font(unsigned char font) +{ + _cmd_buff[0] = FRAME_B; + + _cmd_buff[1] = 0x00; + _cmd_buff[2] = 0x0A; + + _cmd_buff[3] = CMD_SET_CH_FONT; + + _cmd_buff[4] = font; + + _cmd_buff[5] = FRAME_E0; + _cmd_buff[6] = FRAME_E1; + _cmd_buff[7] = FRAME_E2; + _cmd_buff[8] = FRAME_E3; + _cmd_buff[9] = _verify(_cmd_buff, 9); + + _putchars(_cmd_buff, 10); +} +/******************************************************************************* +* Function Name : void epd_draw_pixel(int x0, int y0) +* Description : +* Input : +* Output : None +* Return : +* Attention : None +*******************************************************************************/ +void epd_draw_pixel(int x0, int y0) +{ + _cmd_buff[0] = FRAME_B; + + _cmd_buff[1] = 0x00; + _cmd_buff[2] = 0x0D; + + _cmd_buff[3] = CMD_DRAW_PIXEL; + + _cmd_buff[4] = (x0 >> 8) & 0xFF; + _cmd_buff[5] = x0 & 0xFF; + _cmd_buff[6] = (y0 >> 8) & 0xFF; + _cmd_buff[7] = y0 & 0xFF; + + _cmd_buff[8] = FRAME_E0; + _cmd_buff[9] = FRAME_E1; + _cmd_buff[10] = FRAME_E2; + _cmd_buff[11] = FRAME_E3; + _cmd_buff[12] = _verify(_cmd_buff, 12); + + _putchars(_cmd_buff, 13); +} +/******************************************************************************* +* Function Name : void epd_draw_line(int x0, int y0, int x1, int y1) +* Description : +* Input : +* Output : None +* Return : +* Attention : None +*******************************************************************************/ +void epd_draw_line(int x0, int y0, int x1, int y1) +{ + _cmd_buff[0] = FRAME_B; + + _cmd_buff[1] = 0x00; + _cmd_buff[2] = 0x11; + + _cmd_buff[3] = CMD_DRAW_LINE; + + _cmd_buff[4] = (x0 >> 8) & 0xFF; + _cmd_buff[5] = x0 & 0xFF; + _cmd_buff[6] = (y0 >> 8) & 0xFF; + _cmd_buff[7] = y0 & 0xFF; + _cmd_buff[8] = (x1 >> 8) & 0xFF; + _cmd_buff[9] = x1 & 0xFF; + _cmd_buff[10] = (y1 >> 8) & 0xFF; + _cmd_buff[11] = y1 & 0xFF; + + _cmd_buff[12] = FRAME_E0; + _cmd_buff[13] = FRAME_E1; + _cmd_buff[14] = FRAME_E2; + _cmd_buff[15] = FRAME_E3; + _cmd_buff[16] = _verify(_cmd_buff, 16); + + _putchars(_cmd_buff, 17); +} +/******************************************************************************* +* Function Name : void epd_fill_rect(int x0, int y0, int x1, int y1) +* Description : +* Input : +* Output : None +* Return : +* Attention : None +*******************************************************************************/ +void epd_fill_rect(int x0, int y0, int x1, int y1) +{ + _cmd_buff[0] = FRAME_B; + + _cmd_buff[1] = 0x00; + _cmd_buff[2] = 0x11; + + _cmd_buff[3] = CMD_FILL_RECT; + + _cmd_buff[4] = (x0 >> 8) & 0xFF; + _cmd_buff[5] = x0 & 0xFF; + _cmd_buff[6] = (y0 >> 8) & 0xFF; + _cmd_buff[7] = y0 & 0xFF; + _cmd_buff[8] = (x1 >> 8) & 0xFF; + _cmd_buff[9] = x1 & 0xFF; + _cmd_buff[10] = (y1 >> 8) & 0xFF; + _cmd_buff[11] = y1 & 0xFF; + + _cmd_buff[12] = FRAME_E0; + _cmd_buff[13] = FRAME_E1; + _cmd_buff[14] = FRAME_E2; + _cmd_buff[15] = FRAME_E3; + _cmd_buff[16] = _verify(_cmd_buff, 16); + + _putchars(_cmd_buff, 17); +} +/******************************************************************************* +* Function Name : void epd_draw_circle(int x0, int y0, int r) +* Description : +* Input : +* Output : None +* Return : +* Attention : None +*******************************************************************************/ +void epd_draw_circle(int x0, int y0, int r) +{ + _cmd_buff[0] = FRAME_B; + + _cmd_buff[1] = 0x00; + _cmd_buff[2] = 0x0F; + + _cmd_buff[3] = CMD_DRAW_CIRCLE; + + _cmd_buff[4] = (x0 >> 8) & 0xFF; + _cmd_buff[5] = x0 & 0xFF; + _cmd_buff[6] = (y0 >> 8) & 0xFF; + _cmd_buff[7] = y0 & 0xFF; + _cmd_buff[8] = (r >> 8) & 0xFF; + _cmd_buff[9] = r & 0xFF; + + + _cmd_buff[10] = FRAME_E0; + _cmd_buff[11] = FRAME_E1; + _cmd_buff[12] = FRAME_E2; + _cmd_buff[13] = FRAME_E3; + _cmd_buff[14] = _verify(_cmd_buff, 14); + + _putchars(_cmd_buff, 15); +} +/******************************************************************************* +* Function Name : void epd_fill_circle(int x0, int y0, int r) +* Description : +* Input : +* Output : None +* Return : +* Attention : None +*******************************************************************************/ +void epd_fill_circle(int x0, int y0, int r) +{ + _cmd_buff[0] = FRAME_B; + + _cmd_buff[1] = 0x00; + _cmd_buff[2] = 0x0F; + + _cmd_buff[3] = CMD_FILL_CIRCLE; + + _cmd_buff[4] = (x0 >> 8) & 0xFF; + _cmd_buff[5] = x0 & 0xFF; + _cmd_buff[6] = (y0 >> 8) & 0xFF; + _cmd_buff[7] = y0 & 0xFF; + _cmd_buff[8] = (r >> 8) & 0xFF; + _cmd_buff[9] = r & 0xFF; + + + _cmd_buff[10] = FRAME_E0; + _cmd_buff[11] = FRAME_E1; + _cmd_buff[12] = FRAME_E2; + _cmd_buff[13] = FRAME_E3; + _cmd_buff[14] = _verify(_cmd_buff, 14); + + _putchars(_cmd_buff, 15); +} +/******************************************************************************* +* Function Name : void epd_draw_triangle(int x0, int y0, int x1, int y1, int x2, int y2) +* Description : +* Input : +* Output : None +* Return : +* Attention : None +*******************************************************************************/ +void epd_draw_triangle(int x0, int y0, int x1, int y1, int x2, int y2) +{ + _cmd_buff[0] = FRAME_B; + + _cmd_buff[1] = 0x00; + _cmd_buff[2] = 0x15; + + _cmd_buff[3] = CMD_DRAW_TRIANGLE; + + _cmd_buff[4] = (x0 >> 8) & 0xFF; + _cmd_buff[5] = x0 & 0xFF; + _cmd_buff[6] = (y0 >> 8) & 0xFF; + _cmd_buff[7] = y0 & 0xFF; + _cmd_buff[8] = (x1 >> 8) & 0xFF; + _cmd_buff[9] = x1 & 0xFF; + _cmd_buff[10] = (y1 >> 8) & 0xFF; + _cmd_buff[11] = y1 & 0xFF; + _cmd_buff[12] = (x2 >> 8) & 0xFF; + _cmd_buff[13] = x2 & 0xFF; + _cmd_buff[14] = (y2 >> 8) & 0xFF; + _cmd_buff[15] = y2 & 0xFF; + + _cmd_buff[16] = FRAME_E0; + _cmd_buff[17] = FRAME_E1; + _cmd_buff[18] = FRAME_E2; + _cmd_buff[19] = FRAME_E3; + _cmd_buff[20] = _verify(_cmd_buff, 20); + + _putchars(_cmd_buff, 21); +} +/******************************************************************************* +* Function Name : void epd_fill_triangle(int x0, int y0, int x1, int y1, int x2, int y2) +* Description : +* Input : +* Output : None +* Return : +* Attention : None +*******************************************************************************/ +void epd_fill_triangle(int x0, int y0, int x1, int y1, int x2, int y2) +{ + _cmd_buff[0] = FRAME_B; + + _cmd_buff[1] = 0x00; + _cmd_buff[2] = 0x15; + + _cmd_buff[3] = CMD_FILL_TRIANGLE; + + _cmd_buff[4] = (x0 >> 8) & 0xFF; + _cmd_buff[5] = x0 & 0xFF; + _cmd_buff[6] = (y0 >> 8) & 0xFF; + _cmd_buff[7] = y0 & 0xFF; + _cmd_buff[8] = (x1 >> 8) & 0xFF; + _cmd_buff[9] = x1 & 0xFF; + _cmd_buff[10] = (y1 >> 8) & 0xFF; + _cmd_buff[11] = y1 & 0xFF; + _cmd_buff[12] = (x2 >> 8) & 0xFF; + _cmd_buff[13] = x2 & 0xFF; + _cmd_buff[14] = (y2 >> 8) & 0xFF; + _cmd_buff[15] = y2 & 0xFF; + + _cmd_buff[16] = FRAME_E0; + _cmd_buff[17] = FRAME_E1; + _cmd_buff[18] = FRAME_E2; + _cmd_buff[19] = FRAME_E3; + _cmd_buff[20] = _verify(_cmd_buff, 20); + + _putchars(_cmd_buff, 21); +} +/******************************************************************************* +* Function Name : void epd_clear(void) +* Description : +* Input : +* Output : None +* Return : +* Attention : None +*******************************************************************************/ +void epd_clear(void) +{ + _cmd_buff[0] = FRAME_B; + + _cmd_buff[1] = 0x00; + _cmd_buff[2] = 0x09; + + _cmd_buff[3] = CMD_CLEAR; + + _cmd_buff[4] = FRAME_E0; + _cmd_buff[5] = FRAME_E1; + _cmd_buff[6] = FRAME_E2; + _cmd_buff[7] = FRAME_E3; + _cmd_buff[8] = _verify(_cmd_buff, 8); + + _putchars(_cmd_buff, 9); +} + +/******************************************************************************* +* Function Name : void epd_disp_char(unsigned char ch, int x0, int y0); +* Description : +* Input : +* Output : None +* Return : +* Attention : None +*******************************************************************************/ +void epd_disp_char(unsigned char ch, int x0, int y0) +{ + unsigned char buff[2]; + + buff[0] = ch; + buff[1] = 0; + + epd_disp_string(buff, x0, y0); +} +/******************************************************************************* +* Function Name : void epd_disp_string(const void * p, int x0, int y0) +* Description : +* Input : +* Output : None +* Return : +* Attention : None +*******************************************************************************/ +void epd_disp_string(const void * p, int x0, int y0) +{ + int string_size; + unsigned char * ptr = (unsigned char *)p; + + + string_size = strlen((const char *)ptr); + string_size += 14; + + _cmd_buff[0] = FRAME_B; + + _cmd_buff[1] = (string_size >> 8) & 0xFF; + _cmd_buff[2] = string_size & 0xFF; + + _cmd_buff[3] = CMD_DRAW_STRING; + + _cmd_buff[4] = (x0 >> 8) & 0xFF; + _cmd_buff[5] = x0 & 0xFF; + _cmd_buff[6] = (y0 >> 8) & 0xFF; + _cmd_buff[7] = y0 & 0xFF; + + strcpy((char *)(&_cmd_buff[8]), (const char *)ptr); + + string_size -= 5; + + _cmd_buff[string_size] = FRAME_E0; + _cmd_buff[string_size + 1] = FRAME_E1; + _cmd_buff[string_size + 2] = FRAME_E2; + _cmd_buff[string_size + 3] = FRAME_E3; + _cmd_buff[string_size + 4] = _verify(_cmd_buff, string_size + 4); + + _putchars(_cmd_buff, string_size + 5); +} +/******************************************************************************* +* Function Name : void epd_disp_bitmap(const void * p, int x0, int y0) +* Description : +* Input : +* Output : None +* Return : +* Attention : None +*******************************************************************************/ +void epd_disp_bitmap(const void * p, int x0, int y0) +{ + int string_size; + unsigned char * ptr = (unsigned char *)p; + + string_size = strlen((const char *)ptr); + string_size += 14; + + _cmd_buff[0] = FRAME_B; + + _cmd_buff[1] = (string_size >> 8) & 0xFF; + _cmd_buff[2] = string_size & 0xFF; + + _cmd_buff[3] = CMD_DRAW_BITMAP; + + _cmd_buff[4] = (x0 >> 8) & 0xFF; + _cmd_buff[5] = x0 & 0xFF; + _cmd_buff[6] = (y0 >> 8) & 0xFF; + _cmd_buff[7] = y0 & 0xFF; + + strcpy((char *)(&_cmd_buff[8]), (const char *)ptr); + + string_size -= 5; + + _cmd_buff[string_size] = FRAME_E0; + _cmd_buff[string_size + 1] = FRAME_E1; + _cmd_buff[string_size + 2] = FRAME_E2; + _cmd_buff[string_size + 3] = FRAME_E3; + _cmd_buff[string_size + 4] = _verify(_cmd_buff, string_size + 4); + + _putchars(_cmd_buff, string_size + 5); +} diff --git a/epd.h b/epd.h new file mode 100644 index 0000000..b36eca7 --- /dev/null +++ b/epd.h @@ -0,0 +1,156 @@ +/********************************************************************************************************* +* +* File : epd.h +* Hardware Environment: +* Build Environment : RealView MDK-ARM Version: 4.74 +* Version : V1.0 +* By : V +* +* (c) Copyright 2005-2015, WaveShare +* http://www.waveshare.net +* All Rights Reserved +* +*********************************************************************************************************/ +#ifndef EPD_H + #define EPD_H + + +#define CMD_SIZE 512 + +/* +frame format +*/ +#define FRAME_B 0xA5 +#define FRAME_E0 0xCC +#define FRAME_E1 0x33 +#define FRAME_E2 0xC3 +#define FRAME_E3 0x3C + + +/* +color define +*/ +#define WHITE 0x03 +#define GRAY 0x02 +#define DARK_GRAY 0x01 +#define BLACK 0x00 + +/* +command define +*/ +#define CMD_HANDSHAKE 0x00 //handshake +#define CMD_SET_BAUD 0x01 //set baud +#define CMD_READ_BAUD 0x02 //read baud +#define CMD_MEMORYMODE 0x07 //set memory mode +#define CMD_STOPMODE 0x08 //enter stop mode +#define CMD_UPDATE 0x0A //update +#define CMD_SCREEN_ROTATION 0x0D //set screen rotation +#define CMD_LOAD_FONT 0x0E //load font +#define CMD_LOAD_PIC 0x0F //load picture + +#define CMD_SET_COLOR 0x10 //set color +#define CMD_SET_EN_FONT 0x1E //set english font +#define CMD_SET_CH_FONT 0x1F //set chinese font + +#define CMD_DRAW_PIXEL 0x20 //set pixel +#define CMD_DRAW_LINE 0x22 //draw line +#define CMD_FILL_RECT 0x24 //fill rectangle +#define CMD_DRAW_CIRCLE 0x26 //draw circle +#define CMD_FILL_CIRCLE 0x27 //fill circle +#define CMD_DRAW_TRIANGLE 0x28 //draw triangle +#define CMD_FILL_TRIANGLE 0x29 //fill triangle +#define CMD_CLEAR 0x2E //clear screen use back color + +#define CMD_DRAW_STRING 0x30 //draw string + +#define CMD_DRAW_BITMAP 0x70 //draw bitmap + + +/* +FONT +*/ +#define GBK32 0x01 +#define GBK48 0x02 +#define GBK64 0x03 + +#define ASCII32 0x01 +#define ASCII48 0x02 +#define ASCII64 0x03 + + + +/* +Memory Mode +*/ +#define MEM_NAND 0 +#define MEM_TF 1 + +/* +set screen rotation +*/ +#define EPD_NORMAL 0 //screen normal +#define EPD_INVERSION 1 //screen inversion + + +void epd_init(void); +void epd_reset(void); +void epd_wakeup(void); + +void epd_handshake(void); +void epd_set_memory(unsigned char mode); +void epd_enter_stopmode(void); +void epd_update(void); +void epd_screen_rotation(unsigned char mode); +void epd_load_font(void); +void epd_load_pic(void); + + +void epd_set_color(unsigned char color, unsigned char bkcolor); +void epd_set_en_font(unsigned char font); +void epd_set_ch_font(unsigned char font); + +void epd_draw_pixel(int x0, int y0); +void epd_draw_line(int x0, int y0, int x1, int y1); +void epd_fill_rect(int x0, int y0, int x1, int y1); +void epd_draw_circle(int x0, int y0, int r); +void epd_fill_circle(int x0, int y0, int r); +void epd_draw_triangle(int x0, int y0, int x1, int y1, int x2, int y2); +void epd_fill_triangle(int x0, int y0, int x1, int y1, int x2, int y2); +void epd_clear(void); + +void epd_disp_char(unsigned char ch, int x0, int y0); +void epd_disp_string(const void * p, int x0, int y0); + +void epd_disp_bitmap(const void * p, int x0, int y0); + + + +#endif + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/esp_time.ino b/esp_time.ino new file mode 100644 index 0000000..4ec3709 --- /dev/null +++ b/esp_time.ino @@ -0,0 +1,279 @@ +/* + * Copyright Paul Warren 2019 + * + * Released under the terms of the GPLv3 license. + */ +#include +#include +#include +#include +#include + +#include "epd.h" +#include "credential.h" + +// Weather bits + +// Australian BOM bits, Belconnen is mine. +// see http://www.bom.gov.au/catalogue/data-feeds.shtml +//const char* aac = "NSW_PT254"; +//const char* bom_url = "ftp://ftp.bom.gov.au/anon/gen/fwo/IDN11060.xml"; + +// openweathermap, api_key from credential.h +// +// Maybe try String types? +const String owm_url = "http://api.openweathermap.org/data/2.5/weather?q=Belconnen,AU&APPID="; + + +// Timezone bits + +// Australia Eastern Time Zone (Sydney, Melbourne) +TimeChangeRule aEDT = {"AEDT", First, Sun, Oct, 2, 660}; // UTC + 11 hours +TimeChangeRule aEST = {"AEST", First, Sun, Apr, 3, 600}; // UTC + 10 hours +Timezone ausET(aEDT, aEST); +TimeChangeRule *tcr; + +// Network clients +WiFiUDP ntpUDP; + +HTTPClient http; + +NTPClient timeClient(ntpUDP, "raspberrypi.lan", 0, 60000); //use internal ntp server, update every 10 minutes + + +// defined in "credentials.h" +const char* ssid = ssid_name; // The SSID (name) of your Wi-Fi network +const char* password = ssid_pass; // The password of the Wi-Fi network + +const int led = LED_BUILTIN; + +// yes this seems backwards but it works... +void ledOn(void) { digitalWrite(led, LOW);} +void ledOff(void) { digitalWrite(led, HIGH);} +void wait(void) { delay(1500);} + +// Font width +int dwidth = 185; + +void setup() { + pinMode(led, OUTPUT); + ledOff(); + + wifi_set_sleep_type(LIGHT_SLEEP_T); + + epd_init(); + epd_wakeup(); + epd_set_memory(MEM_NAND); + epd_set_color(BLACK, WHITE); + epd_set_en_font(ASCII64); + epd_clear(); + + Serial.begin(115200); // Start serial communication + Serial.setTimeout(2000); + while (!Serial) { } + Serial.println("\r\n\r\nSTARTING\r\n"); + + wifi(); + printDateTime(0); + timeClient.begin(); + ntpUpdate(); + epd_clear(); + printDateTime(1); + ledOff(); +} + +void wifi() { + WiFi.persistent(false); + WiFi.mode(WIFI_OFF); + WiFi.mode(WIFI_STA); + WiFi.begin(ssid, password); // Access WiFi + + Serial.print("Connecting to "); + Serial.print(ssid); + Serial.print(" ..."); + + while (WiFi.status() != WL_CONNECTED) { // Wait for WiFi to connect + delay(250); + Serial.print("."); + } + + Serial.println('\n'); + Serial.println("WiFi connection established"); + Serial.print("Device's IP address is "); + Serial.println(WiFi.localIP()); // Show device's IP address +} + +void ntpUpdate() { + timeClient.update(); + setTime(timeClient.getEpochTime()); +} + + +void disp_digit(int digit, int xpos){ + // digit: digit to display + // xpos: X digit position, indexed at 1 + + int dpos = 0; + int ypos = 0; + dpos = ((xpos - 1) * dwidth); + if (xpos > 2) { + dpos += 60; // account for colon + } + switch (digit) { + case 0: + epd_disp_bitmap("0.JPG", dpos, ypos); + break; + case 1: + epd_disp_bitmap("1.JPG", dpos, ypos); + break; + case 2: + epd_disp_bitmap("2.JPG", dpos, ypos); + break; + case 3: + epd_disp_bitmap("3.JPG", dpos, ypos); + break; + case 4: + epd_disp_bitmap("4.JPG", dpos, ypos); + break; + case 5: + epd_disp_bitmap("5.JPG", dpos, ypos); + break; + case 6: + epd_disp_bitmap("6.JPG", dpos, ypos); + break; + case 7: + epd_disp_bitmap("7.JPG", dpos, ypos); + break; + case 8: + epd_disp_bitmap("8.JPG", dpos, ypos); + break; + case 9: + epd_disp_bitmap("9.JPG", dpos, ypos); + break; + } +} + +void disp_time(int hours, int minutes) { + + epd_clear(); + + // first digit of hours + if (hours > 19) { + disp_digit(2, 1); + hours -= 20; + } else if (hours > 9) { + disp_digit(1, 1); + hours -= 10; + } else { + disp_digit(0, 1); + } + + // second hours digit + disp_digit(hours, 2); + + epd_disp_bitmap("COLO.JPG", 2 * dwidth, 0); + + // first minutes digit + if (minutes > 49) { + disp_digit(5, 3); + minutes -= 50; + } else if (minutes > 39) { + disp_digit(4, 3); + minutes -= 40; + } else if (minutes > 29) { + disp_digit(3, 3); + minutes -= 30; + } else if (minutes > 19) { + disp_digit(2, 3); + minutes -= 20; + } else if (minutes > 9) { + disp_digit(1, 3); + minutes -= 10; + } else { + disp_digit(0, 3); + } + + // second minutes digit + disp_digit(minutes, 4); + +} + + +void printDateTime(int update_epd) +{ + char buf[64]; + + time_t t; + + t = ausET.toLocal(now(), &tcr); + + char m[4]; // temporary storage for month string (DateStrings.cpp uses shared buffer) + strcpy(m, monthShortStr(month(t))); + + sprintf(buf, "%.2d:%.2d:%.2d", hour(t), minute(t), second(t)); + Serial.print(buf); Serial.print(" "); + + if (update_epd > 0) { + disp_time(hour(t), minute(t)); + } + + sprintf(buf, "%s %.2d %s %d %s", dayShortStr(weekday(t)), day(t), m, year(t), &tcr -> abbrev); + Serial.println(buf); + + if (update_epd > 0) { + epd_set_en_font(ASCII64); + epd_disp_string(buf, 150, 290); + epd_update(); + delay(1500); + Serial.println("Screen Updated"); + } +} + +void weatherUpdate(void) { + + http.begin(owm_url + api_key); + int httpCode = http.GET(); + + if (httpCode > 0) { + + String payload = http.getString(); + Serial.println(httpCode); + Serial.println(payload); + } else { + Serial.print("Error on HTTP Request: "); + Serial.println(httpCode); + + http.end(); + } +} + +void loop() { + int sleep_seconds = 0; + + Serial.println("Back from sleep!"); + + if (WiFi.status() != WL_CONNECTED) { + wifi(); + } + + ntpUpdate(); + //weatherUpdate(); + + if (second(now()) >= 49) { + epd_wakeup(); + while (second(now()) != 0) { + delay(500); + } + printDateTime(1); + delay(4000); + epd_enter_stopmode(); + } + + + sleep_seconds = 49 - second(now()); + Serial.print("Sleeping for: "); + Serial.println(sleep_seconds); + + delay(sleep_seconds * 1000); + +} diff --git a/images/0.jpg b/images/0.jpg new file mode 100644 index 0000000..3f92134 Binary files /dev/null and b/images/0.jpg differ diff --git a/images/1.jpg b/images/1.jpg new file mode 100644 index 0000000..e4e85d6 Binary files /dev/null and b/images/1.jpg differ diff --git a/images/2.jpg b/images/2.jpg new file mode 100644 index 0000000..88e4f97 Binary files /dev/null and b/images/2.jpg differ diff --git a/images/3.jpg b/images/3.jpg new file mode 100644 index 0000000..8a76a8c Binary files /dev/null and b/images/3.jpg differ diff --git a/images/4.jpg b/images/4.jpg new file mode 100644 index 0000000..a80150e Binary files /dev/null and b/images/4.jpg differ diff --git a/images/5.jpg b/images/5.jpg new file mode 100644 index 0000000..8bae2ff Binary files /dev/null and b/images/5.jpg differ diff --git a/images/6.jpg b/images/6.jpg new file mode 100644 index 0000000..dee759b Binary files /dev/null and b/images/6.jpg differ diff --git a/images/7.jpg b/images/7.jpg new file mode 100644 index 0000000..8b3abf4 Binary files /dev/null and b/images/7.jpg differ diff --git a/images/8.jpg b/images/8.jpg new file mode 100644 index 0000000..f7fc7a0 Binary files /dev/null and b/images/8.jpg differ diff --git a/images/9.jpg b/images/9.jpg new file mode 100644 index 0000000..3de9d37 Binary files /dev/null and b/images/9.jpg differ diff --git a/images/COLO.jpg b/images/COLO.jpg new file mode 100644 index 0000000..22eef91 Binary files /dev/null and b/images/COLO.jpg differ diff --git a/images/build.sh b/images/build.sh new file mode 100755 index 0000000..0fc6bfd --- /dev/null +++ b/images/build.sh @@ -0,0 +1,15 @@ +#!/bin/bash + +opt=$1 +case $opt in + -u) ~/bin/arduino --upload -v --port /dev/ttyUSB0 --board esp8266:esp8266:d1_mini images.ino + ;; + *) ~/bin/arduino --verify -v --board esp8266:esp8266:d1_mini images.ino + ;; +esac + + + + + + diff --git a/images/create_images.py b/images/create_images.py new file mode 100644 index 0000000..da47525 --- /dev/null +++ b/images/create_images.py @@ -0,0 +1,19 @@ +#!/usr/bin/env python + +from PIL import Image, ImageDraw, ImageFont + +fnt = ImageFont.truetype('/Library/Fonts/FreeMono.ttf', 336) + + +for I in ("1", "2", "3", "4", "5", "6", "7", "8", "9", "0"): + img = Image.new('RGB', (185, 224), color = (255, 255, 255)) + d = ImageDraw.Draw(img) + d.text((0,-60), I, font=fnt, fill=(0,0,0)) + img.save("%s.jpg" % (I)) + + +img = Image.new('RGB', (60,224), color = (255, 255, 255)) +d = ImageDraw.Draw(img) +d.text((-70,-60), ":", font=fnt, fill=(0,0,0)) +# the -70 offset gets the : in the right spot for a 60 pixel wide image. Could proabably reduce the font size a bit +img.save("COLO.jpg"); diff --git a/images/images.ino b/images/images.ino new file mode 100644 index 0000000..de0afee --- /dev/null +++ b/images/images.ino @@ -0,0 +1,52 @@ +/* + * Copyright Paul Warren 2019 + * + * Released under the terms of the GPLv3 license. + */ +#include "epd.h" + +const int led = LED_BUILTIN; + +// Font width +int dwidth = 185; + +void ledOn(void) { digitalWrite(led, HIGH);} +void ledOff(void) { digitalWrite(led, LOW);} +void wait(void) { delay(1500);} + + +void setup() { + Serial.begin(115200); // Start serial communication + Serial.setTimeout(2000); + while (!Serial) { } + Serial.println("\r\n\r\nSTARTING\r\n"); + + epd_init(); + epd_wakeup(); + delay(1500); + epd_set_memory(MEM_TF); + epd_load_pic(); + epd_set_memory(MEM_NAND); + delay(1500); + epd_clear(); + +} + +void loop() { + int flag = 0; + + delay(1500); + Serial.println("Files uploaded"); + Serial.println("Please wait till screen LED goes flashes again"); + + while (1) { + if(flag) { + flag = 0; + ledOff(); + } else { + flag = 1; + ledOn(); + } + delay(1000); + } +} diff --git a/images/old/0.jpg b/images/old/0.jpg new file mode 100644 index 0000000..cba40c8 Binary files /dev/null and b/images/old/0.jpg differ diff --git a/images/old/0_cropped.jpg b/images/old/0_cropped.jpg new file mode 100644 index 0000000..a5c9253 Binary files /dev/null and b/images/old/0_cropped.jpg differ diff --git a/images/old/1.jpg b/images/old/1.jpg new file mode 100644 index 0000000..bac9259 Binary files /dev/null and b/images/old/1.jpg differ diff --git a/images/old/2.jpg b/images/old/2.jpg new file mode 100644 index 0000000..38c8b3c Binary files /dev/null and b/images/old/2.jpg differ diff --git a/images/old/3.jpg b/images/old/3.jpg new file mode 100644 index 0000000..bbd1b8f Binary files /dev/null and b/images/old/3.jpg differ diff --git a/images/old/4.jpg b/images/old/4.jpg new file mode 100644 index 0000000..d7acb51 Binary files /dev/null and b/images/old/4.jpg differ diff --git a/images/old/5.jpg b/images/old/5.jpg new file mode 100644 index 0000000..cc9b831 Binary files /dev/null and b/images/old/5.jpg differ diff --git a/images/old/6.jpg b/images/old/6.jpg new file mode 100644 index 0000000..b7de1db Binary files /dev/null and b/images/old/6.jpg differ diff --git a/images/old/7.jpg b/images/old/7.jpg new file mode 100644 index 0000000..6752075 Binary files /dev/null and b/images/old/7.jpg differ diff --git a/images/old/8.jpg b/images/old/8.jpg new file mode 100644 index 0000000..5c7cef5 Binary files /dev/null and b/images/old/8.jpg differ diff --git a/images/old/9.jpg b/images/old/9.jpg new file mode 100644 index 0000000..03add64 Binary files /dev/null and b/images/old/9.jpg differ diff --git a/images/old/COLO.jpg b/images/old/COLO.jpg new file mode 100644 index 0000000..d4ea047 Binary files /dev/null and b/images/old/COLO.jpg differ