Compare commits
2 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
269cbfdd22 | ||
|
|
c48c624f71 |
674
LICENSE
674
LICENSE
|
|
@ -1,674 +0,0 @@
|
||||||
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>.
|
|
||||||
98
README.md
98
README.md
|
|
@ -1,98 +0,0 @@
|
||||||
# Vulpes
|
|
||||||
An ESP32-based radio orienteering controller. This repo is for
|
|
||||||
the code. See below for hardware comments and a link.
|
|
||||||
[Main project page](https://w1cdn.net/projects/vulpes-radio-orienteering-controller/).
|
|
||||||
|
|
||||||
## 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.
|
|
||||||
|
|
||||||
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).
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
## 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).
|
|
||||||
|
|
||||||
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**
|
|
||||||
|
|
||||||
|
|
||||||
### 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).
|
|
||||||
Binary file not shown.
|
Before Width: | Height: | Size: 336 KiB |
183
esp32-webserver-form/esp32-webserver-form.ino
Normal file
183
esp32-webserver-form/esp32-webserver-form.ino
Normal file
|
|
@ -0,0 +1,183 @@
|
||||||
|
/*********
|
||||||
|
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>
|
||||||
|
|
||||||
|
// download zip from https://github.com/me-no-dev/ESPAsyncWebServer and install.
|
||||||
|
#include <ESPAsyncWebServer.h>
|
||||||
|
|
||||||
|
AsyncWebServer server(80);
|
||||||
|
|
||||||
|
// Read from config.h
|
||||||
|
const char* ssid = WIFI_SSID;
|
||||||
|
const char* password = WIFI_PASSWORD;
|
||||||
|
|
||||||
|
const char* PARAM_STRING = "inputString";
|
||||||
|
const char* PARAM_INT = "inputInt";
|
||||||
|
const char* PARAM_FLOAT = "inputFloat";
|
||||||
|
|
||||||
|
// HTML web page to handle 3 input fields (inputString, inputInt, inputFloat)
|
||||||
|
const char index_html[] PROGMEM = R"rawliteral(
|
||||||
|
<!DOCTYPE HTML><html><head>
|
||||||
|
<title>ESP Input Form</title>
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||||
|
<!--<script>
|
||||||
|
function submitMessage() {
|
||||||
|
alert("Saved value to ESP SPIFFS");
|
||||||
|
setTimeout(function(){ document.location.reload(false); }, 500);
|
||||||
|
}
|
||||||
|
</script>-->
|
||||||
|
</head><body>
|
||||||
|
<form action="/get">
|
||||||
|
inputString (current value %inputString%): <input type="text" name="inputString">
|
||||||
|
<!--<input type="submit" value="Submit" ">
|
||||||
|
</form>--><br>
|
||||||
|
<!--<form action="/get" target="hidden-form">-->
|
||||||
|
inputInt (current value %inputInt%): <input type="number " name="inputInt">
|
||||||
|
<!--<input type="submit" value="Submit" ">
|
||||||
|
</form>--><br>
|
||||||
|
<!--<form action="/get" target="hidden-form">-->
|
||||||
|
inputFloat (current value %inputFloat%): <input type="number " name="inputFloat">
|
||||||
|
<input type="submit" value="Submit" ">
|
||||||
|
</form>
|
||||||
|
<!--<iframe style="display:none" name="hidden-form"></iframe>-->
|
||||||
|
</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 with stored values
|
||||||
|
String processor(const String& var){
|
||||||
|
//Serial.println(var);
|
||||||
|
if(var == "inputString"){
|
||||||
|
return readFile(SPIFFS, "/inputString.txt");
|
||||||
|
}
|
||||||
|
else if(var == "inputInt"){
|
||||||
|
return readFile(SPIFFS, "/inputInt.txt");
|
||||||
|
}
|
||||||
|
else if(var == "inputFloat"){
|
||||||
|
return readFile(SPIFFS, "/inputFloat.txt");
|
||||||
|
}
|
||||||
|
return String();
|
||||||
|
}
|
||||||
|
|
||||||
|
void setup() {
|
||||||
|
Serial.begin(115200);
|
||||||
|
// Initialize SPIFFS
|
||||||
|
#ifdef ESP32
|
||||||
|
if(!SPIFFS.begin(true)){
|
||||||
|
Serial.println("An Error has occurred while mounting SPIFFS");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
#else
|
||||||
|
if(!SPIFFS.begin()){
|
||||||
|
Serial.println("An Error has occurred while mounting SPIFFS");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
|
||||||
|
WiFi.mode(WIFI_STA);
|
||||||
|
WiFi.begin(ssid, password);
|
||||||
|
if (WiFi.waitForConnectResult() != WL_CONNECTED) {
|
||||||
|
Serial.println("WiFi Failed!");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
Serial.println();
|
||||||
|
Serial.print("IP Address: ");
|
||||||
|
Serial.println(WiFi.localIP());
|
||||||
|
|
||||||
|
// Send web page with input fields to client
|
||||||
|
server.on("/", HTTP_GET, [](AsyncWebServerRequest *request){
|
||||||
|
request->send_P(200, "text/html", index_html, processor);
|
||||||
|
});
|
||||||
|
|
||||||
|
// Send a GET request to <ESP_IP>/get?inputString=<inputMessage>
|
||||||
|
server.on("/get", HTTP_GET, [] (AsyncWebServerRequest *request) {
|
||||||
|
String inputMessage;
|
||||||
|
// GET inputString value on <ESP_IP>/get?inputString=<inputMessage>
|
||||||
|
if (request->hasParam(PARAM_STRING)) {
|
||||||
|
inputMessage = request->getParam(PARAM_STRING)->value();
|
||||||
|
writeFile(SPIFFS, "/inputString.txt", inputMessage.c_str());
|
||||||
|
}
|
||||||
|
// GET inputInt value on <ESP_IP>/get?inputInt=<inputMessage>
|
||||||
|
else if (request->hasParam(PARAM_INT)) {
|
||||||
|
inputMessage = request->getParam(PARAM_INT)->value();
|
||||||
|
writeFile(SPIFFS, "/inputInt.txt", inputMessage.c_str());
|
||||||
|
}
|
||||||
|
// GET inputFloat value on <ESP_IP>/get?inputFloat=<inputMessage>
|
||||||
|
else if (request->hasParam(PARAM_FLOAT)) {
|
||||||
|
inputMessage = request->getParam(PARAM_FLOAT)->value();
|
||||||
|
writeFile(SPIFFS, "/inputFloat.txt", inputMessage.c_str());
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
inputMessage = "No message sent";
|
||||||
|
}
|
||||||
|
Serial.println(inputMessage);
|
||||||
|
request->send(200, "text/text", inputMessage);
|
||||||
|
});
|
||||||
|
server.onNotFound(notFound);
|
||||||
|
server.begin();
|
||||||
|
}
|
||||||
|
|
||||||
|
void loop() {
|
||||||
|
// To access your stored values on inputString, inputInt, inputFloat
|
||||||
|
String yourInputString = readFile(SPIFFS, "/inputString.txt");
|
||||||
|
Serial.print("*** Your inputString: ");
|
||||||
|
Serial.println(yourInputString);
|
||||||
|
|
||||||
|
int yourInputInt = readFile(SPIFFS, "/inputInt.txt").toInt();
|
||||||
|
Serial.print("*** Your inputInt: ");
|
||||||
|
Serial.println(yourInputInt);
|
||||||
|
|
||||||
|
float yourInputFloat = readFile(SPIFFS, "/inputFloat.txt").toFloat();
|
||||||
|
Serial.print("*** Your inputFloat: ");
|
||||||
|
Serial.println(yourInputFloat);
|
||||||
|
delay(5000);
|
||||||
|
}
|
||||||
169
esp32-webserver-prefs/esp32-webserver-prefs.ino
Normal file
169
esp32-webserver-prefs/esp32-webserver-prefs.ino
Normal file
|
|
@ -0,0 +1,169 @@
|
||||||
|
/*********
|
||||||
|
Rui Santos
|
||||||
|
Complete project details at https://randomnerdtutorials.com
|
||||||
|
*********/
|
||||||
|
// include wifi password
|
||||||
|
#include "config.h"
|
||||||
|
// Load Wi-Fi library
|
||||||
|
#include <WiFi.h>
|
||||||
|
// Load Preferences library
|
||||||
|
#include <Preferences.h>
|
||||||
|
// Define preferences instance
|
||||||
|
Preferences prefs;
|
||||||
|
// Open up preferences with defined namespace
|
||||||
|
prefs.begin("vulpes", false);
|
||||||
|
|
||||||
|
// Replace with your network credentials
|
||||||
|
const char* ssid = WIFI_SSID;
|
||||||
|
const char* password = WIFI_PASSWORD;
|
||||||
|
|
||||||
|
// Set web server port number to 80
|
||||||
|
WiFiServer server(80);
|
||||||
|
|
||||||
|
// Variable to store the HTTP request
|
||||||
|
String header;
|
||||||
|
|
||||||
|
// Auxiliar variables to store the current output state
|
||||||
|
String output26State = "off";
|
||||||
|
String output27State = "off";
|
||||||
|
|
||||||
|
// Assign output variables to GPIO pins
|
||||||
|
const int output26 = 26;
|
||||||
|
const int output27 = 27;
|
||||||
|
|
||||||
|
// Current time
|
||||||
|
unsigned long currentTime = millis();
|
||||||
|
// Previous time
|
||||||
|
unsigned long previousTime = 0;
|
||||||
|
// Define timeout time in milliseconds (example: 2000ms = 2s)
|
||||||
|
const long timeoutTime = 2000;
|
||||||
|
|
||||||
|
void setup() {
|
||||||
|
Serial.begin(115200);
|
||||||
|
// Initialize the output variables as outputs
|
||||||
|
pinMode(output26, OUTPUT);
|
||||||
|
pinMode(output27, OUTPUT);
|
||||||
|
// Set outputs to LOW
|
||||||
|
digitalWrite(output26, LOW);
|
||||||
|
digitalWrite(output27, LOW);
|
||||||
|
|
||||||
|
preferences.putString("ssid", ssid);
|
||||||
|
preferences.putString("password", password);
|
||||||
|
|
||||||
|
Serial.println("Network Credentials Saved using Preferences");
|
||||||
|
|
||||||
|
preferences.end();
|
||||||
|
|
||||||
|
// Connect to Wi-Fi network with SSID and password
|
||||||
|
Serial.print("Connecting to ");
|
||||||
|
Serial.println(ssid);
|
||||||
|
WiFi.begin(ssid, password);
|
||||||
|
while (WiFi.status() != WL_CONNECTED) {
|
||||||
|
delay(500);
|
||||||
|
Serial.print(".");
|
||||||
|
}
|
||||||
|
// Print local IP address and start web server
|
||||||
|
Serial.println("");
|
||||||
|
Serial.println("WiFi connected.");
|
||||||
|
Serial.println("IP address: ");
|
||||||
|
Serial.println(WiFi.localIP());
|
||||||
|
server.begin();
|
||||||
|
}
|
||||||
|
|
||||||
|
void loop(){
|
||||||
|
WiFiClient client = server.available(); // Listen for incoming clients
|
||||||
|
|
||||||
|
if (client) { // If a new client connects,
|
||||||
|
currentTime = millis();
|
||||||
|
previousTime = currentTime;
|
||||||
|
Serial.println("New Client."); // print a message out in the serial port
|
||||||
|
String currentLine = ""; // make a String to hold incoming data from the client
|
||||||
|
while (client.connected() && currentTime - previousTime <= timeoutTime) { // loop while the client's connected
|
||||||
|
currentTime = millis();
|
||||||
|
if (client.available()) { // if there's bytes to read from the client,
|
||||||
|
char c = client.read(); // read a byte, then
|
||||||
|
Serial.write(c); // print it out the serial monitor
|
||||||
|
header += c;
|
||||||
|
if (c == '\n') { // if the byte is a newline character
|
||||||
|
// if the current line is blank, you got two newline characters in a row.
|
||||||
|
// that's the end of the client HTTP request, so send a response:
|
||||||
|
if (currentLine.length() == 0) {
|
||||||
|
// HTTP headers always start with a response code (e.g. HTTP/1.1 200 OK)
|
||||||
|
// and a content-type so the client knows what's coming, then a blank line:
|
||||||
|
client.println("HTTP/1.1 200 OK");
|
||||||
|
client.println("Content-type:text/html");
|
||||||
|
client.println("Connection: close");
|
||||||
|
client.println();
|
||||||
|
|
||||||
|
// turns the GPIOs on and off
|
||||||
|
if (header.indexOf("GET /26/on") >= 0) {
|
||||||
|
Serial.println("GPIO 26 on");
|
||||||
|
output26State = "on";
|
||||||
|
digitalWrite(output26, HIGH);
|
||||||
|
} else if (header.indexOf("GET /26/off") >= 0) {
|
||||||
|
Serial.println("GPIO 26 off");
|
||||||
|
output26State = "off";
|
||||||
|
digitalWrite(output26, LOW);
|
||||||
|
} else if (header.indexOf("GET /27/on") >= 0) {
|
||||||
|
Serial.println("GPIO 27 on");
|
||||||
|
output27State = "on";
|
||||||
|
digitalWrite(output27, HIGH);
|
||||||
|
} else if (header.indexOf("GET /27/off") >= 0) {
|
||||||
|
Serial.println("GPIO 27 off");
|
||||||
|
output27State = "off";
|
||||||
|
digitalWrite(output27, LOW);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Display the HTML web page
|
||||||
|
client.println("<!DOCTYPE html><html>");
|
||||||
|
client.println("<head><meta name=\"viewport\" content=\"width=device-width, initial-scale=1\">");
|
||||||
|
client.println("<link rel=\"icon\" href=\"data:,\">");
|
||||||
|
// CSS to style the on/off buttons
|
||||||
|
// Feel free to change the background-color and font-size attributes to fit your preferences
|
||||||
|
client.println("<style>html { font-family: Helvetica; display: inline-block; margin: 0px auto; text-align: center;}");
|
||||||
|
client.println(".button { background-color: #4CAF50; border: none; color: white; padding: 16px 40px;");
|
||||||
|
client.println("text-decoration: none; font-size: 30px; margin: 2px; cursor: pointer;}");
|
||||||
|
client.println(".button2 {background-color: #555555;}</style></head>");
|
||||||
|
|
||||||
|
// Web Page Heading
|
||||||
|
client.println("<body><h1>ESP32 Web Server</h1>");
|
||||||
|
|
||||||
|
// Display current state, and ON/OFF buttons for GPIO 26
|
||||||
|
client.println("<p>GPIO 26 - State " + output26State + "</p>");
|
||||||
|
// If the output26State is off, it displays the ON button
|
||||||
|
if (output26State=="off") {
|
||||||
|
client.println("<p><a href=\"/26/on\"><button class=\"button\">ON</button></a></p>");
|
||||||
|
} else {
|
||||||
|
client.println("<p><a href=\"/26/off\"><button class=\"button button2\">OFF</button></a></p>");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Display current state, and ON/OFF buttons for GPIO 27
|
||||||
|
client.println("<p>GPIO 27 - State " + output27State + "</p>");
|
||||||
|
// If the output27State is off, it displays the ON button
|
||||||
|
if (output27State=="off") {
|
||||||
|
client.println("<p><a href=\"/27/on\"><button class=\"button\">ON</button></a></p>");
|
||||||
|
} else {
|
||||||
|
client.println("<p><a href=\"/27/off\"><button class=\"button button2\">OFF</button></a></p>");
|
||||||
|
}
|
||||||
|
client.println("</body></html>");
|
||||||
|
|
||||||
|
// The HTTP response ends with another blank line
|
||||||
|
client.println();
|
||||||
|
// Break out of the while loop
|
||||||
|
break;
|
||||||
|
} else { // if you got a newline, then clear currentLine
|
||||||
|
currentLine = "";
|
||||||
|
}
|
||||||
|
} else if (c != '\r') { // if you got anything else but a carriage return character,
|
||||||
|
currentLine += c; // add it to the end of the currentLine
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// Clear the header variable
|
||||||
|
header = "";
|
||||||
|
// Close the connection
|
||||||
|
client.stop();
|
||||||
|
Serial.println("Client disconnected.");
|
||||||
|
Serial.println("");
|
||||||
|
}
|
||||||
|
}
|
||||||
157
esp32-webserver/esp32-webserver.ino
Normal file
157
esp32-webserver/esp32-webserver.ino
Normal file
|
|
@ -0,0 +1,157 @@
|
||||||
|
/*********
|
||||||
|
Rui Santos
|
||||||
|
Complete project details at https://randomnerdtutorials.com
|
||||||
|
*********/
|
||||||
|
|
||||||
|
// include wifi password
|
||||||
|
#include "config.h"
|
||||||
|
// Load Wi-Fi library
|
||||||
|
#include <WiFi.h>
|
||||||
|
|
||||||
|
// Replace with your network credentials
|
||||||
|
const char* ssid = WIFI_SSID;
|
||||||
|
const char* password = WIFI_PASSWORD;
|
||||||
|
|
||||||
|
// Set web server port number to 80
|
||||||
|
WiFiServer server(80);
|
||||||
|
|
||||||
|
// Variable to store the HTTP request
|
||||||
|
String header;
|
||||||
|
|
||||||
|
// Auxiliar variables to store the current output state
|
||||||
|
String output26State = "off";
|
||||||
|
String output27State = "off";
|
||||||
|
|
||||||
|
// Assign output variables to GPIO pins
|
||||||
|
const int output26 = 26;
|
||||||
|
const int output27 = 27;
|
||||||
|
|
||||||
|
// Current time
|
||||||
|
unsigned long currentTime = millis();
|
||||||
|
// Previous time
|
||||||
|
unsigned long previousTime = 0;
|
||||||
|
// Define timeout time in milliseconds (example: 2000ms = 2s)
|
||||||
|
const long timeoutTime = 2000;
|
||||||
|
|
||||||
|
void setup() {
|
||||||
|
Serial.begin(115200);
|
||||||
|
// Initialize the output variables as outputs
|
||||||
|
pinMode(output26, OUTPUT);
|
||||||
|
pinMode(output27, OUTPUT);
|
||||||
|
// Set outputs to LOW
|
||||||
|
digitalWrite(output26, LOW);
|
||||||
|
digitalWrite(output27, LOW);
|
||||||
|
|
||||||
|
// Connect to Wi-Fi network with SSID and password
|
||||||
|
Serial.print("Connecting to ");
|
||||||
|
Serial.println(ssid);
|
||||||
|
WiFi.begin(ssid, password);
|
||||||
|
while (WiFi.status() != WL_CONNECTED) {
|
||||||
|
delay(500);
|
||||||
|
Serial.print(".");
|
||||||
|
}
|
||||||
|
// Print local IP address and start web server
|
||||||
|
Serial.println("");
|
||||||
|
Serial.println("WiFi connected.");
|
||||||
|
Serial.println("IP address: ");
|
||||||
|
Serial.println(WiFi.localIP());
|
||||||
|
server.begin();
|
||||||
|
}
|
||||||
|
|
||||||
|
void loop(){
|
||||||
|
WiFiClient client = server.available(); // Listen for incoming clients
|
||||||
|
|
||||||
|
if (client) { // If a new client connects,
|
||||||
|
currentTime = millis();
|
||||||
|
previousTime = currentTime;
|
||||||
|
Serial.println("New Client."); // print a message out in the serial port
|
||||||
|
String currentLine = ""; // make a String to hold incoming data from the client
|
||||||
|
while (client.connected() && currentTime - previousTime <= timeoutTime) { // loop while the client's connected
|
||||||
|
currentTime = millis();
|
||||||
|
if (client.available()) { // if there's bytes to read from the client,
|
||||||
|
char c = client.read(); // read a byte, then
|
||||||
|
Serial.write(c); // print it out the serial monitor
|
||||||
|
header += c;
|
||||||
|
if (c == '\n') { // if the byte is a newline character
|
||||||
|
// if the current line is blank, you got two newline characters in a row.
|
||||||
|
// that's the end of the client HTTP request, so send a response:
|
||||||
|
if (currentLine.length() == 0) {
|
||||||
|
// HTTP headers always start with a response code (e.g. HTTP/1.1 200 OK)
|
||||||
|
// and a content-type so the client knows what's coming, then a blank line:
|
||||||
|
client.println("HTTP/1.1 200 OK");
|
||||||
|
client.println("Content-type:text/html");
|
||||||
|
client.println("Connection: close");
|
||||||
|
client.println();
|
||||||
|
|
||||||
|
// turns the GPIOs on and off
|
||||||
|
if (header.indexOf("GET /26/on") >= 0) {
|
||||||
|
Serial.println("GPIO 26 on");
|
||||||
|
output26State = "on";
|
||||||
|
digitalWrite(output26, HIGH);
|
||||||
|
} else if (header.indexOf("GET /26/off") >= 0) {
|
||||||
|
Serial.println("GPIO 26 off");
|
||||||
|
output26State = "off";
|
||||||
|
digitalWrite(output26, LOW);
|
||||||
|
} else if (header.indexOf("GET /27/on") >= 0) {
|
||||||
|
Serial.println("GPIO 27 on");
|
||||||
|
output27State = "on";
|
||||||
|
digitalWrite(output27, HIGH);
|
||||||
|
} else if (header.indexOf("GET /27/off") >= 0) {
|
||||||
|
Serial.println("GPIO 27 off");
|
||||||
|
output27State = "off";
|
||||||
|
digitalWrite(output27, LOW);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Display the HTML web page
|
||||||
|
client.println("<!DOCTYPE html><html>");
|
||||||
|
client.println("<head><meta name=\"viewport\" content=\"width=device-width, initial-scale=1\">");
|
||||||
|
client.println("<link rel=\"icon\" href=\"data:,\">");
|
||||||
|
// CSS to style the on/off buttons
|
||||||
|
// Feel free to change the background-color and font-size attributes to fit your preferences
|
||||||
|
client.println("<style>html { font-family: Helvetica; display: inline-block; margin: 0px auto; text-align: center;}");
|
||||||
|
client.println(".button { background-color: #4CAF50; border: none; color: white; padding: 16px 40px;");
|
||||||
|
client.println("text-decoration: none; font-size: 30px; margin: 2px; cursor: pointer;}");
|
||||||
|
client.println(".button2 {background-color: #555555;}</style></head>");
|
||||||
|
|
||||||
|
// Web Page Heading
|
||||||
|
client.println("<body><h1>ESP32 Web Server</h1>");
|
||||||
|
|
||||||
|
// Display current state, and ON/OFF buttons for GPIO 26
|
||||||
|
client.println("<p>GPIO 26 - State " + output26State + "</p>");
|
||||||
|
// If the output26State is off, it displays the ON button
|
||||||
|
if (output26State=="off") {
|
||||||
|
client.println("<p><a href=\"/26/on\"><button class=\"button\">ON</button></a></p>");
|
||||||
|
} else {
|
||||||
|
client.println("<p><a href=\"/26/off\"><button class=\"button button2\">OFF</button></a></p>");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Display current state, and ON/OFF buttons for GPIO 27
|
||||||
|
client.println("<p>GPIO 27 - State " + output27State + "</p>");
|
||||||
|
// If the output27State is off, it displays the ON button
|
||||||
|
if (output27State=="off") {
|
||||||
|
client.println("<p><a href=\"/27/on\"><button class=\"button\">ON</button></a></p>");
|
||||||
|
} else {
|
||||||
|
client.println("<p><a href=\"/27/off\"><button class=\"button button2\">OFF</button></a></p>");
|
||||||
|
}
|
||||||
|
client.println("</body></html>");
|
||||||
|
|
||||||
|
// The HTTP response ends with another blank line
|
||||||
|
client.println();
|
||||||
|
// Break out of the while loop
|
||||||
|
break;
|
||||||
|
} else { // if you got a newline, then clear currentLine
|
||||||
|
currentLine = "";
|
||||||
|
}
|
||||||
|
} else if (c != '\r') { // if you got anything else but a carriage return character,
|
||||||
|
currentLine += c; // add it to the end of the currentLine
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// Clear the header variable
|
||||||
|
header = "";
|
||||||
|
// Close the connection
|
||||||
|
client.stop();
|
||||||
|
Serial.println("Client disconnected.");
|
||||||
|
Serial.println("");
|
||||||
|
}
|
||||||
|
}
|
||||||
0
.gitignore → vulpes/.gitignore
vendored
0
.gitignore → vulpes/.gitignore
vendored
10
vulpes/.vscode/extensions.json
vendored
Normal file
10
vulpes/.vscode/extensions.json
vendored
Normal file
|
|
@ -0,0 +1,10 @@
|
||||||
|
{
|
||||||
|
// See http://go.microsoft.com/fwlink/?LinkId=827846
|
||||||
|
// for the documentation about the extensions.json format
|
||||||
|
"recommendations": [
|
||||||
|
"platformio.platformio-ide"
|
||||||
|
],
|
||||||
|
"unwantedRecommendations": [
|
||||||
|
"ms-vscode.cpptools-extension-pack"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
@ -19,6 +19,8 @@ build_type = debug
|
||||||
lib_deps =
|
lib_deps =
|
||||||
me-no-dev/AsyncTCP@^1.1.1
|
me-no-dev/AsyncTCP@^1.1.1
|
||||||
me-no-dev/ESP Async WebServer@^1.2.3
|
me-no-dev/ESP Async WebServer@^1.2.3
|
||||||
|
contrem/arduino-timer@^3.0.1
|
||||||
|
jandelgado/JLed@^4.13.1
|
||||||
https://github.com/adafruit/RTClib.git
|
https://github.com/adafruit/RTClib.git
|
||||||
adafruit/Adafruit BusIO@^1.14.3
|
adafruit/Adafruit BusIO@^1.14.3
|
||||||
erropix/ESP32 AnalogWrite@^0.2
|
erropix/ESP32 AnalogWrite@^0.2
|
||||||
|
|
@ -34,19 +34,9 @@ const int blinker = LED_BUILTIN;
|
||||||
RTC_DS3231 rtc; // set up RTC
|
RTC_DS3231 rtc; // set up RTC
|
||||||
const int alarmPin = 4; // pin to monitor for RTC alarms
|
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
|
// Read from config.h
|
||||||
//const char* ssid = WIFI_SSID;
|
const char* ssid = WIFI_SSID;
|
||||||
//const char* password = WIFI_PASSWORD;
|
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_SEND = "inputSend";
|
||||||
const char* PARAM_WPM = "inputWPM";
|
const char* PARAM_WPM = "inputWPM";
|
||||||
|
|
@ -59,9 +49,6 @@ const char* PARAM_RUNNING = "programRunning";
|
||||||
const char* PARAM_STEPLENGTH = "inputStepLength";
|
const char* PARAM_STEPLENGTH = "inputStepLength";
|
||||||
const char* PARAM_CYCLEID = "inputCycleID";
|
const char* PARAM_CYCLEID = "inputCycleID";
|
||||||
const char* PARAM_NTRANS = "inputNtransmitters";
|
const char* PARAM_NTRANS = "inputNtransmitters";
|
||||||
const char* PARAM_NETWORK = "inputNetwork";
|
|
||||||
const char* PARAM_SSID = "inputSSID";
|
|
||||||
const char* PARAM_PASSWORD = "inputPassword";
|
|
||||||
|
|
||||||
// Global variables
|
// Global variables
|
||||||
int yourInputSend;
|
int yourInputSend;
|
||||||
|
|
@ -77,9 +64,6 @@ bool programRunning;
|
||||||
int yourInputStepLength;
|
int yourInputStepLength;
|
||||||
int yourInputCycleID;
|
int yourInputCycleID;
|
||||||
int yourInputNtransmitters;
|
int yourInputNtransmitters;
|
||||||
int yourInputNetwork;
|
|
||||||
String yourInputSSID;
|
|
||||||
String yourInputPassword;
|
|
||||||
long start_millis = 0;
|
long start_millis = 0;
|
||||||
long stop_millis = 0;
|
long stop_millis = 0;
|
||||||
long pause_until_millis = 0;
|
long pause_until_millis = 0;
|
||||||
|
|
@ -88,7 +72,15 @@ long pause_until_millis = 0;
|
||||||
const char index_html[] PROGMEM = R"rawliteral(
|
const char index_html[] PROGMEM = R"rawliteral(
|
||||||
<!DOCTYPE HTML><html><head>
|
<!DOCTYPE HTML><html><head>
|
||||||
<link rel="icon" href="data:,">
|
<link rel="icon" href="data:,">
|
||||||
<title>ESP Input Form</title>
|
<title>Vulpes Radio Orienteering Controller</title>
|
||||||
|
<style>
|
||||||
|
.inv_message {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
.inv_program {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||||
<script type="text/javascript">
|
<script type="text/javascript">
|
||||||
// Utility from https://webreflection.medium.com/using-the-input-datetime-local-9503e7efdce
|
// Utility from https://webreflection.medium.com/using-the-input-datetime-local-9503e7efdce
|
||||||
|
|
@ -129,13 +121,11 @@ const char index_html[] PROGMEM = R"rawliteral(
|
||||||
// Fill in the other form fields
|
// Fill in the other form fields
|
||||||
document.getElementById("send-program").value = %inputSend%;
|
document.getElementById("send-program").value = %inputSend%;
|
||||||
document.getElementById("message").value = %inputMsg%;
|
document.getElementById("message").value = %inputMsg%;
|
||||||
document.getElementById("network").value = %inputNetwork%;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
</script></head><body>
|
</script></head><body>
|
||||||
<h1>Vulpes Radio Orienteering Controller</h1>
|
<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
|
<p>Local time: <b><span id=local-time-unix></span></b></p>
|
||||||
(<a href="https://support.mozilla.org/en-US/questions/1297208">Firefox example</a>).</p>
|
|
||||||
|
|
||||||
<form action="/get" onsubmit="putDate(this);" accept-charset=utf-8>
|
<form action="/get" onsubmit="putDate(this);" accept-charset=utf-8>
|
||||||
<h2>General Settings</h2>
|
<h2>General Settings</h2>
|
||||||
|
|
@ -156,24 +146,29 @@ const char index_html[] PROGMEM = R"rawliteral(
|
||||||
<option value="5">5 - MO5</option>
|
<option value="5">5 - MO5</option>
|
||||||
</select><br>
|
</select><br>
|
||||||
|
|
||||||
|
<!-- Hidden unless "0 - Custom Message" is selected -->
|
||||||
|
<span id="message0" class="inv_message">
|
||||||
Custom message: <input type="text" name="inputCustomMsg" value = "%inputCustomMsg%"><br>
|
Custom message: <input type="text" name="inputCustomMsg" value = "%inputCustomMsg%"><br>
|
||||||
|
</span>
|
||||||
|
|
||||||
Speed: <input type="number" name="inputWPM" value = %inputWPM%> WPM
|
Speed: <input type="number" name="inputWPM" value = %inputWPM%> WPM
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
<!-- Hidden unless "2 - Cycle" is selected -->
|
||||||
|
<span id="program2" class="inv_program">
|
||||||
<h2>Cycle Settings</h2>
|
<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>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.<br>
|
||||||
<p>Cycle start time <input type="datetime-local" id="js_start_time_unix_entry" /><br>
|
Cycle start time <input type="datetime-local" id="js_start_time_unix_entry" /><br>
|
||||||
Current value: <b><span id=current-start></span></b>
|
Current value: <b><span id=current-start></span></b><br>
|
||||||
|
|
||||||
<!-- JS converts the entered start time to a unix timestamp, and copies that value
|
<!-- 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. -->
|
to this hidden field so the user doesn't have to see it. -->
|
||||||
<input type="hidden" name="inputStartTimeUnix" id="js_start_time_unix" /></p>
|
<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>
|
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>
|
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>
|
Number of transmitters: <input type="number" name="inputNtransmitters" min=1 value = %inputNtransmitters%><br>
|
||||||
</p>
|
</p>
|
||||||
|
</span>
|
||||||
|
|
||||||
<!-- This field is hidden so people don't change the submit time (it will be wrong).
|
<!-- This field is hidden so people don't change the submit time (it will be wrong).
|
||||||
The value is automatically filled in with JS. -->
|
The value is automatically filled in with JS. -->
|
||||||
|
|
@ -184,29 +179,41 @@ const char index_html[] PROGMEM = R"rawliteral(
|
||||||
|
|
||||||
<input type="submit" value="Submit"">
|
<input type="submit" value="Submit"">
|
||||||
</form>
|
</form>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<iframe style="display:none" name="hidden-form" id="hidden-form"></iframe>
|
<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 type="text/javascript">
|
||||||
|
// Show more stuff depending on selected values
|
||||||
|
// https://stackoverflow.com/a/24849350
|
||||||
|
show_message = function () {
|
||||||
|
'use strict';
|
||||||
|
var vis_message = document.querySelector('.vis_message'),
|
||||||
|
target = document.getElementById("message"+this.value);
|
||||||
|
if (vis_message !== null) {
|
||||||
|
vis_message.className = 'inv_message';
|
||||||
|
}
|
||||||
|
if (target !== null ) {
|
||||||
|
target.className = 'vis_message';
|
||||||
|
}
|
||||||
|
}
|
||||||
|
show_program = function () {
|
||||||
|
'use strict';
|
||||||
|
var vis_program = document.querySelector('.vis_program'),
|
||||||
|
target = document.getElementById("program"+this.value);
|
||||||
|
if (vis_program !== null) {
|
||||||
|
vis_program.className = 'inv_program';
|
||||||
|
}
|
||||||
|
if (target !== null ) {
|
||||||
|
target.className = 'vis_program';
|
||||||
|
}
|
||||||
|
}
|
||||||
|
document
|
||||||
|
.getElementById('message')
|
||||||
|
.addEventListener('change', show_message);
|
||||||
|
document
|
||||||
|
.getElementById('send-program')
|
||||||
|
.addEventListener('change', show_program);
|
||||||
</script>
|
</script>
|
||||||
</body></html>)rawliteral";
|
</body></html>)rawliteral";
|
||||||
|
|
||||||
|
|
@ -271,15 +278,6 @@ String processor(const String& var){
|
||||||
else if(var == "inputNtransmitters"){
|
else if(var == "inputNtransmitters"){
|
||||||
return readFile(SPIFFS, "/inputNtransmitters.txt");
|
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"){
|
else if(var == "inputFloat"){
|
||||||
return readFile(SPIFFS, "/inputFloat.txt");
|
return readFile(SPIFFS, "/inputFloat.txt");
|
||||||
} else if(var == "inputStartTimeUnix"){
|
} else if(var == "inputStartTimeUnix"){
|
||||||
|
|
@ -293,8 +291,6 @@ String processor(const String& var){
|
||||||
return String();
|
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
|
// Set up arduinomorse pin and default WPM
|
||||||
LEDMorseSender sender_blink(blinker, 10.0f); //f makes it a float
|
LEDMorseSender sender_blink(blinker, 10.0f); //f makes it a float
|
||||||
|
|
@ -328,11 +324,8 @@ void setup() {
|
||||||
//rtc.adjust(DateTime(2023, 9, 2, 17, 32, 0));
|
//rtc.adjust(DateTime(2023, 9, 2, 17, 32, 0));
|
||||||
}
|
}
|
||||||
|
|
||||||
// Report the RTC time after waiting two seconds
|
// Report the RTC time
|
||||||
// https://amiok.net/gitea/W1CDN/vulpes/issues/50#issuecomment-1376
|
Serial.print("RTC time on startup: ");
|
||||||
Serial.println("Wait 2s for RTC");
|
|
||||||
delay(2000);
|
|
||||||
Serial.println("RTC time on startup: ");
|
|
||||||
Serial.println(rtc.now().unixtime());
|
Serial.println(rtc.now().unixtime());
|
||||||
Serial.println(rtc.now().timestamp());
|
Serial.println(rtc.now().timestamp());
|
||||||
|
|
||||||
|
|
@ -370,9 +363,6 @@ void setup() {
|
||||||
yourInputStepLength = readFile(SPIFFS, "/inputStepLength.txt").toInt();
|
yourInputStepLength = readFile(SPIFFS, "/inputStepLength.txt").toInt();
|
||||||
yourInputCycleID = readFile(SPIFFS, "/inputCycleID.txt").toInt();
|
yourInputCycleID = readFile(SPIFFS, "/inputCycleID.txt").toInt();
|
||||||
yourInputNtransmitters = readFile(SPIFFS, "/inputNtransmitters.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
|
// Set WPM from saved value
|
||||||
sender_blink.setWPM(yourInputWPM);
|
sender_blink.setWPM(yourInputWPM);
|
||||||
sender_key.setWPM(yourInputWPM);
|
sender_key.setWPM(yourInputWPM);
|
||||||
|
|
@ -399,39 +389,21 @@ void setup() {
|
||||||
sender_key.setMessage(String("mo5 "));
|
sender_key.setMessage(String("mo5 "));
|
||||||
}
|
}
|
||||||
|
|
||||||
WiFi.setHostname("vulpes");
|
|
||||||
if (yourInputNetwork == 1){
|
|
||||||
// Attach to existing wifi
|
|
||||||
WiFi.mode(WIFI_STA);
|
WiFi.mode(WIFI_STA);
|
||||||
const char* ssid_char = yourInputSSID.c_str();
|
WiFi.begin(ssid, password);
|
||||||
const char* password_char = yourInputPassword.c_str();
|
|
||||||
WiFi.begin(ssid_char, password_char);
|
|
||||||
if (WiFi.waitForConnectResult() != WL_CONNECTED) {
|
if (WiFi.waitForConnectResult() != WL_CONNECTED) {
|
||||||
Serial.println("WiFi Failed! Setting up access point 'vulpes'...");
|
Serial.println("WiFi Failed!");
|
||||||
// If you fail to connect, act as new access point
|
return;
|
||||||
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.println();
|
||||||
Serial.print("IP Address: ");
|
Serial.print("IP Address: ");
|
||||||
Serial.println(WiFi.localIP());
|
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
|
// Send web page with input fields to client
|
||||||
server.on("/", HTTP_GET, [](AsyncWebServerRequest *request){
|
server.on("/", HTTP_GET, [](AsyncWebServerRequest *request){
|
||||||
request->send_P(200, "text/html", index_html, processor);
|
request->send_P(200, "text/html", index_html, processor);
|
||||||
});
|
});
|
||||||
|
|
||||||
// Form 1
|
|
||||||
// Send a GET request to <ESP_IP>/get?inputCustomMsg=<inputMessage>
|
// Send a GET request to <ESP_IP>/get?inputCustomMsg=<inputMessage>
|
||||||
server.on("/get", HTTP_GET, [] (AsyncWebServerRequest *request) {
|
server.on("/get", HTTP_GET, [] (AsyncWebServerRequest *request) {
|
||||||
String inputMessage;
|
String inputMessage;
|
||||||
|
|
@ -578,37 +550,6 @@ void setup() {
|
||||||
// https://techtutorialsx.com/2018/01/14/esp32-arduino-http-server-external-and-internal-redirects/
|
// https://techtutorialsx.com/2018/01/14/esp32-arduino-http-server-external-and-internal-redirects/
|
||||||
request->redirect("/");
|
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.onNotFound(notFound);
|
||||||
server.begin();
|
server.begin();
|
||||||
|
|
||||||
Loading…
Reference in New Issue
Block a user