Compare commits
46 Commits
3106221e7a
...
v0.1.0
| Author | SHA1 | Date | |
|---|---|---|---|
| bf68e53a20 | |||
| cec799fd68 | |||
| c70a262f86 | |||
| a935bbe265 | |||
| 7e73ab05a2 | |||
| d5a8ff8cdc | |||
| a27cf24bd4 | |||
| 3b19b0436e | |||
| b74f0e87cd | |||
| 2ef9d979b0 | |||
| a23563c0be | |||
| 981d808004 | |||
| cce6478eec | |||
| e85b903a52 | |||
| a81e8c31ee | |||
| 05b35a9cea | |||
| 0e75299c20 | |||
| df943620d6 | |||
| 289c55b78c | |||
| 4f6a1dfc4f | |||
| 5109e3b93a | |||
| d3cd6857d0 | |||
| 61923121f0 | |||
| 9c2d0c9059 | |||
| 8ceb762fe1 | |||
| df1c8f3821 | |||
| 771d3a3861 | |||
|
|
a679786b67 | ||
|
|
ba4b4f6e7e | ||
| f507912623 | |||
| dccd6f2773 | |||
| 828964bf8f | |||
| bbdd612209 | |||
| b3371e02f7 | |||
| e6188b8e72 | |||
| 7111a20203 | |||
| 1985e72c16 | |||
| 2208aa8672 | |||
| 20cb22de01 | |||
| f152f1471d | |||
| 39310ad4d2 | |||
| 625256dff1 | |||
| f7bd651121 | |||
| 1da0844ae8 | |||
| d6f0d9650c | |||
| 6763dd9e3c |
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>.
|
||||||
19
PKGBUILD
Normal file
19
PKGBUILD
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
pkgname=fantasize
|
||||||
|
pkgver=0.1.0
|
||||||
|
pkgrel=1
|
||||||
|
pkgdesc='C++ fan control for Linux'
|
||||||
|
url='https://github.com/Tabascl/fantasize.git'
|
||||||
|
source=("$pkgname-$pkgver.tar.gz::https://github.com/Tabascl/fantasize/archive/refs/tags/v$pkgver.tar.gz")
|
||||||
|
arch=('x86_64')
|
||||||
|
license=('GPL3')
|
||||||
|
makedepends=('git' 'cmake' 'nlohmann-json' 'boost' 'cuda')
|
||||||
|
sha256sums=('69d61255edb49b66396f00b7bfadb39ce1220769838929ad74dc9f3301742ce7')
|
||||||
|
|
||||||
|
build() {
|
||||||
|
cmake -S "$pkgname-$pkgver/app" -B build -DCMAKE_BUILD_TYPE=Release
|
||||||
|
cmake --build build
|
||||||
|
}
|
||||||
|
|
||||||
|
package() {
|
||||||
|
cmake --install build --prefix "$pkgdir/" --verbose
|
||||||
|
}
|
||||||
3
README.md
Normal file
3
README.md
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
# Fantasize
|
||||||
|
|
||||||
|
[Github Mirror Repo](https://github.com/Tabascl/fantasize)
|
||||||
@@ -1,18 +1,35 @@
|
|||||||
cmake_minimum_required(VERSION 3.0)
|
cmake_minimum_required(VERSION 3.0)
|
||||||
|
|
||||||
project(fantasize)
|
project(fantasize VERSION 0.1.0)
|
||||||
|
|
||||||
set(CMAKE_BUILD_TYPE Debug)
|
|
||||||
set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
|
set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
|
||||||
|
|
||||||
|
find_package(nlohmann_json 3.11.2 REQUIRED)
|
||||||
|
find_package(Boost 1.80 COMPONENTS program_options REQUIRED)
|
||||||
|
|
||||||
add_executable(app
|
add_executable(${PROJECT_NAME}
|
||||||
src/main.cxx
|
src/main.cxx
|
||||||
src/nvidia.cxx
|
src/sensor/LMSensorsFacade.cxx
|
||||||
src/pwm.cxx
|
src/sensor/GPUSensorsFacade.cxx
|
||||||
|
src/sensor/Sensor.cxx
|
||||||
|
src/sensor/NvidiaSensor.cxx
|
||||||
|
src/sensor/LMSensor.cxx
|
||||||
|
src/pwm/PWMControl.cxx
|
||||||
|
src/pwm/PWMControlFacade.cxx
|
||||||
|
src/fan/HwmonFan.cxx
|
||||||
|
src/fan/FanCurve.cxx
|
||||||
|
src/fan/FanLabeler.cxx
|
||||||
|
src/FanGenerator.cxx
|
||||||
|
src/Serializer.cxx
|
||||||
|
src/sensor/SensorManager.cxx
|
||||||
|
src/Controller.cxx
|
||||||
|
src/App.cxx
|
||||||
)
|
)
|
||||||
|
|
||||||
set_property(TARGET app PROPERTY CXX_STANDARD 17)
|
set_property(TARGET ${PROJECT_NAME} PROPERTY CXX_STANDARD 20)
|
||||||
|
|
||||||
target_include_directories(app PUBLIC include /opt/cuda)
|
target_include_directories(${PROJECT_NAME} PUBLIC include /opt/cuda)
|
||||||
target_link_libraries(app PUBLIC sensors nvidia-ml)
|
target_link_libraries(${PROJECT_NAME} PUBLIC sensors nvidia-ml nlohmann_json::nlohmann_json tbb ${Boost_LIBRARIES})
|
||||||
|
|
||||||
|
install(TARGETS ${PROJECT_NAME} DESTINATION usr/local/bin)
|
||||||
|
install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/unit/fantasize.service DESTINATION usr/lib/systemd/system)
|
||||||
|
|||||||
32
app/include/App.h
Normal file
32
app/include/App.h
Normal file
@@ -0,0 +1,32 @@
|
|||||||
|
#ifndef APP_H_
|
||||||
|
#define APP_H_
|
||||||
|
|
||||||
|
#include <memory>
|
||||||
|
|
||||||
|
#include <Controller.h>
|
||||||
|
#include <FanGenerator.h>
|
||||||
|
#include <Serializer.h>
|
||||||
|
#include <fan/FanLabeler.h>
|
||||||
|
#include <pwm/PWMControlFacade.h>
|
||||||
|
#include <sensor/SensorManager.h>
|
||||||
|
|
||||||
|
class App {
|
||||||
|
public:
|
||||||
|
void Init();
|
||||||
|
|
||||||
|
void InitialSetup();
|
||||||
|
void NormalOperation();
|
||||||
|
|
||||||
|
void Shutdown();
|
||||||
|
|
||||||
|
private:
|
||||||
|
SensorManager mSensorManager;
|
||||||
|
Serializer mSerializer;
|
||||||
|
PWMControlFacade mPWMControlFacade;
|
||||||
|
FanLabeler mFanLabeler;
|
||||||
|
FanGenerator mFanGenerator;
|
||||||
|
|
||||||
|
std::unique_ptr<Controller> mController;
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif // APP_H_
|
||||||
28
app/include/ConfigManager.h
Normal file
28
app/include/ConfigManager.h
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
#ifndef CONFIGMANAGER_H_
|
||||||
|
#define CONFIGMANAGER_H_
|
||||||
|
|
||||||
|
#include <memory>
|
||||||
|
#include <vector>
|
||||||
|
|
||||||
|
#include <nlohmann/json.hpp>
|
||||||
|
|
||||||
|
#include <fan/Fan.h>
|
||||||
|
|
||||||
|
#define CONFIG_FILE "/etc/fantasize/config.json"
|
||||||
|
|
||||||
|
using json = nlohmann::json;
|
||||||
|
|
||||||
|
class ConfigManager {
|
||||||
|
public:
|
||||||
|
ConfigManager();
|
||||||
|
~ConfigManager();
|
||||||
|
|
||||||
|
void WriteConfig();
|
||||||
|
|
||||||
|
void SaveFans(std::vector<std::shared_ptr<Fan>> fans);
|
||||||
|
|
||||||
|
private:
|
||||||
|
json mConfig;
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif // CONFIGMANAGER_H_
|
||||||
27
app/include/Controller.h
Normal file
27
app/include/Controller.h
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
#ifndef CONTROLLER_H_
|
||||||
|
#define CONTROLLER_H_
|
||||||
|
|
||||||
|
#include <memory>
|
||||||
|
#include <thread>
|
||||||
|
#include <vector>
|
||||||
|
|
||||||
|
#include <fan/FanCurve.h>
|
||||||
|
|
||||||
|
class Controller {
|
||||||
|
public:
|
||||||
|
Controller(std::vector<std::shared_ptr<FanCurve>> curves);
|
||||||
|
~Controller();
|
||||||
|
|
||||||
|
void StartFanControlLoop();
|
||||||
|
void StopFanControlLoop();
|
||||||
|
|
||||||
|
private:
|
||||||
|
void Loop();
|
||||||
|
|
||||||
|
std::vector<std::shared_ptr<FanCurve>> mFanCurves;
|
||||||
|
std::atomic<bool> mRun;
|
||||||
|
|
||||||
|
std::unique_ptr<std::thread> mWorker;
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif // CONTROLLER_H_
|
||||||
23
app/include/FanGenerator.h
Normal file
23
app/include/FanGenerator.h
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
#ifndef MAPPING_H_
|
||||||
|
#define MAPPING_H_
|
||||||
|
|
||||||
|
#include <memory>
|
||||||
|
#include <vector>
|
||||||
|
|
||||||
|
#include <fan/Fan.h>
|
||||||
|
#include <pwm/PWMControl.h>
|
||||||
|
#include <sensor/Sensor.h>
|
||||||
|
|
||||||
|
class FanGenerator {
|
||||||
|
public:
|
||||||
|
std::vector<std::shared_ptr<Fan>>
|
||||||
|
FindFans(std::vector<std::shared_ptr<Sensor>> rpmSensors,
|
||||||
|
std::vector<std::shared_ptr<PWMControl>> pwmControls);
|
||||||
|
|
||||||
|
private:
|
||||||
|
template <class Printable>
|
||||||
|
void print(std::string listLabel,
|
||||||
|
std::vector<std::shared_ptr<Printable>> list);
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif // MAPPING_H_
|
||||||
11
app/include/Printable.h
Normal file
11
app/include/Printable.h
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
#ifndef PRINTABLE_H_
|
||||||
|
#define PRINTABLE_H_
|
||||||
|
|
||||||
|
#include <string>
|
||||||
|
|
||||||
|
class Printable {
|
||||||
|
public:
|
||||||
|
virtual const std::string toString() const = 0;
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif // PRINTABLE_H_
|
||||||
13
app/include/Serializable.h
Normal file
13
app/include/Serializable.h
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
#ifndef SERIALIZABLE_H_
|
||||||
|
#define SERIALIZABLE_H_
|
||||||
|
|
||||||
|
#include <nlohmann/json.hpp>
|
||||||
|
|
||||||
|
using json = nlohmann::json;
|
||||||
|
|
||||||
|
class Serializable {
|
||||||
|
public:
|
||||||
|
virtual json toJson() const = 0;
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif // SERIALIZABLE_H_
|
||||||
34
app/include/Serializer.h
Normal file
34
app/include/Serializer.h
Normal file
@@ -0,0 +1,34 @@
|
|||||||
|
#ifndef SERIALIZER_H_
|
||||||
|
#define SERIALIZER_H_
|
||||||
|
|
||||||
|
#include "fan/HwmonFan.h"
|
||||||
|
#include <memory>
|
||||||
|
#include <vector>
|
||||||
|
|
||||||
|
#include <nlohmann/json.hpp>
|
||||||
|
|
||||||
|
#include <fan/Fan.h>
|
||||||
|
#include <fan/FanCurve.h>
|
||||||
|
#include <sensor/Sensor.h>
|
||||||
|
|
||||||
|
#define SERIALIZATION_DIR "/etc/fantasize"
|
||||||
|
#define FANS_JSON_FILENAME "fans.json"
|
||||||
|
|
||||||
|
using json = nlohmann::json;
|
||||||
|
|
||||||
|
class Serializer {
|
||||||
|
public:
|
||||||
|
Serializer();
|
||||||
|
void SerializeFans(std::vector<std::shared_ptr<Fan>> fans);
|
||||||
|
std::vector<std::shared_ptr<Fan>>
|
||||||
|
DeserializeFans(std::vector<std::shared_ptr<Sensor>> availableSensors);
|
||||||
|
std::vector<std::shared_ptr<FanCurve>>
|
||||||
|
DeserializeFanCurves(std::vector<std::shared_ptr<Sensor>> availableSensors,
|
||||||
|
std::vector<std::shared_ptr<Fan>> availableFans);
|
||||||
|
|
||||||
|
private:
|
||||||
|
void WriteJson(json o);
|
||||||
|
json ReadJson();
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif // SERIALIZER_H_
|
||||||
20
app/include/fan/Fan.h
Normal file
20
app/include/fan/Fan.h
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
#ifndef FAN_H_
|
||||||
|
#define FAN_H_
|
||||||
|
|
||||||
|
#include <Printable.h>
|
||||||
|
#include <Serializable.h>
|
||||||
|
|
||||||
|
class Fan : public Serializable, public Printable {
|
||||||
|
public:
|
||||||
|
virtual void PWM(int percent) = 0;
|
||||||
|
virtual int RPM() = 0;
|
||||||
|
|
||||||
|
virtual void Label(std::string label) = 0;
|
||||||
|
virtual void MinPWM(int value) = 0;
|
||||||
|
virtual void StartPWM(int value) = 0;
|
||||||
|
|
||||||
|
virtual void FindMinPWM() = 0;
|
||||||
|
virtual void FindStartPWM() = 0;
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif // FAN_H_
|
||||||
32
app/include/fan/FanCurve.h
Normal file
32
app/include/fan/FanCurve.h
Normal file
@@ -0,0 +1,32 @@
|
|||||||
|
#ifndef FANCURVE_H_
|
||||||
|
#define FANCURVE_H_
|
||||||
|
|
||||||
|
#include <memory>
|
||||||
|
#include <vector>
|
||||||
|
|
||||||
|
#include <fan/HwmonFan.h>
|
||||||
|
#include <sensor/Sensor.h>
|
||||||
|
|
||||||
|
struct FanStep {
|
||||||
|
int Temp;
|
||||||
|
int Percent;
|
||||||
|
};
|
||||||
|
|
||||||
|
class FanCurve {
|
||||||
|
public:
|
||||||
|
FanCurve(std::vector<FanStep> steps,
|
||||||
|
std::vector<std::shared_ptr<Sensor>> sensors,
|
||||||
|
std::vector<std::shared_ptr<Fan>> fans);
|
||||||
|
|
||||||
|
void DoFanControl();
|
||||||
|
|
||||||
|
private:
|
||||||
|
int AggregateTemperature();
|
||||||
|
void PrintInfo();
|
||||||
|
|
||||||
|
std::vector<FanStep> mSteps;
|
||||||
|
std::vector<std::shared_ptr<Sensor>> mTempSensors;
|
||||||
|
std::vector<std::shared_ptr<Fan>> mFans;
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif // FANCURVE_H_
|
||||||
14
app/include/fan/FanLabeler.h
Normal file
14
app/include/fan/FanLabeler.h
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
#ifndef FANLABELER_H_
|
||||||
|
#define FANLABELER_H_
|
||||||
|
|
||||||
|
#include <memory>
|
||||||
|
#include <vector>
|
||||||
|
|
||||||
|
#include <fan/Fan.h>
|
||||||
|
|
||||||
|
class FanLabeler {
|
||||||
|
public:
|
||||||
|
void RunFanLabelInteraction(std::vector<std::shared_ptr<Fan>> fans);
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif // FANLABELER_H_
|
||||||
39
app/include/fan/HwmonFan.h
Normal file
39
app/include/fan/HwmonFan.h
Normal file
@@ -0,0 +1,39 @@
|
|||||||
|
#ifndef HWMONFAN_H_
|
||||||
|
#define HWMONFAN_H_
|
||||||
|
|
||||||
|
#include <boost/json/object.hpp>
|
||||||
|
#include <memory>
|
||||||
|
|
||||||
|
#include <fan/Fan.h>
|
||||||
|
#include <pwm/PWMControl.h>
|
||||||
|
#include <sensor/Sensor.h>
|
||||||
|
|
||||||
|
class HwmonFan : public Fan {
|
||||||
|
public:
|
||||||
|
HwmonFan(std::shared_ptr<PWMControl> pwmControl,
|
||||||
|
std::shared_ptr<Sensor> rpmSensor);
|
||||||
|
|
||||||
|
void PWM(int percent) override;
|
||||||
|
int RPM() override;
|
||||||
|
|
||||||
|
void Label(std::string label) override;
|
||||||
|
void MinPWM(int value) override;
|
||||||
|
void StartPWM(int value) override;
|
||||||
|
|
||||||
|
void FindMinPWM() override;
|
||||||
|
void FindStartPWM() override;
|
||||||
|
|
||||||
|
json toJson() const override;
|
||||||
|
|
||||||
|
const std::string toString() const override;
|
||||||
|
|
||||||
|
private:
|
||||||
|
std::shared_ptr<PWMControl> mPWMControl;
|
||||||
|
std::shared_ptr<Sensor> mRpmSensor;
|
||||||
|
std::string mLabel;
|
||||||
|
|
||||||
|
int mMinPWM;
|
||||||
|
int mStartPWM;
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif // HWMONFAN_H_
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
#ifndef NVIDIA_H_
|
|
||||||
#define NVIDIA_H_
|
|
||||||
|
|
||||||
class Nvidia {
|
|
||||||
public:
|
|
||||||
Nvidia();
|
|
||||||
~Nvidia();
|
|
||||||
double get_gpu_temperature();
|
|
||||||
};
|
|
||||||
|
|
||||||
#endif // NVIDIA_H_
|
|
||||||
@@ -1,30 +0,0 @@
|
|||||||
#ifndef PWM_H_
|
|
||||||
#define PWM_H_
|
|
||||||
|
|
||||||
#include <string>
|
|
||||||
#include <unordered_map>
|
|
||||||
|
|
||||||
typedef struct {
|
|
||||||
std::string control;
|
|
||||||
std::string enable;
|
|
||||||
std::string mode;
|
|
||||||
} PWM_CONTROL;
|
|
||||||
|
|
||||||
typedef enum { FULL_SPEED = 0, MANUAL_CONTROL, AUTOMATIC } PWM_ENABLE;
|
|
||||||
typedef enum { DC = 0, PWM } PWM_MODE;
|
|
||||||
|
|
||||||
class PWM {
|
|
||||||
public:
|
|
||||||
PWM();
|
|
||||||
void dumpValues();
|
|
||||||
|
|
||||||
void setEnable(PWM_CONTROL control, PWM_ENABLE value);
|
|
||||||
void setMode(PWM_CONTROL control, PWM_MODE mode);
|
|
||||||
void setValuePwm(PWM_CONTROL control, int pwm);
|
|
||||||
void setValuePercent(PWM_CONTROL control, int percentage);
|
|
||||||
|
|
||||||
private:
|
|
||||||
std::unordered_map<std::string, PWM_CONTROL> mPwmControls;
|
|
||||||
};
|
|
||||||
|
|
||||||
#endif // PWM_H_
|
|
||||||
40
app/include/pwm/PWMControl.h
Normal file
40
app/include/pwm/PWMControl.h
Normal file
@@ -0,0 +1,40 @@
|
|||||||
|
#ifndef PWMCONTROL_H_
|
||||||
|
#define PWMCONTROL_H_
|
||||||
|
|
||||||
|
#include <boost/json/object.hpp>
|
||||||
|
#include <string>
|
||||||
|
|
||||||
|
#include <Printable.h>
|
||||||
|
#include <Serializable.h>
|
||||||
|
|
||||||
|
enum class PWM_CONTROL_PROPERTY { CONTROL, ENABLE, MODE };
|
||||||
|
enum class PWM_ENABLE { FULL_SPEED = 0, MANUAL_CONTROL };
|
||||||
|
enum class PWM_MODE { DC = 0, PWM };
|
||||||
|
|
||||||
|
class PWMControl : public Printable, public Serializable {
|
||||||
|
public:
|
||||||
|
PWMControl(std::string controlPath);
|
||||||
|
~PWMControl();
|
||||||
|
|
||||||
|
void pwm(int percent);
|
||||||
|
int pwm();
|
||||||
|
|
||||||
|
void EnableManualControl();
|
||||||
|
void Reset();
|
||||||
|
|
||||||
|
const std::string toString() const override;
|
||||||
|
|
||||||
|
json toJson() const override;
|
||||||
|
|
||||||
|
private:
|
||||||
|
int readValue(std::string path);
|
||||||
|
|
||||||
|
std::string mControlPath;
|
||||||
|
std::string mEnablePath;
|
||||||
|
std::string mModePath;
|
||||||
|
|
||||||
|
std::string mInitialEnable;
|
||||||
|
std::string mInitialMode;
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif // PWMCONTROL_H_
|
||||||
16
app/include/pwm/PWMControlFacade.h
Normal file
16
app/include/pwm/PWMControlFacade.h
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
#ifndef PWMCONTROLFACADE_H_
|
||||||
|
#define PWMCONTROLFACADE_H_
|
||||||
|
|
||||||
|
#include <memory>
|
||||||
|
#include <vector>
|
||||||
|
|
||||||
|
#include <pwm/PWMControl.h>
|
||||||
|
|
||||||
|
#define HWMON_BASE_PATH "/sys/class/hwmon"
|
||||||
|
|
||||||
|
class PWMControlFacade {
|
||||||
|
public:
|
||||||
|
std::vector<std::shared_ptr<PWMControl>> PWMControls();
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif // PWMCONTROLFACADE_H_
|
||||||
14
app/include/sensor/GPUSensorsFacade.h
Normal file
14
app/include/sensor/GPUSensorsFacade.h
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
#ifndef GPUSENSORSFACADE_H_
|
||||||
|
#define GPUSENSORSFACADE_H_
|
||||||
|
|
||||||
|
#include <memory>
|
||||||
|
#include <vector>
|
||||||
|
|
||||||
|
#include <sensor/Sensor.h>
|
||||||
|
|
||||||
|
class GPUSensorsFacade {
|
||||||
|
public:
|
||||||
|
std::vector<std::shared_ptr<Sensor>> TemperatureSensors();
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif // GPUSENSORSFACADE_H_
|
||||||
24
app/include/sensor/LMSensor.h
Normal file
24
app/include/sensor/LMSensor.h
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
#ifndef HWMONSENSOR_H_
|
||||||
|
#define HWMONSENSOR_H_
|
||||||
|
|
||||||
|
#include <sensors/sensors.h>
|
||||||
|
|
||||||
|
#include <sensor/Sensor.h>
|
||||||
|
|
||||||
|
class LMSensor : public Sensor {
|
||||||
|
public:
|
||||||
|
LMSensor(const sensors_chip_name *chipName, const sensors_feature *feature,
|
||||||
|
const sensors_subfeature *subfeature);
|
||||||
|
|
||||||
|
int value() override;
|
||||||
|
const std::string toString() const override;
|
||||||
|
|
||||||
|
json toJson() const override;
|
||||||
|
|
||||||
|
private:
|
||||||
|
const sensors_chip_name *mChipName;
|
||||||
|
const sensors_feature *mFeature;
|
||||||
|
const sensors_subfeature *mSubFeature;
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif // HWMONSENSOR_H_
|
||||||
27
app/include/sensor/LMSensorsFacade.h
Normal file
27
app/include/sensor/LMSensorsFacade.h
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
#ifndef LMSENSORSFACADE_H_
|
||||||
|
#define LMSENSORSFACADE_H_
|
||||||
|
|
||||||
|
#include <memory>
|
||||||
|
#include <vector>
|
||||||
|
|
||||||
|
#include <sensors/sensors.h>
|
||||||
|
|
||||||
|
#include <sensor/Sensor.h>
|
||||||
|
|
||||||
|
class LMSensorsFacade {
|
||||||
|
public:
|
||||||
|
LMSensorsFacade();
|
||||||
|
~LMSensorsFacade();
|
||||||
|
|
||||||
|
std::vector<std::shared_ptr<Sensor>> TemperatureSensors();
|
||||||
|
std::vector<std::shared_ptr<Sensor>> RPMSensors();
|
||||||
|
|
||||||
|
private:
|
||||||
|
template <sensors_subfeature_type T>
|
||||||
|
std::vector<std::shared_ptr<Sensor>> Sensors();
|
||||||
|
|
||||||
|
private:
|
||||||
|
FILE *mConfigFile;
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif // LMSENSORSFACADE_H_
|
||||||
18
app/include/sensor/NvidiaSensor.h
Normal file
18
app/include/sensor/NvidiaSensor.h
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
#ifndef NVIDIASENSOR_H_
|
||||||
|
#define NVIDIASENSOR_H_
|
||||||
|
|
||||||
|
#include <sensor/Sensor.h>
|
||||||
|
|
||||||
|
class NvidiaSensor : public Sensor {
|
||||||
|
public:
|
||||||
|
NvidiaSensor();
|
||||||
|
~NvidiaSensor();
|
||||||
|
|
||||||
|
int value() override;
|
||||||
|
|
||||||
|
const std::string toString() const override;
|
||||||
|
|
||||||
|
json toJson() const override;
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif // NVIDIASENSOR_H_
|
||||||
19
app/include/sensor/Sensor.h
Normal file
19
app/include/sensor/Sensor.h
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
#ifndef SENSOR_H_
|
||||||
|
#define SENSOR_H_
|
||||||
|
|
||||||
|
#include <Printable.h>
|
||||||
|
#include <Serializable.h>
|
||||||
|
|
||||||
|
class Sensor : public Printable, public Serializable {
|
||||||
|
public:
|
||||||
|
// Read the current value
|
||||||
|
virtual int value() = 0;
|
||||||
|
|
||||||
|
virtual int max() const;
|
||||||
|
virtual void max(int value);
|
||||||
|
|
||||||
|
protected:
|
||||||
|
int mMax = 0;
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif // SENSOR_H_
|
||||||
20
app/include/sensor/SensorManager.h
Normal file
20
app/include/sensor/SensorManager.h
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
#ifndef SENSORMANAGER_H_
|
||||||
|
#define SENSORMANAGER_H_
|
||||||
|
|
||||||
|
#include <memory>
|
||||||
|
#include <sensor/GPUSensorsFacade.h>
|
||||||
|
#include <sensor/LMSensorsFacade.h>
|
||||||
|
|
||||||
|
class SensorManager {
|
||||||
|
public:
|
||||||
|
SensorManager();
|
||||||
|
|
||||||
|
std::vector<std::shared_ptr<Sensor>> TemperatureSensors();
|
||||||
|
std::vector<std::shared_ptr<Sensor>> RPMSensors();
|
||||||
|
|
||||||
|
private:
|
||||||
|
std::unique_ptr<LMSensorsFacade> mLMSensorsFacade;
|
||||||
|
std::unique_ptr<GPUSensorsFacade> mGPUSensorsFacade;
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif // SENSORMANAGER_H_
|
||||||
33
app/src/App.cxx
Normal file
33
app/src/App.cxx
Normal file
@@ -0,0 +1,33 @@
|
|||||||
|
#include <execution>
|
||||||
|
|
||||||
|
#include <App.h>
|
||||||
|
|
||||||
|
using namespace std;
|
||||||
|
|
||||||
|
void App::Init() {
|
||||||
|
auto fans = mSerializer.DeserializeFans(mSensorManager.RPMSensors());
|
||||||
|
|
||||||
|
auto fanCurves = mSerializer.DeserializeFanCurves(
|
||||||
|
mSensorManager.TemperatureSensors(), fans);
|
||||||
|
|
||||||
|
mController = make_unique<Controller>(fanCurves);
|
||||||
|
}
|
||||||
|
|
||||||
|
void App::InitialSetup() {
|
||||||
|
auto fans = mFanGenerator.FindFans(mSensorManager.RPMSensors(),
|
||||||
|
mPWMControlFacade.PWMControls());
|
||||||
|
|
||||||
|
std::for_each(std::execution::par, std::begin(fans), std::end(fans),
|
||||||
|
[](auto &&fan) { fan->FindMinPWM(); });
|
||||||
|
|
||||||
|
mFanLabeler.RunFanLabelInteraction(fans);
|
||||||
|
|
||||||
|
mSerializer.SerializeFans(fans);
|
||||||
|
}
|
||||||
|
|
||||||
|
void App::NormalOperation() {
|
||||||
|
if (mController)
|
||||||
|
mController->StartFanControlLoop();
|
||||||
|
}
|
||||||
|
|
||||||
|
void App::Shutdown() { mController.reset(); }
|
||||||
29
app/src/ConfigManager.cxx
Normal file
29
app/src/ConfigManager.cxx
Normal file
@@ -0,0 +1,29 @@
|
|||||||
|
#include <filesystem>
|
||||||
|
#include <fstream>
|
||||||
|
|
||||||
|
#include <ConfigManager.h>
|
||||||
|
#include <memory>
|
||||||
|
|
||||||
|
using namespace std;
|
||||||
|
namespace fs = std::filesystem;
|
||||||
|
|
||||||
|
ConfigManager::ConfigManager() {
|
||||||
|
if (fs::exists(CONFIG_FILE)) {
|
||||||
|
ifstream f(CONFIG_FILE);
|
||||||
|
mConfig = json::parse(f);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void ConfigManager::SaveFans(vector<shared_ptr<Fan>> fans) {
|
||||||
|
json obj;
|
||||||
|
|
||||||
|
for (auto fan : fans) {
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
ConfigManager::~ConfigManager() { WriteConfig(); }
|
||||||
|
|
||||||
|
void ConfigManager::WriteConfig() {
|
||||||
|
ofstream f(CONFIG_FILE, ios::trunc);
|
||||||
|
f << mConfig.dump(2) << endl;
|
||||||
|
}
|
||||||
37
app/src/Controller.cxx
Normal file
37
app/src/Controller.cxx
Normal file
@@ -0,0 +1,37 @@
|
|||||||
|
#include <chrono>
|
||||||
|
#include <memory>
|
||||||
|
|
||||||
|
#include <Controller.h>
|
||||||
|
#include <fan/FanCurve.h>
|
||||||
|
|
||||||
|
using namespace std;
|
||||||
|
|
||||||
|
#define TIMEOUT 500
|
||||||
|
|
||||||
|
Controller::Controller(vector<shared_ptr<FanCurve>> curves)
|
||||||
|
: mFanCurves(curves), mRun(false) {}
|
||||||
|
|
||||||
|
Controller::~Controller() { StopFanControlLoop(); }
|
||||||
|
|
||||||
|
void Controller::StartFanControlLoop() {
|
||||||
|
mRun = true;
|
||||||
|
Loop();
|
||||||
|
// mWorker = make_unique<thread>(&Controller::Loop, this);
|
||||||
|
}
|
||||||
|
|
||||||
|
void Controller::StopFanControlLoop() {
|
||||||
|
mRun = false;
|
||||||
|
// if (mWorker->joinable())
|
||||||
|
// mWorker->join();
|
||||||
|
// mWorker.reset();
|
||||||
|
}
|
||||||
|
|
||||||
|
void Controller::Loop() {
|
||||||
|
while (mRun) {
|
||||||
|
for (auto c : mFanCurves) {
|
||||||
|
c->DoFanControl();
|
||||||
|
}
|
||||||
|
|
||||||
|
this_thread::sleep_for(chrono::milliseconds(TIMEOUT));
|
||||||
|
}
|
||||||
|
}
|
||||||
70
app/src/FanGenerator.cxx
Normal file
70
app/src/FanGenerator.cxx
Normal file
@@ -0,0 +1,70 @@
|
|||||||
|
#include <chrono>
|
||||||
|
#include <iostream>
|
||||||
|
#include <map>
|
||||||
|
#include <memory>
|
||||||
|
#include <thread>
|
||||||
|
|
||||||
|
#include <FanGenerator.h>
|
||||||
|
#include <fan/HwmonFan.h>
|
||||||
|
#include <pwm/PWMControl.h>
|
||||||
|
|
||||||
|
#define SETTLE_TIMEOUT 5
|
||||||
|
|
||||||
|
using namespace std;
|
||||||
|
|
||||||
|
vector<shared_ptr<Fan>>
|
||||||
|
FanGenerator::FindFans(vector<shared_ptr<Sensor>> rpmSensors,
|
||||||
|
vector<shared_ptr<PWMControl>> pwmControls) {
|
||||||
|
print("RPM Sensors", rpmSensors);
|
||||||
|
print("PWM controllers", pwmControls);
|
||||||
|
vector<shared_ptr<Fan>> mapping;
|
||||||
|
|
||||||
|
cout << "Setting all fans to maximum speed" << endl;
|
||||||
|
for (auto c : pwmControls) {
|
||||||
|
c->EnableManualControl();
|
||||||
|
c->pwm(100);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Wait for fans to settle
|
||||||
|
cout << "Waiting for fans to settle" << endl;
|
||||||
|
this_thread::sleep_for(chrono::seconds(SETTLE_TIMEOUT));
|
||||||
|
|
||||||
|
// Record values of all RPM sensors
|
||||||
|
for (auto s : rpmSensors) {
|
||||||
|
int value = s->value();
|
||||||
|
s->max(value);
|
||||||
|
|
||||||
|
cout << s->toString() << " max value: " << s->max() << endl;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Set each fan to 50% and check if a sensor matches
|
||||||
|
for (auto c : pwmControls) {
|
||||||
|
cout << "Setting " << c->toString()
|
||||||
|
<< " to 50% and wait for it to settle..." << endl;
|
||||||
|
c->pwm(50);
|
||||||
|
|
||||||
|
this_thread::sleep_for(chrono::seconds(SETTLE_TIMEOUT));
|
||||||
|
|
||||||
|
for (auto s : rpmSensors) {
|
||||||
|
if (s->value() < s->max() * 0.7) {
|
||||||
|
cout << "Found matching sensor " << s->toString() << endl;
|
||||||
|
mapping.push_back(make_shared<HwmonFan>(c, s));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
cout << "Setting fan back to 100%" << endl;
|
||||||
|
c->pwm(100);
|
||||||
|
}
|
||||||
|
|
||||||
|
return mapping;
|
||||||
|
}
|
||||||
|
|
||||||
|
template <class Printable>
|
||||||
|
void FanGenerator::print(string listLabel, vector<shared_ptr<Printable>> list) {
|
||||||
|
cout << listLabel << ": " << endl;
|
||||||
|
|
||||||
|
for (auto i : list) {
|
||||||
|
cout << i->toString() << endl;
|
||||||
|
}
|
||||||
|
cout << "\n";
|
||||||
|
}
|
||||||
124
app/src/Serializer.cxx
Normal file
124
app/src/Serializer.cxx
Normal file
@@ -0,0 +1,124 @@
|
|||||||
|
#include "fan/FanCurve.h"
|
||||||
|
#include "sensor/Sensor.h"
|
||||||
|
#include <filesystem>
|
||||||
|
#include <fstream>
|
||||||
|
#include <iostream>
|
||||||
|
|
||||||
|
#include <memory>
|
||||||
|
|
||||||
|
#include <Serializer.h>
|
||||||
|
#include <fan/HwmonFan.h>
|
||||||
|
#include <pwm/PWMControl.h>
|
||||||
|
#include <sensor/LMSensor.h>
|
||||||
|
|
||||||
|
using namespace std;
|
||||||
|
namespace fs = filesystem;
|
||||||
|
|
||||||
|
Serializer::Serializer() {
|
||||||
|
if (!fs::exists(SERIALIZATION_DIR)) {
|
||||||
|
fs::create_directory(SERIALIZATION_DIR);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void Serializer::SerializeFans(vector<shared_ptr<Fan>> fans) {
|
||||||
|
json obj;
|
||||||
|
|
||||||
|
for (auto f : fans) {
|
||||||
|
obj["fans"].push_back(f->toJson());
|
||||||
|
}
|
||||||
|
|
||||||
|
WriteJson(obj);
|
||||||
|
}
|
||||||
|
|
||||||
|
vector<shared_ptr<Fan>>
|
||||||
|
Serializer::DeserializeFans(vector<shared_ptr<Sensor>> availableSensors) {
|
||||||
|
vector<shared_ptr<Fan>> fans;
|
||||||
|
|
||||||
|
// Create a for the sensors first, then searching becomes cheaper
|
||||||
|
map<string, shared_ptr<Sensor>> sensorMap;
|
||||||
|
for (auto s : availableSensors) {
|
||||||
|
sensorMap[s->toString()] = s;
|
||||||
|
}
|
||||||
|
|
||||||
|
auto data = ReadJson();
|
||||||
|
try {
|
||||||
|
for (auto &el : data["fans"].items()) {
|
||||||
|
auto pwmControl = make_shared<PWMControl>(el.value()["PWMControl"]);
|
||||||
|
auto rpmSensor = sensorMap[el.value()["LMSensor"]];
|
||||||
|
|
||||||
|
int minPWM = el.value()["MinPWM"];
|
||||||
|
string label = el.value()["Label"];
|
||||||
|
|
||||||
|
auto fan = make_shared<HwmonFan>(pwmControl, rpmSensor);
|
||||||
|
fan->MinPWM(minPWM);
|
||||||
|
fan->Label(label);
|
||||||
|
|
||||||
|
fans.push_back(fan);
|
||||||
|
}
|
||||||
|
} catch (const std::exception &e) {
|
||||||
|
std::cout << "Deserialization error! Message: " << e.what() << std::endl;
|
||||||
|
}
|
||||||
|
return fans;
|
||||||
|
}
|
||||||
|
|
||||||
|
void Serializer::WriteJson(json o) {
|
||||||
|
json obj;
|
||||||
|
|
||||||
|
if (fs::exists(fs::path(SERIALIZATION_DIR) / FANS_JSON_FILENAME)) {
|
||||||
|
obj = ReadJson();
|
||||||
|
}
|
||||||
|
|
||||||
|
for (auto &[key, value] : o.items()) {
|
||||||
|
obj[key] = value;
|
||||||
|
}
|
||||||
|
|
||||||
|
ofstream ostrm(fs::path(SERIALIZATION_DIR) / FANS_JSON_FILENAME, ios::trunc);
|
||||||
|
ostrm << obj.dump(2) << "\n";
|
||||||
|
}
|
||||||
|
|
||||||
|
json Serializer::ReadJson() {
|
||||||
|
ifstream istrm(fs::path(SERIALIZATION_DIR) / FANS_JSON_FILENAME);
|
||||||
|
return json::parse(istrm);
|
||||||
|
}
|
||||||
|
|
||||||
|
vector<shared_ptr<FanCurve>> Serializer::DeserializeFanCurves(
|
||||||
|
std::vector<std::shared_ptr<Sensor>> availableSensors,
|
||||||
|
std::vector<std::shared_ptr<Fan>> availableFans) {
|
||||||
|
auto data = ReadJson();
|
||||||
|
|
||||||
|
map<string, shared_ptr<Sensor>> sensorMap;
|
||||||
|
for (auto s : availableSensors) {
|
||||||
|
sensorMap[s->toString()] = s;
|
||||||
|
}
|
||||||
|
|
||||||
|
map<string, shared_ptr<Fan>> fanMap;
|
||||||
|
for (auto f : availableFans) {
|
||||||
|
fanMap[f->toString()] = f;
|
||||||
|
}
|
||||||
|
|
||||||
|
vector<shared_ptr<FanCurve>> curves;
|
||||||
|
|
||||||
|
for (auto &el : data["fancurves"].items()) {
|
||||||
|
vector<FanStep> steps;
|
||||||
|
vector<shared_ptr<Sensor>> sensors;
|
||||||
|
vector<shared_ptr<Fan>> fans;
|
||||||
|
|
||||||
|
for (auto &step : el.value()["FanSteps"].items()) {
|
||||||
|
steps.push_back(FanStep{step.value()[0], step.value()[1]});
|
||||||
|
}
|
||||||
|
|
||||||
|
for (auto &sensor : el.value()["Sensors"].items()) {
|
||||||
|
if (sensorMap.contains(sensor.value()))
|
||||||
|
sensors.push_back(sensorMap[sensor.value()]);
|
||||||
|
}
|
||||||
|
|
||||||
|
for (auto &fan : el.value()["Fans"].items()) {
|
||||||
|
if (fanMap.contains(fan.value()))
|
||||||
|
fans.push_back(fanMap[fan.value()]);
|
||||||
|
}
|
||||||
|
|
||||||
|
curves.push_back(make_shared<FanCurve>(steps, sensors, fans));
|
||||||
|
}
|
||||||
|
|
||||||
|
return curves;
|
||||||
|
}
|
||||||
79
app/src/fan/FanCurve.cxx
Normal file
79
app/src/fan/FanCurve.cxx
Normal file
@@ -0,0 +1,79 @@
|
|||||||
|
#include <iostream>
|
||||||
|
|
||||||
|
#include <fan/FanCurve.h>
|
||||||
|
|
||||||
|
using namespace std;
|
||||||
|
|
||||||
|
FanCurve::FanCurve(std::vector<FanStep> steps,
|
||||||
|
std::vector<std::shared_ptr<Sensor>> sensors,
|
||||||
|
std::vector<std::shared_ptr<Fan>> fans)
|
||||||
|
: mSteps(steps), mTempSensors(sensors), mFans(fans) {
|
||||||
|
cout << "Initialized Fan Curve:" << endl;
|
||||||
|
PrintInfo();
|
||||||
|
}
|
||||||
|
|
||||||
|
void FanCurve::DoFanControl() {
|
||||||
|
int temp = AggregateTemperature();
|
||||||
|
|
||||||
|
int t0, t1, p0, p1;
|
||||||
|
int targetFanSpeed;
|
||||||
|
|
||||||
|
if (temp <= mSteps[0].Temp) {
|
||||||
|
targetFanSpeed = mSteps[0].Percent;
|
||||||
|
} else if (temp > mSteps[mSteps.size() - 1].Temp) {
|
||||||
|
targetFanSpeed = mSteps[mSteps.size() - 1].Percent;
|
||||||
|
} else {
|
||||||
|
for (int i = 0; i < mSteps.size(); i++) {
|
||||||
|
if (temp > mSteps[i].Temp) {
|
||||||
|
t0 = mSteps[i].Temp;
|
||||||
|
p0 = mSteps[i].Percent;
|
||||||
|
|
||||||
|
t1 = mSteps[i + 1].Temp;
|
||||||
|
p1 = mSteps[i + 1].Percent;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
targetFanSpeed = p0 + ((p1 - p0) / (t1 - t0)) * (temp - t0);
|
||||||
|
}
|
||||||
|
|
||||||
|
for (auto f : mFans) {
|
||||||
|
f->PWM(targetFanSpeed);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Dummy Implementation using AVG
|
||||||
|
int FanCurve::AggregateTemperature() {
|
||||||
|
int sum = 0;
|
||||||
|
for (auto s : mTempSensors) {
|
||||||
|
sum += s->value();
|
||||||
|
}
|
||||||
|
|
||||||
|
return sum / mTempSensors.size();
|
||||||
|
}
|
||||||
|
|
||||||
|
void FanCurve::PrintInfo() {
|
||||||
|
stringstream sStream;
|
||||||
|
cout << "Steps: ";
|
||||||
|
for (auto s : mSteps) {
|
||||||
|
sStream << "[ " << s.Temp << "C, " << s.Percent << "% ] ";
|
||||||
|
}
|
||||||
|
cout << sStream.str() << endl;
|
||||||
|
|
||||||
|
sStream.str(string());
|
||||||
|
|
||||||
|
cout << "Sensors: ";
|
||||||
|
for (auto s : mTempSensors) {
|
||||||
|
sStream << s->toString() << ", ";
|
||||||
|
}
|
||||||
|
|
||||||
|
cout << sStream.str() << endl;
|
||||||
|
|
||||||
|
sStream.str(string());
|
||||||
|
|
||||||
|
cout << "Fans: ";
|
||||||
|
for (auto s : mFans) {
|
||||||
|
sStream << s->toString() << ", ";
|
||||||
|
}
|
||||||
|
|
||||||
|
cout << sStream.str() << endl;
|
||||||
|
}
|
||||||
41
app/src/fan/FanLabeler.cxx
Normal file
41
app/src/fan/FanLabeler.cxx
Normal file
@@ -0,0 +1,41 @@
|
|||||||
|
#include <iostream>
|
||||||
|
#include <string>
|
||||||
|
|
||||||
|
#include <fan/FanLabeler.h>
|
||||||
|
|
||||||
|
using namespace std;
|
||||||
|
|
||||||
|
void FanLabeler::RunFanLabelInteraction(
|
||||||
|
std::vector<std::shared_ptr<Fan>> fans) {
|
||||||
|
cout << "Setting all fans to their minimum value" << endl;
|
||||||
|
|
||||||
|
for (auto f : fans) {
|
||||||
|
f->PWM(0);
|
||||||
|
}
|
||||||
|
|
||||||
|
cout << endl;
|
||||||
|
|
||||||
|
for (auto f : fans) {
|
||||||
|
cout << "Setting fan to max power" << endl;
|
||||||
|
|
||||||
|
f->PWM(100);
|
||||||
|
|
||||||
|
cout << "Look inside your PC and check which fan is\n"
|
||||||
|
"spinning fastest and enter a name for it.\n"
|
||||||
|
"Just press enter to skip."
|
||||||
|
<< endl;
|
||||||
|
|
||||||
|
std::string name;
|
||||||
|
getline(cin, name);
|
||||||
|
|
||||||
|
if (!name.empty()) {
|
||||||
|
cout << "Setting " << name << " as label for this fan." << endl;
|
||||||
|
f->Label(name);
|
||||||
|
}
|
||||||
|
|
||||||
|
cout << "Resetting fan to lowest value\n\n" << endl;
|
||||||
|
f->PWM(0);
|
||||||
|
}
|
||||||
|
|
||||||
|
cout << "Done!\n" << endl;
|
||||||
|
}
|
||||||
78
app/src/fan/HwmonFan.cxx
Normal file
78
app/src/fan/HwmonFan.cxx
Normal file
@@ -0,0 +1,78 @@
|
|||||||
|
#include <chrono>
|
||||||
|
#include <iostream>
|
||||||
|
#include <ostream>
|
||||||
|
#include <thread>
|
||||||
|
|
||||||
|
#include "pwm/PWMControl.h"
|
||||||
|
#include <boost/json/object.hpp>
|
||||||
|
#include <fan/HwmonFan.h>
|
||||||
|
|
||||||
|
#define TIMEOUT 5
|
||||||
|
|
||||||
|
using namespace std;
|
||||||
|
|
||||||
|
HwmonFan::HwmonFan(std::shared_ptr<PWMControl> pwmControl,
|
||||||
|
std::shared_ptr<Sensor> rpmSensor)
|
||||||
|
: mPWMControl(pwmControl), mRpmSensor(rpmSensor) {
|
||||||
|
mPWMControl->EnableManualControl();
|
||||||
|
}
|
||||||
|
|
||||||
|
void HwmonFan::PWM(int percent) {
|
||||||
|
if (percent < mMinPWM) {
|
||||||
|
mPWMControl->pwm(mMinPWM);
|
||||||
|
} else {
|
||||||
|
mPWMControl->pwm(percent);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
int HwmonFan::RPM() { return mRpmSensor->value(); }
|
||||||
|
|
||||||
|
void HwmonFan::Label(std::string label) { mLabel = label; }
|
||||||
|
|
||||||
|
void HwmonFan::MinPWM(int value) { mMinPWM = value; }
|
||||||
|
|
||||||
|
void HwmonFan::StartPWM(int value) { mStartPWM = value; }
|
||||||
|
|
||||||
|
void HwmonFan::FindMinPWM() {
|
||||||
|
cout << "Looking for minimal PWM" << endl;
|
||||||
|
int minPWM = 0;
|
||||||
|
mMinPWM = 0;
|
||||||
|
|
||||||
|
for (int curPWM = 100; curPWM > 0; curPWM -= 5) {
|
||||||
|
PWM(curPWM);
|
||||||
|
this_thread::sleep_for(chrono::seconds(TIMEOUT));
|
||||||
|
|
||||||
|
int curRPM = RPM();
|
||||||
|
|
||||||
|
if (curRPM <= 0) {
|
||||||
|
minPWM = curPWM + 5;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (minPWM == 0) {
|
||||||
|
cout << "Fan never stopped. ";
|
||||||
|
}
|
||||||
|
cout << "Setting minimal PWM: " << minPWM << endl;
|
||||||
|
|
||||||
|
mMinPWM = minPWM;
|
||||||
|
}
|
||||||
|
|
||||||
|
void HwmonFan::FindStartPWM() {}
|
||||||
|
|
||||||
|
json HwmonFan::toJson() const {
|
||||||
|
json obj;
|
||||||
|
obj = {mPWMControl->toJson(),
|
||||||
|
mRpmSensor->toJson(),
|
||||||
|
{"Label", mLabel},
|
||||||
|
{"MinPWM", mMinPWM}};
|
||||||
|
return obj;
|
||||||
|
}
|
||||||
|
|
||||||
|
const string HwmonFan::toString() const {
|
||||||
|
if (!mLabel.empty()) {
|
||||||
|
return mLabel;
|
||||||
|
} else {
|
||||||
|
return "fan:" + mPWMControl->toString();
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,54 +1,49 @@
|
|||||||
#include <nvidia.h>
|
#include <boost/program_options/options_description.hpp>
|
||||||
#include <pwm.h>
|
#include <boost/program_options/parsers.hpp>
|
||||||
#include <sensors/sensors.h>
|
#include <boost/program_options/value_semantic.hpp>
|
||||||
|
#include <boost/program_options/variables_map.hpp>
|
||||||
|
#include <csignal>
|
||||||
#include <iostream>
|
#include <iostream>
|
||||||
|
|
||||||
int main() {
|
#include <boost/program_options.hpp>
|
||||||
auto config = std::fopen("/etc/conf.d/sensors", "r");
|
|
||||||
if (sensors_init(config) != 0) {
|
|
||||||
std::cout << "Fuck" << std::endl;
|
|
||||||
return 1;
|
|
||||||
}
|
|
||||||
|
|
||||||
int c = 0;
|
#include <App.h>
|
||||||
for (const sensors_chip_name *i;
|
|
||||||
(i = sensors_get_detected_chips(0, &c)) != NULL;) {
|
|
||||||
std::cout << i->prefix << std::endl;
|
|
||||||
|
|
||||||
int d = 0;
|
namespace po = boost::program_options;
|
||||||
for (const sensors_feature *j; (j = sensors_get_features(i, &d)) != NULL;) {
|
|
||||||
const sensors_subfeature *temp_feature =
|
|
||||||
sensors_get_subfeature(i, j, SENSORS_SUBFEATURE_TEMP_INPUT);
|
|
||||||
if (temp_feature) {
|
|
||||||
std::cout << sensors_get_label(i, j);
|
|
||||||
|
|
||||||
double value;
|
App app;
|
||||||
if (sensors_get_value(i, temp_feature->number, &value) == 0)
|
|
||||||
std::cout << ": " << value << " C" << std::endl;
|
|
||||||
}
|
|
||||||
|
|
||||||
const sensors_subfeature *fan_feature =
|
static int doInitialSetup = 0;
|
||||||
sensors_get_subfeature(i, j, SENSORS_SUBFEATURE_FAN_INPUT);
|
|
||||||
|
|
||||||
if (fan_feature) {
|
void signal_handler(int s) { app.Shutdown(); }
|
||||||
std::cout << sensors_get_label(i, j);
|
|
||||||
|
|
||||||
double value;
|
int main(int argc, char **argv) {
|
||||||
if (sensors_get_value(i, fan_feature->number, &value) == 0)
|
signal(SIGINT, signal_handler);
|
||||||
std::cout << ": " << value << " RPM" << std::endl;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
std::cout << std::endl;
|
po::options_description desc("Allowed options");
|
||||||
}
|
desc.add_options()("help", "produce help message")("setup", po::bool_switch(),
|
||||||
|
"run initial setup");
|
||||||
|
|
||||||
Nvidia nv;
|
po::variables_map vm;
|
||||||
auto temp = nv.get_gpu_temperature();
|
po::store(po::parse_command_line(argc, argv, desc), vm);
|
||||||
std::cout << "\nGPU Temp: " << temp << std::endl;
|
po::notify(vm);
|
||||||
|
|
||||||
PWM pwm;
|
|
||||||
pwm.dumpValues();
|
|
||||||
|
|
||||||
|
try {
|
||||||
|
if (vm.count("help")) {
|
||||||
|
std::cout << desc << "\n";
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (vm.count("setup") && vm["setup"].as<bool>()) {
|
||||||
|
app.InitialSetup();
|
||||||
|
} else {
|
||||||
|
app.Init();
|
||||||
|
app.NormalOperation();
|
||||||
|
}
|
||||||
|
} catch (const std::exception &e) {
|
||||||
|
std::cout << "An exception was caught: " << e.what() << std::endl;
|
||||||
|
}
|
||||||
|
|
||||||
|
app.Shutdown();
|
||||||
return 0;
|
return 0;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,16 +0,0 @@
|
|||||||
#include <include/nvml.h>
|
|
||||||
#include <nvidia.h>
|
|
||||||
|
|
||||||
Nvidia::Nvidia() { nvmlInit_v2(); }
|
|
||||||
Nvidia::~Nvidia() { nvmlShutdown(); }
|
|
||||||
|
|
||||||
double Nvidia::get_gpu_temperature() {
|
|
||||||
nvmlDevice_t device;
|
|
||||||
|
|
||||||
nvmlDeviceGetHandleByIndex_v2(0, &device);
|
|
||||||
|
|
||||||
unsigned int temp;
|
|
||||||
nvmlDeviceGetTemperature(device, NVML_TEMPERATURE_GPU, &temp);
|
|
||||||
|
|
||||||
return static_cast<double>(temp);
|
|
||||||
}
|
|
||||||
@@ -1,56 +0,0 @@
|
|||||||
#include <pwm.h>
|
|
||||||
|
|
||||||
#include <filesystem>
|
|
||||||
#include <iostream>
|
|
||||||
#include <regex>
|
|
||||||
|
|
||||||
namespace fs = std::filesystem;
|
|
||||||
using namespace std;
|
|
||||||
|
|
||||||
#define HWMON_BASE_PATH "/sys/class/hwmon"
|
|
||||||
|
|
||||||
#define PWM_POSTFIX_ENABLE "_enable"
|
|
||||||
#define PWM_POSTFIX_MODE "_mode"
|
|
||||||
|
|
||||||
PWM::PWM() {
|
|
||||||
const regex re_ctrl_enable("pwm[0-9]_enable");
|
|
||||||
const regex re_ctrl_mode("pwm[0-9]_mode");
|
|
||||||
const regex re_ctrl("pwm[0-9]");
|
|
||||||
|
|
||||||
if (!fs::exists(HWMON_BASE_PATH)) {
|
|
||||||
cerr << HWMON_BASE_PATH << " doesn't exist" << endl;
|
|
||||||
} else {
|
|
||||||
for (const fs::directory_entry &hwmon_device :
|
|
||||||
fs::directory_iterator{HWMON_BASE_PATH}) {
|
|
||||||
cout << hwmon_device << endl;
|
|
||||||
|
|
||||||
for (const fs::directory_entry &control :
|
|
||||||
fs::directory_iterator{hwmon_device}) {
|
|
||||||
auto filename = control.path().filename().string();
|
|
||||||
|
|
||||||
if (regex_match(filename, re_ctrl)) {
|
|
||||||
auto controlPath = control.path().string();
|
|
||||||
|
|
||||||
fs::path path_ctrl_enable(
|
|
||||||
string(controlPath + string(PWM_POSTFIX_ENABLE)));
|
|
||||||
fs::path path_ctrl_mode(
|
|
||||||
string(controlPath + string(PWM_POSTFIX_MODE)));
|
|
||||||
|
|
||||||
if (fs::exists(path_ctrl_enable) && fs::exists(path_ctrl_mode))
|
|
||||||
cout << control << endl;
|
|
||||||
|
|
||||||
mPwmControls.insert(
|
|
||||||
{controlPath, PWM_CONTROL{controlPath, path_ctrl_enable.string(),
|
|
||||||
path_ctrl_mode.string()}});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
void PWM::dumpValues() {
|
|
||||||
for (auto control : mPwmControls) {
|
|
||||||
cout << control.second.control << ", " << control.second.enable << ", "
|
|
||||||
<< control.second.mode << endl;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
82
app/src/pwm/PWMControl.cxx
Normal file
82
app/src/pwm/PWMControl.cxx
Normal file
@@ -0,0 +1,82 @@
|
|||||||
|
#include <boost/json/object.hpp>
|
||||||
|
#include <filesystem>
|
||||||
|
#include <fstream>
|
||||||
|
#include <iostream>
|
||||||
|
|
||||||
|
#include <pwm/PWMControl.h>
|
||||||
|
|
||||||
|
#define PWM_POSTFIX_ENABLE "_enable"
|
||||||
|
#define PWM_POSTFIX_MODE "_mode"
|
||||||
|
|
||||||
|
#define PWM_MAX_VALUE 255
|
||||||
|
|
||||||
|
using namespace std;
|
||||||
|
namespace fs = filesystem;
|
||||||
|
|
||||||
|
PWMControl::PWMControl(string controlPath) : mControlPath(controlPath) {
|
||||||
|
fs::path pathEnable(mControlPath + PWM_POSTFIX_ENABLE);
|
||||||
|
fs::path pathMode(mControlPath + PWM_POSTFIX_MODE);
|
||||||
|
|
||||||
|
mEnablePath = pathEnable;
|
||||||
|
mModePath = pathMode;
|
||||||
|
|
||||||
|
ifstream istrm;
|
||||||
|
|
||||||
|
istrm.open(mEnablePath);
|
||||||
|
istrm >> mInitialEnable;
|
||||||
|
istrm.close();
|
||||||
|
|
||||||
|
istrm.open(mInitialMode);
|
||||||
|
istrm >> mInitialMode;
|
||||||
|
istrm.close();
|
||||||
|
}
|
||||||
|
|
||||||
|
PWMControl::~PWMControl() {
|
||||||
|
cout << "Cleanup" << endl;
|
||||||
|
Reset();
|
||||||
|
}
|
||||||
|
|
||||||
|
void PWMControl::pwm(int percent) {
|
||||||
|
int pwmValue = PWM_MAX_VALUE * percent / 100;
|
||||||
|
|
||||||
|
ofstream ostrm(mControlPath, ios::trunc);
|
||||||
|
ostrm << pwmValue;
|
||||||
|
ostrm.close();
|
||||||
|
}
|
||||||
|
|
||||||
|
int PWMControl::pwm() {
|
||||||
|
int value;
|
||||||
|
ifstream istrm;
|
||||||
|
|
||||||
|
istrm.open(mControlPath);
|
||||||
|
istrm >> value;
|
||||||
|
|
||||||
|
return value;
|
||||||
|
}
|
||||||
|
|
||||||
|
void PWMControl::EnableManualControl() {
|
||||||
|
ofstream ostrm(mEnablePath, ios::trunc);
|
||||||
|
ostrm << static_cast<int>(PWM_ENABLE::MANUAL_CONTROL);
|
||||||
|
ostrm.close();
|
||||||
|
}
|
||||||
|
|
||||||
|
void PWMControl::Reset() {
|
||||||
|
ofstream ostrm(mEnablePath, ios::trunc);
|
||||||
|
|
||||||
|
ostrm << mInitialEnable;
|
||||||
|
ostrm.close();
|
||||||
|
|
||||||
|
ostrm.open(mModePath, ios::trunc);
|
||||||
|
ostrm << mInitialMode;
|
||||||
|
|
||||||
|
ostrm.close();
|
||||||
|
}
|
||||||
|
|
||||||
|
const string PWMControl::toString() const {
|
||||||
|
return fs::path(mControlPath).filename();
|
||||||
|
}
|
||||||
|
|
||||||
|
json PWMControl::toJson() const {
|
||||||
|
json obj = {"PWMControl", mControlPath};
|
||||||
|
return obj;
|
||||||
|
}
|
||||||
37
app/src/pwm/PWMControlFacade.cxx
Normal file
37
app/src/pwm/PWMControlFacade.cxx
Normal file
@@ -0,0 +1,37 @@
|
|||||||
|
#include <filesystem>
|
||||||
|
#include <iostream>
|
||||||
|
#include <regex>
|
||||||
|
|
||||||
|
#include <pwm/PWMControlFacade.h>
|
||||||
|
|
||||||
|
using namespace std;
|
||||||
|
namespace fs = std::filesystem;
|
||||||
|
|
||||||
|
vector<shared_ptr<PWMControl>> PWMControlFacade::PWMControls() {
|
||||||
|
vector<shared_ptr<PWMControl>> controls;
|
||||||
|
|
||||||
|
const regex re_ctrl_enable("pwm[0-9]_enable");
|
||||||
|
const regex re_ctrl_mode("pwm[0-9]_mode");
|
||||||
|
const regex re_ctrl("pwm[0-9]");
|
||||||
|
|
||||||
|
if (!fs::exists(HWMON_BASE_PATH)) {
|
||||||
|
cout << HWMON_BASE_PATH << " doesn't exist" << endl;
|
||||||
|
} else {
|
||||||
|
for (const fs::directory_entry &hwmon_device :
|
||||||
|
fs::directory_iterator{HWMON_BASE_PATH}) {
|
||||||
|
|
||||||
|
for (const fs::directory_entry &control :
|
||||||
|
fs::directory_iterator{hwmon_device}) {
|
||||||
|
auto filename = control.path().filename().string();
|
||||||
|
|
||||||
|
if (regex_match(filename, re_ctrl)) {
|
||||||
|
auto controlPath = control.path().string();
|
||||||
|
|
||||||
|
controls.push_back(make_shared<PWMControl>(controlPath));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return controls;
|
||||||
|
}
|
||||||
9
app/src/sensor/GPUSensorsFacade.cxx
Normal file
9
app/src/sensor/GPUSensorsFacade.cxx
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
#include <sensor/GPUSensorsFacade.h>
|
||||||
|
|
||||||
|
#include <sensor/NvidiaSensor.h>
|
||||||
|
|
||||||
|
using namespace std;
|
||||||
|
|
||||||
|
vector<shared_ptr<Sensor>> GPUSensorsFacade::TemperatureSensors() {
|
||||||
|
return vector<shared_ptr<Sensor>>{make_shared<NvidiaSensor>()};
|
||||||
|
}
|
||||||
26
app/src/sensor/LMSensor.cxx
Normal file
26
app/src/sensor/LMSensor.cxx
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
#include <boost/json/kind.hpp>
|
||||||
|
#include <sensor/LMSensor.h>
|
||||||
|
#include <sensors/sensors.h>
|
||||||
|
|
||||||
|
using namespace std;
|
||||||
|
|
||||||
|
LMSensor::LMSensor(const sensors_chip_name *chipName,
|
||||||
|
const sensors_feature *feature,
|
||||||
|
const sensors_subfeature *subfeature)
|
||||||
|
: mChipName(chipName), mFeature(feature), mSubFeature(subfeature) {}
|
||||||
|
|
||||||
|
int LMSensor::value() {
|
||||||
|
double value;
|
||||||
|
sensors_get_value(mChipName, mSubFeature->number, &value);
|
||||||
|
|
||||||
|
return static_cast<int>(value);
|
||||||
|
}
|
||||||
|
|
||||||
|
const string LMSensor::toString() const {
|
||||||
|
return sensors_get_label(mChipName, mFeature);
|
||||||
|
}
|
||||||
|
|
||||||
|
json LMSensor::toJson() const {
|
||||||
|
json obj = {"LMSensor", toString()};
|
||||||
|
return obj;
|
||||||
|
}
|
||||||
50
app/src/sensor/LMSensorsFacade.cxx
Normal file
50
app/src/sensor/LMSensorsFacade.cxx
Normal file
@@ -0,0 +1,50 @@
|
|||||||
|
#include <stdexcept>
|
||||||
|
|
||||||
|
#include <sensors/sensors.h>
|
||||||
|
|
||||||
|
#include <sensor/LMSensorsFacade.h>
|
||||||
|
|
||||||
|
#include <sensor/LMSensor.h>
|
||||||
|
#include <sensor/NvidiaSensor.h>
|
||||||
|
|
||||||
|
using namespace std;
|
||||||
|
|
||||||
|
#define CONFIG_FILE "/etc/conf.d/sensors"
|
||||||
|
|
||||||
|
LMSensorsFacade::LMSensorsFacade() : mConfigFile(fopen(CONFIG_FILE, "r")) {
|
||||||
|
if (sensors_init(mConfigFile) != 0) {
|
||||||
|
throw runtime_error("Config file doesn't exist");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
LMSensorsFacade::~LMSensorsFacade() { sensors_cleanup(); }
|
||||||
|
|
||||||
|
std::vector<std::shared_ptr<Sensor>> LMSensorsFacade::TemperatureSensors() {
|
||||||
|
return Sensors<SENSORS_SUBFEATURE_TEMP_INPUT>();
|
||||||
|
}
|
||||||
|
|
||||||
|
std::vector<std::shared_ptr<Sensor>> LMSensorsFacade::RPMSensors() {
|
||||||
|
return Sensors<SENSORS_SUBFEATURE_FAN_INPUT>();
|
||||||
|
}
|
||||||
|
|
||||||
|
template <sensors_subfeature_type T>
|
||||||
|
std::vector<std::shared_ptr<Sensor>> LMSensorsFacade::Sensors() {
|
||||||
|
std::vector<std::shared_ptr<Sensor>> sensors;
|
||||||
|
|
||||||
|
int c = 0;
|
||||||
|
for (const sensors_chip_name *chipName;
|
||||||
|
(chipName = sensors_get_detected_chips(0, &c)) != NULL;) {
|
||||||
|
|
||||||
|
int d = 0;
|
||||||
|
for (const sensors_feature *feature;
|
||||||
|
(feature = sensors_get_features(chipName, &d)) != NULL;) {
|
||||||
|
auto subFeature = sensors_get_subfeature(chipName, feature, T);
|
||||||
|
if (subFeature) {
|
||||||
|
sensors.push_back(
|
||||||
|
std::make_shared<LMSensor>(chipName, feature, subFeature));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return sensors;
|
||||||
|
}
|
||||||
27
app/src/sensor/NvidiaSensor.cxx
Normal file
27
app/src/sensor/NvidiaSensor.cxx
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
#include <boost/json/object.hpp>
|
||||||
|
#include <include/nvml.h>
|
||||||
|
|
||||||
|
#include <sensor/NvidiaSensor.h>
|
||||||
|
|
||||||
|
using namespace std;
|
||||||
|
|
||||||
|
NvidiaSensor::NvidiaSensor() { nvmlInit_v2(); }
|
||||||
|
NvidiaSensor::~NvidiaSensor() { nvmlShutdown(); }
|
||||||
|
|
||||||
|
int NvidiaSensor::value() {
|
||||||
|
nvmlDevice_t device;
|
||||||
|
|
||||||
|
nvmlDeviceGetHandleByIndex_v2(0, &device);
|
||||||
|
|
||||||
|
unsigned int temp;
|
||||||
|
nvmlDeviceGetTemperature(device, NVML_TEMPERATURE_GPU, &temp);
|
||||||
|
|
||||||
|
return static_cast<int>(temp);
|
||||||
|
}
|
||||||
|
|
||||||
|
const std::string NvidiaSensor::toString() const { return "NvidiaGPU"; }
|
||||||
|
|
||||||
|
json NvidiaSensor::toJson() const {
|
||||||
|
json obj = {"NvidiaSensor", toString()};
|
||||||
|
return obj;
|
||||||
|
}
|
||||||
5
app/src/sensor/Sensor.cxx
Normal file
5
app/src/sensor/Sensor.cxx
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
#include <sensor/Sensor.h>
|
||||||
|
|
||||||
|
int Sensor::max() const { return mMax; }
|
||||||
|
|
||||||
|
void Sensor::max(int value) { mMax = value; }
|
||||||
22
app/src/sensor/SensorManager.cxx
Normal file
22
app/src/sensor/SensorManager.cxx
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
#include <sensor/SensorManager.h>
|
||||||
|
|
||||||
|
using namespace std;
|
||||||
|
|
||||||
|
SensorManager::SensorManager()
|
||||||
|
: mLMSensorsFacade(make_unique<LMSensorsFacade>()),
|
||||||
|
mGPUSensorsFacade(make_unique<GPUSensorsFacade>()) {}
|
||||||
|
|
||||||
|
vector<shared_ptr<Sensor>> SensorManager::TemperatureSensors() {
|
||||||
|
vector<shared_ptr<Sensor>> tempSensors;
|
||||||
|
|
||||||
|
tempSensors = mLMSensorsFacade->TemperatureSensors();
|
||||||
|
|
||||||
|
auto gpuSensors = mGPUSensorsFacade->TemperatureSensors();
|
||||||
|
tempSensors.insert(tempSensors.end(), gpuSensors.begin(), gpuSensors.end());
|
||||||
|
|
||||||
|
return tempSensors;
|
||||||
|
}
|
||||||
|
|
||||||
|
vector<shared_ptr<Sensor>> SensorManager::RPMSensors() {
|
||||||
|
return mLMSensorsFacade->RPMSensors();
|
||||||
|
}
|
||||||
10
app/unit/fantasize.service
Normal file
10
app/unit/fantasize.service
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=Fantasize fan control service
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
Type=simple
|
||||||
|
ExecStart=/usr/local/bin/fantasize
|
||||||
|
Restart=always
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=multi-user.target
|
||||||
1
doc/Application Overview.drawio
Normal file
1
doc/Application Overview.drawio
Normal file
@@ -0,0 +1 @@
|
|||||||
|
<mxfile host="app.diagrams.net" modified="2022-09-24T19:31:05.408Z" agent="5.0 (X11)" etag="F8WQQZ1xw24pL79IvZh_" version="20.2.2" type="device"><diagram id="bxDzWbPEviacuxaYKsiD" name="Page-1">5VjbctowEP0aZtqHZHwJhjyCQ9JOQ4fJjfRRsRdbrWwRWdzy9V3ZMsYYUichgbYvIB1pJXH2nLVFw3aj+YUg47DPfWANy/DnDfusYVnmqd3CL4UsNGKa7QwJBPU1VgDX9Ak0aGh0Qn1IShMl50zScRn0eByDJ0sYEYLPytNGnJV3HZMAKsC1R1gVHVJfhhnabhoF/gVoEOY7m4YeiUg+WQNJSHw+W4HsXsN2Becya0VzF5hiL+clizvfMro8mIBY1gl4bDnd/sgd3j3IaWfY+za8fXo8Mu1smSlhE/2LB8N+Qy3V1MeWi5wL8JEa3eVChjzgMWG9Au0KPol9UBsa2CvmXHI+RtBE8CdIudB5JhPJEQplxPQozKm8V+HHuH/W/aFXU+2z+WpnkXdiKRb3+Qqqk8Yct5p5v4hLe0Wg31Eawa7HSJJQLwPPKcsPlJGgfvlW2jWU8Inw4BmuHS1fIgKQz+VkKQ60FfAI8MgYJ4ARSaflcxAt72A5r1AANrQIXiAIp6KHhuUwPG7Xp1NsBqp5TmKc404EnkaP4mYrEyrSKYShSJ2FVML1mKR0zbBylEWgjwBCwvx51qss6QDb0fLVdcfODTsrTGzmzgxXDOwY70RsXtBWmO3cXeBS/c69+vz6fb9+W7WbWc9uOmhpuPpui3kMJasZu7Vaq6bV2vu0mln12g1EYxBETgTsVQ2rpXepjD+qofVaOXxA8a2rCGefimjVKb4ljWwuvpWYa4gTLvKBB7E+9cCqt2OUq7fZ2nv1tv4pr669KB3We1L7b7Bqu45VXR6NeYJu+V+MegCvWRvy8haSCKNBjG2Rnb3LyAOwgUoq5Qr3kCkQOKB4pHhvvFybEFHfTx2fT+joFaUyejfBnWkc3KSut4wCudJkWcZuUmVaazXVrKbKOtmQquUFdue5qtbUq4G6e+Ym2Jo340PEbZ6sMWbXFHfzvQjbdll3OZZrzhgcHmmWsW/STupU6vRGW6vEIjWyzFqC3P8ClzPU7PJqM8JH4xqUl5JKycgrwrJUbEpTOZE7yJTVXn/JalYy5WxIlP1upbtZJ1NHOONmImI+GqlWKCAJ1Z96dZ+wKr5P5qrMjAFeFpfWdvz+5A5uG5arnEcSyFogvePPr35wv11VDEZy75qquH/Ti/vpbtyP3eLP03Rs5T9ou/cb</diagram></mxfile>
|
||||||
BIN
doc/Application Overview.jpg
Normal file
BIN
doc/Application Overview.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 27 KiB |
17
doc/ApplicationStart.plantuml
Normal file
17
doc/ApplicationStart.plantuml
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
@startuml
|
||||||
|
|
||||||
|
start
|
||||||
|
:Initialization;
|
||||||
|
|
||||||
|
if (Config exists) then (yes)
|
||||||
|
:Load config;
|
||||||
|
else (no)
|
||||||
|
:Do first-start initialization;
|
||||||
|
endif
|
||||||
|
|
||||||
|
:Load Fan Curves;
|
||||||
|
:Enter fan control loop;
|
||||||
|
|
||||||
|
stop
|
||||||
|
|
||||||
|
@enduml
|
||||||
119
doc/Class.plantuml
Normal file
119
doc/Class.plantuml
Normal file
@@ -0,0 +1,119 @@
|
|||||||
|
@startuml
|
||||||
|
|
||||||
|
package sensor {
|
||||||
|
interface Sensor {
|
||||||
|
+ {abstract} int Value()
|
||||||
|
}
|
||||||
|
|
||||||
|
class LMSensor {
|
||||||
|
- string Label
|
||||||
|
|
||||||
|
+ int Value()
|
||||||
|
}
|
||||||
|
|
||||||
|
class GPUSensor {
|
||||||
|
+ int Value()
|
||||||
|
}
|
||||||
|
|
||||||
|
class LMSensorsFacade
|
||||||
|
{
|
||||||
|
+ List<Sensor> RPMSensors()
|
||||||
|
+ List<Sensor> TemperatureSensors()
|
||||||
|
}
|
||||||
|
|
||||||
|
class GPUSensorsFacade
|
||||||
|
{
|
||||||
|
+ List<Sensor> TemperatureSensors()
|
||||||
|
}
|
||||||
|
|
||||||
|
class SensorManager
|
||||||
|
{
|
||||||
|
- LMSensorsFacade
|
||||||
|
- GPUSensorsFacade
|
||||||
|
|
||||||
|
+ List<Sensor> RPMSensors()
|
||||||
|
+ List<Sensor> TemperatureSensors()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
package fan
|
||||||
|
{
|
||||||
|
class HWMONFan {
|
||||||
|
- string Label
|
||||||
|
- Sensor RPMSensor
|
||||||
|
- PWMControl PWMControl
|
||||||
|
|
||||||
|
+ int RPM()
|
||||||
|
+ void PWMPercent(int value)
|
||||||
|
}
|
||||||
|
|
||||||
|
class FanGenerator
|
||||||
|
{
|
||||||
|
+ FanList FindFans(List<RPMSensor>, List<PWMControl>)
|
||||||
|
}
|
||||||
|
|
||||||
|
struct FanStep
|
||||||
|
{
|
||||||
|
int Temp
|
||||||
|
int Percent
|
||||||
|
}
|
||||||
|
|
||||||
|
class FanCurve
|
||||||
|
{
|
||||||
|
- List<FanStep> Steps
|
||||||
|
- List<Sensor> TempSensor
|
||||||
|
- List<HWMONFan> Fan
|
||||||
|
|
||||||
|
+ DoFanControl()
|
||||||
|
}
|
||||||
|
|
||||||
|
class FanController
|
||||||
|
{
|
||||||
|
- List<FanCurve>
|
||||||
|
|
||||||
|
+ void StartFanControlLoop()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
package pwm
|
||||||
|
{
|
||||||
|
class PWMControl {
|
||||||
|
+ void PWMPercent(int value)
|
||||||
|
+ int PWM()
|
||||||
|
}
|
||||||
|
|
||||||
|
class PWMControlFacade {
|
||||||
|
+ List<PWMControl> PWMControls()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
class ConfigManager
|
||||||
|
{
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
HWMONFan -- Sensor
|
||||||
|
HWMONFan -- PWMControl
|
||||||
|
HWMONFan -- FanCurve
|
||||||
|
|
||||||
|
PWMControlFacade -- PWMControl
|
||||||
|
|
||||||
|
Sensor <|-- LMSensor
|
||||||
|
Sensor <|-- GPUSensor
|
||||||
|
|
||||||
|
SensorManager - Sensor
|
||||||
|
|
||||||
|
LMSensor -- LMSensorsFacade
|
||||||
|
GPUSensor -- GPUSensorsFacade
|
||||||
|
LMSensorsFacade -- SensorManager
|
||||||
|
GPUSensorsFacade -- SensorManager
|
||||||
|
|
||||||
|
FanGenerator -- HWMONFan
|
||||||
|
FanGenerator -- SensorManager : uses >
|
||||||
|
FanGenerator -- PWMControlFacade : uses >
|
||||||
|
|
||||||
|
Sensor - FanCurve
|
||||||
|
FanCurve -- FanStep
|
||||||
|
|
||||||
|
FanCurve -- FanController
|
||||||
|
@enduml
|
||||||
23
doc/Initialization.plantuml
Normal file
23
doc/Initialization.plantuml
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
@startuml
|
||||||
|
participant main
|
||||||
|
participant LMSensorsFacade as lms
|
||||||
|
participant GPUSensor as gpus
|
||||||
|
participant PWMControlFactory as pwmfc
|
||||||
|
|
||||||
|
main -> lms: RPMSensors()
|
||||||
|
main <-- lms: vector<Sensor>
|
||||||
|
|
||||||
|
main -> lms: TemperatureSensors()
|
||||||
|
main <-- lms: vector<Sensor>
|
||||||
|
|
||||||
|
main -> gpus: GPUSensor()
|
||||||
|
main <-- gpus: Sensor
|
||||||
|
note right
|
||||||
|
Add GPUSensor to list
|
||||||
|
of temperature sensors
|
||||||
|
end note
|
||||||
|
|
||||||
|
main -> pwmfc: PWMControllers()
|
||||||
|
main <-- pwmfc: vector<PWMControl>
|
||||||
|
|
||||||
|
@enduml
|
||||||
7
doc/InteractiveMapping.plantuml
Normal file
7
doc/InteractiveMapping.plantuml
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
@startuml
|
||||||
|
actor User as usr
|
||||||
|
participant Interface as if
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
@enduml
|
||||||
Reference in New Issue
Block a user