diff --git a/CODE_OWNERS.md b/CODE_OWNERS.md index 07513d6ad..32721d1de 100644 --- a/CODE_OWNERS.md +++ b/CODE_OWNERS.md @@ -102,7 +102,7 @@ In addition to @arendst the following code is mainly owned by: | xdrv_89_ | | xdrv_90_esp32_dingtian_relay | @barbudor | xdrv_91_esp32_twai | @arendst -| xdrv_92_ | +| xdrv_92_vid6608 | @petrows | xdrv_93_ | | xdrv_94_ | | | diff --git a/lib/lib_div/arduino-vid6608/Dockerfile b/lib/lib_div/arduino-vid6608/Dockerfile new file mode 100644 index 000000000..2246dbcb3 --- /dev/null +++ b/lib/lib_div/arduino-vid6608/Dockerfile @@ -0,0 +1,43 @@ +# Dockerfile to build platformio +FROM petrows/arduino-vid6608:latest + +RUN < + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + {one line to give the program's name and a brief idea of what it does.} + Copyright (C) {year} {name of author} + + 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: + + {project} Copyright (C) {year} {fullname} + 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 +. \ No newline at end of file diff --git a/lib/lib_div/arduino-vid6608/README.md b/lib/lib_div/arduino-vid6608/README.md new file mode 100755 index 000000000..dd2c153f3 --- /dev/null +++ b/lib/lib_div/arduino-vid6608/README.md @@ -0,0 +1,93 @@ +# Gauge stepper motor Switec X25.168 driver for VID6608 and clones + +![Moving example](doc/output.gif) + +This library implements driver for Arduino framework +for following driver chips for analog automotive gauges (Switec X25.168, X27.168 and clones) with microstepping support: + +* VID6606 (2 motors) +* VID6608 (4 motors) +* VT6608S +* AX1201728SG +* BY8920 +* many others + +Driver chips with microstepping is the recommended way to drive such motors, +they provide much more relailabe and smooth movement with reduced noise and +to avoid skipping steps. + +This library is developed by inspiration from [SwitecX25](https://github.com/clearwater/SwitecX25) library, many thanks to author. + +This library has following features: + +* More precise Datasheet complaince +* Another smoothing method (requires less calculations) +* Optimized homing +* Extended API's + +[![PlatformIO Registry](https://badges.registry.platformio.org/packages/petrows/library/vid6608.svg)](https://registry.platformio.org/libraries/petrows/vid6608) + +## Chip documentation + +See [VID6606 Datasheet (English)](doc/VID6608.pdf). + +## Wiring + +This library requires that two pins (per drive) are connected to two outputs. + +![Datasheet scheme](doc/operation-configuration.png) + +* Step pin f(scx): impulse to drive motor to one microstep; +* Direction pin CW/CCW: defines direction ov movement; +* RESET pin: does not controlled by this library. Hold to VDD to enable function (see notes below); + +## RESET pin + +This library does not control RESET pin, please perform this inside your firmware. + +I have problems with some IC's, as they lost function after RESET pin manipulation. [Datasheet](doc/VID6608.pdf) recommends to hold it LOW during boot, and set to HIGH to enable operation, but i recommend just to connect to VDD to be safe. + +## Setting zero + +Motor is set to zero by moving whole scale and kept bouncing on the one of +dead positions. This library provides optimized way to perform homing: it does +1/2 of scale forward, then full scale backward. This helps to reduce bouncing +like in the classical "full scale back" method. + +## Function documentation + +See inline documentation in source code: [vid6608.h](src/vid6608.h). + +## Basic example + +Simple code to activate the library. + +```cpp +#include +#include + +// standard X25.168 range 315 degrees at 1/3 degree steps +#define STEPS (320 * 12) + +#define PIN_STEP 26 // Pin, connected to f(scx) +#define PIN_DIR 27 // Pin. connected to CW/CCW + +vid6608 motor1(PIN_STEP, PIN_DIR, STEPS); + +unsigned long nextMoveTime = 0; +uint16_t nextMovePos = 0; + +void setup(void) +{ + // Run the motor against the stops + motor1.zero(); + // Plan next move (in loop()) + motor1.moveTo(100); +} + +void loop(void) +{ + // the motor only moves when you call update + motor1.loop(); +} +``` diff --git a/lib/lib_div/arduino-vid6608/doc/VID6608.pdf b/lib/lib_div/arduino-vid6608/doc/VID6608.pdf new file mode 100644 index 000000000..ed44fed83 Binary files /dev/null and b/lib/lib_div/arduino-vid6608/doc/VID6608.pdf differ diff --git a/lib/lib_div/arduino-vid6608/doc/operation-configuration.png b/lib/lib_div/arduino-vid6608/doc/operation-configuration.png new file mode 100644 index 000000000..aa24adec0 Binary files /dev/null and b/lib/lib_div/arduino-vid6608/doc/operation-configuration.png differ diff --git a/lib/lib_div/arduino-vid6608/doc/output.gif b/lib/lib_div/arduino-vid6608/doc/output.gif new file mode 100644 index 000000000..b113868c1 Binary files /dev/null and b/lib/lib_div/arduino-vid6608/doc/output.gif differ diff --git a/lib/lib_div/arduino-vid6608/examples/RandomMove/RandomMove.cpp b/lib/lib_div/arduino-vid6608/examples/RandomMove/RandomMove.cpp new file mode 100644 index 000000000..ee07f9192 --- /dev/null +++ b/lib/lib_div/arduino-vid6608/examples/RandomMove/RandomMove.cpp @@ -0,0 +1,78 @@ +#include +#include + +// standard X25.168 range 315 degrees at 1/3 degree steps +#define STEPS (320 * 12) + +#define PIN_STEP 26 // Pin, connected to f(scx) +#define PIN_DIR 27 // Pin. connected to CW/CCW + +// Custom Acceleration table for the X27.168 +// Proposed non-linear curve by ChatGPT +static vid6608::AccelTable accelTable[] = { + {30, 3000}, + {65, 2920}, + {100, 2780}, + {135, 2600}, + {170, 2380}, + {205, 2140}, + {240, 1890}, + {275, 1650}, + {310, 1420}, + {345, 1210}, + {380, 1020}, + {415, 860}, + {450, 730}, + {485, 620}, + {520, 530}, + {555, 460}, + {590, 410}, + {625, 370}, + {660, 340}, + {695, 320}, + {730, 310}, + {765, 305}, + {800, 300}, +}; + +vid6608 motor1(PIN_STEP, PIN_DIR, STEPS); + +unsigned long nextMoveTime = 0; +uint16_t nextMovePos = 0; + +void setup(void) +{ + // Initalize debug here + Serial.begin(9600); + Serial.println("Setup"); + // Set custom curve + motor1.setAccelTable(accelTable); + // run the motor against the stops + motor1.zero(); + // We are done + Serial.println("Setup done"); +} + +void loop(void) +{ + // the motor only moves when you call update + motor1.loop(); + + // Wait for motor to finish + if (motor1.isStopped()) { + // Plan next move here, to have real pause between moves + if (nextMoveTime == 0) { + nextMoveTime = millis() + random(500, 2000); + } else { + // Wait for next move time + if (millis() > nextMoveTime) { + // Plan next move here + nextMoveTime = 0; + nextMovePos = random(0, STEPS); + Serial.print("Moving to "); + Serial.println(nextMovePos); + motor1.moveTo(nextMovePos); + } + } + } +} diff --git a/lib/lib_div/arduino-vid6608/library.json b/lib/lib_div/arduino-vid6608/library.json new file mode 100644 index 000000000..e2f609302 --- /dev/null +++ b/lib/lib_div/arduino-vid6608/library.json @@ -0,0 +1,19 @@ +{ + "name": "vid6608", + "keywords": "driver, motor, control", + "description": "Arduino library for driving IC VID6608 and clones for Switec X25.168 / X27.168 miniature stepper motors", + "homepage": "https://github.com/petrows/arduino-vid6608", + "repository": + { + "type": "git", + "url": "https://github.com/petrows/arduino-vid6608.git" + }, + "authors": { + "name": "Petr Golovachev", + "email": "petro@petro.ws", + "url": "https://petro.ws/" + }, + "version": "1.0.2", + "frameworks": "arduino", + "platforms": "*" +} diff --git a/lib/lib_div/arduino-vid6608/library.properties b/lib/lib_div/arduino-vid6608/library.properties new file mode 100644 index 000000000..43dcfdb69 --- /dev/null +++ b/lib/lib_div/arduino-vid6608/library.properties @@ -0,0 +1,9 @@ +name=vid6608 +version=1.0.2 +author=Petr Golovachev +maintainer=Petr Golovachev +sentence=Arduino library for driving IC VID6608 and clones for Switec X25.168 / X27.168 miniature stepper motors +paragraph=This library allows to control automotive gauge stepper motors with microstepping drivers with smooth movement +category=Device Control +url=https://github.com/petrows/arduino-vid6608 +architectures=* diff --git a/lib/lib_div/arduino-vid6608/platformio.ini b/lib/lib_div/arduino-vid6608/platformio.ini new file mode 100644 index 000000000..c0463d03c --- /dev/null +++ b/lib/lib_div/arduino-vid6608/platformio.ini @@ -0,0 +1,31 @@ +; PlatformIO Project Configuration File +; +; Build options: build flags, source filter +; Upload options: custom upload port, speed and extra flags +; Library options: dependencies, extra library storages +; Advanced options: extra scripting +; +; Please visit documentation for the other options and examples +; https://docs.platformio.org/page/projectconf.html + +[platformio] +default_envs = esp32doit-devkit-v1 + +[env:uno] +platform = atmelavr +board = uno +framework = arduino +check_tool = cppcheck +check_src_filters = + + + + + +[env:esp32doit-devkit-v1] +platform = espressif32 +board = esp32doit-devkit-v1 +framework = arduino + +[env:d1_mini_pro] +platform = espressif8266 +board = d1_mini_pro +framework = arduino diff --git a/lib/lib_div/arduino-vid6608/src/vid6608.cpp b/lib/lib_div/arduino-vid6608/src/vid6608.cpp new file mode 100644 index 000000000..5531d180e --- /dev/null +++ b/lib/lib_div/arduino-vid6608/src/vid6608.cpp @@ -0,0 +1,172 @@ +/** + * VID6608 gauge motor driver library + * by Petr Golovachev , 2025 + * + * https://github.com/petrows/arduino-vid6608 + * + * Licensed under the GPL, see LICENSE.txt for details. + */ + +#include "vid6608.h" + +// This table defines the acceleration curve. +// 1 value: distance from begin / target in steps +// 2 value: speed delay in microseconds +static vid6608::AccelTable defaultAccelTable[] = { + {30, 3000}, + {65, 2920}, + {100, 2780}, + {135, 2600}, + {170, 2380}, + {205, 2140}, + {240, 1890}, + {275, 1650}, + {310, 1420}, + {345, 1210}, + {380, 1020}, + {415, 860}, + {450, 730}, + {485, 620}, + {520, 530}, + {555, 460}, + {590, 410}, + {625, 370}, + {660, 340}, + {695, 320}, + {730, 310}, + {765, 305}, + {800, 300}, +}; + +vid6608::vid6608(int stepPin, int dirPin, uint16_t maxSteps /*= VID6608_MAX_STEPS*/) { + // Zero values: + this->maxSteps = maxSteps; + this->stepPin = stepPin; + this->dirPin = dirPin; + this->moveState = STATE_IDLE; + this->moveDirection = MOVE_NONE; + this->dirPinState = MOVE_NONE; // invalid state to force update on first step + this->currentPosition = 0; + this->targetPosition = 0; + this->setAccelTable(defaultAccelTable); + // Setup pins + pinMode(this->stepPin, OUTPUT); + pinMode(this->dirPin, OUTPUT); + digitalWrite(this->stepPin, LOW); + digitalWrite(this->dirPin, LOW); +} + +void vid6608::zero(uint16_t delay /*= VID6608_DEFAULT_ZERO_SPEED*/) { + // We have to optimize the zeroing process to avoid bouncing on end-stops + // Drive makes 1/2 move forward and 1/2 backward to reduce bouncing + // This will reduce bouncing, if the last position was not a zero position + uint16_t halfSteps = this->maxSteps / 2; + // Move to halfSteps forward + for (uint16_t x = 0; x < halfSteps; x++) { + step(MOVE_FORWARD, delay); + } + // Move to halfSteps back + for (uint16_t x = 0; x < this->maxSteps; x++) { + step(MOVE_BACKWARD, delay); + } + // Reset values + this->currentPosition = 0; + this->targetPosition = 0; + this->targetPositionNext = 0; + this->moveState = STATE_IDLE; + this->moveDirection = MOVE_NONE; +} + +void vid6608::moveTo(uint16_t position) { + // Test for duplicates + if (position == this->targetPositionNext) { + return; + } + // Sanity check + if (position > this->maxSteps - 1) { + position = this->maxSteps - 1; + } + // Calculate new values to move and schedule it for next async call + this->targetPositionNext = position; +} + +bool vid6608::isMoving() { + return this->moveState == STATE_MOVING; +} + +uint16_t vid6608::getPosition() { + return this->currentPosition; +} + +void vid6608::loop() { + // Check if we have a new target position scheduled + if (this->moveState == STATE_IDLE) { + if (this->targetPosition != this->targetPositionNext) { + // New position is scheduled, we have to prepare new values for it + this->targetPosition = this->targetPositionNext; + this->moveState = STATE_MOVING; + this->moveDirection = this->targetPosition > this->currentPosition ? MOVE_FORWARD : MOVE_BACKWARD; + this->moveDone = 0; + // Calculate point values, we have to save 1/2 of way to compare it, + // it is required to decide what distance we have (from begin or to end) + if (this->moveDirection == MOVE_FORWARD) { + this->moveLeft = this->targetPosition - this->currentPosition; + } else { + this->moveLeft = this->currentPosition - this->targetPosition; + } + } + } + // If we are moving -> update to next position + if (this->moveState == STATE_MOVING) { + // Check what we have - close to end or begin? + uint16_t accelDistance = 0; + if (this->moveDone < this->moveLeft) { + // We are in the first half + accelDistance = this->moveDone; + } else { + // We are in the second half + accelDistance = this->moveLeft; + } + // Get the actual speed, depending on distance from/to + uint16_t accelDelay = getDelay(accelDistance); + // Actual move + step(this->moveDirection, accelDelay); + this->moveDone++; + this->moveLeft--; + this->currentPosition += (this->moveDirection == MOVE_FORWARD) ? 1 : -1; + // Check the end of movement + if (this->currentPosition == this->targetPosition) { + this->moveState = STATE_IDLE; + } + } +} + +void vid6608::step(vid6608::MoveDirection direction, uint16_t delayUs) { + if (direction != this->dirPinState) { + this->dirPinState = direction; + digitalWrite(this->dirPin, direction == MOVE_FORWARD ? LOW : HIGH); + // Setup time must be > 100ns, we 1us to be safe + delay(1); + } + digitalWrite(this->stepPin, HIGH); + delayMicroseconds(delayUs); + // VID6608 reacts on raising front, so we can lower the pin immediately with lower delay + // to improve max speed. Lower time must be > 100ns, we set 1us to be safe. + digitalWrite(this->stepPin, LOW); + delayMicroseconds(1); + // We should keep resources reserved by others + yield(); +} + +uint16_t vid6608::getDelay(uint16_t distance) { + if (distance >= this->accelMaxDistance) { + return this->accelMaxDelay; + } + for (uint16_t x = 0; x < this->accelTableSize; x++) { + if (this->accelTable[x].distance > distance) { + return this->accelTable[x].delay; + } + } + // We should never be here, but return to be safe + return this->accelMaxDelay; +} diff --git a/lib/lib_div/arduino-vid6608/src/vid6608.h b/lib/lib_div/arduino-vid6608/src/vid6608.h new file mode 100644 index 000000000..a42819366 --- /dev/null +++ b/lib/lib_div/arduino-vid6608/src/vid6608.h @@ -0,0 +1,154 @@ +/** + * VID6608 gauge motor driver library + * by Petr Golovachev , 2025 + * + * https://github.com/petrows/arduino-vid6608 + * + * Licensed under the GPL, see LICENSE.txt for details. + */ + +#ifndef vid6608_h +#define vid6608_h + +#include + +/** + * @brief Default max steps for VID6608 motor + x27.168 clones + * @note driver has 12 steps per degree normally + * this value is default only, can be changed as argument, @see vid6608::vid6608() + */ +#define VID6608_DEFAULT_MAX_STEPS 320 * 12 +/** + * @brief Default speed while homing, in microseconds + * this value is default only, can be changed as argument, @see vid6608::zero() + */ +#define VID6608_DEFAULT_ZERO_SPEED 600 + +/** + * @brief Driver object class + * + * See example usage in: examples/RandomMove/RandomMove.cpp + * + */ +class vid6608 { + public: + /** + * @brief Object constructor, specify two control pins and overall motor capacity here + * + * @param stepPin pin connected to f(scx)N chip input, controls movement + * @param dirPin pin connected to CW/CCW(N) chip input, controls movement direction + * @param maxSteps full capacity in steps for motor. Note that VID6606 and its clones provides 12 steps per degree. Default capacity is defined in VID6608_DEFAULT_MAX_STEPS (320 degrees * 12 steps) + */ + vid6608(int stepPin, int dirPin, uint16_t maxSteps = VID6608_DEFAULT_MAX_STEPS); + + /** + * @brief Resets zero position to actual 0 position + * + * Uses optimized method to reduce bouncing end-stops + * @warning this function is blocking, execution is delayed upon done + * + * @param delay single step delay, controls sthe speed of motor, default is deined in VID6608_DEFAULT_ZERO_SPEED + */ + void zero(uint16_t delay = VID6608_DEFAULT_ZERO_SPEED); + + /** + * @brief Shedules movement to defined absolute position + * + * Input is checked for sanity: must be in range 0...maxSteps-1. Values bigger are threated as maxSteps-1. + * @warning this function is asynchronous, actual movement is done in the loop() function. + * @warning next move will be scheduled after current move is done to avoid drive jittering. + * + * @param position absolute position in range 0...maxSteps-1 + */ + void moveTo(uint16_t position); + + /** + * @brief Test if motor is moving + * + * Return true, if drive still have sheduled steps (that means that next loop() call will result impulse). + * + * @return true if drive is moveemnt + * @return false if drive is stopped + */ + bool isMoving(); + + /** + * @brief Test if motor is stopped + * + * @return true if drive is stopped + * @return false if drive is moveemnt + */ + bool isStopped() { return !isMoving(); } + + /** + * @brief Returns current real absolute position + * + * @return uint16_t current real drive position in steps + */ + uint16_t getPosition(); + + /** + * @brief Main loop function + * + * This function must be called in main loop to manage actual movement + * and proper signal generation. + * @warning: this function is asynchronous, but may delay up to single step (depends on accelTable, up to 3ms using default one) + */ + void loop(); + + /** + * @brief Acceleration Table struct + * This struct holds the acceleration curve, to slow down movement close to start/end positions. + */ + typedef struct { + uint16_t distance; /** in steps, from start or to end */ + uint16_t delay; /** in microseconds */ + } AccelTable; + /** + * @brief Set the Acceleration Table object + * + * This function sets the acceleration curve, to slow down movement close to start/end positions. + * Inspired by: https://github.com/clearwater/SwitecX25/pull/31 + * See ``defaultAccelTable`` defenition for example. + * + * @param table acceleration table, must be array of @struct AccelTable + */ + template void setAccelTable(T (&table)[N]) { + accelTable = table; + accelTableSize = N; + accelMaxDistance = accelTable[accelTableSize - 1].distance; + accelMaxDelay = accelTable[accelTableSize - 1].delay; + }; + + private: + enum MoveState { + STATE_IDLE = 0, + STATE_MOVING = 1, + }; + enum MoveDirection { + MOVE_NONE = -1, + MOVE_FORWARD = 0, + MOVE_BACKWARD = 1, + }; + uint16_t maxSteps; // Maximum steps for the motor + uint16_t currentPosition; // Current position in steps + uint16_t targetPosition; // Target position in steps + uint16_t targetPositionNext; // Target position in steps (scheduled for next move) + uint16_t moveLeft; // How long we have to move left + uint16_t moveDone; // How long we have traveled + int stepPin; // Pin connected to step input + int dirPin; // Pin connected to direction input + MoveState moveState; // Current move state + MoveDirection moveDirection; // Current move state + MoveDirection dirPinState; // Direction pin last state, tri-state to force update on first step + AccelTable *accelTable; // Accel table can be modified + uint16_t accelTableSize; // How many rows in the acceleration table + uint16_t accelMaxDistance; // Max distance from the acceleration table + uint16_t accelMaxDelay; // Max delay from the acceleration table + // Actual move + void step(MoveDirection direction, uint16_t delayUs); + // Get current acceleration speed (delay) + uint16_t getDelay(uint16_t distance); +}; + +#endif // vid6608_h diff --git a/tasmota/include/tasmota_template.h b/tasmota/include/tasmota_template.h index afeccc8f6..301e8dfab 100644 --- a/tasmota/include/tasmota_template.h +++ b/tasmota/include/tasmota_template.h @@ -235,6 +235,7 @@ enum UserSelectablePins { #ifdef ESP32 GPIO_HSDIO_CMD, GPIO_HSDIO_CLK, GPIO_HSDIO_RST, GPIO_HSDIO_D0, GPIO_HSDIO_D1, GPIO_HSDIO_D2, GPIO_HSDIO_D3, // Hosted MCU SDIO interface, including 1-bit and 4-bit modes #endif + GPIO_VID6608_F, GPIO_VID6608_CW, // VID6608 GPIO_SENSOR_END }; // Error as warning to rethink GPIO usage with max 2045 @@ -512,6 +513,7 @@ const char kSensorNames[] PROGMEM = #ifdef ESP32 D_SENSOR_HSDIO_CMD "|" D_SENSOR_HSDIO_CLK "|" D_SENSOR_HSDIO_RST "|" D_SENSOR_HSDIO_D0 "|" D_SENSOR_HSDIO_D1 "|" D_SENSOR_HSDIO_D2 "|" D_SENSOR_HSDIO_D3 "|" #endif + D_VID6608_F "|" D_VID6608_CW "|" ; const char kSensorNamesFixed[] PROGMEM = @@ -1161,7 +1163,6 @@ const uint16_t kGpioNiceList[] PROGMEM = { AGPIO(GPIO_C8_CO2_5K_RX), // SC8-CO2-5K Serial interface #endif - #ifdef ESP32 #ifdef USE_ESP32_TWAI #if SOC_TWAI_SUPPORTED @@ -1328,6 +1329,13 @@ const uint16_t kGpioNiceList[] PROGMEM = { AGPIO(GPIO_ADC_VOLTAGE) + AGMAX(MAX_ADCS), // Voltage AGPIO(GPIO_ADC_CURRENT) + AGMAX(MAX_ADCS), // Current #endif // ESP32 + + +#ifdef USE_VID6608 + AGPIO(GPIO_VID6608_F) + AGMAX(4), // VID6608 step interface (max 4 motors) + AGPIO(GPIO_VID6608_CW) + AGMAX(4), // VID6608 direction interface (max 4 motors) +#endif + }; /*-------------------------------------------------------------------------------------------*\ diff --git a/tasmota/language/af_AF.h b/tasmota/language/af_AF.h index 3e190d36b..fe6660870 100644 --- a/tasmota/language/af_AF.h +++ b/tasmota/language/af_AF.h @@ -542,6 +542,10 @@ #define D_ENERGY_YESTERDAY "Energie Gister" #define D_ENERGY_TOTAL "Energie Totaal" +// xdrv_92_vid6608.ino +#define D_VID6608_F "VID6608 F" +#define D_VID6608_CW "VID6608 CW" + // xsns_100_ina3221.ino #define D_UNIT_CHARGE "Ah" #define D_CHARGE "Charge" diff --git a/tasmota/language/bg_BG.h b/tasmota/language/bg_BG.h index 751dfd7f1..962437478 100644 --- a/tasmota/language/bg_BG.h +++ b/tasmota/language/bg_BG.h @@ -542,6 +542,10 @@ #define D_ENERGY_YESTERDAY "Консумация за вчера" #define D_ENERGY_TOTAL "Консумирано общо" +// xdrv_92_vid6608.ino +#define D_VID6608_F "VID6608 F" +#define D_VID6608_CW "VID6608 CW" + // xsns_100_ina3221.ino #define D_UNIT_CHARGE "Ah" #define D_CHARGE "Charge" diff --git a/tasmota/language/ca_AD.h b/tasmota/language/ca_AD.h index a087c7310..2a0ba1ec5 100644 --- a/tasmota/language/ca_AD.h +++ b/tasmota/language/ca_AD.h @@ -542,6 +542,10 @@ #define D_ENERGY_YESTERDAY "Energy Yesterday" #define D_ENERGY_TOTAL "Energy Total" +// xdrv_92_vid6608.ino +#define D_VID6608_F "VID6608 F" +#define D_VID6608_CW "VID6608 CW" + // xsns_100_ina3221.ino #define D_UNIT_CHARGE "Ah" #define D_CHARGE "Charge" diff --git a/tasmota/language/cs_CZ.h b/tasmota/language/cs_CZ.h index 84209ed5e..c505b51d9 100644 --- a/tasmota/language/cs_CZ.h +++ b/tasmota/language/cs_CZ.h @@ -542,6 +542,10 @@ #define D_ENERGY_YESTERDAY "Spotřeba Včera" #define D_ENERGY_TOTAL "Celková spotřeba" +// xdrv_92_vid6608.ino +#define D_VID6608_F "VID6608 F" +#define D_VID6608_CW "VID6608 CW" + // xsns_100_ina3221.ino #define D_UNIT_CHARGE "Ah" #define D_CHARGE "Charge" diff --git a/tasmota/language/de_DE.h b/tasmota/language/de_DE.h index 23e2b6667..e39510350 100644 --- a/tasmota/language/de_DE.h +++ b/tasmota/language/de_DE.h @@ -542,6 +542,10 @@ #define D_ENERGY_YESTERDAY "Energie gestern" #define D_ENERGY_TOTAL "Energie gesamt" +// xdrv_92_vid6608.ino +#define D_VID6608_F "VID6608 F" +#define D_VID6608_CW "VID6608 CW" + // xsns_100_ina3221.ino #define D_UNIT_CHARGE "Ah" #define D_CHARGE "Ladung" diff --git a/tasmota/language/el_GR.h b/tasmota/language/el_GR.h index 3c751133b..b8d3eeb2b 100644 --- a/tasmota/language/el_GR.h +++ b/tasmota/language/el_GR.h @@ -542,6 +542,10 @@ #define D_ENERGY_YESTERDAY "Ενέργεια χθες" #define D_ENERGY_TOTAL "Ενέργεια συνολικά" +// xdrv_92_vid6608.ino +#define D_VID6608_F "VID6608 F" +#define D_VID6608_CW "VID6608 CW" + // xsns_100_ina3221.ino #define D_UNIT_CHARGE "Ah" #define D_CHARGE "Charge" diff --git a/tasmota/language/en_GB.h b/tasmota/language/en_GB.h index ab1f94f7b..f7b38b595 100644 --- a/tasmota/language/en_GB.h +++ b/tasmota/language/en_GB.h @@ -542,6 +542,10 @@ #define D_ENERGY_YESTERDAY "Energy Yesterday" #define D_ENERGY_TOTAL "Energy Total" +// xdrv_92_vid6608.ino +#define D_VID6608_F "VID6608 F" +#define D_VID6608_CW "VID6608 CW" + // xsns_100_ina3221.ino #define D_UNIT_CHARGE "Ah" #define D_CHARGE "Charge" diff --git a/tasmota/language/es_ES.h b/tasmota/language/es_ES.h index 7cccf8776..272d22de9 100644 --- a/tasmota/language/es_ES.h +++ b/tasmota/language/es_ES.h @@ -542,6 +542,10 @@ #define D_ENERGY_YESTERDAY "Energía Ayer" #define D_ENERGY_TOTAL "Energía Total" +// xdrv_92_vid6608.ino +#define D_VID6608_F "VID6608 F" +#define D_VID6608_CW "VID6608 CW" + // xsns_100_ina3221.ino #define D_UNIT_CHARGE "Ah" #define D_CHARGE "Charge" diff --git a/tasmota/language/fr_FR.h b/tasmota/language/fr_FR.h index decc6c735..a1d590164 100644 --- a/tasmota/language/fr_FR.h +++ b/tasmota/language/fr_FR.h @@ -542,6 +542,10 @@ #define D_ENERGY_YESTERDAY "Énergie hier" #define D_ENERGY_TOTAL "Énergie totale" +// xdrv_92_vid6608.ino +#define D_VID6608_F "VID6608 F" +#define D_VID6608_CW "VID6608 CW" + // xsns_100_ina3221.ino #define D_UNIT_CHARGE "Ah" #define D_CHARGE "Charge" diff --git a/tasmota/language/fy_NL.h b/tasmota/language/fy_NL.h index 27fa8c1d9..3c4d8d70d 100644 --- a/tasmota/language/fy_NL.h +++ b/tasmota/language/fy_NL.h @@ -542,6 +542,10 @@ #define D_ENERGY_YESTERDAY "Konsumpsje juster" #define D_ENERGY_TOTAL "Konsumpsje totaal" +// xdrv_92_vid6608.ino +#define D_VID6608_F "VID6608 F" +#define D_VID6608_CW "VID6608 CW" + // xsns_100_ina3221.ino #define D_UNIT_CHARGE "Ah" #define D_CHARGE "Charge" diff --git a/tasmota/language/he_HE.h b/tasmota/language/he_HE.h index e9411a1f6..67e5cc68f 100644 --- a/tasmota/language/he_HE.h +++ b/tasmota/language/he_HE.h @@ -542,6 +542,10 @@ #define D_ENERGY_YESTERDAY "צריכה בעבר" #define D_ENERGY_TOTAL "צריכה כללית" +// xdrv_92_vid6608.ino +#define D_VID6608_F "VID6608 F" +#define D_VID6608_CW "VID6608 CW" + // xsns_100_ina3221.ino #define D_UNIT_CHARGE "Ah" #define D_CHARGE "Charge" diff --git a/tasmota/language/hu_HU.h b/tasmota/language/hu_HU.h index 8b20bc528..19f239367 100644 --- a/tasmota/language/hu_HU.h +++ b/tasmota/language/hu_HU.h @@ -542,6 +542,10 @@ #define D_ENERGY_YESTERDAY "Tegnapi energia" #define D_ENERGY_TOTAL "Összes energia" +// xdrv_92_vid6608.ino +#define D_VID6608_F "VID6608 F" +#define D_VID6608_CW "VID6608 CW" + // xsns_100_ina3221.ino #define D_UNIT_CHARGE "Ah" #define D_CHARGE "Charge" diff --git a/tasmota/language/it_IT.h b/tasmota/language/it_IT.h index 575f17c00..d70fe9ea4 100644 --- a/tasmota/language/it_IT.h +++ b/tasmota/language/it_IT.h @@ -542,6 +542,10 @@ #define D_ENERGY_YESTERDAY "Energia - ieri" #define D_ENERGY_TOTAL "Energia - totale" +// xdrv_92_vid6608.ino +#define D_VID6608_F "VID6608 F" +#define D_VID6608_CW "VID6608 CW" + // xsns_100_ina3221.ino #define D_UNIT_CHARGE "Ah" #define D_CHARGE "Carica" diff --git a/tasmota/language/ko_KO.h b/tasmota/language/ko_KO.h index 4139ab364..39f312b16 100644 --- a/tasmota/language/ko_KO.h +++ b/tasmota/language/ko_KO.h @@ -542,6 +542,10 @@ #define D_ENERGY_YESTERDAY "어제 전력 사용량" #define D_ENERGY_TOTAL "총 전력 사용량" +// xdrv_92_vid6608.ino +#define D_VID6608_F "VID6608 F" +#define D_VID6608_CW "VID6608 CW" + // xsns_100_ina3221.ino #define D_UNIT_CHARGE "Ah" #define D_CHARGE "Charge" diff --git a/tasmota/language/lt_LT.h b/tasmota/language/lt_LT.h index 28c6c8bcd..c50fcdf26 100644 --- a/tasmota/language/lt_LT.h +++ b/tasmota/language/lt_LT.h @@ -542,6 +542,10 @@ #define D_ENERGY_YESTERDAY "Energija vakar" #define D_ENERGY_TOTAL "Bendra energija" +// xdrv_92_vid6608.ino +#define D_VID6608_F "VID6608 F" +#define D_VID6608_CW "VID6608 CW" + // xsns_100_ina3221.ino #define D_UNIT_CHARGE "Ah" #define D_CHARGE "Įkrova" diff --git a/tasmota/language/nl_NL.h b/tasmota/language/nl_NL.h index 22c6a3aad..bffb0f589 100644 --- a/tasmota/language/nl_NL.h +++ b/tasmota/language/nl_NL.h @@ -542,6 +542,10 @@ #define D_ENERGY_YESTERDAY "Verbruik gisteren" #define D_ENERGY_TOTAL "Verbruik totaal" +// xdrv_92_vid6608.ino +#define D_VID6608_F "VID6608 F" +#define D_VID6608_CW "VID6608 CW" + // xsns_100_ina3221.ino #define D_UNIT_CHARGE "Ah" #define D_CHARGE "Charge" diff --git a/tasmota/language/pl_PL.h b/tasmota/language/pl_PL.h index 3a764ef42..82db9882d 100644 --- a/tasmota/language/pl_PL.h +++ b/tasmota/language/pl_PL.h @@ -542,6 +542,10 @@ #define D_ENERGY_YESTERDAY "Energia wczoraj" #define D_ENERGY_TOTAL "Energia całkowita" +// xdrv_92_vid6608.ino +#define D_VID6608_F "VID6608 F" +#define D_VID6608_CW "VID6608 CW" + // xsns_100_ina3221.ino #define D_UNIT_CHARGE "Ah" #define D_CHARGE "Ładowanie" diff --git a/tasmota/language/pt_BR.h b/tasmota/language/pt_BR.h index 317992dfc..5176e3d0d 100644 --- a/tasmota/language/pt_BR.h +++ b/tasmota/language/pt_BR.h @@ -542,6 +542,10 @@ #define D_ENERGY_YESTERDAY "Consumo energético de ontem" #define D_ENERGY_TOTAL "Consumo total de energia" +// xdrv_92_vid6608.ino +#define D_VID6608_F "VID6608 F" +#define D_VID6608_CW "VID6608 CW" + // xsns_100_ina3221.ino #define D_UNIT_CHARGE "Ah" #define D_CHARGE "Charge" diff --git a/tasmota/language/pt_PT.h b/tasmota/language/pt_PT.h index d9448ba08..ed3ca9cf3 100644 --- a/tasmota/language/pt_PT.h +++ b/tasmota/language/pt_PT.h @@ -542,6 +542,10 @@ #define D_ENERGY_YESTERDAY "Consumo energético de ontem" #define D_ENERGY_TOTAL "Consumo energético total" +// xdrv_92_vid6608.ino +#define D_VID6608_F "VID6608 F" +#define D_VID6608_CW "VID6608 CW" + // xsns_100_ina3221.ino #define D_UNIT_CHARGE "Ah" #define D_CHARGE "Charge" diff --git a/tasmota/language/ro_RO.h b/tasmota/language/ro_RO.h index 1e88dc2a0..bb2ac9310 100644 --- a/tasmota/language/ro_RO.h +++ b/tasmota/language/ro_RO.h @@ -542,6 +542,10 @@ #define D_ENERGY_YESTERDAY "Energia de Ieri" #define D_ENERGY_TOTAL "Energia Totală" +// xdrv_92_vid6608.ino +#define D_VID6608_F "VID6608 F" +#define D_VID6608_CW "VID6608 CW" + // xsns_100_ina3221.ino #define D_UNIT_CHARGE "Ah" #define D_CHARGE "Charge" diff --git a/tasmota/language/ru_RU.h b/tasmota/language/ru_RU.h index fc8de49a7..d8a85b4f4 100644 --- a/tasmota/language/ru_RU.h +++ b/tasmota/language/ru_RU.h @@ -543,6 +543,10 @@ #define D_ENERGY_YESTERDAY "Энергия вчера" #define D_ENERGY_TOTAL "Энергия всего" +// xdrv_92_vid6608.ino +#define D_VID6608_F "VID6608 F" +#define D_VID6608_CW "VID6608 CW" + // xsns_100_ina3221.ino #define D_UNIT_CHARGE "Ah" #define D_CHARGE "Charge" diff --git a/tasmota/language/sk_SK.h b/tasmota/language/sk_SK.h index ab0239c80..4fb132312 100644 --- a/tasmota/language/sk_SK.h +++ b/tasmota/language/sk_SK.h @@ -542,6 +542,10 @@ #define D_ENERGY_YESTERDAY "Spotreba včera" #define D_ENERGY_TOTAL "Celková spotreba" +// xdrv_92_vid6608.ino +#define D_VID6608_F "VID6608 F" +#define D_VID6608_CW "VID6608 CW" + // xsns_100_ina3221.ino #define D_UNIT_CHARGE "Ah" #define D_CHARGE "Charge" diff --git a/tasmota/language/sv_SE.h b/tasmota/language/sv_SE.h index d97fb9f51..e8fe01528 100644 --- a/tasmota/language/sv_SE.h +++ b/tasmota/language/sv_SE.h @@ -542,6 +542,10 @@ #define D_ENERGY_YESTERDAY "Energi igår" #define D_ENERGY_TOTAL "Energi totalt" +// xdrv_92_vid6608.ino +#define D_VID6608_F "VID6608 F" +#define D_VID6608_CW "VID6608 CW" + // xsns_100_ina3221.ino #define D_UNIT_CHARGE "Ah" #define D_CHARGE "Charge" diff --git a/tasmota/language/tr_TR.h b/tasmota/language/tr_TR.h index bf8ef7e2b..f8a1adfbe 100644 --- a/tasmota/language/tr_TR.h +++ b/tasmota/language/tr_TR.h @@ -542,6 +542,10 @@ #define D_ENERGY_YESTERDAY "Energy Yesterday" #define D_ENERGY_TOTAL "Energy Total" +// xdrv_92_vid6608.ino +#define D_VID6608_F "VID6608 F" +#define D_VID6608_CW "VID6608 CW" + // xsns_100_ina3221.ino #define D_UNIT_CHARGE "Ah" #define D_CHARGE "Charge" diff --git a/tasmota/language/uk_UA.h b/tasmota/language/uk_UA.h index a8fd8bb03..f552bdc3d 100644 --- a/tasmota/language/uk_UA.h +++ b/tasmota/language/uk_UA.h @@ -542,6 +542,10 @@ #define D_ENERGY_YESTERDAY "Енергія Вчора" #define D_ENERGY_TOTAL "Енергія Всього" +// xdrv_92_vid6608.ino +#define D_VID6608_F "VID6608 F" +#define D_VID6608_CW "VID6608 CW" + // xsns_100_ina3221.ino #define D_UNIT_CHARGE "Ah" #define D_CHARGE "Charge" diff --git a/tasmota/language/vi_VN.h b/tasmota/language/vi_VN.h index 6f85cad0f..456b525f5 100644 --- a/tasmota/language/vi_VN.h +++ b/tasmota/language/vi_VN.h @@ -542,6 +542,10 @@ #define D_ENERGY_YESTERDAY "Năng lượng tiêu thụ hôm qua" #define D_ENERGY_TOTAL "Tổng năng lượng tiêu thụ" +// xdrv_92_vid6608.ino +#define D_VID6608_F "VID6608 F" +#define D_VID6608_CW "VID6608 CW" + // xsns_100_ina3221.ino #define D_UNIT_CHARGE "Ah" #define D_CHARGE "Charge" diff --git a/tasmota/language/zh_CN.h b/tasmota/language/zh_CN.h index 3d49e6950..52cc0bd0c 100644 --- a/tasmota/language/zh_CN.h +++ b/tasmota/language/zh_CN.h @@ -542,6 +542,10 @@ #define D_ENERGY_YESTERDAY "昨日用电量" #define D_ENERGY_TOTAL "总用电量" +// xdrv_92_vid6608.ino +#define D_VID6608_F "VID6608 F" +#define D_VID6608_CW "VID6608 CW" + // xsns_100_ina3221.ino #define D_UNIT_CHARGE "Ah" #define D_CHARGE "Charge" diff --git a/tasmota/language/zh_TW.h b/tasmota/language/zh_TW.h index 395699313..b96f65727 100644 --- a/tasmota/language/zh_TW.h +++ b/tasmota/language/zh_TW.h @@ -542,6 +542,10 @@ #define D_ENERGY_YESTERDAY "昨日用電量" #define D_ENERGY_TOTAL "總用電量" +// xdrv_92_vid6608.ino +#define D_VID6608_F "VID6608 F" +#define D_VID6608_CW "VID6608 CW" + // xsns_100_ina3221.ino #define D_UNIT_CHARGE "Ah" #define D_CHARGE "Charge" diff --git a/tasmota/my_user_config.h b/tasmota/my_user_config.h index 154f58ece..681fcade2 100644 --- a/tasmota/my_user_config.h +++ b/tasmota/my_user_config.h @@ -1128,6 +1128,7 @@ //#define USE_HRE // Add support for Badger HR-E Water Meter (+1k4 code) //#define USE_A4988_STEPPER // Add support for A4988/DRV8825 stepper-motor-driver-circuit (+10k5 code) +//#define USE_VID6608 // Add support for VID6608 Automotive analog gauge driver (+0k7 code) //#define USE_PROMETHEUS // Add support for https://prometheus.io/ metrics exporting over HTTP /metrics endpoint diff --git a/tasmota/tasmota_xdrv_driver/xdrv_92_vid6608.ino b/tasmota/tasmota_xdrv_driver/xdrv_92_vid6608.ino new file mode 100644 index 000000000..f15e53586 --- /dev/null +++ b/tasmota/tasmota_xdrv_driver/xdrv_92_vid6608.ino @@ -0,0 +1,355 @@ +/* + xdrv_92_vid6608.ino - Support for VID6608 automotive gauge stepper motor driver + + Copyright (C) 2025 Petr Golovachev + + 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 . +*/ +#ifdef USE_VID6608 + +#define XDRV_92 92 +#define VID6608_MAX_DRIVES 4 + +/* + VID6608 automotive gauge stepper motor driver + + This driver implements support for following driver chips for analog automotive gauges (Switec X25.168, X27.168 and clones) with microstepping support: + + * VID6606 (2 motors) + * VID6608 (4 motors) + * VT6608S + * AX1201728SG + * BY8920 + * many others + + Driver chips with microstepping is the recommended way to drive such motors, + they provide much more relailabe and smooth movement with reduced noise and + to avoid skipping steps. + + Driver is configured to perform 320° rotation angle with 12 steps per degree. + Total capacity is 3840 steps for whole scale. + + Library homepage: https://github.com/petrows/arduino-vid6608 + + Connection: + + * Connect IC VID6608 inputs F(scx) and CW/CCW to GPIO pins + * Connect RESET pin of VID6608 to VCC + * Define "VID6608 F" and "VID6608 CW" pins in Configuration / Module page + + Driver adds following commands: + + * Gauge : returns current gauges state + * GaugeSetX : set gauge to absolute position in range 0..3840, where X - motor index from 1 to 4, 0 for all + * GaugePercentX : set gauge position in percents in range 0..100, where X - motor index from 1 to 4, 0 for all + * GaugeZeroX : triggers gauge calibration and homing, where X - motor index from 1 to 4, 0 for all + + Performance notes: + + * ESP32: Driver uses background FreeRTOS task for impulse generation, as it requires microsecond precision + for inpulses. ESP32 uses FreeRTOS API and movement is fast and smooth (very similar to real car gauges). + * ESP8266: For ESP8266 driver also works, but movement is much slower (but it is still okay for slow + changing values, i.e. temperature). On ESP8266 speed is ~2 sec per degree. + + Version history: + + * 2025-11-23 - fixes related with ESP8266 performance + * 2025-11-22 - initial release +*/ + +/** + * @brief Driver impulse mode decision here + * ESP-32 has FreeRTOS, that allows us to perform precision inpulse control + */ +#ifdef ESP32 + #define VID6608_RTOS +#endif + +#include "vid6608.h" + +/** + * @brief Command definition + */ +#define D_PRFX_GAUGE "Gauge" +#define D_CMND_GAUGE_SET "Set" +#define D_CMND_GAUGE_PERCENT "Percent" +#define D_CMND_GAUGE_ZERO "Zero" + +const char kGaugeCommands[] PROGMEM = D_PRFX_GAUGE "|" // Prefix + "|" D_CMND_GAUGE_SET "|" D_CMND_GAUGE_PERCENT "|" + D_CMND_GAUGE_ZERO + ; + +void (* const GaugeCommand[])(void) PROGMEM = { + &CmndGauge, &CmndGaugeSet, &CmndGaugePercent, + &CmndGaugeZero, +}; + +enum GaugeInternalCommand { + GAUGE_ZERO, + GAUGE_SET, + GAUGE_SET_PERCENT +}; + +/** + * @brief Global vars + */ +bool vid6608Present = false; +float vid6608StepsFloat = VID6608_DEFAULT_MAX_STEPS; +vid6608 *vid6608Drives[VID6608_MAX_DRIVES]; + +/** + * @brief Command Gauge + * Displays currnt state for all Gauge drives + */ +void CmndGauge(void) { + Response_P(PSTR("{")); + VID6608StatusJson(); + ResponseJsonEnd(); +} + +/** + * @brief Command GaugeSet, GaugeSet0 and GaugeSetX + */ +void CmndGaugeSet(void) { + CmndGaugeCommand(GAUGE_SET, XdrvMailbox.index, XdrvMailbox.payload); +} + +/** + * @brief Command GaugePercent, GaugePercent0 and GaugePercentX + */ +void CmndGaugePercent(void) { + CmndGaugeCommand(GAUGE_SET_PERCENT, XdrvMailbox.index, XdrvMailbox.payload); +} + +/** + * @brief Command GaugeZero, GaugeZero0 and GaugeZeroX + */ +void CmndGaugeZero(void) { + CmndGaugeCommand(GAUGE_ZERO, XdrvMailbox.index, XdrvMailbox.payload); +} + +/** + * @brief Driver common command function + * + * @param command what to issue + * @param index drive number (0 - all, 1..4 - by number) + * @param payload command argument + */ +void CmndGaugeCommand(int32_t command, uint32_t index, int32_t payload) { + Response_P(PSTR("{\"" D_PRFX_GAUGE "\":{")); + bool isFirstItem = true; + for (uint8_t x = 0; x < VID6608_MAX_DRIVES; x++) { + if (index == 0 || index == (x+1)) { + vid6608 *driver = vid6608Drives[x]; + if (driver) { + if (!isFirstItem) { + ResponseAppend_P(PSTR(",")); + } + ResponseAppend_P(PSTR("\"%d\":{"), (int32_t)(x+1)); + switch (command) { + case GAUGE_ZERO: + driver->zero(); + ResponseAppend_P(PSTR("\"cmd\":\"zero\",\"pos\":0")); + break; + case GAUGE_SET: + driver->moveTo(payload); + ResponseAppend_P(PSTR("\"cmd\":\"set\",\"pos\":%d"), payload); + break; + case GAUGE_SET_PERCENT: + float moveSteps = vid6608StepsFloat * ( (float)payload / 100.0 ); + driver->moveTo(moveSteps); + ResponseAppend_P(PSTR("\"cmd\":\"perc\",\"perc\":%d,\"pos\":%d"), payload, (int32_t)moveSteps); + break; + } + ResponseAppend_P(PSTR("}"), x+1); + isFirstItem = false; + } + } + } + ResponseAppend_P(PSTR("}}")); +} + +/** + * @brief Function to display current Gauge state in JSON format + * Prefix (i.e. "," or "{") should be added externally + */ +void VID6608StatusJson() { + ResponseAppend_P(PSTR("\"" D_PRFX_GAUGE "\":{")); + bool isFirstItem = true; + for (uint8_t x = 0; x < VID6608_MAX_DRIVES; x++) { + vid6608 *driver = vid6608Drives[x]; + if (driver) { + if (!isFirstItem) { + ResponseAppend_P(PSTR(",")); + } + ResponseAppend_P(PSTR("\"%d\":{\"pos\":%d}"), (int32_t)(x+1), (int32_t)driver->getPosition()); + isFirstItem = false; + } + } + ResponseJsonEnd(); +} + +#ifdef USE_WEBSERVER +/** + * @brief Function to display current Gauge state in HTML format + * Displayes HTML table for web browser + */ +void VID6608StatusWeb() { + WSContentSend_PD(HTTP_TABLE100); + for (uint8_t x = 0; x < VID6608_MAX_DRIVES; x++) { + vid6608 *driver = vid6608Drives[x]; + if (driver) { + WSContentSend_PD(PSTR("Gauge %d%d"), (int32_t)(x+1), (int32_t)driver->getPosition()); + } + } + WSContentSend_PD(PSTR("")); +} +#endif + +#ifdef VID6608_RTOS +/** + * @brief FreeRTOS background process function + * This function is required to handle movement with precision timings. + * Used in ESP-32 only, the ESP8266 uses classical loop() thread. + */ +void VID6608XvTask(void *) { + while(true) { + bool needToMove = false; + for (uint8_t x = 0; x < VID6608_MAX_DRIVES; x++) { + vid6608 *driver = vid6608Drives[x]; + if (driver) { + driver->loop(); + if (driver->isMoving()) { + needToMove = true; + } + } + } + /* + If we dont need to move any -> go sleep. + This will delay next move begin up to 500ms, but freeds up CPU a lot. + */ + if (!needToMove) { + vTaskDelay(500 / portTICK_PERIOD_MS); + } + } +} +#endif // VID6608_RTOS + +/** + * @brief Driver initalisation + * Checks the defined pins and creates Drives objects, if pins found. + */ +void VID6608Init() { + AddLog(LOG_LEVEL_INFO, PSTR("VID: Init")); + for (uint32_t x = 0; x < VID6608_MAX_DRIVES; x++) { + if (PinUsed(GPIO_VID6608_F, x) && PinUsed(GPIO_VID6608_CW, x)) { + // We have motor defined at number x + uint32_t pinStep = Pin(GPIO_VID6608_F, x); + uint32_t pinDir = Pin(GPIO_VID6608_CW, x); + AddLog(LOG_LEVEL_DEBUG, PSTR("VID: detected drive %d at pin %d, %d"), x, pinStep, pinDir); + vid6608Drives[x] = new vid6608(pinStep, pinDir); + + // Perform homing operation + vid6608Drives[x]->zero(); + AddLog(LOG_LEVEL_DEBUG, PSTR("VID: zero %d done"), x); + vid6608Present = true; + } else { + vid6608Drives[x] = nullptr; + } + } + // If no drives present -> skip rest of initalization + if (!vid6608Present) { + return; + } +#ifdef VID6608_RTOS + // Start background RTOS thread -> required for precision timing + xTaskCreate( + VID6608XvTask, /* Function to implement the task */ + "VID6608XvTask", /* Name of the task */ + 1024, /* Stack size in words */ + NULL, /* Task input parameter */ + 0, /* Priority of the task, lowest */ + NULL /* Task handle. */ + ); +#endif // VID6608_RTOS +} + +// Classical loop implementation +#ifndef VID6608_RTOS +/** + * @brief Non-FreeRTOS background process function + * ESP8266 classical loop() thread function, used where is no FreeRTOS. + */ +bool VID6608Loop() { + for (uint8_t x = 0; x < VID6608_MAX_DRIVES; x++) { + vid6608 *driver = vid6608Drives[x]; + if (driver) { + driver->loop(); + } + } + return true; +} +#endif // VID6608_RTOS + +/*********************************************************************************************\ + * Interface +\*********************************************************************************************/ + +bool Xdrv92(uint32_t function) { + // Driver initalization + if (FUNC_INIT == function) { + VID6608Init(); + return false; + } + // We are not initilized? + if (!vid6608Present) { + return false; + } + // Normal callbacks + bool result = false; + + switch (function) { + case FUNC_LOOP: +#ifndef VID6608_RTOS + // ESP32 uses FreeRTOS to manage moving tasks, as it requires precision timings + // Others should use regular loop -> slower, but still works + result = VID6608Loop(); +#else + result = true; +#endif + break; + case FUNC_COMMAND: + result = DecodeCommand(kGaugeCommands, GaugeCommand); + break; + case FUNC_JSON_APPEND: + ResponseAppend_P(PSTR(",")); + VID6608StatusJson(); + result = true; + break; +#ifdef USE_WEBSERVER + case FUNC_WEB_SENSOR: + VID6608StatusWeb(); + result = true; + break; +#endif // USE_WEBSERVER + case FUNC_ACTIVE: + result = true; + break; + } + + return result; +} + +#endif // USE_VID6608