Update readme

Reviewed-on: #53

.gitignore

@@ -1,4 +1,7 @@
-/logs/*
-config.ini
-*.db
-*.log
+.pio
+.vscode/.browse.c_cpp.db*
+.vscode/c_cpp_properties.json
+.vscode/launch.json
+.vscode/ipch
+.vscode/*
+*/config.h

LICENSE

@@ -0,0 +1,674 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+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:
+
+    <program>  Copyright (C) <year>  <name of author>
+    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
+<https://www.gnu.org/licenses/>.
+
+  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
+<https://www.gnu.org/licenses/why-not-lgpl.html>.

README.md

@@ -1,80 +1,97 @@
-# README
+# Vulpes
+An ESP32-based radio orienteering controller. This repo is for
+the code. See below for hardware comments and a link.
 
-I got tired of APRS-IS websites not showing me all the paths that packets
-take, only the shortest path to IS. So this is a Python 3 tool that turns
-direwolf logs into a REST API in JSON format.
+## What
+Radio orienteering, or amateur radio direction finding (ARDF) is a 
+sport where people run around and look for hidden transmitters. One
+necessary component is a controller on each transmitter that tells
+it when and what to transmit. 
 
-## Setup
-1. Run direwolf with logging to CSV on by using `-l`. (`-L` not yet implemented).
-1. Install requirements using `pip install -r requirements.txt`.
-1. Set up database file with `python init_db.py`.
-2. Run `app.py` with either a Python call or a real WSGI server.
-You can use screen to detach the session.
-    - Default URL is http://127.0.0.1:5001
-    - Example `waitress` and `screen` scripts are included, see
-      - `api_waitress.py` and
-      - `start-aprs_api.sh`
-3. Access the API from whatever other system you want.
+This is my attempt at a simple, easy-to-use controller with a low 
+parts count. Rather than programming a microcontroller and/or 
+using DIP switches, delayed starts, and sync cables, the ESP32 development
+board lets you set up each controller using a web browser (e.g., on your
+smartphone or tablet).
 
-## Endpoints:
--`/packets` - gives the most recent packets, sorted descending by time received.
-    - argument `n` will return a specific number of packets, default 10. E.g.,
-    `https://digi.w1cdn.net/aprs_api/packets?n=1` returns one packet.
-    - argument `from` will return packets from the named station-SSID (no wildcards).
-    E.g., `https://digi.w1cdn.net/aprs_api/packets?n=1&from=W1CDN-1` returns
-    one packet from W1CDN-1.
+The [ARRL ARDF page](https://www.arrl.org/amateur-radio-direction-finding) 
+is an OK starting point for learning about radio orienteering, but 
+there are probably better ones. I've never done an RO event before, but have
+experience racing and directing adventure races.
 
-Example of an object packet sent by W1CDN-1 and digipeated by K0UND-2:
-```
-{
-      "id": 1,
-      "addresse": null,
-      "alive": null,
-      "altitude": null,
-      "comment": "Leave a message to say hi!",
-      "course": null,
-      "created": "2023-04-16 15:04:03",
-      "format": "uncompressed",
-      "frame": null,
-      "from": "W1CDN-2",
-      "gpsfixstatus": null,
-      "latitude": 47.94133333333333,
-      "longitude": -97.02683333333333,
-      "mbits": null,
-      "messagecapable": 1,
-      "message_text": null,
-      "mtype": null,
-      "object_format": null,
-      "object_name": null,
-      "path": "['K0UND-2', 'WIDE2-2']",
-      "phg": null,
-      "phg_dir": null,
-      "phg_gain": null,
-      "phg_height": null,
-      "phg_power": null,
-      "phg_range": null,
-      "posambiguity": 0,
-      "raw": "W1CDN-2>APQTH1,K0UND-2,WIDE2-2:@150321h4756.48N/09701.61W-Leave a message to say hi!",
-      "raw_timestamp": "150321h",
-      "speed": null,
-      "station_call": "W1CDN-1",
-      "station_lat": 47.9415,
-      "station_lon": -97.027,
-      "status": null,
-      "symbol": "-",
-      "symbol_table": "/",
-      "telemetry": null,
-      "timestamp": 1681657401,
-      "to": "APQTH1",
-      "tEQNS": null,
-      "tPARM": null,
-      "tUNIT": null,
-      "via": "",
-      "weather": null,
-      "wx_raw_timestamp": null
-    }
-```
+## Hardware
+I designed a simple custom printed circuit board (PCB) to make
+assumbling this controller easy to do. The repo for schematic and
+board design is here: [vulpes_hardware](https://amiok.net/gitea/W1CDN/vulpes_hardware).
 
-# Contributing
-If you want to contribute, please get in touch with me on Mastodon at
-https://mastodon.radio/@W1CDN.
+Because the ESP32 doesn't track time when it is powered off, and
+I wanted to avoid delayed starts (e.g., push a button exactly two hours
+before an event starts), an additional real-time clock (RTC) is 
+included. The RTC runs on a watch battery to track time when the
+controller is not powered on.
+
+Morse code is sent according to the parameters set up in the UI. The GPIO
+pin triggers a transistor that acts as a switch to close the key connection
+on the radio. Code is also shown on the onboard LED of the ESP32 dev board.
+
+## Software/Firmware
+Power on the controller by plugging in a micro-USB cable to a 5V 
+source (e.g., computer or battery pack). After the device is powered on,
+it will start an internal webserver and set up a wireless network called 
+"vulpes."
+
+Connect to the "vulpes" wireless network and use a web browser to navigate
+to `http://192.168.0.1` (note "http" not "http**s**"). You will see the
+settings below. Note that you will not be able to access the Internet while
+connected to this network, and each controller sets up a separate network.
+
+**Web UI**
+![screenshot of the Vulpes web UI](doc/vulpes_gui.png)
+
+### General Settings
+- **Sending Program**
+    - Off - nothing is sent
+    - Continuous - the message in `Message` is sent to the key GPIO and the
+    onboard LED
+    - Cycle - the message in `Message` is sent according to the `Cycle Settings`
+- **Message**
+    - Custom Message - a message defined in `Custom Message`
+    - MOE - transmitter 1 message (dit)
+    - MOI - transmitter 2 message (dit dit)
+    - MOS - transmitter 3 message (dit dit dit)
+    - MOH - transmitter 4 message (dit dit dit dit)
+    - MO5 - transmitter 5 message (dit dit dit dit dit)
+- **Custom Message** - a custom message to be sent when "Custom Message" is selected in `Message`
+- **Speed** - speed of Morse code transmission in words per minute (WPM)
+
+### Cycle Settings
+These settings only apply when "Cycle" is chosen under `Sending Program`
+- **Cycle Start Time** - when to start the next cycle/event (only HH:MM:SS day-of-month matter)
+- **Step Length** - how long this transmitter will transmit on each cycle
+- **Cycle ID** - what order transmitter is this (1st, 2nd, 3rd, etc.)
+- **Number of Transmitters** - how many transmitters there are
+
+### Network Settings
+The `Submit and Reboot` button only affects these fields.
+
+#### Network access
+- **Access Point** - when using as a wireless access point, the network SSID is "vulpes"
+with no password. Connect to wireless network "vulpes" and point your browser to URL http://192.168.0.1 (http, not https)
+- **Existing Wireless Network** - connect to the same existing network and use the proper IP address (useful if you have access to the router or a serial connection). If an existing network can't be connected to, an access point will be set up. 
+
+## License
+GNU GPLv3. See `LICENSE` file for details, and 
+https://choosealicense.com/licenses/ if you're like me and don't
+understand all of this stuff.
+
+## Acknowledgments
+Special thanks to [Mark Fickett](http://www.markfickett.com/) for his
+[arduinomorse](https://github.com/markfickett/arduinomorse) library and 
+[N1OIQ](https://sourceforge.net/projects/kb1oiq-ham-radio-projects/files/80m_ardf/) 
+for similar design insparation.
+
+## Questions and Contributing
+Until I get Gitea set up completely, please email me at w1cdnQRTw1cdn.net, 
+but replace "QRT" with @.
+
+I developed the C++ code in Visual Studio Code (VSCode).

api_app.py

@@ -1,187 +0,0 @@
-from flask import Flask, request, render_template
-from flask_restful import Resource, Api, reqparse, url_for
-from datetime import date, timedelta
-import configparser
-import csv
-import datetime
-import ast
-import glob
-import json, operator
-import requests
-import sqlite3
-api_app = Flask(__name__)
-api = Api(api_app)
-
-# TODO this is duplicated from kiss_and_db.py, can I avoid that?
-import constants
-
-def read_config():
-    config = configparser.ConfigParser()
-    config.read('config.ini')
-    return config
-
-def read_logs(log_folder):
-    # Read some log files
-    # UTC time, so let's look at tomorrow, today, and yesterday.
-    today = date.today()
-    yesterday = today - timedelta(days = 1)
-    tomorrow = today + timedelta(days = 1)
-    file_list = glob.glob(log_folder+str(yesterday)+"*") + \
-                glob.glob(log_folder+str(today)+"*") + \
-                glob.glob(log_folder+str(tomorrow)+"*")
-
-    # https://stackoverflow.com/a/66071962
-    json_array = []
-    for file in file_list:
-        with open(file, encoding='utf-8') as csvf:
-            csvReader = csv.DictReader(csvf)
-            for row in csvReader:
-                #add this python dict to json array
-                json_array.append(row)
-
-    # Add the call and location of this station to the packet info
-    config = read_config()
-    for item in json_array:
-        item['station_name'] = config['Settings']['station_call']
-        item['station_lat'] = config['Settings']['station_lat']
-        item['station_lon'] = config['Settings']['station_lon']
-
-    return(json_array)
-
-def dict_factory(cursor, row):
-    d = {}
-    for idx, col in enumerate(cursor.description):
-        d[col[0]] = row[idx]
-    return d
-
-def get_db_connection():
-    conn = sqlite3.connect('database.db')
-    conn.row_factory = dict_factory
-    return conn
-
-def select_all_frames(conn):
-    """
-    Query all rows in the frames table
-    :param conn: the Connection object
-    :return:
-    """
-    cur = conn.cursor()
-    cur.execute("SELECT * FROM frames")
-    rows = cur.fetchall()
-    return rows
-
-def select_all_stations(conn):
-    """
-    Query all rows in the stations table
-    :param conn: the Connection object
-    :return:
-    """
-    cur = conn.cursor()
-    cur.execute("SELECT * FROM stations ORDER BY last_heard_unix DESC")
-    rows = cur.fetchall()
-    return rows
-
-def unique_stations(conn):
-    """
-    Query all rows in the frames table
-    :param conn: the Connection object
-    :return:
-    """
-    cur = conn.cursor()
-    cur.execute('SELECT *, MAX(id), COUNT(id) FROM frames GROUP BY "from" ORDER BY MAX(id) DESC')
-    rows = cur.fetchall()
-    return rows
-
-def select_frames(conn, n, url_params):
-
-    # Should pass this a dict of fields and values (request.args)
-    # TODO clean data before sending to DB
-    # Filter out any keys that don't match db fields
-    # From https://stackoverflow.com/a/20256491
-    dictfilt = lambda x, y: dict([ (i,x[i]) for i in x if i in set(y) ])
-    field_where = dictfilt(url_params, constants.db_frames_fields)
-    # Then loop through fields to create query parts
-    # From https://stackoverflow.com/a/73512269/2152245
-    field_where_str = ' AND '.join([f'"{k}" LIKE \'{v}\'' for k,v in field_where.items()])
-
-    cur = conn.cursor()
-    # Workaround to deal with missing value in WHERE
-    field_where_query = "" if field_where_str == "" else "WHERE "+field_where_str
-    sql = 'SELECT * FROM frames {field_where_query} ORDER BY created DESC LIMIT {n}'.format(field_where_query=field_where_query, n=n)
-    print(sql)
-    cur.execute(sql)
-    rows = cur.fetchall()
-    return rows
-
-@api_app.route('/')
-def index():
-
-    # Get list of recent packets using API
-    # TODO use relative path
-    response = json.loads(requests.get("https://digi.w1cdn.net/aprs_api/packets").text)['data']
-
-    # Play with function to create station list
-    #stations = select_all_stations(get_db_connection())
-    #print(url_for("static", filename="test.txt", _external=True))
-    # this should work: stations = json.loads(requests.get(url_for("stations", _external=True)).text)['data']
-    stations = json.loads(requests.get("https://digi.w1cdn.net/aprs_api/stations").text)['data']
-    # Convert unix time to datetime on the fly because I'm lazy right now
-    for station in stations:
-        if station['last_heard_unix'] != None:
-            station['last_heard'] = datetime.datetime.utcfromtimestamp(station['last_heard_unix'])
-
-    return render_template('index.html',
-                            station_call = config['Settings']['station_call'],
-                            station_lat = config['Settings']['station_lat'],
-                            station_lon = config['Settings']['station_lon'],
-                            frames = response,
-                            stations = stations)
-
-class Packets(Resource):
-    def get(self):
-        # Handle arguments that may or may not exist
-        try:
-            n = int(request.args.get('n'))
-        except:
-            n = 10
-
-        conn = get_db_connection()
-        # Limit to number of records requested
-        data = select_frames(conn, n = n, url_params = request.args.to_dict())
-        # Sort by created date, descending (https://stackoverflow.com/a/45266808)
-        #data.sort(key=operator.itemgetter('created'), reverse=True)
-        return {'data':data}, 200  # return data and 200 OK code
-
-class Stations(Resource):
-    def get(self):
-        # Handle arguments that may or may not exist
-        try:
-            n = int(request.args.get('n'))
-        except:
-            n = 10
-
-        conn = get_db_connection()
-        # Limit to number of records requested
-        data = select_all_stations(conn)
-        # Sort by created date, descending (https://stackoverflow.com/a/45266808)
-        #data.sort(key=operator.itemgetter('created'), reverse=True)
-        return {'data':data}, 200  # return data and 200 OK code
-
-# Read config
-config = read_config()
-log_folder = config['Settings']['log_folder']
-
-# Start subprocess to watch KISS connection
-import subprocess
-#proc = subprocess.Popen(["python3","kiss_and_db.py"])
-# Combine under one process https://stackoverflow.com/a/13143013/2152245
-proc = subprocess.Popen("exec " + "python3 kiss_and_db.py", stdout=subprocess.PIPE, shell=True)
-print("kiss_and_db.py as subprocess pid "+str(proc.pid))
-
-# The packets endpoint
-api.add_resource(Packets, '/packets')
-# The stations endpoint
-api.add_resource(Stations, '/stations')
-
-if __name__ == '__main__':
-    api_app.run(debug=True, host='0.0.0.0', port=5001)  # run our Flask app

api_waitress.py

@@ -1,12 +0,0 @@
-# run.py from https://www.devdungeon.com/content/run-python-wsgi-web-app-waitress
-import os
-from waitress import serve
-from api_app import api_app  # Import your app
-
-# Run from the same directory as this script
-this_files_dir = os.path.dirname(os.path.abspath(__file__))
-os.chdir(this_files_dir)
-
-# `url_prefix` is optional, but useful if you are serving app on a sub-dir
-# behind a reverse-proxy.
-serve(api_app, host='0.0.0.0', port=5001)

config_default.ini

@@ -1,20 +0,0 @@
-[Settings]
-# Path to direwolf log folder, include trailing slash
-log_folder = logs/
-#log_folder = /home/pi/logs/direwolf/
-
-# Name and location of this station, for inclusion in the API
-station_call = W1CDN-1
-station_lat = 47.941500
-station_lon = -97.027000
-
-# How long to keep packets (frames) e.g., "2 days", "5 minutes"
-keep_time = "2 days"
-
-# KISS settings
-kiss_host = 192.168.0.30
-kiss_port = 8001
-
-# Development settings (not operational yet)
-mycall = W1CDN-15
-log_path = aprs_api.log

constants.py

@@ -1,49 +0,0 @@
-# Tuple of frames table fields
-db_frames_fields = ("id",
-"addresse",
-"alive",
-"altitude",
-"comment",
-"course",
-"created",
-"created_unix",
-"format",
-"frame",
-"from",
-"gpsfixstatus",
-"latitude",
-"longitude",
-"mbits",
-"messagecapable",
-"message_text",
-"msgNo",
-"mtype",
-"object_format",
-"object_name",
-"path",
-"phg",
-"phg_dir",
-"phg_gain",
-"phg_height",
-"phg_power",
-"phg_range",
-"posambiguity",
-"raw",
-"raw_timestamp",
-"speed",
-"station_call",
-"station_lat",
-"station_lon",
-"status",
-"subpacket",
-"symbol",
-"symbol_table",
-"telemetry",
-"timestamp",
-"to",
-"tEQNS",
-"tPARM",
-"tUNIT",
-"via",
-"weather",
-"wx_raw_timestamp")

include/README

@@ -0,0 +1,39 @@
+
+This directory is intended for project header files.
+
+A header file is a file containing C declarations and macro definitions
+to be shared between several project source files. You request the use of a
+header file in your project source file (C, C++, etc) located in `src` folder
+by including it, with the C preprocessing directive `#include'.
+
+```src/main.c
+
+#include "header.h"
+
+int main (void)
+{
+ ...
+}
+```
+
+Including a header file produces the same results as copying the header file
+into each source file that needs it. Such copying would be time-consuming
+and error-prone. With a header file, the related declarations appear
+in only one place. If they need to be changed, they can be changed in one
+place, and programs that include the header file will automatically use the
+new version when next recompiled. The header file eliminates the labor of
+finding and changing all the copies as well as the risk that a failure to
+find one copy will result in inconsistencies within a program.
+
+In C, the usual convention is to give header files names that end with `.h'.
+It is most portable to use only letters, digits, dashes, and underscores in
+header file names, and at most one dot.
+
+Read more about using header files in official GCC documentation:
+
+* Include Syntax
+* Include Operation
+* Once-Only Headers
+* Computed Includes
+
+https://gcc.gnu.org/onlinedocs/cpp/Header-Files.html

init_db.py

@@ -1,19 +0,0 @@
-import sqlite3
-
-connection = sqlite3.connect('database.db')
-
-with open('schema.sql') as f:
-    connection.executescript(f.read())
-
-cur = connection.cursor()
-
-# cur.execute("INSERT INTO posts (title, content) VALUES (?, ?)",
-#             ('First Post', 'Content for the first post')
-#             )
-#
-# cur.execute("INSERT INTO posts (title, content) VALUES (?, ?)",
-#             ('Second Post', 'Content for the second post')
-#             )
-
-connection.commit()
-connection.close()

kiss_and_db.py

@@ -1,116 +0,0 @@
-#!/usr/bin/env python3
-import os
-import sqlite3
-import aprs
-import json
-import aprslib
-import configparser
-import time
-import logging
-
-def read_config():
-    config = configparser.ConfigParser()
-    config.read('config.ini')
-    return config
-
-def get_db_connection():
-    conn = sqlite3.connect('database.db')
-    conn.row_factory = sqlite3.Row
-    return conn
-
-def main():
-
-    # Add the call and location of this station to the packet info
-    config = read_config()
-    # MYCALL = os.environ.get("MYCALL", "W1CDN")
-    # KISS_HOST = os.environ.get("KISS_HOST", "192.168.0.30")
-    # KISS_PORT = os.environ.get("KISS_PORT", "8001")
-
-    logging.basicConfig(filename=config['Settings']['log_path'], level=logging.DEBUG, \
-                        format='%(asctime)s - %(message)s')
-    logging.debug('kiss_and_db.py running')
-
-    ki = aprs.TCPKISS(host=config['Settings']['kiss_host'], port=int(config['Settings']['kiss_port']))
-    ki.start()
-
-
-    # Make a simple frame and send it
-    frame = aprs.APRSFrame.ui(
-        destination="APZ001",
-        source=config['Settings']['mycall'],
-        path=["WIDE1-1"],
-        info=b">Hello World!",
-    )
-    #ki.write(frame)
-
-    # Watch for new packets to come in
-    while True:
-        conn = get_db_connection()
-        for frame in ki.read(min_frames=1):
-            try:
-                a = aprslib.parse(str(frame))
-                a['station_call'] = config['Settings']['station_call']
-                a['station_lat'] = config['Settings']['station_lat']
-                a['station_lon'] = config['Settings']['station_lon']
-                a['created_unix'] = int(time.time())
-                print(a)
-                # Make this a string and deal with it later (probably a mistake)
-                a['path'] = str(a['path'])
-                # Store true/false as 1/0
-                if 'alive' in a:
-                    if a['alive'] == True:
-                        a['alive'] = 1
-                    else:
-                        a['alive'] = 0
-                # Build an INSERT statement based on the fields we have from the frame
-                attrib_names = ', '.join('"%s"' % w for w in a.keys())
-                attrib_values = ", ".join("?" * len(a.keys()))
-
-
-                try:
-                    # Insert data
-                    sql = "INSERT INTO frames ("+attrib_names+") VALUES ("+attrib_values+")"
-                    logging.debug(sql)
-                    conn.execute(sql, list(a.values()))
-
-                    # TODO update stations table here
-                    # Original intent was to include the id from the frames table,
-                    # but that would mean making another query.
-                    # It's not immediately needed, so I'm skipping it.
-                    # Build query
-                    # "from" is wrappedin [] because it is a reserved word and using '' doesn't work.
-                    # https://www.sqlite.org/lang_keywords.html
-                    #try:
-                    station_update = "'"+a['from'] +"', '"+ str(a['created_unix']) +"', '1'"
-                    query3 = "INSERT INTO stations ([from], last_heard_unix, count) \
-                    VALUES("+station_update+") \
-                    ON CONFLICT([from]) \
-                    DO UPDATE SET count = count + 1,\
-                                  last_heard_unix = excluded.last_heard_unix;"
-                    #print(query3)
-                    logging.debug(query3)
-                    # Insert/update data
-                    conn.execute(query3)
-
-                    conn.commit()
-                    #except:
-                     #   print("Stations table couldn't be updated.")
-
-                    # TODO remove packets that are older ('created') than a limit set in config.ini
-                    # "5 minutes" also works
-                    #conn.execute("DELETE FROM frames WHERE created < DATETIME('now', '"+config['Settings']['keep_time']+"')")
-                    #conn.commit()
-                except:
-                    #print("Error with SQLite!")
-                    logging.error("Error with SQLite!")
-            except:
-                #print("Frame could not be parsed.")
-                logging.error("Frame could not be parsed.")
-
-
-        conn.close()
-
-
-
-if __name__ == "__main__":
-    main()

lib/README

@@ -0,0 +1,46 @@
+
+This directory is intended for project specific (private) libraries.
+PlatformIO will compile them to static libraries and link into executable file.
+
+The source code of each library should be placed in a an own separate directory
+("lib/your_library_name/[here are source files]").
+
+For example, see a structure of the following two libraries `Foo` and `Bar`:
+
+|--lib
+|  |
+|  |--Bar
+|  |  |--docs
+|  |  |--examples
+|  |  |--src
+|  |     |- Bar.c
+|  |     |- Bar.h
+|  |  |- library.json (optional, custom build options, etc) https://docs.platformio.org/page/librarymanager/config.html
+|  |
+|  |--Foo
+|  |  |- Foo.c
+|  |  |- Foo.h
+|  |
+|  |- README --> THIS FILE
+|
+|- platformio.ini
+|--src
+   |- main.c
+
+and a contents of `src/main.c`:
+```
+#include <Foo.h>
+#include <Bar.h>
+
+int main (void)
+{
+  ...
+}
+
+```
+
+PlatformIO Library Dependency Finder will find automatically dependent
+libraries scanning project source files.
+
+More information about PlatformIO Library Dependency Finder
+- https://docs.platformio.org/page/librarymanager/ldf.html

platformio.ini

@@ -0,0 +1,24 @@
+; PlatformIO Project Configuration File
+;
+;   Build options: build flags, source filter
+;   Upload options: custom upload port, speed and extra flags
+;   Library options: dependencies, extra library storages
+;   Advanced options: extra scripting
+;
+; Please visit documentation for the other options and examples
+; https://docs.platformio.org/page/projectconf.html
+
+[env:esp32doit-devkit-v1]
+platform = espressif32
+board = esp32doit-devkit-v1
+framework = arduino
+upload_speed = 921600
+monitor_speed = 115200
+monitor_filters = esp32_exception_decoder
+build_type = debug
+lib_deps = 
+	me-no-dev/AsyncTCP@^1.1.1
+	me-no-dev/ESP Async WebServer@^1.2.3
+	https://github.com/adafruit/RTClib.git
+	adafruit/Adafruit BusIO@^1.14.3
+	erropix/ESP32 AnalogWrite@^0.2

requirements.txt

@@ -1,8 +0,0 @@
-flask
-flask_restful
-aprs3
-kiss3
-kiss
-aprslib
-sqlite3
-json

schema.sql

@@ -1,61 +0,0 @@
-DROP TABLE IF EXISTS frames;
-
-CREATE TABLE frames (
-    id INTEGER PRIMARY KEY AUTOINCREMENT,
-    addresse TEXT,
-    alive INT,
-    altitude REAL,
-    comment TEXT,
-    course REAL,
-    created TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
-    created_unix INT,
-    format TEXT,
-    frame TEXT,
-    "from" TEXT,
-    gpsfixstatus TEXT,
-    latitude REAL,
-    longitude REAL,
-    mbits INT,
-    messagecapable INT,
-    message_text TEXT,
-    msgNo INT,
-    mtype TEXT,
-    object_format TEXT,
-    object_name TEXT,
-    path TEXT,
-    phg REAL,
-    phg_dir TEXT,
-    phg_gain REAL,
-    phg_height REAL,
-    phg_power REAL,
-    phg_range REAL,
-    posambiguity INT,
-    raw TEXT,
-    raw_timestamp TEXT,
-    speed REAL,
-    station_call TEXT,
-    station_lat REAL,
-    station_lon REAL,
-    status TEXT,
-    subpacket TEXT,
-    symbol TEXT,
-    symbol_table TEXT,
-    telemetry TEXT,
-    timestamp INT,
-    "to" TEXT,
-    tEQNS TEXT,
-    tPARM TEXT,
-    tUNIT TEXT,
-    via TEXT,
-    weather TEXT,
-    wx_raw_timestamp TIMESTAMP
-);
-
-CREATE TABLE "stations" (
-	"id"	INTEGER NOT NULL UNIQUE,
-	"from"	TEXT UNIQUE,
-	"frames_id"	INTEGER,
-	"last_heard_unix"	INTEGER,
-	"count"	INTEGER,
-	PRIMARY KEY("id" AUTOINCREMENT)
-);

src/config.h.default

@@ -0,0 +1,2 @@
+#define WIFI_SSID "wifi_name"
+#define WIFI_PASSWORD "wifi_pass"

src/main.cpp

@@ -0,0 +1,690 @@
+/*********
+  Rui Santos
+  Complete project details at https://RandomNerdTutorials.com/esp32-esp8266-input-data-html-form/
+  
+  Permission is hereby granted, free of charge, to any person obtaining a copy
+  of this software and associated documentation files.
+  
+  The above copyright notice and this permission notice shall be included in all
+  copies or substantial portions of the Software.
+*********/
+
+// include wifi password
+#include "config.h"
+#include <Arduino.h>
+#include <WiFi.h>
+#include <AsyncTCP.h>
+#include <SPIFFS.h>
+#include <Preferences.h>
+#include "morse.h"
+#include <Adafruit_BusIO_Register.h> // for DS3231
+#include <RTClib.h> // for DS3231
+#include <string>
+
+// download zip from https://github.com/me-no-dev/ESPAsyncWebServer and install.
+#include <ESPAsyncWebServer.h>
+
+AsyncWebServer server(80);
+
+// Assign output variables to GPIO pins
+//LED_BUILTIN for ESP32 onboard LED, 32 for transmitter keyer
+const int keyer = 32;
+const int blinker = LED_BUILTIN;
+
+RTC_DS3231 rtc; // set up RTC
+const int alarmPin = 4; // pin to monitor for RTC alarms
+
+// Network options: "0" for existing netowrk, "1" to be an access point
+const int network = 1;
+// Connect to existing network
+// Read from config.h
+//const char* ssid = WIFI_SSID;
+//const char* password = WIFI_PASSWORD;
+// Create a new access point
+// Replace with your desired network credentials
+const char* ssid_ap     = "vulpes";
+const char* password_ap = NULL; //"123456789"; //NULL is empty
+IPAddress local_ip(192,168,0,1);
+IPAddress gateway(192,168,0,1);
+IPAddress subnet(255,255,255,0);
+
+const char* PARAM_SEND = "inputSend";
+const char* PARAM_WPM = "inputWPM";
+const char* PARAM_MSG = "inputMsg";
+const char* PARAM_CMSG = "inputCustomMsg";
+const char* PARAM_FLOAT = "inputFloat";
+const char* PARAM_TIME = "inputTimeUnix";
+const char* PARAM_START = "inputStartTimeUnix";
+const char* PARAM_RUNNING = "programRunning";
+const char* PARAM_STEPLENGTH = "inputStepLength";
+const char* PARAM_CYCLEID = "inputCycleID";
+const char* PARAM_NTRANS = "inputNtransmitters";
+const char* PARAM_NETWORK = "inputNetwork";
+const char* PARAM_SSID = "inputSSID";
+const char* PARAM_PASSWORD = "inputPassword";
+
+// Global variables
+int yourInputSend;
+int yourInputWPM;
+int yourInputMsg;
+int yourInputMsg_old; // to save previous state and check changes
+String yourInputCustomMsg;
+float yourInputFloat;
+uint32_t yourInputTime; //to keep time
+uint32_t yourInputStartTimeUnix;
+bool startProgram;
+bool programRunning;
+int yourInputStepLength;
+int yourInputCycleID;
+int yourInputNtransmitters;
+int yourInputNetwork;
+String yourInputSSID;
+String yourInputPassword;
+long start_millis = 0;
+long stop_millis = 0;
+long pause_until_millis = 0;
+
+// HTML web page to handle input fields 
+const char index_html[] PROGMEM = R"rawliteral(
+<!DOCTYPE HTML><html><head>
+  <link rel="icon" href="data:,">
+  <title>ESP Input Form</title>
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <script type="text/javascript">
+    // Utility from https://webreflection.medium.com/using-the-input-datetime-local-9503e7efdce
+    Date.prototype.toDatetimeLocal = function toDatetimeLocal() {
+    var
+      date = this,
+      ten = function (i) {
+        return (i < 10 ? '0' : '') + i;
+      },
+      YYYY = date.getFullYear(),
+      MM = ten(date.getMonth() + 1),
+      DD = ten(date.getDate()),
+      HH = ten(date.getHours()),
+      II = ten(date.getMinutes()),
+      SS = ten(date.getSeconds())
+    ;
+    return YYYY + '-' + MM + '-' + DD + 'T' +
+             HH + ':' + II + ':' + SS;
+    }
+
+    // Submit timestamps as unix seconds when form is submitted
+    var putDate = function(form) {
+      form.inputTimeUnix.value = Math.floor(Date.now() / 1000);// - new Date().getTimezoneOffset()*60;
+      form.inputStartTimeUnix.value = ((Date.parse(js_start_time_unix_entry.value))/1000);
+      //document.getElementById("js_start_time_unix").value = ((Date.parse(js_start_time_unix_entry.value))/1000);
+    }
+    // Fill in page values
+    window.onload = function() {
+      s = %inputStartTimeUnix%;
+      current_start = new Date(s * 1000);
+      document.getElementById('current-start').innerHTML = current_start.toLocaleString();
+      // Show the local time as a string
+      local_time_unix = new Date().toLocaleString();//toUTCString();
+      document.getElementById('local-time-unix').innerHTML = local_time_unix.toString();
+      // Fill in the start time field as local time
+      document.getElementById('js_start_time_unix_entry').value = current_start.toDatetimeLocal();
+
+      // Fill in the other form fields
+      document.getElementById("send-program").value = %inputSend%;
+      document.getElementById("message").value = %inputMsg%;
+      document.getElementById("network").value = %inputNetwork%;
+    }
+
+  </script></head><body>
+  <h1>Vulpes Radio Orienteering Controller</h1>
+  <p>Local time: <b><span id=local-time-unix></span></b>. If this is incorrect, your browser is not providing the correct time 
+  (<a href="https://support.mozilla.org/en-US/questions/1297208">Firefox example</a>).</p>
+
+  <form action="/get"  onsubmit="putDate(this);" accept-charset=utf-8>
+    <h2>General Settings</h2>
+    <p>Sending program:
+    <select name="inputSend" id="send-program">
+      <option value="0" >0 - Off</option>
+      <option value="1">1 - Continuous</option>
+      <option value="2">2 - Cycle</option>
+    </select><br>
+
+    Message:
+    <select name="inputMsg" id="message">
+      <option value="0">0 - Custom Message</option>
+      <option value="1">1 - MOE</option>
+      <option value="2">2 - MOI</option>
+      <option value="3">3 - MOS</option>
+      <option value="4">4 - MOH</option>
+      <option value="5">5 - MO5</option>
+    </select><br>
+
+    Custom message: <input type="text" name="inputCustomMsg" value = "%inputCustomMsg%"><br>
+    
+    Speed: <input type="number" name="inputWPM" value = %inputWPM%> WPM
+    </p>
+
+    <h2>Cycle Settings</h2>
+    <p>Only applies when <em>Sending Program</em> is set to "2 - Cycle". You cannot set a cycle start date more than a month in advance.</p>
+    <p>Cycle start time <input type="datetime-local" id="js_start_time_unix_entry" /><br>
+    Current value: <b><span id=current-start></span></b>
+    
+    <!-- JS converts the entered start time to a unix timestamp, and copies that value
+    to this hidden field so the user doesn't have to see it. -->
+    <input type="hidden" name="inputStartTimeUnix" id="js_start_time_unix" /></p>
+    <p>
+      Step length: <input type="number" name="inputStepLength" min=1000 step=1000 value = %inputStepLength%> milliseconds <br>
+      Cycle ID: <input type="number" name="inputCycleID" min=1 value = %inputCycleID%><br>
+      Number of transmitters: <input type="number" name="inputNtransmitters" min=1 value = %inputNtransmitters%><br>
+    </p>
+    
+    <!-- This field is hidden so people don't change the submit time (it will be wrong).
+    The value is automatically filled in with JS. -->
+    <input type="hidden" name="inputTimeUnix" id="js_time_unix">
+
+    <!-- Extra fields just in case I need them -->  
+    <input type="hidden" name="inputFloat" value = %inputFloat%>
+
+    <input type="submit" value="Submit"">
+  </form>
+  <iframe style="display:none" name="hidden-form" id="hidden-form"></iframe>
+
+  <br><hr>
+  <h2>Network Settings</h2>
+  <form onsubmit="return confirm('Are you sure you want to change the network and reboot?');" action="/get2" accept-charset=utf-8>
+    <p>Network Access: 
+    <select name="inputNetwork" id="network">
+      <option value="0">Access Point</option>
+      <option value="1">Existing Wireless Network (advanced)</option>
+    </select><br>
+    Existing Wireless Network SSID: <input type="text" name="inputSSID" value = "%inputSSID%"><br>
+    Existing Wireless Network Password: <input type="password" name="inputPassword" value = "%inputPassword%"><br>
+    </p><p>
+    Access Point: Connect to wireless network "vulpes" and point your browser to URL <a href="http://192.168.0.1">http://192.168.0.1</a> (http, not http<b>s</b>)<br>
+    Existing Network (advanced): Connect to the same existing network and use the proper IP address (useful if you have access to the router or a serial connection).<br>
+    If an existing network can't be connected to, an access point will be set up.
+    </p>
+  <input type="submit" value="Submit and Reboot">
+  </form>
+
+  <iframe style="display:none" name="hidden-form02" id="hidden-form02"></iframe>
+  <script type="text/javascript">
+    
+  </script>
+</body></html>)rawliteral";
+
+
+void notFound(AsyncWebServerRequest *request) {
+  request->send(404, "text/plain", "Not found");
+}
+
+String readFile(fs::FS &fs, const char * path){
+  //Serial.printf("Reading file: %s\r\n", path);
+  File file = fs.open(path, "r");
+  if(!file || file.isDirectory()){
+    Serial.println("- empty file or failed to open file");
+    return String();
+  }
+  //Serial.println("- read from file:");
+  String fileContent;
+  while(file.available()){
+    fileContent+=String((char)file.read());
+  }
+  file.close();
+  //Serial.println(fileContent);
+  return fileContent;
+}
+
+void writeFile(fs::FS &fs, const char * path, const char * message){
+  Serial.printf("Writing file: %s\r\n", path);
+  File file = fs.open(path, "w");
+  if(!file){
+    Serial.println("- failed to open file for writing");
+    return;
+  }
+  if(file.print(message)){
+    Serial.println("- file written");
+  } else {
+    Serial.println("- write failed");
+  }
+  file.close();
+}
+
+// Replaces placeholder in web UI with stored values
+String processor(const String& var){
+  //Serial.println(var);
+  if(var == "inputCustomMsg"){
+    return readFile(SPIFFS, "/inputCustomMsg.txt");
+  }
+  else if(var == "inputSend"){
+    return readFile(SPIFFS, "/inputSend.txt");
+  }
+  else if(var == "inputWPM"){
+    return readFile(SPIFFS, "/inputWPM.txt");
+  }
+  else if(var == "inputMsg"){
+    return readFile(SPIFFS, "/inputMsg.txt");
+  }
+  else if(var == "inputStepLength"){
+    return readFile(SPIFFS, "/inputStepLength.txt");
+  }
+  else if(var == "inputCycleID"){
+    return readFile(SPIFFS, "/inputCycleID.txt");
+  }
+  else if(var == "inputNtransmitters"){
+    return readFile(SPIFFS, "/inputNtransmitters.txt");
+  }
+  else if(var == "inputNetwork"){
+    return readFile(SPIFFS, "/inputNetwork.txt");
+  }
+  else if(var == "inputSSID"){
+    return readFile(SPIFFS, "/inputSSID.txt");
+  }
+  else if(var == "inputPassword"){
+    return readFile(SPIFFS, "/inputPassword.txt");
+  }
+  else if(var == "inputFloat"){
+    return readFile(SPIFFS, "/inputFloat.txt");
+  } else if(var == "inputStartTimeUnix"){
+    // Webform breaks if this value is empty.
+    String temp = readFile(SPIFFS, "/inputStartTimeUnix.txt");
+    if(temp == ""){
+      temp = "0";
+    }
+    return temp;
+  } 
+  return String();
+}
+
+// https://www.thegeekpub.com/276838/how-to-reset-an-arduino-using-code/
+void(* resetFunc) (void) = 0; // create a standard reset function
+
+// Set up arduinomorse pin and default WPM
+LEDMorseSender sender_blink(blinker, 10.0f); //f makes it a float
+LEDMorseSender sender_key(keyer, 10.0f);
+
+//================================================================================
+// setup(): stuff that only gets done once, after power up (KB1OIQ's description)
+//================================================================================
+void setup() {
+  Serial.begin(115200);
+
+  // Get arduinomorse ready to go
+  sender_blink.setup();
+  sender_key.setup();
+
+  pinMode(alarmPin, INPUT_PULLUP); // Set alarm pin as pullup
+
+  if (! rtc.begin()) {
+    Serial.println("Couldn't find RTC");
+    Serial.flush();
+    while (1) delay(10);
+  }
+
+  if (rtc.lostPower()) {
+    Serial.println("RTC lost power, let's set the time!");
+    // When time needs to be set on a new device, or after a power loss, the
+    // following line sets the RTC to the date & time this sketch was compiled
+    rtc.adjust(DateTime(__DATE__, __TIME__));
+    // This line sets the RTC with an explicit date & time, for example to set
+    // January 21, 2014 at 3am you would call:
+    //rtc.adjust(DateTime(2023, 9, 2, 17, 32, 0));
+  }
+
+  // Report the RTC time after waiting two seconds
+  // https://amiok.net/gitea/W1CDN/vulpes/issues/50#issuecomment-1376
+  Serial.println("Wait 2s for RTC");
+  delay(2000); 
+  Serial.println("RTC time on startup: ");
+  Serial.println(rtc.now().unixtime());
+  Serial.println(rtc.now().timestamp());
+
+  // Are there any RTC alarms set?
+  DateTime alarm_one = rtc.getAlarm1(); // Get the current time
+  char buff[] = "Alarm 1 set for at hh:mm:ss DDD, DD MMM YYYY";
+  Serial.print(alarm_one.toString(buff));
+  Serial.println(" (only HH:MM:SS day-of-month are accurate)");
+
+  // Initialize the output variables as outputs
+  pinMode(keyer, OUTPUT);
+  pinMode(blinker, OUTPUT);
+  // Set outputs to LOW
+  digitalWrite(keyer, LOW);
+  digitalWrite(blinker, LOW);
+
+  // Initialize SPIFFS
+  SPIFFS.begin(true);
+    if(!SPIFFS.begin(true)){
+      Serial.println("An Error has occurred while mounting SPIFFS");
+      return;
+    }
+    if(!SPIFFS.begin()){
+      Serial.println("An Error has occurred while mounting SPIFFS");
+      return;
+    }
+
+  // Read in existing data
+  yourInputCustomMsg = readFile(SPIFFS, "/inputCustomMsg.txt");
+  yourInputSend = readFile(SPIFFS, "/inputSend.txt").toInt();
+  yourInputWPM = readFile(SPIFFS, "/inputWPM.txt").toFloat();
+  yourInputMsg = readFile(SPIFFS, "/inputMsg.txt").toInt();
+  yourInputFloat = readFile(SPIFFS, "/inputFloat.txt").toFloat();
+  yourInputStartTimeUnix = readFile(SPIFFS, "/inputStartTimeUnix.txt").toInt();
+  yourInputStepLength = readFile(SPIFFS, "/inputStepLength.txt").toInt();
+  yourInputCycleID = readFile(SPIFFS, "/inputCycleID.txt").toInt();
+  yourInputNtransmitters = readFile(SPIFFS, "/inputNtransmitters.txt").toInt();
+  yourInputNetwork = readFile(SPIFFS, "/inputNetwork.txt").toInt();
+  yourInputSSID = readFile(SPIFFS, "/inputSSID.txt");
+  yourInputPassword = readFile(SPIFFS, "/inputPassword.txt");
+  // Set WPM from saved value
+  sender_blink.setWPM(yourInputWPM);
+  sender_key.setWPM(yourInputWPM);
+
+  // On restart, keep doing what you were doing before
+  yourInputMsg_old = yourInputMsg;
+  if(yourInputMsg == 0){
+    sender_blink.setMessage(yourInputCustomMsg);
+    sender_key.setMessage(yourInputCustomMsg);
+  } else if(yourInputMsg == 1){
+    sender_blink.setMessage(String("moe "));
+    sender_key.setMessage(String("moe "));
+  } else if(yourInputMsg == 2){
+    sender_blink.setMessage(String("moi "));
+    sender_key.setMessage(String("moi "));
+  } else if(yourInputMsg == 3){
+    sender_blink.setMessage(String("mos "));
+    sender_key.setMessage(String("mos "));
+  } else if(yourInputMsg == 4){
+    sender_blink.setMessage(String("moh "));
+    sender_key.setMessage(String("moh "));
+  } else if(yourInputMsg == 5){
+    sender_blink.setMessage(String("mo5 "));
+    sender_key.setMessage(String("mo5 "));
+  }
+
+  WiFi.setHostname("vulpes");
+  if (yourInputNetwork == 1){
+    // Attach to existing wifi
+    WiFi.mode(WIFI_STA);
+    const char* ssid_char = yourInputSSID.c_str();
+    const char* password_char = yourInputPassword.c_str();
+    WiFi.begin(ssid_char, password_char);
+    if (WiFi.waitForConnectResult() != WL_CONNECTED) {
+      Serial.println("WiFi Failed! Setting up access point 'vulpes'...");
+      // If you fail to connect, act as new access point
+      WiFi.disconnect(true);
+      WiFi.softAPConfig(local_ip, gateway, subnet);
+      WiFi.softAP(ssid_ap, password_ap);
+      // update the file so the webform is right
+      writeFile(SPIFFS, "/inputNetwork.txt", "0");
+      //return;
+    }
+    Serial.print("IP Address: ");
+    Serial.println(WiFi.localIP());
+  } else if (yourInputNetwork == 0){
+    // Act as new access point
+    WiFi.softAPConfig(local_ip, gateway, subnet);
+    WiFi.softAP(ssid_ap, password_ap);
+  }
+
+  
+
+  // Send web page with input fields to client
+  server.on("/", HTTP_GET, [](AsyncWebServerRequest *request){
+    request->send_P(200, "text/html", index_html, processor);
+  });
+
+  // Form 1 
+  // Send a GET request to <ESP_IP>/get?inputCustomMsg=<inputMessage>
+  server.on("/get", HTTP_GET, [] (AsyncWebServerRequest *request) {
+    String inputMessage;
+    // GET inputCustomMsg value on <ESP_IP>/get?inputCustomMsg=<inputMessage>
+    if (request->hasParam(PARAM_CMSG)) {
+      inputMessage = request->getParam(PARAM_CMSG)->value();
+      // arduinomorse needs lowercase characters
+      std::transform(inputMessage.begin(), inputMessage.end(), inputMessage.begin(), ::tolower);
+      writeFile(SPIFFS, "/inputCustomMsg.txt", inputMessage.c_str());
+      yourInputCustomMsg = inputMessage;
+      
+    }
+    // GET inputSend value on <ESP_IP>/get?inputSend=<inputMessage>
+    if (request->hasParam(PARAM_SEND)) {
+      inputMessage = request->getParam(PARAM_SEND)->value();
+      writeFile(SPIFFS, "/inputSend.txt", inputMessage.c_str());
+      yourInputSend = inputMessage.toInt();
+      // if not running a program, set the program running off
+      //if(yourInputSend != 2){
+        // Cease all programs on new input
+        startProgram = false;
+        programRunning = false;
+      //}
+    }
+    // GET inputWPM value on <ESP_IP>/get?inputWPM=<inputMessage>
+    if (request->hasParam(PARAM_WPM)) {
+      inputMessage = request->getParam(PARAM_WPM)->value();
+      writeFile(SPIFFS, "/inputWPM.txt", inputMessage.c_str());
+      yourInputWPM = inputMessage.toFloat();
+      sender_blink.setWPM(yourInputWPM);
+      sender_key.setWPM(yourInputWPM);
+    }
+    // GET inputMsg value on <ESP_IP>/get?inputMsg=<inputMessage>
+    if (request->hasParam(PARAM_MSG)) {
+      inputMessage = request->getParam(PARAM_MSG)->value();
+      writeFile(SPIFFS, "/inputMsg.txt", inputMessage.c_str());
+      // save previous state
+      yourInputMsg_old = yourInputMsg;
+      yourInputMsg = inputMessage.toInt();
+
+      // Check the message every time the form is submitted.
+      if(yourInputMsg == 0){
+        sender_blink.setMessage(yourInputCustomMsg);
+        sender_key.setMessage(yourInputCustomMsg);
+      } else if(yourInputMsg == 1){
+        sender_blink.setMessage(String("moe "));
+        sender_key.setMessage(String("moe "));
+      } else if(yourInputMsg == 2){
+        sender_blink.setMessage(String("moi "));
+        sender_key.setMessage(String("moi "));
+      } else if(yourInputMsg == 3){
+        sender_blink.setMessage(String("mos "));
+        sender_key.setMessage(String("mos "));
+      } else if(yourInputMsg == 4){
+        sender_blink.setMessage(String("moh "));
+        sender_key.setMessage(String("moh "));
+      } else if(yourInputMsg == 5){
+        sender_blink.setMessage(String("mo5 "));
+        sender_key.setMessage(String("mo5 "));
+      }
+    }
+    // GET inputStepLength value on <ESP_IP>/get?inputStepLength=<inputMessage>
+    if (request->hasParam(PARAM_STEPLENGTH)) {
+      inputMessage = request->getParam(PARAM_STEPLENGTH)->value();
+      writeFile(SPIFFS, "/inputStepLength.txt", inputMessage.c_str());
+      yourInputStepLength = inputMessage.toInt();
+    }
+    // GET inputCycleID value on <ESP_IP>/get?inputCycleID=<inputMessage>
+    if (request->hasParam(PARAM_CYCLEID)) {
+      inputMessage = request->getParam(PARAM_CYCLEID)->value();
+      writeFile(SPIFFS, "/inputCycleID.txt", inputMessage.c_str());
+      yourInputCycleID = inputMessage.toInt();
+    }
+    // GET inputNtransmitters value on <ESP_IP>/get?inputNtransmitters=<inputMessage>
+    if (request->hasParam(PARAM_NTRANS)) {
+      inputMessage = request->getParam(PARAM_NTRANS)->value();
+      writeFile(SPIFFS, "/inputNtransmitters.txt", inputMessage.c_str());
+      yourInputNtransmitters = inputMessage.toInt();
+    }
+    // GET inputTimeUnix value on <ESP_IP>/get?inputTimeUnix=<inputMessage>
+    if (request->hasParam(PARAM_TIME)) {
+      inputMessage = request->getParam(PARAM_TIME)->value();
+      //https://stackoverflow.com/a/22733127/2152245
+      yourInputTime = atol(inputMessage.c_str());
+      Serial.print("yourInputTime: ");
+      Serial.println(yourInputTime);
+      // update the RTC time
+      rtc.adjust(DateTime(yourInputTime));
+      DateTime now = rtc.now();
+      // Might work to fix random errors? If date is far in the future,
+      // try to update again.
+      // replace if with while if you want it to try a bunch...
+      if(now.year() > 2040){
+        Serial.print("Year is ");
+        Serial.println(now.year());
+        Serial.println("RTC can't set time. Trying again.");
+        rtc.adjust(DateTime(yourInputTime));
+      }
+
+      Serial.print("UTC time from browser: ");
+      Serial.print(now.year(), DEC);
+      Serial.print('/');
+      Serial.print(now.month(), DEC);
+      Serial.print('/');
+      Serial.print(now.day(), DEC);
+      Serial.print(" (");
+      Serial.print(now.dayOfTheWeek());
+      Serial.print(") ");
+      Serial.print(now.hour(), DEC);
+      Serial.print(':');
+      Serial.print(now.minute(), DEC);
+      Serial.print(':');
+      Serial.print(now.second(), DEC);
+      Serial.println();
+
+      Serial.print("rtc.now().unixtime(): ");
+      Serial.println(rtc.now().unixtime());
+    }
+    // GET inputFloat value on <ESP_IP>/get?inputFloat=<inputMessage>
+    if (request->hasParam(PARAM_FLOAT)) {
+      inputMessage = request->getParam(PARAM_FLOAT)->value();
+      writeFile(SPIFFS, "/inputFloat.txt", inputMessage.c_str());
+      yourInputFloat = inputMessage.toFloat();
+    }
+    // GET inputStartTimeUnix value on <ESP_IP>/get?inputStartTimeUnix=<inputMessage>
+    if (request->hasParam(PARAM_START)) {
+      inputMessage = request->getParam(PARAM_START)->value();
+      Serial.println(inputMessage);
+      // if a start time isn't entered, don't overwrite the old one
+      //if(!(inputMessage != NULL && inputMessage[0] == '\0')){
+        writeFile(SPIFFS, "/inputStartTimeUnix.txt", inputMessage.c_str());
+        yourInputStartTimeUnix = atol(inputMessage.c_str());
+      //}
+      Serial.println(yourInputStartTimeUnix);
+      
+      // Use alarm built into RTC
+      rtc.setAlarm1(DateTime(yourInputStartTimeUnix), DS3231_A1_Date);
+      //rtc.setAlarm1(DateTime(2020, 6, 25, 15, 34, 0), DS3231_A2_Date);
+      DateTime alarm_one = rtc.getAlarm1(); // Get the current alarm time
+      char buff[] = "Alarm 1 set for at hh:mm:ss DDD, DD MMM YYYY";
+      Serial.print(alarm_one.toString(buff));
+      Serial.println(" (only HH:MM:SS day-of-month are accurate)");
+    }
+    // https://techtutorialsx.com/2018/01/14/esp32-arduino-http-server-external-and-internal-redirects/
+    request->redirect("/");
+  });
+
+  // Form 2
+  server.on("/get2", HTTP_GET, [] (AsyncWebServerRequest *request) {
+    String inputMessage;
+    /// GET inputNetwork value on <ESP_IP>/get2?inputNetwork=<inputMessage>
+    if (request->hasParam(PARAM_NETWORK)) {
+      inputMessage = request->getParam(PARAM_NETWORK)->value();
+      writeFile(SPIFFS, "/inputNetwork.txt", inputMessage.c_str());
+      yourInputNetwork = inputMessage.toInt();
+      Serial.println(yourInputNetwork);
+    }
+    /// GET inputSSID value on <ESP_IP>/get2?inputSSID=<inputMessage>
+    if (request->hasParam(PARAM_SSID)) {
+      inputMessage = request->getParam(PARAM_SSID)->value();
+      writeFile(SPIFFS, "/inputSSID.txt", inputMessage.c_str());
+      yourInputSSID = inputMessage;
+      Serial.println(yourInputSSID);
+    }
+    /// GET inputNetwork value on <ESP_IP>/get2?inputNetwork=<inputMessage>
+    if (request->hasParam(PARAM_PASSWORD)) {
+      inputMessage = request->getParam(PARAM_PASSWORD)->value();
+      writeFile(SPIFFS, "/inputPassword.txt", inputMessage.c_str());
+      yourInputPassword = inputMessage;
+      Serial.println(yourInputPassword);
+    }
+    // Shouldn't need to do this if using this form.
+    request->redirect("/");
+
+    resetFunc();  // reset the Arduino via software function
+  });
+
+  server.onNotFound(notFound);
+  server.begin();
+
+}
+
+void loop() {
+
+  // This statement from https://github.com/garrysblog/DS3231-Alarm-With-Adafruit-RTClib-Library/blob/master/DS3231-RTClib-Adafruit-Alarm-Poll-alarmFired/DS3231-RTClib-Adafruit-Alarm-Poll-alarmFired.ino
+  // Check if alarm by polling SQW alarm pin
+  if((yourInputSend == 2) & (digitalRead(alarmPin) == LOW)) {
+    // Print current time and date
+    DateTime now = rtc.now(); // Get the current time
+    char buff[] = "Alarm triggered at hh:mm:ss DDD, DD MMM YYYY";
+    Serial.println(now.toString(buff));
+    startProgram = true;
+
+    // Disable and clear alarm
+    rtc.clearAlarm(1); 
+    rtc.clearAlarm(2); // clear the other one just in case 
+  }
+
+  // Once alarm has started the program, set things up to run
+  if(startProgram == true){
+    //Serial.println("Start sending");
+    start_millis = millis() + ((yourInputCycleID - 1) * yourInputStepLength);
+    stop_millis = start_millis + yourInputStepLength;
+    if(yourInputCycleID == 1){
+      pause_until_millis = stop_millis + (yourInputStepLength * (yourInputNtransmitters - 1)); 
+    } else {
+    // Subtract 2 rather than 1 here to account for start_millis duration at beginning of repeat.
+      pause_until_millis = stop_millis + (yourInputStepLength * (yourInputNtransmitters - 2)); 
+    }
+    programRunning = true;
+    startProgram = false;
+  }
+
+  // if you want to send continuous code, and it's not sending, then start it up
+  if((yourInputSend == 1)){
+    // If not sending, start sending. Yes, these need to be separate statements.
+    if (!sender_blink.continueSending()){
+          sender_blink.startSending();
+      }
+    if (!sender_key.continueSending()){
+          sender_key.startSending();
+      }
+  // if you want to send cycle code and it's not sending, then start it up
+  } else if((yourInputSend == 2) & (programRunning == true)){
+      if((millis() < start_millis)){
+        // Shut the pin off manually
+        digitalWrite(blinker, LOW);
+        digitalWrite(keyer, LOW);
+      } else if((millis() >= start_millis) & (millis() <= stop_millis)){
+        // If not sending, start sending. Yes, these need to be separate statements
+        // for the blinker and keyer.
+        if (!sender_blink.continueSending()){
+              sender_blink.startSending();
+          }
+        if (!sender_key.continueSending()){
+              sender_key.startSending();
+          }
+      } else if((millis() >= stop_millis) & (millis() <= pause_until_millis)){
+        // do nothing in this case --  in between cycles
+        // Shut the pin off manually
+        digitalWrite(blinker, LOW);
+        digitalWrite(keyer, LOW);
+      } else if((millis() >= pause_until_millis)){
+        startProgram = true;
+      }
+  // if the cycle program is not running
+  } else if((yourInputSend == 2) & (programRunning == false)){
+    // do we need something here?
+  // if you don't want to send code
+  } else if(yourInputSend == 0){
+    // Shut the pin off manually
+    digitalWrite(blinker, LOW);
+    digitalWrite(keyer, LOW);
+  }
+
+}

src/morse.cpp

@@ -0,0 +1,232 @@
+// Morse Code sending library
+
+#include <morse.h>
+
+// MorseSender
+int MorseSender::copyTimings(
+	morseTiming_t *rawOut,
+	morseBitmask_t definition)
+{
+	int t = 0;
+	boolean foundSentinel = false;
+	for(morseBitmask_t mask = MORSE_BITMASK_HIGH_BIT;
+		mask > 0; mask = mask >> 1)
+	{
+		boolean isDah = (mask & definition) > 0;
+		if(!foundSentinel)
+		{
+			if (isDah) { foundSentinel = true; }
+			continue;
+		}
+		rawOut[2*t] = isDah ? DAH : DIT;
+		rawOut[2*t + 1] = DIT;
+		t++;
+	}
+	return t;
+}
+unsigned int MorseSender::fillTimings(char c)
+{
+	int t = 0;
+	unsigned int start = 0;
+	if (c >= 'a' && c <= 'z')
+	{
+		t = copyTimings(timingBuffer, MORSE_LETTERS[c-'a']);
+	}
+	else if (c >= '0' && c <= '9')
+	{
+		int n = c - '0';
+		boolean ditsFirst = (n <= 5);
+		if (!ditsFirst)
+		{
+			n -= 5;
+		}
+		while(t < 5)
+		{
+			timingBuffer[2*t] = ((t < n) == ditsFirst) ? DIT : DAH;
+			timingBuffer[2*t + 1] = DIT;
+			t++;
+		}
+	}
+	else
+	{
+		int s = 0;
+		while(MORSE_PUNCT_ETC[s].c != END)
+		{
+			if(MORSE_PUNCT_ETC[s].c == c)
+			{
+				t = copyTimings(timingBuffer,
+					MORSE_PUNCT_ETC[s].timing);
+				break;
+			}
+			s++;
+		}
+		if (MORSE_PUNCT_ETC[s].c == END)
+		{
+			start = t = 1; // start on a space
+		}
+	}
+
+	timingBuffer[2*t - 1] = DAH;
+	timingBuffer[2*t] = END;
+
+	/*
+	Serial.print("Refilled timing buffer for '");
+	Serial.print(c);
+	Serial.print("': ");
+	int i = start;
+	while(timingBuffer[i] != END)
+	{
+		Serial.print((int)timingBuffer[i]);
+		Serial.print(", ");
+		i++;
+	}
+	Serial.println("END");
+	*/
+
+	return start;
+}
+
+// see note in header about pure-virtual-ness
+void MorseSender::setOn() {};
+void MorseSender::setOff() {};
+
+// noop defaults
+void MorseSender::setReady() {};
+void MorseSender::setComplete() {};
+
+MorseSender::MorseSender(unsigned int outputPin, float wpm) :
+	pin(outputPin)
+{
+	setWPM(wpm);
+}
+
+void MorseSender::setup() { pinMode(pin, OUTPUT); }
+
+void MorseSender::setWPM(float wpm)
+{
+	setSpeed((morseTiming_t)(1000.0*60.0/(max(1.0f, wpm)*DITS_PER_WORD)));
+}
+
+void MorseSender::setSpeed(morseTiming_t duration)
+{
+	DIT = max(duration, (morseTiming_t) 1);
+	DAH = 3*DIT;
+}
+
+void MorseSender::setMessage(const String newMessage)
+{
+	message = newMessage;
+
+	// Force startSending() before continueSending().
+	messageIndex = message.length();
+
+	// If a different message was in progress, make sure it stops cleanly.
+	if (timingIndex % 2 == 0) {
+		setOff();
+	}
+}
+
+void MorseSender::sendBlocking()
+{
+	//Serial.println("Sending blocking: ");
+	//Serial.println(message);
+	startSending();
+	while(continueSending());
+}
+
+void MorseSender::startSending()
+{
+	messageIndex = 0;
+	if (message.length() == 0) { return; }
+	timingIndex = fillTimings(message[0]);
+	setReady();
+	if (timingIndex % 2 == 0) {
+		setOn();
+		//Serial.print("Starting with on, duration=");
+	} else {
+		//Serial.print("Starting with off, duration=");
+	}
+	lastChangedMillis = millis();
+	//Serial.println((int)timingBuffer[timingIndex]);
+}
+
+boolean MorseSender::continueSending()
+{
+	if(messageIndex >= message.length()) { return false; }
+
+	unsigned long elapsedMillis = millis() - lastChangedMillis;
+	if (elapsedMillis < timingBuffer[timingIndex]) { return true; }
+
+	timingIndex++;
+	if (timingBuffer[timingIndex] == END)
+	{
+		messageIndex++;
+		if(messageIndex >= message.length()) {
+			setOff();
+			setComplete();
+			return false;
+		}
+		timingIndex = fillTimings(message[messageIndex]);
+	}
+
+	lastChangedMillis += elapsedMillis;
+	//Serial.print("Next is       ");
+	if (timingIndex % 2 == 0) {
+		//Serial.print("(on) ");
+		setOn();
+	} else {
+		//Serial.print("(off) ");
+		setOff();
+	}
+	//Serial.println((int)timingBuffer[timingIndex]);
+
+	return true;
+}
+
+void *MorseSender::operator new(size_t size) { return malloc(size); }
+void MorseSender::operator delete(void* ptr) { if (ptr) free(ptr); }
+
+
+// SpeakerMorseSender
+
+// void SpeakerMorseSender::setOn() { tone(pin, frequency); }
+// void SpeakerMorseSender::setOff() {
+// 	if (carrFrequency == CARRIER_FREQUENCY_NONE) {
+// 		noTone(pin);
+// 	} else {
+// 		tone(pin, carrFrequency);
+// 	}
+// }
+// void SpeakerMorseSender::setReady() { setOff(); }
+// void SpeakerMorseSender::setComplete() { noTone(pin); }
+// SpeakerMorseSender::SpeakerMorseSender(
+// 	int outputPin,
+// 	unsigned int toneFrequency,
+// 	unsigned int carrierFrequency,
+// 	float wpm)
+// 	: MorseSender(outputPin, wpm),
+// 	frequency(toneFrequency),
+// 	carrFrequency(carrierFrequency) {};
+
+
+// LEDMorseSender
+
+void LEDMorseSender::setOn() { digitalWrite(pin, activeLow ? LOW : HIGH); }
+void LEDMorseSender::setOff() { digitalWrite(pin, activeLow ? HIGH : LOW); }
+LEDMorseSender::LEDMorseSender(int outputPin, bool activeLow, float wpm)
+	: MorseSender(outputPin, wpm), activeLow(activeLow) {};
+LEDMorseSender::LEDMorseSender(int outputPin, float wpm)
+	: MorseSender(outputPin, wpm), activeLow(false) {};
+
+// PWMMorseSender
+
+void PWMMorseSender::setOn() { analogWrite(pin, brightness); }
+void PWMMorseSender::setOff() { analogWrite(pin, 0); }
+void PWMMorseSender::setBrightness(byte bright) {
+	brightness = bright;
+}
+PWMMorseSender::PWMMorseSender(
+		int outputPin,
+		float wpm,
+		byte bright)
+	: MorseSender(outputPin, wpm), brightness(bright) {};

src/morse.h

@@ -0,0 +1,276 @@
+#pragma once
+/**
+ * Generate and send Morse Code on an LED or a speaker. Allow sending
+ * in a non-blocking manner (by calling a 'continue sending' method
+ * every so often to turn an LED on/off, or to call tone/noTone appropriately).
+ *
+ * All input should be lowercase. Prosigns (SK, KN, etc) have special
+ * character values #defined.
+ *
+ * See also:
+ * Morse decoder (using binary tree):
+ * http://www.arduino.cc/cgi-bin/yabb2/YaBB.pl?num=1289074596/15
+ * Generator (on playground):
+ * http://www.arduino.cc/playground/Code/Morse
+ */
+
+// for malloc and free, for the new/delete operators
+#include <stdlib.h>
+#include <analogWrite.h>
+
+// Arduino language types
+#if defined(ARDUINO) && ARDUINO >= 100
+#include "Arduino.h"
+#else
+#include "WProgram.h"
+#endif
+
+#define WPM_DEFAULT	12.0
+// PARIS WPM measurement: 50; CODEX WPM measurement: 60 (Wikipedia:Morse_code)
+#define DITS_PER_WORD	50
+// Pass to SpeakerMorseSender as carrierFrequency to suppress the carrier.
+#define CARRIER_FREQUENCY_NONE	0
+
+// Bitmasks are 1 for dah and 0 for dit, in left-to-right order;
+//	the sequence proper begins after the first 1 (a sentinel).
+//	Credit for this scheme to Mark VandeWettering K6HX ( brainwagon.org ).
+typedef unsigned int             morseTiming_t;
+typedef unsigned char	morseBitmask_t; // see also MAX_TIMINGS
+#define MORSE_BITMASK_HIGH_BIT	B10000000
+
+// sentinel
+#define END             0
+
+// the most timing numbers any unit will need; ex: k = on,off,on,off,on,end = 5
+#define MAX_TIMINGS     15
+
+// Punctuation and Prosigns
+#define PROSIGN_SK	'S'
+#define PROSIGN_KN	'K'
+#define PROSIGN_BT	'B'
+typedef struct {
+	char c;
+	morseBitmask_t timing;
+} specialTiming;
+const specialTiming MORSE_PUNCT_ETC[] = {
+	{'.',		B1010101},
+	{'?',		B1001100},
+	{'/',		B110010},
+	{PROSIGN_SK,	B1000101},
+	{PROSIGN_KN,	B110110},
+	{PROSIGN_BT,	B110001},
+	{END,		B1},
+};
+
+// Morse Code (explicit declaration of letter timings)
+const morseBitmask_t MORSE_LETTERS[26] = {
+	/* a */ B101,
+	/* b */ B11000,
+	/* c */ B11010,
+	/* d */ B1100,
+	/* e */ B10,
+	/* f */ B10010,
+	/* g */ B1110,
+	/* h */ B10000,
+	/* i */ B100,
+	/* j */ B10111,
+	/* k */ B1101,
+	/* l */ B10100,
+	/* m */ B111,
+	/* n */ B110,
+	/* o */ B1111,
+	/* p */ B10110,
+	/* q */ B11101,
+	/* r */ B1010,
+	/* s */ B1000,
+	/* t */ B11,
+	/* u */ B1001,
+	/* v */ B10001,
+	/* w */ B1011,
+	/* x */ B11001,
+	/* y */ B11011,
+	/* z */ B11100,
+};
+
+
+/**
+ * Define the logic of converting characters to on/off timing,
+ * and encapsulate the state of one sending-in-progress Morse message.
+ *
+ * Subclasses define setOn and setOff for (for example) LED and speaker output.
+ */
+class MorseSender {
+protected:
+	const unsigned int pin;
+	// The setOn and setOff methods would be pure virtual,
+	// but that has compiler issues.
+	// See: http://www.arduino.cc/cgi-bin/yabb2/YaBB.pl?num=1167672075 .
+
+	/**
+	 * Called to set put the output in 'on' state, during a dit or dah.
+	 */
+	virtual void setOn();
+	virtual void setOff();
+
+	/**
+	 * Called before sending a message. Used for example to enable a
+	 * carrier. (Noop in the base class.)
+	 */
+	virtual void setReady();
+	virtual void setComplete();
+
+private:
+	morseTiming_t DIT, DAH;
+	String message;
+
+	// on,off,...,wait,0 list, millis
+	morseTiming_t timingBuffer[MAX_TIMINGS+1];
+
+	// index of the character currently being sent
+	unsigned int messageIndex;
+	// timing unit currently being sent
+	unsigned int timingIndex;
+
+	// when this timing unit was started
+	unsigned long lastChangedMillis;
+
+	/**
+	 * Copy definition timings (on only) to raw timings (on/off).
+	 * @return the number of 'on' timings copied
+	 */
+	int copyTimings(morseTiming_t *rawOut,
+		morseBitmask_t definition);
+
+	/**
+	 * Fill a buffer with on,off,..,END timings (millis)
+	 * @return the index at which to start within the new timing sequence
+	 */
+	unsigned int fillTimings(char c);
+
+public:
+	/**
+	 * Create a sender which will output to the given pin.
+	 */
+	MorseSender(unsigned int outputPin, float wpm=WPM_DEFAULT);
+
+	/**
+	 * To be called during the Arduino setup(); set the pin as OUTPUT.
+	 */
+	void setup();
+
+	/**
+	 * Set the words per minute (based on PARIS timing).
+	 */
+	void setWPM(float wpm);
+
+	/**
+	 * Set the duration, in milliseconds, of a DIT.
+	 */
+	void setSpeed(morseTiming_t duration);
+
+	/**
+	 * Set the message to be sent.
+	 * This halts any sending in progress.
+	 */
+	void setMessage(const String newMessage);
+
+	/**
+	 * Send the entirety of the current message before returning. See the "simple"
+	 * example, which uses sendBlocking to send one message.
+	 */
+	void sendBlocking();
+
+	/**
+	 * Prepare to send and begin sending the current message. After calling this,
+	 * call continueSending repeatedly until it returns false to finish sending
+	 * the message. See the "speeds" example, which calls startSending and
+	 * continueSending on two different senders.
+	 */
+	void startSending();
+
+	/**
+	 * Switch outputs on and off (and refill the internal timing buffer)
+	 * as necessary to continue with the sending of the current message.
+	 * This should be called every few milliseconds (at a significantly
+	 * smaller interval than a DIT) to produce a legible fist.
+	 *
+	 * @see startSending, which must be called first
+	 * @return false if sending is complete, otherwise true (keep sending)
+	 */
+	boolean continueSending();
+
+	void *operator new(size_t size);
+	void operator delete(void* ptr);
+};
+
+
+/**
+ * Adapt Morse sending to use the Arduino language tone() and noTone()
+ * functions, for use with a speaker.
+ *
+ * If a carrierFrequency is given, instead of calling noTone, call tone
+ * with a low frequency. This is useful ex. for maintaining radio links.
+ */
+class SpeakerMorseSender: public MorseSender {
+	private:
+		unsigned int frequency;
+		unsigned int carrFrequency;
+	protected:
+		virtual void setOn();
+		virtual void setOff();
+		virtual void setReady();
+		virtual void setComplete();
+	public:
+		// concert A = 440
+		// middle C = 261.626; higher octaves = 523.251, 1046.502
+		SpeakerMorseSender(
+			int outputPin,
+			unsigned int toneFrequency=1046,
+			unsigned int carrierFrequency=CARRIER_FREQUENCY_NONE,
+			float wpm=WPM_DEFAULT);
+};
+
+
+/**
+ * Sends Morse on a digital output pin.
+ */
+class LEDMorseSender: public MorseSender {
+	private:
+		bool activeLow;
+	protected:
+		virtual void setOn();
+		virtual void setOff();
+	public:
+		/**
+		 * Creates a LED Morse code sender with the given GPIO pin.  The optional
+		 * boolean activeLow indicates LED is ON with digital LOW value.
+		 * @param outputPin GPIO pin number
+		 * @param activeLow set to true to indicate the LED ON with digital LOW value.  default: false
+		 * @param wpm words per minute, default: WPM_DEFAULT
+		 */
+		LEDMorseSender(int outputPin, bool activeLow = false, float wpm=WPM_DEFAULT);
+
+		/**
+		 * Creates a LED Morse code sender with the given GPIO pin.  This constructor is for backward compability.
+		 * @param outputPin GPIO pin number
+		 * @param wpm words per minute
+		 */
+		LEDMorseSender(int outputPin, float wpm);
+};
+
+
+/**
+ * Sends Morse on an analog output pin (using PWM). The brightness value is
+ * between 0 and 255 and is passed directly to analogWrite.
+ */
+class PWMMorseSender: public MorseSender {
+	private:
+		byte brightness;
+	protected:
+		virtual void setOn();
+		virtual void setOff();
+	public:
+		PWMMorseSender(int outputPin, float wpm=WPM_DEFAULT, byte brightness=255);
+		void setBrightness(byte brightness);
+};
+

start-aprs_api.sh

@@ -1,4 +0,0 @@
-#!/bin/bash
-# Run `chmod +x start-aprs_api.sh` so this can be run
-
-screen -dmS aprs_api python3 /home/pi/aprs_tool/api_waitress.py

templates/index.html

@@ -1,59 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="UTF-8">
-    <title>{{station_call}} Status</title>
-
-    <style>
-      table, th, td {
-        border: 1px solid black;
-      }
-    </style>
-</head>
-<body>
-<h1>{{station_call}} Status</h1>
-{{station_lat}}, {{station_lon}}
-
-<h2> Recent RF Packets </h2>
-   <table>
-     <tr>
-      <th> from </th>
-      <th> object_name </th>
-      <th> raw </th>
-      <th> created (utc) </th>
-      <th> more </th>
-    </tr>
-        {% for i in frames %}
-     <tr>
-       <td> <a href="https://digi.w1cdn.net/aprs_api/packets?from={{ i['from'] }}">{{ i['from'] }}</a> </td>
-       <td> {{ i['object_name'] }} </td>
-       <td> {{ i['raw'] }} </td>
-       <td> {{ i['created'] }} </td>
-       <td> <a href="https://digi.w1cdn.net/aprs_api/packets?id={{ i['id'] }}">query</a>,
-            <a href="https://aprs.fi/#!mt=roadmap&z=12&call=a%2F{{ i['from'] }}">aprs.fi</a></td>
-     </tr>
-      {% endfor %}
-  </table>
-
-<h2> Recent Stations </h2>
-<table>
-  <tr>
-   <th> from </th>
-   <th> last heard (utc) </th>
-   <th> count </th>
-   <th> more </th>
- </tr>
-     {% for i in stations %}
-  <tr>
-    <td> <a href="https://digi.w1cdn.net/aprs_api/packets?from={{ i['from'] }}">{{ i['from'] }}</a> </td>
-    <td> {{ i['last_heard'] }} </td>
-    <td> {{ i['count']}} </td>
-    <td> <a href="https://aprs.fi/#!mt=roadmap&z=12&call=a%2F{{ i['from'] }}">aprs.fi</a></td>
-  </tr>
-   {% endfor %}
-</table>
-
-<h2> Help </h2>
-This is a work in progress. See <a href="https://amiok.net/gitea/W1CDN/aprs_tool">https://amiok.net/gitea/W1CDN/aprs_tool</a> for usage.
-</body>
-</html>

test/README

@@ -0,0 +1,11 @@
+
+This directory is intended for PlatformIO Test Runner and project tests.
+
+Unit Testing is a software testing method by which individual units of
+source code, sets of one or more MCU program modules together with associated
+control data, usage procedures, and operating procedures, are tested to
+determine whether they are fit for use. Unit testing finds problems early
+in the development cycle.
+
+More information about PlatformIO Unit Testing:
+- https://docs.platformio.org/en/latest/advanced/unit-testing/index.html

test_db.py

@@ -1,36 +0,0 @@
-
-# Learn how to update database
-
-import sqlite3
-
-def get_db_connection():
-    conn = sqlite3.connect('database.db')
-    conn.row_factory = sqlite3.Row
-    return conn
-
-conn = get_db_connection()
-
-# Grab a random row from frames table and pretend it is new
-cur = conn.cursor()
-cur.execute("SELECT [from], id, created_unix FROM frames ORDER BY RANDOM() LIMIT 1;")
-rows = cur.fetchall()
-results = dict(rows[0])
-values = ', '.join('"%s"' % w for w in results.values())
-
-
-# Build query
-# "from" is wrappedin [] because it is a reserved word and using '' doesn't work.
-query3 = "INSERT INTO stations ([from], frames_id, last_heard_unix, count) \
-VALUES("+values+", 1) \
-ON CONFLICT([from]) \
-DO UPDATE SET count = count + 1;"
-
-# example https://stackoverflow.com/a/50718957/2152245
-# query2 = "INSERT INTO stations ([from], frames_id, last_heard_unix, count) \
-# VALUES('KC9TZN-8', 4068, 1687623864, 1) \
-# ON CONFLICT([from]) \
-# DO UPDATE SET count = count + 1;"
-
-conn.execute(query3)
-conn.commit()
-conn.close()

vulpes.code-workspace

@@ -0,0 +1,8 @@
+{
+	"folders": [
+		{
+			"path": "."
+		}
+	],
+	"settings": {}
+}