diff --git a/LICENSE b/LICENSE index 10669682..f288702d 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,674 @@ -MIT License + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 -Copyright (c) 2020 jomjol + 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. -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: + Preamble -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. + The GNU General Public License is a free, copyleft license for +software and other kinds of works. -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. + 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 index 057d0aee..dfe5c167 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,15 @@ In other cases you can contact the developer via email: copyRmtHalfBlock(); + RMT.int_clr.val |= 1 << ( 24 + channel ); + } else if ( RMT.int_st.val & ( 1 << (3 * channel ) ) ) { // tx_end + if ( self ) + xSemaphoreGiveFromISR( self->_finishedFlag, nullptr ); + RMT.int_clr.val |= 1 << ( 3 * channel ); + } + } +} + +void IRAM_ATTR SmartLed::copyRmtHalfBlock() { + int offset = detail::MAX_PULSES * _halfIdx; + _halfIdx = !_halfIdx; + int len = 3 - _componentPosition + 3 * ( _count - 1 ); + len = std::min( len, detail::MAX_PULSES / 8 ); + + if ( !len ) { + for ( int i = 0; i < detail::MAX_PULSES; i++) { + RMTMEM.chan[ _channel].data32[i + offset ].val = 0; + } + } + + int i; + for ( i = 0; i != len && _pixelPosition != _count; i++ ) { + uint8_t val = _buffer[ _pixelPosition ].getGrb( _componentPosition ); + for ( int j = 0; j != 8; j++, val <<= 1 ) { + int bit = val >> 7; + int idx = i * 8 + offset + j; + RMTMEM.chan[ _channel ].data32[ idx ].val = _bitToRmt[ bit & 0x01 ].value; + } + if ( _pixelPosition == _count - 1 && _componentPosition == 2 ) { + RMTMEM.chan[ _channel ].data32[ i * 8 + offset + 7 ].duration1 = + _timing.TRS / ( detail::RMT_DURATION_NS * detail::DIVIDER ); + } + + _componentPosition++; + if ( _componentPosition == 3 ) { + _componentPosition = 0; + _pixelPosition++; + } + } + + for ( i *= 8; i != detail::MAX_PULSES; i++ ) { + RMTMEM.chan[ _channel ].data32[ i + offset ].val = 0; + } +} diff --git a/code/SmartLeds.h b/code/SmartLeds.h new file mode 100644 index 00000000..824eb337 --- /dev/null +++ b/code/SmartLeds.h @@ -0,0 +1,530 @@ +#pragma once + +/* + * A C++ driver for the WS2812 LEDs using the RMT peripheral on the ESP32. + * + * Jan "yaqwsx" Mrázek + * + * Based on the work by Martin F. Falatic - https://github.com/FozzTexx/ws2812-demo + */ + +/* + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + */ + +#include +#include +#include + +#if defined ( ARDUINO ) + extern "C" { // ...someone forgot to put in the includes... + #include "esp32-hal.h" + #include "esp_intr_alloc.h" + #include "esp_ipc.h" + #include "driver/gpio.h" + #include "driver/periph_ctrl.h" + #include "freertos/semphr.h" + #include "soc/rmt_struct.h" + #include + #include "esp_idf_version.h" +#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL( 4, 0, 0 ) + #include "soc/dport_reg.h" +#endif + } +#elif defined ( ESP_PLATFORM ) + extern "C" { // ...someone forgot to put in the includes... + #include + #include + #include + #include + #include + #include + #include + #include + #include + } + #include +#endif + +#include "Color.h" + +namespace detail { + +struct TimingParams { + uint32_t T0H; + uint32_t T1H; + uint32_t T0L; + uint32_t T1L; + uint32_t TRS; +}; + +union RmtPulsePair { + struct { + int duration0:15; + int level0:1; + int duration1:15; + int level1:1; + }; + uint32_t value; +}; + +static const int DIVIDER = 4; // 8 still seems to work, but timings become marginal +static const int MAX_PULSES = 32; // A channel has a 64 "pulse" buffer - we use half per pass +static const double RMT_DURATION_NS = 12.5; // minimum time of a single RMT duration based on clock ns + +} // namespace detail + +using LedType = detail::TimingParams; + +static const LedType LED_WS2812 = { 350, 700, 800, 600, 50000 }; +static const LedType LED_WS2812B = { 400, 850, 850, 400, 50100 }; +static const LedType LED_SK6812 = { 300, 600, 900, 600, 80000 }; +static const LedType LED_WS2813 = { 350, 800, 350, 350, 300000 }; + +enum BufferType { SingleBuffer = 0, DoubleBuffer }; + +enum IsrCore { CoreFirst = 0, CoreSecond = 1, CoreCurrent = 2}; + +class SmartLed { +public: + // The RMT interrupt must not run on the same core as WiFi interrupts, otherwise SmartLeds + // can't fill the RMT buffer fast enough, resulting in rendering artifacts. + // Usually, that means you have to set isrCore == CoreSecond. + // + // If you use anything other than CoreCurrent, the FreeRTOS scheduler MUST be already running, + // so you can't use it if you define SmartLed as global variable. + SmartLed( const LedType& type, int count, int pin, int channel = 0, BufferType doubleBuffer = SingleBuffer, IsrCore isrCore = CoreCurrent) + : _timing( type ), + _channel( channel ), + _count( count ), + _firstBuffer( new Rgb[ count ] ), + _secondBuffer( doubleBuffer ? new Rgb[ count ] : nullptr ), + _finishedFlag( xSemaphoreCreateBinary() ) + { + assert( channel >= 0 && channel < 8 ); + assert( ledForChannel( channel ) == nullptr ); + + xSemaphoreGive( _finishedFlag ); + + DPORT_SET_PERI_REG_MASK( DPORT_PERIP_CLK_EN_REG, DPORT_RMT_CLK_EN ); + DPORT_CLEAR_PERI_REG_MASK( DPORT_PERIP_RST_EN_REG, DPORT_RMT_RST ); + + PIN_FUNC_SELECT( GPIO_PIN_MUX_REG[ pin ], 2 ); + gpio_set_direction( static_cast< gpio_num_t >( pin ), GPIO_MODE_OUTPUT ); + gpio_matrix_out( static_cast< gpio_num_t >( pin ), RMT_SIG_OUT0_IDX + _channel, 0, 0 ); + initChannel( _channel ); + + RMT.tx_lim_ch[ _channel ].limit = detail::MAX_PULSES; + RMT.int_ena.val |= 1 << ( 24 + _channel ); + RMT.int_ena.val |= 1 << ( 3 * _channel ); + + _bitToRmt[ 0 ].level0 = 1; + _bitToRmt[ 0 ].level1 = 0; + _bitToRmt[ 0 ].duration0 = _timing.T0H / ( detail::RMT_DURATION_NS * detail::DIVIDER ); + _bitToRmt[ 0 ].duration1 = _timing.T0L / ( detail::RMT_DURATION_NS * detail::DIVIDER ); + + _bitToRmt[ 1 ].level0 = 1; + _bitToRmt[ 1 ].level1 = 0; + _bitToRmt[ 1 ].duration0 = _timing.T1H / ( detail::RMT_DURATION_NS * detail::DIVIDER ); + _bitToRmt[ 1 ].duration1 = _timing.T1L / ( detail::RMT_DURATION_NS * detail::DIVIDER ); + + if ( !anyAlive() ) { + _interruptCore = isrCore; + if(isrCore != CoreCurrent) { + ESP_ERROR_CHECK(esp_ipc_call_blocking(isrCore, registerInterrupt, NULL)); + } else { + registerInterrupt(NULL); + } + } + + ledForChannel( channel ) = this; + } + + ~SmartLed() { + ledForChannel( _channel ) = nullptr; + if ( !anyAlive() ) { + if(_interruptCore != CoreCurrent) { + ESP_ERROR_CHECK(esp_ipc_call_blocking(_interruptCore, unregisterInterrupt, NULL)); + } else { + unregisterInterrupt(NULL); + } + } + vSemaphoreDelete( _finishedFlag ); + } + + Rgb& operator[]( int idx ) { + return _firstBuffer[ idx ]; + } + + const Rgb& operator[]( int idx ) const { + return _firstBuffer[ idx ]; + } + + void show() { + _buffer = _firstBuffer.get(); + startTransmission(); + swapBuffers(); + } + + bool wait( TickType_t timeout = portMAX_DELAY ) { + if( xSemaphoreTake( _finishedFlag, timeout ) == pdTRUE ) { + xSemaphoreGive( _finishedFlag ); + return true; + } + return false; + } + + int size() const { + return _count; + } + + Rgb *begin() { return _firstBuffer.get(); } + const Rgb *begin() const { return _firstBuffer.get(); } + const Rgb *cbegin() const { return _firstBuffer.get(); } + + Rgb *end() { return _firstBuffer.get() + _count; } + const Rgb *end() const { return _firstBuffer.get() + _count; } + const Rgb *cend() const { return _firstBuffer.get() + _count; } + +private: + static intr_handle_t _interruptHandle; + static IsrCore _interruptCore; + + static void initChannel( int channel ) { + RMT.apb_conf.fifo_mask = 1; //enable memory access, instead of FIFO mode. + RMT.apb_conf.mem_tx_wrap_en = 1; //wrap around when hitting end of buffer + RMT.conf_ch[ channel ].conf0.div_cnt = detail::DIVIDER; + RMT.conf_ch[ channel ].conf0.mem_size = 1; + RMT.conf_ch[ channel ].conf0.carrier_en = 0; + RMT.conf_ch[ channel ].conf0.carrier_out_lv = 1; + RMT.conf_ch[ channel ].conf0.mem_pd = 0; + + RMT.conf_ch[ channel ].conf1.rx_en = 0; + RMT.conf_ch[ channel ].conf1.mem_owner = 0; + RMT.conf_ch[ channel ].conf1.tx_conti_mode = 0; //loop back mode. + RMT.conf_ch[ channel ].conf1.ref_always_on = 1; // use apb clock: 80M + RMT.conf_ch[ channel ].conf1.idle_out_en = 1; + RMT.conf_ch[ channel ].conf1.idle_out_lv = 0; + } + + static void registerInterrupt(void *) { + ESP_ERROR_CHECK(esp_intr_alloc( ETS_RMT_INTR_SOURCE, 0, interruptHandler, nullptr, &_interruptHandle)); + } + + static void unregisterInterrupt(void*) { + esp_intr_free( _interruptHandle ); + } + + static SmartLed*& IRAM_ATTR ledForChannel( int channel ); + static void IRAM_ATTR interruptHandler( void* ); + + void IRAM_ATTR copyRmtHalfBlock(); + + void swapBuffers() { + if ( _secondBuffer ) + _firstBuffer.swap( _secondBuffer ); + } + + void startTransmission() { + // Invalid use of the library + if( xSemaphoreTake( _finishedFlag, 0 ) != pdTRUE ) + abort(); + + _pixelPosition = _componentPosition = _halfIdx = 0; + copyRmtHalfBlock(); + if ( _pixelPosition < _count ) + copyRmtHalfBlock(); + + RMT.conf_ch[ _channel ].conf1.mem_rd_rst = 1; + RMT.conf_ch[ _channel ].conf1.tx_start = 1; + } + + static bool anyAlive() { + for ( int i = 0; i != 8; i++ ) + if ( ledForChannel( i ) != nullptr ) return true; + return false; + } + + const LedType& _timing; + int _channel; + detail::RmtPulsePair _bitToRmt[ 2 ]; + int _count; + std::unique_ptr< Rgb[] > _firstBuffer; + std::unique_ptr< Rgb[] > _secondBuffer; + Rgb *_buffer; + + xSemaphoreHandle _finishedFlag; + + int _pixelPosition; + int _componentPosition; + int _halfIdx; +}; + +class Apa102 { +public: + struct ApaRgb { + ApaRgb( uint8_t r = 0, uint8_t g = 0, uint32_t b = 0, uint32_t v = 0xFF ) + : v( 0xE0 | v ), b( b ), g( g ), r( r ) + {} + + ApaRgb& operator=( const Rgb& o ) { + r = o.r; + g = o.g; + b = o.b; + return *this; + } + + ApaRgb& operator=( const Hsv& o ) { + *this = Rgb{ o }; + return *this; + } + + uint8_t v, b, g, r; + }; + + static const int FINAL_FRAME_SIZE = 4; + static const int TRANS_COUNT = 2 + 8; + + Apa102( int count, int clkpin, int datapin, BufferType doubleBuffer = SingleBuffer ) + : _count( count ), + _firstBuffer( new ApaRgb[ count ] ), + _secondBuffer( doubleBuffer ? new ApaRgb[ count ] : nullptr ), + _initFrame( 0 ) + { + spi_bus_config_t buscfg; + memset( &buscfg, 0, sizeof( buscfg ) ); + buscfg.mosi_io_num = datapin; + buscfg.miso_io_num = -1; + buscfg.sclk_io_num = clkpin; + buscfg.quadwp_io_num = -1; + buscfg.quadhd_io_num = -1; + buscfg.max_transfer_sz = 65535; + + spi_device_interface_config_t devcfg; + memset( &devcfg, 0, sizeof( devcfg ) ); + devcfg.clock_speed_hz = 1000000; + devcfg.mode = 0; + devcfg.spics_io_num = -1; + devcfg.queue_size = TRANS_COUNT; + devcfg.pre_cb = nullptr; + + auto ret = spi_bus_initialize( HSPI_HOST, &buscfg, 1 ); + assert( ret == ESP_OK ); + + ret = spi_bus_add_device( HSPI_HOST, &devcfg, &_spi ); + assert( ret == ESP_OK ); + + std::fill_n( _finalFrame, FINAL_FRAME_SIZE, 0xFFFFFFFF ); + } + + ~Apa102() { + // ToDo + } + + ApaRgb& operator[]( int idx ) { + return _firstBuffer[ idx ]; + } + + const ApaRgb& operator[]( int idx ) const { + return _firstBuffer[ idx ]; + } + + void show() { + _buffer = _firstBuffer.get(); + startTransmission(); + swapBuffers(); + } + + void wait() { + for ( int i = 0; i != _transCount; i++ ) { + spi_transaction_t *t; + spi_device_get_trans_result( _spi, &t, portMAX_DELAY ); + } + } +private: + void swapBuffers() { + if ( _secondBuffer ) + _firstBuffer.swap( _secondBuffer ); + } + + void startTransmission() { + for ( int i = 0; i != TRANS_COUNT; i++ ) { + _transactions[ i ].cmd = 0; + _transactions[ i ].addr = 0; + _transactions[ i ].flags = 0; + _transactions[ i ].rxlength = 0; + _transactions[ i ].rx_buffer = nullptr; + } + // Init frame + _transactions[ 0 ].length = 32; + _transactions[ 0 ].tx_buffer = &_initFrame; + spi_device_queue_trans( _spi, _transactions + 0, portMAX_DELAY ); + // Data + _transactions[ 1 ].length = 32 * _count; + _transactions[ 1 ].tx_buffer = _buffer; + spi_device_queue_trans( _spi, _transactions + 1, portMAX_DELAY ); + _transCount = 2; + // End frame + for ( int i = 0; i != 1 + _count / 32 / FINAL_FRAME_SIZE; i++ ) { + _transactions[ 2 + i ].length = 32 * FINAL_FRAME_SIZE; + _transactions[ 2 + i ].tx_buffer = _finalFrame; + spi_device_queue_trans( _spi, _transactions + 2 + i, portMAX_DELAY ); + _transCount++; + } + } + + spi_device_handle_t _spi; + int _count; + std::unique_ptr< ApaRgb[] > _firstBuffer, _secondBuffer; + ApaRgb *_buffer; + + spi_transaction_t _transactions[ TRANS_COUNT ]; + int _transCount; + + uint32_t _initFrame; + uint32_t _finalFrame[ FINAL_FRAME_SIZE ]; +}; + +class LDP8806 { +public: + struct LDP8806_GRB { + + LDP8806_GRB( uint8_t g_7bit = 0, uint8_t r_7bit = 0, uint32_t b_7bit = 0 ) + : g( g_7bit ), r( r_7bit ), b( b_7bit ) + { + } + + LDP8806_GRB& operator=( const Rgb& o ) { + //Convert 8->7bit colour + r = ( o.r * 127 / 256 ) | 0x80; + g = ( o.g * 127 / 256 ) | 0x80; + b = ( o.b * 127 / 256 ) | 0x80; + return *this; + } + + LDP8806_GRB& operator=( const Hsv& o ) { + *this = Rgb{ o }; + return *this; + } + + uint8_t g, r, b; + }; + + static const int LED_FRAME_SIZE_BYTES = sizeof( LDP8806_GRB ); + static const int LATCH_FRAME_SIZE_BYTES = 3; + static const int TRANS_COUNT_MAX = 20;//Arbitrary, supports up to 600 LED + + LDP8806( int count, int clkpin, int datapin, BufferType doubleBuffer = SingleBuffer, uint32_t clock_speed_hz = 2000000 ) + : _count( count ), + _firstBuffer( new LDP8806_GRB[ count ] ), + _secondBuffer( doubleBuffer ? new LDP8806_GRB[ count ] : nullptr ), + // one 'latch'/start-of-data mark frame for every 32 leds + _latchFrames( ( count + 31 ) / 32 ) + { + spi_bus_config_t buscfg; + memset( &buscfg, 0, sizeof( buscfg ) ); + buscfg.mosi_io_num = datapin; + buscfg.miso_io_num = -1; + buscfg.sclk_io_num = clkpin; + buscfg.quadwp_io_num = -1; + buscfg.quadhd_io_num = -1; + buscfg.max_transfer_sz = 65535; + + spi_device_interface_config_t devcfg; + memset( &devcfg, 0, sizeof( devcfg ) ); + devcfg.clock_speed_hz = clock_speed_hz; + devcfg.mode = 0; + devcfg.spics_io_num = -1; + devcfg.queue_size = TRANS_COUNT_MAX; + devcfg.pre_cb = nullptr; + + auto ret = spi_bus_initialize( HSPI_HOST, &buscfg, 1 ); + assert( ret == ESP_OK ); + + ret = spi_bus_add_device( HSPI_HOST, &devcfg, &_spi ); + assert( ret == ESP_OK ); + + std::fill_n( _latchBuffer, LATCH_FRAME_SIZE_BYTES, 0x0 ); + } + + ~LDP8806() { + // noop + } + + LDP8806_GRB& operator[]( int idx ) { + return _firstBuffer[ idx ]; + } + + const LDP8806_GRB& operator[]( int idx ) const { + return _firstBuffer[ idx ]; + } + + void show() { + _buffer = _firstBuffer.get(); + startTransmission(); + swapBuffers(); + } + + void wait() { + while ( _transCount-- ) { + spi_transaction_t *t; + spi_device_get_trans_result( _spi, &t, portMAX_DELAY ); + } + } +private: + void swapBuffers() { + if ( _secondBuffer ) + _firstBuffer.swap( _secondBuffer ); + } + + void startTransmission() { + _transCount = 0; + for ( int i = 0; i != TRANS_COUNT_MAX; i++ ) { + _transactions[ i ].cmd = 0; + _transactions[ i ].addr = 0; + _transactions[ i ].flags = 0; + _transactions[ i ].rxlength = 0; + _transactions[ i ].rx_buffer = nullptr; + } + // LED Data + _transactions[ 0 ].length = ( LED_FRAME_SIZE_BYTES * 8 ) * _count; + _transactions[ 0 ].tx_buffer = _buffer; + spi_device_queue_trans( _spi, _transactions + _transCount, portMAX_DELAY ); + _transCount++; + + // 'latch'/start-of-data marker frames + for ( int i = 0; i < _latchFrames; i++ ) { + _transactions[ _transCount ].length = ( LATCH_FRAME_SIZE_BYTES * 8 ); + _transactions[ _transCount ].tx_buffer = _latchBuffer; + spi_device_queue_trans( _spi, _transactions + _transCount, portMAX_DELAY ); + _transCount++; + } + } + + spi_device_handle_t _spi; + int _count; + std::unique_ptr< LDP8806_GRB[] > _firstBuffer, _secondBuffer; + LDP8806_GRB *_buffer; + + spi_transaction_t _transactions[ TRANS_COUNT_MAX ]; + int _transCount; + + int _latchFrames; + uint8_t _latchBuffer[ LATCH_FRAME_SIZE_BYTES ]; +}; diff --git a/code/components/jomjol_controlGPIO/Color.cpp b/code/components/jomjol_controlGPIO/Color.cpp new file mode 100644 index 00000000..b2beb9ac --- /dev/null +++ b/code/components/jomjol_controlGPIO/Color.cpp @@ -0,0 +1,132 @@ +#include "Color.h" +#include +#include +#include + +namespace { + +// Int -> fixed point +int up( int x ) { return x * 255; } + +} // namespace + +int iRgbSqrt( int num ) { + // https://en.wikipedia.org/wiki/Methods_of_computing_square_roots#Binary_numeral_system_.28base_2.29 + assert( "sqrt input should be non-negative" && num >= 0 ); + assert( "sqrt input should no exceed 16 bits" && num <= 0xFFFF ); + int res = 0; + int bit = 1 << 16; + while ( bit > num ) + bit >>= 2; + while ( bit != 0 ) { + if ( num >= res + bit ) { + num -= res + bit; + res = ( res >> 1 ) + bit; + } else + res >>= 1; + bit >>= 2; + } + return res; +} + +Rgb::Rgb( Hsv y ) { + // https://stackoverflow.com/questions/24152553/hsv-to-rgb-and-back-without-floating-point-math-in-python + // greyscale + if( y.s == 0 ) { + r = g = b = y.v; + return; + } + + const int region = y.h / 43; + const int remainder = ( y.h - ( region * 43 ) ) * 6; + + const int p = ( y.v * ( 255 - y.s ) ) >> 8; + const int q = ( y.v * ( 255 - ( ( y.s * remainder ) >> 8 ) ) ) >> 8; + const int t = ( y.v * ( 255 - ( ( y.s * (255 -remainder ) ) >> 8 ) ) ) >> 8; + + switch( region ) { + case 0: r = y.v; g = t; b = p; break; + case 1: r = q; g = y.v; b = p; break; + case 2: r = p; g = y.v; b = t; break; + case 3: r = p; g = q; b = y.v; break; + case 4: r = t; g = p; b = y.v; break; + case 5: r = y.v; g = p; b = q; break; + default: __builtin_trap(); + } + + a = y.a; +} + +Rgb& Rgb::operator=( Hsv hsv ) { + Rgb r{ hsv }; + swap( r ); + return *this; +} + +Rgb Rgb::operator+( Rgb in ) const { + auto copy = *this; + copy += in; + return copy; +} + +Rgb& Rgb::operator+=( Rgb in ) { + unsigned int red = r + in.r; + r = ( red < 255 ) ? red : 255; + unsigned int green = g + in.g; + g = ( green < 255 ) ? green : 255; + unsigned int blue = b + in.b; + b = ( blue < 255 ) ? blue : 255; + return *this; +} + +Rgb& Rgb::blend( Rgb in ) { + unsigned int inAlpha = in.a * ( 255 - a ); + unsigned int alpha = a + inAlpha; + r = iRgbSqrt( ( ( r * r * a ) + ( in.r * in.r * inAlpha ) ) / alpha ); + g = iRgbSqrt( ( ( g * g * a ) + ( in.g * in.g * inAlpha ) ) / alpha ); + b = iRgbSqrt( ( ( b * b * a ) + ( in.b * in.b * inAlpha ) ) / alpha ); + a = alpha; + return *this; +} + +uint8_t IRAM_ATTR Rgb::getGrb( int idx ) { + switch ( idx ) { + case 0: return g; + case 1: return r; + case 2: return b; + } + __builtin_unreachable(); +} + +Hsv::Hsv( Rgb r ) { + int min = std::min( r.r, std::min( r.g, r.b ) ); + int max = std::max( r.r, std::max( r.g, r.b ) ); + int chroma = max - min; + + v = max; + if ( chroma == 0 ) { + h = s = 0; + return; + } + + s = up( chroma ) / max; + int hh; + if ( max == r.r ) + hh = ( up( int( r.g ) - int( r.b ) ) ) / chroma / 6; + else if ( max == r.g ) + hh = 255 / 3 + ( up( int( r.b ) - int( r.r ) ) ) / chroma / 6; + else + hh = 2 * 255 / 3 + ( up( int( r.r ) - int( r.g ) ) ) / chroma / 6; + + if ( hh < 0 ) + hh += 255; + h = hh; + + a = r.a; +} + +Hsv& Hsv::operator=( Rgb rgb ) { + Hsv h{ rgb }; + swap( h ); + return *this; +} diff --git a/code/components/jomjol_controlGPIO/Color.h b/code/components/jomjol_controlGPIO/Color.h new file mode 100644 index 00000000..1923cf0b --- /dev/null +++ b/code/components/jomjol_controlGPIO/Color.h @@ -0,0 +1,69 @@ +#pragma once + +#include +#include "esp_attr.h" +union Hsv; + +union Rgb { + struct __attribute__ ((packed)) { + uint8_t r, g, b, a; + }; + uint32_t value; + + Rgb( uint8_t r = 0, uint8_t g = 0, uint8_t b = 0, uint8_t a = 255 ) : r( r ), g( g ), b( b ), a( a ) {} + Rgb( Hsv c ); + Rgb& operator=( Rgb rgb ) { swap( rgb ); return *this; } + Rgb& operator=( Hsv hsv ); + Rgb operator+( Rgb in ) const; + Rgb& operator+=( Rgb in ); + bool operator==( Rgb in ) const { return in.value == value; } + Rgb& blend( Rgb in ); + void swap( Rgb& o ) { value = o.value; } + void linearize() { + r = channelGamma(r); + g = channelGamma(g); + b = channelGamma(b); + } + + uint8_t IRAM_ATTR getGrb( int idx ); + + void stretchChannels( uint8_t maxR, uint8_t maxG, uint8_t maxB ) { + r = stretch( r, maxR ); + g = stretch( g, maxG ); + b = stretch( b, maxB ); + } + + void stretchChannelsEvenly( uint8_t max ) { + stretchChannels( max, max, max ); + } + +private: + uint8_t stretch( int value, uint8_t max ) { + return ( value * max ) >> 8; + } + + uint8_t channelGamma( int channel ) { + /* The optimal gamma correction is x^2.8. However, this is expensive to + * compute. Therefore, we use x^3 for gamma correction. Also, we add a + * bias as the WS2812 LEDs do not turn on for values less than 4. */ + if (channel == 0) + return channel; + channel = channel * channel * channel * 251; + channel >>= 24; + return static_cast< uint8_t >( 4 + channel ); + } +}; + +union Hsv { + struct __attribute__ ((packed)) { + uint8_t h, s, v, a; + }; + uint32_t value; + + Hsv( uint8_t h, uint8_t s = 0, uint8_t v = 0, uint8_t a = 255 ) : h( h ), s( s ), v( v ), a( a ) {} + Hsv( Rgb r ); + Hsv& operator=( Hsv h ) { swap( h ); return *this; } + Hsv& operator=( Rgb rgb ); + bool operator==( Hsv in ) const { return in.value == value; } + void swap( Hsv& o ) { value = o.value; } +}; diff --git a/code/components/jomjol_controlGPIO/SmartLeds.cpp b/code/components/jomjol_controlGPIO/SmartLeds.cpp new file mode 100644 index 00000000..a2ba7b29 --- /dev/null +++ b/code/components/jomjol_controlGPIO/SmartLeds.cpp @@ -0,0 +1,63 @@ +#include "SmartLeds.h" + +IsrCore SmartLed::_interruptCore = CoreCurrent; +intr_handle_t SmartLed::_interruptHandle = NULL; + +SmartLed*& IRAM_ATTR SmartLed::ledForChannel( int channel ) { + static SmartLed* table[8] = { nullptr }; + assert( channel < 8 ); + return table[ channel ]; +} + +void IRAM_ATTR SmartLed::interruptHandler(void*) { + for (int channel = 0; channel != 8; channel++) { + auto self = ledForChannel( channel ); + + if ( RMT.int_st.val & (1 << (24 + channel ) ) ) { // tx_thr_event + if ( self ) + self->copyRmtHalfBlock(); + RMT.int_clr.val |= 1 << ( 24 + channel ); + } else if ( RMT.int_st.val & ( 1 << (3 * channel ) ) ) { // tx_end + if ( self ) + xSemaphoreGiveFromISR( self->_finishedFlag, nullptr ); + RMT.int_clr.val |= 1 << ( 3 * channel ); + } + } +} + +void IRAM_ATTR SmartLed::copyRmtHalfBlock() { + int offset = detail::MAX_PULSES * _halfIdx; + _halfIdx = !_halfIdx; + int len = 3 - _componentPosition + 3 * ( _count - 1 ); + len = std::min( len, detail::MAX_PULSES / 8 ); + + if ( !len ) { + for ( int i = 0; i < detail::MAX_PULSES; i++) { + RMTMEM.chan[ _channel].data32[i + offset ].val = 0; + } + } + + int i; + for ( i = 0; i != len && _pixelPosition != _count; i++ ) { + uint8_t val = _buffer[ _pixelPosition ].getGrb( _componentPosition ); + for ( int j = 0; j != 8; j++, val <<= 1 ) { + int bit = val >> 7; + int idx = i * 8 + offset + j; + RMTMEM.chan[ _channel ].data32[ idx ].val = _bitToRmt[ bit & 0x01 ].value; + } + if ( _pixelPosition == _count - 1 && _componentPosition == 2 ) { + RMTMEM.chan[ _channel ].data32[ i * 8 + offset + 7 ].duration1 = + _timing.TRS / ( detail::RMT_DURATION_NS * detail::DIVIDER ); + } + + _componentPosition++; + if ( _componentPosition == 3 ) { + _componentPosition = 0; + _pixelPosition++; + } + } + + for ( i *= 8; i != detail::MAX_PULSES; i++ ) { + RMTMEM.chan[ _channel ].data32[ i + offset ].val = 0; + } +} diff --git a/code/components/jomjol_controlGPIO/SmartLeds.h b/code/components/jomjol_controlGPIO/SmartLeds.h new file mode 100644 index 00000000..824eb337 --- /dev/null +++ b/code/components/jomjol_controlGPIO/SmartLeds.h @@ -0,0 +1,530 @@ +#pragma once + +/* + * A C++ driver for the WS2812 LEDs using the RMT peripheral on the ESP32. + * + * Jan "yaqwsx" Mrázek + * + * Based on the work by Martin F. Falatic - https://github.com/FozzTexx/ws2812-demo + */ + +/* + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + */ + +#include +#include +#include + +#if defined ( ARDUINO ) + extern "C" { // ...someone forgot to put in the includes... + #include "esp32-hal.h" + #include "esp_intr_alloc.h" + #include "esp_ipc.h" + #include "driver/gpio.h" + #include "driver/periph_ctrl.h" + #include "freertos/semphr.h" + #include "soc/rmt_struct.h" + #include + #include "esp_idf_version.h" +#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL( 4, 0, 0 ) + #include "soc/dport_reg.h" +#endif + } +#elif defined ( ESP_PLATFORM ) + extern "C" { // ...someone forgot to put in the includes... + #include + #include + #include + #include + #include + #include + #include + #include + #include + } + #include +#endif + +#include "Color.h" + +namespace detail { + +struct TimingParams { + uint32_t T0H; + uint32_t T1H; + uint32_t T0L; + uint32_t T1L; + uint32_t TRS; +}; + +union RmtPulsePair { + struct { + int duration0:15; + int level0:1; + int duration1:15; + int level1:1; + }; + uint32_t value; +}; + +static const int DIVIDER = 4; // 8 still seems to work, but timings become marginal +static const int MAX_PULSES = 32; // A channel has a 64 "pulse" buffer - we use half per pass +static const double RMT_DURATION_NS = 12.5; // minimum time of a single RMT duration based on clock ns + +} // namespace detail + +using LedType = detail::TimingParams; + +static const LedType LED_WS2812 = { 350, 700, 800, 600, 50000 }; +static const LedType LED_WS2812B = { 400, 850, 850, 400, 50100 }; +static const LedType LED_SK6812 = { 300, 600, 900, 600, 80000 }; +static const LedType LED_WS2813 = { 350, 800, 350, 350, 300000 }; + +enum BufferType { SingleBuffer = 0, DoubleBuffer }; + +enum IsrCore { CoreFirst = 0, CoreSecond = 1, CoreCurrent = 2}; + +class SmartLed { +public: + // The RMT interrupt must not run on the same core as WiFi interrupts, otherwise SmartLeds + // can't fill the RMT buffer fast enough, resulting in rendering artifacts. + // Usually, that means you have to set isrCore == CoreSecond. + // + // If you use anything other than CoreCurrent, the FreeRTOS scheduler MUST be already running, + // so you can't use it if you define SmartLed as global variable. + SmartLed( const LedType& type, int count, int pin, int channel = 0, BufferType doubleBuffer = SingleBuffer, IsrCore isrCore = CoreCurrent) + : _timing( type ), + _channel( channel ), + _count( count ), + _firstBuffer( new Rgb[ count ] ), + _secondBuffer( doubleBuffer ? new Rgb[ count ] : nullptr ), + _finishedFlag( xSemaphoreCreateBinary() ) + { + assert( channel >= 0 && channel < 8 ); + assert( ledForChannel( channel ) == nullptr ); + + xSemaphoreGive( _finishedFlag ); + + DPORT_SET_PERI_REG_MASK( DPORT_PERIP_CLK_EN_REG, DPORT_RMT_CLK_EN ); + DPORT_CLEAR_PERI_REG_MASK( DPORT_PERIP_RST_EN_REG, DPORT_RMT_RST ); + + PIN_FUNC_SELECT( GPIO_PIN_MUX_REG[ pin ], 2 ); + gpio_set_direction( static_cast< gpio_num_t >( pin ), GPIO_MODE_OUTPUT ); + gpio_matrix_out( static_cast< gpio_num_t >( pin ), RMT_SIG_OUT0_IDX + _channel, 0, 0 ); + initChannel( _channel ); + + RMT.tx_lim_ch[ _channel ].limit = detail::MAX_PULSES; + RMT.int_ena.val |= 1 << ( 24 + _channel ); + RMT.int_ena.val |= 1 << ( 3 * _channel ); + + _bitToRmt[ 0 ].level0 = 1; + _bitToRmt[ 0 ].level1 = 0; + _bitToRmt[ 0 ].duration0 = _timing.T0H / ( detail::RMT_DURATION_NS * detail::DIVIDER ); + _bitToRmt[ 0 ].duration1 = _timing.T0L / ( detail::RMT_DURATION_NS * detail::DIVIDER ); + + _bitToRmt[ 1 ].level0 = 1; + _bitToRmt[ 1 ].level1 = 0; + _bitToRmt[ 1 ].duration0 = _timing.T1H / ( detail::RMT_DURATION_NS * detail::DIVIDER ); + _bitToRmt[ 1 ].duration1 = _timing.T1L / ( detail::RMT_DURATION_NS * detail::DIVIDER ); + + if ( !anyAlive() ) { + _interruptCore = isrCore; + if(isrCore != CoreCurrent) { + ESP_ERROR_CHECK(esp_ipc_call_blocking(isrCore, registerInterrupt, NULL)); + } else { + registerInterrupt(NULL); + } + } + + ledForChannel( channel ) = this; + } + + ~SmartLed() { + ledForChannel( _channel ) = nullptr; + if ( !anyAlive() ) { + if(_interruptCore != CoreCurrent) { + ESP_ERROR_CHECK(esp_ipc_call_blocking(_interruptCore, unregisterInterrupt, NULL)); + } else { + unregisterInterrupt(NULL); + } + } + vSemaphoreDelete( _finishedFlag ); + } + + Rgb& operator[]( int idx ) { + return _firstBuffer[ idx ]; + } + + const Rgb& operator[]( int idx ) const { + return _firstBuffer[ idx ]; + } + + void show() { + _buffer = _firstBuffer.get(); + startTransmission(); + swapBuffers(); + } + + bool wait( TickType_t timeout = portMAX_DELAY ) { + if( xSemaphoreTake( _finishedFlag, timeout ) == pdTRUE ) { + xSemaphoreGive( _finishedFlag ); + return true; + } + return false; + } + + int size() const { + return _count; + } + + Rgb *begin() { return _firstBuffer.get(); } + const Rgb *begin() const { return _firstBuffer.get(); } + const Rgb *cbegin() const { return _firstBuffer.get(); } + + Rgb *end() { return _firstBuffer.get() + _count; } + const Rgb *end() const { return _firstBuffer.get() + _count; } + const Rgb *cend() const { return _firstBuffer.get() + _count; } + +private: + static intr_handle_t _interruptHandle; + static IsrCore _interruptCore; + + static void initChannel( int channel ) { + RMT.apb_conf.fifo_mask = 1; //enable memory access, instead of FIFO mode. + RMT.apb_conf.mem_tx_wrap_en = 1; //wrap around when hitting end of buffer + RMT.conf_ch[ channel ].conf0.div_cnt = detail::DIVIDER; + RMT.conf_ch[ channel ].conf0.mem_size = 1; + RMT.conf_ch[ channel ].conf0.carrier_en = 0; + RMT.conf_ch[ channel ].conf0.carrier_out_lv = 1; + RMT.conf_ch[ channel ].conf0.mem_pd = 0; + + RMT.conf_ch[ channel ].conf1.rx_en = 0; + RMT.conf_ch[ channel ].conf1.mem_owner = 0; + RMT.conf_ch[ channel ].conf1.tx_conti_mode = 0; //loop back mode. + RMT.conf_ch[ channel ].conf1.ref_always_on = 1; // use apb clock: 80M + RMT.conf_ch[ channel ].conf1.idle_out_en = 1; + RMT.conf_ch[ channel ].conf1.idle_out_lv = 0; + } + + static void registerInterrupt(void *) { + ESP_ERROR_CHECK(esp_intr_alloc( ETS_RMT_INTR_SOURCE, 0, interruptHandler, nullptr, &_interruptHandle)); + } + + static void unregisterInterrupt(void*) { + esp_intr_free( _interruptHandle ); + } + + static SmartLed*& IRAM_ATTR ledForChannel( int channel ); + static void IRAM_ATTR interruptHandler( void* ); + + void IRAM_ATTR copyRmtHalfBlock(); + + void swapBuffers() { + if ( _secondBuffer ) + _firstBuffer.swap( _secondBuffer ); + } + + void startTransmission() { + // Invalid use of the library + if( xSemaphoreTake( _finishedFlag, 0 ) != pdTRUE ) + abort(); + + _pixelPosition = _componentPosition = _halfIdx = 0; + copyRmtHalfBlock(); + if ( _pixelPosition < _count ) + copyRmtHalfBlock(); + + RMT.conf_ch[ _channel ].conf1.mem_rd_rst = 1; + RMT.conf_ch[ _channel ].conf1.tx_start = 1; + } + + static bool anyAlive() { + for ( int i = 0; i != 8; i++ ) + if ( ledForChannel( i ) != nullptr ) return true; + return false; + } + + const LedType& _timing; + int _channel; + detail::RmtPulsePair _bitToRmt[ 2 ]; + int _count; + std::unique_ptr< Rgb[] > _firstBuffer; + std::unique_ptr< Rgb[] > _secondBuffer; + Rgb *_buffer; + + xSemaphoreHandle _finishedFlag; + + int _pixelPosition; + int _componentPosition; + int _halfIdx; +}; + +class Apa102 { +public: + struct ApaRgb { + ApaRgb( uint8_t r = 0, uint8_t g = 0, uint32_t b = 0, uint32_t v = 0xFF ) + : v( 0xE0 | v ), b( b ), g( g ), r( r ) + {} + + ApaRgb& operator=( const Rgb& o ) { + r = o.r; + g = o.g; + b = o.b; + return *this; + } + + ApaRgb& operator=( const Hsv& o ) { + *this = Rgb{ o }; + return *this; + } + + uint8_t v, b, g, r; + }; + + static const int FINAL_FRAME_SIZE = 4; + static const int TRANS_COUNT = 2 + 8; + + Apa102( int count, int clkpin, int datapin, BufferType doubleBuffer = SingleBuffer ) + : _count( count ), + _firstBuffer( new ApaRgb[ count ] ), + _secondBuffer( doubleBuffer ? new ApaRgb[ count ] : nullptr ), + _initFrame( 0 ) + { + spi_bus_config_t buscfg; + memset( &buscfg, 0, sizeof( buscfg ) ); + buscfg.mosi_io_num = datapin; + buscfg.miso_io_num = -1; + buscfg.sclk_io_num = clkpin; + buscfg.quadwp_io_num = -1; + buscfg.quadhd_io_num = -1; + buscfg.max_transfer_sz = 65535; + + spi_device_interface_config_t devcfg; + memset( &devcfg, 0, sizeof( devcfg ) ); + devcfg.clock_speed_hz = 1000000; + devcfg.mode = 0; + devcfg.spics_io_num = -1; + devcfg.queue_size = TRANS_COUNT; + devcfg.pre_cb = nullptr; + + auto ret = spi_bus_initialize( HSPI_HOST, &buscfg, 1 ); + assert( ret == ESP_OK ); + + ret = spi_bus_add_device( HSPI_HOST, &devcfg, &_spi ); + assert( ret == ESP_OK ); + + std::fill_n( _finalFrame, FINAL_FRAME_SIZE, 0xFFFFFFFF ); + } + + ~Apa102() { + // ToDo + } + + ApaRgb& operator[]( int idx ) { + return _firstBuffer[ idx ]; + } + + const ApaRgb& operator[]( int idx ) const { + return _firstBuffer[ idx ]; + } + + void show() { + _buffer = _firstBuffer.get(); + startTransmission(); + swapBuffers(); + } + + void wait() { + for ( int i = 0; i != _transCount; i++ ) { + spi_transaction_t *t; + spi_device_get_trans_result( _spi, &t, portMAX_DELAY ); + } + } +private: + void swapBuffers() { + if ( _secondBuffer ) + _firstBuffer.swap( _secondBuffer ); + } + + void startTransmission() { + for ( int i = 0; i != TRANS_COUNT; i++ ) { + _transactions[ i ].cmd = 0; + _transactions[ i ].addr = 0; + _transactions[ i ].flags = 0; + _transactions[ i ].rxlength = 0; + _transactions[ i ].rx_buffer = nullptr; + } + // Init frame + _transactions[ 0 ].length = 32; + _transactions[ 0 ].tx_buffer = &_initFrame; + spi_device_queue_trans( _spi, _transactions + 0, portMAX_DELAY ); + // Data + _transactions[ 1 ].length = 32 * _count; + _transactions[ 1 ].tx_buffer = _buffer; + spi_device_queue_trans( _spi, _transactions + 1, portMAX_DELAY ); + _transCount = 2; + // End frame + for ( int i = 0; i != 1 + _count / 32 / FINAL_FRAME_SIZE; i++ ) { + _transactions[ 2 + i ].length = 32 * FINAL_FRAME_SIZE; + _transactions[ 2 + i ].tx_buffer = _finalFrame; + spi_device_queue_trans( _spi, _transactions + 2 + i, portMAX_DELAY ); + _transCount++; + } + } + + spi_device_handle_t _spi; + int _count; + std::unique_ptr< ApaRgb[] > _firstBuffer, _secondBuffer; + ApaRgb *_buffer; + + spi_transaction_t _transactions[ TRANS_COUNT ]; + int _transCount; + + uint32_t _initFrame; + uint32_t _finalFrame[ FINAL_FRAME_SIZE ]; +}; + +class LDP8806 { +public: + struct LDP8806_GRB { + + LDP8806_GRB( uint8_t g_7bit = 0, uint8_t r_7bit = 0, uint32_t b_7bit = 0 ) + : g( g_7bit ), r( r_7bit ), b( b_7bit ) + { + } + + LDP8806_GRB& operator=( const Rgb& o ) { + //Convert 8->7bit colour + r = ( o.r * 127 / 256 ) | 0x80; + g = ( o.g * 127 / 256 ) | 0x80; + b = ( o.b * 127 / 256 ) | 0x80; + return *this; + } + + LDP8806_GRB& operator=( const Hsv& o ) { + *this = Rgb{ o }; + return *this; + } + + uint8_t g, r, b; + }; + + static const int LED_FRAME_SIZE_BYTES = sizeof( LDP8806_GRB ); + static const int LATCH_FRAME_SIZE_BYTES = 3; + static const int TRANS_COUNT_MAX = 20;//Arbitrary, supports up to 600 LED + + LDP8806( int count, int clkpin, int datapin, BufferType doubleBuffer = SingleBuffer, uint32_t clock_speed_hz = 2000000 ) + : _count( count ), + _firstBuffer( new LDP8806_GRB[ count ] ), + _secondBuffer( doubleBuffer ? new LDP8806_GRB[ count ] : nullptr ), + // one 'latch'/start-of-data mark frame for every 32 leds + _latchFrames( ( count + 31 ) / 32 ) + { + spi_bus_config_t buscfg; + memset( &buscfg, 0, sizeof( buscfg ) ); + buscfg.mosi_io_num = datapin; + buscfg.miso_io_num = -1; + buscfg.sclk_io_num = clkpin; + buscfg.quadwp_io_num = -1; + buscfg.quadhd_io_num = -1; + buscfg.max_transfer_sz = 65535; + + spi_device_interface_config_t devcfg; + memset( &devcfg, 0, sizeof( devcfg ) ); + devcfg.clock_speed_hz = clock_speed_hz; + devcfg.mode = 0; + devcfg.spics_io_num = -1; + devcfg.queue_size = TRANS_COUNT_MAX; + devcfg.pre_cb = nullptr; + + auto ret = spi_bus_initialize( HSPI_HOST, &buscfg, 1 ); + assert( ret == ESP_OK ); + + ret = spi_bus_add_device( HSPI_HOST, &devcfg, &_spi ); + assert( ret == ESP_OK ); + + std::fill_n( _latchBuffer, LATCH_FRAME_SIZE_BYTES, 0x0 ); + } + + ~LDP8806() { + // noop + } + + LDP8806_GRB& operator[]( int idx ) { + return _firstBuffer[ idx ]; + } + + const LDP8806_GRB& operator[]( int idx ) const { + return _firstBuffer[ idx ]; + } + + void show() { + _buffer = _firstBuffer.get(); + startTransmission(); + swapBuffers(); + } + + void wait() { + while ( _transCount-- ) { + spi_transaction_t *t; + spi_device_get_trans_result( _spi, &t, portMAX_DELAY ); + } + } +private: + void swapBuffers() { + if ( _secondBuffer ) + _firstBuffer.swap( _secondBuffer ); + } + + void startTransmission() { + _transCount = 0; + for ( int i = 0; i != TRANS_COUNT_MAX; i++ ) { + _transactions[ i ].cmd = 0; + _transactions[ i ].addr = 0; + _transactions[ i ].flags = 0; + _transactions[ i ].rxlength = 0; + _transactions[ i ].rx_buffer = nullptr; + } + // LED Data + _transactions[ 0 ].length = ( LED_FRAME_SIZE_BYTES * 8 ) * _count; + _transactions[ 0 ].tx_buffer = _buffer; + spi_device_queue_trans( _spi, _transactions + _transCount, portMAX_DELAY ); + _transCount++; + + // 'latch'/start-of-data marker frames + for ( int i = 0; i < _latchFrames; i++ ) { + _transactions[ _transCount ].length = ( LATCH_FRAME_SIZE_BYTES * 8 ); + _transactions[ _transCount ].tx_buffer = _latchBuffer; + spi_device_queue_trans( _spi, _transactions + _transCount, portMAX_DELAY ); + _transCount++; + } + } + + spi_device_handle_t _spi; + int _count; + std::unique_ptr< LDP8806_GRB[] > _firstBuffer, _secondBuffer; + LDP8806_GRB *_buffer; + + spi_transaction_t _transactions[ TRANS_COUNT_MAX ]; + int _transCount; + + int _latchFrames; + uint8_t _latchBuffer[ LATCH_FRAME_SIZE_BYTES ]; +}; diff --git a/code/components/jomjol_controlGPIO/server_GPIO.cpp b/code/components/jomjol_controlGPIO/server_GPIO.cpp index c78207ec..7aa81a65 100644 --- a/code/components/jomjol_controlGPIO/server_GPIO.cpp +++ b/code/components/jomjol_controlGPIO/server_GPIO.cpp @@ -107,7 +107,8 @@ void GpioPin::init() //configure GPIO with the given settings gpio_config(&io_conf); - if (_interruptType != GPIO_INTR_DISABLE) { +// if (_interruptType != GPIO_INTR_DISABLE) { // ohne GPIO_PIN_MODE_EXTERNAL_FLASH_WS281X, wenn das genutzt wird, dann soll auch der Handler hier nicht initialisiert werden, da das dann über SmartLED erfolgt. + if ((_interruptType != GPIO_INTR_DISABLE) && (_interruptType != GPIO_PIN_MODE_EXTERNAL_FLASH_WS281X)) { //hook isr handler for specific gpio pin ESP_LOGD(TAG_SERVERGPIO, "GpioPin::init add isr handler for GPIO %d\r\n", _gpio); gpio_isr_handler_add(_gpio, gpio_isr_handler, (void*)&_gpio); @@ -212,6 +213,8 @@ void GpioHandler::init() // printf("wait before start %ldms\r\n", (long) xDelay); // vTaskDelay( xDelay ); + printf("*************** Start GPIOHandler_Init *****************\n"); + if (gpioMap == NULL) { gpioMap = new std::map(); } else { @@ -295,16 +298,24 @@ bool GpioHandler::readConfig() std::string line = ""; bool disabledLine = false; bool eof = false; + gpio_num_t gpioExtLED = (gpio_num_t) 0; + +// printf("readConfig - Start 1\n"); - while ((!configFile.GetNextParagraph(line, disabledLine, eof) || (line.compare("[GPIO]") != 0)) && !disabledLine && !eof) {} + while ((!configFile.GetNextParagraph(line, disabledLine, eof) || (line.compare("[GPIO]") != 0)) && !eof) {} if (eof) return false; - + +// printf("readConfig - Start 2 line: %s, disabbledLine: %d\n", line.c_str(), (int) disabledLine); + + _isEnabled = !disabledLine; if (!_isEnabled) return false; +// printf("readConfig - Start 3\n"); + // std::string mainTopicMQTT = ""; std::string mainTopicMQTT = GetMQTTMainTopic(); if (mainTopicMQTT.length() > 0) @@ -346,10 +357,40 @@ bool GpioHandler::readConfig() GpioPin* gpioPin = new GpioPin(gpioNr, gpioName, pinMode, intType,dutyResolution, mqttTopic, httpEnabled); (*gpioMap)[gpioNr] = gpioPin; + if (pinMode == GPIO_PIN_MODE_EXTERNAL_FLASH_WS281X) + { + printf("Found WS2812 auf GPIO %d\n", gpioNr); + gpioExtLED = gpioNr; + } + if (intType != GPIO_INTR_DISABLE) { registerISR = true; } } + if (toUpper(zerlegt[0]) == "LEDNUMBERS") + { + LEDNumbers = stoi(zerlegt[6]); + } + if (toUpper(zerlegt[0]) == "LEDCOLOR") + { + uint8_t _r, _g, _b; + _r = stoi(zerlegt[1]); + _g = stoi(zerlegt[2]); + _b = stoi(zerlegt[3]); + + LEDColor = Rgb{_r, _g, _b}; + } + if (toUpper(zerlegt[0]) == "LEDTYPE") + { + if (zerlegt[1] == "WS2812") + LEDType = LED_WS2812; + if (zerlegt[1] == "WS2812B") + LEDType = LED_WS2812B; + if (zerlegt[1] == "SK6812") + LEDType = LED_SK6812; + if (zerlegt[1] == "WS2813") + LEDType = LED_WS2813; + } } if (registerISR) { @@ -357,6 +398,28 @@ bool GpioHandler::readConfig() gpio_install_isr_service(ESP_INTR_FLAG_LOWMED | ESP_INTR_FLAG_IRAM); } + if (gpioExtLED > 0) + { + // LogFile.WriteToFile("Startsequence 06"); +// vTaskDelay( xDelay ); +// xDelay = 5000 / portTICK_PERIOD_MS; +// printf("main: sleep for : %ldms\n", (long) xDelay); + + SmartLed leds( LED_WS2812, 2, GPIO_NUM_12, 0, DoubleBuffer ); + + + leds[ 0 ] = Rgb{ 255, 0, 0 }; + leds[ 1 ] = Rgb{ 255, 255, 255 }; + leds.show(); +/* +// _SmartLED = new SmartLed(LEDType, LEDNumbers, gpioExtLED, 0, DoubleBuffer); + _SmartLED = new SmartLed( LED_WS2812, 2, GPIO_NUM_12, 0, DoubleBuffer ); + (*_SmartLED)[ 0 ] = Rgb{ 255, 0, 0 }; + (*_SmartLED)[ 1 ] = LEDColor; + _SmartLED->show(); +*/ + } + return true; } @@ -498,7 +561,24 @@ void GpioHandler::flashLightEnable(bool value) } else { ESP_LOGE(TAG_SERVERGPIO, "Can't set flash light pin GPIO %d. Error: %s\r\n", (int)it->first, resp_str.c_str()); } - } + } else + { + if (it->second->getMode() == GPIO_PIN_MODE_EXTERNAL_FLASH_WS281X) + { + SmartLed leds( LEDType, LEDNumbers, it->second->getGPIO(), 0, DoubleBuffer ); + if (value) + { + for (int i = 0; i < LEDNumbers; ++i) + leds[i] = LEDColor; + } + else + { + for (int i = 0; i < LEDNumbers; ++i) + leds[i] = Rgb{0, 0, 0}; + } + leds.show(); + } + } } } } diff --git a/code/components/jomjol_controlGPIO/server_GPIO.h b/code/components/jomjol_controlGPIO/server_GPIO.h index 14d88412..7e708222 100644 --- a/code/components/jomjol_controlGPIO/server_GPIO.h +++ b/code/components/jomjol_controlGPIO/server_GPIO.h @@ -7,6 +7,8 @@ #include #include "driver/gpio.h" +#include "SmartLeds.h" + //#include "ClassControllCamera.h" typedef enum { @@ -45,6 +47,7 @@ public: void gpioInterrupt(int value); gpio_int_type_t getInterruptType() { return _interruptType; } gpio_pin_mode_t getMode() { return _mode; } + gpio_num_t getGPIO(){return _gpio;}; private: gpio_num_t _gpio; @@ -80,6 +83,11 @@ private: TaskHandle_t xHandleTaskGpio = NULL; bool _isEnabled = false; + int LEDNumbers = 2; + Rgb LEDColor = Rgb{ 255, 255, 255 }; + LedType LEDType = LED_WS2812; + + bool readConfig(); void clear(); diff --git a/code/components/jomjol_controlcamera/ClassControllCamera.cpp b/code/components/jomjol_controlcamera/ClassControllCamera.cpp index defa7777..aa85a357 100644 --- a/code/components/jomjol_controlcamera/ClassControllCamera.cpp +++ b/code/components/jomjol_controlcamera/ClassControllCamera.cpp @@ -499,6 +499,7 @@ void CCamera::LightOnOff(bool status) { GpioHandler* gpioHandler = gpio_handler_get(); if ((gpioHandler != NULL) && (gpioHandler->isEnabled())) { +// printf("Use gpioHandler flashLigh\n"); gpioHandler->flashLightEnable(status); } else { // Init the GPIO diff --git a/code/components/jomjol_flowcontroll/ClassFlowCNNGeneral.cpp b/code/components/jomjol_flowcontroll/ClassFlowCNNGeneral.cpp index f9909b7c..7fe14743 100644 --- a/code/components/jomjol_flowcontroll/ClassFlowCNNGeneral.cpp +++ b/code/components/jomjol_flowcontroll/ClassFlowCNNGeneral.cpp @@ -600,13 +600,20 @@ std::vector ClassFlowCNNGeneral::GetHTMLInfo() zw->filename_org = GENERAL[_ana]->name + "_" + GENERAL[_ana]->ROI[i]->name + ".jpg"; } - zw->val = GENERAL[_ana]->ROI[i]->result; + if (CNNType == Analogue) + zw->val = GENERAL[_ana]->ROI[i]->resultklasse; + else + zw->val = GENERAL[_ana]->ROI[i]->result; zw->image = GENERAL[_ana]->ROI[i]->image; zw->image_org = GENERAL[_ana]->ROI[i]->image_org; + printf("Push %s\n", zw->filename.c_str()); + result.push_back(zw); } + printf("größe: %d\n", result.size()); + return result; } diff --git a/code/components/jomjol_flowcontroll/ClassFlowControll.cpp b/code/components/jomjol_flowcontroll/ClassFlowControll.cpp index 0d17e7be..e83dc491 100644 --- a/code/components/jomjol_flowcontroll/ClassFlowControll.cpp +++ b/code/components/jomjol_flowcontroll/ClassFlowControll.cpp @@ -83,7 +83,10 @@ std::vector ClassFlowControll::GetAllDigital() */ if (flowdigit) - flowdigit->GetHTMLInfo(); + { + printf("ClassFlowControll::GetAllDigital - flowdigit != NULL\n"); + return flowdigit->GetHTMLInfo(); + } std::vector empty; return empty; @@ -91,17 +94,8 @@ std::vector ClassFlowControll::GetAllDigital() std::vector ClassFlowControll::GetAllAnalog() { -/* - for (int i = 0; i < FlowControll.size(); ++i) - if (FlowControll[i]->name().compare("ClassFlowAnalog") == 0) - return ((ClassFlowAnalog*) (FlowControll[i]))->GetHTMLInfo(); - - std::vector empty; - return empty; -*/ - if (flowanalog) - flowanalog->GetHTMLInfo(); + return flowanalog->GetHTMLInfo(); std::vector empty; return empty; diff --git a/code/components/jomjol_tfliteclass/server_tflite.cpp b/code/components/jomjol_tfliteclass/server_tflite.cpp index dbfa1ce1..5df7da6c 100644 --- a/code/components/jomjol_tfliteclass/server_tflite.cpp +++ b/code/components/jomjol_tfliteclass/server_tflite.cpp @@ -284,8 +284,7 @@ esp_err_t handler_wasserzaehler(httpd_req_t *req) httpd_resp_sendstr_chunk(req, txt.c_str()); std::vector htmlinfo; - htmlinfo = tfliteflow.GetAllDigital(); - printf("Size of htmlinfo: %i\n", htmlinfo.size()); + htmlinfo = tfliteflow.GetAllDigital(); for (int i = 0; i < htmlinfo.size(); ++i) { if (tfliteflow.GetTypeDigital() == Digital) diff --git a/code/components/tfmicro.zip b/code/components/tfmicro.zip deleted file mode 100644 index 8da73d50..00000000 Binary files a/code/components/tfmicro.zip and /dev/null differ diff --git a/code/main/Color.cpp b/code/main/Color.cpp new file mode 100644 index 00000000..b2beb9ac --- /dev/null +++ b/code/main/Color.cpp @@ -0,0 +1,132 @@ +#include "Color.h" +#include +#include +#include + +namespace { + +// Int -> fixed point +int up( int x ) { return x * 255; } + +} // namespace + +int iRgbSqrt( int num ) { + // https://en.wikipedia.org/wiki/Methods_of_computing_square_roots#Binary_numeral_system_.28base_2.29 + assert( "sqrt input should be non-negative" && num >= 0 ); + assert( "sqrt input should no exceed 16 bits" && num <= 0xFFFF ); + int res = 0; + int bit = 1 << 16; + while ( bit > num ) + bit >>= 2; + while ( bit != 0 ) { + if ( num >= res + bit ) { + num -= res + bit; + res = ( res >> 1 ) + bit; + } else + res >>= 1; + bit >>= 2; + } + return res; +} + +Rgb::Rgb( Hsv y ) { + // https://stackoverflow.com/questions/24152553/hsv-to-rgb-and-back-without-floating-point-math-in-python + // greyscale + if( y.s == 0 ) { + r = g = b = y.v; + return; + } + + const int region = y.h / 43; + const int remainder = ( y.h - ( region * 43 ) ) * 6; + + const int p = ( y.v * ( 255 - y.s ) ) >> 8; + const int q = ( y.v * ( 255 - ( ( y.s * remainder ) >> 8 ) ) ) >> 8; + const int t = ( y.v * ( 255 - ( ( y.s * (255 -remainder ) ) >> 8 ) ) ) >> 8; + + switch( region ) { + case 0: r = y.v; g = t; b = p; break; + case 1: r = q; g = y.v; b = p; break; + case 2: r = p; g = y.v; b = t; break; + case 3: r = p; g = q; b = y.v; break; + case 4: r = t; g = p; b = y.v; break; + case 5: r = y.v; g = p; b = q; break; + default: __builtin_trap(); + } + + a = y.a; +} + +Rgb& Rgb::operator=( Hsv hsv ) { + Rgb r{ hsv }; + swap( r ); + return *this; +} + +Rgb Rgb::operator+( Rgb in ) const { + auto copy = *this; + copy += in; + return copy; +} + +Rgb& Rgb::operator+=( Rgb in ) { + unsigned int red = r + in.r; + r = ( red < 255 ) ? red : 255; + unsigned int green = g + in.g; + g = ( green < 255 ) ? green : 255; + unsigned int blue = b + in.b; + b = ( blue < 255 ) ? blue : 255; + return *this; +} + +Rgb& Rgb::blend( Rgb in ) { + unsigned int inAlpha = in.a * ( 255 - a ); + unsigned int alpha = a + inAlpha; + r = iRgbSqrt( ( ( r * r * a ) + ( in.r * in.r * inAlpha ) ) / alpha ); + g = iRgbSqrt( ( ( g * g * a ) + ( in.g * in.g * inAlpha ) ) / alpha ); + b = iRgbSqrt( ( ( b * b * a ) + ( in.b * in.b * inAlpha ) ) / alpha ); + a = alpha; + return *this; +} + +uint8_t IRAM_ATTR Rgb::getGrb( int idx ) { + switch ( idx ) { + case 0: return g; + case 1: return r; + case 2: return b; + } + __builtin_unreachable(); +} + +Hsv::Hsv( Rgb r ) { + int min = std::min( r.r, std::min( r.g, r.b ) ); + int max = std::max( r.r, std::max( r.g, r.b ) ); + int chroma = max - min; + + v = max; + if ( chroma == 0 ) { + h = s = 0; + return; + } + + s = up( chroma ) / max; + int hh; + if ( max == r.r ) + hh = ( up( int( r.g ) - int( r.b ) ) ) / chroma / 6; + else if ( max == r.g ) + hh = 255 / 3 + ( up( int( r.b ) - int( r.r ) ) ) / chroma / 6; + else + hh = 2 * 255 / 3 + ( up( int( r.r ) - int( r.g ) ) ) / chroma / 6; + + if ( hh < 0 ) + hh += 255; + h = hh; + + a = r.a; +} + +Hsv& Hsv::operator=( Rgb rgb ) { + Hsv h{ rgb }; + swap( h ); + return *this; +} diff --git a/code/main/Color.h b/code/main/Color.h new file mode 100644 index 00000000..1923cf0b --- /dev/null +++ b/code/main/Color.h @@ -0,0 +1,69 @@ +#pragma once + +#include +#include "esp_attr.h" +union Hsv; + +union Rgb { + struct __attribute__ ((packed)) { + uint8_t r, g, b, a; + }; + uint32_t value; + + Rgb( uint8_t r = 0, uint8_t g = 0, uint8_t b = 0, uint8_t a = 255 ) : r( r ), g( g ), b( b ), a( a ) {} + Rgb( Hsv c ); + Rgb& operator=( Rgb rgb ) { swap( rgb ); return *this; } + Rgb& operator=( Hsv hsv ); + Rgb operator+( Rgb in ) const; + Rgb& operator+=( Rgb in ); + bool operator==( Rgb in ) const { return in.value == value; } + Rgb& blend( Rgb in ); + void swap( Rgb& o ) { value = o.value; } + void linearize() { + r = channelGamma(r); + g = channelGamma(g); + b = channelGamma(b); + } + + uint8_t IRAM_ATTR getGrb( int idx ); + + void stretchChannels( uint8_t maxR, uint8_t maxG, uint8_t maxB ) { + r = stretch( r, maxR ); + g = stretch( g, maxG ); + b = stretch( b, maxB ); + } + + void stretchChannelsEvenly( uint8_t max ) { + stretchChannels( max, max, max ); + } + +private: + uint8_t stretch( int value, uint8_t max ) { + return ( value * max ) >> 8; + } + + uint8_t channelGamma( int channel ) { + /* The optimal gamma correction is x^2.8. However, this is expensive to + * compute. Therefore, we use x^3 for gamma correction. Also, we add a + * bias as the WS2812 LEDs do not turn on for values less than 4. */ + if (channel == 0) + return channel; + channel = channel * channel * channel * 251; + channel >>= 24; + return static_cast< uint8_t >( 4 + channel ); + } +}; + +union Hsv { + struct __attribute__ ((packed)) { + uint8_t h, s, v, a; + }; + uint32_t value; + + Hsv( uint8_t h, uint8_t s = 0, uint8_t v = 0, uint8_t a = 255 ) : h( h ), s( s ), v( v ), a( a ) {} + Hsv( Rgb r ); + Hsv& operator=( Hsv h ) { swap( h ); return *this; } + Hsv& operator=( Rgb rgb ); + bool operator==( Hsv in ) const { return in.value == value; } + void swap( Hsv& o ) { value = o.value; } +}; diff --git a/code/main/SmartLeds.cpp b/code/main/SmartLeds.cpp new file mode 100644 index 00000000..a2ba7b29 --- /dev/null +++ b/code/main/SmartLeds.cpp @@ -0,0 +1,63 @@ +#include "SmartLeds.h" + +IsrCore SmartLed::_interruptCore = CoreCurrent; +intr_handle_t SmartLed::_interruptHandle = NULL; + +SmartLed*& IRAM_ATTR SmartLed::ledForChannel( int channel ) { + static SmartLed* table[8] = { nullptr }; + assert( channel < 8 ); + return table[ channel ]; +} + +void IRAM_ATTR SmartLed::interruptHandler(void*) { + for (int channel = 0; channel != 8; channel++) { + auto self = ledForChannel( channel ); + + if ( RMT.int_st.val & (1 << (24 + channel ) ) ) { // tx_thr_event + if ( self ) + self->copyRmtHalfBlock(); + RMT.int_clr.val |= 1 << ( 24 + channel ); + } else if ( RMT.int_st.val & ( 1 << (3 * channel ) ) ) { // tx_end + if ( self ) + xSemaphoreGiveFromISR( self->_finishedFlag, nullptr ); + RMT.int_clr.val |= 1 << ( 3 * channel ); + } + } +} + +void IRAM_ATTR SmartLed::copyRmtHalfBlock() { + int offset = detail::MAX_PULSES * _halfIdx; + _halfIdx = !_halfIdx; + int len = 3 - _componentPosition + 3 * ( _count - 1 ); + len = std::min( len, detail::MAX_PULSES / 8 ); + + if ( !len ) { + for ( int i = 0; i < detail::MAX_PULSES; i++) { + RMTMEM.chan[ _channel].data32[i + offset ].val = 0; + } + } + + int i; + for ( i = 0; i != len && _pixelPosition != _count; i++ ) { + uint8_t val = _buffer[ _pixelPosition ].getGrb( _componentPosition ); + for ( int j = 0; j != 8; j++, val <<= 1 ) { + int bit = val >> 7; + int idx = i * 8 + offset + j; + RMTMEM.chan[ _channel ].data32[ idx ].val = _bitToRmt[ bit & 0x01 ].value; + } + if ( _pixelPosition == _count - 1 && _componentPosition == 2 ) { + RMTMEM.chan[ _channel ].data32[ i * 8 + offset + 7 ].duration1 = + _timing.TRS / ( detail::RMT_DURATION_NS * detail::DIVIDER ); + } + + _componentPosition++; + if ( _componentPosition == 3 ) { + _componentPosition = 0; + _pixelPosition++; + } + } + + for ( i *= 8; i != detail::MAX_PULSES; i++ ) { + RMTMEM.chan[ _channel ].data32[ i + offset ].val = 0; + } +} diff --git a/code/main/SmartLeds.h b/code/main/SmartLeds.h new file mode 100644 index 00000000..824eb337 --- /dev/null +++ b/code/main/SmartLeds.h @@ -0,0 +1,530 @@ +#pragma once + +/* + * A C++ driver for the WS2812 LEDs using the RMT peripheral on the ESP32. + * + * Jan "yaqwsx" Mrázek + * + * Based on the work by Martin F. Falatic - https://github.com/FozzTexx/ws2812-demo + */ + +/* + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + */ + +#include +#include +#include + +#if defined ( ARDUINO ) + extern "C" { // ...someone forgot to put in the includes... + #include "esp32-hal.h" + #include "esp_intr_alloc.h" + #include "esp_ipc.h" + #include "driver/gpio.h" + #include "driver/periph_ctrl.h" + #include "freertos/semphr.h" + #include "soc/rmt_struct.h" + #include + #include "esp_idf_version.h" +#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL( 4, 0, 0 ) + #include "soc/dport_reg.h" +#endif + } +#elif defined ( ESP_PLATFORM ) + extern "C" { // ...someone forgot to put in the includes... + #include + #include + #include + #include + #include + #include + #include + #include + #include + } + #include +#endif + +#include "Color.h" + +namespace detail { + +struct TimingParams { + uint32_t T0H; + uint32_t T1H; + uint32_t T0L; + uint32_t T1L; + uint32_t TRS; +}; + +union RmtPulsePair { + struct { + int duration0:15; + int level0:1; + int duration1:15; + int level1:1; + }; + uint32_t value; +}; + +static const int DIVIDER = 4; // 8 still seems to work, but timings become marginal +static const int MAX_PULSES = 32; // A channel has a 64 "pulse" buffer - we use half per pass +static const double RMT_DURATION_NS = 12.5; // minimum time of a single RMT duration based on clock ns + +} // namespace detail + +using LedType = detail::TimingParams; + +static const LedType LED_WS2812 = { 350, 700, 800, 600, 50000 }; +static const LedType LED_WS2812B = { 400, 850, 850, 400, 50100 }; +static const LedType LED_SK6812 = { 300, 600, 900, 600, 80000 }; +static const LedType LED_WS2813 = { 350, 800, 350, 350, 300000 }; + +enum BufferType { SingleBuffer = 0, DoubleBuffer }; + +enum IsrCore { CoreFirst = 0, CoreSecond = 1, CoreCurrent = 2}; + +class SmartLed { +public: + // The RMT interrupt must not run on the same core as WiFi interrupts, otherwise SmartLeds + // can't fill the RMT buffer fast enough, resulting in rendering artifacts. + // Usually, that means you have to set isrCore == CoreSecond. + // + // If you use anything other than CoreCurrent, the FreeRTOS scheduler MUST be already running, + // so you can't use it if you define SmartLed as global variable. + SmartLed( const LedType& type, int count, int pin, int channel = 0, BufferType doubleBuffer = SingleBuffer, IsrCore isrCore = CoreCurrent) + : _timing( type ), + _channel( channel ), + _count( count ), + _firstBuffer( new Rgb[ count ] ), + _secondBuffer( doubleBuffer ? new Rgb[ count ] : nullptr ), + _finishedFlag( xSemaphoreCreateBinary() ) + { + assert( channel >= 0 && channel < 8 ); + assert( ledForChannel( channel ) == nullptr ); + + xSemaphoreGive( _finishedFlag ); + + DPORT_SET_PERI_REG_MASK( DPORT_PERIP_CLK_EN_REG, DPORT_RMT_CLK_EN ); + DPORT_CLEAR_PERI_REG_MASK( DPORT_PERIP_RST_EN_REG, DPORT_RMT_RST ); + + PIN_FUNC_SELECT( GPIO_PIN_MUX_REG[ pin ], 2 ); + gpio_set_direction( static_cast< gpio_num_t >( pin ), GPIO_MODE_OUTPUT ); + gpio_matrix_out( static_cast< gpio_num_t >( pin ), RMT_SIG_OUT0_IDX + _channel, 0, 0 ); + initChannel( _channel ); + + RMT.tx_lim_ch[ _channel ].limit = detail::MAX_PULSES; + RMT.int_ena.val |= 1 << ( 24 + _channel ); + RMT.int_ena.val |= 1 << ( 3 * _channel ); + + _bitToRmt[ 0 ].level0 = 1; + _bitToRmt[ 0 ].level1 = 0; + _bitToRmt[ 0 ].duration0 = _timing.T0H / ( detail::RMT_DURATION_NS * detail::DIVIDER ); + _bitToRmt[ 0 ].duration1 = _timing.T0L / ( detail::RMT_DURATION_NS * detail::DIVIDER ); + + _bitToRmt[ 1 ].level0 = 1; + _bitToRmt[ 1 ].level1 = 0; + _bitToRmt[ 1 ].duration0 = _timing.T1H / ( detail::RMT_DURATION_NS * detail::DIVIDER ); + _bitToRmt[ 1 ].duration1 = _timing.T1L / ( detail::RMT_DURATION_NS * detail::DIVIDER ); + + if ( !anyAlive() ) { + _interruptCore = isrCore; + if(isrCore != CoreCurrent) { + ESP_ERROR_CHECK(esp_ipc_call_blocking(isrCore, registerInterrupt, NULL)); + } else { + registerInterrupt(NULL); + } + } + + ledForChannel( channel ) = this; + } + + ~SmartLed() { + ledForChannel( _channel ) = nullptr; + if ( !anyAlive() ) { + if(_interruptCore != CoreCurrent) { + ESP_ERROR_CHECK(esp_ipc_call_blocking(_interruptCore, unregisterInterrupt, NULL)); + } else { + unregisterInterrupt(NULL); + } + } + vSemaphoreDelete( _finishedFlag ); + } + + Rgb& operator[]( int idx ) { + return _firstBuffer[ idx ]; + } + + const Rgb& operator[]( int idx ) const { + return _firstBuffer[ idx ]; + } + + void show() { + _buffer = _firstBuffer.get(); + startTransmission(); + swapBuffers(); + } + + bool wait( TickType_t timeout = portMAX_DELAY ) { + if( xSemaphoreTake( _finishedFlag, timeout ) == pdTRUE ) { + xSemaphoreGive( _finishedFlag ); + return true; + } + return false; + } + + int size() const { + return _count; + } + + Rgb *begin() { return _firstBuffer.get(); } + const Rgb *begin() const { return _firstBuffer.get(); } + const Rgb *cbegin() const { return _firstBuffer.get(); } + + Rgb *end() { return _firstBuffer.get() + _count; } + const Rgb *end() const { return _firstBuffer.get() + _count; } + const Rgb *cend() const { return _firstBuffer.get() + _count; } + +private: + static intr_handle_t _interruptHandle; + static IsrCore _interruptCore; + + static void initChannel( int channel ) { + RMT.apb_conf.fifo_mask = 1; //enable memory access, instead of FIFO mode. + RMT.apb_conf.mem_tx_wrap_en = 1; //wrap around when hitting end of buffer + RMT.conf_ch[ channel ].conf0.div_cnt = detail::DIVIDER; + RMT.conf_ch[ channel ].conf0.mem_size = 1; + RMT.conf_ch[ channel ].conf0.carrier_en = 0; + RMT.conf_ch[ channel ].conf0.carrier_out_lv = 1; + RMT.conf_ch[ channel ].conf0.mem_pd = 0; + + RMT.conf_ch[ channel ].conf1.rx_en = 0; + RMT.conf_ch[ channel ].conf1.mem_owner = 0; + RMT.conf_ch[ channel ].conf1.tx_conti_mode = 0; //loop back mode. + RMT.conf_ch[ channel ].conf1.ref_always_on = 1; // use apb clock: 80M + RMT.conf_ch[ channel ].conf1.idle_out_en = 1; + RMT.conf_ch[ channel ].conf1.idle_out_lv = 0; + } + + static void registerInterrupt(void *) { + ESP_ERROR_CHECK(esp_intr_alloc( ETS_RMT_INTR_SOURCE, 0, interruptHandler, nullptr, &_interruptHandle)); + } + + static void unregisterInterrupt(void*) { + esp_intr_free( _interruptHandle ); + } + + static SmartLed*& IRAM_ATTR ledForChannel( int channel ); + static void IRAM_ATTR interruptHandler( void* ); + + void IRAM_ATTR copyRmtHalfBlock(); + + void swapBuffers() { + if ( _secondBuffer ) + _firstBuffer.swap( _secondBuffer ); + } + + void startTransmission() { + // Invalid use of the library + if( xSemaphoreTake( _finishedFlag, 0 ) != pdTRUE ) + abort(); + + _pixelPosition = _componentPosition = _halfIdx = 0; + copyRmtHalfBlock(); + if ( _pixelPosition < _count ) + copyRmtHalfBlock(); + + RMT.conf_ch[ _channel ].conf1.mem_rd_rst = 1; + RMT.conf_ch[ _channel ].conf1.tx_start = 1; + } + + static bool anyAlive() { + for ( int i = 0; i != 8; i++ ) + if ( ledForChannel( i ) != nullptr ) return true; + return false; + } + + const LedType& _timing; + int _channel; + detail::RmtPulsePair _bitToRmt[ 2 ]; + int _count; + std::unique_ptr< Rgb[] > _firstBuffer; + std::unique_ptr< Rgb[] > _secondBuffer; + Rgb *_buffer; + + xSemaphoreHandle _finishedFlag; + + int _pixelPosition; + int _componentPosition; + int _halfIdx; +}; + +class Apa102 { +public: + struct ApaRgb { + ApaRgb( uint8_t r = 0, uint8_t g = 0, uint32_t b = 0, uint32_t v = 0xFF ) + : v( 0xE0 | v ), b( b ), g( g ), r( r ) + {} + + ApaRgb& operator=( const Rgb& o ) { + r = o.r; + g = o.g; + b = o.b; + return *this; + } + + ApaRgb& operator=( const Hsv& o ) { + *this = Rgb{ o }; + return *this; + } + + uint8_t v, b, g, r; + }; + + static const int FINAL_FRAME_SIZE = 4; + static const int TRANS_COUNT = 2 + 8; + + Apa102( int count, int clkpin, int datapin, BufferType doubleBuffer = SingleBuffer ) + : _count( count ), + _firstBuffer( new ApaRgb[ count ] ), + _secondBuffer( doubleBuffer ? new ApaRgb[ count ] : nullptr ), + _initFrame( 0 ) + { + spi_bus_config_t buscfg; + memset( &buscfg, 0, sizeof( buscfg ) ); + buscfg.mosi_io_num = datapin; + buscfg.miso_io_num = -1; + buscfg.sclk_io_num = clkpin; + buscfg.quadwp_io_num = -1; + buscfg.quadhd_io_num = -1; + buscfg.max_transfer_sz = 65535; + + spi_device_interface_config_t devcfg; + memset( &devcfg, 0, sizeof( devcfg ) ); + devcfg.clock_speed_hz = 1000000; + devcfg.mode = 0; + devcfg.spics_io_num = -1; + devcfg.queue_size = TRANS_COUNT; + devcfg.pre_cb = nullptr; + + auto ret = spi_bus_initialize( HSPI_HOST, &buscfg, 1 ); + assert( ret == ESP_OK ); + + ret = spi_bus_add_device( HSPI_HOST, &devcfg, &_spi ); + assert( ret == ESP_OK ); + + std::fill_n( _finalFrame, FINAL_FRAME_SIZE, 0xFFFFFFFF ); + } + + ~Apa102() { + // ToDo + } + + ApaRgb& operator[]( int idx ) { + return _firstBuffer[ idx ]; + } + + const ApaRgb& operator[]( int idx ) const { + return _firstBuffer[ idx ]; + } + + void show() { + _buffer = _firstBuffer.get(); + startTransmission(); + swapBuffers(); + } + + void wait() { + for ( int i = 0; i != _transCount; i++ ) { + spi_transaction_t *t; + spi_device_get_trans_result( _spi, &t, portMAX_DELAY ); + } + } +private: + void swapBuffers() { + if ( _secondBuffer ) + _firstBuffer.swap( _secondBuffer ); + } + + void startTransmission() { + for ( int i = 0; i != TRANS_COUNT; i++ ) { + _transactions[ i ].cmd = 0; + _transactions[ i ].addr = 0; + _transactions[ i ].flags = 0; + _transactions[ i ].rxlength = 0; + _transactions[ i ].rx_buffer = nullptr; + } + // Init frame + _transactions[ 0 ].length = 32; + _transactions[ 0 ].tx_buffer = &_initFrame; + spi_device_queue_trans( _spi, _transactions + 0, portMAX_DELAY ); + // Data + _transactions[ 1 ].length = 32 * _count; + _transactions[ 1 ].tx_buffer = _buffer; + spi_device_queue_trans( _spi, _transactions + 1, portMAX_DELAY ); + _transCount = 2; + // End frame + for ( int i = 0; i != 1 + _count / 32 / FINAL_FRAME_SIZE; i++ ) { + _transactions[ 2 + i ].length = 32 * FINAL_FRAME_SIZE; + _transactions[ 2 + i ].tx_buffer = _finalFrame; + spi_device_queue_trans( _spi, _transactions + 2 + i, portMAX_DELAY ); + _transCount++; + } + } + + spi_device_handle_t _spi; + int _count; + std::unique_ptr< ApaRgb[] > _firstBuffer, _secondBuffer; + ApaRgb *_buffer; + + spi_transaction_t _transactions[ TRANS_COUNT ]; + int _transCount; + + uint32_t _initFrame; + uint32_t _finalFrame[ FINAL_FRAME_SIZE ]; +}; + +class LDP8806 { +public: + struct LDP8806_GRB { + + LDP8806_GRB( uint8_t g_7bit = 0, uint8_t r_7bit = 0, uint32_t b_7bit = 0 ) + : g( g_7bit ), r( r_7bit ), b( b_7bit ) + { + } + + LDP8806_GRB& operator=( const Rgb& o ) { + //Convert 8->7bit colour + r = ( o.r * 127 / 256 ) | 0x80; + g = ( o.g * 127 / 256 ) | 0x80; + b = ( o.b * 127 / 256 ) | 0x80; + return *this; + } + + LDP8806_GRB& operator=( const Hsv& o ) { + *this = Rgb{ o }; + return *this; + } + + uint8_t g, r, b; + }; + + static const int LED_FRAME_SIZE_BYTES = sizeof( LDP8806_GRB ); + static const int LATCH_FRAME_SIZE_BYTES = 3; + static const int TRANS_COUNT_MAX = 20;//Arbitrary, supports up to 600 LED + + LDP8806( int count, int clkpin, int datapin, BufferType doubleBuffer = SingleBuffer, uint32_t clock_speed_hz = 2000000 ) + : _count( count ), + _firstBuffer( new LDP8806_GRB[ count ] ), + _secondBuffer( doubleBuffer ? new LDP8806_GRB[ count ] : nullptr ), + // one 'latch'/start-of-data mark frame for every 32 leds + _latchFrames( ( count + 31 ) / 32 ) + { + spi_bus_config_t buscfg; + memset( &buscfg, 0, sizeof( buscfg ) ); + buscfg.mosi_io_num = datapin; + buscfg.miso_io_num = -1; + buscfg.sclk_io_num = clkpin; + buscfg.quadwp_io_num = -1; + buscfg.quadhd_io_num = -1; + buscfg.max_transfer_sz = 65535; + + spi_device_interface_config_t devcfg; + memset( &devcfg, 0, sizeof( devcfg ) ); + devcfg.clock_speed_hz = clock_speed_hz; + devcfg.mode = 0; + devcfg.spics_io_num = -1; + devcfg.queue_size = TRANS_COUNT_MAX; + devcfg.pre_cb = nullptr; + + auto ret = spi_bus_initialize( HSPI_HOST, &buscfg, 1 ); + assert( ret == ESP_OK ); + + ret = spi_bus_add_device( HSPI_HOST, &devcfg, &_spi ); + assert( ret == ESP_OK ); + + std::fill_n( _latchBuffer, LATCH_FRAME_SIZE_BYTES, 0x0 ); + } + + ~LDP8806() { + // noop + } + + LDP8806_GRB& operator[]( int idx ) { + return _firstBuffer[ idx ]; + } + + const LDP8806_GRB& operator[]( int idx ) const { + return _firstBuffer[ idx ]; + } + + void show() { + _buffer = _firstBuffer.get(); + startTransmission(); + swapBuffers(); + } + + void wait() { + while ( _transCount-- ) { + spi_transaction_t *t; + spi_device_get_trans_result( _spi, &t, portMAX_DELAY ); + } + } +private: + void swapBuffers() { + if ( _secondBuffer ) + _firstBuffer.swap( _secondBuffer ); + } + + void startTransmission() { + _transCount = 0; + for ( int i = 0; i != TRANS_COUNT_MAX; i++ ) { + _transactions[ i ].cmd = 0; + _transactions[ i ].addr = 0; + _transactions[ i ].flags = 0; + _transactions[ i ].rxlength = 0; + _transactions[ i ].rx_buffer = nullptr; + } + // LED Data + _transactions[ 0 ].length = ( LED_FRAME_SIZE_BYTES * 8 ) * _count; + _transactions[ 0 ].tx_buffer = _buffer; + spi_device_queue_trans( _spi, _transactions + _transCount, portMAX_DELAY ); + _transCount++; + + // 'latch'/start-of-data marker frames + for ( int i = 0; i < _latchFrames; i++ ) { + _transactions[ _transCount ].length = ( LATCH_FRAME_SIZE_BYTES * 8 ); + _transactions[ _transCount ].tx_buffer = _latchBuffer; + spi_device_queue_trans( _spi, _transactions + _transCount, portMAX_DELAY ); + _transCount++; + } + } + + spi_device_handle_t _spi; + int _count; + std::unique_ptr< LDP8806_GRB[] > _firstBuffer, _secondBuffer; + LDP8806_GRB *_buffer; + + spi_transaction_t _transactions[ TRANS_COUNT_MAX ]; + int _transCount; + + int _latchFrames; + uint8_t _latchBuffer[ LATCH_FRAME_SIZE_BYTES ]; +}; diff --git a/code/main/main.cpp b/code/main/main.cpp index 145f862f..6353087c 100644 --- a/code/main/main.cpp +++ b/code/main/main.cpp @@ -28,6 +28,9 @@ #include "server_main.h" #include "server_camera.h" +// #include "jomjol_WS2812Slow.h" +#include "SmartLeds.h" + #define __SD_USE_ONE_LINE_MODE__ @@ -135,8 +138,12 @@ void task_NoSDBlink(void *pvParameter) vTaskDelete(NULL); //Delete this task if it exits from the loop above } + extern "C" void app_main(void) { + TickType_t xDelay; + + printf("Do Reset Camera\n"); PowerResetCamera(); Camera.InitCam(); @@ -171,7 +178,7 @@ extern "C" void app_main(void) wifi_init_sta(ssid, passwd, hostname, ip, gateway, netmask, dns); - TickType_t xDelay; + xDelay = 2000 / portTICK_PERIOD_MS; printf("main: sleep for : %ldms\n", (long) xDelay); // LogFile.WriteToFile("Startsequence 06"); @@ -184,6 +191,9 @@ extern "C" void app_main(void) LogFile.WriteToFile("============================================================================================="); LogFile.SwitchOnOff(false); + + + std::string zw = gettimestring("%Y%m%d-%H%M%S"); printf("time %s\n", zw.c_str()); @@ -206,5 +216,26 @@ extern "C" void app_main(void) printf("vor dotautostart\n"); TFliteDoAutoStart(); + +////////////////////////// Test SmartLED Liberary ////////////////////////////////////////////// +/* + xDelay = 5000 / portTICK_PERIOD_MS; + printf("main: sleep for : %ldms\n", (long) xDelay); +// LogFile.WriteToFile("Startsequence 06"); + vTaskDelay( xDelay ); + + SmartLed leds( LED_WS2812, 2, GPIO_NUM_12, 0, DoubleBuffer ); + + + leds[ 0 ] = Rgb{ 255, 0, 0 }; + leds[ 1 ] = Rgb{ 255, 255, 255 }; + leds.show(); + + vTaskDelay( xDelay ); + + leds[ 0 ] = Rgb{ 0, 0, 0 }; + leds[ 1 ] = Rgb{ 0, 0, 0 }; + leds.show(); +*/ } diff --git a/code/main/version.cpp b/code/main/version.cpp index 893450de..063d8c9d 100644 --- a/code/main/version.cpp +++ b/code/main/version.cpp @@ -1,4 +1,4 @@ -const char* GIT_REV="7fcb5d1"; -const char* GIT_TAG=""; -const char* GIT_BRANCH="master"; -const char* BUILD_TIME="2021-09-12 07:30"; \ No newline at end of file +const char* GIT_REV="19ca0d7"; +const char* GIT_TAG="v8.3.0"; +const char* GIT_BRANCH="rolling"; +const char* BUILD_TIME="2021-09-13 20:03"; \ No newline at end of file diff --git a/code/version.cpp b/code/version.cpp index 893450de..063d8c9d 100644 --- a/code/version.cpp +++ b/code/version.cpp @@ -1,4 +1,4 @@ -const char* GIT_REV="7fcb5d1"; -const char* GIT_TAG=""; -const char* GIT_BRANCH="master"; -const char* BUILD_TIME="2021-09-12 07:30"; \ No newline at end of file +const char* GIT_REV="19ca0d7"; +const char* GIT_TAG="v8.3.0"; +const char* GIT_BRANCH="rolling"; +const char* BUILD_TIME="2021-09-13 20:03"; \ No newline at end of file diff --git a/firmware/bootloader.bin b/firmware/bootloader.bin index 0ed1520d..d5c8cc57 100644 Binary files a/firmware/bootloader.bin and b/firmware/bootloader.bin differ diff --git a/firmware/firmware.bin b/firmware/firmware.bin index 976c7cc8..6bf8a353 100644 Binary files a/firmware/firmware.bin and b/firmware/firmware.bin differ diff --git a/firmware/html.zip b/firmware/html.zip index ae06f6dc..3ffbcee0 100644 Binary files a/firmware/html.zip and b/firmware/html.zip differ diff --git a/sd-card/config/dig1300s1q.tflite b/sd-card/config/dig1300s1q.tflite new file mode 100644 index 00000000..305335b7 Binary files /dev/null and b/sd-card/config/dig1300s1q.tflite differ diff --git a/sd-card/html/edit_config_param.html b/sd-card/html/edit_config_param.html index 169f1a97..59c2db79 100644 --- a/sd-card/html/edit_config_param.html +++ b/sd-card/html/edit_config_param.html @@ -1028,7 +1028,7 @@ textarea { - + diff --git a/sd-card/html/readconfigparam.js b/sd-card/html/readconfigparam.js index 47717a20..86eaa08e 100644 --- a/sd-card/html/readconfigparam.js +++ b/sd-card/html/readconfigparam.js @@ -31,6 +31,7 @@ function ParseConfig() { ParamAddValue(param, catname, "ImageQuality"); ParamAddValue(param, catname, "ImageSize"); ParamAddValue(param, catname, "FixedExposure"); + ParamAddValue(param, catname, "UseGPIOControlledIllumination"); var catname = "Alignment"; category[catname] = new Object(); @@ -102,6 +103,10 @@ function ParseConfig() { ParamAddValue(param, catname, "IO4", 6, false, [null, null, /^[0-9]*$/, null, null, /^[a-zA-Z0-9_-]*$/]); ParamAddValue(param, catname, "IO12", 6, false, [null, null, /^[0-9]*$/, null, null, /^[a-zA-Z0-9_-]*$/]); ParamAddValue(param, catname, "IO13", 6, false, [null, null, /^[0-9]*$/, null, null, /^[a-zA-Z0-9_-]*$/]); + ParamAddValue(param, catname, "LEDType"); + ParamAddValue(param, catname, "LEDNumbers"); + ParamAddValue(param, catname, "LEDColor", 3); + var catname = "AutoTimer"; category[catname] = new Object();