reformat with black;

use pwm_min of 1 since newer kernels have different behaviour on pwm=0

.gitignore

@@ -1,4 +1,109 @@
-# ---> Python
+
+# Created by https://www.gitignore.io/api/linux,python,windows,pycharm+all
+# Edit at https://www.gitignore.io/?templates=linux,python,windows,pycharm+all
+
+### Linux ###
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+### PyCharm+all ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+### PyCharm+all Patch ###
+# Ignores the whole .idea folder and all .iml files
+# See https://github.com/joeblau/gitignore.io/issues/186 and https://github.com/joeblau/gitignore.io/issues/360
+
+.idea/
+
+# Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-249601023
+
+*.iml
+modules.xml
+.idea/misc.xml
+*.ipr
+
+# Sonarlint plugin
+.idea/sonarlint
+
+### Python ###
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
@@ -21,6 +126,8 @@ parts/
 sdist/
 var/
 wheels/
+pip-wheel-metadata/
+share/python-wheels/
 *.egg-info/
 .installed.cfg
 *.egg
@@ -57,6 +164,7 @@ coverage.xml
 *.log
 local_settings.py
 db.sqlite3
+db.sqlite3-journal
 
 # Flask stuff:
 instance/
@@ -81,6 +189,13 @@ ipython_config.py
 # pyenv
 .python-version
 
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
 # celery beat schedule file
 celerybeat-schedule
 
@@ -114,18 +229,30 @@ dmypy.json
 # Pyre type checker
 .pyre/
 
-# ---> Linux
+### Windows ###
-*~
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
 
-# temporary files which can be created if a process still has a handle open of a deleted file
+# Dump file
-.fuse_hidden*
+*.stackdump
 
-# KDE directory preferences
+# Folder config file
-.directory
+[Dd]esktop.ini
 
-# Linux trash folder which might appear on any partition or disk
+# Recycle Bin used on file shares
-.Trash-*
+$RECYCLE.BIN/
 
-# .nfs files are created when an open file is removed but is still being accessed
+# Windows Installer files
-.nfs*
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
 
+# Windows shortcuts
+*.lnk
+
+# End of https://www.gitignore.io/api/linux,python,windows,pycharm+all

.idea/.gitignore

@@ -1,2 +0,0 @@
-# Default ignored files
-/workspace.xml

LICENSE

@@ -1,319 +1,674 @@
-GNU GENERAL PUBLIC LICENSE
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
 
-Version 2, June 1991
+ 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.
 
-Copyright (C) 1989, 1991 Free Software Foundation, Inc. 
+                            Preamble
 
-51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 , USA
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
 
-Everyone is permitted to copy and distribute verbatim copies of this license
+  The licenses for most software and other practical works are designed
-document, but changing it is not allowed.
+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.
 
-Preamble
+  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.
 
-The licenses for most software are designed to take away your freedom to share
+  To protect your rights, we need to prevent others from denying you
-and change it. By contrast, the GNU General Public License is intended to
+these rights or asking you to surrender the rights.  Therefore, you have
-guarantee your freedom to share and change free software--to make sure the
+certain responsibilities if you distribute copies of the software, or if
-software is free for all its users. This General Public License applies to
+you modify it: responsibilities to respect the freedom of others.
-most of the Free Software Foundation's software and to any other program whose
-authors commit to using it. (Some other Free Software Foundation software
-is covered by the GNU Lesser General Public License instead.) You can apply
-it to your programs, too.
 
-When we speak of free software, we are referring to freedom, not price. Our
+  For example, if you distribute copies of such a program, whether
-General Public Licenses are designed to make sure that you have the freedom
+gratis or for a fee, you must pass on to the recipients the same
-to distribute copies of free software (and charge for this service if you
+freedoms that you received.  You must make sure that they, too, receive
-wish), that you receive source code or can get it if you want it, that you
+or can get the source code.  And you must show them these terms so they
-can change the software or use pieces of it in new free programs; and that
+know their rights.
-you know you can do these things.
 
-To protect your rights, we need to make restrictions that forbid anyone to
+  Developers that use the GNU GPL protect your rights with two steps:
-deny you these rights or to ask you to surrender the rights. These restrictions
+(1) assert copyright on the software, and (2) offer you this License
-translate to certain responsibilities for you if you distribute copies of
+giving you legal permission to copy, distribute and/or modify it.
-the software, or if you modify it.
 
-For example, if you distribute copies of such a program, whether gratis or
+  For the developers' and authors' protection, the GPL clearly explains
-for a fee, you must give the recipients all the rights that you have. You
+that there is no warranty for this free software.  For both users' and
-must make sure that they, too, receive or can get the source code. And you
+authors' sake, the GPL requires that modified versions be marked as
-must show them these terms so they know their rights.
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
 
-We protect your rights with two steps: (1) copyright the software, and (2)
+  Some devices are designed to deny users access to install or run
-offer you this license which gives you legal permission to copy, distribute
+modified versions of the software inside them, although the manufacturer
-and/or modify the software.
+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.
 
-Also, for each author's protection and ours, we want to make certain that
+  Finally, every program is threatened constantly by software patents.
-everyone understands that there is no warranty for this free software. If
+States should not allow patents to restrict development and use of
-the software is modified by someone else and passed on, we want its recipients
+software on general-purpose computers, but in those that do, we wish to
-to know that what they have is not the original, so that any problems introduced
+avoid the special danger that patents applied to a free program could
-by others will not reflect on the original authors' reputations.
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
 
-Finally, any free program is threatened constantly by software patents. We
+  The precise terms and conditions for copying, distribution and
-wish to avoid the danger that redistributors of a free program will individually
+modification follow.
-obtain patent licenses, in effect making the program proprietary. To prevent
-this, we have made it clear that any patent must be licensed for everyone's
-free use or not licensed at all.
 
-The precise terms and conditions for copying, distribution and modification
+                       TERMS AND CONDITIONS
-follow.
 
-TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+  0. Definitions.
 
-0. This License applies to any program or other work which contains a notice
+  "This License" refers to version 3 of the GNU General Public License.
-placed by the copyright holder saying it may be distributed under the terms
-of this General Public License. The "Program", below, refers to any such program
-or work, and a "work based on the Program" means either the Program or any
-derivative work under copyright law: that is to say, a work containing the
-Program or a portion of it, either verbatim or with modifications and/or translated
-into another language. (Hereinafter, translation is included without limitation
-in the term "modification".) Each licensee is addressed as "you".
 
-Activities other than copying, distribution and modification are not covered
+  "Copyright" also means copyright-like laws that apply to other kinds of
-by this License; they are outside its scope. The act of running the Program
+works, such as semiconductor masks.
-is not restricted, and the output from the Program is covered only if its
-contents constitute a work based on the Program (independent of having been
-made by running the Program). Whether that is true depends on what the Program
-does.
 
-1. You may copy and distribute verbatim copies of the Program's source code
+  "The Program" refers to any copyrightable work licensed under this
-as you receive it, in any medium, provided that you conspicuously and appropriately
+License.  Each licensee is addressed as "you".  "Licensees" and
-publish on each copy an appropriate copyright notice and disclaimer of warranty;
+"recipients" may be individuals or organizations.
-keep intact all the notices that refer to this License and to the absence
-of any warranty; and give any other recipients of the Program a copy of this
-License along with the Program.
 
-You may charge a fee for the physical act of transferring a copy, and you
+  To "modify" a work means to copy from or adapt all or part of the work
-may at your option offer warranty protection in exchange for a fee.
+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.
 
-2. You may modify your copy or copies of the Program or any portion of it,
+  A "covered work" means either the unmodified Program or a work based
-thus forming a work based on the Program, and copy and distribute such modifications
-or work under the terms of Section 1 above, provided that you also meet all
-of these conditions:
-
-a) You must cause the modified files to carry prominent notices stating that
-you changed the files and the date of any change.
-
-b) You must cause any work that you distribute or publish, that in whole or
-in part contains or is derived from the Program or any part thereof, to be
-licensed as a whole at no charge to all third parties under the terms of this
-License.
-
-c) If the modified program normally reads commands interactively when run,
-you must cause it, when started running for such interactive use in the most
-ordinary way, to print or display an announcement including an appropriate
-copyright notice and a notice that there is no warranty (or else, saying that
-you provide a warranty) and that users may redistribute the program under
-these conditions, and telling the user how to view a copy of this License.
-(Exception: if the Program itself is interactive but does not normally print
-such an announcement, your work based on the Program is not required to print
-an announcement.)
-
-These requirements apply to the modified work as a whole. If identifiable
-sections of that work are not derived from the Program, and can be reasonably
-considered independent and separate works in themselves, then this License,
-and its terms, do not apply to those sections when you distribute them as
-separate works. But when you distribute the same sections as part of a whole
-which is a work based on the Program, the distribution of the whole must be
-on the terms of this License, whose permissions for other licensees extend
-to the entire whole, and thus to each and every part regardless of who wrote
-it.
-
-Thus, it is not the intent of this section to claim rights or contest your
-rights to work written entirely by you; rather, the intent is to exercise
-the right to control the distribution of derivative or collective works based
 on the Program.
 
-In addition, mere aggregation of another work not based on the Program with
+  To "propagate" a work means to do anything with it that, without
-the Program (or with a work based on the Program) on a volume of a storage
+permission, would make you directly or secondarily liable for
-or distribution medium does not bring the other work under the scope of this
+infringement under applicable copyright law, except executing it on a
-License.
+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.
 
-3. You may copy and distribute the Program (or a work based on it, under Section
+  To "convey" a work means any kind of propagation that enables other
-2) in object code or executable form under the terms of Sections 1 and 2 above
+parties to make or receive copies.  Mere interaction with a user through
-provided that you also do one of the following:
+a computer network, with no transfer of a copy, is not conveying.
 
-a) Accompany it with the complete corresponding machine-readable source code,
+  An interactive user interface displays "Appropriate Legal Notices"
-which must be distributed under the terms of Sections 1 and 2 above on a medium
+to the extent that it includes a convenient and prominently visible
-customarily used for software interchange; or,
+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.
 
-b) Accompany it with a written offer, valid for at least three years, to give
+  1. Source Code.
-any third party, for a charge no more than your cost of physically performing
-source distribution, a complete machine-readable copy of the corresponding
-source code, to be distributed under the terms of Sections 1 and 2 above on
-a medium customarily used for software interchange; or,
 
-c) Accompany it with the information you received as to the offer to distribute
+  The "source code" for a work means the preferred form of the work
-corresponding source code. (This alternative is allowed only for noncommercial
+for making modifications to it.  "Object code" means any non-source
-distribution and only if you received the program in object code or executable
+form of a work.
-form with such an offer, in accord with Subsection b above.)
 
-The source code for a work means the preferred form of the work for making
+  A "Standard Interface" means an interface that either is an official
-modifications to it. For an executable work, complete source code means all
+standard defined by a recognized standards body, or, in the case of
-the source code for all modules it contains, plus any associated interface
+interfaces specified for a particular programming language, one that
-definition files, plus the scripts used to control compilation and installation
+is widely used among developers working in that language.
-of the executable. However, as a special exception, the source code distributed
-need not include anything that is normally distributed (in either source or
-binary form) with the major components (compiler, kernel, and so on) of the
-operating system on which the executable runs, unless that component itself
-accompanies the executable.
 
-If distribution of executable or object code is made by offering access to
+  The "System Libraries" of an executable work include anything, other
-copy from a designated place, then offering equivalent access to copy the
+than the work as a whole, that (a) is included in the normal form of
-source code from the same place counts as distribution of the source code,
+packaging a Major Component, but which is not part of that Major
-even though third parties are not compelled to copy the source along with
+Component, and (b) serves only to enable use of the work with that
-the object code.
+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.
 
-4. You may not copy, modify, sublicense, or distribute the Program except
+  The "Corresponding Source" for a work in object code form means all
-as expressly provided under this License. Any attempt otherwise to copy, modify,
+the source code needed to generate, install, and (for an executable
-sublicense or distribute the Program is void, and will automatically terminate
+work) run the object code and to modify the work, including scripts to
-your rights under this License. However, parties who have received copies,
+control those activities.  However, it does not include the work's
-or rights, from you under this License will not have their licenses terminated
+System Libraries, or general-purpose tools or generally available free
-so long as such parties remain in full compliance.
+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.
 
-5. You are not required to accept this License, since you have not signed
+  The Corresponding Source need not include anything that users
-it. However, nothing else grants you permission to modify or distribute the
+can regenerate automatically from other parts of the Corresponding
-Program or its derivative works. These actions are prohibited by law if you
+Source.
-do not accept this License. Therefore, by modifying or distributing the Program
-(or any work based on the Program), you indicate your acceptance of this License
-to do so, and all its terms and conditions for copying, distributing or modifying
-the Program or works based on it.
 
-6. Each time you redistribute the Program (or any work based on the Program),
+  The Corresponding Source for a work in source code form is that
-the recipient automatically receives a license from the original licensor
+same work.
-to copy, distribute or modify the Program subject to these terms and conditions.
-You may not impose any further restrictions on the recipients' exercise of
-the rights granted herein. You are not responsible for enforcing compliance
-by third parties to this License.
 
-7. If, as a consequence of a court judgment or allegation of patent infringement
+  2. Basic Permissions.
-or for any other reason (not limited to patent issues), 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 distribute so as to satisfy simultaneously your
-obligations under this License and any other pertinent obligations, then as
-a consequence you may not distribute the Program at all. For example, if a
-patent license would not permit royalty-free redistribution of the Program
-by all those who receive copies directly or indirectly through you, then the
-only way you could satisfy both it and this License would be to refrain entirely
-from distribution of the Program.
 
-If any portion of this section is held invalid or unenforceable under any
+  All rights granted under this License are granted for the term of
-particular circumstance, the balance of the section is intended to apply and
+copyright on the Program, and are irrevocable provided the stated
-the section as a whole is intended to apply in other circumstances.
+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.
 
-It is not the purpose of this section to induce you to infringe any patents
+  You may make, run and propagate covered works that you do not
-or other property right claims or to contest validity of any such claims;
+convey, without conditions so long as your license otherwise remains
-this section has the sole purpose of protecting the integrity of the free
+in force.  You may convey covered works to others for the sole purpose
-software distribution system, which is implemented by public license practices.
+of having them make modifications exclusively for you, or provide you
-Many people have made generous contributions to the wide range of software
+with facilities for running those works, provided that you comply with
-distributed through that system in reliance on consistent application of that
+the terms of this License in conveying all material for which you do
-system; it is up to the author/donor to decide if he or she is willing to
+not control copyright.  Those thus making or running the covered works
-distribute software through any other system and a licensee cannot impose
+for you must do so exclusively on your behalf, under your direction
-that choice.
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
 
-This section is intended to make thoroughly clear what is believed to be a
+  Conveying under any other circumstances is permitted solely under
-consequence of the rest of this License.
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
 
-8. If the distribution and/or use of the Program is restricted in certain
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
-countries either by patents or by copyrighted interfaces, the original copyright
-holder who places the Program under this License may add an explicit geographical
-distribution limitation excluding those countries, so that distribution is
-permitted only in or among countries not thus excluded. In such case, this
-License incorporates the limitation as if written in the body of this License.
 
-9. The Free Software Foundation may publish revised and/or new versions of
+  No covered work shall be deemed part of an effective technological
-the General Public License from time to time. Such new versions will be similar
+measure under any applicable law fulfilling obligations under article
-in spirit to the present version, but may differ in detail to address new
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
-problems or concerns.
+similar laws prohibiting or restricting circumvention of such
+measures.
 
-Each version is given a distinguishing version number. If the Program specifies
+  When you convey a covered work, you waive any legal power to forbid
-a version number of this License which applies to it and "any later version",
+circumvention of technological measures to the extent such circumvention
-you have the option of following the terms and conditions either of that version
+is effected by exercising rights under this License with respect to
-or of any later version published by the Free Software Foundation. If the
+the covered work, and you disclaim any intention to limit operation or
-Program does not specify a version number of this License, you may choose
+modification of the work as a means of enforcing, against the work's
-any version ever published by the Free Software Foundation.
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
 
-10. If you wish to incorporate parts of the Program into other free programs
+  4. Conveying Verbatim Copies.
-whose distribution conditions are different, write to the author to ask for
-permission. For software which is copyrighted by the Free Software Foundation,
-write to the Free Software Foundation; we sometimes make exceptions for this.
-Our decision will be guided by the two goals of preserving the free status
-of all derivatives of our free software and of promoting the sharing and reuse
-of software generally.
 
-   NO WARRANTY
+  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.
 
-11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR
+  You may charge any price or no price for each copy that you convey,
-THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE
+and you may offer support or warranty protection for a fee.
-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.
 
-12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+  5. Conveying Modified Source Versions.
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE
+
+  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
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
-OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
-OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
-OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
-HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
-END OF TERMS AND CONDITIONS
+SUCH DAMAGES.
 
-How to Apply These Terms to Your New Programs
+  17. Interpretation of Sections 15 and 16.
 
-If you develop a new program, and you want it to be of the greatest possible
+  If the disclaimer of warranty and limitation of liability provided
-use to the public, the best way to achieve this is to make it free software
+above cannot be given local legal effect according to their terms,
-which everyone can redistribute and change under these 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.
 
-To do so, attach the following notices to the program. It is safest to attach
+                     END OF TERMS AND CONDITIONS
-them to the start of each source file to most effectively convey 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 an idea of what it does.>
+            How to Apply These Terms to Your New Programs
 
-Copyright (C) <yyyy> <name of author>
+  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.
 
-This program is free software; you can redistribute it and/or modify it under
+  To do so, attach the following notices to the program.  It is safest
-the terms of the GNU General Public License as published by the Free Software
+to attach them to the start of each source file to most effectively
-Foundation; either version 2 of the License, or (at your option) any later
+state the exclusion of warranty; and each file should have at least
-version.
+the "copyright" line and a pointer to where the full notice is found.
 
-This program is distributed in the hope that it will be useful, but WITHOUT
+    <one line to give the program's name and a brief idea of what it does.>
-ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+    Copyright (C) <year>  <name of author>
-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 is free software: you can redistribute it and/or modify
-this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
+    it under the terms of the GNU General Public License as published by
-Street, Fifth Floor, Boston, MA 02110-1301 , USA.
+    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 is interactive, make it output a short notice like this when
+  If the program does terminal interaction, make it output a short
-it starts in an interactive mode:
+notice like this when it starts in an interactive mode:
 
-Gnomovision version 69, Copyright (C) year name of author Gnomovision comes
+    <program>  Copyright (C) <year>  <name of author>
-with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software,
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
-and you are welcome to redistribute it under certain conditions; type `show
+    This is free software, and you are welcome to redistribute it
-c' for details.
+    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, the commands you use may be
+parts of the General Public License.  Of course, your program's commands
-called something other than `show w' and `show c'; they could even be mouse-clicks
+might be different; for a GUI interface, you would use an "about box".
-or menu items--whatever suits your program.
 
-You should also get your employer (if you work as a programmer) or your school,
+  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. Here
+if any, to sign a "copyright disclaimer" for the program, if necessary.
-is a sample; alter the names:
+For more information on this, and how to apply and follow the GNU GPL, see
+<https://www.gnu.org/licenses/>.
 
-Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision'
+  The GNU General Public License does not permit incorporating your program
-(which makes passes at compilers) written by James Hacker.
+into proprietary programs.  If your program is a subroutine library, you
-
+may consider it more useful to permit linking proprietary applications with
-< signature of Ty Coon > , 1 April 1989 Ty Coon, President of Vice This General
+the library.  If this is what you want to do, use the GNU Lesser General
-Public License does not permit incorporating your program into proprietary
+Public License instead of this License.  But first, please read
-programs. If your program is a subroutine library, you may consider it more
+<https://www.gnu.org/licenses/why-not-lgpl.html>.
-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.

README.md

@@ -1,12 +1,21 @@
-## PyFAN
+# PyFan
 
-This python script utilizes linux's hwmon interface and a PID controller for fan controlling. No external dependencies besides simple_pid are needed.
+This python script utilizes linux's hwmon interface and a PID controller for fan controlling. No external dependencies besides simple_pid and PyYAML are needed.
 
-# Usage
+## Installation
+### Archlinux
+
+[AUR package](https://aur.archlinux.org/packages/pyfan/)
+
+### Other
+
+Put pyfan.py into /usr/local/sbin and give it +x.
+
+## Usage
 
 Put your config in /etc/pyfan (see example config) and enable pyfan as a service (see example service file).
 
-# Finding your fans
+## Finding your fans
 > It is recommended to use pwmconfig from lm_sensors to detect your fans.
 
 

config-example.yaml

@@ -1,24 +1,65 @@
+# This example configuration is creating two thermal zones, one with amdgpu/temp1_input as source,
+# the other one with coretemp/temp1_input as source.
+# Some options have additional comments for explanation.
+
+# Set target log level. If you have a problem or want to report an issue set this to DEBUG,
+# otherwise INFO is a good value.
 loglevel: DEBUG
 
+# Frequency in seconds of feeding sensors values into PID. Higher frequency (lower value) means PID can react faster.
+# Fans only get set every thermalzones->interval seconds, regardless of this value.
+# Must be lower then your lowest thermalzone interval.
+pid_interval: 0.2
+
 thermalzones:
   - name: GPU+SYSTEM
-    hwmon: amdgpu
+
+    # This is your source temperature. You can add multiple sources, see thermal zone below for an example.
     source: amdgpu/temp1_input
+
+    # This is most likely 1000 for your temp sensor as well.
+    # If not, check what you sensor is outputting if you try to read from it.
     factor: 1000
+
+    # Frequency in which fan speed should be adjusted in seconds.
+    # PyFan reads sensors values from hwmon every pid_interval, but only sets fan speeds in this interval.
+    # Can't be lower then pid_interval.
+    interval: 3
+
+    # Define all fans that this thermal zone is going to control.
+    # There is no limit to how many fans one thermal zone can control.
+    # You can have different limitations on your fans, for example:
+    #   - amdgpu/pwm1: 170
+    # means your GPU fan's pwm1 is never getting set higher than 170, limiting its max. rpm value.
+    # You can specify an lower limit as well:
+    #   - it8686/pwm1: [100, 200]
+    # means your fan's pwm is never set under 100, and never over 200.
     fan:
       - it8686/pwm2
       - amdgpu/pwm1: 170
+
+    # This is your target temperature. This is one of the main control knobs. Set this to a comfortable temperature for
+    # your equipment. Don't set this as high as its max temperature allowance, since pid is gonna allow some overshooting.
     target: 60
+
+    # For understanding PID please have a look at https://en.wikipedia.org/wiki/PID_controller. The aforementioned page
+    # also explains what p, i and d stand for and what they do in detail. These are the second main control knobs.
+    # Simplified you can view them as weights for:
+    #   p = difference in temperature (momentarily)
+    #   i = difference in temperature over time
+    #   d = rate of chance in temperature
     pid:
       p: 1
       i: 1
       d: 1.5
   - name: CPU
-    hwmon: it8686
+    source:
-    source: coretemp/temp1_input
+      - coretemp/temp1_input
+      - amdgpu/temp1_input
     factor: 1000
+    interval: 3
     fan:
-      - it8686/pwm1
+      - it8686/pwm1: [ 100, 200 ]
     target: 50
     pid:
       p: 1

pyfan.py

@@ -12,53 +12,114 @@ SYSFS_HWMON_BASE = "/sys/class/hwmon/"
 
 
 class ThermalZone:
-    def __init__(self, config, hwmon_map) -> None:
+    def __init__(self, config, pyfan_parent) -> None:
         self.fans = config["fan"]
         self.temp_source = config["source"]
-        self.pid = PID(config["pid"]["p"], config["pid"]["i"], config["pid"]["d"], setpoint=0)
-        self.pid.output_limits = (0, 255)
         self.factor = 1 / config["factor"]
         self.name = config["name"]
         self.target = config["target"]
-        self.hwname = config["hwmon"]
+        self.pyfan = pyfan_parent
-        self.hwmap = hwmon_map
+        self.hwmap = self.pyfan.hwmap
-        self.alias_replace = re.compile('|'.join(self.hwmap.keys()))
+        self.alias_replace = re.compile("|".join(self.hwmap.keys()))
+
+        if "interval" not in config:
+            config["interval"] = 3
+            logging.getLogger("pyfan").warning(
+                "[%s] No interval specified, using default. This is deprecated since 1.6 and may be removed in future "
+                "versions. See example config for reference.",
+                self.name,
+            )
+
+        self.pid = PID(
+            config["pid"]["p"],
+            config["pid"]["i"],
+            config["pid"]["d"],
+            setpoint=0,
+            sample_time=config["interval"],
+        )
+
+        # we prefer 3 for pwm_enable, but since some chips do not support this mode, use 1 with pwm_min of 1 as fallback
+        # more on pwm=0 behaviour: https://www.kernel.org/doc/html/latest/hwmon/pwm-fan.html
+        self.pid.output_limits = (1, 255)
         self.setup_pwm()
 
         logging.getLogger("pyfan").info(
-            "[{zone}] Source={source} Fans={fans} Factor={factor} PID={pid}".format(zone=self.name,
+            "[%s] Source=%s Fans=%s Factor=%f %s",
-                                                                                    source=self.temp_source,
+            self.name,
-                                                                                    fans=self.fans,
+            self.temp_source,
-                                                                                    factor=self.factor,
+            self.fans,
-                                                                                    pid=(
+            self.factor,
-                                                                                        self.pid.Kp, self.pid.Ki,
+            self.pid,
-                                                                                        self.pid.Kd)))
+        )
 
     def eval(self):
-        diff = self.target - self.get_temp()
+        if self.get_temp():
-        val = self.pid(diff)
+            diff = self.target - self.get_temp()
+            val = int(self.pid(diff))
 
-        try:
+            try:
-            for target_fan in self.fans:
+                for target_fan in self.fans:
-                if type(target_fan) is dict:
+                    if isinstance(target_fan, dict):
-                    self.write_sysfs(list(target_fan.keys())[0], min(int(val), list(target_fan.values())[0]))
+                        fan = list(target_fan.keys())[0]
-                else:
+                        fan_val = list(target_fan.values())[0]
-                    self.write_sysfs(target_fan, int(val))
-        except OSError as err:
-            logging.getLogger("pyfan").warning(
-                "[%s] Failed to set pwm, trying to reset it. (%s)" % (self.name, err.strerror))
-            self.setup_pwm(1)
 
-        p, i, d = self.pid.components
+                        if isinstance(fan_val, list):
+                            if len(fan_val) < 2:
+                                logging.getLogger("pyfan").warning(
+                                    "[%s] max/min for %s was not set correctly (%s)",
+                                    self.name,
+                                    fan,
+                                    fan_val,
+                                )
 
-        logging.getLogger("pyfan").debug(
+                            if self.read_sysfs(fan) != min(
-            "[{name}] {val}% ({diff}C/{temp}C) ({p}|{i}|{d})".format(name=self.name, val=int(val / 255 * 100),
+                                fan_val[1], max(val, fan_val[0])
-                                                                     diff=diff,
+                            ):
-                                                                     temp=self.get_temp(), p=int(p), i=int(i),
+                                self.write_sysfs(
-                                                                     d=int(d)))
+                                    fan, min(fan_val[1], max(val, fan_val[0]))
+                                )
+                        elif self.read_sysfs(fan) != min(val, fan_val):
+                            self.write_sysfs(fan, min(val, fan_val))
+
+                        logging.getLogger("pyfan").debug(
+                            "[%s] %s=%i%%",
+                            self.name,
+                            fan,
+                            int(int(self.read_sysfs(fan)) / 255 * 100),
+                        )
+                    elif self.read_sysfs(target_fan) != val:
+                        self.write_sysfs(target_fan, val)
+            except OSError as err:
+                logging.getLogger("pyfan").warning(
+                    "[%s] Failed to set pwm, trying to reset it. (%s)",
+                    self.name,
+                    err.strerror,
+                )
+
+                self.setup_pwm(1)
+
+            logging.getLogger("pyfan").debug(
+                "[%s] %i%% D:%iC T:%iC %s",
+                self.name,
+                int(val / 255 * 100),
+                diff,
+                self.get_temp(),
+                self.pid,
+            )
 
     def get_temp(self):
-        return float(self.read_sysfs(self.temp_source)) * self.factor
+        if isinstance(self.temp_source, list):
+            max_temp = -1.0
+            for fan in self.temp_source:
+                if self.read_sysfs(fan):
+                    max_temp = max(float(self.read_sysfs(fan)) * self.factor, max_temp)
+
+            return max_temp
+        else:
+            if self.read_sysfs(self.temp_source):
+                return float(self.read_sysfs(self.temp_source)) * self.factor
+            else:
+                return None
 
     def restore(self):
         self.setup_pwm(2)
@@ -66,29 +127,39 @@ class ThermalZone:
     def setup_pwm(self, value=1):
         for target_fan in self.fans:
             try:
-                if type(target_fan) is dict:
+                if isinstance(target_fan, dict):
                     self.set_pwm_mode(list(target_fan.keys())[0], value)
                 else:
                     self.set_pwm_mode(target_fan, value)
-            except FileNotFoundError as err:
+            except FileNotFoundError:
-                logging.getLogger("pyfan").warning("[%s] pwm not found. Not ready yet or wrong path? (%s)" % (self.name,
+                logging.getLogger("pyfan").warning(
-                                                                                                              err.strerror))
+                    "[%s] pwm not found. Try reloading hwmon map...", self.name
+                )
+                self.hwmap = self.pyfan.hwmap
 
     def replace_alias(self, path):
         replaced = self.alias_replace.sub(lambda x: self.hwmap[x.group()], path)
-        logging.getLogger("pyfan").debug("[ALIAS] %s -> %s" % (path, replaced))
+        logging.getLogger("pyfan").debug("[ALIAS] %s -> %s", path, replaced)
         return replaced
 
     def build_pwm_path(self, specific):
         return self.replace_alias(SYSFS_HWMON_BASE + specific)
 
     def write_sysfs(self, path, value):
-        with open(self.build_pwm_path(path), 'w') as sysfs_f:
+        with open(self.build_pwm_path(path), "w") as sysfs_f:
             sysfs_f.write(str(value))
 
     def read_sysfs(self, path):
-        with open(self.build_pwm_path(path)) as sysfs_f:
+        try:
-            return sysfs_f.readline()
+            with open(self.build_pwm_path(path)) as sysfs_f:
+                return sysfs_f.readline()
+        except FileNotFoundError as err:
+            logging.getLogger("pyfan").warning(
+                "[%s] temp source not found. Not ready yet or wrong path? (%s)",
+                self.name,
+                err.strerror,
+            )
+            return None
 
     def set_pwm_mode(self, path, value=1):
         self.write_sysfs(path + "_enable", value)
@@ -99,13 +170,21 @@ class PyFan:
         self.config = self.__load_config(config)
         logging.basicConfig(level=logging.getLevelName(self.config["loglevel"]))
         self.zones = []
-        self.hwmon_map = {}
+        if "pid_interval" not in self.config:
-        self.gen_hwmon_map()
+            self.interval = 0.2
+            logging.getLogger("pyfan").warning(
+                "No pid_interval specified, using default. This is deprecated since 1.6 and may be removed in future "
+                "versions. See example config for reference."
+            )
+        else:
+            self.interval = self.config["pid_interval"]
 
         for zone in self.config["thermalzones"]:
-            self.zones.append(ThermalZone(zone, self.hwmon_map))
+            self.zones.append(ThermalZone(zone, self))
 
-        logging.getLogger("pyfan").info("Finished creating %d thermal zones." % len(self.zones))
+        logging.getLogger("pyfan").info(
+            "Created %d thermal zones, pid_interval=%f.", len(self.zones), self.interval
+        )
 
     def __enter__(self):
         return self
@@ -118,19 +197,23 @@ class PyFan:
         for zone in self.zones:
             zone.eval()
 
-    @staticmethod
+    @property
-    def __load_config(path):
+    def hwmap(self):
-        with open(path) as cfg_file:
+        hwmon_map = {}
-            return yaml.safe_load(cfg_file)
 
-    def gen_hwmon_map(self):
         names = glob.glob(SYSFS_HWMON_BASE + "hwmon*/name")
 
         for name in names:
             hwmon = name.split("/")[-2]
             with open(name) as file:
-                hwname = file.read().strip()
+                hw_name = file.read().strip()
-            self.hwmon_map[hwname] = hwmon
+            hwmon_map[hw_name] = hwmon
+        return hwmon_map
+
+    @staticmethod
+    def __load_config(path):
+        with open(path) as cfg_file:
+            return yaml.safe_load(cfg_file)
 
 
 if __name__ == "__main__":
@@ -138,6 +221,6 @@ if __name__ == "__main__":
         while True:
             try:
                 pyfan.eval()
-                sleep(1)
+                sleep(pyfan.interval)
             except KeyboardInterrupt:
                 sys.exit(0)

pyfan.pyi

@@ -0,0 +1,54 @@
+from typing import Any, Pattern
+
+from simple_pid import PID
+
+SYSFS_HWMON_BASE: str
+
+
+class ThermalZone:
+    fans: Any = ...
+    temp_source: Any = ...
+    pid: PID = ...
+    factor: float = ...
+    name: str = ...
+    target: Any = ...
+    hwmap: dict = ...
+    pyfan: PyFan = ...
+    alias_replace: Pattern = ...
+
+    def __init__(self, config: dict, pyfan_parent: PyFan) -> None: ...
+
+    def eval(self) -> None: ...
+
+    def get_temp(self): ...
+
+    def restore(self) -> None: ...
+
+    def setup_pwm(self, value: int = ...) -> None: ...
+
+    def replace_alias(self, path: str): ...
+
+    def build_pwm_path(self, specific: Any): ...
+
+    def write_sysfs(self, path: str, value: Any) -> None: ...
+
+    def read_sysfs(self, path: str): ...
+
+    def set_pwm_mode(self, path: str, value: int = ...) -> None: ...
+
+
+class PyFan:
+    config: dict = ...
+    zones: list = ...
+    interval: float = ...
+
+    def __init__(self, config: str = ...) -> None: ...
+
+    def __enter__(self): ...
+
+    def __exit__(self, exc_type: Any, exc_val: Any, exc_tb: Any) -> None: ...
+
+    def eval(self) -> None: ...
+
+    @property
+    def hwmap(self): ...

pyfan.service

@@ -1,5 +1,5 @@
 [Unit]
-Description=Start PyFan fan control
+Description=PID based fan control
 ConditionFileNotEmpty=/etc/pyfan
 After=lm_sensors.service
 

pylintrc

@@ -0,0 +1,441 @@
+# This Pylint rcfile contains a best-effort configuration to uphold the
+# best-practices and style described in the Google Python style guide:
+#   https://google.github.io/styleguide/pyguide.html
+#
+# Its canonical open-source location is:
+#   https://google.github.io/styleguide/pylintrc
+
+[MASTER]
+
+# Files or directories to be skipped. They should be base names, not paths.
+ignore=third_party
+
+# Files or directories matching the regex patterns are skipped. The regex
+# matches against base names, not paths.
+ignore-patterns=
+
+# Pickle collected data for later comparisons.
+persistent=no
+
+# List of plugins (as comma separated values of python modules names) to load,
+# usually to register additional checkers.
+load-plugins=
+
+# Use multiple processes to speed up Pylint.
+jobs=4
+
+# Allow loading of arbitrary C extensions. Extensions are imported into the
+# active Python interpreter and may run arbitrary code.
+unsafe-load-any-extension=no
+
+
+[MESSAGES CONTROL]
+
+# Only show warnings with the listed confidence levels. Leave empty to show
+# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED
+confidence=
+
+# Enable the message, report, category or checker with the given id(s). You can
+# either give multiple identifier separated by comma (,) or put this option
+# multiple time (only on the command line, not in the configuration file where
+# it should appear only once). See also the "--disable" option for examples.
+#enable=
+
+# Disable the message, report, category or checker with the given id(s). You
+# can either give multiple identifiers separated by comma (,) or put this
+# option multiple times (only on the command line, not in the configuration
+# file where it should appear only once).You can also use "--disable=all" to
+# disable everything first and then reenable specific checks. For example, if
+# you want to run only the similarities checker, you can use "--disable=all
+# --enable=similarities". If you want to run only the classes checker, but have
+# no Warning level messages displayed, use"--disable=all --enable=classes
+# --disable=W"
+disable=abstract-method,
+        apply-builtin,
+        arguments-differ,
+        attribute-defined-outside-init,
+        backtick,
+        bad-option-value,
+        basestring-builtin,
+        buffer-builtin,
+        c-extension-no-member,
+        consider-using-enumerate,
+        cmp-builtin,
+        cmp-method,
+        coerce-builtin,
+        coerce-method,
+        delslice-method,
+        div-method,
+        duplicate-code,
+        eq-without-hash,
+        execfile-builtin,
+        file-builtin,
+        filter-builtin-not-iterating,
+        fixme,
+        getslice-method,
+        global-statement,
+        hex-method,
+        idiv-method,
+        implicit-str-concat-in-sequence,
+        import-error,
+        import-self,
+        import-star-module-level,
+        inconsistent-return-statements,
+        input-builtin,
+        intern-builtin,
+        invalid-str-codec,
+        locally-disabled,
+        long-builtin,
+        long-suffix,
+        map-builtin-not-iterating,
+        misplaced-comparison-constant,
+        missing-function-docstring,
+        metaclass-assignment,
+        next-method-called,
+        next-method-defined,
+        no-absolute-import,
+        no-else-break,
+        no-else-continue,
+        no-else-raise,
+        no-else-return,
+        no-init,  # added
+        no-member,
+        no-name-in-module,
+        no-self-use,
+        nonzero-method,
+        oct-method,
+        old-division,
+        old-ne-operator,
+        old-octal-literal,
+        old-raise-syntax,
+        parameter-unpacking,
+        print-statement,
+        raising-string,
+        range-builtin-not-iterating,
+        raw_input-builtin,
+        rdiv-method,
+        reduce-builtin,
+        relative-import,
+        reload-builtin,
+        round-builtin,
+        setslice-method,
+        signature-differs,
+        standarderror-builtin,
+        suppressed-message,
+        sys-max-int,
+        too-few-public-methods,
+        too-many-ancestors,
+        too-many-arguments,
+        too-many-boolean-expressions,
+        too-many-branches,
+        too-many-instance-attributes,
+        too-many-locals,
+        too-many-nested-blocks,
+        too-many-public-methods,
+        too-many-return-statements,
+        too-many-statements,
+        trailing-newlines,
+        unichr-builtin,
+        unicode-builtin,
+        unnecessary-pass,
+        unpacking-in-except,
+        useless-else-on-loop,
+        useless-object-inheritance,
+        useless-suppression,
+        using-cmp-argument,
+        wrong-import-order,
+        xrange-builtin,
+        zip-builtin-not-iterating,
+
+
+[REPORTS]
+
+# Set the output format. Available formats are text, parseable, colorized, msvs
+# (visual studio) and html. You can also give a reporter class, eg
+# mypackage.mymodule.MyReporterClass.
+output-format=text
+
+# Put messages in a separate file for each module / package specified on the
+# command line instead of printing them on stdout. Reports (if any) will be
+# written in a file name "pylint_global.[txt|html]". This option is deprecated
+# and it will be removed in Pylint 2.0.
+files-output=no
+
+# Tells whether to display a full report or only the messages
+reports=no
+
+# Python expression which should return a note less than 10 (10 is the highest
+# note). You have access to the variables errors warning, statement which
+# respectively contain the number of errors / warnings messages and the total
+# number of statements analyzed. This is used by the global evaluation report
+# (RP0004).
+evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
+
+# Template used to display messages. This is a python new-style format string
+# used to format the message information. See doc for all details
+#msg-template=
+
+
+[BASIC]
+
+# Good variable names which should always be accepted, separated by a comma
+good-names=main,_
+
+# Bad variable names which should always be refused, separated by a comma
+bad-names=
+
+# Colon-delimited sets of names that determine each other's naming style when
+# the name regexes allow several styles.
+name-group=
+
+# Include a hint for the correct naming format with invalid-name
+include-naming-hint=no
+
+# List of decorators that produce properties, such as abc.abstractproperty. Add
+# to this list to register other decorators that produce valid properties.
+property-classes=abc.abstractproperty,cached_property.cached_property,cached_property.threaded_cached_property,cached_property.cached_property_with_ttl,cached_property.threaded_cached_property_with_ttl
+
+# Regular expression matching correct function names
+function-rgx=^(?:(?P<exempt>setUp|tearDown|setUpModule|tearDownModule)|(?P<camel_case>_?[A-Z][a-zA-Z0-9]*)|(?P<snake_case>_?[a-z][a-z0-9_]*))$
+
+# Regular expression matching correct variable names
+variable-rgx=^[a-z][a-z0-9_]*$
+
+# Regular expression matching correct constant names
+const-rgx=^(_?[A-Z][A-Z0-9_]*|__[a-z0-9_]+__|_?[a-z][a-z0-9_]*)$
+
+# Regular expression matching correct attribute names
+attr-rgx=^_{0,2}[a-z][a-z0-9_]*$
+
+# Regular expression matching correct argument names
+argument-rgx=^[a-z][a-z0-9_]*$
+
+# Regular expression matching correct class attribute names
+class-attribute-rgx=^(_?[A-Z][A-Z0-9_]*|__[a-z0-9_]+__|_?[a-z][a-z0-9_]*)$
+
+# Regular expression matching correct inline iteration names
+inlinevar-rgx=^[a-z][a-z0-9_]*$
+
+# Regular expression matching correct class names
+class-rgx=^_?[A-Z][a-zA-Z0-9]*$
+
+# Regular expression matching correct module names
+module-rgx=^(_?[a-z][a-z0-9_]*|__init__)$
+
+# Regular expression matching correct method names
+method-rgx=(?x)^(?:(?P<exempt>_[a-z0-9_]+__|runTest|setUp|tearDown|setUpTestCase|tearDownTestCase|setupSelf|tearDownClass|setUpClass|(test|assert)_*[A-Z0-9][a-zA-Z0-9_]*|next)|(?P<camel_case>_{0,2}[A-Z][a-zA-Z0-9_]*)|(?P<snake_case>_{0,2}[a-z][a-z0-9_]*))$
+
+# Regular expression which should only match function or class names that do
+# not require a docstring.
+no-docstring-rgx=(__.*__|main|test.*|.*test|.*Test)$
+
+# Minimum line length for functions/classes that require docstrings, shorter
+# ones are exempt.
+docstring-min-length=10
+
+
+[TYPECHECK]
+
+# List of decorators that produce context managers, such as
+# contextlib.contextmanager. Add to this list to register other decorators that
+# produce valid context managers.
+contextmanager-decorators=contextlib.contextmanager,contextlib2.contextmanager
+
+# Tells whether missing members accessed in mixin class should be ignored. A
+# mixin class is detected if its name ends with "mixin" (case insensitive).
+ignore-mixin-members=yes
+
+# List of module names for which member attributes should not be checked
+# (useful for modules/projects where namespaces are manipulated during runtime
+# and thus existing member attributes cannot be deduced by static analysis. It
+# supports qualified module names, as well as Unix pattern matching.
+ignored-modules=
+
+# List of class names for which member attributes should not be checked (useful
+# for classes with dynamically set attributes). This supports the use of
+# qualified names.
+ignored-classes=optparse.Values,thread._local,_thread._local
+
+# List of members which are set dynamically and missed by pylint inference
+# system, and so shouldn't trigger E1101 when accessed. Python regular
+# expressions are accepted.
+generated-members=
+
+
+[FORMAT]
+
+# Maximum number of characters on a single line.
+max-line-length=120
+
+# TODO(https://github.com/PyCQA/pylint/issues/3352): Direct pylint to exempt
+# lines made too long by directives to pytype.
+
+# Regexp for a line that is allowed to be longer than the limit.
+ignore-long-lines=(?x)(
+  ^\s*(\#\ )?<?https?://\S+>?$|
+  ^\s*(from\s+\S+\s+)?import\s+.+$)
+
+# Allow the body of an if to be on the same line as the test if there is no
+# else.
+single-line-if-stmt=yes
+
+# List of optional constructs for which whitespace checking is disabled. `dict-
+# separator` is used to allow tabulation in dicts, etc.: {1  : 1,\n222: 2}.
+# `trailing-comma` allows a space between comma and closing bracket: (a, ).
+# `empty-line` allows space-only lines.
+no-space-check=
+
+# Maximum number of lines in a module
+max-module-lines=99999
+
+# String used as indentation unit.  The internal Google style guide mandates 2
+# spaces.  Google's externaly-published style guide says 4, consistent with
+# PEP 8.  Here, we use 2 spaces, for conformity with many open-sourced Google
+# projects (like TensorFlow).
+indent-string='    '
+
+# Number of spaces of indent required inside a hanging  or continued line.
+indent-after-paren=8
+
+# Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
+expected-line-ending-format=
+
+
+[MISCELLANEOUS]
+
+# List of note tags to take in consideration, separated by a comma.
+notes=TODO
+
+
+[STRING]
+
+# This flag controls whether inconsistent-quotes generates a warning when the
+# character used as a quote delimiter is used inconsistently within a module.
+check-quote-consistency=yes
+
+
+[VARIABLES]
+
+# Tells whether we should check for unused import in __init__ files.
+init-import=no
+
+# A regular expression matching the name of dummy variables (i.e. expectedly
+# not used).
+dummy-variables-rgx=^\*{0,2}(_$|unused_|dummy_)
+
+# List of additional names supposed to be defined in builtins. Remember that
+# you should avoid to define new builtins when possible.
+additional-builtins=
+
+# List of strings which can identify a callback function by name. A callback
+# name must start or end with one of those strings.
+callbacks=cb_,_cb
+
+# List of qualified module names which can have objects that can redefine
+# builtins.
+redefining-builtins-modules=six,six.moves,past.builtins,future.builtins,functools
+
+
+[LOGGING]
+
+# Logging modules to check that the string format arguments are in logging
+# function parameter format
+logging-modules=logging,absl.logging,tensorflow.io.logging
+
+
+[SIMILARITIES]
+
+# Minimum lines number of a similarity.
+min-similarity-lines=4
+
+# Ignore comments when computing similarities.
+ignore-comments=yes
+
+# Ignore docstrings when computing similarities.
+ignore-docstrings=yes
+
+# Ignore imports when computing similarities.
+ignore-imports=no
+
+
+[SPELLING]
+
+# Spelling dictionary name. Available dictionaries: none. To make it working
+# install python-enchant package.
+spelling-dict=
+
+# List of comma separated words that should not be checked.
+spelling-ignore-words=
+
+# A path to a file that contains private dictionary; one word per line.
+spelling-private-dict-file=
+
+# Tells whether to store unknown words to indicated private dictionary in
+# --spelling-private-dict-file option instead of raising a message.
+spelling-store-unknown-words=no
+
+
+[IMPORTS]
+
+# Deprecated modules which should not be used, separated by a comma
+deprecated-modules=regsub,
+                   TERMIOS,
+                   Bastion,
+                   rexec,
+                   sets
+
+# Create a graph of every (i.e. internal and external) dependencies in the
+# given file (report RP0402 must not be disabled)
+import-graph=
+
+# Create a graph of external dependencies in the given file (report RP0402 must
+# not be disabled)
+ext-import-graph=
+
+# Create a graph of internal dependencies in the given file (report RP0402 must
+# not be disabled)
+int-import-graph=
+
+# Force import order to recognize a module as part of the standard
+# compatibility libraries.
+known-standard-library=
+
+# Force import order to recognize a module as part of a third party library.
+known-third-party=enchant, absl
+
+# Analyse import fallback blocks. This can be used to support both Python 2 and
+# 3 compatible code, which means that the block might have code that exists
+# only in one or another interpreter, leading to false positives when analysed.
+analyse-fallback-blocks=no
+
+
+[CLASSES]
+
+# List of method names used to declare (i.e. assign) instance attributes.
+defining-attr-methods=__init__,
+                      __new__,
+                      setUp
+
+# List of member names, which should be excluded from the protected access
+# warning.
+exclude-protected=_asdict,
+                  _fields,
+                  _replace,
+                  _source,
+                  _make
+
+# List of valid names for the first argument in a class method.
+valid-classmethod-first-arg=cls,
+                            class_
+
+# List of valid names for the first argument in a metaclass class method.
+valid-metaclass-classmethod-first-arg=mcs
+
+
+[EXCEPTIONS]
+
+# Exceptions that will emit a warning when being caught. Defaults to
+# "Exception"
+overgeneral-exceptions=StandardError,
+                       Exception,
+                       BaseException