Compare commits
26 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| cefe34c7bc | |||
| 388e75864a | |||
| b33db504a3 | |||
| 0765c47e4a | |||
| e7d97c1d6f | |||
| 4bd060ff22 | |||
| 4e6db88f7e | |||
| e3d98ed3dd | |||
| 535bd9388e | |||
| 8bc08569fe | |||
| 1f06c677c6 | |||
| 16a87c0f40 | |||
| 69f7471953 | |||
| e1f232eace | |||
| 274b70dbbe | |||
| 3e7d3cabfe | |||
| 40fd0a667a | |||
| 89e17efcfc | |||
| fb2ab88bc9 | |||
| e07aad2d7d | |||
| 358090db5d | |||
| bfc2b17ed4 | |||
| 6be0512146 | |||
| 6606be456b | |||
| 7f6308bb6f | |||
| 23c72790ef |
674
LICENSE
Normal file
@@ -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>.
|
||||
675
LICENSE.md
Normal file
@@ -0,0 +1,675 @@
|
||||
# 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>.
|
||||
11
README.md
@@ -77,4 +77,13 @@ sudo apt install nodejs npm nanopb
|
||||
1. After flashing, the ESP32 will either connect to the pre-configured Wi-Fi network or start an Access Point (APSTA).
|
||||
2. Check the serial monitor logs to find the IP address assigned to the device in STA mode, or the default AP address (usually `192.168.4.1`).
|
||||
3. Open a web browser and navigate to the device's IP address.
|
||||
4. You should now see the ODROID Remote control panel.
|
||||
4. You should now see the ODROID Remote control panel.
|
||||
|
||||
## Docs
|
||||
|
||||
- Hardkernel WiKi: [https://wiki.odroid.com/accessory/powermate](https://wiki.odroid.com/accessory/powermate)
|
||||
|
||||
## Repo
|
||||
|
||||
- Hardkernel Github: [https://github.com/hardkernel/odroid-powermate](https://github.com/hardkernel/odroid-powermate)
|
||||
- Original Repo: [https://github.com/shinys000114/odroid-powermate](https://github.com/shinys000114/odroid-powermate)
|
||||
283
docs/API.md
@@ -1,283 +0,0 @@
|
||||
# ODROID Remote API Documentation
|
||||
|
||||
This document outlines the HTTP REST and WebSocket APIs for communication between the web interface and the ESP32 device.
|
||||
|
||||
---
|
||||
|
||||
## WebSocket API
|
||||
|
||||
The WebSocket API provides a full-duplex communication channel for real-time data, such as sensor metrics and the
|
||||
interactive serial console. All server-to-client communication is done via binary WebSocket frames containing Protocol
|
||||
Buffers (protobuf) messages.
|
||||
|
||||
**Endpoint**: `/ws`
|
||||
|
||||
### Server-to-Client Messages
|
||||
|
||||
The server pushes binary messages to the client. Each message is a Protocol Buffers (protobuf) encoded `StatusMessage`.
|
||||
This top-level message uses a `oneof` field to carry different payload types.
|
||||
|
||||
The protobuf schema is defined in `proto/status.proto`.
|
||||
|
||||
```proto
|
||||
// Top-level message for all websocket communication
|
||||
message StatusMessage {
|
||||
oneof payload {
|
||||
SensorData sensor_data = 1;
|
||||
WifiStatus wifi_status = 2;
|
||||
UartData uart_data = 3;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
The client decodes the `StatusMessage` and then handles the specific payload:
|
||||
|
||||
| `oneof` payload field | Contained Message | Description |
|
||||
|-----------------------|-------------------|-----------------------------------------------------------------------------------------|
|
||||
| `sensor_data` | `SensorData` | Pushed periodically (e.g., every second) with the latest power metrics. |
|
||||
| `wifi_status` | `WifiStatus` | Pushed periodically or on change to update the current Wi-Fi connection status. |
|
||||
| `uart_data` | `UartData` | Forwards raw binary data from the ODROID's serial (UART) port to the client's terminal. |
|
||||
|
||||
### Client-to-Server Messages
|
||||
|
||||
The client sends raw binary/text data, which is interpreted as terminal input.
|
||||
|
||||
- **Description**: Raw binary data representing user input from the web terminal. This data is forwarded directly to the ODROID's serial (UART) port.
|
||||
- **Payload**: `(raw data)`
|
||||
|
||||
---
|
||||
|
||||
## HTTP REST API
|
||||
|
||||
The REST API is used for configuration and to trigger specific actions. All request and response bodies are in `application/json` format.
|
||||
|
||||
### Endpoint: `/api/control`
|
||||
|
||||
Manages power relays and system actions.
|
||||
|
||||
#### `GET /api/control`
|
||||
|
||||
Retrieves the current status of the power relays.
|
||||
|
||||
- **Success Response (200 OK)**
|
||||
```json
|
||||
{
|
||||
"load_12v_on": true,
|
||||
"load_5v_on": false
|
||||
}
|
||||
```
|
||||
- `load_12v_on` (boolean): The state of the main 12V power relay.
|
||||
- `load_5v_on` (boolean): The state of the 5V USB power relay.
|
||||
|
||||
#### `POST /api/control`
|
||||
|
||||
Sets the state of power relays or triggers a power action. You can send one or more commands in a single request.
|
||||
|
||||
- **Request Body Examples**:
|
||||
- To turn the main power on:
|
||||
```json
|
||||
{ "load_12v_on": true }
|
||||
```
|
||||
- To trigger a system reset:
|
||||
```json
|
||||
{ "reset_trigger": true }
|
||||
```
|
||||
- To toggle the power button:
|
||||
```json
|
||||
{ "power_trigger": true }
|
||||
```
|
||||
|
||||
- **Request Fields**:
|
||||
- `load_12v_on` (boolean, optional): Sets the state of the 12V relay.
|
||||
- `load_5v_on` (boolean, optional): Sets the state of the 5V relay.
|
||||
- `reset_trigger` (boolean, optional): If `true`, momentarily triggers the reset button (pulls the line low for 3 seconds). The action is triggered only on a `true` value.
|
||||
- `power_trigger` (boolean, optional): If `true`, momentarily triggers the power button (pulls the line low for 3 seconds). The action is triggered only on a `true` value.
|
||||
|
||||
- **Success Response (200 OK)**: `{"status":"ok"}`
|
||||
|
||||
---
|
||||
|
||||
### Endpoint: `/api/setting`
|
||||
|
||||
Manages all Wi-Fi, network, and system-related configurations.
|
||||
|
||||
#### `GET /api/setting`
|
||||
|
||||
Retrieves the complete current network and system configuration.
|
||||
|
||||
- **Success Response (200 OK)**
|
||||
```json
|
||||
{
|
||||
"connected": true,
|
||||
"ssid": "MyHome_WiFi",
|
||||
"rssi": -65,
|
||||
"mode": "apsta",
|
||||
"net_type": "static",
|
||||
"baudrate": "115200",
|
||||
"vin_current_limit": 8.0,
|
||||
"main_current_limit": 7.0,
|
||||
"usb_current_limit": 5.0,
|
||||
"ip": {
|
||||
"ip": "192.168.1.100",
|
||||
"gateway": "192.168.1.1",
|
||||
"subnet": "255.255.255.0",
|
||||
"dns1": "8.8.8.8",
|
||||
"dns2": "8.8.4.4"
|
||||
}
|
||||
}
|
||||
```
|
||||
- **Response Fields**:
|
||||
- `connected` (boolean): Current Wi-Fi connection state.
|
||||
- `ssid` (string): The SSID of the connected network.
|
||||
- `rssi` (integer): The Received Signal Strength Indicator in dBm. Only present if connected.
|
||||
- `mode` (string): The current Wi-Fi mode (`"sta"` or `"apsta"`).
|
||||
- `net_type` (string): The network type (`"dhcp"` or `"static"`).
|
||||
- `baudrate` (string): The current UART baud rate.
|
||||
- `vin_current_limit` (number): The current limit for VIN in Amps. `0` means disabled.
|
||||
- `main_current_limit` (number): The current limit for the Main channel in Amps. `0` means disabled.
|
||||
- `usb_current_limit` (number): The current limit for the USB channel in Amps. `0` means disabled.
|
||||
- `ip` (object): Contains IP configuration details. Present even if using DHCP (may show the last-leased IP).
|
||||
- `ip` (string): The device's IP address.
|
||||
- `gateway` (string): The network gateway address.
|
||||
- `subnet` (string): The network subnet mask.
|
||||
- `dns1` (string): The primary DNS server address.
|
||||
- `dns2` (string): The secondary DNS server address.
|
||||
|
||||
#### `POST /api/setting`
|
||||
|
||||
This is a multi-purpose endpoint. The server determines the action based on the fields provided in the request body.
|
||||
|
||||
- **Action: Connect to a Wi-Fi Network**
|
||||
- **Request Body**:
|
||||
```json
|
||||
{
|
||||
"ssid": "MyHome_WiFi",
|
||||
"password": "my_secret_password"
|
||||
}
|
||||
```
|
||||
- **Success Response (200 OK)**:
|
||||
```json
|
||||
{ "status": "connection_initiated" }
|
||||
```
|
||||
|
||||
- **Action: Configure Network Type (DHCP/Static)**
|
||||
- **Request Body (for DHCP)**:
|
||||
```json
|
||||
{ "net_type": "dhcp" }
|
||||
```
|
||||
- **Request Body (for Static IP)**:
|
||||
```json
|
||||
{
|
||||
"net_type": "static",
|
||||
"ip": "192.168.1.100",
|
||||
"gateway": "192.168.1.1",
|
||||
"subnet": "255.255.255.0",
|
||||
"dns1": "8.8.8.8",
|
||||
"dns2": "8.8.4.4"
|
||||
}
|
||||
```
|
||||
- **Success Response (200 OK)**:
|
||||
- `{"status":"dhcp_config_applied"}`
|
||||
- `{"status":"static_config_applied"}`
|
||||
|
||||
- **Action: Configure Wi-Fi Mode (STA/APSTA)**
|
||||
- **Request Body (for STA mode)**:
|
||||
```json
|
||||
{ "mode": "sta" }
|
||||
```
|
||||
- **Request Body (for AP+STA mode)**:
|
||||
```json
|
||||
{
|
||||
"mode": "apsta",
|
||||
"ap_ssid": "ODROID-Remote-AP",
|
||||
"ap_password": "hardkernel"
|
||||
}
|
||||
```
|
||||
*Note: `ap_password` is optional. If omitted, the AP will be open.*
|
||||
- **Success Response (200 OK)**: `{"status":"mode_switch_initiated"}`
|
||||
|
||||
- **Action: Configure UART Baud Rate**
|
||||
- **Request Body**:
|
||||
```json
|
||||
{ "baudrate": "115200" }
|
||||
```
|
||||
- **Success Response (200 OK)**:
|
||||
```json
|
||||
{ "status": "baudrate_updated" }
|
||||
```
|
||||
|
||||
- **Action: Configure Current Limits**
|
||||
- **Request Body**:
|
||||
*Note: You can set one or more limits in a single request. A value of `-1.0` disables the limit.*
|
||||
```json
|
||||
{
|
||||
"vin_current_limit": 7.5,
|
||||
"main_current_limit": 6.0,
|
||||
"usb_current_limit": -1.0
|
||||
}
|
||||
```
|
||||
- **Success Response (200 OK)**: `{"status":"current_limit_updated"}`
|
||||
|
||||
---
|
||||
|
||||
### Endpoint: `/api/wifi/scan`
|
||||
|
||||
Scans for available Wi-Fi networks.
|
||||
|
||||
#### `GET /api/wifi/scan`
|
||||
|
||||
- **Success Response (200 OK)**: Returns a JSON array of found networks.
|
||||
```json
|
||||
[
|
||||
{
|
||||
"ssid": "MyHome_WiFi",
|
||||
"rssi": -55,
|
||||
"authmode": "WPA2_PSK"
|
||||
},
|
||||
{
|
||||
"ssid": "GuestNetwork",
|
||||
"rssi": -78,
|
||||
"authmode": "OPEN"
|
||||
}
|
||||
]
|
||||
```
|
||||
- **Response Fields**:
|
||||
- `ssid` (string): The network's Service Set Identifier.
|
||||
- `rssi` (integer): Signal strength in dBm.
|
||||
- `authmode` (string): The authentication mode (e.g., `"OPEN"`, `"WPA_PSK"`, `"WPA2_PSK"`).
|
||||
|
||||
---
|
||||
|
||||
### Endpoint: `/datalog.csv`
|
||||
|
||||
Provides access to the historical sensor data log.
|
||||
|
||||
#### `GET /datalog.csv`
|
||||
|
||||
- **Description**: Downloads a CSV file containing the history of sensor data readings (voltage, current, power). The log is rotated when it reaches its maximum size (1MB).
|
||||
- **Success Response (200 OK)**: The body of the response is the CSV file content.
|
||||
- **Response Headers**:
|
||||
- `Content-Type: text/csv`
|
||||
- `Content-Disposition: attachment; filename="datalog.csv"`
|
||||
- **CSV Format**:
|
||||
```csv
|
||||
timestamp,voltage,current,power
|
||||
1672531200,12.01,1.52,18.25
|
||||
1672531201,12.02,1.53,18.39
|
||||
...
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### General Error Responses
|
||||
|
||||
In case of an error, the server will respond with an appropriate HTTP status code.
|
||||
|
||||
- **`400 Bad Request`**: The request is malformed, contains invalid parameters, or is otherwise incorrect. The response body may contain a JSON object with more details.
|
||||
```json
|
||||
{
|
||||
"error": "Invalid request body"
|
||||
}
|
||||
```
|
||||
- **`404 Not Found`**: The requested endpoint does not exist.
|
||||
- **`500 Internal Server Error`**: The server encountered an unexpected condition that prevented it from fulfilling the request.
|
||||
@@ -1,66 +0,0 @@
|
||||
# Custom firmware
|
||||
|
||||
If you want, you can create your own custom firmware.
|
||||
|
||||
## Install Tools
|
||||
|
||||
To build the source code, you need the following packages on Ubuntu 24.04.
|
||||
|
||||
```bash
|
||||
sudo apt install nodejs npm nanopb
|
||||
```
|
||||
|
||||
You need `esp-idf` version 5.4. It might be possible to build with the latest version, but it has not been confirmed.
|
||||
|
||||
First, install the necessary tools for esp-idf.
|
||||
|
||||
```bash
|
||||
sudo apt install git wget flex bison gperf python3 python3-pip python3-venv \
|
||||
cmake ninja-build ccache libffi-dev libssl-dev dfu-util libusb-1.0-0 \
|
||||
|
||||
```
|
||||
|
||||
Next, clone the esp-idf tool.
|
||||
|
||||
```bash
|
||||
mkdir -p ~/esp
|
||||
cd ~/esp
|
||||
git clone -b release/v5.4 --recursive https://github.com/espressif/esp-idf.git
|
||||
```
|
||||
|
||||
You need to install tools such as a compiler and a debugger.
|
||||
|
||||
```bash
|
||||
cd ~/esp/esp-idf
|
||||
./install.sh esp32c3
|
||||
```
|
||||
|
||||
Please prepare to build the source by running the shell for using esp-idf.
|
||||
```bash
|
||||
. $HOME/esp/esp-idf/export.sh
|
||||
```
|
||||
## Build custom firmware based on PowerMate
|
||||
|
||||
First, clone the PowerMate source code.
|
||||
```bash
|
||||
git clone https://github.com/shinys000114/odroid-powermate.git
|
||||
```
|
||||
|
||||
After connecting the USB Type-C cable to the PowerMate and the host PC, run the command below to build and update PowerMate.
|
||||
```bash
|
||||
cd odroid-powermate
|
||||
idf.py app flash monitor
|
||||
```
|
||||
|
||||
## Create a new project
|
||||
|
||||
Create a project with the command below and create your own firmware.
|
||||
|
||||
```bash
|
||||
idf.py create-project proj
|
||||
cd proj
|
||||
idf.py set-target esp32c3
|
||||
```
|
||||
|
||||
For a more detailed guide, please refer to the link below.
|
||||
[https://docs.espressif.com/projects/esp-idf/en/release-v5.4/esp32/get-started/linux-macos-setup.html#](https://docs.espressif.com/projects/esp-idf/en/release-v5.4/esp32/get-started/linux-macos-setup.html#)
|
||||
|
Before Width: | Height: | Size: 288 KiB |
|
Before Width: | Height: | Size: 454 KiB |
|
Before Width: | Height: | Size: 447 KiB |
|
Before Width: | Height: | Size: 498 KiB |
|
Before Width: | Height: | Size: 293 KiB |
|
Before Width: | Height: | Size: 69 KiB |
|
Before Width: | Height: | Size: 86 KiB |
|
Before Width: | Height: | Size: 54 KiB |
|
Before Width: | Height: | Size: 39 KiB |
|
Before Width: | Height: | Size: 257 KiB |
|
Before Width: | Height: | Size: 68 KiB |
|
Before Width: | Height: | Size: 207 KiB |
52
docs/pin.md
@@ -1,52 +0,0 @@
|
||||
# Connector and Pin Header Description
|
||||
|
||||
## J1 USB-C Connector
|
||||
|
||||
This terminal is for uploading firmware and checking program logs.
|
||||
It is recognized as a serial device and as a `ttyACM` device in Linux.
|
||||
To view the logs, you can use the command below.
|
||||
|
||||
```bash
|
||||
minicom -D /dev/ttyACM0 -b 115200
|
||||
```
|
||||
|
||||
## J2 UART Pin header
|
||||
|
||||
Connected to the `U0RXD`, `U0TXD` system UART of the ESP32-C3. Currently not used on this board.
|
||||
It can be used as GPIO through appropriate configuration in esp-idf.
|
||||
|
||||
## J3 ODROID UART Connector
|
||||
|
||||
Connects to the UART debug port of the ODROID.
|
||||
This connector is `X8821WRS-04`. you can use the [cable from the USB-UART 2 board](https://www.hardkernel.com/shop/usb-uart-2-module-kit-copy/).
|
||||
|
||||
## J4 GPIO Output
|
||||
|
||||
4 GPIO output pin headers. Used to trigger the power of external devices.
|
||||
|
||||
| Pin Number | Function | Function | Pin Number |
|
||||
|------------|--------------------|--------------------|------------|
|
||||
| 3 | Reserved | Reserved | 1 |
|
||||
| 4 | Reset (Open Drain) | Power (Open Drain) | 2 |
|
||||
|
||||
The Reset and Power pins can be used on the ODROID-M series and H series.
|
||||
|
||||
## J5 DC Input
|
||||
|
||||
Supports 9~21v input. You can use the DC power supply sold by Hardkernel.
|
||||
|
||||
## J6 DC Out
|
||||
|
||||
Outputs the switched power from the J5 input.
|
||||
|
||||
## J7 USB Power Out
|
||||
|
||||
Switched 5v voltage output.
|
||||
The output is set to 5.25V considering voltage drop. Please use with caution.
|
||||
|
||||
## J8 OLED Display Connector
|
||||
|
||||
**Reserved**
|
||||
|
||||
SSD1309 OLED Connector
|
||||
It cannot be used as GPIO for other purposes because it shares the I2C bus with `PCA9557PW`, `INA3221`.
|
||||
@@ -1,77 +0,0 @@
|
||||
# Settings
|
||||
|
||||
> **Warning**
|
||||
> Wi-Fi and IP related settings will restart the Wi-Fi service.
|
||||
> After applying the settings, you may need to reconnect to the page.
|
||||
>
|
||||
> Please be careful when applying settings. Incorrect settings may prevent you from connecting to the device.
|
||||
> If you have problems with the device settings, connect the debug USB-C connector to check the device's logs.
|
||||
> If necessary, you can re-update the firmware to initialize the device.
|
||||
|
||||
## Connect to Wi-Fi
|
||||
|
||||
The device boots in APSTA mode by default and services the following AP.
|
||||
|
||||
- SSID: powermate
|
||||
- Password: hardkernel
|
||||
|
||||
After connecting to the above AP using a smartphone, etc., you can configure the device by accessing the
|
||||
`http://192.168.4.1` address.
|
||||
|
||||
> **Warning**
|
||||
> A warning that the AP does not have internet may appear. Please press `Allow connection` to connect to the device.
|
||||
|
||||
You can open the settings window by pressing the gear button at the top.
|
||||
Press the Scan button to see a list of nearby APs.
|
||||
|
||||
<img src="img/1000030234.jpg" width="300">
|
||||
|
||||
After entering the password, press the Connect button and PowerMate will attempt to connect to the AP.
|
||||
For public APs, leave the Password blank.
|
||||
|
||||
<img src="img/1000030235.jpg" width="300">
|
||||
|
||||
|
||||
|
||||
<img src="img/1000030236.jpg" width="300">
|
||||
|
||||
When Wi-Fi is connected, the green SSID name appears at the top of the page.
|
||||
|
||||
<img src="img/1000030237.jpg" width="300">
|
||||
|
||||
## Set static ip
|
||||
|
||||
You can assign the IP of the device yourself.
|
||||
You can set the IP directly by turning on the `Use Static IP` toggle in the `Network` tab.
|
||||
|
||||

|
||||
|
||||
## AP Mode
|
||||
|
||||
Configure the AP function of PowerMate.
|
||||
|
||||
If you do not need the AP service, it is recommended to disable it.
|
||||
|
||||

|
||||
|
||||
## Current Limit
|
||||
|
||||
Monitors the current of PowerMate, and if a value higher than the set current is detected, all load switches are turned
|
||||
off.
|
||||
|
||||

|
||||
|
||||
## Device
|
||||
|
||||
Sets the UART Baudrate. Please match it with the baudrate of the connected ODROID.
|
||||
|
||||
| ODROID | Baud rate |
|
||||
|------------------|----------------------------|
|
||||
| ODROID-C4 | 115200 |
|
||||
| ODROID-C5 | 921600 |
|
||||
| ODROID-M1/M1S/M2 | 1500000 |
|
||||
| ODROID-H3/4 | According to user settings |
|
||||
|
||||
You can reboot the PowerMate. The state of the load switch does not change due to rebooting.
|
||||
|
||||

|
||||
24
docs/uart.md
@@ -1,24 +0,0 @@
|
||||
# UART Terminal
|
||||
|
||||
> **Warning**
|
||||
> Data drop may occur depending on the communication quality.
|
||||
|
||||

|
||||
|
||||
You can see the UART terminal in the Device tab.
|
||||
|
||||
You can specify the baud rate in `Setting > Device`, and the supported baud rates are 9600-1500000.
|
||||
|
||||

|
||||
|
||||
## ANSI Color
|
||||
|
||||
Supports the color table of the terminal.
|
||||
|
||||
```bash
|
||||
odroid@server:~$ TERM=xterm-256color /bin/bash
|
||||
```
|
||||
|
||||

|
||||
|
||||

|
||||
5
example/logger/.gitignore
vendored
Normal file
@@ -0,0 +1,5 @@
|
||||
/.venv/
|
||||
/venv/
|
||||
status_pb2.py
|
||||
test.csv
|
||||
plot.png
|
||||
41
example/logger/README.md
Normal file
@@ -0,0 +1,41 @@
|
||||
# Power Consumption Logger Example
|
||||
|
||||
Based on this script, you can monitor power consumption and implement graph plotting.
|
||||
|
||||
## How to Run the Script
|
||||
|
||||
### Install Python Virtual Environment
|
||||
|
||||
```shell
|
||||
sudo apt install virtualenv
|
||||
virtualenv venv
|
||||
source venv/bin/activate
|
||||
```
|
||||
|
||||
### Install require package
|
||||
|
||||
```shell
|
||||
pip install grpcio-tools requests websockets protobuf pandas matplotlib
|
||||
```
|
||||
|
||||
### Build `status_pb2.py`
|
||||
|
||||
```shell
|
||||
python -m grpc_tools.protoc -I ../../proto --python_out=. status.proto
|
||||
```
|
||||
|
||||
### Execute script
|
||||
|
||||
#### Power consumption collection
|
||||
```shell
|
||||
# python3 logger.py -u <username> -o <name.csv> -p <password> <address>
|
||||
python3 logger.py -u admin -p password -o test.csv 192.168.30.5
|
||||
```
|
||||
|
||||
#### Plot data
|
||||
|
||||
```shell
|
||||
python3 csv_2_plot.py test.csv plot.png [--type power voltage current]
|
||||
```
|
||||
|
||||

|
||||
108
example/logger/csv_2_plot.py
Normal file
@@ -0,0 +1,108 @@
|
||||
import argparse
|
||||
|
||||
import matplotlib.dates as mdates
|
||||
import matplotlib.pyplot as plt
|
||||
import pandas as pd
|
||||
|
||||
|
||||
def plot_power_data(csv_path, output_path, plot_types):
|
||||
"""
|
||||
Reads power data from a CSV file and generates a plot image.
|
||||
|
||||
Args:
|
||||
csv_path (str): The path to the input CSV file.
|
||||
output_path (str): The path to save the output plot image.
|
||||
plot_types (list): A list of strings indicating which plots to generate
|
||||
(e.g., ['power', 'voltage', 'current']).
|
||||
"""
|
||||
try:
|
||||
# Read the CSV file into a pandas DataFrame
|
||||
# The 'timestamp' column is parsed as dates
|
||||
df = pd.read_csv(csv_path, parse_dates=['timestamp'])
|
||||
print(f"Successfully loaded {len(df)} records from '{csv_path}'")
|
||||
except FileNotFoundError:
|
||||
print(f"Error: The file '{csv_path}' was not found.")
|
||||
return
|
||||
except Exception as e:
|
||||
print(f"An error occurred while reading the CSV file: {e}")
|
||||
return
|
||||
|
||||
# --- Plotting Configuration ---
|
||||
plot_configs = {
|
||||
'power': {'title': 'Power Consumption', 'ylabel': 'Power (W)',
|
||||
'cols': ['vin_power', 'main_power', 'usb_power']},
|
||||
'voltage': {'title': 'Voltage', 'ylabel': 'Voltage (V)',
|
||||
'cols': ['vin_voltage', 'main_voltage', 'usb_voltage']},
|
||||
'current': {'title': 'Current', 'ylabel': 'Current (A)', 'cols': ['vin_current', 'main_current', 'usb_current']}
|
||||
}
|
||||
channel_labels = ['VIN', 'MAIN', 'USB']
|
||||
channel_colors = ['red', 'green', 'blue']
|
||||
|
||||
num_plots = len(plot_types)
|
||||
if num_plots == 0:
|
||||
print("No plot types selected. Exiting.")
|
||||
return
|
||||
|
||||
# Create a figure and a set of subplots based on the number of selected plot types.
|
||||
# sharex=True makes all subplots share the same x-axis (time)
|
||||
# squeeze=False ensures that 'axes' is always a 2D array, even if num_plots is 1.
|
||||
fig, axes = plt.subplots(num_plots, 1, figsize=(15, 6 * num_plots), sharex=True, squeeze=False)
|
||||
axes = axes.flatten() # Flatten the 2D array to 1D for easier iteration
|
||||
|
||||
# --- Loop through selected plot types and generate plots ---
|
||||
for i, plot_type in enumerate(plot_types):
|
||||
ax = axes[i]
|
||||
config = plot_configs[plot_type]
|
||||
|
||||
for j, col_name in enumerate(config['cols']):
|
||||
ax.plot(df['timestamp'], df[col_name], label=channel_labels[j], color=channel_colors[j])
|
||||
|
||||
ax.set_title(config['title'])
|
||||
ax.set_ylabel(config['ylabel'])
|
||||
ax.legend()
|
||||
ax.grid(True, which='both', linestyle='--', linewidth=0.5)
|
||||
|
||||
# --- Formatting the x-axis (Time) ---
|
||||
# Improve date formatting on the x-axis
|
||||
# Apply formatting to the last subplot's x-axis
|
||||
last_ax = axes[-1]
|
||||
last_ax.xaxis.set_major_formatter(mdates.DateFormatter('%H:%M:%S'))
|
||||
last_ax.xaxis.set_major_locator(plt.MaxNLocator(15)) # Limit the number of ticks
|
||||
plt.xlabel('Time')
|
||||
plt.xticks(rotation=45)
|
||||
|
||||
# Add a main title to the figure
|
||||
start_time = df['timestamp'].iloc[0].strftime('%Y-%m-%d %H:%M:%S')
|
||||
end_time = df['timestamp'].iloc[-1].strftime('%H:%M:%S')
|
||||
fig.suptitle(f'ODROID Power Log ({start_time} to {end_time})', fontsize=16, y=0.95)
|
||||
|
||||
# Adjust layout to prevent titles/labels from overlapping
|
||||
plt.tight_layout(rect=[0, 0, 1, 0.94])
|
||||
|
||||
# --- Save the plot to a file ---
|
||||
try:
|
||||
plt.savefig(output_path, dpi=150)
|
||||
print(f"Plot successfully saved to '{output_path}'")
|
||||
except Exception as e:
|
||||
print(f"An error occurred while saving the plot: {e}")
|
||||
|
||||
|
||||
def main():
|
||||
parser = argparse.ArgumentParser(description="Generate a plot from an Odroid PowerMate CSV log file.")
|
||||
parser.add_argument("input_csv", help="Path to the input CSV log file.")
|
||||
parser.add_argument("output_image", help="Path to save the output plot image (e.g., plot.png).")
|
||||
parser.add_argument(
|
||||
"-t", "--type",
|
||||
nargs='+',
|
||||
choices=['power', 'voltage', 'current'],
|
||||
default=['power', 'voltage', 'current'],
|
||||
help="Types of plots to generate. Choose from 'power', 'voltage', 'current'. "
|
||||
"Default is to generate all three."
|
||||
)
|
||||
args = parser.parse_args()
|
||||
|
||||
plot_power_data(args.input_csv, args.output_image, args.type)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
152
example/logger/logger.py
Normal file
@@ -0,0 +1,152 @@
|
||||
import argparse
|
||||
import asyncio
|
||||
import csv
|
||||
import requests
|
||||
import websockets
|
||||
from datetime import datetime
|
||||
|
||||
# Import the status_pb2.py file generated by `protoc`.
|
||||
# This file must be in the same directory as logger.py.
|
||||
import status_pb2
|
||||
|
||||
|
||||
class OdroidPowerLogger:
|
||||
"""
|
||||
A class to connect to the Odroid Smart Power monitoring server and log power data.
|
||||
1. Logs into the server via an HTTP POST request to obtain an authentication token.
|
||||
2. Connects to the WebSocket using the obtained token.
|
||||
3. Receives and decodes binary data in Protobuf format, then prints it.
|
||||
"""
|
||||
|
||||
def __init__(self, host, username, password, output_file=None):
|
||||
self.host = host
|
||||
self.username = username
|
||||
self.password = password
|
||||
self.base_url = f"http://{self.host}"
|
||||
self.ws_url = f"ws://{self.host}/ws"
|
||||
self.output_file = output_file
|
||||
self.token = None
|
||||
|
||||
def login(self):
|
||||
"""Logs into the server to retrieve an authentication token."""
|
||||
login_url = f"{self.base_url}/login"
|
||||
payload = {"username": self.username, "password": self.password}
|
||||
try:
|
||||
print(f"Attempting to log in to '{login_url}'...")
|
||||
response = requests.post(login_url, json=payload, timeout=5)
|
||||
response.raise_for_status()
|
||||
|
||||
response_json = response.json()
|
||||
if "token" in response_json:
|
||||
self.token = response_json["token"]
|
||||
print("Login successful! Token received.")
|
||||
return True
|
||||
else:
|
||||
print("Login failed: No token in response.")
|
||||
return False
|
||||
except requests.exceptions.RequestException as e:
|
||||
print(f"Error during login: {e}")
|
||||
return False
|
||||
|
||||
async def listen_power_data(self):
|
||||
"""Connects to the WebSocket to receive and log power data."""
|
||||
if not self.token:
|
||||
print("Cannot connect to WebSocket without an authentication token.")
|
||||
return
|
||||
|
||||
# Add the authentication token as a query parameter
|
||||
uri = f"{self.ws_url}?token={self.token}"
|
||||
|
||||
csv_file = None
|
||||
csv_writer = None
|
||||
|
||||
try:
|
||||
# --- CSV File Handling ---
|
||||
if self.output_file:
|
||||
try:
|
||||
# Open the file in write mode, with newline='' to prevent extra blank rows
|
||||
csv_file = open(self.output_file, 'w', newline='', encoding='utf-8')
|
||||
csv_writer = csv.writer(csv_file)
|
||||
|
||||
# Write header
|
||||
header = [
|
||||
'timestamp', 'uptime_sec',
|
||||
'vin_voltage', 'vin_current', 'vin_power',
|
||||
'main_voltage', 'main_current', 'main_power',
|
||||
'usb_voltage', 'usb_current', 'usb_power'
|
||||
]
|
||||
csv_writer.writerow(header)
|
||||
print(f"Logging data to {self.output_file}")
|
||||
except IOError as e:
|
||||
print(f"Error opening CSV file: {e}")
|
||||
# If file can't be opened, disable CSV writing
|
||||
csv_file = None
|
||||
csv_writer = None
|
||||
# --- End CSV File Handling ---
|
||||
|
||||
async with websockets.connect(uri) as websocket:
|
||||
print(f"Connected to WebSocket: {uri}")
|
||||
while True:
|
||||
# Receive binary message from the server
|
||||
message_bytes = await websocket.recv()
|
||||
|
||||
# Decode the Protobuf message
|
||||
status_message = status_pb2.StatusMessage()
|
||||
status_message.ParseFromString(message_bytes)
|
||||
|
||||
# Process only if the payload type is 'sensor_data'
|
||||
if status_message.WhichOneof('payload') == 'sensor_data':
|
||||
sensor_data = status_message.sensor_data
|
||||
ts_dt = datetime.fromtimestamp(sensor_data.timestamp)
|
||||
ts_str = ts_dt.strftime('%Y-%m-%d %H:%M:%S')
|
||||
|
||||
print(f"--- {ts_str} (Uptime: {sensor_data.uptime_sec}s) ---")
|
||||
|
||||
# Print data for each channel
|
||||
for name, channel in [('VIN', sensor_data.vin), ('MAIN', sensor_data.main),
|
||||
('USB', sensor_data.usb)]:
|
||||
print(
|
||||
f" {name:<4}: {channel.voltage:5.2f} V | {channel.current:5.3f} A | {channel.power:5.2f} W")
|
||||
|
||||
# Write to CSV if enabled
|
||||
if csv_writer:
|
||||
row = [
|
||||
ts_dt.isoformat(), sensor_data.uptime_sec,
|
||||
sensor_data.vin.voltage, sensor_data.vin.current, sensor_data.vin.power,
|
||||
sensor_data.main.voltage, sensor_data.main.current, sensor_data.main.power,
|
||||
sensor_data.usb.voltage, sensor_data.usb.current, sensor_data.usb.power
|
||||
]
|
||||
csv_writer.writerow(row)
|
||||
|
||||
except websockets.exceptions.ConnectionClosed as e:
|
||||
print(f"WebSocket connection closed: {e}")
|
||||
except Exception as e:
|
||||
print(f"Error during WebSocket processing: {e}")
|
||||
finally:
|
||||
if csv_file:
|
||||
csv_file.close()
|
||||
print(f"\nCSV file '{self.output_file}' saved.")
|
||||
|
||||
async def run(self):
|
||||
"""Runs the logger."""
|
||||
if self.login():
|
||||
await self.listen_power_data()
|
||||
|
||||
|
||||
async def main():
|
||||
parser = argparse.ArgumentParser(description="Odroid Smart Power Data Logger")
|
||||
parser.add_argument("host", help="Server's host address or IP (e.g., 192.168.1.10)")
|
||||
parser.add_argument("-u", "--username", required=True, help="Login username")
|
||||
parser.add_argument("-p", "--password", required=True, help="Login password")
|
||||
parser.add_argument("-o", "--output", help="Path to the output CSV file.")
|
||||
args = parser.parse_args()
|
||||
|
||||
logger = OdroidPowerLogger(host=args.host, username=args.username, password=args.password, output_file=args.output)
|
||||
await logger.run()
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
try:
|
||||
asyncio.run(main())
|
||||
except KeyboardInterrupt:
|
||||
print("\nExiting program.")
|
||||
BIN
example/logger/plot.png
Normal file
|
After Width: | Height: | Size: 272 KiB |
@@ -16,7 +16,7 @@ endif ()
|
||||
|
||||
# Register the component. Now, CMake knows how GZ_OUTPUT_FILE is generated
|
||||
# and can correctly handle the dependency for embedding.
|
||||
idf_component_register(SRC_DIRS "app" "nconfig" "wifi" "indicator" "system" "service" "proto"
|
||||
idf_component_register(SRC_DIRS "app" "nconfig" "wifi" "indicator" "service" "proto"
|
||||
INCLUDE_DIRS "include" "proto"
|
||||
EMBED_FILES ${GZ_OUTPUT_FILE}
|
||||
)
|
||||
|
||||
@@ -11,6 +11,7 @@
|
||||
#include "nvs_flash.h"
|
||||
#include "system.h"
|
||||
#include "wifi.h"
|
||||
#include "storage.h"
|
||||
|
||||
void app_main(void)
|
||||
{
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
dependencies:
|
||||
espressif/led_indicator: ^1.1.1
|
||||
joltwallet/littlefs: ==1.20.1
|
||||
esp-idf-lib/ina3221: ^1.1.7
|
||||
esp-idf-lib/pca9557: ^1.0.7
|
||||
nikas-belogolov/nanopb: ^1.0.0
|
||||
|
||||
@@ -42,6 +42,8 @@ enum nconfig_type
|
||||
VIN_CURRENT_LIMIT, ///< The maximum current limit for the VIN.
|
||||
MAIN_CURRENT_LIMIT, ///< The maximum current limit for the MAIN out.
|
||||
USB_CURRENT_LIMIT, ///< The maximum current limit for the USB out.
|
||||
PAGE_USERNAME, ///< Webpage username
|
||||
PAGE_PASSWORD, ///< Webpage password
|
||||
NCONFIG_TYPE_MAX, ///< Sentinel for the maximum number of configuration types.
|
||||
};
|
||||
|
||||
|
||||
6
main/include/storage.h
Normal file
@@ -0,0 +1,6 @@
|
||||
#ifndef STORAGE_H_
|
||||
#define STORAGE_H_
|
||||
|
||||
void storage_init(void);
|
||||
|
||||
#endif /* STORAGE_H_ */
|
||||
@@ -28,6 +28,8 @@ const static char* keys[NCONFIG_TYPE_MAX] = {
|
||||
[VIN_CURRENT_LIMIT] = "vin_climit",
|
||||
[MAIN_CURRENT_LIMIT] = "main_climit",
|
||||
[USB_CURRENT_LIMIT] = "usb_climit",
|
||||
[PAGE_USERNAME] = "username",
|
||||
[PAGE_PASSWORD] = "password",
|
||||
};
|
||||
|
||||
struct default_value
|
||||
@@ -50,6 +52,8 @@ struct default_value const default_values[] = {
|
||||
{VIN_CURRENT_LIMIT, "4.0"},
|
||||
{MAIN_CURRENT_LIMIT, "3.0"},
|
||||
{USB_CURRENT_LIMIT, "3.0"},
|
||||
{PAGE_USERNAME, "admin"},
|
||||
{PAGE_PASSWORD, "password"},
|
||||
};
|
||||
|
||||
esp_err_t init_nconfig()
|
||||
|
||||
222
main/service/auth.c
Normal file
@@ -0,0 +1,222 @@
|
||||
#include "auth.h"
|
||||
|
||||
#include <esp_http_server.h>
|
||||
#include <esp_random.h>
|
||||
#include <stdlib.h>
|
||||
#include <string.h>
|
||||
#include <time.h>
|
||||
#include "esp_log.h"
|
||||
#include "freertos/FreeRTOS.h"
|
||||
#include "freertos/semphr.h"
|
||||
|
||||
static const char* TAG = "AUTH";
|
||||
|
||||
typedef struct
|
||||
{
|
||||
char token[TOKEN_LENGTH];
|
||||
bool active;
|
||||
time_t creation_time;
|
||||
} auth_token_t;
|
||||
|
||||
static auth_token_t s_tokens[MAX_TOKENS];
|
||||
static SemaphoreHandle_t s_token_mutex;
|
||||
|
||||
void auth_init(void)
|
||||
{
|
||||
s_token_mutex = xSemaphoreCreateMutex();
|
||||
if (s_token_mutex == NULL)
|
||||
{
|
||||
ESP_LOGE(TAG, "Failed to create token mutex");
|
||||
return;
|
||||
}
|
||||
for (int i = 0; i < MAX_TOKENS; i++)
|
||||
{
|
||||
s_tokens[i].active = false;
|
||||
s_tokens[i].token[0] = '\0';
|
||||
}
|
||||
ESP_LOGI(TAG, "Auth module initialized.");
|
||||
}
|
||||
|
||||
char* auth_generate_token(void)
|
||||
{
|
||||
if (xSemaphoreTake(s_token_mutex, portMAX_DELAY) != pdTRUE)
|
||||
{
|
||||
ESP_LOGE(TAG, "Failed to take token mutex");
|
||||
return NULL;
|
||||
}
|
||||
|
||||
int free_slot = -1;
|
||||
for (int i = 0; i < MAX_TOKENS; i++)
|
||||
{
|
||||
if (!s_tokens[i].active)
|
||||
{
|
||||
free_slot = i;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
if (free_slot == -1)
|
||||
{
|
||||
ESP_LOGW(TAG, "No free token slots available. Invalidating oldest token.");
|
||||
time_t oldest_time = time(NULL);
|
||||
int oldest_idx = -1;
|
||||
for (int i = 0; i < MAX_TOKENS; i++)
|
||||
{
|
||||
if (s_tokens[i].active && s_tokens[i].creation_time < oldest_time)
|
||||
{
|
||||
oldest_time = s_tokens[i].creation_time;
|
||||
oldest_idx = i;
|
||||
}
|
||||
}
|
||||
if (oldest_idx != -1)
|
||||
{
|
||||
s_tokens[oldest_idx].active = false;
|
||||
free_slot = oldest_idx;
|
||||
ESP_LOGI(TAG, "Oldest token at index %d invalidated.", oldest_idx);
|
||||
}
|
||||
else
|
||||
{
|
||||
ESP_LOGE(TAG, "Could not find an oldest token to invalidate. This should not happen if all are active.");
|
||||
xSemaphoreGive(s_token_mutex);
|
||||
return NULL;
|
||||
}
|
||||
}
|
||||
|
||||
const char charset[] = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789";
|
||||
char* new_token = (char*)malloc(TOKEN_LENGTH);
|
||||
if (new_token == NULL)
|
||||
{
|
||||
ESP_LOGE(TAG, "Failed to allocate memory for new token");
|
||||
xSemaphoreGive(s_token_mutex);
|
||||
return NULL;
|
||||
}
|
||||
|
||||
for (int i = 0; i < TOKEN_LENGTH - 1; i++)
|
||||
{
|
||||
new_token[i] = charset[esp_random() % (sizeof(charset) - 1)];
|
||||
}
|
||||
new_token[TOKEN_LENGTH - 1] = '\0';
|
||||
|
||||
strncpy(s_tokens[free_slot].token, new_token, TOKEN_LENGTH);
|
||||
s_tokens[free_slot].active = true;
|
||||
s_tokens[free_slot].creation_time = time(NULL);
|
||||
|
||||
ESP_LOGI(TAG, "Generated new token at slot %d: %s", free_slot, new_token);
|
||||
|
||||
xSemaphoreGive(s_token_mutex);
|
||||
return new_token;
|
||||
}
|
||||
|
||||
bool auth_validate_token(const char* token)
|
||||
{
|
||||
if (token == NULL)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
if (xSemaphoreTake(s_token_mutex, portMAX_DELAY) != pdTRUE)
|
||||
{
|
||||
ESP_LOGE(TAG, "Failed to take token mutex");
|
||||
return false;
|
||||
}
|
||||
|
||||
bool valid = false;
|
||||
for (int i = 0; i < MAX_TOKENS; i++)
|
||||
{
|
||||
if (s_tokens[i].active && strcmp(s_tokens[i].token, token) == 0)
|
||||
{
|
||||
valid = true;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
xSemaphoreGive(s_token_mutex);
|
||||
return valid;
|
||||
}
|
||||
|
||||
void auth_invalidate_token(const char* token)
|
||||
{
|
||||
if (token == NULL)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
if (xSemaphoreTake(s_token_mutex, portMAX_DELAY) != pdTRUE)
|
||||
{
|
||||
ESP_LOGE(TAG, "Failed to take token mutex");
|
||||
return;
|
||||
}
|
||||
|
||||
for (int i = 0; i < MAX_TOKENS; i++)
|
||||
{
|
||||
if (s_tokens[i].active && strcmp(s_tokens[i].token, token) == 0)
|
||||
{
|
||||
s_tokens[i].active = false;
|
||||
s_tokens[i].token[0] = '\0'; // Clear token string
|
||||
ESP_LOGI(TAG, "Token at slot %d invalidated.", i);
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
xSemaphoreGive(s_token_mutex);
|
||||
}
|
||||
|
||||
void auth_cleanup_expired_tokens(void) { ESP_LOGD(TAG, "auth_cleanup_expired_tokens called (no-op for now)."); }
|
||||
|
||||
static const char* get_token_from_header(httpd_req_t* req)
|
||||
{
|
||||
char* auth_header = NULL;
|
||||
size_t buf_len;
|
||||
|
||||
if (httpd_req_get_hdr_value_len(req, "Authorization") == 0)
|
||||
{
|
||||
return NULL;
|
||||
}
|
||||
|
||||
buf_len = httpd_req_get_hdr_value_len(req, "Authorization") + 1;
|
||||
auth_header = (char*)malloc(buf_len);
|
||||
if (auth_header == NULL)
|
||||
{
|
||||
ESP_LOGE(TAG, "Failed to allocate memory for auth header");
|
||||
return NULL;
|
||||
}
|
||||
|
||||
if (httpd_req_get_hdr_value_str(req, "Authorization", auth_header, buf_len) != ESP_OK)
|
||||
{
|
||||
free(auth_header);
|
||||
return NULL;
|
||||
}
|
||||
|
||||
if (strncmp(auth_header, "Bearer ", 7) == 0)
|
||||
{
|
||||
const char* token = auth_header + 7;
|
||||
return token;
|
||||
}
|
||||
|
||||
free(auth_header);
|
||||
return NULL;
|
||||
}
|
||||
|
||||
esp_err_t api_auth_check(httpd_req_t* req)
|
||||
{
|
||||
const char* token = get_token_from_header(req);
|
||||
|
||||
if (token == NULL)
|
||||
{
|
||||
ESP_LOGW(TAG, "API access attempt without token for URI: %s", req->uri);
|
||||
httpd_resp_send_err(req, HTTPD_401_UNAUTHORIZED, "Authorization token required");
|
||||
return ESP_FAIL;
|
||||
}
|
||||
|
||||
if (!auth_validate_token(token))
|
||||
{
|
||||
ESP_LOGW(TAG, "API access attempt with invalid token for URI: %s", req->uri);
|
||||
httpd_resp_send_err(req, HTTPD_401_UNAUTHORIZED, "Invalid or expired token");
|
||||
free((void*)token - 7);
|
||||
return ESP_FAIL;
|
||||
}
|
||||
|
||||
ESP_LOGD(TAG, "Token validated for URI: %s", req->uri);
|
||||
free((void*)token - 7);
|
||||
return ESP_OK;
|
||||
}
|
||||
28
main/service/auth.h
Normal file
@@ -0,0 +1,28 @@
|
||||
#ifndef AUTH_H
|
||||
#define AUTH_H
|
||||
|
||||
#include <stdbool.h>
|
||||
#include "esp_err.h"
|
||||
#include "esp_http_server.h"
|
||||
|
||||
#define MAX_TOKENS 4
|
||||
#define TOKEN_LENGTH 33 // 32 characters + null terminator
|
||||
|
||||
// Function to initialize the authentication module
|
||||
void auth_init(void);
|
||||
|
||||
// Function to generate a new token
|
||||
char* auth_generate_token(void);
|
||||
|
||||
// Function to validate a token
|
||||
bool auth_validate_token(const char* token);
|
||||
|
||||
// Function to invalidate a token (e.g., on logout)
|
||||
void auth_invalidate_token(const char* token);
|
||||
|
||||
// Function to clean up expired tokens (if any)
|
||||
void auth_cleanup_expired_tokens(void);
|
||||
|
||||
esp_err_t api_auth_check(httpd_req_t* req);
|
||||
|
||||
#endif // AUTH_H
|
||||
@@ -1,3 +1,4 @@
|
||||
#include "auth.h"
|
||||
#include "cJSON.h"
|
||||
#include "driver/gpio.h"
|
||||
#include "esp_http_server.h"
|
||||
@@ -8,6 +9,12 @@
|
||||
|
||||
static esp_err_t control_get_handler(httpd_req_t* req)
|
||||
{
|
||||
esp_err_t err = api_auth_check(req);
|
||||
if (err != ESP_OK)
|
||||
{
|
||||
return err;
|
||||
}
|
||||
|
||||
cJSON* root = cJSON_CreateObject();
|
||||
|
||||
cJSON_AddBoolToObject(root, "load_12v_on", get_main_load_switch());
|
||||
@@ -25,6 +32,12 @@ static esp_err_t control_get_handler(httpd_req_t* req)
|
||||
|
||||
static esp_err_t control_post_handler(httpd_req_t* req)
|
||||
{
|
||||
esp_err_t err = api_auth_check(req);
|
||||
if (err != ESP_OK)
|
||||
{
|
||||
return err;
|
||||
}
|
||||
|
||||
char buf[128];
|
||||
int ret, remaining = req->content_len;
|
||||
|
||||
|
||||
@@ -1,157 +0,0 @@
|
||||
#include "datalog.h"
|
||||
#include <stdio.h>
|
||||
#include <stdlib.h>
|
||||
#include <string.h>
|
||||
#include <sys/stat.h>
|
||||
#include <unistd.h>
|
||||
#include "esp_littlefs.h"
|
||||
#include "esp_log.h"
|
||||
|
||||
static const char* TAG = "datalog";
|
||||
static const char* LOG_FILE_PATH = "/littlefs/datalog.csv";
|
||||
|
||||
#define MAX_LOG_SIZE (700 * 1024)
|
||||
|
||||
void datalog_init(void)
|
||||
{
|
||||
ESP_LOGI(TAG, "Initializing DataLog with LittleFS");
|
||||
|
||||
esp_vfs_littlefs_conf_t conf = {
|
||||
.base_path = "/littlefs",
|
||||
.partition_label = "littlefs",
|
||||
.format_if_mount_failed = true,
|
||||
.dont_mount = false,
|
||||
};
|
||||
|
||||
esp_err_t ret = esp_vfs_littlefs_register(&conf);
|
||||
|
||||
if (ret != ESP_OK)
|
||||
{
|
||||
if (ret == ESP_FAIL)
|
||||
{
|
||||
ESP_LOGE(TAG, "Failed to mount or format filesystem");
|
||||
}
|
||||
else if (ret == ESP_ERR_NOT_FOUND)
|
||||
{
|
||||
ESP_LOGE(TAG, "Failed to find LittleFS partition");
|
||||
}
|
||||
else
|
||||
{
|
||||
ESP_LOGE(TAG, "Failed to initialize LittleFS (%s)", esp_err_to_name(ret));
|
||||
}
|
||||
return;
|
||||
}
|
||||
|
||||
size_t total = 0, used = 0;
|
||||
ret = esp_littlefs_info(conf.partition_label, &total, &used);
|
||||
if (ret != ESP_OK)
|
||||
{
|
||||
ESP_LOGE(TAG, "Failed to get LittleFS partition information (%s)", esp_err_to_name(ret));
|
||||
}
|
||||
else
|
||||
{
|
||||
ESP_LOGI(TAG, "Partition size: total: %d, used: %d", total, used);
|
||||
}
|
||||
|
||||
// Check if file exists
|
||||
FILE* f = fopen(LOG_FILE_PATH, "r");
|
||||
if (f == NULL)
|
||||
{
|
||||
ESP_LOGI(TAG, "Log file not found, creating new one.");
|
||||
FILE* f_write = fopen(LOG_FILE_PATH, "w");
|
||||
if (f_write == NULL)
|
||||
{
|
||||
ESP_LOGE(TAG, "Failed to create log file.");
|
||||
}
|
||||
else
|
||||
{
|
||||
// Add header for 3 channels
|
||||
fprintf(f_write,
|
||||
"timestamp,usb_voltage,usb_current,usb_power,main_voltage,main_current,main_power,vin_voltage,vin_"
|
||||
"current,vin_power\n");
|
||||
fclose(f_write);
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
// Here we could check if the header is correct, but for now we assume it is.
|
||||
ESP_LOGI(TAG, "Log file found.");
|
||||
fclose(f);
|
||||
}
|
||||
}
|
||||
|
||||
void datalog_add(uint32_t timestamp, const channel_data_t* channel_data)
|
||||
{
|
||||
struct stat st;
|
||||
if (stat(LOG_FILE_PATH, &st) == 0)
|
||||
{
|
||||
if (st.st_size >= MAX_LOG_SIZE)
|
||||
{
|
||||
ESP_LOGI(TAG, "Log file size (%ld) >= MAX_LOG_SIZE (%d). Truncating.", st.st_size, MAX_LOG_SIZE);
|
||||
|
||||
const char* temp_path = "/littlefs/datalog.tmp";
|
||||
FILE* f_read = fopen(LOG_FILE_PATH, "r");
|
||||
FILE* f_write = fopen(temp_path, "w");
|
||||
|
||||
if (f_read == NULL || f_write == NULL)
|
||||
{
|
||||
ESP_LOGE(TAG, "Failed to open files for truncation.");
|
||||
if (f_read)
|
||||
fclose(f_read);
|
||||
if (f_write)
|
||||
fclose(f_write);
|
||||
return;
|
||||
}
|
||||
|
||||
char line[256];
|
||||
// Copy header
|
||||
if (fgets(line, sizeof(line), f_read) != NULL)
|
||||
{
|
||||
fputs(line, f_write);
|
||||
}
|
||||
|
||||
// Skip the oldest data line
|
||||
if (fgets(line, sizeof(line), f_read) == NULL)
|
||||
{
|
||||
// No data lines to skip, something is wrong if we are truncating
|
||||
}
|
||||
|
||||
// Copy the rest of the lines
|
||||
while (fgets(line, sizeof(line), f_read) != NULL)
|
||||
{
|
||||
fputs(line, f_write);
|
||||
}
|
||||
|
||||
fclose(f_read);
|
||||
fclose(f_write);
|
||||
|
||||
// Replace the old log with the new one
|
||||
if (remove(LOG_FILE_PATH) != 0)
|
||||
{
|
||||
ESP_LOGE(TAG, "Failed to remove old log file.");
|
||||
}
|
||||
if (rename(temp_path, LOG_FILE_PATH) != 0)
|
||||
{
|
||||
ESP_LOGE(TAG, "Failed to rename temp file.");
|
||||
return;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
FILE* f = fopen(LOG_FILE_PATH, "a");
|
||||
if (f == NULL)
|
||||
{
|
||||
ESP_LOGE(TAG, "Failed to open log file for appending.");
|
||||
return;
|
||||
}
|
||||
|
||||
fprintf(f, "%lu", timestamp);
|
||||
for (int i = 0; i < 3; ++i)
|
||||
{
|
||||
fprintf(f, ",%.3f,%.3f,%.3f", channel_data[i].voltage, channel_data[i].current, channel_data[i].power);
|
||||
}
|
||||
fprintf(f, "\n");
|
||||
fclose(f);
|
||||
}
|
||||
|
||||
const char* datalog_get_path(void) { return LOG_FILE_PATH; }
|
||||
@@ -1,19 +0,0 @@
|
||||
#ifndef MAIN_SERVICE_DATALOG_H_
|
||||
#define MAIN_SERVICE_DATALOG_H_
|
||||
|
||||
#include <stdint.h>
|
||||
|
||||
#define NUM_CHANNELS 3
|
||||
|
||||
typedef struct
|
||||
{
|
||||
float voltage;
|
||||
float current;
|
||||
float power;
|
||||
} channel_data_t;
|
||||
|
||||
void datalog_init(void);
|
||||
void datalog_add(uint32_t timestamp, const channel_data_t* channel_data);
|
||||
const char* datalog_get_path(void);
|
||||
|
||||
#endif /* MAIN_SERVICE_DATALOG_H_ */
|
||||
182
main/service/dbg_console.c
Normal file
@@ -0,0 +1,182 @@
|
||||
#include "dbg_console.h"
|
||||
|
||||
#include <stdio.h>
|
||||
#include <string.h>
|
||||
#include "argtable3/argtable3.h"
|
||||
#include "esp_console.h"
|
||||
#include "esp_log.h"
|
||||
#include "esp_netif.h"
|
||||
#include "esp_system.h"
|
||||
#include "freertos/FreeRTOS.h"
|
||||
#include "freertos/task.h"
|
||||
|
||||
#include "wifi.h"
|
||||
|
||||
|
||||
/* 'wifi_scan' command */
|
||||
static int wifi_scan_handler(int argc, char** argv)
|
||||
{
|
||||
printf("Scanning for Wi-Fi networks...\n");
|
||||
|
||||
wifi_ap_record_t* ap_records;
|
||||
uint16_t count = 0;
|
||||
|
||||
wifi_scan_aps(&ap_records, &count);
|
||||
|
||||
if (count == 0)
|
||||
{
|
||||
printf("No APs found.\n");
|
||||
return 0;
|
||||
}
|
||||
|
||||
printf("Found %d APs:\n", count);
|
||||
printf(" %-32s %-4s %s\n", "SSID", "RSSI", "Auth Mode");
|
||||
for (int i = 0; i < count; i++)
|
||||
{
|
||||
printf(" %-32s %-4d %s\n", ap_records[i].ssid, ap_records[i].rssi, auth_mode_str(ap_records[i].authmode));
|
||||
}
|
||||
|
||||
if (count > 0)
|
||||
{
|
||||
free(ap_records);
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
static void register_wifi_scan(void)
|
||||
{
|
||||
const esp_console_cmd_t cmd = {
|
||||
.command = "wifi_scan",
|
||||
.help = "Scan for available Wi-Fi networks",
|
||||
.hint = NULL,
|
||||
.func = &wifi_scan_handler,
|
||||
};
|
||||
ESP_ERROR_CHECK(esp_console_cmd_register(&cmd));
|
||||
}
|
||||
|
||||
static struct
|
||||
{
|
||||
struct arg_str* ssid;
|
||||
struct arg_str* password;
|
||||
struct arg_end* end;
|
||||
} wifi_connect_args;
|
||||
|
||||
static int wifi_connect_handler(int argc, char** argv)
|
||||
{
|
||||
int nerrors = arg_parse(argc, argv, (void**)&wifi_connect_args);
|
||||
if (nerrors != 0)
|
||||
{
|
||||
arg_print_errors(stderr, wifi_connect_args.end, argv[0]);
|
||||
return 1;
|
||||
}
|
||||
|
||||
const char* ssid = wifi_connect_args.ssid->sval[0];
|
||||
char password[64] = "";
|
||||
|
||||
if (wifi_connect_args.password->count != 0)
|
||||
strncpy(password, wifi_connect_args.password->sval[0], sizeof(password));
|
||||
|
||||
printf("Attempting to connect to SSID: %s\n", ssid);
|
||||
|
||||
esp_err_t err = wifi_sta_set_ap(ssid, password);
|
||||
|
||||
if (err == ESP_OK)
|
||||
{
|
||||
printf("Wi-Fi credentials set. The device will attempt to connect.\n");
|
||||
}
|
||||
else
|
||||
{
|
||||
printf("Failed to set Wi-Fi credentials.\n");
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
static void register_wifi_connect(void)
|
||||
{
|
||||
wifi_connect_args.ssid = arg_str1(NULL, NULL, "<ssid>", "SSID of the network to connect to");
|
||||
wifi_connect_args.password = arg_str0(NULL, NULL, "<password>", "Password of the network");
|
||||
wifi_connect_args.end = arg_end(2);
|
||||
|
||||
const esp_console_cmd_t cmd = {.command = "wifi_connect",
|
||||
.help = "Connect to a Wi-Fi network",
|
||||
.hint = NULL,
|
||||
.func = &wifi_connect_handler,
|
||||
.argtable = &wifi_connect_args};
|
||||
ESP_ERROR_CHECK(esp_console_cmd_register(&cmd));
|
||||
}
|
||||
|
||||
/* 'wifi_status' command */
|
||||
static int wifi_status_handler(int argc, char** argv)
|
||||
{
|
||||
wifi_ap_record_t ap_info;
|
||||
esp_err_t err = wifi_get_current_ap_info(&ap_info);
|
||||
|
||||
if (err == ESP_OK)
|
||||
{
|
||||
printf("Connected to AP:\n");
|
||||
printf(" SSID: %s\n", (char*)ap_info.ssid);
|
||||
printf(" RSSI: %d\n", ap_info.rssi);
|
||||
|
||||
esp_netif_ip_info_t ip_info;
|
||||
err = wifi_get_current_ip_info(&ip_info);
|
||||
|
||||
if (err == ESP_OK)
|
||||
{
|
||||
char ip_str[16];
|
||||
esp_ip4addr_ntoa(&ip_info.ip, ip_str, sizeof(ip_str));
|
||||
printf(" IP Address: %s\n", ip_str);
|
||||
|
||||
esp_ip4addr_ntoa(&ip_info.gw, ip_str, sizeof(ip_str));
|
||||
printf(" Gateway: %s\n", ip_str);
|
||||
|
||||
esp_ip4addr_ntoa(&ip_info.netmask, ip_str, sizeof(ip_str));
|
||||
printf(" Subnet Mask: %s\n", ip_str);
|
||||
}
|
||||
else
|
||||
{
|
||||
printf(" Could not get IP information: %s\n", esp_err_to_name(err));
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
printf("Not connected to any AP.\n");
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
static void register_wifi_status(void)
|
||||
{
|
||||
const esp_console_cmd_t cmd = {
|
||||
.command = "wifi_status",
|
||||
.help = "Get current Wi-Fi connection status and IP information",
|
||||
.hint = NULL,
|
||||
.func = &wifi_status_handler,
|
||||
};
|
||||
ESP_ERROR_CHECK(esp_console_cmd_register(&cmd));
|
||||
}
|
||||
|
||||
esp_err_t initialize_dbg_console(void)
|
||||
{
|
||||
esp_console_repl_t* repl = NULL;
|
||||
esp_console_repl_config_t repl_config = ESP_CONSOLE_REPL_CONFIG_DEFAULT();
|
||||
|
||||
repl_config.prompt = "powermate >";
|
||||
repl_config.max_cmdline_length = 512;
|
||||
|
||||
esp_console_dev_usb_serial_jtag_config_t hw_config = ESP_CONSOLE_DEV_USB_SERIAL_JTAG_CONFIG_DEFAULT();
|
||||
ESP_ERROR_CHECK(esp_console_new_repl_usb_serial_jtag(&hw_config, &repl_config, &repl));
|
||||
|
||||
esp_console_register_help_command();
|
||||
register_wifi_scan();
|
||||
register_wifi_connect();
|
||||
register_wifi_status();
|
||||
|
||||
printf("Debug console initialized.\n");
|
||||
|
||||
esp_console_start_repl(repl);
|
||||
|
||||
return ESP_OK;
|
||||
}
|
||||
13
main/service/dbg_console.h
Normal file
@@ -0,0 +1,13 @@
|
||||
#ifndef ODROID_POWER_MATE_DBG_CONSOLE_H
|
||||
#define ODROID_POWER_MATE_DBG_CONSOLE_H
|
||||
|
||||
#include "esp_err.h"
|
||||
|
||||
/**
|
||||
* @brief Initialize the debug console.
|
||||
*
|
||||
* @return ESP_OK on success, or an error code on failure.
|
||||
*/
|
||||
esp_err_t initialize_dbg_console(void);
|
||||
|
||||
#endif // ODROID_POWER_MATE_DBG_CONSOLE_H
|
||||
@@ -6,7 +6,6 @@
|
||||
#include <nconfig.h>
|
||||
#include <time.h>
|
||||
#include "climit.h"
|
||||
#include "datalog.h"
|
||||
#include "esp_log.h"
|
||||
#include "esp_netif.h"
|
||||
#include "esp_timer.h"
|
||||
@@ -94,8 +93,6 @@ static void sensor_timer_callback(void* arg)
|
||||
uint32_t uptime_sec = (uint32_t)(uptime_us / 1000000);
|
||||
uint32_t timestamp = (uint32_t)time(NULL);
|
||||
|
||||
channel_data_t channel_data_log[NUM_CHANNELS];
|
||||
|
||||
StatusMessage message = StatusMessage_init_zero;
|
||||
message.which_payload = StatusMessage_sensor_data_tag;
|
||||
SensorData* sensor_data = &message.payload.sensor_data;
|
||||
@@ -115,9 +112,6 @@ static void sensor_timer_callback(void* arg)
|
||||
current /= 1000.0f; // mA to A
|
||||
power = voltage * current;
|
||||
|
||||
// For datalog
|
||||
channel_data_log[i] = (channel_data_t){.voltage = voltage, .current = current, .power = power};
|
||||
|
||||
// For protobuf
|
||||
channels[i]->voltage = voltage;
|
||||
channels[i]->current = current;
|
||||
@@ -282,19 +276,18 @@ void init_status_monitor()
|
||||
lim = atof(buf);
|
||||
climit_set_usb(lim);
|
||||
|
||||
datalog_init();
|
||||
|
||||
const esp_timer_create_args_t sensor_timer_args = {.callback = &sensor_timer_callback,
|
||||
.name = "sensor_reading_timer"};
|
||||
const esp_timer_create_args_t wifi_timer_args = {.callback = &status_wifi_callback, .name = "wifi_status_timer"};
|
||||
const esp_timer_create_args_t long_press_timer_args = {.callback = &long_press_timer_callback,
|
||||
.name = "long_press_timer"};
|
||||
.name = "long_press_timer"};
|
||||
|
||||
ESP_ERROR_CHECK(esp_timer_create(&sensor_timer_args, &sensor_timer));
|
||||
ESP_ERROR_CHECK(esp_timer_create(&wifi_timer_args, &wifi_status_timer));
|
||||
ESP_ERROR_CHECK(esp_timer_create(&long_press_timer_args, &long_press_timer));
|
||||
|
||||
xTaskCreate(shutdown_load_sw_task, "shutdown_sw_task", configMINIMAL_STACK_SIZE * 3, NULL, 15, &shutdown_task_handle);
|
||||
xTaskCreate(shutdown_load_sw_task, "shutdown_sw_task", configMINIMAL_STACK_SIZE * 3, NULL, 15,
|
||||
&shutdown_task_handle);
|
||||
|
||||
ESP_ERROR_CHECK(esp_timer_start_periodic(sensor_timer, 1000000));
|
||||
ESP_ERROR_CHECK(esp_timer_start_periodic(wifi_status_timer, 1000000 * 5));
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
#include <stdlib.h>
|
||||
#include "auth.h"
|
||||
#include "cJSON.h"
|
||||
#include "climit.h"
|
||||
#include "esp_http_server.h"
|
||||
@@ -13,6 +14,12 @@ static const char* TAG = "webserver";
|
||||
|
||||
static esp_err_t setting_get_handler(httpd_req_t* req)
|
||||
{
|
||||
esp_err_t err = api_auth_check(req);
|
||||
if (err != ESP_OK)
|
||||
{
|
||||
return err;
|
||||
}
|
||||
|
||||
wifi_ap_record_t ap_info;
|
||||
cJSON* root = cJSON_CreateObject();
|
||||
|
||||
@@ -103,6 +110,12 @@ static esp_err_t setting_get_handler(httpd_req_t* req)
|
||||
|
||||
static esp_err_t wifi_scan(httpd_req_t* req)
|
||||
{
|
||||
esp_err_t err = api_auth_check(req);
|
||||
if (err != ESP_OK)
|
||||
{
|
||||
return err;
|
||||
}
|
||||
|
||||
wifi_ap_record_t* ap_records;
|
||||
uint16_t count;
|
||||
|
||||
@@ -133,6 +146,12 @@ static esp_err_t wifi_scan(httpd_req_t* req)
|
||||
|
||||
static esp_err_t setting_post_handler(httpd_req_t* req)
|
||||
{
|
||||
esp_err_t err = api_auth_check(req);
|
||||
if (err != ESP_OK)
|
||||
{
|
||||
return err;
|
||||
}
|
||||
|
||||
char buf[512];
|
||||
int received = httpd_req_recv(req, buf, sizeof(buf) - 1);
|
||||
|
||||
@@ -158,6 +177,8 @@ static esp_err_t setting_post_handler(httpd_req_t* req)
|
||||
cJSON* vin_climit_item = cJSON_GetObjectItem(root, "vin_current_limit");
|
||||
cJSON* main_climit_item = cJSON_GetObjectItem(root, "main_current_limit");
|
||||
cJSON* usb_climit_item = cJSON_GetObjectItem(root, "usb_current_limit");
|
||||
cJSON* new_username_item = cJSON_GetObjectItem(root, "new_username");
|
||||
cJSON* new_password_item = cJSON_GetObjectItem(root, "new_password");
|
||||
|
||||
if (mode_item && cJSON_IsString(mode_item))
|
||||
{
|
||||
@@ -303,6 +324,17 @@ static esp_err_t setting_post_handler(httpd_req_t* req)
|
||||
}
|
||||
httpd_resp_sendstr(req, "{\"status\":\"current_limit_updated\"}");
|
||||
}
|
||||
else if (new_username_item && cJSON_IsString(new_username_item) && new_password_item &&
|
||||
cJSON_IsString(new_password_item))
|
||||
{
|
||||
const char* new_username = new_username_item->valuestring;
|
||||
const char* new_password = new_password_item->valuestring;
|
||||
|
||||
nconfig_write(PAGE_USERNAME, new_username);
|
||||
nconfig_write(PAGE_PASSWORD, new_password);
|
||||
ESP_LOGI(TAG, "Username and password updated successfully.");
|
||||
httpd_resp_sendstr(req, "{\"status\":\"user_credentials_updated\"}");
|
||||
}
|
||||
else
|
||||
{
|
||||
httpd_resp_send_err(req, HTTPD_400_BAD_REQUEST, "Invalid payload");
|
||||
|
||||
@@ -7,6 +7,7 @@
|
||||
#include <esp_log.h>
|
||||
#include <esp_timer.h>
|
||||
#include <string.h>
|
||||
#include "auth.h"
|
||||
#include "esp_http_server.h"
|
||||
#include "esp_system.h"
|
||||
|
||||
@@ -50,6 +51,12 @@ void start_reboot_timer(int sec)
|
||||
|
||||
static esp_err_t reboot_post_handler(httpd_req_t* req)
|
||||
{
|
||||
esp_err_t err = api_auth_check(req);
|
||||
if (err != ESP_OK)
|
||||
{
|
||||
return err;
|
||||
}
|
||||
|
||||
httpd_resp_set_type(req, "application/json");
|
||||
const char* resp_str = "{\"status\": \"reboot timer started\"}";
|
||||
httpd_resp_send(req, resp_str, strlen(resp_str));
|
||||
@@ -80,6 +87,12 @@ void register_reboot_endpoint(httpd_handle_t server)
|
||||
|
||||
static esp_err_t version_get_handler(httpd_req_t* req)
|
||||
{
|
||||
esp_err_t err = api_auth_check(req);
|
||||
if (err != ESP_OK)
|
||||
{
|
||||
return err;
|
||||
}
|
||||
|
||||
httpd_resp_set_type(req, "application/json");
|
||||
char buf[100];
|
||||
sprintf(buf, "{\"version\": \"%s-%s\"}", VERSION_TAG, VERSION_HASH);
|
||||
@@ -92,4 +105,4 @@ void register_version_endpoint(httpd_handle_t server)
|
||||
httpd_uri_t post_uri = {
|
||||
.uri = "/api/version", .method = HTTP_GET, .handler = version_get_handler, .user_ctx = NULL};
|
||||
httpd_register_uri_handler(server, &post_uri);
|
||||
}
|
||||
}
|
||||
@@ -1,7 +1,9 @@
|
||||
#include "webserver.h"
|
||||
#include <stdio.h>
|
||||
#include <string.h>
|
||||
#include "datalog.h"
|
||||
#include "auth.h"
|
||||
#include "cJSON.h"
|
||||
#include "dbg_console.h"
|
||||
#include "esp_http_server.h"
|
||||
#include "esp_log.h"
|
||||
#include "esp_wifi.h"
|
||||
@@ -22,47 +24,149 @@ static esp_err_t index_handler(httpd_req_t* req)
|
||||
const size_t index_html_size = (index_html_end - index_html_start);
|
||||
|
||||
httpd_resp_set_hdr(req, "Content-Encoding", "gzip");
|
||||
httpd_resp_set_hdr(req, "Cache-Control", "max-age=3600");
|
||||
httpd_resp_set_type(req, "text/html");
|
||||
httpd_resp_send(req, (const char*)index_html_start, index_html_size);
|
||||
|
||||
return ESP_OK;
|
||||
}
|
||||
|
||||
static esp_err_t datalog_download_handler(httpd_req_t* req)
|
||||
{
|
||||
const char* filepath = datalog_get_path();
|
||||
FILE* f = fopen(filepath, "r");
|
||||
if (f == NULL)
|
||||
size_t remaining = index_html_size;
|
||||
const char* ptr = (const char*)index_html_start;
|
||||
while (remaining > 0)
|
||||
{
|
||||
ESP_LOGE(TAG, "Failed to open datalog file for reading");
|
||||
httpd_resp_send_404(req);
|
||||
return ESP_FAIL;
|
||||
}
|
||||
|
||||
httpd_resp_set_type(req, "text/csv");
|
||||
httpd_resp_set_hdr(req, "Content-Disposition", "attachment; filename=\"datalog.csv\"");
|
||||
|
||||
char buffer[1024];
|
||||
size_t bytes_read;
|
||||
while ((bytes_read = fread(buffer, 1, sizeof(buffer), f)) > 0)
|
||||
{
|
||||
if (httpd_resp_send_chunk(req, buffer, bytes_read) != ESP_OK)
|
||||
size_t to_send = remaining < 2048 ? remaining : 2048;
|
||||
if (httpd_resp_send_chunk(req, ptr, to_send) != ESP_OK)
|
||||
{
|
||||
ESP_LOGE(TAG, "File sending failed!");
|
||||
fclose(f);
|
||||
httpd_resp_send_chunk(req, NULL, 0);
|
||||
httpd_resp_send_500(req);
|
||||
return ESP_FAIL;
|
||||
}
|
||||
ptr += to_send;
|
||||
remaining -= to_send;
|
||||
}
|
||||
|
||||
fclose(f);
|
||||
httpd_resp_send_chunk(req, NULL, 0);
|
||||
return ESP_OK;
|
||||
}
|
||||
|
||||
static esp_err_t login_handler(httpd_req_t* req)
|
||||
{
|
||||
char content[100]; // Adjust size as needed for username/password
|
||||
int ret = httpd_req_recv(req, content, sizeof(content) - 1); // -1 for null terminator
|
||||
if (ret <= 0)
|
||||
{ // 0 means connection closed, < 0 means error
|
||||
if (ret == HTTPD_SOCK_ERR_TIMEOUT)
|
||||
{
|
||||
httpd_resp_send_408(req);
|
||||
}
|
||||
return ESP_FAIL;
|
||||
}
|
||||
content[ret] = '\0'; // Null-terminate the received data
|
||||
|
||||
ESP_LOGI(TAG, "Received login request: %s", content);
|
||||
|
||||
cJSON* root = cJSON_Parse(content);
|
||||
if (root == NULL)
|
||||
{
|
||||
httpd_resp_send_err(req, HTTPD_400_BAD_REQUEST, "Invalid JSON");
|
||||
return ESP_FAIL;
|
||||
}
|
||||
|
||||
cJSON* username_json = cJSON_GetObjectItemCaseSensitive(root, "username");
|
||||
cJSON* password_json = cJSON_GetObjectItemCaseSensitive(root, "password");
|
||||
|
||||
if (!cJSON_IsString(username_json) || (username_json->valuestring == NULL) || !cJSON_IsString(password_json) ||
|
||||
(password_json->valuestring == NULL))
|
||||
{
|
||||
cJSON_Delete(root);
|
||||
httpd_resp_send_err(req, HTTPD_400_BAD_REQUEST, "Missing username or password");
|
||||
return ESP_FAIL;
|
||||
}
|
||||
|
||||
const char* received_username = username_json->valuestring;
|
||||
const char* received_password = password_json->valuestring;
|
||||
|
||||
// Get stored username and password from nconfig
|
||||
size_t stored_username_len = 0;
|
||||
size_t stored_password_len = 0;
|
||||
char* stored_username = NULL;
|
||||
char* stored_password = NULL;
|
||||
bool credentials_match = false;
|
||||
|
||||
if (nconfig_get_str_len(PAGE_USERNAME, &stored_username_len) == ESP_OK && stored_username_len > 1)
|
||||
{
|
||||
stored_username = (char*)malloc(stored_username_len);
|
||||
if (stored_username)
|
||||
{
|
||||
if (nconfig_read(PAGE_USERNAME, stored_username, stored_username_len) != ESP_OK)
|
||||
{
|
||||
ESP_LOGE(TAG, "Failed to read stored username from nconfig");
|
||||
free(stored_username);
|
||||
stored_username = NULL;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (nconfig_get_str_len(PAGE_PASSWORD, &stored_password_len) == ESP_OK && stored_password_len > 1)
|
||||
{
|
||||
stored_password = (char*)malloc(stored_password_len);
|
||||
if (stored_password)
|
||||
{
|
||||
if (nconfig_read(PAGE_PASSWORD, stored_password, stored_password_len) != ESP_OK)
|
||||
{
|
||||
ESP_LOGE(TAG, "Failed to read stored password from nconfig");
|
||||
free(stored_password);
|
||||
stored_password = NULL;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (stored_username && stored_password)
|
||||
{
|
||||
if (strcmp(received_username, stored_username) == 0 && strcmp(received_password, stored_password) == 0)
|
||||
{
|
||||
credentials_match = true;
|
||||
}
|
||||
}
|
||||
|
||||
if (stored_username)
|
||||
free(stored_username);
|
||||
if (stored_password)
|
||||
free(stored_password);
|
||||
|
||||
if (credentials_match)
|
||||
{
|
||||
char* token = auth_generate_token();
|
||||
if (token)
|
||||
{
|
||||
cJSON* response_root = cJSON_CreateObject();
|
||||
cJSON_AddStringToObject(response_root, "token", token);
|
||||
char* json_response = cJSON_Print(response_root);
|
||||
|
||||
httpd_resp_set_type(req, "application/json");
|
||||
httpd_resp_sendstr(req, json_response);
|
||||
|
||||
free(token); // Free the token generated by auth_generate_token
|
||||
free(json_response);
|
||||
cJSON_Delete(response_root);
|
||||
}
|
||||
else
|
||||
{
|
||||
httpd_resp_send_err(req, HTTPD_500_INTERNAL_SERVER_ERROR, "Failed to generate token");
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
httpd_resp_send_err(req, HTTPD_401_UNAUTHORIZED, "Invalid credentials");
|
||||
}
|
||||
|
||||
cJSON_Delete(root);
|
||||
return ESP_OK;
|
||||
}
|
||||
|
||||
|
||||
void start_webserver(void)
|
||||
{
|
||||
auth_init();
|
||||
|
||||
httpd_handle_t server = NULL;
|
||||
httpd_config_t config = HTTPD_DEFAULT_CONFIG();
|
||||
config.stack_size = 1024 * 8;
|
||||
@@ -79,9 +183,9 @@ void start_webserver(void)
|
||||
httpd_uri_t index = {.uri = "/", .method = HTTP_GET, .handler = index_handler, .user_ctx = NULL};
|
||||
httpd_register_uri_handler(server, &index);
|
||||
|
||||
httpd_uri_t datalog_uri = {
|
||||
.uri = "/datalog.csv", .method = HTTP_GET, .handler = datalog_download_handler, .user_ctx = NULL};
|
||||
httpd_register_uri_handler(server, &datalog_uri);
|
||||
// Login endpoint
|
||||
httpd_uri_t login = {.uri = "/login", .method = HTTP_POST, .handler = login_handler, .user_ctx = NULL};
|
||||
httpd_register_uri_handler(server, &login);
|
||||
|
||||
register_wifi_endpoint(server);
|
||||
register_ws_endpoint(server);
|
||||
@@ -90,4 +194,6 @@ void start_webserver(void)
|
||||
register_version_endpoint(server);
|
||||
|
||||
init_status_monitor();
|
||||
|
||||
initialize_dbg_console();
|
||||
}
|
||||
|
||||
@@ -5,9 +5,9 @@
|
||||
#ifndef ODROID_REMOTE_HTTP_WEBSERVER_H
|
||||
#define ODROID_REMOTE_HTTP_WEBSERVER_H
|
||||
|
||||
#include "esp_http_server.h"
|
||||
#include <stddef.h>
|
||||
#include <stdint.h>
|
||||
#include "esp_http_server.h"
|
||||
|
||||
void register_wifi_endpoint(httpd_handle_t server);
|
||||
void register_ws_endpoint(httpd_handle_t server);
|
||||
|
||||
@@ -2,15 +2,18 @@
|
||||
// Created by shinys on 25. 8. 18..
|
||||
//
|
||||
|
||||
#include "auth.h"
|
||||
#include "driver/uart.h"
|
||||
#include "esp_err.h"
|
||||
#include "esp_http_server.h"
|
||||
#include "esp_log.h"
|
||||
#include "freertos/FreeRTOS.h"
|
||||
#include "freertos/semphr.h"
|
||||
#include "nconfig.h"
|
||||
#include "pb.h"
|
||||
#include "pb_encode.h"
|
||||
#include "status.pb.h"
|
||||
#include "string.h" // Added for strlen and strncmp
|
||||
#include "webserver.h"
|
||||
|
||||
#define UART_NUM UART_NUM_1
|
||||
@@ -204,6 +207,57 @@ static esp_err_t ws_handler(httpd_req_t* req)
|
||||
{
|
||||
if (req->method == HTTP_GET)
|
||||
{
|
||||
ESP_LOGI(TAG, "WebSocket GET request received for URI: %s", req->uri);
|
||||
|
||||
char* query_str = NULL;
|
||||
size_t query_len = httpd_req_get_url_query_len(req) + 1;
|
||||
if (query_len > 1)
|
||||
{
|
||||
query_str = malloc(query_len);
|
||||
if (query_str == NULL)
|
||||
{
|
||||
ESP_LOGE(TAG, "Failed to allocate memory for query string");
|
||||
httpd_resp_send_err(req, HTTPD_500_INTERNAL_SERVER_ERROR, "Internal Server Error");
|
||||
return ESP_FAIL;
|
||||
}
|
||||
if (httpd_req_get_url_query_str(req, query_str, query_len) != ESP_OK)
|
||||
{
|
||||
ESP_LOGE(TAG, "Failed to get query string from URI: %s", req->uri);
|
||||
free(query_str);
|
||||
httpd_resp_send_err(req, HTTPD_500_INTERNAL_SERVER_ERROR, "Internal Server Error");
|
||||
return ESP_FAIL;
|
||||
}
|
||||
ESP_LOGI(TAG, "Extracted query string: %s", query_str);
|
||||
}
|
||||
|
||||
char token_str[TOKEN_LENGTH];
|
||||
esp_err_t err = ESP_FAIL; // Default to fail
|
||||
|
||||
if (query_str)
|
||||
{
|
||||
err = httpd_query_key_value(query_str, "token", token_str, sizeof(token_str));
|
||||
free(query_str); // Free allocated query string
|
||||
}
|
||||
|
||||
if (err == ESP_OK)
|
||||
{
|
||||
ESP_LOGI(TAG, "Token extracted from query string, value: %s", token_str);
|
||||
if (!auth_validate_token(token_str))
|
||||
{
|
||||
ESP_LOGW(TAG, "WebSocket connection attempt with invalid token for URI: %s", req->uri);
|
||||
httpd_resp_send_err(req, HTTPD_401_UNAUTHORIZED, "Invalid or expired token");
|
||||
return ESP_FAIL;
|
||||
}
|
||||
ESP_LOGD(TAG, "WebSocket token validated for URI: %s", req->uri);
|
||||
}
|
||||
else
|
||||
{
|
||||
ESP_LOGW(TAG, "Failed to extract token from query string or query string not found, error: %s",
|
||||
esp_err_to_name(err));
|
||||
httpd_resp_send_err(req, HTTPD_401_UNAUTHORIZED, "Authorization token required");
|
||||
return ESP_FAIL;
|
||||
}
|
||||
|
||||
ESP_LOGI(TAG, "Handshake done, the new connection was opened");
|
||||
return ESP_OK;
|
||||
}
|
||||
@@ -211,7 +265,6 @@ static esp_err_t ws_handler(httpd_req_t* req)
|
||||
httpd_ws_frame_t ws_pkt = {0};
|
||||
uint8_t buf[BUF_SIZE];
|
||||
ws_pkt.payload = buf;
|
||||
ws_pkt.type = HTTPD_WS_TYPE_BINARY;
|
||||
|
||||
esp_err_t ret = httpd_ws_recv_frame(req, &ws_pkt, BUF_SIZE);
|
||||
if (ret != ESP_OK)
|
||||
@@ -220,7 +273,33 @@ static esp_err_t ws_handler(httpd_req_t* req)
|
||||
return ret;
|
||||
}
|
||||
|
||||
uart_write_bytes(UART_NUM, (const char*)ws_pkt.payload, ws_pkt.len);
|
||||
if (ws_pkt.type == HTTPD_WS_TYPE_TEXT && ws_pkt.len == strlen("ping") &&
|
||||
strncmp((const char*)ws_pkt.payload, "ping", ws_pkt.len) == 0)
|
||||
{
|
||||
ESP_LOGD(TAG, "Received application-level ping from client, sending pong.");
|
||||
httpd_ws_frame_t pong_pkt = {
|
||||
.payload = (uint8_t*)"pong", .len = strlen("pong"), .type = HTTPD_WS_TYPE_TEXT, .final = true};
|
||||
return httpd_ws_send_frame(req, &pong_pkt);
|
||||
}
|
||||
else if (ws_pkt.type == HTTPD_WS_TYPE_CLOSE)
|
||||
{
|
||||
ESP_LOGI(TAG, "Client sent close frame, closing connection.");
|
||||
return ESP_OK;
|
||||
}
|
||||
else if (ws_pkt.type == HTTPD_WS_TYPE_PING)
|
||||
{
|
||||
ESP_LOGD(TAG, "Received WebSocket PING control frame (handled by httpd).");
|
||||
return ESP_OK;
|
||||
}
|
||||
else if (ws_pkt.type == HTTPD_WS_TYPE_PONG)
|
||||
{
|
||||
ESP_LOGD(TAG, "Received WebSocket PONG control frame.");
|
||||
return ESP_OK;
|
||||
}
|
||||
else
|
||||
{
|
||||
uart_write_bytes(UART_NUM, (const char*)ws_pkt.payload, ws_pkt.len);
|
||||
}
|
||||
|
||||
return ESP_OK;
|
||||
}
|
||||
@@ -274,4 +353,4 @@ void push_data_to_ws(const uint8_t* data, size_t len)
|
||||
}
|
||||
}
|
||||
|
||||
esp_err_t change_baud_rate(int baud_rate) { return uart_set_baudrate(UART_NUM, baud_rate); }
|
||||
esp_err_t change_baud_rate(int baud_rate) { return uart_set_baudrate(UART_NUM, baud_rate); }
|
||||
@@ -8,5 +8,6 @@
|
||||
void wifi_init_sta(void);
|
||||
void wifi_init_ap(void);
|
||||
void initialize_sntp(void);
|
||||
void wifi_set_auto_reconnect(bool enable);
|
||||
|
||||
#endif // ODROID_POWER_MATE_PRIV_WIFI_H
|
||||
|
||||
@@ -81,6 +81,14 @@ void wifi_scan_aps(wifi_ap_record_t** ap_records, uint16_t* count)
|
||||
*count = 0;
|
||||
*ap_records = NULL;
|
||||
|
||||
wifi_set_auto_reconnect(false);
|
||||
|
||||
wifi_ap_record_t ap_info;
|
||||
if (esp_wifi_sta_get_ap_info(&ap_info) != ESP_OK)
|
||||
{
|
||||
esp_wifi_disconnect();
|
||||
}
|
||||
|
||||
// Start scan, this is a blocking call
|
||||
if (esp_wifi_scan_start(NULL, true) == ESP_OK)
|
||||
{
|
||||
@@ -100,6 +108,16 @@ void wifi_scan_aps(wifi_ap_record_t** ap_records, uint16_t* count)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
wifi_set_auto_reconnect(true);
|
||||
|
||||
if (esp_wifi_sta_get_ap_info(&ap_info) != ESP_OK)
|
||||
{
|
||||
if (!nconfig_value_is_not_set(WIFI_SSID))
|
||||
{
|
||||
wifi_connect();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
esp_err_t wifi_get_current_ap_info(wifi_ap_record_t* ap_info)
|
||||
|
||||
@@ -16,9 +16,13 @@
|
||||
#include "wifi.h"
|
||||
|
||||
#include "indicator.h"
|
||||
static bool s_auto_reconnect = true;
|
||||
|
||||
static const char* TAG = "WIFI";
|
||||
|
||||
void wifi_set_auto_reconnect(bool enable) { s_auto_reconnect = enable; }
|
||||
|
||||
|
||||
static void wifi_event_handler(void* arg, esp_event_base_t event_base, int32_t event_id, void* event_data)
|
||||
{
|
||||
if (event_base == WIFI_EVENT && event_id == WIFI_EVENT_AP_STACONNECTED)
|
||||
@@ -46,10 +50,18 @@ static void wifi_event_handler(void* arg, esp_event_base_t event_base, int32_t e
|
||||
}
|
||||
else if (event_base == WIFI_EVENT && event_id == WIFI_EVENT_STA_DISCONNECTED)
|
||||
{
|
||||
led_set(LED_RED, BLINK_TRIPLE);
|
||||
led_set(LED_BLU, BLINK_TRIPLE);
|
||||
wifi_event_sta_disconnected_t* event = (wifi_event_sta_disconnected_t*)event_data;
|
||||
ESP_LOGW(TAG, "Disconnected from AP, reason: %s", wifi_reason_str(event->reason));
|
||||
// ESP-IDF will automatically try to reconnect by default.
|
||||
|
||||
if (event->reason != WIFI_REASON_ASSOC_LEAVE)
|
||||
{
|
||||
if (s_auto_reconnect && !nconfig_value_is_not_set(WIFI_SSID))
|
||||
{
|
||||
ESP_LOGI(TAG, "Connection lost, attempting to reconnect...");
|
||||
esp_wifi_connect();
|
||||
}
|
||||
}
|
||||
}
|
||||
else if (event_base == IP_EVENT && event_id == IP_EVENT_STA_GOT_IP)
|
||||
{
|
||||
|
||||
@@ -8,7 +8,33 @@
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<main class="container">
|
||||
<div id="login-container" class="d-flex flex-column justify-content-center align-items-center vh-100" style="display: none;">
|
||||
<div class="card p-4 shadow-lg" style="width: 100%; max-width: 400px;">
|
||||
<div class="card-body">
|
||||
<h2 class="card-title text-center mb-4">Login to ODROID Power Mate</h2>
|
||||
<div id="login-alert" class="alert alert-danger d-none" role="alert"></div>
|
||||
<form id="login-form">
|
||||
<div class="mb-3">
|
||||
<label for="username" class="form-label">Username</label>
|
||||
<input type="text" class="form-control" id="username" required>
|
||||
</div>
|
||||
<div class="mb-3">
|
||||
<label for="password" class="form-label">Password</label>
|
||||
<input type="password" class="form-control" id="password" required>
|
||||
</div>
|
||||
<div class="d-grid">
|
||||
<button type="submit" class="btn btn-primary">Login</button>
|
||||
</div>
|
||||
</form>
|
||||
<div class="form-check form-switch d-flex justify-content-center mt-4">
|
||||
<input class="form-check-input" type="checkbox" role="switch" id="theme-toggle-login">
|
||||
<label class="form-check-label ms-2" for="theme-toggle-login"><i id="theme-icon-login" class="bi bi-moon-stars-fill"></i></label>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<main class="container" style="display: none;">
|
||||
<header class="d-flex justify-content-between align-items-center mb-3 main-header">
|
||||
<div class="order-md-1" style="flex: 1;">
|
||||
<div class="d-flex align-items-center">
|
||||
@@ -27,7 +53,10 @@
|
||||
<span id="power-display" class="text-primary">--.-- W</span>
|
||||
</div>
|
||||
</div>
|
||||
<h1 class="text-primary text-center order-md-2 mx-auto">ODROID Power Mate</h1>
|
||||
<div class="text-center order-md-2 mx-auto">
|
||||
<h1 class="text-primary mb-0">ODROID Power Mate</h1>
|
||||
<small class="text-muted" id="version-info"></small>
|
||||
</div>
|
||||
<div class="d-flex align-items-center justify-content-end order-md-3 header-controls" style="flex: 1;">
|
||||
<div class="form-check form-switch">
|
||||
<input class="form-check-input" type="checkbox" role="switch" id="theme-toggle">
|
||||
@@ -37,6 +66,9 @@
|
||||
data-bs-target="#settingsModal">
|
||||
<i class="bi bi-gear"></i>
|
||||
</button>
|
||||
<button class="btn btn-outline-secondary ms-3" id="logout-button">
|
||||
<i class="bi bi-box-arrow-right"></i>
|
||||
</button>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
@@ -130,12 +162,9 @@
|
||||
</div>
|
||||
</main>
|
||||
|
||||
<footer class="bg-body-tertiary text-center p-3 position-relative">
|
||||
<footer class="bg-body-tertiary text-center p-3">
|
||||
<a href="https://www.hardkernel.com/" target="_blank" class="link-secondary text-decoration-none">Hardkernel</a> |
|
||||
<a href="https://wiki.odroid.com/start" target="_blank" class="link-secondary text-decoration-none">Wiki</a>
|
||||
<div class="position-absolute end-0 top-50 translate-middle-y pe-3">
|
||||
<small class="text-muted" id="version-info"></small>
|
||||
</div>
|
||||
</footer>
|
||||
|
||||
<!-- Settings Modal -->
|
||||
@@ -168,6 +197,11 @@
|
||||
id="current-limit-settings-tab" role="tab" type="button">Current Limit
|
||||
</button>
|
||||
</li>
|
||||
<li class="nav-item" role="presentation">
|
||||
<button class="nav-link" data-bs-target="#user-settings-pane" data-bs-toggle="tab"
|
||||
id="user-settings-tab" role="tab" type="button">User Settings
|
||||
</button>
|
||||
</li>
|
||||
<li class="nav-item" role="presentation">
|
||||
<button class="nav-link" id="device-settings-tab" data-bs-toggle="tab"
|
||||
data-bs-target="#device-settings-pane" type="button" role="tab">Device
|
||||
@@ -302,6 +336,28 @@
|
||||
<button type="button" class="btn btn-secondary" data-bs-dismiss="modal">Close</button>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tab-pane fade" id="user-settings-pane" role="tabpanel">
|
||||
<form id="user-settings-form">
|
||||
<div class="mb-3">
|
||||
<label class="form-label" for="new-username">New Username</label>
|
||||
<input class="form-control" id="new-username" required type="text">
|
||||
</div>
|
||||
<div class="mb-3">
|
||||
<label class="form-label" for="new-password">New Password</label>
|
||||
<input class="form-control" id="new-password" required type="password">
|
||||
</div>
|
||||
<div class="mb-3">
|
||||
<label class="form-label" for="confirm-password">Confirm New Password</label>
|
||||
<input class="form-control" id="confirm-password" required type="password">
|
||||
</div>
|
||||
<div class="d-flex justify-content-end pt-3 border-top mt-3">
|
||||
<button class="btn btn-primary me-2" id="user-settings-apply-button" type="submit">
|
||||
Apply
|
||||
</button>
|
||||
<button class="btn btn-secondary" data-bs-dismiss="modal" type="button">Close</button>
|
||||
</div>
|
||||
</form>
|
||||
</div>
|
||||
<div class="tab-pane fade" id="device-settings-pane" role="tabpanel">
|
||||
<div class="mb-3">
|
||||
<label for="baud-rate-select" class="form-label">UART Baud Rate</label>
|
||||
|
||||
139
page/src/api.js
@@ -4,15 +4,63 @@
|
||||
* It abstracts the fetch logic, error handling, and JSON parsing for network and control operations.
|
||||
*/
|
||||
|
||||
// Function to get authentication headers
|
||||
export function getAuthHeaders() {
|
||||
const token = localStorage.getItem('authToken');
|
||||
if (token) {
|
||||
return { 'Authorization': `Bearer ${token}` };
|
||||
}
|
||||
return {};
|
||||
}
|
||||
|
||||
// Global error handler for unauthorized responses
|
||||
export async function handleResponse(response) {
|
||||
if (response.status === 401) {
|
||||
// Unauthorized, log out the user
|
||||
localStorage.removeItem('authToken');
|
||||
// Redirect to login or trigger a logout event
|
||||
// For now, we'll just reload the page, which will trigger the login screen
|
||||
window.location.reload();
|
||||
throw new Error('Unauthorized: Session expired or invalid token.');
|
||||
}
|
||||
if (!response.ok) {
|
||||
const errorText = await response.text();
|
||||
throw new Error(errorText || `HTTP error! status: ${response.status}`);
|
||||
}
|
||||
return response;
|
||||
}
|
||||
|
||||
/**
|
||||
* Authenticates a user with the provided username and password.
|
||||
* @param {string} username The user's username.
|
||||
* @param {string} password The user's password.
|
||||
* @returns {Promise<Object>} A promise that resolves to the server's JSON response containing a token.
|
||||
* @throws {Error} Throws an error if the authentication fails.
|
||||
*/
|
||||
export async function login(username, password) {
|
||||
const response = await fetch('/login', {
|
||||
method: 'POST',
|
||||
headers: {'Content-Type': 'application/json'},
|
||||
body: JSON.stringify({ username, password }),
|
||||
});
|
||||
// Login function does not use handleResponse as it's for obtaining the token
|
||||
if (!response.ok) {
|
||||
const errorText = await response.text();
|
||||
throw new Error(errorText || `Login failed with status: ${response.status}`);
|
||||
}
|
||||
return await response.json();
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetches the list of available Wi-Fi networks from the server.
|
||||
* @returns {Promise<Array<Object>>} A promise that resolves to an array of Wi-Fi access point objects.
|
||||
* @throws {Error} Throws an error if the network request fails.
|
||||
*/
|
||||
export async function fetchWifiScan() {
|
||||
const response = await fetch('/api/wifi/scan');
|
||||
if (!response.ok) throw new Error(`HTTP error! status: ${response.status}`);
|
||||
return await response.json();
|
||||
const response = await fetch('/api/wifi/scan', {
|
||||
headers: getAuthHeaders(),
|
||||
});
|
||||
return await handleResponse(response).then(res => res.json());
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -23,16 +71,15 @@ export async function fetchWifiScan() {
|
||||
* @throws {Error} Throws an error if the connection request fails.
|
||||
*/
|
||||
export async function postWifiConnect(ssid, password) {
|
||||
const response = await fetch('/api/setting', { // Updated URL
|
||||
const response = await fetch('/api/setting', {
|
||||
method: 'POST',
|
||||
headers: {'Content-Type': 'application/json'},
|
||||
headers: {
|
||||
'Content-Type': 'application/json',
|
||||
...getAuthHeaders(),
|
||||
},
|
||||
body: JSON.stringify({ssid, password}),
|
||||
});
|
||||
if (!response.ok) {
|
||||
const errorText = await response.text();
|
||||
throw new Error(errorText || `Connection failed with status: ${response.status}`);
|
||||
}
|
||||
return await response.json();
|
||||
return await handleResponse(response).then(res => res.json());
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -42,16 +89,15 @@ export async function postWifiConnect(ssid, password) {
|
||||
* @throws {Error} Throws an error if the request fails.
|
||||
*/
|
||||
export async function postNetworkSettings(payload) {
|
||||
const response = await fetch('/api/setting', { // Updated URL
|
||||
const response = await fetch('/api/setting', {
|
||||
method: 'POST',
|
||||
headers: {'Content-Type': 'application/json'},
|
||||
headers: {
|
||||
'Content-Type': 'application/json',
|
||||
...getAuthHeaders(),
|
||||
},
|
||||
body: JSON.stringify(payload),
|
||||
});
|
||||
if (!response.ok) {
|
||||
const errorText = await response.text();
|
||||
throw new Error(errorText || `Failed to apply settings with status: ${response.status}`);
|
||||
}
|
||||
return response;
|
||||
return await handleResponse(response);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -63,14 +109,13 @@ export async function postNetworkSettings(payload) {
|
||||
export async function postBaudRateSetting(baudrate) {
|
||||
const response = await fetch('/api/setting', {
|
||||
method: 'POST',
|
||||
headers: {'Content-Type': 'application/json'},
|
||||
headers: {
|
||||
'Content-Type': 'application/json',
|
||||
...getAuthHeaders(),
|
||||
},
|
||||
body: JSON.stringify({baudrate}),
|
||||
});
|
||||
if (!response.ok) {
|
||||
const errorText = await response.text();
|
||||
throw new Error(errorText || `Failed to apply baudrate with status: ${response.status}`);
|
||||
}
|
||||
return response;
|
||||
return await handleResponse(response);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -79,9 +124,10 @@ export async function postBaudRateSetting(baudrate) {
|
||||
* @throws {Error} Throws an error if the network request fails.
|
||||
*/
|
||||
export async function fetchSettings() {
|
||||
const response = await fetch('/api/setting'); // Updated URL
|
||||
if (!response.ok) throw new Error(`HTTP error! status: ${response.status}`);
|
||||
return await response.json();
|
||||
const response = await fetch('/api/setting', {
|
||||
headers: getAuthHeaders(),
|
||||
});
|
||||
return await handleResponse(response).then(res => res.json());
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -90,9 +136,10 @@ export async function fetchSettings() {
|
||||
* @throws {Error} Throws an error if the network request fails.
|
||||
*/
|
||||
export async function fetchControlStatus() {
|
||||
const response = await fetch('/api/control');
|
||||
if (!response.ok) throw new Error(`HTTP error! status: ${response.status}`);
|
||||
return await response.json();
|
||||
const response = await fetch('/api/control', {
|
||||
headers: getAuthHeaders(),
|
||||
});
|
||||
return await handleResponse(response).then(res => res.json());
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -104,11 +151,13 @@ export async function fetchControlStatus() {
|
||||
export async function postControlCommand(command) {
|
||||
const response = await fetch('/api/control', {
|
||||
method: 'POST',
|
||||
headers: {'Content-Type': 'application/json'},
|
||||
headers: {
|
||||
'Content-Type': 'application/json',
|
||||
...getAuthHeaders(),
|
||||
},
|
||||
body: JSON.stringify(command)
|
||||
});
|
||||
if (!response.ok) throw new Error(`HTTP error! status: ${response.status}`);
|
||||
return response;
|
||||
return await handleResponse(response);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -117,7 +166,27 @@ export async function postControlCommand(command) {
|
||||
* @throws {Error} Throws an error if the network request fails.
|
||||
*/
|
||||
export async function fetchVersion() {
|
||||
const response = await fetch('/api/version');
|
||||
if (!response.ok) throw new Error(`HTTP error! status: ${response.status}`);
|
||||
return await response.json();
|
||||
const response = await fetch('/api/version', {
|
||||
headers: getAuthHeaders(),
|
||||
});
|
||||
return await handleResponse(response).then(res => res.json());
|
||||
}
|
||||
|
||||
/**
|
||||
* Updates the user's username and password on the server.
|
||||
* @param {string} newUsername The new username.
|
||||
* @param {string} newPassword The new password.
|
||||
* @returns {Promise<Object>} A promise that resolves to the server's JSON response.
|
||||
* @throws {Error} Throws an error if the update fails.
|
||||
*/
|
||||
export async function updateUserSettings(newUsername, newPassword) {
|
||||
const response = await fetch('/api/setting', {
|
||||
method: 'POST',
|
||||
headers: {
|
||||
'Content-Type': 'application/json',
|
||||
...getAuthHeaders(),
|
||||
},
|
||||
body: JSON.stringify({new_username: newUsername, new_password: newPassword}),
|
||||
});
|
||||
return await handleResponse(response).then(res => res.json());
|
||||
}
|
||||
|
||||
@@ -7,6 +7,7 @@
|
||||
|
||||
import * as dom from './dom.js';
|
||||
import * as api from './api.js';
|
||||
import {getAuthHeaders, handleResponse} from './api.js'; // Import auth functions
|
||||
import * as ui from './ui.js';
|
||||
import {clearTerminal, downloadTerminalOutput, fitTerminal} from './terminal.js';
|
||||
import {debounce, isMobile} from './utils.js';
|
||||
@@ -28,7 +29,10 @@ function updateSliderValue(slider, span) {
|
||||
}
|
||||
|
||||
function loadCurrentLimitSettings() {
|
||||
fetch('/api/setting')
|
||||
fetch('/api/setting', {
|
||||
headers: getAuthHeaders(), // Add auth headers
|
||||
})
|
||||
.then(handleResponse) // Handle response for 401
|
||||
.then(response => response.json())
|
||||
.then(data => {
|
||||
if (data.vin_current_limit !== undefined) {
|
||||
@@ -56,14 +60,6 @@ export function setupEventListeners() {
|
||||
console.log("Event listeners already attached. Skipping.");
|
||||
return;
|
||||
}
|
||||
console.log("Attaching event listeners...");
|
||||
|
||||
// --- Theme Toggle ---
|
||||
dom.themeToggle.addEventListener('change', () => {
|
||||
const newTheme = dom.themeToggle.checked ? 'dark' : 'light';
|
||||
localStorage.setItem('theme', newTheme);
|
||||
ui.applyTheme(newTheme);
|
||||
});
|
||||
|
||||
// --- Terminal Controls ---
|
||||
dom.clearButton.addEventListener('click', clearTerminal);
|
||||
@@ -86,8 +82,12 @@ export function setupEventListeners() {
|
||||
if (dom.rebootButton) {
|
||||
dom.rebootButton.addEventListener('click', () => {
|
||||
if (confirm('Are you sure you want to reboot the device?')) {
|
||||
fetch('/api/reboot', {method: 'POST'})
|
||||
.then(response => response.ok ? response.json() : Promise.reject('Network response was not ok'))
|
||||
fetch('/api/reboot', {
|
||||
method: 'POST',
|
||||
headers: getAuthHeaders(), // Add auth headers
|
||||
})
|
||||
.then(handleResponse) // Handle response for 401
|
||||
.then(response => response.json())
|
||||
.then(data => {
|
||||
console.log('Reboot command sent:', data);
|
||||
ui.hideSettingsModal();
|
||||
@@ -115,10 +115,14 @@ export function setupEventListeners() {
|
||||
|
||||
fetch('/api/setting', {
|
||||
method: 'POST',
|
||||
headers: {'Content-Type': 'application/json'},
|
||||
headers: {
|
||||
'Content-Type': 'application/json',
|
||||
...getAuthHeaders(), // Add auth headers
|
||||
},
|
||||
body: JSON.stringify(settings),
|
||||
})
|
||||
.then(response => response.ok ? response.json() : Promise.reject('Failed to apply settings'))
|
||||
.then(handleResponse) // Handle response for 401
|
||||
.then(response => response.json())
|
||||
.then(data => {
|
||||
console.log('Current limit settings applied:', data);
|
||||
})
|
||||
@@ -184,5 +188,4 @@ export function setupEventListeners() {
|
||||
window.addEventListener('resize', debounce(ui.handleResize, 150));
|
||||
|
||||
listenersAttached = true;
|
||||
console.log("Event listeners attached successfully.");
|
||||
}
|
||||
|
||||
172
page/src/main.js
@@ -31,20 +31,36 @@ import {setupEventListeners} from './events.js';
|
||||
// --- Globals ---
|
||||
// StatusMessage is imported directly from the generated proto.js file.
|
||||
|
||||
// --- DOM Elements ---
|
||||
const loginContainer = document.getElementById('login-container');
|
||||
const mainContent = document.querySelector('main.container');
|
||||
const loginForm = document.getElementById('login-form');
|
||||
const usernameInput = document.getElementById('username');
|
||||
const passwordInput = document.getElementById('password');
|
||||
const loginAlert = document.getElementById('login-alert');
|
||||
const logoutButton = document.getElementById('logout-button');
|
||||
const themeToggleLogin = document.getElementById('theme-toggle-login');
|
||||
const themeIconLogin = document.getElementById('theme-icon-login');
|
||||
const themeToggleMain = document.getElementById('theme-toggle');
|
||||
const themeIconMain = document.getElementById('theme-icon');
|
||||
|
||||
// User Settings DOM Elements
|
||||
const userSettingsForm = document.getElementById('user-settings-form');
|
||||
const newUsernameInput = document.getElementById('new-username');
|
||||
const newPasswordInput = document.getElementById('new-password');
|
||||
const confirmPasswordInput = document.getElementById('confirm-password');
|
||||
|
||||
|
||||
// --- WebSocket Event Handlers ---
|
||||
|
||||
function onWsOpen() {
|
||||
updateWebsocketStatus(true);
|
||||
if (term) {
|
||||
term.write('\x1b[32mConnected to WebSocket Server\x1b[0m\r\n');
|
||||
}
|
||||
console.log('Connected to WebSocket Server');
|
||||
}
|
||||
|
||||
function onWsClose() {
|
||||
updateWebsocketStatus(false);
|
||||
if (term) {
|
||||
term.write('\r\n\x1b[31mConnection closed. Reconnecting...\x1b[0m\r\n');
|
||||
}
|
||||
console.warn('Connection closed. Reconnecting...');
|
||||
setTimeout(connect, 2000);
|
||||
}
|
||||
|
||||
@@ -111,6 +127,112 @@ function onWsMessage(event) {
|
||||
}
|
||||
}
|
||||
|
||||
// --- Authentication Functions ---
|
||||
|
||||
function checkAuth() {
|
||||
const token = localStorage.getItem('authToken');
|
||||
if (token) {
|
||||
return true;
|
||||
} else {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
async function handleLogin(event) {
|
||||
event.preventDefault();
|
||||
const username = usernameInput.value;
|
||||
const password = passwordInput.value;
|
||||
|
||||
try {
|
||||
const response = await api.login(username, password);
|
||||
if (response && response.token) {
|
||||
localStorage.setItem('authToken', response.token);
|
||||
loginAlert.classList.add('d-none');
|
||||
loginContainer.style.setProperty('display', 'none', 'important');
|
||||
initializeMainAppContent(); // After successful login, initialize the main app
|
||||
} else {
|
||||
loginAlert.textContent = 'Login failed: No token received.';
|
||||
loginAlert.classList.remove('d-none');
|
||||
}
|
||||
} catch (error) {
|
||||
console.error('Login error:', error);
|
||||
loginAlert.textContent = `Login failed: ${error.message}`;
|
||||
loginAlert.classList.remove('d-none');
|
||||
}
|
||||
}
|
||||
|
||||
function handleLogout() {
|
||||
localStorage.removeItem('authToken');
|
||||
// Hide main content and show login form
|
||||
loginContainer.style.setProperty('display', 'flex', 'important');
|
||||
mainContent.style.setProperty('display', 'none', 'important');
|
||||
// Optionally, disconnect WebSocket or perform other cleanup
|
||||
// For now, just hide the main content.
|
||||
}
|
||||
|
||||
// --- User Settings Functions ---
|
||||
async function handleUserSettingsSubmit(event) {
|
||||
event.preventDefault();
|
||||
|
||||
const newUsername = newUsernameInput.value;
|
||||
const newPassword = newPasswordInput.value;
|
||||
const confirmPassword = confirmPasswordInput.value;
|
||||
|
||||
if (!newUsername || !newPassword || !confirmPassword) {
|
||||
alert('Please fill in all fields for username and password.');
|
||||
return;
|
||||
}
|
||||
|
||||
if (newPassword !== confirmPassword) {
|
||||
alert('New password and confirm password do not match.');
|
||||
return;
|
||||
}
|
||||
|
||||
try {
|
||||
const response = await api.updateUserSettings(newUsername, newPassword);
|
||||
if (response && response.status === 'user_credentials_updated') {
|
||||
alert('Username and password updated successfully. Please log in again with new credentials.');
|
||||
handleLogout(); // Force logout to re-authenticate with new credentials
|
||||
} else {
|
||||
alert(`Failed to update credentials: ${response.message || 'Unknown error'}`);
|
||||
}
|
||||
} catch (error) {
|
||||
console.error('Error updating user settings:', error);
|
||||
alert(`Error updating user settings: ${error.message}`);
|
||||
}
|
||||
}
|
||||
|
||||
// --- Theme Toggle Functions ---
|
||||
function setupThemeToggles() {
|
||||
// Initialize theme for login page
|
||||
const savedTheme = localStorage.getItem('theme') || (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light');
|
||||
applyTheme(savedTheme);
|
||||
themeToggleLogin.checked = savedTheme === 'dark';
|
||||
themeIconLogin.className = savedTheme === 'dark' ? 'bi bi-moon-stars-fill' : 'bi bi-sun-fill';
|
||||
|
||||
// Sync main theme toggle with login theme toggle (initial state)
|
||||
themeToggleMain.checked = savedTheme === 'dark';
|
||||
themeIconMain.className = savedTheme === 'dark' ? 'bi bi-moon-stars-fill' : 'bi bi-sun-fill';
|
||||
|
||||
themeToggleLogin.addEventListener('change', () => {
|
||||
const newTheme = themeToggleLogin.checked ? 'dark' : 'light';
|
||||
applyTheme(newTheme);
|
||||
localStorage.setItem('theme', newTheme);
|
||||
themeIconLogin.className = newTheme === 'dark' ? 'bi bi-moon-stars-fill' : 'bi bi-sun-fill';
|
||||
themeToggleMain.checked = themeToggleLogin.checked; // Keep main toggle in sync
|
||||
themeIconMain.className = themeIconLogin.className; // Keep main icon in sync
|
||||
});
|
||||
|
||||
themeToggleMain.addEventListener('change', () => {
|
||||
const newTheme = themeToggleMain.checked ? 'dark' : 'light';
|
||||
applyTheme(newTheme);
|
||||
localStorage.setItem('theme', newTheme);
|
||||
themeIconMain.className = newTheme === 'dark' ? 'bi bi-moon-stars-fill' : 'bi bi-sun-fill';
|
||||
themeToggleLogin.checked = themeToggleMain.checked; // Keep login toggle in sync
|
||||
themeIconLogin.className = themeIconMain.className; // Keep login icon in sync
|
||||
});
|
||||
}
|
||||
|
||||
|
||||
// --- Application Initialization ---
|
||||
|
||||
@@ -131,17 +253,41 @@ function connect() {
|
||||
initWebSocket({ onOpen: onWsOpen, onClose: onWsClose, onMessage: onWsMessage });
|
||||
}
|
||||
|
||||
function initialize() {
|
||||
// New function to initialize main app content after successful login or on initial load if authenticated
|
||||
function initializeMainAppContent() {
|
||||
loginContainer.style.setProperty('display', 'none', 'important');
|
||||
mainContent.style.setProperty('display', 'block', 'important');
|
||||
|
||||
initUI();
|
||||
setupTerminal();
|
||||
initializeVersion();
|
||||
|
||||
const savedTheme = localStorage.getItem('theme') || (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light');
|
||||
applyTheme(savedTheme);
|
||||
|
||||
setupEventListeners();
|
||||
|
||||
setupEventListeners(); // Attach main app event listeners
|
||||
logoutButton.addEventListener('click', handleLogout); // Attach logout listener
|
||||
connect();
|
||||
|
||||
// Attach user settings form listener
|
||||
if (userSettingsForm) {
|
||||
userSettingsForm.addEventListener('submit', handleUserSettingsSubmit);
|
||||
}
|
||||
}
|
||||
|
||||
function initialize() {
|
||||
setupThemeToggles(); // Setup theme toggles for both login and main (initial sync)
|
||||
|
||||
// Always attach login form listener
|
||||
loginForm.addEventListener('submit', handleLogin);
|
||||
|
||||
if (!checkAuth()) { // If NOT authenticated
|
||||
// Show login form
|
||||
loginContainer.style.setProperty('display', 'flex', 'important');
|
||||
mainContent.style.setProperty('display', 'none', 'important');
|
||||
console.log('Not authenticated. Login form displayed. Main app content NOT initialized.');
|
||||
return; // IMPORTANT: Stop execution here if not authenticated
|
||||
}
|
||||
|
||||
// If authenticated, initialize main content
|
||||
console.log('Authenticated. Initializing main app content.');
|
||||
initializeMainAppContent();
|
||||
}
|
||||
|
||||
// --- Start Application ---
|
||||
|
||||
@@ -114,6 +114,10 @@ footer a {
|
||||
|
||||
/* Mobile Optimizations */
|
||||
@media (max-width: 767.98px) {
|
||||
#login-container {
|
||||
height: 100%;
|
||||
}
|
||||
|
||||
.main-header {
|
||||
flex-direction: column;
|
||||
}
|
||||
|
||||
@@ -2,32 +2,116 @@
|
||||
* @file websocket.js
|
||||
* @description This module handles the WebSocket connection for real-time, two-way
|
||||
* communication with the server. It provides functions to initialize the connection
|
||||
* and send messages.
|
||||
* and send messages, including a heartbeat mechanism to detect disconnections.
|
||||
*/
|
||||
|
||||
// The WebSocket instance, exported for potential direct access if needed.
|
||||
export let websocket;
|
||||
|
||||
// The WebSocket server address, derived from the current page's host (hostname + port).
|
||||
const gateway = `ws://${window.location.host}/ws`;
|
||||
const baseGateway = `ws://${window.location.host}/ws`;
|
||||
|
||||
// Heartbeat related variables
|
||||
let pingIntervalId = null;
|
||||
let pongTimeoutId = null;
|
||||
const HEARTBEAT_INTERVAL = 10000; // 10 seconds: How often to send a 'ping'
|
||||
const HEARTBEAT_TIMEOUT = 5000; // 5 seconds: How long to wait for a 'pong' after sending a 'ping'
|
||||
|
||||
/**
|
||||
* Initializes the WebSocket connection and sets up event handlers.
|
||||
* @param {Object} callbacks - An object containing callback functions for WebSocket events.
|
||||
* @param {function} callbacks.onOpen - Called when the connection is successfully opened.
|
||||
* @param {function} callbacks.onClose - Called when the connection is closed.
|
||||
* @param {function} callbacks.onMessage - Called when a message is received from the server.
|
||||
* Starts the heartbeat mechanism.
|
||||
* Sends a 'ping' message to the server at regular intervals and sets a timeout
|
||||
* to detect if a 'pong' response is not received.
|
||||
*/
|
||||
export function initWebSocket({onOpen, onClose, onMessage}) {
|
||||
function startHeartbeat() {
|
||||
stopHeartbeat(); // Ensure any previous heartbeat is stopped before starting a new one
|
||||
|
||||
pingIntervalId = setInterval(() => {
|
||||
if (websocket && websocket.readyState === WebSocket.OPEN) {
|
||||
websocket.send('ping');
|
||||
|
||||
// Set a timeout to check if a pong is received within HEARTBEAT_TIMEOUT
|
||||
pongTimeoutId = setTimeout(() => {
|
||||
console.warn('WebSocket: No pong received within timeout, closing connection.');
|
||||
// If no pong is received, close the connection. This will trigger the onClose handler.
|
||||
websocket.close();
|
||||
}, HEARTBEAT_TIMEOUT);
|
||||
}
|
||||
}, HEARTBEAT_INTERVAL);
|
||||
}
|
||||
|
||||
/**
|
||||
* Stops the heartbeat mechanism by clearing the ping interval and pong timeout.
|
||||
*/
|
||||
function stopHeartbeat() {
|
||||
if (pingIntervalId) {
|
||||
clearInterval(pingIntervalId);
|
||||
pingIntervalId = null;
|
||||
}
|
||||
if (pongTimeoutId) {
|
||||
clearTimeout(pongTimeoutId);
|
||||
pongTimeoutId = null;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes the WebSocket connection and sets up event handlers, including a heartbeat mechanism.
|
||||
* @param {Object} callbacks - An object containing callback functions for WebSocket events.
|
||||
* @param {function} [callbacks.onOpen] - Called when the connection is successfully opened.
|
||||
* @param {function} [callbacks.onClose] - Called when the connection is closed.
|
||||
* @param {function} [callbacks.onMessage] - Called when a message is received from the server (excluding 'pong' messages).
|
||||
* @param {function} [callbacks.onError] - Called when an error occurs with the WebSocket connection.
|
||||
*/
|
||||
export function initWebSocket({onOpen, onClose, onMessage, onError}) {
|
||||
const token = localStorage.getItem('authToken');
|
||||
let gateway = baseGateway;
|
||||
|
||||
if (token) {
|
||||
gateway = `${baseGateway}?token=${token}`;
|
||||
}
|
||||
|
||||
console.log(`Trying to open a WebSocket connection to ${gateway}...`);
|
||||
websocket = new WebSocket(gateway);
|
||||
// Set binary type to arraybuffer to handle raw binary data from the UART.
|
||||
websocket.binaryType = "arraybuffer";
|
||||
|
||||
// Assign event handlers from the provided callbacks
|
||||
if (onOpen) websocket.onopen = onOpen;
|
||||
if (onClose) websocket.onclose = onClose;
|
||||
if (onMessage) websocket.onmessage = onMessage;
|
||||
// Assign event handlers, wrapping user-provided callbacks to include heartbeat logic
|
||||
websocket.onopen = (event) => {
|
||||
console.log('WebSocket connection opened.');
|
||||
startHeartbeat(); // Start heartbeat on successful connection
|
||||
if (onOpen) {
|
||||
onOpen(event);
|
||||
}
|
||||
};
|
||||
|
||||
websocket.onclose = (event) => {
|
||||
console.log('WebSocket connection closed:', event);
|
||||
stopHeartbeat(); // Stop heartbeat when connection closes
|
||||
if (onClose) {
|
||||
onClose(event);
|
||||
}
|
||||
};
|
||||
|
||||
websocket.onmessage = (event) => {
|
||||
if (event.data === 'pong') {
|
||||
// Clear the timeout as pong was received, resetting for the next ping
|
||||
clearTimeout(pongTimeoutId);
|
||||
pongTimeoutId = null;
|
||||
} else {
|
||||
// If it's not a pong message, pass it to the user's onMessage callback
|
||||
if (onMessage) {
|
||||
onMessage(event);
|
||||
} else {
|
||||
console.log('WebSocket message received:', event.data);
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
websocket.onerror = (error) => {
|
||||
console.error('WebSocket error:', error);
|
||||
if (onError) {
|
||||
onError(error);
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -37,5 +121,7 @@ export function initWebSocket({onOpen, onClose, onMessage}) {
|
||||
export function sendWebsocketMessage(data) {
|
||||
if (websocket && websocket.readyState === WebSocket.OPEN) {
|
||||
websocket.send(data);
|
||||
} else {
|
||||
console.warn('WebSocket is not open. Message not sent:', data);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -3,4 +3,3 @@
|
||||
nvs,data,nvs,0x9000,24K,
|
||||
phy_init,data,phy,0xf000,4K,
|
||||
factory,app,factory,0x10000,2M,
|
||||
littlefs, data, littlefs, ,1536K,
|
||||
|
BIN
schematic.pdf
Normal file
@@ -7,7 +7,11 @@ CONFIG_ESPTOOLPY_FLASHMODE_QIO=y
|
||||
CONFIG_ESPTOOLPY_FLASHSIZE_4MB=y
|
||||
CONFIG_PARTITION_TABLE_CUSTOM=y
|
||||
CONFIG_UART_ISR_IN_IRAM=y
|
||||
CONFIG_HTTPD_MAX_REQ_HDR_LEN=2048
|
||||
CONFIG_HTTPD_MAX_URI_LEN=1024
|
||||
CONFIG_HTTPD_WS_SUPPORT=y
|
||||
CONFIG_ESP_HTTPS_SERVER_ENABLE=y
|
||||
CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG=y
|
||||
CONFIG_ESP_WIFI_STATIC_RX_BUFFER_NUM=20
|
||||
CONFIG_ESP_WIFI_DYNAMIC_RX_BUFFER_NUM=40
|
||||
CONFIG_ESP_WIFI_DYNAMIC_TX_BUFFER_NUM=40
|
||||
|
||||