jeff/greendeck
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

first

Browse source
This commit is contained in:
Jeffrey C. Ollie 2022-12-13 14:25:50 -06:00
commit 2cdd0ffc31
Signed by: jeff
GPG key ID: 6F86035A6D97044E
32 changed files with 4913 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
.gitignore vendored Normal file
View file

@ -0,0 +1,4 @@
/result*
/.venv
__pycache__
/config.yaml

16
.vscode/settings.json vendored Normal file
View file

@ -0,0 +1,16 @@
{
"python.formatting.provider": "black",
"python.linting.flake8Enabled": true,
"editor.formatOnSave": true,
"editor.formatOnSaveMode": "file",
"editor.codeActionsOnSave": {
"source.organizeImports": true
},
"python.analysis.typeCheckingMode": "off",
"python.linting.enabled": true,
"python.linting.flake8Args": [
"--max-line-length=88",
"--extend-ignore=E203"
],
"python.linting.pylintEnabled": false,
}

674
LICENSE Normal file
View file

@ -0,0 +1,674 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://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 <http://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
<http://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
<http://www.gnu.org/philosophy/why-not-lgpl.html>.

42
flake.lock Normal file
View file

@ -0,0 +1,42 @@
{
"nodes": {
"flake-utils": {
"locked": {
"lastModified": 1667395993,
"narHash": "sha256-nuEHfE/LcWyuSWnS8t12N1wc105Qtau+/OdUAjtQ0rA=",
"owner": "numtide",
"repo": "flake-utils",
"rev": "5aed5285a952e0b949eb3ba02c12fa4fcfef535f",
"type": "github"
},
"original": {
"owner": "numtide",
"repo": "flake-utils",
"type": "github"
}
},
"nixpkgs": {
"locked": {
"lastModified": 1670461440,
"narHash": "sha256-jy1LB8HOMKGJEGXgzFRLDU1CBGL0/LlkolgnqIsF0D8=",
"owner": "NixOS",
"repo": "nixpkgs",
"rev": "04a75b2eecc0acf6239acf9dd04485ff8d14f425",
"type": "github"
},
"original": {
"id": "nixpkgs",
"ref": "nixos-22.11",
"type": "indirect"
}
},
"root": {
"inputs": {
"flake-utils": "flake-utils",
"nixpkgs": "nixpkgs"
}
}
},
"root": "root",
"version": 7
}

91
flake.nix Normal file
View file

@ -0,0 +1,91 @@
{
description = "My Streamdeck";
inputs = {
nixpkgs = {
url = "nixpkgs/nixos-22.11";
};
flake-utils = {
url = "github:numtide/flake-utils";
};
};
outputs = { self, nixpkgs, flake-utils, ... }@inputs:
flake-utils.lib.eachDefaultSystem
(system:
let
pkgs = import nixpkgs {
inherit system;
};
in
{
devShells.default =
let
python = pkgs.python310.withPackages (ps: with ps; [
poetry
]);
in
pkgs.mkShell {
buildInputs = [
python
pkgs.hidapi
pkgs.libusb1
];
shellHook = ''
export HIDAPI_HOME=${pkgs.hidapi}
export MAGICK_HOME=${pkgs.imagemagickBig}
export POETRY_VIRTUALENVS_IN_PROJECT=true
export PS1='\[\033[1;34m\][greendeck:\w]\$\[\033[0m\] '
export PATH=''$(pwd)/.venv/bin:$PATH
'';
};
packages = {
greendeck = pkgs.poetry2nix.mkPoetryApplication {
python = pkgs.python310;
projectDir = ./.;
propagatedBuildInputs = [
pkgs.hidapi
];
postPatch = ''
substituteInPlace greendeck/lib/hidapi/library.py \
--replace \
'os.getenv("HIDAPI_LIBRARY")' \
'"${pkgs.hidapi}/lib/libhidapi-libusb.so.0"'
'';
overrides = pkgs.poetry2nix.overrides.withDefaults
(
self: super: {
wand = super.wand.overridePythonAttrs
(
old: {
postPatch = ''
substituteInPlace wand/api.py \
--replace \
"os.environ.get('MAGICK_HOME')" \
"'${pkgs.imagemagickBig}'"
'';
propagatedBuildInputs = old.propagatedBuildInputs ++ [ pkgs.imagemagickBig ];
}
);
types-deprecated = super.types-deprecated.overridePythonAttrs (
old: {
buildInputs = old.buildInputs ++ [ pkgs.python310Packages.setuptools ];
}
);
pydantic-yaml = super.pydantic-yaml.overridePythonAttrs (
old: {
buildInputs = old.buildInputs ++ [ pkgs.python310Packages.setuptools ];
}
);
pydocstringformatter = super.pydocstringformatter.overridePythonAttrs (
old: {
buildInputs = old.buildInputs ++ [ pkgs.python310Packages.setuptools ];
}
);
}
);
};
};
default = self.packages.${system}.greendeck;
}
);
}

0
greendeck/__init__.py Normal file
View file

136
greendeck/config.py Normal file
View file

@ -0,0 +1,136 @@
from typing import Annotated, Literal, Union
from pydantic import BaseModel, Field, ValidationError, root_validator, validator
from pydantic.color import Color
from pydantic_yaml import YamlModel
from typing_extensions import Self
class HomeAssistantConfig(BaseModel):
token: str
hostname: str
port: int | None
secure: bool = True
@validator("port")
def check_port(cls, v):
if v <= 0 or v >= 65536:
raise ValidationError("port must be greater than 0 and less than 65536")
return v
class StreamDeckConfig(BaseModel):
index: int | None
serial_number: str | None
brightness: int | float
screensaver: int
screen: str
@root_validator
def check_index_serial_number(cls: type[Self], values: dict):
index = values.get("index")
serial_number = values.get("serial_number")
if index is None and serial_number is None:
raise ValidationError("must set either index or serial_number")
if index is not None and serial_number is not None:
raise ValidationError("cannot set both index and serial_number")
return values
@validator("brightness")
def check_brightness(cls: type[Self], v: int | float) -> int | float:
if isinstance(v, int):
if v < 0 or v > 100:
raise ValidationError("brightness")
return v
if isinstance(v, float):
if v < 0.0 or v > 1.0:
raise ValidationError("brightness")
return v
raise ValidationError("brightness must be an int or a float")
class ColorConfig(BaseModel):
foreground: Color
background: Color
# class HomeAssistantIconImageStateConfig(BaseModel):
# state: str | None
# icon: str
# up: ColorConfig
# down: ColorConfig
class ImageConfig(BaseModel):
icon: str
up: ColorConfig
down: ColorConfig
class HomeAssistantIconImageConfig(BaseModel):
type: Literal["homeassistant-icon"]
entity_id: str
states: dict[str | None, ImageConfig]
@root_validator
def check_states(cls: type[Self], values: dict) -> dict:
states = values.get("states")
if None not in states:
raise ValidationError("must define default state by using '~' in yaml")
return values
class StaticIconImageConfig(ImageConfig):
type: Literal["static-icon"]
# icon: str
# up: ColorConfig
# down: ColorConfig
class ImageTextConfig(ImageConfig):
icon: str
text: str
class StaticTextIconImageConfig(ImageTextConfig):
type: Literal["static-icon-text"]
class HomeAssistantServiceActionConfig(BaseModel):
type: Literal["homeassistant-service"]
domain: str
service: str
data: dict
class PulseAudioActionConfig(BaseModel):
type: Literal["pulseaudio-action"]
application_name: str
action: Literal["volume-up", "volume-down", "toggle-mute"]
class ActionConfig(BaseModel):
__root__: Annotated[
Union[HomeAssistantServiceActionConfig, PulseAudioActionConfig],
Field(discriminator="type"),
]
ImageTypes = Annotated[
Union[
StaticIconImageConfig, StaticTextIconImageConfig, HomeAssistantIconImageConfig
],
Field(discriminator="type"),
]
class TileConfig(BaseModel):
position: tuple[int, int]
image: ImageTypes
actions: list[ActionConfig]
class Config(YamlModel):
homeassistant: HomeAssistantConfig
streamdecks: list[StreamDeckConfig]
screens: dict[str, list[TileConfig]]

0
greendeck/lib/__init__.py Normal file
View file

0
greendeck/lib/actions/__init__.py Normal file
View file

90
greendeck/lib/actions/pulseaudio.py Normal file
View file

@ -0,0 +1,90 @@
import asyncio
import json
from greendeck.config import PulseAudioActionConfig
async def get_sink_info(
action_config: PulseAudioActionConfig,
) -> tuple[int | None, int | None]:
proc = await asyncio.create_subprocess_exec(
"pactl",
*["--format=json", "list", "sink-inputs"],
stdin=asyncio.subprocess.DEVNULL,
stdout=asyncio.subprocess.PIPE,
stderr=asyncio.subprocess.STDOUT,
)
stdout, stderr = await proc.communicate()
if proc.returncode != 0:
print(f"error {proc.returncode}")
print(stderr)
return None, None
data = json.loads(stdout)
index = None
for entry in data:
if entry["properties"]["application.name"] == action_config.application_name:
index = entry["index"]
volume = int(
round(
sum([v["value"] for v in entry["volume"].values()])
/ len(entry["volume"]),
0,
)
)
print(index, volume, entry["volume"])
return index, volume
print(f"unable to locate sink {action_config.application_name}")
return None, None
volume_step = int(round(0x10000 * 0.05, 0))
async def handle_pulseaudio_action(
action_config: PulseAudioActionConfig,
) -> None:
index, volume = await get_sink_info(action_config)
if index is None:
return
match action_config.action:
case "volume-up":
new_volume = min(volume + volume_step, 0x10000)
command = [
"set-sink-input-volume",
f"{index}",
f"{new_volume}",
]
case "volume-down":
new_volume = max(volume - volume_step, 0x00000)
command = [
"set-sink-input-volume",
f"{index}",
f"{new_volume}",
]
case "toggle-mute":
command = ["set-sink-input-mute", f"{index}", "toggle"]
case _:
print(f"unknown action {action_config.action}")
return
proc = await asyncio.create_subprocess_exec(
"pactl",
*command,
stdin=asyncio.subprocess.DEVNULL,
stdout=asyncio.subprocess.PIPE,
stderr=asyncio.subprocess.PIPE,
)
stdout, stderr = await proc.communicate()
if proc.returncode != 0:
print(f"retcode: {proc.returncode}")
print(stdout)
print(stderr)
index, volume = await get_sink_info(action_config)

44
greendeck/lib/elgato/__init__.py Normal file
View file

@ -0,0 +1,44 @@
"""Elgato StreamDeck Python Library."""
from enum import IntEnum
from greendeck.lib.elgato.streamdeck import StreamDeck
from greendeck.lib.elgato.streamdeck.original_v2 import StreamDeckOriginalV2
from greendeck.lib.hidapi.device import enumerate_devices
class VendorIDs(IntEnum):
"""Elgato StreamDeck USB Vendor IDs."""
USB_VID_ELGATO = 0x0FD9
class ProductIDs(IntEnum):
"""Elgato StreamDeck USB product IDs."""
USB_PID_STREAMDECK_ORIGINAL = 0x0060
USB_PID_STREAMDECK_ORIGINAL_V2 = 0x006D
USB_PID_STREAMDECK_MINI = 0x0063
USB_PID_STREAMDECK_XL = 0x006C
USB_PID_STREAMDECK_XL_V2 = 0x008F
USB_PID_STREAMDECK_MK2 = 0x0080
USB_PID_STREAMDECK_PEDAL = 0x0086
USB_PID_STREAMDECK_MINI_MK2 = 0x0090
USB_PID_STREAMDECK_PLUS = 0x0084
async def enumerate_streamdecks() -> list[StreamDeck]:
"""Return a list of StreamDecks installed on the system."""
streamdecks: list[StreamDeck] = []
for device in await enumerate_devices():
match (device.vendor_id, device.product_id):
case (
VendorIDs.USB_VID_ELGATO,
ProductIDs.USB_PID_STREAMDECK_ORIGINAL_V2,
):
streamdecks.append(StreamDeckOriginalV2(device))
case _:
pass
return streamdecks

385
greendeck/lib/elgato/streamdeck/__init__.py Normal file
View file

@ -0,0 +1,385 @@
# Python Stream Deck Library
# Released under the MIT license
#
# dean [at] fourwalledcubicle [dot] com
# www.fourwalledcubicle.com
#
from abc import ABC
from abc import abstractmethod
import asyncio
from enum import Enum
from enum import auto
from typing import Any
from typing import Awaitable
from typing import Callable
from typing_extensions import Self
from greendeck.lib.hidapi.device import Device
from greendeck.lib.util import task_done_callback
# def print_done(future: asyncio.Future):
# print("done", future)
class KeyDirection(Enum):
LTR = auto()
RTL = auto()
class StreamDeck(ABC):
"""
Represents a physically attached StreamDeck device.
"""
KEY_COLS: int | None = None
KEY_ROWS: int | None = None
KEY_PIXEL_WIDTH: int | None = None
KEY_PIXEL_HEIGHT: int | None = None
KEY_IMAGE_FORMAT: str | None = None
KEY_FLIP: tuple[bool, bool] = None
KEY_ROTATION: int = None
KEY_DIRECTION: KeyDirection | None = None
ENCODER_COUNT: int = 0
DECK_TYPE: str | None = None
DECK_VISUAL: bool | None = None
BLANK_KEY_IMAGE: bytes | None = None
_serial_number: str | None = None
_firmware_version: str | None = None
device: Device
last_key_states: list[bool | None]
key_callback: Callable[[Self, int, bool, bool], Awaitable[None]]
mutex: asyncio.Lock
read_task: asyncio.Task
run_read_task: bool
def __init__(self, device: Device):
self.device = device
self.last_key_states = [None] * self.KEY_COUNT
self.read_task = None
self.run_read_task = False
self.key_callback = None
self.mutex = asyncio.Lock()
def __del__(self):
"""
Delete handler for the StreamDeck, automatically closing the transport
if it is currently open and terminating the transport reader thread.
"""
if self.read_task is not None:
self.read_task.cancel()
@property
def KEY_COUNT(self) -> int:
return self.KEY_COLS * self.KEY_ROWS
@property
def serial_number(self) -> str:
return self.device.device_info.serial_number
async def handleKeyReport(self: Self, new_key_states: list[bool] | None) -> None:
if new_key_states is None:
return
if self.key_callback is not None:
for key, (old_state, new_state) in enumerate(
zip(self.last_key_states, new_key_states)
):
if old_state is not None and (old_state ^ new_state):
if self.key_callback is not None:
t = asyncio.create_task(
self.key_callback(self, key, old_state, new_state),
name=(
f"callback for key {key} keypress "
f"{old_state} → {new_state} on "
f"streamdeck {self.serial_number}"
),
)
t.add_done_callback(task_done_callback)
self.last_key_states = new_key_states
@abstractmethod
async def _reset_key_stream(self: Self):
"""
Sends a blank key report to the StreamDeck, resetting the key image
streamer in the device. This prevents previously started partial key
writes that were not completed from corrupting images sent from this
application.
"""
pass
def _extract_string(self: Self, data: bytes) -> str:
"""
Extracts out a human-readable string from a collection of raw bytes,
removing any trailing whitespace or data after the first NUL byte.
"""
return str(data, "ascii", "replace").partition("\0")[0].rstrip()
@abstractmethod
async def _read(self: Self) -> None:
"""
Read handler for the underlying transport, listening for button state
changes on the underlying device, caching the new states and firing off
any registered callbacks.
"""
pass
async def _setup_reader(self: Self) -> None:
"""
Sets up the internal transport reader thread with the given callback,
for asynchronous processing of HID events from the device. If the thread
already exists, it is terminated and restarted with the new callback
function.
:param function callback: Callback to run on the reader thread.
"""
if self.read_task is not None:
self.run_read_task = False
self.read_task.cancel()
await self.read_task
self.run_read_task = True
self.read_task = asyncio.create_task(
self._read(), name=f"read task for streamdeck {self.serial_number}"
)
self.read_task.add_done_callback(task_done_callback)
async def open(self):
"""
Opens the device for input/output. This must be called prior to setting
or retrieving any device state.
.. seealso:: See :func:`~StreamDeck.close` for the corresponding close method.
"""
await self.device.open()
await self._reset_key_stream()
await self._setup_reader()
async def close(self):
"""
Closes the device for input/output.
.. seealso:: See :func:`~StreamDeck.open` for the corresponding open method.
"""
await self.device.close()
async def is_open(self) -> bool:
"""
Indicates if the StreamDeck device is currently open and ready for use.
:rtype: bool
:return: `True` if the deck is open, `False` otherwise.
"""
return await self.device.is_open()
async def connected(self) -> bool:
"""
Indicates if the physical StreamDeck device this instance is attached to
is still connected to the host.
:rtype: bool
:return: `True` if the deck is still connected, `False` otherwise.
"""
return await self.device.connected()
def id(self) -> str:
"""
Retrieves the physical ID of the attached StreamDeck. This can be used
to differentiate one StreamDeck from another.
:rtype: str
:return: Identifier for the attached device.
"""
return self.device.path()
# def key_count(self) -> int:
# """
# Retrieves number of physical buttons on the attached StreamDeck device.
# :rtype: int
# :return: Number of physical buttons.
# """
# return self.KEY_COUNT
# def deck_type(self) -> str:
# """
# Retrieves the model of Stream Deck.
# :rtype: str
# :return: String containing the model name of the StreamDeck device..
# """
# return self.DECK_TYPE
# def is_visual(self) -> bool:
# """
# Returns whether the Stream Deck has a visual display output.
# :rtype: bool
# :return: `True` if the deck has a screen, `False` otherwise.
# """
# return self.DECK_VISUAL
@property
def key_size(self: Self) -> tuple[int, int]:
return (self.KEY_PIXEL_WIDTH, self.KEY_PIXEL_HEIGHT)
def convert_key_to_position(self: Self, key: int) -> tuple[int, int]:
match self.KEY_DIRECTION:
case KeyDirection.LTR:
x = key % self.KEY_COLS
y = self.KEY_ROWS - (key // self.KEY_COLS) - 1
return x, y
case _:
raise ValueError("unsupported key direction")
def key_layout(self) -> tuple[int, int]:
"""
Retrieves the physical button layout on the attached StreamDeck device.
:rtype: (int, int)
:return (rows, columns): Number of button rows and columns.
"""
return self.KEY_ROWS, self.KEY_COLS
def key_image_format(self) -> dict:
"""
Retrieves the image format accepted by the attached StreamDeck device.
Images should be given in this format when setting an image on a button.
.. seealso:: See :func:`~StreamDeck.set_key_image` method to update the
image displayed on a StreamDeck button.
:rtype: dict()
:return: Dictionary describing the various image parameters
(size, image format, image mirroring and rotation).
"""
return {
"size": (self.KEY_PIXEL_WIDTH, self.KEY_PIXEL_HEIGHT),
"format": self.KEY_IMAGE_FORMAT,
"flip": self.KEY_FLIP,
"rotation": self.KEY_ROTATION,
}
# def set_poll_frequency(self, hz: int) -> None:
# """
# Sets the frequency of the button polling reader thread, determining how
# often the StreamDeck will be polled for button changes.
# A higher frequency will result in a higher CPU usage, but a lower
# latency between a physical button press and a event from the library.
# :param int hz: Reader thread frequency, in Hz (1-1000).
# """
# self.read_poll_hz = min(max(hz, 1), 1000)
def set_key_callback(
self, callback: Callable[[Any, int, bool, bool], Awaitable[None]]
) -> None:
"""
Sets the callback function called each time a button on the StreamDeck
changes state (either pressed, or released).
.. note:: This callback will be fired from an internal reader thread.
Ensure that the given callback function is thread-safe.
.. note:: Only one callback can be registered at one time.
.. seealso:: See :func:`~StreamDeck.set_key_callback_async` method for
a version compatible with Python 3 `asyncio` asynchronous
functions.
:param function callback: Callback function to fire each time a button
state changes.
"""
self.key_callback = callback
def key_states(self) -> list[bool]:
"""
Retrieves the current states of the buttons on the StreamDeck.
:rtype: list(bool)
:return: List describing the current states of each of the buttons on
the device (`True` if the button is being pressed, `False`
otherwise).
"""
return self.last_key_states
@abstractmethod
async def reset(self):
"""
Resets the StreamDeck, clearing all button images and showing the
standby image.
"""
pass
@abstractmethod
async def set_brightness(self, percent: int | float):
"""
Sets the global screen brightness of the StreamDeck, across all the
physical buttons.
:param int/float percent: brightness percent, from [0-100] as an `int`,
or normalized to [0.0-1.0] as a `float`.
"""
pass
@abstractmethod
async def get_serial_number(self) -> str:
"""
Gets the serial number of the attached StreamDeck.
:rtype: str
:return: String containing the serial number of the attached device.
"""
pass
@abstractmethod
async def get_firmware_version(self) -> str:
"""
Gets the firmware version of the attached StreamDeck.
:rtype: str
:return: String containing the firmware version of the attached device.
"""
pass
@abstractmethod
async def set_key_image(self, key: int, image: bytes) -> None:
"""
Sets the image of a button on the StreamDeck to the given image. The
image being set should be in the correct format for the device, as an
enumerable collection of bytes.
.. seealso:: See :func:`~StreamDeck.get_key_image_format` method for
information on the image format accepted by the device.
:param int key: Index of the button whose image is to be updated.
:param enumerable image: Raw data of the image to set on the button.
If `None`, the key will be cleared to a black
color.
"""
pass

183
greendeck/lib/elgato/streamdeck/gen2.py Normal file
View file

@ -0,0 +1,183 @@
import asyncio
import struct
from typing_extensions import Self
from greendeck.lib.elgato.streamdeck import StreamDeck
from greendeck.lib.hidapi.library import HIDAPIError
from greendeck.lib.util import task_done_callback
class StreamDeckGen2Base(StreamDeck):
MAX_PACKET_SIZE: int = 1024
async def _read(self: Self) -> None:
try:
while self.run_read_task:
data = await self.device.read(64)
if data is None:
continue
match data[0]:
case 0x01:
key_count = data[2]
states = [bool(s) for s in data[4 : 4 + key_count]]
t = asyncio.create_task(self.handleKeyReport(states))
t.add_done_callback(task_done_callback)
case 0x02:
# lcd input
# position1 = struct.unpack("<HH", data[5:9])
match data[3]:
case 0x01:
# short press
pass
case 0x02:
# long press
pass
case 0x03:
# swipe
# position2 = struct.unpack("<HH", data[9:12])
pass
case x:
print(f"unknown lcd input type {x}")
case 0x03:
# encoder
match data[3]:
case 0x00:
# encoder press/release
pass
case 0x01:
# rotate
pass
case x:
print(f"unknown input report type {x}")
except HIDAPIError:
print("HIDAPI Error")
self.run_read_thread = False
return
except asyncio.CancelledError:
print("cancelled")
self.run_read_thread = False
return
async def _reset_key_stream(self) -> None:
async with self.mutex:
payload = struct.pack(f"<B{self.MAX_PACKET_SIZE-1}x", 0x02)
await self.device.write(payload)
async def reset(self) -> None:
async with self.mutex:
payload = struct.pack("<BB30x", 0x03, 0x02)
# payload = b"\x03\x02" + (b"\x00" * 30)
await self.device.write_feature(payload)
async def set_brightness(self, percent: int | float):
"""
Sets the global screen brightness of the StreamDeck, across all the
physical buttons.
:param int/float percent: brightness percent, from [0-100] as an `int`,
or normalized to [0.0-1.0] as a `float`.
"""
async with self.mutex:
if isinstance(percent, float):
percent = int(round(100.0 * percent, 0))
percent = min(max(percent, 0), 100)
payload = struct.pack("<BBB29x", 0x03, 0x08, percent)
# payload = b"\x03\x08" + percent + (b"\x00" * 29)
await self.device.write_feature(payload)
async def get_serial_number(self) -> str:
"""
Gets the serial number of the attached StreamDeck.
:rtype: str
:return: String containing the serial number of the attached device.
"""
if self._serial_number is not None:
return self._serial_number
async with self.mutex:
if self._serial_number is None:
data = await self.device.read_feature(0x06, 32)
self._serial_number = self._extract_string(data[2:])
return self._serial_number
async def get_firmware_version(self) -> str:
"""
Gets the firmware version of the attached StreamDeck.
:rtype: str
:return: String containing the firmware version of the attached device.
"""
if self._firmware_version is not None:
return self._firmware_version
async with self.mutex:
if self._firmware_version is None:
data = await self.device.read_feature(0x05, 32)
self._firmware_version = self._extract_string(data[6:])
return self._firmware_version
async def set_key_image(self, key: int, image: bytes | None) -> None:
"""
Sets the image of a button on the StreamDeck to the given image. The
image being set should be in the correct format for the device, as an
enumerable collection of bytes.
.. seealso:: See :func:`~StreamDeck.get_key_image_format` method for
information on the image format accepted by the device.
:param int key: Index of the button whose image is to be updated.
:param enumerable image: Raw data of the image to set on the button.
If `None`, the key will be cleared to a black
color.
"""
IMAGE_REPORT_HEADER_LENGTH = struct.calcsize("<BBBBHH")
IMAGE_REPORT_PAYLOAD_LENGTH = self.MAX_PACKET_SIZE - IMAGE_REPORT_HEADER_LENGTH
async with self.mutex:
if min(max(key, 0), self.KEY_COUNT) != key:
raise IndexError("Invalid key index {}.".format(key))
image = bytes(image or self.BLANK_KEY_IMAGE)
page_number = 0
bytes_remaining = len(image)
while bytes_remaining > 0:
page_length = min(bytes_remaining, IMAGE_REPORT_PAYLOAD_LENGTH)
bytes_sent = page_number * IMAGE_REPORT_PAYLOAD_LENGTH
last_page = 1 if page_length == bytes_remaining else 0
header = struct.pack(
"<BBBBHH",
0x02,
0x07,
key,
last_page,
page_length,
page_number,
)
payload = header + image[bytes_sent : bytes_sent + page_length]
padding = b"\x00" * (self.MAX_PACKET_SIZE - len(payload))
await self.device.write(payload + padding)
bytes_remaining = bytes_remaining - page_length
page_number = page_number + 1

26
greendeck/lib/elgato/streamdeck/original_v2.py Normal file
View file

@ -0,0 +1,26 @@
import importlib.resources
from greendeck.lib.elgato.streamdeck import KeyDirection
from greendeck.lib.elgato.streamdeck import resources
from greendeck.lib.elgato.streamdeck.gen2 import StreamDeckGen2Base
class StreamDeckOriginalV2(StreamDeckGen2Base):
"""
Represents a physically attached StreamDeck Original (V2) device.
"""
KEY_COLS = 5
KEY_ROWS = 3
KEY_PIXEL_WIDTH = 72
KEY_PIXEL_HEIGHT = 72
KEY_IMAGE_FORMAT = "JPEG"
KEY_FLIP = (True, True)
KEY_ROTATION = 0
KEY_DIRECTION = KeyDirection.LTR
DECK_TYPE = "StreamDeck Original (V2)"
DECK_VISUAL = True
BLANK_KEY_IMAGE = importlib.resources.read_binary(resources, "72x72.jpeg")

73
greendeck/lib/elgato/streamdeck/plus.py Normal file
View file

@ -0,0 +1,73 @@
import importlib.resources
import struct
from greendeck.lib.elgato.streamdeck import KeyDirection
from greendeck.lib.elgato.streamdeck import resources
from greendeck.lib.elgato.streamdeck.gen2 import StreamDeckGen2Base
class StreamDeckPlus(StreamDeckGen2Base):
"""
Represents a physically attached StreamDeck+ device.
"""
KEY_COLS = 4
KEY_ROWS = 2
KEY_PIXEL_WIDTH = 120
KEY_PIXEL_HEIGHT = 120
KEY_IMAGE_FORMAT = "JPEG"
KEY_FLIP = (True, True)
KEY_ROTATION = 0
KEY_DIRECTION = KeyDirection.LTR
ENCODER_COUNT = 4
LCD_STRIP_WIDTH = 800
LCD_STRIP_HEIGHT = 100
DECK_TYPE = "StreamDeck+"
DECK_VISUAL = True
IMAGE_REPORT_LENGTH = 1024
IMAGE_REPORT_HEADER_LENGTH = 8
BLANK_KEY_IMAGE = importlib.resources.read_binary(resources, "120x120.jpeg")
async def set_lcd_image(
self, key: int, image: bytes, x: int, y: int, width: int, height: int
) -> None:
""" """
if min(max(key, 0), self.KEY_COUNT) != key:
raise IndexError("Invalid key index {}.".format(key))
header_definition = "<BBHHHHBHHx"
PACKET_HEADER_LENGTH = struct.calcsize(header_definition)
MAX_PAYLOAD_SIZE = self.MAX_PACKET_SIZE - PACKET_HEADER_LENGTH
async with self.mutex:
page_number = 0
bytes_remaining = len(image)
while bytes_remaining > 0:
page_length = min(bytes_remaining, MAX_PAYLOAD_SIZE)
bytes_sent = page_number * MAX_PAYLOAD_SIZE
last_page = 1 if page_length == bytes_remaining else 0
header = struct.pack(
header_definition,
0x02,
0x0C,
x,
y,
width,
height,
last_page,
page_number,
page_length,
)
payload = header + image[bytes_sent : bytes_sent + page_length]
padding = b"\x00" * (self.MAX_PACKET_SIZE - len(payload))
await self.device.write(payload + padding)
bytes_remaining = bytes_remaining - page_length
page_number = page_number + 1

BIN
greendeck/lib/elgato/streamdeck/resources/120x120.jpeg Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 882 B

BIN
greendeck/lib/elgato/streamdeck/resources/72x72.jpeg Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 726 B

0
greendeck/lib/elgato/streamdeck/resources/__init__.py Normal file
View file

2
greendeck/lib/hidapi/__init__.py Normal file
View file

@ -0,0 +1,2 @@
class HIDAPIError(Exception):
pass

170
greendeck/lib/hidapi/device.py Normal file
View file

@ -0,0 +1,170 @@
from greendeck.lib.hidapi.library import DeviceInfo
from greendeck.lib.hidapi.library import Handle
from greendeck.lib.hidapi.library import hid_close_device
from greendeck.lib.hidapi.library import hid_enumerate
from greendeck.lib.hidapi.library import hid_get_feature_report
from greendeck.lib.hidapi.library import hid_open_device
from greendeck.lib.hidapi.library import hid_read
from greendeck.lib.hidapi.library import hid_send_feature_report
from greendeck.lib.hidapi.library import hid_write
__all__ = ["Device", "DeviceInfo", "enumerate_devices"]
class Device:
device_info: DeviceInfo
device_handle: Handle | None
def __init__(self, device_info: DeviceInfo):
"""
Creates a new HID device instance, used to send and receive HID
reports from/to an attached USB HID device.
:param dict() device_info: Device information dictionary describing
a single unique attached USB HID device.
"""
self.device_info = device_info
self.device_handle = None
async def open(self) -> None:
"""
Opens the HID device for input/output. This must be called prior to
sending or receiving any HID reports.
.. seealso:: See :func:`~HID.Device.close` for the corresponding
close method.
"""
if self.device_handle:
return
self.device_handle = await hid_open_device(self.device_info.path)
async def close(self) -> None:
"""
Closes the HID device for input/output.
.. seealso:: See :func:`~~HID.Device.open` for the corresponding
open method.
"""
if self.device_handle:
self.device_handle, device_handle = None, self.device_handle
await hid_close_device(device_handle)
async def is_open(self) -> bool:
"""
Indicates if the physical device object this instance is attached
to has been opened by the host.
:rtype: bool
:return: `True` if the device is open, `False` otherwise.
"""
return self.device_handle is not None
async def connected(self) -> bool:
"""
Indicates if the physical HID device this instance is attached to
is still connected to the host.
:rtype: bool
:return: `True` if the device is still connected, `False` otherwise.
"""
return any([d.path == self.path for d in await hid_enumerate()])
@property
def path(self) -> str:
"""
Retrieves the logical path of the attached HID device within the
current system. This can be used to differentiate one HID device
from another.
:rtype: str
:return: Logical device path for the attached device.
"""
return self.device_info.path
@property
def serial_number(self) -> int:
return self.device_info.serial_number
@property
def vendor_id(self) -> int:
return self.device_info.vendor_id
@property
def product_id(self) -> int:
return self.device_info.product_id
async def write_feature(self, payload: bytes) -> int:
"""
Sends a HID Feature report to the open HID device.
:param enumerable() payload: Enumerate list of bytes to send to the
device, as a feature report. The first
byte of the report should be the Report
ID of the report being sent.
:rtype: int
:return: Number of bytes successfully sent to the device.
"""
return await hid_send_feature_report(self.device_handle, payload)
async def read_feature(self, report_id: int, length: int) -> bytes:
"""
Reads a HID Feature report from the open HID device.
:param int report_id: Report ID of the report being read.
:param int length: Maximum length of the Feature report to read..
:rtype: bytes
:return: List of bytes containing the read Feature report. The
first byte of the report will be the Report ID of the
report that was read.
"""
return await hid_get_feature_report(self.device_handle, report_id, length)
async def write(self, payload: bytes) -> int:
"""
Sends a HID Out report to the open HID device.
:param bytes payload: bytes to send to the
device, as an Out report. The first
byte of the report should be the Report
ID of the report being sent.
:rtype: int
:return: Number of bytes successfully sent to the device.
"""
return await hid_write(self.device_handle, payload)
async def read(self, length: int) -> bytes | None:
"""
Performs a non-blocking read of a HID In report from the open HID device.
:param int length: Maximum length of the In report to read.
:rtype: bytes
:return: bytes containing the read In report. The first byte
of the report will be the Report ID of the report that was
read.
"""
return await hid_read(self.device_handle, length)
async def enumerate_devices(
vendor_id: int | None = None, product_id: int | None = None
) -> list[Device]:
return [
Device(device_info)
for device_info in await hid_enumerate(
vendor_id=vendor_id, product_id=product_id
)
]

366
greendeck/lib/hidapi/library.py Normal file
View file

@ -0,0 +1,366 @@
import asyncio
import atexit
import ctypes
import os
import platform
from typing import Any
from typing import TypeVar
from pydantic import BaseModel
from greendeck.lib.hidapi import HIDAPIError
Handle = TypeVar("Handle", bound=ctypes.c_void_p)
# mutex: asyncio.Lock = None
LOOP: asyncio.AbstractEventLoop = None
LIBRARY: ctypes.CDLL = None
class DeviceInfo(BaseModel):
path: str
serial_number: str | None
vendor_id: int
product_id: int
release_number: int
product_string: str | None
usage_page: int
usage: int
interface_number: int
class hid_device_info(ctypes.Structure):
"""
Structure definition for the hid_device_info structure defined
in the LibUSB HIDAPI library API.
"""
pass
hid_device_info._fields_ = [
("path", ctypes.c_char_p),
("vendor_id", ctypes.c_ushort),
("product_id", ctypes.c_ushort),
("serial_number", ctypes.c_wchar_p),
("release_number", ctypes.c_ushort),
("manufacturer_string", ctypes.c_wchar_p),
("product_string", ctypes.c_wchar_p),
("usage_page", ctypes.c_ushort),
("usage", ctypes.c_ushort),
("interface_number", ctypes.c_int),
("next", ctypes.POINTER(hid_device_info)),
]
def _get_library_search_list():
if (hidapi_library := os.getenv("HIDAPI_LIBRARY")) is not None:
return [hidapi_library]
if (hidapi_home := os.getenv("HIDAPI_HOME")) is not None:
return [
os.path.join(hidapi_home, "lib", "libhidapi-libusb.so.0"),
]
library_search_list = {
"Windows": ["hidapi.dll", "libhidapi-0.dll"],
"Linux": [
"libhidapi-libusb.so",
"libhidapi-libusb.so.0",
],
"Darwin": ["libhidapi.dylib"],
}.get(platform.system())
if library_search_list is None:
raise HIDAPIError(
"No suitable LibUSB HIDAPI library search names were found for this system."
)
return library_search_list
def _find_hidapi_libary() -> ctypes.CDLL:
for lib_name in _get_library_search_list():
try:
return ctypes.cdll.LoadLibrary(lib_name)
except OSError as e:
print(e)
pass
if LIBRARY is None:
raise HIDAPIError("No suitable LibUSB HIDAPI library found on this system.")
def _load_hidapi_library():
"""
Loads the given LibUSB HIDAPI dynamic library from the host system,
if available.
:rtype: ctypes.CDLL
:return: Loaded HIDAPI library instance, or None if no library was found.
"""
global LIBRARY
if LIBRARY is not None:
return
LIBRARY = _find_hidapi_libary()
LIBRARY.hid_init.argtypes = []
LIBRARY.hid_init.restype = ctypes.c_int
LIBRARY.hid_exit.argtypes = []
LIBRARY.hid_exit.restype = ctypes.c_int
LIBRARY.hid_enumerate.argtypes = [ctypes.c_ushort, ctypes.c_ushort]
LIBRARY.hid_enumerate.restype = ctypes.POINTER(hid_device_info)
LIBRARY.hid_free_enumeration.argtypes = [ctypes.POINTER(hid_device_info)]
LIBRARY.hid_free_enumeration.restype = None
LIBRARY.hid_open_path.argtypes = [ctypes.c_char_p]
LIBRARY.hid_open_path.restype = ctypes.c_void_p
LIBRARY.hid_close.argtypes = [ctypes.c_void_p]
LIBRARY.hid_close.restype = None
LIBRARY.hid_set_nonblocking.argtypes = [ctypes.c_void_p, ctypes.c_int]
LIBRARY.hid_set_nonblocking.restype = ctypes.c_int
LIBRARY.hid_send_feature_report.argtypes = [
ctypes.c_void_p,
ctypes.POINTER(ctypes.c_char),
ctypes.c_size_t,
]
LIBRARY.hid_send_feature_report.restype = ctypes.c_int
LIBRARY.hid_get_feature_report.argtypes = [
ctypes.c_void_p,
ctypes.POINTER(ctypes.c_char),
ctypes.c_size_t,
]
LIBRARY.hid_get_feature_report.restype = ctypes.c_int
LIBRARY.hid_write.argtypes = [
ctypes.c_void_p,
ctypes.POINTER(ctypes.c_char),
ctypes.c_size_t,
]
LIBRARY.hid_write.restype = ctypes.c_int
LIBRARY.hid_read.argtypes = [
ctypes.c_void_p,
ctypes.POINTER(ctypes.c_char),
ctypes.c_size_t,
]
LIBRARY.hid_read.restype = ctypes.c_int
LIBRARY.hid_init()
atexit.register(LIBRARY.hid_exit)
async def run_in_executor(name: str, *args: tuple, **keywords: dict) -> Any:
global LOOP
global LIBRARY
if LOOP is None:
LOOP = asyncio.get_running_loop()
if LIBRARY is None:
_load_hidapi_library()
func = LIBRARY.__getattribute__(name)
return await LOOP.run_in_executor(None, func, *args, **keywords)
async def hid_enumerate(
vendor_id: int | None = None, product_id: int | None = None
) -> list[DeviceInfo]:
"""
Enumerates all available USB HID devices on the system.
:param int vid: USB Vendor ID to filter all devices by, `None` if the
device list should not be filtered by vendor.
:param int pid: USB Product ID to filter all devices by, `None` if the
device list should not be filtered by product.
:rtype: list(dict())
:return: List of discovered USB HID device attributes.
"""
vendor_id = vendor_id or 0
product_id = product_id or 0
device_list: list[dict] = []
device_enumeration: hid_device_info = await run_in_executor(
"hid_enumerate", vendor_id, product_id
)
if device_enumeration:
current_device = device_enumeration
while current_device:
device_list.append(
DeviceInfo(
path=current_device.contents.path.decode("utf-8"),
vendor_id=current_device.contents.vendor_id,
product_id=current_device.contents.product_id,
serial_number=current_device.contents.serial_number,
release_number=current_device.contents.release_number,
manufacturer_string=current_device.contents.manufacturer_string,
product_string=current_device.contents.product_string,
usage_page=current_device.contents.usage_page,
usage=current_device.contents.usage,
interface_number=current_device.contents.interface_number,
)
)
current_device = current_device.contents.next
await run_in_executor("hid_free_enumeration", device_enumeration)
return device_list
async def hid_open_device(path: str | bytes) -> Handle:
"""
Opens a HID device by its canonical path on the host system.
:rtype: Handle
:return: Device handle if opened successfully, None if open failed.
"""
if type(path) is not bytes:
path = bytes(path, "utf-8")
handle: Handle = await run_in_executor("hid_open_path", path)
if not handle:
raise HIDAPIError("Could not open HID device.")
return handle
async def hid_close_device(handle: Handle):
"""
Closes a HID device by its open device handle on the host system.
:param Handle handle: Device handle to close.
"""
if handle:
await run_in_executor("hid_close", handle)
async def hid_send_feature_report(handle: Handle, data: bytes) -> int:
"""
Sends a HID Feature report to an open HID device.
:param Handle handle: Device handle to access.
:param bytes data: Array of bytes to send to the device, as a
feature report. The first byte of the
report should be the Report ID of the
report being sent.
:rtype: int
:return: Number of bytes successfully sent to the device.
"""
if not handle:
raise HIDAPIError("No HID device.")
result: int = await run_in_executor(
"hid_send_feature_report", handle, data, len(data)
)
if result < 0:
raise HIDAPIError("Failed to write feature report (%d)" % result)
return result
async def hid_get_feature_report(handle: Handle, report_id: int, length: int) -> bytes:
"""
Retrieves a HID Feature report from an open HID device.
:param Handle handle: Device handle to access.
:param int report_id: Report ID of the report being read.
:param int length: Maximum length of the Feature report to read.
:rtype: bytes
:return: Array of bytes containing the read Feature report. The
first byte of the report will be the Report ID of the
report that was read.
"""
data = ctypes.create_string_buffer(length)
data[0] = report_id
if not handle:
raise HIDAPIError("No HID device.")
# loop = asyncio.get_event_loop()
result: int = await run_in_executor(
"hid_get_feature_report", handle, data, len(data)
)
if result < 0:
raise HIDAPIError("Failed to read feature report (%d)" % result)
return data.raw[:result]
async def hid_write(handle: Handle, data: bytes) -> int:
"""
Writes a HID Out report to an open HID device.
:param Handle handle: Device handle to access.
:param bytearray() data: Array of bytes to send to the device, as an
out report. The first byte of the report
should be the Report ID of the report being
sent.
:rtype: int
:return: Number of bytes successfully sent to the device.
"""
if not handle:
raise HIDAPIError("No HID device.")
result: int = await run_in_executor("hid_write", handle, data, len(data))
if result < 0:
raise HIDAPIError("Failed to write out report (%d)" % result)
return result
async def hid_read(handle: Handle, length: int) -> bytes | None:
"""
Performs a non-blocking read of a HID In report from an open HID device.
:param Handle handle: Device handle to access.
:param int length: Maximum length of the In report to read.
:rtype: bytes
:return: Array of bytes containing the read In report. The
first byte of the report will be the Report ID of the
report that was read.
"""
data = ctypes.create_string_buffer(length)
if not handle:
raise HIDAPIError("No HID device.")
result: int = await run_in_executor("hid_read", handle, data, len(data))
if result < 0:
raise HIDAPIError(f"Failed to read in report ({result})")
elif result == 0:
return None
return data.raw[:length]

314
greendeck/lib/homeassistant/__init__.py Normal file
View file

@ -0,0 +1,314 @@
"""Async interface to Home Assistant."""
import asyncio
import datetime
import logging
from pprint import pformat
from typing import Annotated
from typing import Any
from typing import Awaitable
from typing import Callable
from typing import Literal
from typing import Union
import aiohttp
from hyperlink import URL
from pydantic import BaseModel
from pydantic import Field
from pydantic import ValidationError
from pydantic import parse_obj_as
from pydantic import parse_raw_as
from pydantic import validator
from typing_extensions import Self
import websockets.client
import websockets.exceptions
from greendeck.lib.util import task_done_callback
logger = logging.getLogger(__name__)
cache = {}
entities = []
# LAST_ID: int = 0
# def generate_id() -> int:
# """Generate a unique ID for websocket reqeuests."""
# global LAST_ID # NOQA: pylint(global-statement)
# LAST_ID += 1
# return LAST_ID
class Request(BaseModel):
_last_id: int = 0
id: int | None
@validator("id", always=True)
def generate_id(cls: type[Self], v: int) -> int:
if v is None:
cls._last_id += 1
return cls._last_id
return v
class AuthRequest(BaseModel):
"""Websocket authentication request."""
type: str = "auth"
access_token: str
class AuthRequiredResponse(BaseModel):
"""Authentication required response."""
type: Literal["auth_required"]
ha_version: str
class AuthOKResponse(BaseModel):
"""Authentication OK response."""
type: Literal["auth_ok"]
ha_version: str
class SubscribeEventsRequest(Request):
"""Subscribe to events request."""
type: str = "subscribe_events"
event_type: str
class GetStatesRequest(Request):
type: str = "get_states"
class EventContext(BaseModel):
id: str
parent_id: str | None
user_id: str | None
class EventState(BaseModel):
entity_id: str
state: str
attributes: dict[str, Any]
context: EventContext | None
last_changed: datetime.datetime | None
last_updated: datetime.datetime | None
class EventData(BaseModel):
entity_id: str
new_state: EventState
old_state: EventState
class Event(BaseModel):
context: EventContext
data: EventData
event_type: str
origin: str
time_fired: datetime.datetime
class EventResponse(BaseModel):
type: Literal["event"]
id: int
event: Event
class ResultResponse(BaseModel):
type: Literal["result"]
id: int
result: Any
success: bool
Response = Annotated[
Union[AuthRequiredResponse, AuthOKResponse, ResultResponse, EventResponse],
Field(discriminator="type"),
]
class TargetData(BaseModel):
entity_id: str
class CallServiceRequest(Request):
type: str = "call_service"
domain: str
service: str
service_data: Any
target: TargetData
class HomeAssistant:
websocket: websockets.client.WebSocketClientProtocol
host: URL
port: int
secure: bool
token: str
last_id: int
event_callbacks: dict[str, set[Callable[[EventResponse], Awaitable[None]]]]
response_callbacks: dict[int, Callable[[ResultResponse], Awaitable[None]]]
websocket_task: asyncio.Task
def __init__(self: Self, host: str, port: int | None, secure: bool, token: str):
self.host = host
self.port = port if port is not None else 443 if secure else 80
self.secure = secure
self.token = token
self.last_id = 0
self.websocket = None
self.event_callbacks = {}
self.response_callbacks = {}
self.websocket_task = None
def generate_id() -> int:
global LAST_ID
LAST_ID += 1
return LAST_ID
def websocket_url(self: Self) -> URL:
return URL(
scheme="wss" if self.secure else "ws",
host=self.host,
port=self.port,
path=("api", "websocket"),
)
def rest_api_url(self: Self) -> URL:
return URL(
scheme="https" if self.secure else "http",
host=self.host,
port=self.port,
path=("api",),
)
def add_event_callback(
self: Self,
entity_id: str,
callback: Callable[[EventResponse], Awaitable[None]],
):
callbacks = self.event_callbacks.get(entity_id, set())
callbacks.add(callback)
self.event_callbacks[entity_id] = callbacks
async def call_service(
self, domain: str, service: str, data: dict
) -> list[EventState]:
async with aiohttp.ClientSession() as session:
async with session.post(
str(self.rest_api_url().child("services", domain, service)),
headers={
"Authorization": f"Bearer {self.token}",
"Content-Type": "application/json",
},
json=data,
) as response:
if response.status in [200, 201]:
data = await response.json()
return parse_obj_as(list[EventState], data)
else:
logger.error("Home Assistant REST API error:")
for line in (await response.text()).splitlines():
logger.error(line)
async def get_state(self: Self, entity_id: str) -> EventState | None:
async with aiohttp.ClientSession() as session:
async with session.get(
str(self.rest_api_url().child("states", entity_id)),
headers={
"Authorization": f"Bearer {self.token}",
"Content-Type": "application/json",
},
) as response:
if response.status in [200, 201]:
data = await response.read()
return parse_raw_as(EventState, data)
else:
print(response.status)
print(await response.text())
return
async def start(self: Self):
self.websocket_task = asyncio.create_task(self.websocket_runner())
self.websocket_task.add_done_callback(task_done_callback)
async def authenticated_callback(self: Self):
request = SubscribeEventsRequest(event_type="state_changed")
await self.websocket.send(request.json())
async def get_events_callback(self: Self, response: Response) -> None:
print(response.result)
async def websocket_runner(self: Self) -> None:
try:
async with websockets.client.connect(
str(self.websocket_url())
) as self.websocket:
async for message in self.websocket:
try:
response = parse_raw_as(Response, message)
# pprint(response)
match response.type:
case "auth_required":
await self.websocket.send(
AuthRequest(access_token=self.token).json()
)
case "auth_ok":
t = asyncio.create_task(
self.authenticated_callback(),
name="authenticaion ok callback",
)
t.add_done_callback(task_done_callback)
case "event":
if (
response.event.data.entity_id
in self.event_callbacks
):
for callback in self.event_callbacks[
response.event.data.entity_id
]:
t = asyncio.create_task(
callback(response),
name=(
f"homeassistant event callback for "
f"{response.event.data.entity_id}"
),
)
t.add_done_callback(task_done_callback)
case "result":
if response.id in self.response_callbacks:
callback = self.response_callbacks[response.id]
t = asyncio.create_task(
callback(response),
name=f"result callback for {response.id}",
)
t.add_done_callback(task_done_callback)
del self.response_callbacks[response.id]
case _:
logger.debug(f"unknown message type {response.type}")
for line in pformat(message).splitlines():
logger.debug(line)
except ValidationError as exception:
for line in pformat(exception).splitlines():
logger.error(line)
for line in pformat(message).splitlines():
logger.error(line)
except asyncio.CancelledError:
print("homeassistant websocket task cancelled")
self.websocket_task = None
except websockets.exceptions.ConnectionClosedError:
print("websocket connection closed error")
self.websocket_task = None

161
greendeck/lib/images/__init__.py Normal file
View file

@ -0,0 +1,161 @@
import asyncio
import io
from PIL import Image
from PIL.Image import Image as ImageType
from pydantic.color import Color
from greendeck.lib.elgato.streamdeck import StreamDeck
from greendeck.lib.images.materialdesignicons import get_material_design_icon
__all__ = [
"create_image",
"create_scaled_image",
"render_key_image",
"to_native_format",
]
def _create_image(deck: StreamDeck, background: Color = Color("black")) -> ImageType:
"""
Creates a new PIL Image with the correct image dimensions for the given
StreamDeck device's keys.
.. seealso:: See :func:`~PILHelper.to_native_format` method for converting a
PIL image instance to the native image format of a given
StreamDeck device.
:param StreamDeck deck: StreamDeck device to generate a compatible image for.
:param str background: Background color to use, compatible with `PIL.Image.new()`.
:rtype: PIL.Image
:return: Created PIL image
"""
image_format = deck.key_image_format()
return Image.new("RGBA", image_format["size"], background.as_rgb_tuple())
async def create_image(
deck: StreamDeck, background: Color = Color("black")
) -> ImageType:
loop = asyncio.get_running_loop()
return await loop.run_in_executor(None, _create_image, deck, background)
def _create_scaled_image(
deck: StreamDeck,
image: ImageType,
margins: tuple[int, int, int, int] = (0, 0, 0, 0),
background: Color = Color("black"),
) -> ImageType:
if len(margins) != 4:
raise ValueError("Margins should be given as an array of four integers.")
final_image = create_image(deck, background=background.as_rgb_tuple())
thumbnail_max_width = final_image.width - (margins[1] + margins[3])
thumbnail_max_height = final_image.height - (margins[0] + margins[2])
thumbnail = image.convert("RGBA")
thumbnail.thumbnail((thumbnail_max_width, thumbnail_max_height), Image.LANCZOS)
thumbnail_x = margins[3] + (thumbnail_max_width - thumbnail.width) // 2
thumbnail_y = margins[0] + (thumbnail_max_height - thumbnail.height) // 2
final_image.paste(thumbnail, (thumbnail_x, thumbnail_y), thumbnail)
return final_image
async def create_scaled_image(
deck: StreamDeck,
image: ImageType,
margins: tuple[int, int, int, int] = (0, 0, 0, 0),
background: Color = Color("black"),
) -> ImageType:
loop = asyncio.get_running_loop()
return await loop.run_in_executor(
None, _create_scaled_image, deck, image, margins, background
)
def _to_native_format(deck: StreamDeck, image: ImageType) -> bytes:
image_format = deck.key_image_format()
if image_format["rotation"]:
image = image.rotate(image_format["rotation"])
if image_format["flip"][0]:
image = image.transpose(Image.FLIP_LEFT_RIGHT)
if image_format["flip"][1]:
image = image.transpose(Image.FLIP_TOP_BOTTOM)
if image.size != image_format["size"]:
image.thumbnail(image_format["size"], Image.LANCZOS)
image = image.convert("RGB")
# We want a compressed image in a given codec, convert.
compressed_image = io.BytesIO()
image.save(compressed_image, image_format["format"], quality=100)
return compressed_image.getvalue()
async def to_native_format(deck: StreamDeck, image: ImageType) -> bytes:
loop = asyncio.get_running_loop()
return await loop.run_in_executor(None, _to_native_format, deck, image)
async def render_key_image(
deck: StreamDeck, name: str, foreground: Color, background: Color
) -> bytes:
loop = asyncio.get_running_loop()
icon: ImageType
foreground: ImageType
background: ImageType
icon, foreground, background = await asyncio.gather(
get_material_design_icon(name, deck.KEY_PIXEL_WIDTH, deck.KEY_PIXEL_HEIGHT),
create_image(deck, foreground),
create_image(deck, background),
)
def _compose(
foreground: ImageType, background: ImageType, icon: ImageType
) -> ImageType:
image = background.copy()
image.paste(foreground, None, icon)
return image
image = await loop.run_in_executor(None, _compose, foreground, background, icon)
def _convert(image: ImageType):
return image.convert(mode="RGB")
image = await loop.run_in_executor(None, _convert, image)
# Resize the source image asset to best-fit the dimensions of a single key,
# leaving a margin at the bottom so that we can draw the key title
# afterwards.
# icon = Image.open(icon_filename)
# image = PILHelper.create_scaled_image(deck, icon, margins=[0, 0, 20, 0])
# # Load a custom TrueType font and use it to overlay the key index, draw key
# # label onto the image a few pixels from the bottom of the key.
# draw = ImageDraw.Draw(image)
# font = ImageFont.truetype(font_filename, 14)
# draw.text(
# (image.width / 2, image.height - 5),
# text=label_text,
# font=font,
# anchor="ms",
# fill="white",
# )
return await to_native_format(deck, image)

109
greendeck/lib/images/materialdesignicons.py Normal file
View file

@ -0,0 +1,109 @@
"""Get material design icons."""
import asyncio
import io
from PIL import Image
from PIL.Image import Image as ImageType
import aiohttp
import aiopath
from hyperlink import URL
import xdg
from greendeck.lib.images.svg import render_svg_image
__all__ = ["get_material_design_icon"]
mdi_base_path = URL.from_text(
"https://raw.githubusercontent.com/Templarian/MaterialDesign/master/svg/"
)
svg_cache: dict[str, bytes] = {}
image_cache: dict[tuple[str, int, int], ImageType] = {}
async def _get_svg(icon: str) -> bytes:
global svg_cache
if icon in svg_cache:
return svg_cache[icon]
cache_file = (
aiopath.AsyncPath(xdg.xdg_cache_home())
/ "streamdeck"
/ "svg"
/ "original"
/ f"{icon}.svg"
)
if await cache_file.exists():
content = await cache_file.read_bytes()
svg_cache[icon] = content
return content
content = None
async with aiohttp.ClientSession() as session:
mdi_url = mdi_base_path.child(f"{icon}.svg")
async with session.get(str(mdi_url)) as response:
if response.status == 200:
content = await response.read()
svg_cache[icon] = content
await cache_file.parent.mkdir(parents=True, exist_ok=True)
await cache_file.write_bytes(content)
return content
mdi_url = mdi_base_path.child("alert-circle.svg")
async with session.get(str(mdi_url)) as response:
if response.status_code == 200:
content = await response.read()
svg_cache[icon] = content
return content
raise ValueError
async def get_material_design_icon(
icon: str, width: int, height: int
) -> ImageType:
"""Get a material design icon."""
global image_cache
loop = asyncio.get_running_loop()
if (icon, width, height) in image_cache:
return image_cache[(icon, width, height)]
cache_file = (
aiopath.AsyncPath(xdg.xdg_cache_home())
/ "streamdeck"
/ "svg"
/ "rendered"
/ f"{icon}"
/ f"{width}x{height}.webp"
)
if await cache_file.exists():
def _decompress(compressed_image: bytes) -> ImageType:
image = Image.open(io.BytesIO(compressed_image), formats=["webp"])
image.load()
return image
compressed_image = await cache_file.read_bytes()
image = await loop.run_in_executor(None, _decompress, compressed_image)
image_cache[(icon, width, height)] = image
return image
svg = await _get_svg(icon)
image = await render_svg_image(svg, width, height)
image_cache[(icon, width, height)] = image
def _compress(image: ImageType) -> bytes:
compressed_image = io.BytesIO()
image.save(compressed_image, format="webp", lossless=True)
return compressed_image.getvalue()
compressed_image = await loop.run_in_executor(None, _compress, image)
await cache_file.parent.mkdir(parents=True, exist_ok=True)
await cache_file.write_bytes(compressed_image)
return image

17
greendeck/lib/images/staticiconimage.py Normal file
View file

@ -0,0 +1,17 @@
from greendeck.config import ImageConfig
from greendeck.lib.elgato.streamdeck import StreamDeck
from greendeck.lib.images import render_key_image
async def render_static_icon_image(
deck: StreamDeck, new_state: bool, image_config: ImageConfig
) -> bytes:
colors = image_config.down if new_state else image_config.up
image = await render_key_image(
deck,
image_config.icon,
colors.foreground,
colors.background,
)
return image

34
greendeck/lib/images/svg.py Normal file
View file

@ -0,0 +1,34 @@
import asyncio
import io
import PIL.Image
import wand.color
import wand.image
__all__ = ["render_svg_image"]
def _render_svg_image(svg: bytes, width: int, height: int) -> PIL.Image.Image:
with wand.image.Image(
blob=svg,
format="svg",
width=width,
height=height,
background=wand.color.Color("#ffffff00"),
) as image:
image = PIL.Image.open(
io.BytesIO(image.make_blob("png")),
)
image = image.convert("RGBA")
return image
async def render_svg_image(
svg: bytes, width: int, height: int
) -> PIL.Image.Image:
loop = asyncio.get_running_loop()
return await loop.run_in_executor(
None, _render_svg_image, svg, width, height
)

88
greendeck/lib/logging.py Normal file
View file

@ -0,0 +1,88 @@
import asyncio
import logging
import logging.handlers
from queue import SimpleQueue
import sys
import arrow
from typing_extensions import Self
class MyFormatter(logging.Formatter):
"""Format time the way it SHOULD be done."""
def __init__(self, color: bool = True, ascii_only: bool = False):
# fmt = formatter_message(fmt, use_color)
logging.Formatter.__init__(self, "")
self.color = color
self.ascii_only = ascii_only
def format(self, record: logging.LogRecord):
message = record.msg
if len(record.args) > 0:
message = record.msg % record.args
created = arrow.get(record.created).to("America/Chicago")
name = record.name
if len(name) > 25:
name = name[:24] + "\u2026"
pathname = record.pathname
if len(pathname) > 15:
pathname = "\u2026" + pathname[-14:]
msg = (
f"{created:YYYY-MM-DD HH:mm:ss.SSSSSS Z} "
f"{pathname:15s}:{record.lineno:<4d} "
f"[{name:^25s}] {record.levelname:8s} {message:s}"
)
return msg
def formatTime(self, record: logging.LogRecord, datefmt=None):
"""Format the timestamp."""
created = arrow.get(record.created)
return created.format("YYYY-MM-DD HH:mm:ss.SSSSSS Z")
class LocalQueueHandler(logging.handlers.QueueHandler):
def emit(self: Self, record: logging.LogRecord) -> None:
# Removed the call to self.prepare(), handle task cancellation
try:
self.enqueue(record)
except asyncio.CancelledError:
raise
except Exception:
self.handleError(record)
def setup_logging() -> None:
"""Set up logging."""
queue = SimpleQueue()
handler = LocalQueueHandler(queue)
formatter = MyFormatter()
console = logging.StreamHandler(stream=sys.stderr)
console.setFormatter(formatter)
console.setLevel(logging.DEBUG)
root = logging.getLogger()
for h in root.handlers[:]:
root.removeHandler(h)
h.close()
root.addHandler(handler)
root.setLevel(logging.DEBUG)
listener = logging.handlers.QueueListener(
queue, console, respect_handler_level=True
)
listener.start()
logging.getLogger("asyncio").setLevel(logging.INFO)
logging.getLogger("PIL.Image").setLevel(logging.INFO)
logging.getLogger("PIL.PngImagePlugin").setLevel(logging.INFO)
logging.getLogger("websockets.client").setLevel(logging.INFO)

23
greendeck/lib/util.py Normal file
View file

@ -0,0 +1,23 @@
import asyncio
import traceback
def task_done_callback(future: asyncio.Future):
"""Print out debug information for background tasks."""
try:
if future.result() is not None:
print(f"{future.get_name()} result {future.result}")
except asyncio.CancelledError:
print(f"{future.get_name()} was cancelled")
except Exception as exception:
formatted = traceback.format_exception(
type(exception),
exception,
exception.__traceback__,
)
for chunk in formatted:
line = chunk.splitlines()
for line in chunk.splitlines():
print(line.rstrip())

339
greendeck/main.py Normal file
View file

@ -0,0 +1,339 @@
import asyncio
import functools
import logging
import pathlib
import click
# from PIL import ImageDraw
# from PIL import ImageFont
from pydantic import parse_obj_as
from typing_extensions import Self
from greendeck.config import Config
from greendeck.config import HomeAssistantIconImageConfig
from greendeck.config import HomeAssistantServiceActionConfig
from greendeck.config import ImageConfig
from greendeck.config import PulseAudioActionConfig
from greendeck.config import StreamDeckConfig
from greendeck.config import TileConfig
from greendeck.lib.actions.pulseaudio import handle_pulseaudio_action
from greendeck.lib.elgato import enumerate_streamdecks
from greendeck.lib.elgato.streamdeck import StreamDeck
from greendeck.lib.homeassistant import EventResponse
from greendeck.lib.homeassistant import HomeAssistant
from greendeck.lib.images.staticiconimage import render_static_icon_image
from greendeck.lib.logging import setup_logging
from greendeck.lib.util import task_done_callback
logger = logging.getLogger(__name__)
class DeckHandler:
"""Class to manage connected StreamDeck."""
deck: StreamDeck
deck_config: StreamDeckConfig
config: Config
homeassistant: HomeAssistant
homeassistant_states: list[str | None]
key_states: list[bool | None]
def __init__(
self,
deck: StreamDeck,
deck_config: StreamDeckConfig,
config: Config,
homeassistant: HomeAssistant,
):
self.deck = deck
self.deck_config = deck_config
self.config = config
self.homeassistant = homeassistant
self.current_screen = self.deck_config.screen
self.homeassistant_states = [None] * self.deck.KEY_COUNT
self.key_states = [None] * self.deck.KEY_COUNT
def convert_key_to_position(self: Self, key: int) -> tuple[int, int]:
return self.deck.convert_key_to_position(key)
def get_screen_config(self: Self) -> list[TileConfig] | None:
return self.config.screens.get(self.current_screen)
def get_tile_config_for_key(self: Self, key: int) -> TileConfig | None:
position = self.convert_key_to_position(key)
screen = self.get_screen_config()
if screen is None:
return None
for tile_config in screen:
if position == tile_config.position:
return tile_config
return None
async def start(self: Self):
await self.deck.open()
await self.deck.reset()
serial = await self.deck.get_serial_number()
fw = await self.deck.get_firmware_version()
logger.info(
f"opened '{self.deck.DECK_TYPE}' device "
f"(serial number: '{serial}', fw: '{fw}')"
)
self.deck.set_key_callback(self.key_callback)
await self.deck.set_brightness(self.deck_config.brightness)
tasks = []
for key in range(self.deck.KEY_COUNT):
tasks.append(self.initialize_key(key))
await asyncio.wait(tasks, return_when=asyncio.ALL_COMPLETED)
async def initialize_key(self: Self, key: int) -> None:
await self.update_key_image(key)
await self.update_homeassistant_callbacks(key)
async def update_key_state(
self: Self, key: int, old_state: bool | None, new_state: bool
) -> None:
self.key_states[key] = new_state
if new_state is False:
t = asyncio.create_task(
self.process_key_actions(key),
name=(
f"process key actions on streamdeck "
f"{self.deck.serial_number} key {key}"
),
)
t.add_done_callback(task_done_callback)
if old_state is not None and not (old_state ^ new_state):
logger.info("no change - skipping image update")
return
t = asyncio.create_task(
self.update_key_image(key),
name=f"update image on streamdeck {self.deck.serial_number} key {key}",
)
t.add_done_callback(task_done_callback)
async def update_key_image(self: Self, key: int) -> None:
tile_config = self.get_tile_config_for_key(key)
if tile_config is None:
image = self.deck.BLANK_KEY_IMAGE
else:
match tile_config.image.type:
case "static-icon":
image_config = parse_obj_as(ImageConfig, tile_config.image)
image = await render_static_icon_image(
self.deck, self.key_states[key], image_config
)
case "homeassistant-icon":
home_assistant_icon_image_config = parse_obj_as(
HomeAssistantIconImageConfig, tile_config.image
)
image_config = home_assistant_icon_image_config.states.get(
self.homeassistant_states[key]
)
if image_config is None:
image_config = home_assistant_icon_image_config.states.get(None)
if image_config is not None:
image = await render_static_icon_image(
self.deck, self.key_states[key], image_config
)
else:
print(f"no state matched {self.homeassistant_states[key]}")
image = self.deck.BLANK_KEY_IMAGE
case _:
image = self.deck.BLANK_KEY_IMAGE
await self.deck.set_key_image(key, image)
async def key_callback(
self: Self,
deck: StreamDeck,
key: int,
old_state: bool | None,
new_state: bool,
) -> None:
assert self.deck.serial_number == deck.serial_number
position = self.convert_key_to_position(key)
logger.info(
f"deck {deck.serial_number} key {key} {position} {old_state} → {new_state}",
)
await self.update_key_state(key, old_state, new_state)
async def process_key_actions(self: Self, key: int):
tile_config = self.get_tile_config_for_key(key)
if tile_config is not None:
for action_config in tile_config.actions:
match action_config.__root__.type:
case "homeassistant-service":
action_config = HomeAssistantServiceActionConfig.parse_obj(
action_config.__root__
)
await self.homeassistant.call_service(
domain=action_config.domain,
service=action_config.service,
data=action_config.data,
)
case "pulseaudio-action":
action_config = PulseAudioActionConfig.parse_obj(
action_config.__root__
)
await handle_pulseaudio_action(action_config)
case _:
logger.error(f"unimplemented {action_config.__root__.type}")
async def homeassistant_callback(
self: Self,
key: int,
event: EventResponse,
) -> None:
self.homeassistant_states[key] = event.event.data.new_state.state
t = asyncio.create_task(self.update_key_image(key))
t.add_done_callback(task_done_callback)
async def update_homeassistant_callbacks(self: Self, key: int):
tile_config = self.get_tile_config_for_key(key)
if tile_config is None:
return
match tile_config.image.type:
case "homeassistant-icon":
homeassistant_icon_image_config = parse_obj_as(
HomeAssistantIconImageConfig, tile_config.image
)
self.homeassistant.add_event_callback(
homeassistant_icon_image_config.entity_id,
functools.partial(
self.homeassistant_callback,
key,
),
)
event_response = await self.homeassistant.get_state(
homeassistant_icon_image_config.entity_id
)
if event_response is not None:
self.homeassistant_states[key] = event_response.state
await self.update_key_image(key)
async def _main(config: Config):
decks: dict[str, tuple[StreamDeck, StreamDeckConfig]] = {}
try:
streamdecks = await enumerate_streamdecks()
if len(streamdecks) == 1:
logger.info("found 1 StreamDeck")
else:
logger.info(f"found {len(streamdecks)} StreamDecks")
for deck_config in config.streamdecks:
if deck_config.serial_number is None:
continue
for deck in streamdecks:
if deck_config.serial_number == deck.serial_number:
decks[deck.serial_number] = (
deck,
deck_config,
)
for deck_config in config.streamdecks:
if deck_config.index is None:
continue
if deck_config.index >= len(streamdecks):
logger.error(f"index {deck_config.index} is out of bounds")
continue
deck = streamdecks[deck_config.index]
if deck.serial_number in decks:
logger.error(
f"deck {deck_config.index} was already configured "
f"by serial number {deck.serial_number}"
)
continue
decks[deck.serial_number] = (
deck,
deck_config,
)
homeassistant = HomeAssistant(
host=config.homeassistant.hostname,
port=config.homeassistant.port,
secure=config.homeassistant.secure,
token=config.homeassistant.token,
)
tasks = [homeassistant.start()]
for deck, deck_config in decks.values():
deck_handler = DeckHandler(deck, deck_config, config, homeassistant)
tasks.append(deck_handler.start())
await asyncio.wait(tasks, return_when=asyncio.ALL_COMPLETED)
while True:
await asyncio.sleep(5)
except KeyboardInterrupt:
logger.info("keyboard_interrupt")
finally:
for deck, _ in decks.values():
print(deck.serial_number)
if await deck.is_open():
await deck.reset()
await deck.close()
@click.command
@click.option(
"--config",
"config_path",
type=click.Path(
exists=True,
file_okay=True,
dir_okay=False,
allow_dash=False,
path_type=pathlib.Path,
),
default="./config.yaml",
)
def main(
config_path: pathlib.Path,
):
setup_logging()
config = Config.parse_raw(config_path.read_bytes(), proto="yaml")
asyncio.run(_main(config))
if __name__ == "__main__":
main()

69
greendeck/timer.py Normal file
View file

@ -0,0 +1,69 @@
import functools
import time
from dataclasses import dataclass, field
from typing import Callable, ClassVar, Dict, Optional
class TimerError(Exception):
"""A custom exception used to report errors in use of Timer class."""
pass
@dataclass
class Timer:
"""Time a section of code."""
timers: ClassVar[Dict[str, float]] = {}
name: Optional[str] = None
text: str = "Elapsed time: {:0.4f} seconds"
logger: Optional[Callable[[str], None]] = print
_start_time: Optional[float] = field(default=None, init=False, repr=False)
def __post_init__(self) -> None:
"""Add timer to dict of timers after initialization."""
if self.name is not None:
self.timers.setdefault(self.name, 0)
def __enter__(self):
"""Start a new timer as a context manager."""
self.start()
return self
def __exit__(self, *exc_info):
"""Stop the context manager timer."""
self.stop()
def __call__(self, func):
"""Support using Timer as a decorator."""
@functools.wraps(func)
def wrapper_timer(*args, **kwargs):
with self:
return func(*args, **kwargs)
return wrapper_timer
def start(self) -> None:
"""Start a new timer."""
if self._start_time is not None:
raise TimerError("Timer is running. Use .stop() to stop it")
self._start_time = time.perf_counter()
def stop(self) -> float:
"""Stop the timer, and report the elapsed time."""
if self._start_time is None:
raise TimerError("Timer is not running. Use .start() to start it")
# Calculate elapsed time
elapsed_time = time.perf_counter() - self._start_time
self._start_time = None
# Report elapsed time
if self.logger:
self.logger(self.text.format(elapsed_time))
if self.name:
self.timers[self.name] += elapsed_time
return elapsed_time

1409
poetry.lock generated Normal file
View file

File diff suppressed because it is too large Load diff

48
pyproject.toml Normal file
View file

@ -0,0 +1,48 @@
[tool.poetry]
name = "greendeck"
version = "0.1.0"
description = ""
authors = ["Jeffrey C. Ollie <jeff@ocjtech.us>"]
[tool.poetry.dependencies]
python = "^3.10"
pydantic = "^1.10.2"
hyperlink = "^21.0.0"
websockets = "^10.4"
Pillow = "^9.3.0"
Wand = "^0.6.7"
aiohttp = "^3.8.3"
pydantic-yaml = {extras = ["ruamel"], version = "^0.8.1"}
xdg = "^5.1.1"
aiopath = "^0.6.11"
arrow = "^1.2.3"
click = "^8.1.3"
[tool.poetry.scripts]
greendeck = "greendeck.main:main"
[tool.poetry.group.dev.dependencies]
pylint = "^2.15.8"
pydocstringformatter = "^0.7.2"
pydocstyle = {extras = ["toml"], version = "^6.1.1"}
black = "^22.12.0"
flake8 = "^6.0.0"
flake8-pyproject = "^1.2.2"
isort = "^5.11.1"
[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"
[tool.black]
[tool.isort]
profile = "black"
line_length = 88
force_single_line = true
force_sort_within_sections = true
from_first = false
[tool.flake8]
max-line-length = 88
extend-ignore = "E203"