parent
e0a9610d02
commit
fd9f215f9d
674
LICENSE
Normal file
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>.
|
||||
10
README.md
Normal file
10
README.md
Normal file
@ -0,0 +1,10 @@
|
||||
# Rotorflight Presets
|
||||
|
||||
A simple way to configure your Rotorflight Flight Controller Firmware settings.
|
||||
|
||||
See https://github.com/betaflight/firmware-presets for more information. There have been some changes made to the parser, but overall the same rules apply for building presets.
|
||||
|
||||
## Credits
|
||||
|
||||
The Preset system was developed by @limonspb for Betaflight 4.3 and ported by @Oats87 for the Rotorflight project.
|
||||
|
||||
256
index.json
Normal file
256
index.json
Normal file
@ -0,0 +1,256 @@
|
||||
{
|
||||
"majorVersion": 1,
|
||||
"minorVersion": 0,
|
||||
"settings": {
|
||||
"MetapropertyDirective": "#$",
|
||||
"PresetCategories": {
|
||||
"PROFILE": "PROFILE",
|
||||
"RATEPROFILE": "RATEPROFILE",
|
||||
"FILTERS": "FILTERS",
|
||||
"REMAPPING": "REMAPPING",
|
||||
"BNF": "BNF",
|
||||
"OTHER": "OTHER"
|
||||
},
|
||||
"PresetCategoriesPriorities": {
|
||||
"PROFILE": 1000000000000,
|
||||
"RATEPROFILE": 10000,
|
||||
"REMAPPING": 0,
|
||||
"FILTERS": 100,
|
||||
"BNF": 0,
|
||||
"OTHER": 0
|
||||
},
|
||||
"MetadataTypes": {
|
||||
"STRING": "STRING",
|
||||
"STRING_ARRAY": "STRING_ARRAY",
|
||||
"PRESET_CATEGORY": "PRESET_CATEGORY",
|
||||
"FILE_PATH": "FILE_PATH",
|
||||
"BOOLEAN": "BOOLEAN",
|
||||
"WORDS_ARRAY": "WORDS_ARRAY",
|
||||
"FILE_PATH_ARRAY": "FILE_PATH_ARRAY",
|
||||
"PRESET_STATUS": "PRESET_STATUS",
|
||||
"PRIORITY": "PRIORITY",
|
||||
"PARSER": "PARSER"
|
||||
},
|
||||
"OptionsDirectives": {
|
||||
"OPTION_DIRECTIVE": "option",
|
||||
"BEGIN_OPTION_DIRECTIVE": "option begin",
|
||||
"END_OPTION_DIRECTIVE": "option end",
|
||||
"OPTION_CHECKED": "(checked)",
|
||||
"OPTION_UNCHECKED": "(unchecked)",
|
||||
"BEGIN_OPTION_GROUP_DIRECTIVE": "option_group begin",
|
||||
"END_OPTION_GROUP_DIRECTIVE": "option_group end",
|
||||
"EXCLUSIVE_OPTION_GROUP": "(exclusive)"
|
||||
},
|
||||
"PresetStatusEnum": [
|
||||
"OFFICIAL",
|
||||
"COMMUNITY",
|
||||
"EXPERIMENTAL"
|
||||
],
|
||||
"ParserEnum": [
|
||||
"TEXT",
|
||||
"MARKED"
|
||||
],
|
||||
"presetsDir": "presets",
|
||||
"presetsFileEncoding": "utf-8",
|
||||
"presetsFileMetadata": {
|
||||
"title": {
|
||||
"type": "STRING",
|
||||
"optional": false
|
||||
},
|
||||
"firmware_version": {
|
||||
"type": "STRING_ARRAY",
|
||||
"optional": false
|
||||
},
|
||||
"category": {
|
||||
"type": "PRESET_CATEGORY",
|
||||
"optional": false
|
||||
},
|
||||
"status": {
|
||||
"type": "PRESET_STATUS",
|
||||
"optional": false
|
||||
},
|
||||
"board_name": {
|
||||
"type": "STRING_ARRAY",
|
||||
"optional": true
|
||||
},
|
||||
"author": {
|
||||
"type": "STRING",
|
||||
"optional": true
|
||||
},
|
||||
"description": {
|
||||
"type": "STRING_ARRAY",
|
||||
"optional": true
|
||||
},
|
||||
"include": {
|
||||
"type": "FILE_PATH_ARRAY",
|
||||
"optional": true
|
||||
},
|
||||
"keywords": {
|
||||
"type": "WORDS_ARRAY",
|
||||
"optional": true
|
||||
},
|
||||
"hidden": {
|
||||
"type": "BOOLEAN",
|
||||
"optional": true
|
||||
},
|
||||
"discussion": {
|
||||
"type": "STRING",
|
||||
"optional": true
|
||||
},
|
||||
"warning": {
|
||||
"type": "STRING",
|
||||
"optional": true
|
||||
},
|
||||
"disclaimer": {
|
||||
"type": "STRING",
|
||||
"optional": true
|
||||
},
|
||||
"include_warning": {
|
||||
"type": "FILE_PATH_ARRAY",
|
||||
"optional": true
|
||||
},
|
||||
"include_disclaimer": {
|
||||
"type": "FILE_PATH_ARRAY",
|
||||
"optional": true
|
||||
},
|
||||
"priority": {
|
||||
"type": "PRIORITY",
|
||||
"optional": true
|
||||
},
|
||||
"force_options_review": {
|
||||
"type": "BOOLEAN",
|
||||
"optional": true
|
||||
},
|
||||
"parser": {
|
||||
"type": "PARSER",
|
||||
"optional": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"uniqueValues": {
|
||||
"firmware_version": [
|
||||
"4.4"
|
||||
],
|
||||
"category": [
|
||||
"REMAPPING"
|
||||
],
|
||||
"author": [
|
||||
"FlyDragonRC"
|
||||
],
|
||||
"keywords": [
|
||||
"bec",
|
||||
"ext",
|
||||
"f.port",
|
||||
"fbus",
|
||||
"rpm-e",
|
||||
"rpm-s",
|
||||
"s.bus",
|
||||
"sbus",
|
||||
"voltage"
|
||||
],
|
||||
"board_name": [
|
||||
"FLYDRAGONF722_V2",
|
||||
"FLYDRAGONF722_V2_2"
|
||||
]
|
||||
},
|
||||
"presets": [
|
||||
{
|
||||
"fullPath": "presets/4.4/remapping/FDRC/f722v2/ext-volt-to-bec.txt",
|
||||
"hash": "dd3ff6286dca2208919240c3a8071a5ce08c80be7a054c3db98f78e4912320b0",
|
||||
"title": "FlyDragon F722V2 EXT Voltage -> BEC",
|
||||
"firmware_version": [
|
||||
"4.4"
|
||||
],
|
||||
"board_name": [
|
||||
"FLYDRAGONF722_V2"
|
||||
],
|
||||
"category": "REMAPPING",
|
||||
"status": "COMMUNITY",
|
||||
"keywords": [
|
||||
"ext",
|
||||
"voltage",
|
||||
"bec"
|
||||
],
|
||||
"author": "FlyDragonRC",
|
||||
"priority": 0
|
||||
},
|
||||
{
|
||||
"fullPath": "presets/4.4/remapping/FDRC/f722v2/fport-to-servo5.txt",
|
||||
"hash": "12548f2ea3b30e5e77e435f3126d586210c266bda7af1c97118d1d9eea72d1fa",
|
||||
"title": "FlyDragon F722V2/F722V2.2 F.Port -> Servo 5 Remap",
|
||||
"firmware_version": [
|
||||
"4.4"
|
||||
],
|
||||
"board_name": [
|
||||
"FLYDRAGONF722_V2",
|
||||
"FLYDRAGONF722_V2_2"
|
||||
],
|
||||
"category": "REMAPPING",
|
||||
"status": "COMMUNITY",
|
||||
"keywords": [
|
||||
"fbus",
|
||||
"f.port"
|
||||
],
|
||||
"author": "FlyDragonRC",
|
||||
"priority": 0
|
||||
},
|
||||
{
|
||||
"fullPath": "presets/4.4/remapping/FDRC/f722v2/rpm-e.txt",
|
||||
"hash": "c6254c47c37e86d6a174994eba4f0f00e5459e25c55cb520abec3c860be90ae9",
|
||||
"title": "FlyDragon F722V2/F722V2.2 Enable RPM-E",
|
||||
"firmware_version": [
|
||||
"4.4"
|
||||
],
|
||||
"board_name": [
|
||||
"FLYDRAGONF722_V2",
|
||||
"FLYDRAGONF722_V2_2"
|
||||
],
|
||||
"category": "REMAPPING",
|
||||
"status": "COMMUNITY",
|
||||
"keywords": [
|
||||
"rpm-e"
|
||||
],
|
||||
"author": "FlyDragonRC",
|
||||
"priority": 0
|
||||
},
|
||||
{
|
||||
"fullPath": "presets/4.4/remapping/FDRC/f722v2/rpm-s.txt",
|
||||
"hash": "0375fd67da70aed1092c3cc4bb171c36d68effc82b9bbfcb1d11aea438daa9de",
|
||||
"title": "FlyDragon F722V2/F722V2.2 Enable RPM-S",
|
||||
"firmware_version": [
|
||||
"4.4"
|
||||
],
|
||||
"board_name": [
|
||||
"FLYDRAGONF722_V2",
|
||||
"FLYDRAGONF722_V2_2"
|
||||
],
|
||||
"category": "REMAPPING",
|
||||
"status": "COMMUNITY",
|
||||
"keywords": [
|
||||
"rpm-s"
|
||||
],
|
||||
"author": "FlyDragonRC",
|
||||
"priority": 0
|
||||
},
|
||||
{
|
||||
"fullPath": "presets/4.4/remapping/FDRC/f722v2/sbus-to-servo5.txt",
|
||||
"hash": "6050f47a404ca5ca8c9f40cefacf18318364d5579edd8a7cf57442b93148b894",
|
||||
"title": "FlyDragon F722V2/F722V2.2 SBUS -> Servo 5 Remap",
|
||||
"firmware_version": [
|
||||
"4.4"
|
||||
],
|
||||
"board_name": [
|
||||
"FLYDRAGONF722_V2",
|
||||
"FLYDRAGONF722_V2_2"
|
||||
],
|
||||
"category": "REMAPPING",
|
||||
"status": "COMMUNITY",
|
||||
"keywords": [
|
||||
"sbus",
|
||||
"s.bus"
|
||||
],
|
||||
"author": "FlyDragonRC",
|
||||
"priority": 0
|
||||
}
|
||||
]
|
||||
}
|
||||
1
index_hash.txt
Normal file
1
index_hash.txt
Normal file
@ -0,0 +1 @@
|
||||
dd4f63da8853f01599a966b968e7ce51a36e84a962d1f9fc4d674b3ddbcbd985
|
||||
52
indexer/IndexContent.js
Normal file
52
indexer/IndexContent.js
Normal file
@ -0,0 +1,52 @@
|
||||
'use strict';
|
||||
|
||||
class IndexContent
|
||||
{
|
||||
constructor(presetFilesArray, settings)
|
||||
{
|
||||
this.majorVersion = 1;
|
||||
this.minorVersion = 0;
|
||||
this.settings = settings;
|
||||
this.uniqueValues = {};
|
||||
this.presets = presetFilesArray;
|
||||
|
||||
this.uniqueValues.firmware_version = this._getUniqueValues(presetFilesArray, "firmware_version");
|
||||
this.uniqueValues.category = this._getUniqueValues(presetFilesArray, "category");
|
||||
this.uniqueValues.author = this._getUniqueValues(presetFilesArray, "author");
|
||||
this.uniqueValues.keywords = this._getUniqueValues(presetFilesArray, "keywords");
|
||||
this.uniqueValues.board_name = this._getUniqueValues(presetFilesArray, "board_name");
|
||||
}
|
||||
|
||||
_getUniqueValues(presetFilesArray, property)
|
||||
{
|
||||
let result = new Set();
|
||||
let resultLowerCase = new Set();
|
||||
|
||||
function addValue(value) {
|
||||
const valueLowCase = value.toLowerCase();
|
||||
if (!resultLowerCase.has(valueLowCase)) {
|
||||
result.add(value);
|
||||
resultLowerCase.add(valueLowCase);
|
||||
}
|
||||
}
|
||||
|
||||
for (let preset of presetFilesArray) {
|
||||
if (property in preset) {
|
||||
if (Array.isArray(preset[property])) {
|
||||
for (let value of preset[property]) {
|
||||
addValue(value);
|
||||
}
|
||||
} else {
|
||||
addValue(preset[property]);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
result = [...result];
|
||||
result.sort((a, b) => a.localeCompare(b, undefined, {sensitivity: 'base'}));
|
||||
return result;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
module.exports = IndexContent;
|
||||
473
indexer/PresetsFile.js
Normal file
473
indexer/PresetsFile.js
Normal file
@ -0,0 +1,473 @@
|
||||
'use strict';
|
||||
|
||||
const readline = require('readline');
|
||||
const fs = require("fs");
|
||||
const crypto = require('crypto');
|
||||
|
||||
class PresetsFile
|
||||
{
|
||||
constructor(fullPath, settings, errors)
|
||||
{
|
||||
this.fullPath = fullPath;
|
||||
this.hash = "";
|
||||
this._presetsFileMetadata = settings.presetsFileMetadata;
|
||||
this._errors = errors;
|
||||
this._settings = settings;
|
||||
this.options = [];
|
||||
this.optionGroups = [];
|
||||
this._currentOption = undefined;
|
||||
this._currentOptionGroup = undefined;
|
||||
|
||||
const binaryFileContent = fs.readFileSync(this.fullPath);
|
||||
let sum = crypto.createHash('sha256');
|
||||
sum.update(binaryFileContent);
|
||||
this.hash = sum.digest('hex');
|
||||
|
||||
this._processLines(binaryFileContent, settings.presetsFileEncoding);
|
||||
this._checkProperties();
|
||||
|
||||
if (undefined === this.priority) {
|
||||
this.priority = this._settings.PresetCategoriesPriorities[this.category];
|
||||
}
|
||||
|
||||
this._clearProperties();
|
||||
}
|
||||
|
||||
_clearProperties()
|
||||
{
|
||||
delete this._presetsFileMetadata;
|
||||
delete this._errors;
|
||||
delete this._settings;
|
||||
delete this._currentOption;
|
||||
delete this._currentOptionGroup;
|
||||
delete this.options;
|
||||
delete this.optionGroups;
|
||||
delete this.description;
|
||||
delete this.include;
|
||||
delete this.discussion;
|
||||
delete this.warning;
|
||||
delete this.disclaimer;
|
||||
delete this.include_warning;
|
||||
delete this.include_disclaimer;
|
||||
delete this.parser;
|
||||
}
|
||||
|
||||
_checkProperties()
|
||||
{
|
||||
for (const [property, value] of Object.entries(this._presetsFileMetadata)) {
|
||||
if (!value.optional) {
|
||||
if (this._isEmptyProperty(this[property]))
|
||||
{
|
||||
this._addError(`missing or empty property '${property}'`);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (undefined !== this._currentOption) {
|
||||
this._addError(`Missing ${this._settings.OptionsDirectives.END_OPTION_DIRECTIVE} for ${this._currentOption.name}`);
|
||||
}
|
||||
|
||||
if (undefined !== this._currentOptionGroup) {
|
||||
this._addError(`Missing ${this._settings.OptionsDirectives.END_OPTION_GROUP_DIRECTIVE} for ${this._currentOptionGroup.name}`);
|
||||
}
|
||||
}
|
||||
|
||||
_isEmptyProperty(property)
|
||||
{
|
||||
return (property === undefined || property.length === 0);
|
||||
}
|
||||
|
||||
_processLines(binaryFileContent, presetsFileEncoding)
|
||||
{
|
||||
const fileContent = binaryFileContent.toString(presetsFileEncoding);
|
||||
const lines = fileContent.split('\n');
|
||||
|
||||
this._currentLine = 1;
|
||||
|
||||
for (let line of lines) {
|
||||
line = line.trim();
|
||||
if (line.startsWith(this._settings.MetapropertyDirective)) {
|
||||
this._processMetapropertyLine(line);
|
||||
}
|
||||
|
||||
this._currentLine++;
|
||||
}
|
||||
|
||||
delete this._currentLine;
|
||||
}
|
||||
|
||||
_processMetapropertyLine(line)
|
||||
{
|
||||
line = line.slice(this._settings.MetapropertyDirective.length).trim(); // (#$ Title: foo) -> (Title: foo)
|
||||
const lowCaseLine = line.toLowerCase();
|
||||
let isProperty = false;
|
||||
let isPropertyMissingSemicolon = false;
|
||||
let isOptionDirective = false;
|
||||
|
||||
for (const [property, value] of Object.entries(this._presetsFileMetadata)) {
|
||||
const lineBeginning = `${property.toLowerCase()}:`; // "TITLE:"
|
||||
const wrongLineBeginning = `${property.toLowerCase()}`; // "TITLE"
|
||||
|
||||
if (lowCaseLine.startsWith(lineBeginning)) {
|
||||
line = line.slice(lineBeginning.length).trim(); // (Title: foo) -> (foo)
|
||||
this._processProperty(property, line);
|
||||
isProperty = true;
|
||||
} else if (lowCaseLine.startsWith(wrongLineBeginning)) {
|
||||
isPropertyMissingSemicolon = true;
|
||||
}
|
||||
}
|
||||
|
||||
if (!isProperty && lowCaseLine.startsWith(this._settings.OptionsDirectives.OPTION_DIRECTIVE)) {
|
||||
this._processOptionDirective(line);
|
||||
isOptionDirective = true;
|
||||
}
|
||||
|
||||
if (!isProperty && !isOptionDirective) {
|
||||
if (isPropertyMissingSemicolon) {
|
||||
this._addError(`line ${this._currentLine}, property missing ":"`);
|
||||
} else {
|
||||
this._addError(`line ${this._currentLine}, unknown preset directive: '${line}'`);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
_processOptionDirective(line)
|
||||
{
|
||||
const lowCaseLine = line.toLowerCase();
|
||||
|
||||
if (lowCaseLine.startsWith(this._settings.OptionsDirectives.BEGIN_OPTION_DIRECTIVE)) {
|
||||
this._processOptionBeginDirective(line, lowCaseLine);
|
||||
} else if (lowCaseLine.startsWith(this._settings.OptionsDirectives.END_OPTION_DIRECTIVE)) {
|
||||
this._processOptionEndDirective(line, lowCaseLine);
|
||||
} else if (lowCaseLine.startsWith(this._settings.OptionsDirectives.BEGIN_OPTION_GROUP_DIRECTIVE)) {
|
||||
this._processOptionGroupBeginDirective(line, lowCaseLine);
|
||||
} else if (lowCaseLine.startsWith(this._settings.OptionsDirectives.END_OPTION_GROUP_DIRECTIVE)) {
|
||||
this._processOptionGroupEndDirective(line, lowCaseLine);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
_processOptionGroupBeginDirective(line, lowCaseLine)
|
||||
{
|
||||
const optionGroup = this._getOptionGroup(line);
|
||||
|
||||
if ("" === optionGroup.name) {
|
||||
this._addError(`line ${this._currentLine}, empty optionGroup name`);
|
||||
} else if (undefined !== this._currentOptionGroup) {
|
||||
this._addError(`line ${this._currentLine}, nested #$ option groups are not allowed`);
|
||||
} else {
|
||||
this._currentOptionGroup = optionGroup;
|
||||
}
|
||||
}
|
||||
|
||||
_processOptionGroupEndDirective(line, lowCaseLine)
|
||||
{
|
||||
if (undefined === this._currentOptionGroup) {
|
||||
this._addError(`line ${this._currentLine}, end Option Group directive found but no Option Group to close`);
|
||||
} else {
|
||||
const lowCaseOptionGroupName = this._currentOptionGroup.name.toLowerCase();
|
||||
|
||||
const indexOfOption = this.optionGroups.findIndex(item => lowCaseOptionGroupName === item.name.toLowerCase());
|
||||
|
||||
if (-1 === indexOfOption) {
|
||||
this.optionGroups.push(this._currentOptionGroup);
|
||||
}
|
||||
|
||||
this._currentOptionGroup = undefined;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
_processOptionBeginDirective(line, lowCaseLine)
|
||||
{
|
||||
const Option = this._getOption(line);
|
||||
const lowCaseOptionName = Option.name.toLowerCase();
|
||||
|
||||
if ("" === Option.name) {
|
||||
this._addError(`line ${this._currentLine}, empty Option name`);
|
||||
} else if (undefined !== this._currentOption) {
|
||||
this._addError(`line ${this._currentLine}, nested #$ options are not allowed`);
|
||||
} else {
|
||||
this._currentOption = Option;
|
||||
}
|
||||
}
|
||||
|
||||
_processOptionEndDirective(line, lowCaseLine)
|
||||
{
|
||||
if (undefined === this._currentOption) {
|
||||
this._addError(`line ${this._currentLine}, end Option directive found but no Option to close`);
|
||||
} else {
|
||||
const lowCaseOptionName = this._currentOption.name.toLowerCase();
|
||||
|
||||
const indexOfOption = this.options.findIndex(item => lowCaseOptionName === item.name.toLowerCase());
|
||||
|
||||
if (-1 === indexOfOption) {
|
||||
this.options.push(this._currentOption);
|
||||
}
|
||||
|
||||
this._currentOption = undefined;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
_escapeRegex(string)
|
||||
{
|
||||
return string.replace(/[-\/\\^$*+?.()|[\]{}]/g, '\\$&');
|
||||
}
|
||||
|
||||
_getOptionGroup(line)
|
||||
{
|
||||
const directiveRemoved = line.slice(this._settings.OptionsDirectives.BEGIN_OPTION_GROUP_DIRECTIVE.length).trim();
|
||||
const isExclusiveGroup = this._isExclusiveGroup(directiveRemoved.toLowerCase());
|
||||
|
||||
const exclusiveOptionGroupRegex = new RegExp(this._escapeRegex(this._settings.OptionsDirectives.EXCLUSIVE_OPTION_GROUP), 'gi');
|
||||
|
||||
const optionGroupName = directiveRemoved.replace(exclusiveOptionGroupRegex, "");
|
||||
|
||||
if (0 == optionGroupName.length || optionGroupName[0] != ":") {
|
||||
this._addError(`line ${this._currentLine}, OPTION_GROUP BEGIN directive should be followed by ":". Example: #$ OPTION_GROUP BEGIN: My Group Name or if its exclusive: #$ OPTION_GROUP BEGIN: (EXCLUSIVE) My Exclusive Group`);
|
||||
}
|
||||
|
||||
let optionGroup = {
|
||||
name: optionGroupName.slice(1).trim(),
|
||||
exclusive: isExclusiveGroup,
|
||||
}
|
||||
|
||||
return optionGroup;
|
||||
}
|
||||
|
||||
_isExclusiveGroup(lowercaseLine)
|
||||
{
|
||||
return lowercaseLine.includes(this._settings.OptionsDirectives.EXCLUSIVE_OPTION_GROUP)
|
||||
}
|
||||
|
||||
_getOption(line)
|
||||
{
|
||||
const directiveRemoved = line.slice(this._settings.OptionsDirectives.BEGIN_OPTION_DIRECTIVE.length).trim();
|
||||
const directiveRemovedLowCase = directiveRemoved.toLowerCase();
|
||||
const optionChecked = this._isOptionChecked(directiveRemovedLowCase);
|
||||
|
||||
const regExpRemoveChecked = new RegExp(this._escapeRegex(this._settings.OptionsDirectives.OPTION_CHECKED), 'gi');
|
||||
const regExpRemoveUnchecked = new RegExp(this._escapeRegex(this._settings.OptionsDirectives.OPTION_UNCHECKED), 'gi');
|
||||
let optionName = directiveRemoved.replace(regExpRemoveChecked, "");
|
||||
optionName = optionName.replace(regExpRemoveUnchecked, "").trim();
|
||||
if (0 == optionName.length || optionName[0] != ":") {
|
||||
this._addError(`line ${this._currentLine}, OPTION BEGIN directive should be followed by ":". Example: #$ OPTION BEGIN (UNCHECKED): My Option Name`);
|
||||
}
|
||||
|
||||
let option = {
|
||||
name: optionName.slice(1).trim(),
|
||||
checked: optionChecked
|
||||
}
|
||||
|
||||
return option;
|
||||
}
|
||||
|
||||
_isOptionChecked(lowCaseLine)
|
||||
{
|
||||
let OptionChecked = false;
|
||||
let OptionUnchecked = false;
|
||||
|
||||
if (lowCaseLine.includes(this._settings.OptionsDirectives.OPTION_CHECKED)) {
|
||||
OptionChecked = true;
|
||||
}
|
||||
if (lowCaseLine.includes(this._settings.OptionsDirectives.OPTION_UNCHECKED)) {
|
||||
OptionUnchecked = true;
|
||||
}
|
||||
|
||||
if (OptionChecked && OptionUnchecked) {
|
||||
this._addError(`line ${this._currentLine}, Option can't be checked and unchecked at the same time`);
|
||||
} else if (!OptionChecked && !OptionUnchecked) {
|
||||
this._addError(`line ${this._currentLine}, Every option must specify whether it is ${this._settings.OptionsDirectives.OPTION_CHECKED.toUpperCase()} or ${this._settings.OptionsDirectives.OPTION_UNCHECKED.toUpperCase()}`);
|
||||
} else {
|
||||
OptionChecked = OptionChecked;
|
||||
}
|
||||
|
||||
return OptionChecked;
|
||||
}
|
||||
|
||||
_processProperty(property, line)
|
||||
{
|
||||
switch(this._presetsFileMetadata[property].type) {
|
||||
case this._settings.MetadataTypes.STRING_ARRAY:
|
||||
this._processArrayProperty(property, line);
|
||||
break;
|
||||
case this._settings.MetadataTypes.STRING:
|
||||
this._processStringProperty(property, line);
|
||||
break;
|
||||
case this._settings.MetadataTypes.PRESET_CATEGORY:
|
||||
this._processPresetCategoryProperty(property, line);
|
||||
break;
|
||||
case this._settings.MetadataTypes.FILE_PATH:
|
||||
this._processFilePathProperty(property, line);
|
||||
break;
|
||||
case this._settings.MetadataTypes.FILE_PATH_ARRAY:
|
||||
this._processFilePathArrayProperty(property, line);
|
||||
break;
|
||||
case this._settings.MetadataTypes.BOOLEAN:
|
||||
this._processBooleanProperty(property, line);
|
||||
break;
|
||||
case this._settings.MetadataTypes.WORDS_ARRAY:
|
||||
this._processWordsArrayProperty(property, line);
|
||||
break;
|
||||
case this._settings.MetadataTypes.PRESET_STATUS:
|
||||
this._processPresetStatusProperty(property, line);
|
||||
break;
|
||||
case this._settings.MetadataTypes.PRIORITY:
|
||||
this._processPriorityProperty(property, line);
|
||||
break;
|
||||
case this._settings.MetadataTypes.PARSER:
|
||||
this._processParserProperty(property, line);
|
||||
break;
|
||||
default:
|
||||
this._addError(`line ${this._currentLine}, unknown property type '${this._presetsFileMetadata[property].type}' for the property '${property}'`);
|
||||
}
|
||||
}
|
||||
|
||||
_processPresetStatusProperty(property, line)
|
||||
{
|
||||
this._checkPropertyDublicated(property);
|
||||
|
||||
if (this._settings.PresetStatusEnum.includes(line)) {
|
||||
this[property] = line;
|
||||
} else {
|
||||
this._addError(`line ${this._currentLine}, unknown ${property} value: '${line}'; available values: ${this._settings.PresetStatusEnum}`);
|
||||
}
|
||||
}
|
||||
|
||||
_processParserProperty(property, line)
|
||||
{
|
||||
this._checkPropertyDublicated(property);
|
||||
|
||||
if (this._settings.ParserEnum.includes(line)) {
|
||||
this[property] = line;
|
||||
} else {
|
||||
this._addError(`line ${this._currentLine}, unknown ${property} value: '${line}'; available values: ${this._settings.ParserEnum}`);
|
||||
}
|
||||
}
|
||||
|
||||
_processWordsArrayProperty(property, line)
|
||||
{
|
||||
this._checkPropertyDublicated(property);
|
||||
|
||||
let words = line.split(",");
|
||||
words = words.map(word => word.trim());
|
||||
words = words.filter(word => word);
|
||||
this[property] = words;
|
||||
}
|
||||
|
||||
|
||||
_processBooleanProperty(property, line)
|
||||
{
|
||||
this._checkPropertyDublicated(property);
|
||||
|
||||
const trueValues = ["true", "yes"];
|
||||
const falseValues = ["false", "no"];
|
||||
|
||||
const lineLowCase = line.toLowerCase();
|
||||
|
||||
let result = false;
|
||||
|
||||
if (trueValues.includes(lineLowCase)) {
|
||||
result = true;
|
||||
} else if (falseValues.includes(lineLowCase)) {
|
||||
result = false;
|
||||
} else {
|
||||
this._addError(`line ${this._currentLine}, boolean property '${property}'' has a wrong value: '${line}'`);
|
||||
}
|
||||
|
||||
this[property] = result;
|
||||
}
|
||||
|
||||
_checkPropertyDublicated(property)
|
||||
{
|
||||
if (undefined !== this[property]) {
|
||||
this._addError(`line ${this._currentLine}, duplicated property '${property}'`);
|
||||
}
|
||||
}
|
||||
|
||||
_processFilePathProperty(property, line)
|
||||
{
|
||||
this._checkPropertyDublicated(property);
|
||||
const stat = fs.statSync(line);
|
||||
if (!stat || stat.isDirectory()) {
|
||||
this._addError(`line ${this._currentLine}, can't find file '${line}'`);
|
||||
} else {
|
||||
this[property] = line;
|
||||
}
|
||||
}
|
||||
|
||||
_processFilePathArrayProperty(property, line)
|
||||
{
|
||||
if (!this[property]) {
|
||||
this[property] = [];
|
||||
}
|
||||
|
||||
if (fs.existsSync(line)) {
|
||||
// still could be a folder, so have to filter out folders
|
||||
const stat = fs.statSync(line);
|
||||
if (!stat || stat.isDirectory()) {
|
||||
this._addError(`line ${this._currentLine}, a folder is specified instead of a file: '${line}'`);
|
||||
} else {
|
||||
this[property].push(line);
|
||||
}
|
||||
} else {
|
||||
this._addError(`line ${this._currentLine}, can't find file '${line}'`);
|
||||
}
|
||||
}
|
||||
|
||||
_processPresetCategoryProperty(property, line)
|
||||
{
|
||||
this._checkPropertyDublicated(property);
|
||||
line = line.toLowerCase();
|
||||
let presetTypeValid = false;
|
||||
|
||||
for (const [key, value] of Object.entries(this._settings.PresetCategories)) {
|
||||
if (key.toLowerCase() === line) {
|
||||
presetTypeValid = true;
|
||||
this[property] = key;
|
||||
}
|
||||
}
|
||||
|
||||
if (!presetTypeValid) {
|
||||
this._addError(`line ${this._currentLine}, unknown preset category: '${line}'`);
|
||||
}
|
||||
}
|
||||
|
||||
_processArrayProperty(property, line)
|
||||
{
|
||||
if (!this[property]) {
|
||||
this[property] = [];
|
||||
}
|
||||
|
||||
this[property].push(line);
|
||||
}
|
||||
|
||||
_processStringProperty(property, line)
|
||||
{
|
||||
this._checkPropertyDublicated(property);
|
||||
this[property] = line;
|
||||
}
|
||||
|
||||
_processPriorityProperty(property, line)
|
||||
{
|
||||
this._checkPropertyDublicated(property);
|
||||
const value = parseInt(line);
|
||||
const value2 = Number(line);
|
||||
|
||||
if (NaN === value || value !== value2) {
|
||||
this._addError(`line ${this._currentLine}, PRIORITY value must be integer. Instead it is: '${line}'`);
|
||||
}
|
||||
|
||||
this[property] = value;
|
||||
}
|
||||
|
||||
_addError(error)
|
||||
{
|
||||
const fullError = `${this.fullPath}: ${error}`;
|
||||
this._errors.push(fullError);
|
||||
console.error(fullError);
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = PresetsFile;
|
||||
79
indexer/PresetsFolder.js
Normal file
79
indexer/PresetsFolder.js
Normal file
@ -0,0 +1,79 @@
|
||||
'use strict';
|
||||
|
||||
const fs = require("fs");
|
||||
const path = require("path");
|
||||
const PresetsFile = require('./PresetsFile');
|
||||
|
||||
class PresetsFolder
|
||||
{
|
||||
constructor(fullPath, settings, presetFilesArray, errors)
|
||||
{
|
||||
this.subFolders = [];
|
||||
this.files = [];
|
||||
this.fullPath = fullPath;
|
||||
this.name = "";
|
||||
|
||||
let list = fs.readdirSync(fullPath);
|
||||
|
||||
list.forEach((fileName) => {
|
||||
const fullFileName = fullPath + '/' + fileName;
|
||||
const stat = fs.statSync(fullFileName);
|
||||
if (!fileName.startsWith(".")) {
|
||||
if (stat && stat.isDirectory()) {
|
||||
let subdir = new PresetsFolder(fullFileName, settings, presetFilesArray, errors);
|
||||
subdir.name = fileName;
|
||||
this.subFolders.push(subdir);
|
||||
} else if (fileName.toLowerCase().endsWith(".txt")) {
|
||||
let presetsFile = new PresetsFile(fullFileName, settings, errors);
|
||||
presetFilesArray.push(presetsFile);
|
||||
this.files.push(presetsFile);
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
static checkForIncludeLoops(presetFilesArray, errors)
|
||||
{
|
||||
const filesDb = PresetsFolder._createFilesDictionary(presetFilesArray);
|
||||
const fileNameErrors = {};
|
||||
|
||||
presetFilesArray.forEach((file) => {
|
||||
const parents = [];
|
||||
PresetsFolder._checkFileForIncludeLoops(file, filesDb, parents, fileNameErrors);
|
||||
});
|
||||
|
||||
for (const fileNameError in fileNameErrors) {
|
||||
const errorText = `File ${fileNameError}, takes part in the #$ INCLUDE loop'`;
|
||||
errors.push(errorText);
|
||||
console.error(errorText);
|
||||
}
|
||||
}
|
||||
|
||||
static _checkFileForIncludeLoops(file, filesDb, parents, fileNameErrors)
|
||||
{
|
||||
if (parents.includes(file.fullPath)) {
|
||||
fileNameErrors[file.fullPath] = true;
|
||||
} else {
|
||||
parents.push(file.fullPath);
|
||||
if (file.hasOwnProperty("include")) {
|
||||
file.include.forEach((includedFileName) => {
|
||||
const clonedParents = [...parents];
|
||||
PresetsFolder._checkFileForIncludeLoops(filesDb[includedFileName], filesDb, clonedParents, fileNameErrors);
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
static _createFilesDictionary(presetFilesArray)
|
||||
{
|
||||
let result = {};
|
||||
|
||||
presetFilesArray.forEach((file) => {
|
||||
result[file.fullPath] = file;
|
||||
});
|
||||
|
||||
return result;
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = PresetsFolder;
|
||||
86
indexer/Settings.js
Normal file
86
indexer/Settings.js
Normal file
@ -0,0 +1,86 @@
|
||||
'use strict';
|
||||
|
||||
const MetadataTypes = {
|
||||
STRING: "STRING",
|
||||
STRING_ARRAY: "STRING_ARRAY", // strings from multiple comment lines
|
||||
PRESET_CATEGORY: "PRESET_CATEGORY", // TUNE/RATES/OSD etc
|
||||
FILE_PATH: "FILE_PATH", // path/to/file.ext and check if file exists
|
||||
BOOLEAN: "BOOLEAN", // true/false
|
||||
WORDS_ARRAY: "WORDS_ARRAY", // "word1, word2, word3"
|
||||
FILE_PATH_ARRAY: "FILE_PATH_ARRAY", // array of path/to/file.ext and check if files exist
|
||||
PRESET_STATUS: "PRESET_STATUS", // official/community/experimental
|
||||
PRIORITY: "PRIORITY", // 0..99
|
||||
PARSER: "PARSER", // TEXT, MARKED
|
||||
}
|
||||
|
||||
const PresetStatusEnum = ["OFFICIAL", "COMMUNITY", "EXPERIMENTAL"];
|
||||
const ParserEnum = ["TEXT", "MARKED"];
|
||||
|
||||
const PresetCategories = {
|
||||
PROFILE: "PROFILE",
|
||||
RATEPROFILE: "RATEPROFILE",
|
||||
FILTERS: "FILTERS",
|
||||
REMAPPING: "REMAPPING",
|
||||
BNF: "BNF",
|
||||
OTHER: "OTHER",
|
||||
}
|
||||
|
||||
const PresetCategoriesPriorities = {
|
||||
PROFILE: 10**12,
|
||||
RATEPROFILE: 10**4,
|
||||
REMAPPING: 0,
|
||||
FILTERS: 10**2,
|
||||
BNF: 0,
|
||||
OTHER: 0,
|
||||
}
|
||||
|
||||
const OptionsDirectives = {
|
||||
OPTION_DIRECTIVE: "option",
|
||||
BEGIN_OPTION_DIRECTIVE: "option begin",
|
||||
END_OPTION_DIRECTIVE: "option end",
|
||||
OPTION_CHECKED: "(checked)",
|
||||
OPTION_UNCHECKED: "(unchecked)",
|
||||
BEGIN_OPTION_GROUP_DIRECTIVE: "option_group begin",
|
||||
END_OPTION_GROUP_DIRECTIVE: "option_group end",
|
||||
EXCLUSIVE_OPTION_GROUP: "(exclusive)",
|
||||
}
|
||||
|
||||
const settings = {
|
||||
MetapropertyDirective: "#$",
|
||||
|
||||
PresetCategories: Object.freeze(PresetCategories),
|
||||
PresetCategoriesPriorities: Object.freeze(PresetCategoriesPriorities),
|
||||
|
||||
MetadataTypes: Object.freeze(MetadataTypes),
|
||||
|
||||
OptionsDirectives : Object.freeze(OptionsDirectives),
|
||||
|
||||
PresetStatusEnum : Object.freeze(PresetStatusEnum),
|
||||
ParserEnum : Object.freeze(ParserEnum),
|
||||
|
||||
presetsDir: "presets",
|
||||
presetsFileEncoding: "utf-8",
|
||||
|
||||
presetsFileMetadata: Object.freeze({
|
||||
title: {type: MetadataTypes.STRING, optional: false },
|
||||
firmware_version: {type: MetadataTypes.STRING_ARRAY, optional: false },
|
||||
category: {type: MetadataTypes.PRESET_CATEGORY, optional: false },
|
||||
status: {type: MetadataTypes.PRESET_STATUS, optional: false },
|
||||
board_name: {type: MetadataTypes.STRING_ARRAY, optional: true },
|
||||
author: {type: MetadataTypes.STRING, optional: true },
|
||||
description: {type: MetadataTypes.STRING_ARRAY, optional: true },
|
||||
include: {type: MetadataTypes.FILE_PATH_ARRAY, optional: true },
|
||||
keywords: {type: MetadataTypes.WORDS_ARRAY, optional: true },
|
||||
hidden: {type: MetadataTypes.BOOLEAN, optional: true },
|
||||
discussion: {type: MetadataTypes.STRING, optional: true },
|
||||
warning: {type: MetadataTypes.STRING, optional: true },
|
||||
disclaimer: {type: MetadataTypes.STRING, optional: true },
|
||||
include_warning: {type: MetadataTypes.FILE_PATH_ARRAY, optional: true },
|
||||
include_disclaimer: {type: MetadataTypes.FILE_PATH_ARRAY, optional: true },
|
||||
priority: {type: MetadataTypes.PRIORITY, optional: true },
|
||||
force_options_review: {type: MetadataTypes.BOOLEAN, optional: true },
|
||||
parser: {type: MetadataTypes.PARSER, optional: true },
|
||||
}),
|
||||
}
|
||||
|
||||
module.exports = Object.freeze(settings);
|
||||
6
indexer/check.js
Normal file
6
indexer/check.js
Normal file
@ -0,0 +1,6 @@
|
||||
'use strict';
|
||||
|
||||
const child = require('child_process').fork('indexer/indexer.js', ["nosave"]);
|
||||
child.on('exit', (code) => {
|
||||
process.exitCode = code;
|
||||
});
|
||||
45
indexer/indexer.js
Normal file
45
indexer/indexer.js
Normal file
@ -0,0 +1,45 @@
|
||||
'use strict';
|
||||
|
||||
const fs = require("fs");
|
||||
const path = require("path");
|
||||
const PresetsFolder = require('./PresetsFolder');
|
||||
const settings = require('./Settings');
|
||||
const IndexContent = require('./IndexContent');
|
||||
const crypto = require('crypto');
|
||||
const errors = [];
|
||||
process.exitCode = 100;
|
||||
|
||||
let writeIndexFile = true;
|
||||
|
||||
if (process.argv.length === 3) {
|
||||
if (process.argv[2] === "nosave") {
|
||||
writeIndexFile = false;
|
||||
}
|
||||
}
|
||||
|
||||
let presetFilesArray = [];
|
||||
let presetsFolder = new PresetsFolder(settings.presetsDir, settings, presetFilesArray, errors);
|
||||
PresetsFolder.checkForIncludeLoops(presetFilesArray, errors);
|
||||
|
||||
//console.log(getUniqueValues(presetFilesArray, "firmwareVersion"));
|
||||
|
||||
if (0 === errors.length) {
|
||||
console.log("OK");
|
||||
|
||||
if (writeIndexFile) {
|
||||
const indexContent = new IndexContent(presetFilesArray, settings);
|
||||
const jsonIndexContent = JSON.stringify(indexContent, null, 2);
|
||||
fs.writeFileSync("index.json", jsonIndexContent);
|
||||
console.log("index.json created");
|
||||
|
||||
const sum = crypto.createHash('sha256');
|
||||
sum.update(jsonIndexContent);
|
||||
const indexHash = sum.digest('hex');
|
||||
fs.writeFileSync("index_hash.txt", indexHash);
|
||||
console.log("index_hash.txt created");
|
||||
}
|
||||
|
||||
process.exitCode = 0;
|
||||
} else {
|
||||
console.log("Failed with errors");
|
||||
}
|
||||
18
package.json
Normal file
18
package.json
Normal file
@ -0,0 +1,18 @@
|
||||
{
|
||||
"name" : "firmware-presets",
|
||||
"productName" : "Rotorflight Firmware Presets",
|
||||
"description" : "Collection of CLI-based presets",
|
||||
"scripts" : {
|
||||
"index" : "node indexer/indexer.js",
|
||||
"verify" : "node indexer/check.js"
|
||||
},
|
||||
"repository" : {
|
||||
"type" : "git",
|
||||
"url" : "github.com/rotorflight/rotorflight-presets"
|
||||
},
|
||||
"author" : "The Rotorflight open source project.",
|
||||
"license" : "GPL-3.0",
|
||||
"engines" : {
|
||||
"node" : ">=10.x"
|
||||
}
|
||||
}
|
||||
123
presets/4.4/profile/profile-helper.include
Normal file
123
presets/4.4/profile/profile-helper.include
Normal file
@ -0,0 +1,123 @@
|
||||
#$ OPTION_GROUP BEGIN: (EXCLUSIVE) Applied Profile
|
||||
#$ OPTION BEGIN (UNCHECKED): Profile 1
|
||||
profile 0
|
||||
#$ OPTION END
|
||||
#$ OPTION BEGIN (UNCHECKED): Profile 2
|
||||
profile 1
|
||||
#$ OPTION END
|
||||
#$ OPTION BEGIN (UNCHECKED): Profile 3
|
||||
profile 2
|
||||
#$ OPTION END
|
||||
#$ OPTION BEGIN (UNCHECKED): Profile 4
|
||||
profile 3
|
||||
#$ OPTION END
|
||||
#$ OPTION BEGIN (UNCHECKED): Profile 5
|
||||
profile 4
|
||||
#$ OPTION END
|
||||
#$ OPTION BEGIN (UNCHECKED): Profile 6
|
||||
profile 5
|
||||
#$ OPTION END
|
||||
#$ OPTION_GROUP END
|
||||
set pid_mode = 3
|
||||
set pid_dterm_mode = GYRO
|
||||
set pid_dterm_mode_yaw = GYRO
|
||||
set pid_gyro_filter_type = FIRST_ORDER
|
||||
set pitch_p_gain = 50
|
||||
set pitch_i_gain = 100
|
||||
set pitch_d_gain = 50
|
||||
set pitch_f_gain = 100
|
||||
set pitch_b_gain = 0
|
||||
set pitch_o_gain = 40
|
||||
set roll_p_gain = 50
|
||||
set roll_i_gain = 100
|
||||
set roll_d_gain = 20
|
||||
set roll_f_gain = 100
|
||||
set roll_b_gain = 0
|
||||
set roll_o_gain = 40
|
||||
set yaw_p_gain = 80
|
||||
set yaw_i_gain = 120
|
||||
set yaw_d_gain = 40
|
||||
set yaw_b_gain = 0
|
||||
set yaw_f_gain = 0
|
||||
set pitch_d_cutoff = 15
|
||||
set pitch_b_cutoff = 15
|
||||
set pitch_gyro_cutoff = 50
|
||||
set pitch_error_cutoff = 0
|
||||
set roll_d_cutoff = 15
|
||||
set roll_b_cutoff = 15
|
||||
set roll_gyro_cutoff = 50
|
||||
set roll_error_cutoff = 0
|
||||
set yaw_d_cutoff = 20
|
||||
set yaw_b_cutoff = 20
|
||||
set yaw_gyro_cutoff = 100
|
||||
set yaw_error_cutoff = 0
|
||||
set yaw_cw_stop_gain = 120
|
||||
set yaw_ccw_stop_gain = 80
|
||||
set yaw_precomp_cutoff = 5
|
||||
set yaw_precomp_filter_type = FIRST_ORDER
|
||||
set yaw_cyclic_ff_gain = 0
|
||||
set yaw_collective_ff_gain = 30
|
||||
set yaw_collective_dynamic_gain = 0
|
||||
set yaw_collective_dynamic_decay = 25
|
||||
set pitch_collective_ff_gain = 0
|
||||
set cyclic_cross_coupling_gain = 50
|
||||
set cyclic_cross_coupling_ratio = 0
|
||||
set cyclic_cross_coupling_cutoff = 25
|
||||
set error_rotation = ON
|
||||
set error_limit = 30,30,45
|
||||
set offset_limit = 45,45
|
||||
set error_decay_time_ground = 25
|
||||
set error_decay_time_cyclic = 250
|
||||
set error_decay_time_yaw = 0
|
||||
set error_decay_limit_cyclic = 12
|
||||
set error_decay_limit_yaw = 0
|
||||
set error_decay_rate_curve = 12,13,14,15,17,20,23,28,36,49,78,187,250,250,250,250
|
||||
set error_decay_limit_curve = 12,12,12,12,12,12,12,12,12,12,12,12,13,14,15,16
|
||||
set offset_decay_rate_curve = 250,250,250,250,25,3,1,0,0,0,0,0,0,0,0,0
|
||||
set offset_decay_limit_curve = 5,5,4,3,2,2,2,2,2,2,2,2,2,2,2,2
|
||||
set offset_bleed_rate_curve = 0,0,0,0,0,0,2,4,30,250,250,250,250,250,250,250
|
||||
set offset_bleed_limit_curve = 0,0,0,0,0,0,15,40,100,150,200,250,250,250,250,250
|
||||
set offset_charge_curve = 0,100,100,100,100,100,95,90,82,76,72,68,65,62,60,58
|
||||
set iterm_relax_type = RPY
|
||||
set iterm_relax_level = 40,40,40
|
||||
set iterm_relax_cutoff = 10,10,10
|
||||
set angle_level_strength = 40
|
||||
set angle_level_limit = 55
|
||||
set horizon_level_strength = 40
|
||||
set horizon_transition = 75
|
||||
set horizon_tilt_effect = 75
|
||||
set horizon_tilt_expert_mode = OFF
|
||||
set acro_trainer_angle_limit = 20
|
||||
set acro_trainer_lookahead_ms = 50
|
||||
set acro_trainer_gain = 75
|
||||
set rescue_mode = OFF
|
||||
set rescue_flip = OFF
|
||||
set rescue_flip_gain = 200
|
||||
set rescue_level_gain = 100
|
||||
set rescue_pull_up_time = 3
|
||||
set rescue_climb_time = 10
|
||||
set rescue_flip_time = 20
|
||||
set rescue_exit_time = 5
|
||||
set rescue_pull_up_collective = 650
|
||||
set rescue_climb_collective = 450
|
||||
set rescue_hover_collective = 350
|
||||
set rescue_hover_altitude = 500
|
||||
set rescue_alt_p_gain = 20
|
||||
set rescue_alt_i_gain = 20
|
||||
set rescue_alt_d_gain = 10
|
||||
set rescue_max_sp_rate = 300
|
||||
set rescue_max_sp_accel = 3000
|
||||
set rescue_max_collective = 500
|
||||
set gov_headspeed = 1000
|
||||
set gov_gain = 40
|
||||
set gov_p_gain = 40
|
||||
set gov_i_gain = 50
|
||||
set gov_d_gain = 0
|
||||
set gov_f_gain = 10
|
||||
set gov_tta_gain = 0
|
||||
set gov_tta_limit = 20
|
||||
set gov_yaw_ff_weight = 0
|
||||
set gov_cyclic_ff_weight = 10
|
||||
set gov_collective_ff_weight = 100
|
||||
set gov_max_throttle = 100
|
||||
set gov_min_throttle = 10
|
||||
16
presets/4.4/remapping/FDRC/f722v2/ext-volt-to-bec.txt
Normal file
16
presets/4.4/remapping/FDRC/f722v2/ext-volt-to-bec.txt
Normal file
@ -0,0 +1,16 @@
|
||||
#$ TITLE: FlyDragon F722V2 EXT Voltage -> BEC
|
||||
#$ FIRMWARE_VERSION: 4.4
|
||||
#$ BOARD_NAME: FLYDRAGONF722_V2
|
||||
#$ CATEGORY: REMAPPING
|
||||
#$ STATUS: COMMUNITY
|
||||
#$ KEYWORDS: ext, voltage, bec
|
||||
#$ AUTHOR: FlyDragonRC
|
||||
#$ DESCRIPTION: Enables the EXT Voltage Pin to be used as BEC voltage
|
||||
#$ PRIORITY: 0
|
||||
|
||||
resource ADC_BATT 1 NONE
|
||||
resource ADC_BEC 1 C00
|
||||
|
||||
set vbec_scale = 19
|
||||
set vbec_divider = 1
|
||||
set pid_process_denom = 2
|
||||
16
presets/4.4/remapping/FDRC/f722v2/fport-to-servo5.txt
Normal file
16
presets/4.4/remapping/FDRC/f722v2/fport-to-servo5.txt
Normal file
@ -0,0 +1,16 @@
|
||||
#$ TITLE: FlyDragon F722V2/F722V2.2 F.Port -> Servo 5 Remap
|
||||
#$ FIRMWARE_VERSION: 4.4
|
||||
#$ BOARD_NAME: FLYDRAGONF722_V2
|
||||
#$ BOARD_NAME: FLYDRAGONF722_V2_2
|
||||
#$ CATEGORY: REMAPPING
|
||||
#$ STATUS: COMMUNITY
|
||||
#$ KEYWORDS: fbus, f.port
|
||||
#$ AUTHOR: FlyDragonRC
|
||||
#$ DESCRIPTION: Remaps F.Port to Servo 5
|
||||
#$ PRIORITY: 0
|
||||
|
||||
resource SERIAL_TX 2 none
|
||||
resource SERVO 5 A02
|
||||
timer A02 AF3
|
||||
mixer input CH10 -1000 1000 1000
|
||||
mixer rule 10 set CH10 S5 1000 0
|
||||
12
presets/4.4/remapping/FDRC/f722v2/rpm-e.txt
Normal file
12
presets/4.4/remapping/FDRC/f722v2/rpm-e.txt
Normal file
@ -0,0 +1,12 @@
|
||||
#$ TITLE: FlyDragon F722V2/F722V2.2 Enable RPM-E
|
||||
#$ FIRMWARE_VERSION: 4.4
|
||||
#$ BOARD_NAME: FLYDRAGONF722_V2
|
||||
#$ BOARD_NAME: FLYDRAGONF722_V2_2
|
||||
#$ CATEGORY: REMAPPING
|
||||
#$ STATUS: COMMUNITY
|
||||
#$ KEYWORDS: rpm-e
|
||||
#$ AUTHOR: FlyDragonRC
|
||||
#$ DESCRIPTION: Enables the RPM-E Port for RPM Input
|
||||
#$ PRIORITY: 0
|
||||
|
||||
resource FREQ 1 A01
|
||||
12
presets/4.4/remapping/FDRC/f722v2/rpm-s.txt
Normal file
12
presets/4.4/remapping/FDRC/f722v2/rpm-s.txt
Normal file
@ -0,0 +1,12 @@
|
||||
#$ TITLE: FlyDragon F722V2/F722V2.2 Enable RPM-S
|
||||
#$ FIRMWARE_VERSION: 4.4
|
||||
#$ BOARD_NAME: FLYDRAGONF722_V2
|
||||
#$ BOARD_NAME: FLYDRAGONF722_V2_2
|
||||
#$ CATEGORY: REMAPPING
|
||||
#$ STATUS: COMMUNITY
|
||||
#$ KEYWORDS: rpm-s
|
||||
#$ AUTHOR: FlyDragonRC
|
||||
#$ DESCRIPTION: Enables the RPM-S Port for RPM Input
|
||||
#$ PRIORITY: 0
|
||||
|
||||
resource FREQ 1 A15
|
||||
16
presets/4.4/remapping/FDRC/f722v2/sbus-to-servo5.txt
Normal file
16
presets/4.4/remapping/FDRC/f722v2/sbus-to-servo5.txt
Normal file
@ -0,0 +1,16 @@
|
||||
#$ TITLE: FlyDragon F722V2/F722V2.2 SBUS -> Servo 5 Remap
|
||||
#$ FIRMWARE_VERSION: 4.4
|
||||
#$ BOARD_NAME: FLYDRAGONF722_V2
|
||||
#$ BOARD_NAME: FLYDRAGONF722_V2_2
|
||||
#$ CATEGORY: REMAPPING
|
||||
#$ STATUS: COMMUNITY
|
||||
#$ KEYWORDS: sbus, s.bus
|
||||
#$ AUTHOR: FlyDragonRC
|
||||
#$ DESCRIPTION: Remaps the SBUS port to Servo 5
|
||||
#$ PRIORITY: 0
|
||||
|
||||
resource SERIAL_RX 2 none
|
||||
resource SERVO 5 A03
|
||||
timer A03 AF3
|
||||
mixer input CH10 -1000 1000 1000
|
||||
mixer rule 10 set CH10 S5 1000 0
|
||||
Loading…
Reference in New Issue
Block a user