diff --git a/.gitignore b/.gitignore deleted file mode 100644 index c09e3fc..0000000 --- a/.gitignore +++ /dev/null @@ -1,4 +0,0 @@ -de.jaseg.kimesh.footprints/footprints -de.jaseg.kimesh.footprints/metadata.json -de.jaseg.kimesh.plugin/metadata.json -__pycache__ diff --git a/LICENSE b/LICENSE deleted file mode 100644 index f288702..0000000 --- a/LICENSE +++ /dev/null @@ -1,674 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. diff --git a/README.rst b/README.rst index 2c6ac45..f00d9f8 100644 --- a/README.rst +++ b/README.rst @@ -9,56 +9,13 @@ This repository contains KiMesh, a KiCAD pcbnew plugin that generates security m Installation ------------ - -KiMesh has two parts: The pcbnew plugin that generates the traces, and the magic footprints that you use to tell the -plugin how many traces of which dimensions to generate where. - -To install the plugin, copy the "kimesh" directory into your KiCAD installation's scripting plugin folder. Usually, this -is `~/.config/kicad/scripting/plugins/` for KiCAD stable installations or -`~/.config/kicad/[major version].99/scripting/plugins/` for nightly builds. On Windows, these paths can be found in your -user account's `AppData/Roaming` directory. - -To install the footprint libraries, the easiest way is to download the library zip from the project's repo -`[link] `__, unpack it to your project folder, and -add the unpacked libraries as project-specific libraries through KiCad's library management thingy. - -Usage ------ - -To work, KiMesh requires four things: - -1. An area free of other features such as footprints or traces where to generate the mesh. -2. One or more "graphic polygons" on a drawing layer that specify the area of the mesh. -3. A closed board outline on the `Edge.Cuts` layer. -4. One of the magic footprints from the KiMesh anchor library that defines the mesh's number of wires and their - dimensions, and tells KiMesh where to start the mesh and in which direction to start it. - -You can choose any layer for the outline polygons, such as the pre-defined `User.Eco1` or `User.X` layers, or you can -define your own. You just have to select that layer later in KiMesh's generator dialog. Note that KiMesh only processes -graphic polygons on that layer, and ignores other shapes such as lines, rectangles or circles. You can still use other -shapes, but you have to manually convert them to polygons before running KiMesh. To convert other shapes to -a polygon, select them, open the context menu with a right click, then choose the "Create from Selection 🞂 Create -Polygon from Selection" entry. For rectangles or circles, use the "Use Centerlines" option. For lines or arcs, use the -"Create bounding hull" option. - -Place the magic anchor footprint on the outline of the mesh's shape polygons so that you have space to route out the -traces. The anchor footprint has an arrow on the `F.Fab` layer that indicates in which direction the mesh will be -generated. - -I recommend adding the mesh to the schematic with one of KiCad's built-in `Connector_02xN_Top_Bottom` footprints. For a -mesh with k wires, choose a symbol with two rows of 2k pins each. For instance, for two mesh wires, choose -`Connector_02x04_Top_bottom`. Then assign one of the magic footprints to that symbol. To avoid DRC warnings, join the -two halves of the mesh on the output side of the footprint. That's the right side in default orientation, where the -higher-numbered pins are. - -.. image:: screenshot-mesh-schematic.png - :width: 800 - :alt: A screenshot of the connector footprint mentioned in the previous paragraph, shown conencted up as described in - KiCad's schematic editor. +To install, copy the "kimesh" directory into your KiCAD installation's scripting plugin folder. Usually, this is +`~/.config/kicad/scripting/plugins/` for KiCAD stable installations or `~/.config/kicad/5.99/scripting/plugins/` for +nightly builds. On Windows, these paths can be found in your user account's `AppData/Roaming` directory. Theory of operation ------------------- I have published a post_ on my blog on the theory of operation behind KiMesh. -.. _post: https://jaseg.de/blog/kicad-mesh-plugin/ +.. _post: https://blog.jaseg.de/posts/kicad-mesh-plugin/ diff --git a/de.jaseg.kimesh.plugin/plugins/__init__.py b/__init__.py similarity index 100% rename from de.jaseg.kimesh.plugin/plugins/__init__.py rename to __init__.py diff --git a/de.jaseg.kimesh.footprints-repo-metadata.json b/de.jaseg.kimesh.footprints-repo-metadata.json deleted file mode 100644 index 8c099b0..0000000 --- a/de.jaseg.kimesh.footprints-repo-metadata.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "$schema": "https://go.kicad.org/pcm/schemas/v1", - "name": "KiMesh", - "description": "A security mesh generator for KiCad", - "description_full": "This is the footprint package for the KiMesh security mesh generator.", - "identifier": "de.jaseg.kimesh.footprints", - "type": "library", - "author": { - "name": "jaseg", - "contact": { - "web": "https://jaseg.de/" - } - }, - "license": "CERN-OHL", - "resources": { - "homepage": "https://jaseg.de/projects/kimesh", - "git": "https://git.jaseg.de/kimesh.git", - "issues": "https://github.com/jaseg/kimesh/issues" - }, - "versions": [ - { - "version": "1.0.0", - "status": "stable", - "kicad_version": "7.99", - "download_sha256": "e0c1a2752090def465afa6f6c38baeb74a6544e79e87de3019087c41a3f2790e", - "download_size": 822342, - "download_url": "https://git.jaseg.de/kimesh.git/plain/de.jaseg.kimesh.footprints-v1.0.0.zip?h=v1.0.0", - "install_size": 4803868 - }, - { - "version": "1.0.1", - "status": "stable", - "kicad_version": "7.99", - "download_sha256": "00bc9b6e264ee4f72324909e40dbc2d7d2ec6e91d150639d52492fe305c17620", - "download_size": 822997, - "download_url": "https://git.jaseg.de/kimesh.git/plain/de.jaseg.kimesh.footprints-v1.0.1.zip?h=v1.0.1", - "install_size": 4803868 - } - ] -} \ No newline at end of file diff --git a/de.jaseg.kimesh.footprints-v1.0.1.zip b/de.jaseg.kimesh.footprints-v1.0.1.zip deleted file mode 100644 index 6f6278e..0000000 Binary files a/de.jaseg.kimesh.footprints-v1.0.1.zip and /dev/null differ diff --git a/de.jaseg.kimesh.footprints/metadata.json b/de.jaseg.kimesh.footprints/metadata.json deleted file mode 100644 index 5f0225f..0000000 --- a/de.jaseg.kimesh.footprints/metadata.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "$schema": "https://go.kicad.org/pcm/schemas/v1", - "name": "KiMesh", - "description": "A security mesh generator for KiCad", - "description_full": "This is the footprint package for the KiMesh security mesh generator.", - "identifier": "de.jaseg.kimesh.footprints", - "type": "library", - "author": { - "name": "jaseg", - "contact": { - "web": "https://jaseg.de/" - } - }, - "license": "CERN-OHL", - "resources": { - "homepage": "https://jaseg.de/projects/kimesh", - "git": "https://git.jaseg.de/kimesh.git", - "issues": "https://github.com/jaseg/kimesh/issues" - }, - "versions": [ - { - "version": "1.0.1", - "status": "stable", - "kicad_version": "7.99" - } - ] -} \ No newline at end of file diff --git a/de.jaseg.kimesh.footprints/resources/icon.png b/de.jaseg.kimesh.footprints/resources/icon.png deleted file mode 100644 index dbb60d1..0000000 Binary files a/de.jaseg.kimesh.footprints/resources/icon.png and /dev/null differ diff --git a/de.jaseg.kimesh.plugin-repo-metadata.json b/de.jaseg.kimesh.plugin-repo-metadata.json deleted file mode 100644 index 3165de9..0000000 --- a/de.jaseg.kimesh.plugin-repo-metadata.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "$schema": "https://go.kicad.org/pcm/schemas/v1", - "name": "KiMesh", - "description": "A security mesh generator for KiCad", - "description_full": "KiMesh automatically generates security meshes for you. A security mesh is a set of PCB traces that cover an area to detect physical tampering. KiMesh can cover arbitrary areas with two or more traces. Note: The KiMesh footprints Add-On must be installed alongside KiMesh. For detailed usage instructions, please have a look at the KiMesh website linked in the add-on information.", - "identifier": "de.jaseg.kimesh.plugin", - "type": "plugin", - "author": { - "name": "jaseg", - "contact": { - "web": "https://jaseg.de/" - } - }, - "license": "GPL-3.0", - "resources": { - "homepage": "https://jaseg.de/projects/kimesh", - "git": "https://git.jaseg.de/kimesh.git", - "issues": "https://github.com/jaseg/kimesh/issues" - }, - "versions": [ - { - "version": "1.0.0", - "status": "stable", - "kicad_version": "7.99", - "download_sha256": "59da3a8a13be001fb6f5eee9e1d346f4beee6c0d736856b2da205db290ad21a6", - "download_size": 12895, - "download_url": "https://git.jaseg.de/kimesh.git/plain/de.jaseg.kimesh.plugin-v1.0.0.zip?h=v1.0.0", - "install_size": 45166 - }, - { - "version": "1.0.1", - "status": "stable", - "kicad_version": "7.99", - "download_sha256": "5367448e63cd824a60f47d85fdd379e7072eaceab6e93d2a2af3791a4b54aa25", - "download_size": 12911, - "download_url": "https://git.jaseg.de/kimesh.git/plain/de.jaseg.kimesh.plugin-v1.0.1.zip?h=v1.0.1", - "install_size": 45187 - } - ] -} \ No newline at end of file diff --git a/de.jaseg.kimesh.plugin-v1.0.1.zip b/de.jaseg.kimesh.plugin-v1.0.1.zip deleted file mode 100644 index cde0bfc..0000000 Binary files a/de.jaseg.kimesh.plugin-v1.0.1.zip and /dev/null differ diff --git a/de.jaseg.kimesh.plugin/metadata.json b/de.jaseg.kimesh.plugin/metadata.json deleted file mode 100644 index 5256ccb..0000000 --- a/de.jaseg.kimesh.plugin/metadata.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "$schema": "https://go.kicad.org/pcm/schemas/v1", - "name": "KiMesh", - "description": "A security mesh generator for KiCad", - "description_full": "KiMesh automatically generates security meshes for you. A security mesh is a set of PCB traces that cover an area to detect physical tampering. KiMesh can cover arbitrary areas with two or more traces. Note: The KiMesh footprints Add-On must be installed alongside KiMesh. For detailed usage instructions, please have a look at the KiMesh website linked in the add-on information.", - "identifier": "de.jaseg.kimesh.plugin", - "type": "plugin", - "author": { - "name": "jaseg", - "contact": { - "web": "https://jaseg.de/" - } - }, - "license": "GPL-3.0", - "resources": { - "homepage": "https://jaseg.de/projects/kimesh", - "git": "https://git.jaseg.de/kimesh.git", - "issues": "https://github.com/jaseg/kimesh/issues" - }, - "versions": [ - { - "version": "1.0.1", - "status": "stable", - "kicad_version": "7.99" - } - ] -} \ No newline at end of file diff --git a/de.jaseg.kimesh.plugin/resources/icon.png b/de.jaseg.kimesh.plugin/resources/icon.png deleted file mode 100644 index dbb60d1..0000000 Binary files a/de.jaseg.kimesh.plugin/resources/icon.png and /dev/null differ diff --git a/debug_install.sh b/debug_install.sh new file mode 100644 index 0000000..e928738 --- /dev/null +++ b/debug_install.sh @@ -0,0 +1,13 @@ +#!/bin/sh + +PLUGIN_NAME=security_mesh + +XDG_CONFIG_HOME="${XDG_CONFIG_HOME-$HOME/.config}" +KICAD_BASE="${1-$XDG_CONFIG_HOME/kicad}" +PLUGIN_DIR="$KICAD_BASE/scripting/plugins/$PLUGIN_NAME" + +rm -rf "$PLUGIN_DIR" +mkdir -p "$PLUGIN_DIR" + +cp -r * $PLUGIN_DIR/ + diff --git a/footprint_generator.py b/footprint_generator.py deleted file mode 100755 index af98d41..0000000 --- a/footprint_generator.py +++ /dev/null @@ -1,80 +0,0 @@ -#!/usr/bin/env python3 - -from pathlib import Path -import itertools - -import gerbonara.cad.kicad as kc -from gerbonara.cad.kicad import footprints -import gerbonara as gn -from gerbonara.utils import MM - -import click - -@click.command() -@click.option('-w', '--trace-width', default='0.15', help='Comma-separated list of trace widths [mm]') -@click.option('-c', '--clearance', default='0.15', help='Comma-separated list of clearances to step through [mm]') -@click.option('-n', '--conductors', default='2', help='Comma-separated list of numbers of conductors') -@click.argument('output_dir', type=click.Path(dir_okay=True, file_okay=False, path_type=Path)) -def generate_footprints(output_dir, trace_width, clearance, conductors): - trace_widths = [float(x.strip()) for x in trace_width.split(',')] - clearances = [float(x.strip()) for x in clearance.split(',')] - conductors = [int(x.strip()) for x in conductors.split(',')] - - if output_dir.suffix != '.pretty': - output_dir = output_dir.with_name(output_dir.name + '.pretty') - - for trace, space, conductors in itertools.product(trace_widths, clearances, conductors): - pitch = trace + space - - fp = footprints.Footprint( - name=f'MeshAnchor_{conductors}W_T{trace:.3f}mm_S{space:.3f}mm', - _version=20230620, - generator = footprints.Atom('kimesh_footprint_generator'), - descr=f'KiMesh mesh anchor footprint, {conductors} wires, {trace:.3f} mm trace width, {space:.3f} mm clearance', - tags='net tie', - attributes=footprints.Attribute(footprints.Atom.smd), - net_tie_pad_groups=[f'{i+1},{2*conductors-i},{2*conductors+1+i},{4*conductors-i}' for i in range(conductors)], - polygons=[footprints.Polygon( - pts=footprints.PointList(xy=[ - footprints.XYCoord(-pitch/2, pitch * (conductors - i - 0.5) + trace/2), - footprints.XYCoord(pitch/2, pitch * (conductors - i - 0.5) + trace/2), - footprints.XYCoord(pitch/2, pitch * (conductors - i - 0.5) - trace/2), - footprints.XYCoord(-pitch/2, pitch * (conductors - i - 0.5) - trace/2), - ]), - layer='F.Cu', - fill=footprints.Atom.solid) - for i in range(2*conductors)], - lines=[footprints.Line(footprints.XYCoord(pitch/2 + trace/2 + 0.25 + x1, y1), - footprints.XYCoord(pitch/2 + trace/2 + 0.25 + x2, y2), - 'F.Fab', - stroke=footprints.Stroke(width=0.25)) - for x1, y1, x2, y2 in [ - (0, pitch * (conductors - 0.5) + trace/2 - 0.25/2, - 0, pitch * (-conductors + 0.5) - trace/2 + 0.25/2), - (0, 0, conductors * pitch, 0), - (conductors * pitch, 0, conductors * pitch/2, conductors * pitch/2), - (conductors * pitch, 0, conductors * pitch/2, -conductors * pitch/2), - ]], - texts=[ - footprints.Text( - text='Mesh', - at=footprints.AtPos(pitch/2 + trace/2 + 0.25 + conductors * pitch + 0.5, 0), - layer='F.Fab', - effects=footprints.TextEffect(justify=footprints.Justify(h=footprints.Atom.left)) - ) - ], - pads=[ - footprints.Pad( - number=f'{i+1}', - type=footprints.Atom.smd, - shape=footprints.Atom.circle, - at=footprints.AtPos(pitch * (i//(2*conductors) - 0.5), -pitch * (conductors - i%(2*conductors) - 0.5)), - size=footprints.XYCoord(trace, trace), - layers=['F.Cu']) - for i in range(4*conductors)]) - output_dir.mkdir(exist_ok=True) - fp.make_standard_properties() - fp.write(output_dir / f'{fp.name}.kicad_mod') - -if __name__ == '__main__': - generate_footprints() diff --git a/main_dialog.fbp b/main_dialog.fbp index d97f4c0..9852735 100644 --- a/main_dialog.fbp +++ b/main_dialog.fbp @@ -48,7 +48,7 @@ MainDialog - 632,580 + 632,458 wxCLOSE_BOX|wxDEFAULT_DIALOG_STYLE|wxMINIMIZE_BOX|wxRESIZE_BORDER|wxSTAY_ON_TOP ; ; forward_declare Security Mesh Generator Plugin @@ -62,68 +62,6 @@ bSizer1 wxVERTICAL none - - 5 - wxALL|wxEXPAND - 0 - - 1 - 1 - 1 - 1 - - - - - - - - 1 - 0 - 1 - - 1 - 0 - Dock - 0 - Left - 0 - 1 - - 1 - - 0 - 0 - wxID_ANY - <font color="red"><b>Warning: Board outline not found</b></font> - 1 - - 0 - - - 0 - - 1 - m_warningLabel - 1 - - - protected - 1 - - Resizable - 1 - - wxALIGN_CENTER_HORIZONTAL - ; ; forward_declare - 0 - - - - - -1 - - 5 wxEXPAND @@ -1395,358 +1333,6 @@ - - 5 - wxEXPAND - 1 - - 0 - protected - 0 - - - - 5 - wxALL - 0 - - 1 - 1 - 1 - 1 - - - - - - - - 1 - 0 - 1 - 1 - - 1 - 0 - Dock - 0 - Left - 0 - 1 - - 1 - - 0 - 0 - wxID_ANY - Respect zone keepouts - - 0 - - - 0 - - 1 - m_useKeepoutCheckbox - 1 - - - protected - 1 - - Resizable - 1 - - - ; ; forward_declare - 0 - - - wxFILTER_NONE - wxDefaultValidator - - - - - - - - 5 - wxEXPAND - 1 - - 0 - protected - 0 - - - - 5 - wxALL - 0 - - 1 - 1 - 1 - 1 - - - - - - - - 1 - 0 - 1 - 1 - - 1 - 0 - Dock - 0 - Left - 0 - 1 - - 1 - - 0 - 0 - wxID_ANY - Respect board outline - - 0 - - - 0 - - 1 - m_useOutlineCheckbox - 1 - - - protected - 1 - - Resizable - 1 - - - ; ; forward_declare - 0 - - - wxFILTER_NONE - wxDefaultValidator - - - - - - - - 5 - wxEXPAND - 1 - - 0 - protected - 0 - - - - 5 - wxALL - 0 - - 1 - 1 - 1 - 1 - - - - - - - - 1 - 0 - 1 - 1 - - 1 - 0 - Dock - 0 - Left - 0 - 1 - - 1 - - 0 - 0 - wxID_ANY - Save layout visualizations - - 0 - - - 0 - - 1 - m_vizCheckbox - 1 - - - protected - 1 - - Resizable - 1 - - - ; ; forward_declare - 0 - - - wxFILTER_NONE - wxDefaultValidator - - - - - - - - 5 - wxALIGN_CENTER_VERTICAL|wxALIGN_RIGHT|wxALL - 0 - - 1 - 1 - 1 - 1 - - - - - - - - 1 - 0 - 1 - - 1 - 0 - Dock - 0 - Left - 0 - 1 - - 1 - - 0 - 0 - wxID_ANY - Visualization output directory - 0 - - 0 - - - 0 - - 1 - m_staticText14 - 1 - - - protected - 1 - - Resizable - 1 - - - ; ; forward_declare - 0 - - - - - -1 - - - - 5 - wxALL|wxEXPAND - 0 - - 1 - 1 - 1 - 1 - - - - - - - - 1 - 0 - 1 - - 1 - 0 - Dock - 0 - Left - 0 - 1 - - 1 - - 0 - 0 - wxID_ANY - - 0 - - - - 0 - - 1 - m_vizTextfield - 1 - - - protected - 1 - - Resizable - 1 - - - ; ; forward_declare - 0 - - - wxFILTER_NONE - wxDefaultValidator - - - - - - - diff --git a/de.jaseg.kimesh.plugin/plugins/mesh_dialog.py b/mesh_dialog.py similarity index 79% rename from de.jaseg.kimesh.plugin/plugins/mesh_dialog.py rename to mesh_dialog.py index 4bcbc38..c508608 100644 --- a/de.jaseg.kimesh.plugin/plugins/mesh_dialog.py +++ b/mesh_dialog.py @@ -8,7 +8,6 @@ from itertools import count, islice import json import re from os import path -import os import wx @@ -31,20 +30,16 @@ class AbortError(SystemError): @dataclasses.dataclass class GeneratorSettings: - edge_clearance: float = 1.5 # mm - anchor: str = None # Footprint designator - chamfer: float = 0.0 # unit fraction - mask_layer_id: int = 0 # kicad layer id, populated later - random_seed: str = None - randomness: float = 1.0 - use_keepouts: bool = True - use_outline: bool = True - save_visualization: bool = True - visualization_path: str = 'mesh_visualizations' + edge_clearance: float = 1.5 # mm + anchor: str = None # Footprint designator + chamfer: float = 0.0 # unit fraction + mask_layer_id: int = 0 # kicad layer id, populated later + random_seed: str = None + randomness: float = 1.0 def serialize(self): d = dataclasses.asdict(self) - d['kimesh_settings_version'] = '2.1.0' + d['kimesh_settings_version'] = '1.0.0' return json.dumps(d).encode() @classmethod @@ -52,7 +47,7 @@ class GeneratorSettings: d = json.loads(data.decode()) version = d.pop('kimesh_settings_version') vtup = tuple(map(int, version.split('.'))) - if vtup > (2, 1, 0): + if vtup > (2, 0, 0): raise cls.VersionError("Project kimesh settings file is too new for this plugin's version.") return cls(**d) @@ -74,7 +69,6 @@ class MeshPluginMainDialog(mesh_plugin_dialog.MainDialog): self.nets = { str(wxs) for wxs, netinfo in board.GetNetsByName().items() } self.update_net_label(None) - self.update_outline_warning() self.Fit() @@ -83,8 +77,8 @@ class MeshPluginMainDialog(mesh_plugin_dialog.MainDialog): with open(self.settings_fn(), 'rb') as f: try: settings = GeneratorSettings.deserialize(f.read()) - except (GeneratorSettings.VersionError, TypeError) as e: - wx.MessageDialog(self, "Cannot load settings: {}.".format(e), "File I/O error. Will use default settings.").ShowModal() + except GeneratorSettings.VersionError as e: + wx.MessageDialog(self, "Cannot load settings: {}.".format(e), "File I/O error").ShowModal() for i in range(pcbnew.PCB_LAYER_ID_COUNT): name = board.GetLayerName(i) @@ -101,74 +95,18 @@ class MeshPluginMainDialog(mesh_plugin_dialog.MainDialog): for i, fp in enumerate(self.fps): ref = fp.GetReference() self.m_anchorChoice.Append(ref) - if (settings and ref == settings.anchor) or (not settings and 'MeshAnchor' in str(fp.GetFPID().GetLibItemName())): + if settings and ref == settings.anchor: self.m_anchorChoice.SetSelection(i) - if settings: self.m_chamferSpin.Value = settings.chamfer*100.0 self.m_maskLayerChoice.SetSelection(settings.mask_layer_id) self.m_seedInput.Value = settings.random_seed or '' self.m_randomnessSpin.Value = settings.randomness*100.0 self.m_edgeClearanceSpin.Value = settings.edge_clearance - self.m_useOutlineCheckbox.Value = settings.use_outline - self.m_useKeepoutCheckbox.Value = settings.use_keepouts - self.m_vizTextfield.Value = settings.visualization_path - self.m_vizCheckbox.Value = settings.save_visualization self.SetMinSize(self.GetSize()) - @contextmanager - def viz(self, filename): - if self.m_vizCheckbox.Value: - val = self.m_vizTextfield.Value - project_dir = path.dirname(self.board.GetFileName()) - if val: - val = path.join(project_dir, val) - if not os.path.isdir(val): - os.mkdir(val) - filename = path.join(val, filename) - - filename = path.join(project_dir, filename) - with open(filename, 'w') as f: - wrapper = DebugOutputWrapper(f) - yield wrapper - wrapper.save() - - else: - wrapper = DebugOutputWrapper(None) - yield wrapper - - def board_has_outline(self): - # KiCad's API is absolutely insane. As long as the board has an outline, the board outline function works - # alright. Now imagine the Edge.Cuts layer is empty. What would be a sane thing to do? I guess raising an error - # would be the best, with the second best being to return something like the hull of all objects on the other - # layers. Alas, KiCad doesn't do either. Instead, KiCad returns the union of the shapes of all objects on the - # **VISIBLE** layers, so the result of that outline function changes with which layers the user has set to - # visible. Whyyyyy :( - # - # We have to work around this to avoid presenting the user with a foot-gun in case they hide their mesh - # definition layer. - # - edge_cuts = self.board.GetLayerID('Edge.Cuts') - outline_objs = [] - for drawing in self.board.GetDrawings(): - if drawing.GetLayer() == edge_cuts: - return True - else: - return False - - def update_outline_warning(self): - outlines = pcbnew.SHAPE_POLY_SET() - self.board.GetBoardPolygonOutlines(outlines) - board_outlines = list(self.poly_set_to_shapely(outlines)) - board_mask = shapely.ops.unary_union(board_outlines) - - if not self.board_has_outline() or board_mask.is_empty: - self.m_warningLabel.SetLabelMarkup('Warning: Board outline not found') - else: - self.m_warningLabel.SetLabelMarkup('') - def get_matching_nets(self): prefix = self.m_net_prefix.Value return { net for net in self.nets if net.startswith(prefix) } @@ -232,11 +170,7 @@ class MeshPluginMainDialog(mesh_plugin_dialog.MainDialog): chamfer = float(self.m_chamferSpin.Value)/100.0, mask_layer_id = self.m_maskLayerChoice.GetSelection(), random_seed = str(self.m_seedInput.Value) or None, - randomness = float(self.m_randomnessSpin.Value)/100.0, - use_outline = self.m_useOutlineCheckbox.Value, - use_keepouts = self.m_useKeepoutCheckbox.Value, - visualization_path = self.m_vizTextfield.Value, - save_visualization = self.m_vizCheckbox.Value) + randomness = float(self.m_randomnessSpin.Value)/100.0) except ValueError as e: return wx.MessageDialog(self, "Invalid input value: {}.".format(e), "Invalid input").ShowModal() @@ -256,7 +190,7 @@ class MeshPluginMainDialog(mesh_plugin_dialog.MainDialog): mesh_zones.append(drawing.GetPolyShape()) if not mesh_zones: - return wx.MessageDialog(self, "Error: Could not find any mesh zones on the outline pattern layer.").ShowModal() + return wx.MessageDialog(self, "Error: Could not find any mesh zones on the outline pattern layer.").ShowModal() keepouts = [] for zone in self.board.Zones(): @@ -264,37 +198,19 @@ class MeshPluginMainDialog(mesh_plugin_dialog.MainDialog): keepouts.append(zone.Outline()) print(f'Found {len(keepouts)} keepout areas.') - if self.board_has_outline() and self.m_useOutlineCheckbox.Value: # Avoid foot-gun due to insane API. See note in the function. - outlines = pcbnew.SHAPE_POLY_SET() - self.board.GetBoardPolygonOutlines(outlines) - board_outlines = list(self.poly_set_to_shapely(outlines)) - board_mask = shapely.ops.unary_union(board_outlines) - mask = board_mask.buffer(-settings.edge_clearance) - print('board outline bounds:', mask.bounds) - if mask.is_empty: - return wx.MessageDialog(self, "Error: Board edge clearance is set too high. There is nothing left for the mesh after applying clearance.").ShowModal() - else: - mask = None + outlines = pcbnew.SHAPE_POLY_SET() + self.board.GetBoardPolygonOutlines(outlines) + board_outlines = list(self.poly_set_to_shapely(outlines)) + board_mask = shapely.ops.unary_union(board_outlines) + board_mask = board_mask.buffer(-settings.edge_clearance) zone_outlines = [ outline for zone in mesh_zones for outline in self.poly_set_to_shapely(zone) ] zone_mask = shapely.ops.unary_union(zone_outlines) - if zone_mask.is_empty: - return wx.MessageDialog(self, "Error: Empty mesh outline on mesh outline layer. Make sure the mesh outline is defined with polygon objects only. Other shapes are not supported yet.").ShowModal() - elif mask is None: - mask = zone_mask - else: - mask = zone_mask.intersection(mask) - print('Mesh mask bounds:', zone_mask.bounds) + mask = zone_mask.intersection(board_mask) - if self.m_useKeepoutCheckbox.Value: - keepout_outlines = [ outline for zone in keepouts for outline in self.poly_set_to_shapely(zone) ] - keepout_mask = shapely.ops.unary_union(keepout_outlines) - if not keepout_mask.is_empty: - mask = shapely.difference(mask, keepout_mask) - print('keepout mask bounds:', keepout_mask.bounds) - print('resulting mask bounds:', mask.bounds) - if mask.is_empty: - return wx.MessageDialog(self, "Error: After applying all keepouts, and intersecting with the board's outline, the mesh outline is empty.") + keepout_outlines = [ outline for zone in keepouts for outline in self.poly_set_to_shapely(zone) ] + keepout_mask = shapely.ops.unary_union(keepout_outlines) + mask = shapely.difference(mask, keepout_mask) try: def warn(msg): @@ -336,18 +252,18 @@ class MeshPluginMainDialog(mesh_plugin_dialog.MainDialog): warn('Anchor {} has multiple outlines. Using first outline for trace start.') anchor_pads = list(sorted(anchor.Pads(), key=lambda pad: int(pad.GetNumber()))) + mesh_angle = anchor.GetOrientationDegrees() trace_width = pcbnew.ToMM(anchor_pads[0].GetSize()[0]) space_width = pcbnew.ToMM(math.dist(anchor_pads[0].GetPosition(), anchor_pads[1].GetPosition())) - trace_width num_traces = len(anchor_pads) - assert num_traces%4 == 0 - num_traces //= 4 + assert num_traces%2 == 0 + num_traces //= 2 nets = [f'{net_prefix}{i}' for i in range(num_traces)] width_per_trace = trace_width + space_width grid_cell_width = width_per_trace * num_traces * 2 - print(f'mesh cell size is {grid_cell_width}') - x0, y0 = anchor_pads[len(anchor_pads)//2].GetPosition() + x0, y0 = anchor_pads[0].GetPosition() x0, y0 = pcbnew.ToMM(x0), pcbnew.ToMM(y0) xl, yl = anchor_pads[-1].GetPosition() xl, yl = pcbnew.ToMM(xl), pcbnew.ToMM(yl) @@ -355,11 +271,11 @@ class MeshPluginMainDialog(mesh_plugin_dialog.MainDialog): mesh_angle = math.atan2(xl-x0, yl-y0) print('mesh angle is', math.degrees(mesh_angle)) len_along = - width_per_trace/2 - x0 += len_along * math.sin(mesh_angle) - y0 += len_along * math.cos(mesh_angle) + x0 += -trace_width/2 * math.cos(mesh_angle) + len_along * math.sin(mesh_angle) + y0 += -trace_width/2 * math.sin(mesh_angle) + len_along * math.cos(mesh_angle) mask_xformed = affinity.translate(mask, -x0, -y0) - mask_xformed = affinity.rotate(mask_xformed, mesh_angle, origin=(0, 0), use_radians=True) + mask_xformed = affinity.rotate(mask_xformed, -mesh_angle, origin=(0, 0), use_radians=True) bbox = mask_xformed.bounds grid_x0, grid_y0 = math.floor(bbox[0]/grid_cell_width), math.floor(bbox[1]/grid_cell_width) @@ -375,19 +291,19 @@ class MeshPluginMainDialog(mesh_plugin_dialog.MainDialog): cell = polygon.Polygon([(0, 0), (0, 1), (1, 1), (1, 0)]) cell = affinity.scale(cell, grid_cell_width, grid_cell_width, origin=(0, 0)) cell = affinity.translate(cell, x*grid_cell_width, y*grid_cell_width) - cell = affinity.rotate(cell, -mesh_angle, origin=(0, 0), use_radians=True) + cell = affinity.rotate(cell, mesh_angle, origin=(0, 0), use_radians=True) cell = affinity.translate(cell, x0, y0) row.append(cell) grid.append(row) num_valid = 0 - with self.viz('mesh_grid.svg') as dbg: + with DebugOutput('dbg_grid.svg') as dbg: dbg.add(mask, color='#00000020') for y, row in enumerate(grid, start=grid_y0): for x, cell in enumerate(row, start=grid_x0): if mask.contains(cell): - if x == -1 and y == 0: # exit cell + if x == 0 and y == 0: # exit cell color = '#ff00ff80' else: num_valid += 1 @@ -461,13 +377,12 @@ class MeshPluginMainDialog(mesh_plugin_dialog.MainDialog): netinfos.append(ni) not_visited = { (x, y) for x in range(grid_x0, grid_x0+grid_cols) for y in range(grid_y0, grid_y0+grid_rows) if is_valid(grid[y-grid_y0][x-grid_x0]) } - not_visited -= {(-1, 0)} # Remove exit cell num_to_visit = len(not_visited) track_count = 0 - with self.viz('mesh_cells.svg') as dbg_cells,\ - self.viz('mesh_composite.svg') as dbg_composite,\ - self.viz('mesh_tiles.svg') as dbg_tiles,\ - self.viz('mesh_traces.svg') as dbg_traces: + with DebugOutput('dbg_cells.svg') as dbg_cells,\ + DebugOutput('dbg_composite.svg') as dbg_composite,\ + DebugOutput('dbg_tiles.svg') as dbg_tiles,\ + DebugOutput('dbg_traces.svg') as dbg_traces: dbg_cells.add(mask, color='#00000020') dbg_composite.add(mask, color='#00000020') dbg_traces.add(mask, color='#00000020') @@ -500,7 +415,7 @@ class MeshPluginMainDialog(mesh_plugin_dialog.MainDialog): i = 0 past_tiles = {} def dump_output(i): - with self.viz(f'per-tile/step{i}.svg') as dbg_per_tile: + with DebugOutput(f'per-tile/step{i}.svg') as dbg_per_tile: dbg_per_tile.add(mask, color='#00000020') for foo in anchor_outlines: dbg_per_tile.add(foo, color='#00000080', stroke_width=0.05, stroke_color='#00000000') @@ -526,7 +441,7 @@ class MeshPluginMainDialog(mesh_plugin_dialog.MainDialog): for segment in segments: segment = affinity.scale(segment, grid_cell_width, grid_cell_width, origin=(0, 0)) segment = affinity.translate(segment, le_x*grid_cell_width, le_y*grid_cell_width) - segment = affinity.rotate(segment, -mesh_angle, origin=(0, 0), use_radians=True) + segment = affinity.rotate(segment, mesh_angle, origin=(0, 0), use_radians=True) segment = affinity.translate(segment, x0, y0) dbg_per_tile.add(segment, stroke_width=trace_width, color='#ff000000', stroke_color=stroke_color) @@ -560,7 +475,7 @@ class MeshPluginMainDialog(mesh_plugin_dialog.MainDialog): if is_valid(grid[y-grid_y0][x-grid_x0]): segment = affinity.scale(segment, grid_cell_width, grid_cell_width, origin=(0, 0)) segment = affinity.translate(segment, x*grid_cell_width, y*grid_cell_width) - segment = affinity.rotate(segment, -mesh_angle, origin=(0, 0), use_radians=True) + segment = affinity.rotate(segment, mesh_angle, origin=(0, 0), use_radians=True) segment = affinity.translate(segment, x0, y0) dbg_composite.add(segment, stroke_width=trace_width, color='#ff000000', stroke_color='#ffffff60') dbg_traces.add(segment, stroke_width=trace_width, color='#ff000000', stroke_color='#000000ff') @@ -682,6 +597,14 @@ def virihex(val, max=1.0, alpha=1.0): r, g, b, a = [ int(round(0xff*c)) for c in [r, g, b, alpha] ] return f'#{r:02x}{g:02x}{b:02x}{a:02x}' +@contextmanager +def DebugOutput(filename): + filename = path.join('/tmp', filename) + with open(filename, 'w') as f: + wrapper = DebugOutputWrapper(f) + yield wrapper + wrapper.save() + class DebugOutputWrapper: def __init__(self, f): self.f = f @@ -758,16 +681,15 @@ class DebugOutputWrapper: 'xmlns:xlink': 'http://www.w3.org/1999/xlink' } - if self.f is not None: - self.f.write(textwrap.dedent(r''' - - - {data} - - ''').format( - attrs = ' '.join(['{key:s}="{val:s}"'.format(key = key, val = props[key]) for key in props]), - data = '\n'.join(self.gen_svg(obj, *style) for obj, style in self.objs) - ).strip()) + self.f.write(textwrap.dedent(r''' + + + {data} + + ''').format( + attrs = ' '.join(['{key:s}="{val:s}"'.format(key = key, val = props[key]) for key in props]), + data = '\n'.join(self.gen_svg(obj, *style) for obj, style in self.objs) + ).strip()) def show_dialog(board): dialog = MeshPluginMainDialog(board) diff --git a/de.jaseg.kimesh.plugin/plugins/mesh_plugin.py b/mesh_plugin.py similarity index 100% rename from de.jaseg.kimesh.plugin/plugins/mesh_plugin.py rename to mesh_plugin.py diff --git a/de.jaseg.kimesh.plugin/plugins/mesh_plugin_dialog.py b/mesh_plugin_dialog.py similarity index 78% rename from de.jaseg.kimesh.plugin/plugins/mesh_plugin_dialog.py rename to mesh_plugin_dialog.py index 790caa8..6223481 100644 --- a/de.jaseg.kimesh.plugin/plugins/mesh_plugin_dialog.py +++ b/mesh_plugin_dialog.py @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- ########################################################################### -## Python code generated with wxFormBuilder (version 3.10.1-380-gf48f2659) +## Python code generated with wxFormBuilder (version 3.10.1-367-gf0e67a69) ## http://www.wxformbuilder.org/ ## ## PLEASE DO *NOT* EDIT THIS FILE! @@ -17,18 +17,12 @@ import wx.xrc class MainDialog ( wx.Dialog ): def __init__( self, parent ): - wx.Dialog.__init__ ( self, parent, id = wx.ID_ANY, title = u"Security Mesh Generator Plugin", pos = wx.DefaultPosition, size = wx.Size( 632,580 ), style = wx.CLOSE_BOX|wx.DEFAULT_DIALOG_STYLE|wx.MINIMIZE_BOX|wx.RESIZE_BORDER|wx.STAY_ON_TOP ) + wx.Dialog.__init__ ( self, parent, id = wx.ID_ANY, title = u"Security Mesh Generator Plugin", pos = wx.DefaultPosition, size = wx.Size( 632,458 ), style = wx.CLOSE_BOX|wx.DEFAULT_DIALOG_STYLE|wx.MINIMIZE_BOX|wx.RESIZE_BORDER|wx.STAY_ON_TOP ) self.SetSizeHints( wx.DefaultSize, wx.DefaultSize ) bSizer1 = wx.BoxSizer( wx.VERTICAL ) - self.m_warningLabel = wx.StaticText( self, wx.ID_ANY, u"Warning: Board outline not found", wx.DefaultPosition, wx.DefaultSize, wx.ALIGN_CENTER_HORIZONTAL ) - self.m_warningLabel.SetLabelMarkup( u"Warning: Board outline not found" ) - self.m_warningLabel.Wrap( -1 ) - - bSizer1.Add( self.m_warningLabel, 0, wx.ALL|wx.EXPAND, 5 ) - fgSizer1 = wx.FlexGridSizer( 0, 2, 0, 0 ) fgSizer1.AddGrowableCol( 1 ) fgSizer1.SetFlexibleDirection( wx.BOTH ) @@ -144,35 +138,6 @@ class MainDialog ( wx.Dialog ): fgSizer1.Add( bSizer12, 1, wx.EXPAND, 5 ) - fgSizer1.Add( ( 0, 0), 1, wx.EXPAND, 5 ) - - self.m_useKeepoutCheckbox = wx.CheckBox( self, wx.ID_ANY, u"Respect zone keepouts", wx.DefaultPosition, wx.DefaultSize, 0 ) - self.m_useKeepoutCheckbox.SetValue(True) - fgSizer1.Add( self.m_useKeepoutCheckbox, 0, wx.ALL, 5 ) - - - fgSizer1.Add( ( 0, 0), 1, wx.EXPAND, 5 ) - - self.m_useOutlineCheckbox = wx.CheckBox( self, wx.ID_ANY, u"Respect board outline", wx.DefaultPosition, wx.DefaultSize, 0 ) - self.m_useOutlineCheckbox.SetValue(True) - fgSizer1.Add( self.m_useOutlineCheckbox, 0, wx.ALL, 5 ) - - - fgSizer1.Add( ( 0, 0), 1, wx.EXPAND, 5 ) - - self.m_vizCheckbox = wx.CheckBox( self, wx.ID_ANY, u"Save layout visualizations", wx.DefaultPosition, wx.DefaultSize, 0 ) - self.m_vizCheckbox.SetValue(True) - fgSizer1.Add( self.m_vizCheckbox, 0, wx.ALL, 5 ) - - self.m_staticText14 = wx.StaticText( self, wx.ID_ANY, u"Visualization output directory", wx.DefaultPosition, wx.DefaultSize, 0 ) - self.m_staticText14.Wrap( -1 ) - - fgSizer1.Add( self.m_staticText14, 0, wx.ALIGN_CENTER_VERTICAL|wx.ALIGN_RIGHT|wx.ALL, 5 ) - - self.m_vizTextfield = wx.TextCtrl( self, wx.ID_ANY, wx.EmptyString, wx.DefaultPosition, wx.DefaultSize, 0 ) - fgSizer1.Add( self.m_vizTextfield, 0, wx.ALL|wx.EXPAND, 5 ) - - bSizer1.Add( fgSizer1, 1, wx.EXPAND, 5 ) bSizer99 = wx.BoxSizer( wx.HORIZONTAL ) diff --git a/de.jaseg.kimesh.plugin/plugins/mesh_plugin_icon.png b/mesh_plugin_icon.png similarity index 100% rename from de.jaseg.kimesh.plugin/plugins/mesh_plugin_icon.png rename to mesh_plugin_icon.png diff --git a/package.py b/package.py deleted file mode 100644 index 942d367..0000000 --- a/package.py +++ /dev/null @@ -1,106 +0,0 @@ -#!/usr/bin/env python3 -import re -import hashlib -import shutil -import subprocess -import json -from pathlib import Path - -import click - -def tree_size(path): - return sum(entry.stat().st_size for entry in path.glob('**/*') if entry.is_file()) - -@click.command() -@click.option('--major', 'increment', flag_value='major') -@click.option('--minor', 'increment', flag_value='minor', default=True) -@click.option('--patch', 'increment', flag_value='patch', default=True) -@click.argument('version', required=False) -def do_release(version, increment): - if not version: - tag = subprocess.run('git describe --tags --abbrev=0 --match v*'.split(), - check=True, capture_output=True, text=True) - major, minor, patch = map(int, re.fullmatch(r'v([0-9]+)\.([0-9]+)\.([0-9]+)', tag.stdout.strip()).groups()) - match increment: - case 'major': - major, minor, patch = (major+1, 0, 0) - case 'minor': - major, minor, patch = (major, minor+1, 0) - case 'patch': - major, minor, patch = (major, minor, patch+1) - version = f'{major}.{minor}.{patch}' - - res = subprocess.run('git status --porcelain --untracked-files=no'.split(), - check=True, capture_output=True, text=True) - if res.stdout.strip(): - raise click.ClickException('There are uncommitted changes in this repository.') - - print('Cleaning old footprints') - footprint_dir = Path('de.jaseg.kimesh.footprints') / 'footprints' - shutil.rmtree(footprint_dir, ignore_errors=True) - footprint_dir.mkdir() - - print('Re-generating footprints') - for n in range(2, 9): - subprocess.run(['python', '-m', 'footprint_generator', - '-w', '0.100,0.120,0.150,0.200,0.250,0.300,0.350,0.400,0.500,0.600,0.700,0.800,1.000,1.200,1.500,1.800', - '-c', '0.100,0.120,0.150,0.200,0.300,0.400,0.500', - '-n', str(n), - str(footprint_dir / f'kimesh_anchors_{n}wire.pretty') - ], check=True) - - res = subprocess.run('git ls-files'.split(), check=True, capture_output=True, text=True) - for path in res.stdout.splitlines(): - if re.fullmatch(r'de\.jaseg\.kimesh\.[^/]*-v[.0-9]*\.zip', path.strip()): - print(f'Removing old release zip {path} from git index.') - subprocess.run(['git', 'rm', path], check=True, capture_output=True) - - for pkg_dir in Path('de.jaseg.kimesh.plugin'), Path('de.jaseg.kimesh.footprints'): - # NOTE: metadata.json appears twice. In what I believe is a sub-optimal design choice, the variant in the - # archive is only allowed to contain the current version in its version list without its zip file metadata, - # while the variant in the repository index is supposed to contain all past versions including their zip file - # metadata. AFAICT they are the same otherwise. - meta_path = Path(f'{pkg_dir}-repo-metadata.json') - - print(f'Updating metadata file {meta_path}') - ver_dict = { - 'version': version, - 'status': 'stable', - 'kicad_version': '7.99', - } - - # Include just the version metadata in the metadata for the archive - meta_file = json.loads(meta_path.read_text()) - meta_file['versions'] = [ver_dict] - (pkg_dir / 'metadata.json').write_text(json.dumps(meta_file, indent=4)) - - zip_fn = Path(shutil.make_archive(f'{pkg_dir.name}-v{version}', 'zip', pkg_dir, '.')) - print(f'Adding new release zip {zip_fn} to git index.') - subprocess.run(['git', 'add', str(zip_fn)], check=True, capture_output=True) - - # Add the zip's metadata to the metadata for the repository - ver_dict['download_sha256'] = hashlib.sha256(zip_fn.read_bytes()).hexdigest() - ver_dict['download_size'] = zip_fn.stat().st_size - ver_dict['download_url'] = f'https://git.jaseg.de/kimesh.git/plain/{zip_fn.name}?h=v{version}' - ver_dict['install_size'] = tree_size(pkg_dir) - - meta_file = json.loads(meta_path.read_text()) - meta_file['versions'].append(ver_dict) - meta_path.write_text(json.dumps(meta_file, indent=4)) - - print(f'Adding updated metadata file {meta_path} to git index') - subprocess.run(['git', 'add', str(meta_path)], check=True, capture_output=True) - - print('Create git commit') - subprocess.run(['git', 'commit', '-m', f'Version {version}', '--no-edit'], check=True, capture_output=True) - res = subprocess.run('git rev-parse --short HEAD'.split(), check=True, capture_output=True, text=True) - print(f'Created commit {res.stdout.strip()}') - print(f'Creating and signing version tag v{version}') - subprocess.run(['git', - '-c', 'user.signingkey=E36F75307F0A0EC2D145FF5CED7A208EEEC76F2D', - '-c', 'user.email=python-mpv@jaseg.de', - 'tag', '-s', f'v{version}', '-m', f'Version v{version}'], - check=True) - -if __name__ == '__main__': - do_release() diff --git a/screenshot-mesh-schematic.png b/screenshot-mesh-schematic.png deleted file mode 100644 index 2869b5e..0000000 Binary files a/screenshot-mesh-schematic.png and /dev/null differ