diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README b/README index 9609e64..67cc52b 100644 --- a/README +++ b/README @@ -61,7 +61,7 @@ Connections 2pin terminal block To connect LED PCB - JST 2.54 XH 77-pin connector -> LEDs + GND + JST 2.54 XH 7-pin connector -> LEDs + GND For I²C modules 2x 4pin-pin female headers @@ -141,7 +141,7 @@ Bill of materials (WIP) eckstein-shop.de 6x black or white push buttons (1-6) 1x colored push button (DST) - 1x M12 Micro-C panel connector + 1x M12 Micro-C panel connector pre-wired 1x RGB LED (common cathode), diffused 3x green LEDs, diffused 6x resistors 330 Ω @@ -187,8 +187,6 @@ A device list is maintained. From the device list, 3 devices can be assigned to targets A, B, and C. -Aus der Geräteliste können 3 Geräten den Zielen A, B und C zugeordnet werden - Key codes are sent to the currently active device. If a temperature/humidity sensor is present, the measured values diff --git a/README.de b/README.de index f1cd691..2236a30 100644 --- a/README.de +++ b/README.de @@ -56,9 +56,13 @@ Verbindungskabel CPU-Platine Anschlußmöglichkeiten --------------------- + Hauptplatine für Stromversorgung +12V und NMEA2000 2pin Terminalblock + Verbindung zur LED-Platine + JST 2.54 XH 7-pin Stecker -> LEDs + GND + für I²C-Module 2x 4pin Buchsenleiste weibl. 1x qwiic-Buchse (JST_SH_BM04B-SRSS-TB_04x1.00mm) @@ -68,6 +72,12 @@ Anschlußmöglichkeiten für mechanische Taster 1x Terminalblock 8fach, 7 Tasten und GND + LED Platine + für Verbindung zur Hauptplatine + 7-pin JST-XH Kabel kann auch direkt auf die Platine gelötet werden + + für optionalen Lichtsensor + 2-Pin Buchse, liegend Bemerkungen ----------- @@ -126,7 +136,9 @@ ggf. ein E-Paper angeschlossen werden. TX D9 GPIO18 RX D10 GPIO21 -BUZZER +BUZZ Pin Remarks +------ ---------- ---------------------- +TBD GPIO43 temporär, piept allerdings beim flashen über USB und beim Reset Bauteilliste (WIP) @@ -135,16 +147,16 @@ Bauteilliste (WIP) 1x ESP32-S3 Nano (Waveshare) berrybase.de eckstein-shop.de - 6x Taster schwarz (1-6) + 6x Taster schwarz oder weiß (1-6) 1x Taster farbig (DST) - 1x M12 Micro-C Einbaubuchse + 1x M12 Micro-C Einbaubuchse vorverkabelt 1x RGB LED (gemeinsame Kathode), diffus 3x LED grün, diffus - 6x Widerstand 330 Ohm + 6x Widerstand 330 Ω 1x SN65HVD230 CAN Transceiver 1x Buzzer 12V, passiv 1x MOSFET 2N7000 - 1x Widerstand 150 Ohm + 1x Widerstand 150 Ω 1x Kabelsatz für Tasten, 0,25 mm², je 15cm lang 8x schwarz (GND) 7x farbig (Signal) @@ -156,28 +168,25 @@ Bauteilliste (WIP) 8x Platinenschraube M2,5, kurz 1x Silikondichtschnur 2mm 1x SHT31 I²C-Modul - Buchsenleiste 2,54 mm - Stiftleiste 2,54mm + 1x Buchsenleiste 2,54 mm + 1x Stiftleiste 2,54mm 2x Jumper 1x Polyfuse - Schrumpfschlauch + 1x Schrumpfschlauch Konfiguration ------------- - Instanz-Nummer, es können mehrere Keypads im System sein -- Namen des gekoppelten Geräts, an dieses werden die Tasten gesendet +- Namen der gekoppelten Geräte (bis zu 3), an diese werden die Tasten gesendet - Tastencodes Tasten 1 bis 6 +- Tastencodes Tasten 1 bis 6, langer Druck - Tastennamen -- Web-AP +- Wifi-Setup NMEA2000 -------- -Für verbesserten Zugriff auf die Geräteliste der NMEA2000-Bibliothek -wird eine erweiterte Funktion GetDeviceByIndex benötigt. -Aus diesem Grund wird mit einem Fork der Bibliothek gearbeitet. - Es werden keine eingehenden Pakete verarbeitet bis auf die ISO-Pflichtpakete Es wird eine Geräteliste geführt diff --git a/include/config.h b/include/config.h index b2286a1..b4e564f 100644 --- a/include/config.h +++ b/include/config.h @@ -53,7 +53,6 @@ static const ConfigDef configdefs[] = { {"buzEnable", ConfigType::BOOL, false}, {"buzPower", ConfigType::BYTE, uint8_t(50)}, {"tempFormat", ConfigType::CHAR, 'C'}, - {"switchBank", ConfigType::BYTE, uint8_t(0)}, {"key1", ConfigType::BYTE, uint8_t(1)}, {"key1long", ConfigType::BYTE, uint8_t(11)}, {"key2", ConfigType::BYTE, uint8_t(2)}, @@ -66,11 +65,14 @@ static const ConfigDef configdefs[] = { {"key5long", ConfigType::BYTE, uint8_t(15)}, {"key6", ConfigType::BYTE, uint8_t(6)}, {"key6long", ConfigType::BYTE, uint8_t(16)}, - {"n2kSysInst", ConfigType::BYTE, uint8_t(0)}, - {"n2kDevInst", ConfigType::BYTE, uint8_t(0)}, + {"n2kSysInst", ConfigType::BYTE, uint8_t(0)}, // 4 bits unsigned + {"n2kDevInst", ConfigType::BYTE, uint8_t(0)}, // 8 bits: 3 bits lower, 5 bits upper {"n2kDestA", ConfigType::STRING, String("none")}, + {"switchBankA", ConfigType::BYTE, uint8_t(0)}, {"n2kDestB", ConfigType::STRING, String("none")}, + {"switchBankB", ConfigType::BYTE, uint8_t(0)}, {"n2kDestC", ConfigType::STRING, String("none")}, + {"switchBankC", ConfigType::BYTE, uint8_t(0)}, {"envInterval", ConfigType::SHORT, int16_t(5)}, // no user access diff --git a/include/main.h b/include/main.h index 5b4c993..f30dc9a 100644 --- a/include/main.h +++ b/include/main.h @@ -47,7 +47,14 @@ // NMEA2000 defaults #define N2K_DEFAULT_NODEID 124 -#define NMEA2000_HEARTBEAT_INTERVAL 5000 // milliseconds +#define N2K_HEARTBEAT_INTERVAL 5000 // milliseconds +#define N2K_MANUFACTURERCODE 2046 // custom OBP +#define N2K_INDUSTRYGROUP 4 +#define N2K_DEVFUNCT 130 // Device function=Button Interface (or 190?) +#define N2K_DEVCLASS 110 // Device class=Human Interface? (or 140?) + +#define NAME_BROADCAST 0xFFFFFFFFFFFFFFFFULL // "all" +#define NAME_NONE 0x0ULL // "none" // Keys #define KEY_1 GPIO_NUM_5 // D2 @@ -74,15 +81,29 @@ // #define LEDC_TIMER_8_BIT 8 // Buzzer -#define BUZZER GPIO_NUM_43 // TX +#ifdef HARDWARE_V1 +#define BUZZER GPIO_NUM_43 // TX (bad: signals while booting) +#else +#define BUZZER GPIO_NUM_14 // A7 +#endif + +// Light sensor +#define LDR GPIO_NUM_13 // A6 // LEDS #define LED_A GPIO_NUM_3 // A2 #define LED_B GPIO_NUM_2 // A1 #define LED_C GPIO_NUM_1 // A0 + +#ifdef HARDWARE_V1 #define RGBLED_R GPIO_NUM_14 // A7 red #define RGBLED_G GPIO_NUM_13 // A6 green #define RGBLED_B GPIO_NUM_4 // A3 blue +#else +#define RGBLED_R GPIO_NUM_12 // A5 red +#define RGBLED_G GPIO_NUM_11 // A4 green +#define RGBLED_B GPIO_NUM_4 // A3 blue +#endif #define LED_USER GPIO_NUM_48 // internal red user led @@ -96,19 +117,19 @@ #define CAN_RECOVERY_PERIOD 3000 // I2C temp. sensor +#ifdef HARDWARE_V1 #define I2C_SDA GPIO_NUM_11 // A4 #define I2C_SCL GPIO_NUM_12 // A5 +#else +#define I2C_SDA GPIO_NUM_38 // D11 +#define I2C_SCL GPIO_NUM_47 // D12 +#endif + #define I2C_SPEED 100000UL // 100kHz clock speed on I2C bus // I2C addresses #define SHT31_ADDRESS 0x44 -// SPI display connector (optional) -#define SPI_MOSI GPIO_NUM_38 // D11 -#define SPI_MISO GPIO_NUM_47 // D12 -#define SPI_SCK GPIO_NUM_48 // D13 -#define SPI_CS GPIO_NUM_46 // B0 - // Button indices #define BUTTON_1 0 #define BUTTON_2 1 @@ -130,7 +151,6 @@ struct ButtonEvent { }; extern uint8_t loglevel; - extern Nmea2kTwai &NMEA2000; extern tN2kDeviceList *pN2kDeviceList; @@ -141,8 +161,6 @@ extern char audiomode; extern char destination; extern uint64_t chipid; -// extern int16_t led_brightness; -// extern int16_t rgb_brightness; extern bool ap_enabled; extern bool buz_enabled; extern uint8_t keycode[6]; diff --git a/platformio.ini b/platformio.ini index b22f6dc..fb2afdd 100644 --- a/platformio.ini +++ b/platformio.ini @@ -38,6 +38,8 @@ build_flags = -DCORE_DEBUG_LEVEL=4 # Max. possible loglevel: 0=None, 1=Error, 2=Warning, 3=Info, 4=Debug, 5=Verbose # -DLOG_LOCAL_LEVEL=5 # No limits for ESP_LOG -DCONFIG_LOG_TX_BUF_SIZE=8192 +# -DHARDWARE_V1 + -DHARDWARE_V2 -std=gnu++17 build_unflags = -std=gnu++11 diff --git a/src/main.cpp b/src/main.cpp index e498d2b..9d82c9d 100644 --- a/src/main.cpp +++ b/src/main.cpp @@ -45,6 +45,7 @@ bool ap_enabled = true; unsigned long firstStart = 0; unsigned long lastSensor = 0; unsigned long lastPrint = 0; +unsigned long lastRefresh = 0; unsigned long env_interval = 2000; @@ -74,13 +75,79 @@ float hum = 0.0; uint8_t nodeid; // NMEA2000 id on bus Nmea2kTwai &NMEA2000=*(new Nmea2kTwai(CAN_TX, CAN_RX, CAN_RECOVERY_PERIOD)); tN2kDeviceList *pN2kDeviceList; -uint8_t n2k_id[3] = { 254, 254, 254 }; // aktuelle IDs für dest A, B, C +uint8_t n2k_id[3] = { 254, 254, 254 }; // destination ids; 254 = undef. +uint64_t n2k_name[3] = { 0, 0, 0 }; // destination names +uint8_t switchbank[3] = { 0, 0, 0 }; // switch bank of destionation String processor(const String& var) { // dummy for now return ""; } +uint64_t config_to_n2kname(const String &cfgval) { + if (cfgval == "all") { + LOGD(TAG, "n2kname: Broadcast"); + return NAME_BROADCAST; + } + if (cfgval == "none") { + LOGD(TAG, "n2kname: None"); + return NAME_NONE; + } + // parse as hex string + LOGD(TAG, "n2kname: %s", cfgval.c_str()); + return strtoull(cfgval.c_str(), nullptr, 16); +} + +void refresh_n2k_ids() { + + // Debug + for (uint8_t i = 0; i < 3; i++) { + char hex_name[17]; + snprintf(hex_name, sizeof(hex_name), "%08X%08X", + (uint32_t)(n2k_name[i] >> 32), (uint32_t)(n2k_name[i] & 0xFFFFFFFF)); + LOGD(TAG, "Dest %d: name=%s", i, hex_name); + } + + if (!pN2kDeviceList->ReadResetIsListUpdated()) { + // no changes, nothing to do + return; + } + LOGD(TAG, "refreshing NMEA2000 device ids"); + for (int i = 0; i < 3; i++) { + if (n2k_name[i] == NAME_BROADCAST) { + n2k_id[i] = 255; + } else { + n2k_id[i] = 254; + } + } + uint8_t hits = 0; + for (int i = 0; i <= 252; i++) { + const tNMEA2000::tDevice *d = pN2kDeviceList->FindDeviceBySource(i); + if (d == nullptr) { + continue; + } + for (int j = 0; j < 3; j++) { + if (d->GetName() == n2k_name[j] && n2k_id[j] == 254) { + n2k_id[j] = i; + hits++; + } + } + if (hits == 3) { + // all found no need to look further + break; + } + } + + // Debug + for (uint8_t i = 0; i < 3; i++) { + char hex_name[17]; + snprintf(hex_name, sizeof(hex_name), "%08X%08X", + (uint32_t)(n2k_name[i] >> 32), (uint32_t)(n2k_name[i] & 0xFFFFFFFF)); + LOGD(TAG, "Dest %d: name=%s, id=%d", i, hex_name, n2k_id[i]); + } + +} + TaskHandle_t ledTaskHandle = NULL; TaskHandle_t sensorTaskHandle = NULL; TaskHandle_t keyTaskHandle = NULL; @@ -178,8 +245,10 @@ void cpuFreqTimerCallback(TimerHandle_t xTimer) { void setup() { Serial.begin(115200); - while (!Serial) delay(10); // verhindert Booten ohne USB-Verbindung - delay(500); + unsigned long start = millis(); + while (!Serial && millis() - start < 3000) { + delay(10); + } // Configure I/O pins @@ -213,6 +282,9 @@ void setup() { pinMode(KEY_6, INPUT_PULLUP); pinMode(KEY_DST, INPUT_PULLUP); + // Light sensor input + pinMode(LDR, INPUT); + // Early signal system activity, red while booting digitalWrite(RGBLED_R, HIGH); digitalWrite(RGBLED_G, LOW); @@ -247,6 +319,10 @@ void setup() { longcode[4] = config.getByte("key5long"); longcode[5] = config.getByte("key6long"); + switchbank[0] = config.getByte("switchBankA"); + switchbank[1] = config.getByte("switchBankB"); + switchbank[2] = config.getByte("switchBankC"); + esp_sleep_wakeup_cause_t cause = esp_sleep_get_wakeup_cause(); if (cause == ESP_SLEEP_WAKEUP_EXT0) { LOGI(TAG, "Wake up by key"); @@ -300,13 +376,9 @@ void setup() { // NMEA2000 configuration // Destinations setup, refresh in loop later - if (config.getString("n2kDestA") == "all") { - // broadcast - } else if (config.getString("n2kDestA") == "none") { - // disabled - } else { - // NAME - } + n2k_name[0] = config_to_n2kname(config.getString("n2kDestA")); + n2k_name[1] = config_to_n2kname(config.getString("n2kDestB")); + n2k_name[2] = config_to_n2kname(config.getString("n2kDestC")); NMEA2000.SetN2kCANMsgBufSize(8); NMEA2000.SetN2kCANReceiveFrameBufSize(250); @@ -330,14 +402,15 @@ void setup() { uint32_t uid; // ISO 21bit identity number devived from chipid (MAC) uid = ((chipid >> 32) ^ (chipid & 0xFFFFFFFF)) & 0x1FFFFF; - // TODO Device unique id stored in preferences - NMEA2000.SetDeviceInformation(uid, // Unique number. Use e.g. Serial number. - 130, // Device function=Button Interface (or 190?) - 110, // Device class=Human Interface? (or 140?) - 2046, // Manufacturer code (custom OBP) - 4 // Industrygoup=Marine + NMEA2000.SetDeviceInformation(uid, // Unique number. Use e.g. Serial number. + N2K_DEVFUNCT, + N2K_DEVCLASS, + N2K_MANUFACTURERCODE, + N2K_INDUSTRYGROUP ); - + uint8_t devinst = config.getByte("n2kDevInst"); + // devinst lower, devinst upper, sysinst + NMEA2000.SetDeviceInformationInstances(devinst & 0x07, devinst & 0xf8 >> 3, config.getByte("n2kSysInst")); // Debug Start // NMEA2000.SetForwardStream(&Serial); @@ -349,7 +422,7 @@ void setup() { //TODO: N2km_NodeOnly N2km_ListenAndNode? NMEA2000.SetMode(tNMEA2000::N2km_ListenAndNode, nodeid); NMEA2000.SetForwardOwnMessages(false); - NMEA2000.SetHeartbeatIntervalAndOffset(NMEA2000_HEARTBEAT_INTERVAL); + NMEA2000.SetHeartbeatIntervalAndOffset(N2K_HEARTBEAT_INTERVAL); // Features? // 130311 environment @@ -454,22 +527,29 @@ void setup() { xTimerStart(stopApTimer, 0); } + refresh_n2k_ids(); // hopefully some devices already detected } void shortBeep() { - ledcWriteTone(LEDC_BUZZER, 2500); - delay(15); - ledcWriteTone(LEDC_BUZZER, 0); + if (audiomode == 'D') { + return; + } + ledcWriteTone(LEDC_BUZZER, 2500); + delay(30); + ledcWriteTone(LEDC_BUZZER, 0); } void atariKeyclick() { - ledcWriteTone(LEDC_BUZZER, 3200); - delayMicroseconds(3000); - ledcWriteTone(LEDC_BUZZER, 0); - delayMicroseconds(800); - ledcWriteTone(LEDC_BUZZER, 3200); - delayMicroseconds(2000); - ledcWriteTone(LEDC_BUZZER, 0); + if (audiomode == 'D') { + return; + } + ledcWriteTone(LEDC_BUZZER, 3200); + delayMicroseconds(3000); + ledcWriteTone(LEDC_BUZZER, 0); + delayMicroseconds(800); + ledcWriteTone(LEDC_BUZZER, 3200); + delayMicroseconds(2000); + ledcWriteTone(LEDC_BUZZER, 0); } void print_n2k_devicelist() { @@ -506,22 +586,23 @@ void print_n2k_devicelist() { Serial.println("------------------------------"); } -// rename to: void sendSwitchBank() -// later: void send_switchbank(uint8_t keycode, uint8_t dest_id) { -void send_switchbank(uint8_t keycode) { +void send_switchbank(uint8_t keycode, uint8_t bank_id, uint8_t dest_id) { + // Seems there is no destination possible for 127502? + // + if (dest_id == 254) { + LOGW(TAG, "nothing sent: destination undefined (254)"); + return; + } tN2kMsg N2kMsg; tN2kBinaryStatus bankstatus; N2kResetBinaryStatus(bankstatus); N2kSetStatusBinaryOnStatus(bankstatus, N2kOnOff_On, keycode); - - // TODO - // Needs filled N2K device list to map NAME to current address - // N2kMsg.Destination = deviceAddress; - // - SetN2kPGN127502(N2kMsg, 0, bankstatus); + SetN2kPGN127502(N2kMsg, bank_id, bankstatus); + if (dest_id != 255) { + N2kMsg.Destination = dest_id; + } NMEA2000.SendMsg(N2kMsg); - - LOGI(TAG, "PGN127502 sent: Switch=%d", keycode); + LOGI(TAG, "PGN127502 sent: switch #%d to device #%d", keycode, dest_id); } void send_sensor_temphum(float temp_k, float hum_perc) { @@ -538,6 +619,25 @@ void send_sensor_temphum(float temp_k, float hum_perc) { SID = (SID + 1) % 256; } +void send_sensor_brightness(uint16_t value) { + // value range 0..4095 from LDR + // proprietary PGN 65280 + // device instance 8bits + // brightness 0-100%, resolution 0.1% 16bits + // 3 bytes reserved + tN2kMsg N2kMsg; + N2kMsg.SetPGN(65280); // proprietary PGN + N2kMsg.Priority = 6; + // 11bits manuf.-code, 2bits reserved (1), 3bits industry group + N2kMsg.Add2ByteUInt((N2K_MANUFACTURERCODE & 0x7FF) | (0x03 << 11) | ((N2K_INDUSTRYGROUP & 0x7) << 13)); + N2kMsg.AddByte(0); // instance not yet used now + N2kMsg.Add2ByteUInt(value * 1000UL / 4095); // resolution 0.1 + N2kMsg.AddByte(0xFF); //reserved bytes + N2kMsg.AddByte(0xFF); + N2kMsg.AddByte(0xFF); + NMEA2000.SendMsg(N2kMsg); +} + void loop() { ButtonEvent event; @@ -545,6 +645,7 @@ void loop() { if (event.buttonId == BUTTON_DST) { // destination / mode button if (event.pressType == ButtonPressType::SHORT) { + atariKeyclick(); if (mode == 'N') { // switch destination only in normal mode if (destination == 'A') { @@ -581,10 +682,12 @@ void loop() { if (mode == 'N') { // Send key code to destination atariKeyclick(); + uint8_t index = destination - 'A'; if ((event.pressType == ButtonPressType::SHORT)) { - send_switchbank(keycode[event.buttonId]); + LOGI(TAG, "Send key %d: dst index = %d", keycode[event.buttonId], index); + send_switchbank(keycode[event.buttonId], switchbank[index], n2k_id[index]); } else if ((event.pressType == ButtonPressType::MEDIUM)) { - send_switchbank(longcode[event.buttonId]); + send_switchbank(longcode[event.buttonId], switchbank[index], n2k_id[index]); } // Debug: if ((event.buttonId == BUTTON_1) @@ -654,6 +757,12 @@ void loop() { // NMEA2000.loop(); // not implemented yet NMEA2000.ParseMessages(); + if (millis() - lastRefresh >= 30000) { + // look every 30 seconds for changed devices + lastRefresh = millis(); + refresh_n2k_ids(); + } + if ((millis() - lastSensor >= env_interval) and sht_available) { lastSensor = millis(); sht.read(); @@ -662,6 +771,14 @@ void loop() { // Send environment data to NMEA2000 send_sensor_temphum(temp + 273.15, hum); + +#ifdef HARDWARE_V2 + int ldrval = analogRead(LDR); + LOGI(TAG, "LDR value =%d", ldrval); + // TODO send brightness to NMEA2000 + //send_sensor_brightness(ldrval); +#endif + } delay(1); // 1ms for FreeRTOS diff --git a/src/webserver.cpp b/src/webserver.cpp index cf67842..cb24a1b 100644 --- a/src/webserver.cpp +++ b/src/webserver.cpp @@ -13,6 +13,8 @@ static const char* TAG = "WEB"; AsyncWebServer server(80); +bool updateSuccess = false; +String updateError = ""; class EmbeddedFile; static std::map embeddedFiles; @@ -96,7 +98,9 @@ void webserver_init() { server.on("/api/checkpass", HTTP_GET, [](AsyncWebServerRequest *request) { LOGD(TAG, "checkpass called"); StaticJsonDocument<100> doc; - doc["status"] = "FAILED"; + // TODO _hash überprüfen! + // LOGD(TAG, "check hash: %s", hash); + doc["status"] = "OK"; String out; serializeJson(doc, out); request->send(200, "application/json", out); @@ -112,7 +116,6 @@ void webserver_init() { doc["instDesc2"] = config.getString("instDesc2"); doc["logLevel"] = loglevel; doc["version"] = VERSION; - doc["fwtype"] = "unknown"; // TODO ? doc["salt"] = "secret"; doc["AdminPassword"] = "********"; doc["useAdminPass"] = config.getBool("useAdminPass") ? "true" : "false"; @@ -128,7 +131,6 @@ void webserver_init() { doc["rgbBrightness"] = config.getShort("rgbBrightness"); doc["buzEnable"] = config.getBool("buzEnable") ? "true" : "false"; doc["buzPower"] = config.getByte("buzPower"); - doc["switchBank"] = config.getByte("switchBank"); doc["key1"] = keycode[BUTTON_1]; doc["key2"] = keycode[BUTTON_2]; doc["key3"] = keycode[BUTTON_3]; @@ -144,8 +146,11 @@ void webserver_init() { doc["n2kSysInst"] = config.getByte("n2kSysInst"); doc["n2kDevInst"] = config.getByte("n2kDevInst"); doc["n2kDestA"] = config.getString("n2kDestA"); + doc["switchBankA"] = config.getByte("switchBankA"); doc["n2kDestB"] = config.getString("n2kDestB"); + doc["switchBankB"] = config.getByte("switchBankB"); doc["n2kDestC"] = config.getString("n2kDestC"); + doc["switchBankC"] = config.getByte("switchBankC"); doc["envInterval"] = config.getShort("envInterval"); String out; serializeJson(doc, out); @@ -180,7 +185,9 @@ void webserver_init() { doc["cpuspeed"] = String(cpu_freq) + "MHz"; char ssid[13]; snprintf(ssid, 13, "%04X%08X", (uint16_t)(chipid >> 32), (uint32_t)chipid); - doc["chipid"] = String(ssid); + doc["ssid"] = ssid; + doc["fwtype"] = FIRMWARE_TYPE; // TODO ? + doc["chipid"] = CONFIG_IDF_FIRMWARE_CHIP_ID; // IDF chipid NOT device! doc["uptime"] = uptime_with_unit(); doc["heap"]=(long)xPortGetFreeHeapSize(); doc["temp"] = String(temp, 1); @@ -260,10 +267,20 @@ void webserver_init() { // create the response, add header, and send response LOGD(TAG, "update called"); StaticJsonDocument<100> doc; - doc["status"] = "FAILED"; + if (updateSuccess) { + doc["status"] = "OK"; + doc["message"] = "Update sucessfull, rebooting..."; + } else { + doc["status"] = "FAILED"; + doc["message"] = updateError; + } String out; serializeJson(doc, out); request->send(200, "application/json", out); + if (updateSuccess) { + delay(100); // Ensure response is sent + ESP.restart(); + } }, [](AsyncWebServerRequest *request, String filename, size_t index, uint8_t *data, size_t len, bool final) { // this is the new image upload part Serial.print("Retrieving firmware image named: "); @@ -272,14 +289,19 @@ void webserver_init() { if (index == 0) { if (! Update.begin(UPDATE_SIZE_UNKNOWN)) { Update.printError(Serial); + updateError = "Update.begin() failed"; } } if (Update.write(data, len) != len) { Update.printError(Serial); + updateError = "Update.write() failed"; } if (final) { - if (!Update.end(true)) { + if (Update.end(true)) { + updateSuccess = true; + } else { Update.printError(Serial); + updateError = "Update.end() failed"; } } diff --git a/web/config.json b/web/config.json index a2d618f..913be4c 100644 --- a/web/config.json +++ b/web/config.json @@ -197,16 +197,6 @@ "description": "Temperature format: Kelvin, Celsius or Fahrenheit\npossible values [K|C|F].", "category": "Units" }, -{ - "name": "switchBank", - "label": "Switch bank #", - "type": "number", - "default": 0, - "min": 0, - "max": 255, - "description": "The number uf switch bank the keys belong to\nRange [0 .. 255] default 0", - "category": "Keys" -}, { "name": "key1", "label": "Key 1 code", @@ -336,6 +326,16 @@ "description": "Destination device A", "category": "NMEA2000" }, +{ + "name": "switchBankA", + "label": "Switch bank A #", + "type": "number", + "default": 0, + "min": 0, + "max": 255, + "description": "The number of the switch bank for Destination A\nRange [0 .. 255] default 0", + "category": "NMEA2000" +}, { "name": "n2kDestB", "label": "Destination B", @@ -345,6 +345,16 @@ "description": "Destination device B", "category": "NMEA2000" }, +{ + "name": "switchBankB", + "label": "Switch bank B #", + "type": "number", + "default": 0, + "min": 0, + "max": 255, + "description": "The number of the switch bank for Destination B\nRange [0 .. 255] default 0", + "category": "NMEA2000" +}, { "name": "n2kDestC", "label": "Destination C", @@ -354,6 +364,16 @@ "description": "Destination device C", "category": "NMEA2000" }, +{ + "name": "switchBankC", + "label": "Switch bank C #", + "type": "number", + "default": 0, + "min": 0, + "max": 255, + "description": "The number of the switch bank for Destination C\nRange [0 .. 255] default 0", + "category": "NMEA2000" +}, { "name": "envInterval", "label":"Environment Data Interval", diff --git a/web/index.html b/web/index.html index cd445f5..656ea7d 100644 --- a/web/index.html +++ b/web/index.html @@ -44,7 +44,7 @@ if (!window.isSecureContext) {
MCU-ID - --- + ---
CPU speed