From 0b7e6a01070af01f552141eeb39ab2b3a22386a2 Mon Sep 17 00:00:00 2001 From: zorruno <1+zorruno@noreply.home.fox.co.nz> Date: Sat, 26 Sep 2026 01:40:52 +0000 Subject: [PATCH] Initial reusable HA kiosk MQTT controls --- .gitignore | 16 + CHANGELOG.md | 8 + LICENSE | 674 ++++++++++++ README.md | 143 +++ home-assistant/kiosk-package.yaml.in | 674 ++++++++++++ home-assistant/render-package.py | 49 + runtime/availability-watch.sh | 43 + runtime/config.example | 25 + runtime/ha-kiosk-availability.service | 17 + runtime/ha-kiosk-browser.service | 15 + runtime/ha-kiosk-launcher.sh | 36 + runtime/ha-kiosk-screen-control.service | 15 + runtime/screen-control.sh | 1256 +++++++++++++++++++++++ runtime/systemd.env.example | 4 + telemetry/kiosk-telemetry.py | 245 +++++ telemetry/kiosk-telemetry.service | 15 + telemetry/telemetry.env.example | 14 + 17 files changed, 3249 insertions(+) create mode 100644 .gitignore create mode 100644 CHANGELOG.md create mode 100644 LICENSE create mode 100644 README.md create mode 100644 home-assistant/kiosk-package.yaml.in create mode 100644 home-assistant/render-package.py create mode 100755 runtime/availability-watch.sh create mode 100644 runtime/config.example create mode 100644 runtime/ha-kiosk-availability.service create mode 100644 runtime/ha-kiosk-browser.service create mode 100755 runtime/ha-kiosk-launcher.sh create mode 100644 runtime/ha-kiosk-screen-control.service create mode 100755 runtime/screen-control.sh create mode 100644 runtime/systemd.env.example create mode 100755 telemetry/kiosk-telemetry.py create mode 100644 telemetry/kiosk-telemetry.service create mode 100644 telemetry/telemetry.env.example diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..1a80872 --- /dev/null +++ b/.gitignore @@ -0,0 +1,16 @@ +# Per-device credentials and settings +*.env +config +systemd.env +telemetry.env +secrets.yaml +*.key +*.pem + +# Generated package and Python cache +home-assistant/kiosk-package.yaml +__pycache__/ +*.py[cod] + +# Local backups +*.backup-* diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..48b4166 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,8 @@ +# Changelog + +## Unreleased + +- Extracted the kiosk browser and MQTT control into configurable Linux/X11 + components. +- Added reusable Home Assistant package rendering, retained-state recovery, + MQTT availability/Last Will, and an optional telemetry publisher. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + 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. + + + Copyright (C) + + 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 . + +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: + + Copyright (C) + 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 +. + + 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 +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..7211da1 --- /dev/null +++ b/README.md @@ -0,0 +1,143 @@ +# HA Kiosk MQTT Control + +Reusable Linux/X11 touchscreen kiosk controls for Home Assistant over MQTT. The +project combines local display and brightness management, a restartable browser, +retained MQTT state and availability, and a Home Assistant package for controls. + +The reference installation is a Dell portrait touchscreen kiosk. Device values +are configurable so the same controls can be deployed to other kiosks. + +## Features + +- Display modes: Screen Lock, Screen Off, Screensaver, and Screen On. +- Touch and optional camera-motion wake, shared presence timer and brightness ramp. +- Current/presence brightness, volume, mute, and physical display state. +- Periodic retained-state publication to recover Home Assistant entities after a + broker retained-store reset. +- MQTT heartbeat watchdog that restarts the screen-control service when its + command subscriber has stopped receiving messages. +- Separate Chrome systemd service with automatic restart. +- Retained availability with Last Will. +- Optional performance telemetry and MQTT Discovery sensors. + +## Requirements + +- Linux desktop session running X11 (the included touch and DPMS controls use X11). +- Google Chrome/Chromium and a kiosk dashboard URL. +- `mosquitto-clients`, `xinput`, `brightnessctl`, `xset`, `xscreensaver`, + `wpctl`, `stdbuf`, `awk`, `grep`, and Bash. +- A Home Assistant MQTT integration and an MQTT broker reachable from the kiosk. +- Optional camera motion service publishing the configured motion state topic. +- Optional telemetry: Python 3 with `psutil` and `paho-mqtt`. + +Wayland support is not currently implemented. + +## Configure a kiosk + +1. Create the per-user directories, then copy the scripts and units into place: + + ```sh + install -d -m 700 ~/.config/ha-kiosk + install -d ~/.local/lib/ha-kiosk-mqtt-control ~/.config/systemd/user + cp runtime/*.sh ~/.local/lib/ha-kiosk-mqtt-control/ + chmod 755 ~/.local/lib/ha-kiosk-mqtt-control/*.sh + cp runtime/*.service ~/.config/systemd/user/ + ``` +2. If no config exists yet, copy `runtime/config.example` to + `~/.config/ha-kiosk/config`; protect it with `chmod 600`. Edit the kiosk + identifier, MQTT roots, dashboard URL, display/touchscreen values, and optional + motion integration. The `KIOSK_ID` topic segment must match the segment used + in the rendered HA package. `KIOSK_ENTITY_PREFIX` must match the package's + `--entity-prefix` (and is used by optional telemetry). Preserve an existing + config when upgrading rather than replacing it with the example. +3. Configure the system Mosquitto clients so `mosquitto_pub` and + `mosquitto_sub` can reach the same broker as Home Assistant. The control and + availability shell scripts currently call those standard clients without + passing authentication flags; use a broker/network policy that allows the + kiosk's client connection, or integrate a credential-safe client wrapper + appropriate to your broker. Do not put passwords in this repository or in + command-line arguments. The optional Python telemetry publisher accepts + broker credentials from its protected systemd environment file. +4. If no systemd environment file exists yet, copy + `runtime/systemd.env.example` to `~/.config/ha-kiosk/systemd.env` and set + `KIOSK_ID` and `STATUS_ROOT` to match `config`. This environment file is used + by systemd for the availability service's orderly-stop publication. +5. Install `ha-kiosk-browser.service`, `ha-kiosk-screen-control.service`, and + `ha-kiosk-availability.service` from `runtime/` into + `~/.config/systemd/user/`. Before enabling the browser unit, disable any + existing desktop/autostart entry that launches the same browser, so there is + only one browser service owner. +6. Run `systemctl --user daemon-reload`, then enable and start + `ha-kiosk-browser.service`, `ha-kiosk-screen-control.service`, and + `ha-kiosk-availability.service`. +7. Enable lingering for the kiosk user if user services must run before login: + `sudo loginctl enable-linger "$USER"`. + +The screen-control script reads `~/.config/ha-kiosk/config`. The browser launcher +reads the same file for `KIOSK_URL`, display and Chrome profile values, and touch +mapping values. Systemd environment files use systemd syntax, not shell sourcing. + +## Home Assistant package + +Render the MQTT entities from the parameterized package template: + +```sh +python3 home-assistant/render-package.py \ + --name "My Kiosk" \ + --entity-prefix my_kiosk \ + --command-root kiosk/commands/my_kiosk \ + --status-root kiosk/status/my_kiosk \ + --manufacturer Generic \ + --model "Linux Touchscreen Kiosk" \ + --output /path/to/homeassistant/packages/my_kiosk.yaml +``` + +The `--command-root` and `--status-root` values are full per-device MQTT topic +roots (including the device segment). They should equal `COMMAND_ROOT/KIOSK_ID` +and `STATUS_ROOT/KIOSK_ID` from the kiosk config. The example uses the neutral +`kiosk/commands` and `kiosk/status` namespaces. The generated package provides the +MQTT controls, availability, and diagnostic entities. Add it to a Home Assistant +package directory and validate the HA configuration before reloading the MQTT +integration or restarting Home Assistant. Existing dashboards and automations may refer to the entity IDs, so +review those references when changing the entity prefix. + +The package expects the kiosk to publish the topics rooted at the supplied +command/status roots. It uses MQTT retained availability and has no secrets. + +## Optional telemetry + +Copy `telemetry/telemetry.env.example` to +`~/.config/ha-kiosk/telemetry.env`, set the broker values, and protect it with +`chmod 600`. Copy `telemetry/kiosk-telemetry.service` into +`~/.config/systemd/user/`, then reload systemd and enable +`kiosk-telemetry.service`. Keep the real environment file out of Git; +`.gitignore` excludes it. Telemetry uses Home Assistant MQTT Discovery. + +## Recovery behavior + +- All control and diagnostic states are republished retained every 30 seconds. +- A non-retained control heartbeat is sent on the same cadence. If the command + subscriber does not return the heartbeat within 90 seconds, systemd restarts + screen control. +- Chrome runs in a separate `Restart=always` service, so restarting screen + control does not take down the browser. +- The availability watcher publishes retained `ON`, while Mosquitto's Last Will + publishes retained `OFF` when the connection is lost. + +## Updating + +Back up the per-device configuration and current scripts, install the new +version, run `bash -n` on shell scripts, reload user systemd, and restart the +services individually. Check `systemctl --user status` and the retained MQTT +state topics after the update. + +## License + +This project is licensed under the GNU General Public License, version 3 or any +later version. See `LICENSE`. + +## Credentials and repository + +Never commit MQTT credentials, SSH private keys, Home Assistant tokens, or a +real per-kiosk config. The Gitea repository is public, so keep secrets and actual +per-kiosk settings out of commits. diff --git a/home-assistant/kiosk-package.yaml.in b/home-assistant/kiosk-package.yaml.in new file mode 100644 index 0000000..4c94722 --- /dev/null +++ b/home-assistant/kiosk-package.yaml.in @@ -0,0 +1,674 @@ +# SPDX-License-Identifier: GPL-3.0-or-later +#:########################################################################################:# +# __KIOSK_NAME__ Package # +#:########################################################################################:# +# +# TITLE: +# __KIOSK_NAME__ +# +# FILE: +# __KIOSK_ENTITY_PREFIX__.yaml +# +# VERSION: +# V3.0 - 2026-09-26 +# +# PURPOSE: +# Provides Home Assistant controls and status entities for the Kiosk portrait +# touchscreen kiosk. +# +# DISPLAY CONTROL MODEL: +# A single MQTT select sets one persistent display mode: +# - Screen Lock +# - Screen Off +# - Screensaver +# - Screen On +# +# The selected display mode is separate from the actual physical screen and +# screensaver states. For example, Screen Off remains selected while a touch +# temporarily wakes the physical display. +# +# MQTT DEVICE: +# Name: __KIOSK_NAME__ +# Identifier: __KIOSK_ENTITY_PREFIX__ +# Manufacturer: Dell +# Model: Portrait Touchscreen Kiosk +# Suggested Area: Lounge +# +# ENTITIES: +# select.__KIOSK_ENTITY_PREFIX___display_mode +# number.__KIOSK_ENTITY_PREFIX___brightness +# number.__KIOSK_ENTITY_PREFIX___presence_brightness +# sensor.__KIOSK_ENTITY_PREFIX___actual_brightness +# number.__KIOSK_ENTITY_PREFIX___presence_timeout +# binary_sensor.__KIOSK_ENTITY_PREFIX___presence_active +# switch.__KIOSK_ENTITY_PREFIX___motion_wake +# number.__KIOSK_ENTITY_PREFIX___volume +# switch.__KIOSK_ENTITY_PREFIX___mute +# binary_sensor.__KIOSK_ENTITY_PREFIX___screen_on +# binary_sensor.__KIOSK_ENTITY_PREFIX___screensaver_active +# binary_sensor.__KIOSK_ENTITY_PREFIX___motion +# +# REPLACED ENTITIES: +# The following writable entities from V1.7 are removed: +# - switch.__KIOSK_ENTITY_PREFIX___screen +# - switch.__KIOSK_ENTITY_PREFIX___screensaver +# +# They are replaced by: +# - select.__KIOSK_ENTITY_PREFIX___display_mode +# - binary_sensor.__KIOSK_ENTITY_PREFIX___screen_on +# - binary_sensor.__KIOSK_ENTITY_PREFIX___screensaver_active +# +# MQTT COMMAND TOPICS: +# __COMMAND_TOPIC_ROOT__/display_mode/set +# __COMMAND_TOPIC_ROOT__/brightness/set +# __COMMAND_TOPIC_ROOT__/brightness/presence/set +# __COMMAND_TOPIC_ROOT__/presence/timeout/set +# __COMMAND_TOPIC_ROOT__/motion_wake/set +# __COMMAND_TOPIC_ROOT__/audio/volume/set +# __COMMAND_TOPIC_ROOT__/audio/mute/set +# +# MQTT STATE TOPICS: +# __STATUS_TOPIC_ROOT__/display_mode/state +# __STATUS_TOPIC_ROOT__/screen/state +# __STATUS_TOPIC_ROOT__/screensaver/state +# __STATUS_TOPIC_ROOT__/brightness/state +# __STATUS_TOPIC_ROOT__/brightness/actual/state +# __STATUS_TOPIC_ROOT__/brightness/presence/state +# __STATUS_TOPIC_ROOT__/presence/state +# __STATUS_TOPIC_ROOT__/presence/timeout/state +# __STATUS_TOPIC_ROOT__/motion_wake/state +# __STATUS_TOPIC_ROOT__/audio/volume/state +# __STATUS_TOPIC_ROOT__/audio/mute/state +# __STATUS_TOPIC_ROOT__/motion/state +# +# MQTT AVAILABILITY TOPIC: +# __STATUS_TOPIC_ROOT__/availability +# +# DISPLAY MODES: +# Screen Lock: +# - Stops XScreenSaver. +# - Disables touchscreen input. +# - Keeps the physical panel off. +# - Ignores camera motion even when Motion Wake is enabled. +# - Camera motion detection and reporting continue in the background. +# +# Screen Off: +# - Keeps the physical panel off while activity is inactive. +# - Keeps the touchscreen enabled. +# - Touch always wakes the panel temporarily. +# - Camera motion wakes it when Motion Wake is enabled. +# - Activity applies Presence Brightness. +# - The panel returns to Screen Off after the shared Presence Timeout. +# +# Screensaver: +# - Turns the panel on at Current Brightness. +# - Starts XScreenSaver immediately. +# - Touch stops XScreenSaver and applies Presence Brightness. +# - Camera motion does the same when Motion Wake is enabled. +# - XScreenSaver restarts after the shared Presence Timeout. +# +# Screen On: +# - Keeps the panel on at Current Brightness while activity is inactive. +# - Touch applies Presence Brightness. +# - Camera motion does the same when Motion Wake is enabled. +# - The panel returns to Current Brightness after the Presence Timeout. +# +# PRESENCE AND TOUCH OPERATION: +# - Touch and camera motion use the same Presence Timeout. +# - Touch is active in every mode except Screen Lock. +# - Motion Wake controls camera motion only and does not disable touch wake. +# - Qualifying activity immediately applies Presence Brightness. +# - Camera motion holds presence active until the Motion entity returns to OFF. +# - A touch starts or restarts the ten-step brightness ramp immediately unless +# qualifying camera motion is currently holding presence active. +# - Presence Timeout is the total duration of the ten-step brightness ramp. +# - The final ramp step applies the latest Current Brightness. +# - The selected display mode is then restored automatically. +# +# DIAGNOSTIC STATE MEANING: +# - Screen On reports the real Linux DPMS panel state. +# - Screensaver Active reports whether XScreenSaver is running. +# - Presence Active reports whether temporary activity behaviour is active. +# - Actual Brightness reports the physical backlight percentage. +# +# VERSION HISTORY: +# V2.3 - 2026-08-02 +# - Removed the Home Assistant Display Mode Restoration automation. +# - Prevented startup and availability timing races from republishing an +# incorrect display mode, including unexpected Screen On commands. +# - Display-mode persistence and enforcement remain handled locally by the +# Kiosk screen-control service. +# +# V2.2 - 2026-07-30 +# - Enforce Screen Lock every ten minutes because the kiosk can incorrectly report +# DPMS off after a restart while the physical panel remains dimly visible. +# +# V2.1 - 2026-07-30 +# - Reapply the selected display mode when the kiosk or Home Assistant restarts, +# ensuring its physical panel, touchscreen and screensaver state are restored. +# +# V2.0 - 2026-07-28 +# - Replaced the separate Screen and Screensaver switches with one persistent +# four-option Display Mode select. +# - Added Screen Lock, Screen Off, Screensaver, and Screen On modes. +# - Added shared touchscreen and camera-presence behaviour. +# - Added automatic return to the selected mode after the presence ramp. +# - Replaced writable Screen and Screensaver entities with diagnostics. +# +# V1.7 - 2026-07-27 +# - Re-enabled DPMS after XScreenSaver activation. +# - Corrected Screen state reporting while XScreenSaver was running. +# +# V1.6 - 2026-07-27 +# - Grouped all MQTT entities under one __KIOSK_NAME__ device. +# +# V1.5 - 2026-07-27 +# - Added Motion Wake control. +# +# V1.4 - 2026-07-27 +# - Added the ten-step presence-brightness fade. +# +# V1.3 - 2026-07-27 +# - Added presence brightness, timeout, and diagnostic entities. +# +# V1.2 - 2026-07-27 +# - Added XScreenSaver control. +# +# V1.1 - 2026-07-27 +# - Added MQTT availability monitoring. +# +# V1.0 - 2026-07-26 +# - Initial package. +# +#:########################################################################################:# +# MQTT Entities # +#:########################################################################################:# + +mqtt: + - button: + name: "Kiosk Restart Chrome" + unique_id: __KIOSK_ENTITY_PREFIX___restart_chrome + icon: mdi:google-chrome + + device: + identifiers: + - __KIOSK_ENTITY_PREFIX__ + name: "__KIOSK_NAME__" + manufacturer: "Dell" + model: "Portrait Touchscreen Kiosk" + suggested_area: "Lounge" + + command_topic: "__COMMAND_TOPIC_ROOT__/chrome/restart" + payload_press: "PRESS" + + #:########################################################################################:# + # __KIOSK_NAME__ Display Mode # + #:########################################################################################:# + # + # Selects the persistent display operating mode. + # + # The selected mode remains unchanged while touch or camera activity temporarily + # changes the real panel or screensaver state. + # + + - select: + name: "Display Mode" + unique_id: __KIOSK_ENTITY_PREFIX___display_mode + default_entity_id: select.__KIOSK_ENTITY_PREFIX___display_mode + + device: + identifiers: + - __KIOSK_ENTITY_PREFIX__ + name: "__KIOSK_NAME__" + manufacturer: "Dell" + model: "Portrait Touchscreen Kiosk" + suggested_area: "Lounge" + + command_topic: "__COMMAND_TOPIC_ROOT__/display_mode/set" + state_topic: "__STATUS_TOPIC_ROOT__/display_mode/state" + + availability_topic: "__STATUS_TOPIC_ROOT__/availability" + payload_available: "ON" + payload_not_available: "OFF" + + options: + - "Screen Lock" + - "Screen Off" + - "Screensaver" + - "Screen On" + + optimistic: false + retain: false + + icon: mdi:monitor-dashboard + + #:########################################################################################:# + # __KIOSK_NAME__ Current Brightness # + #:########################################################################################:# + # + # Stores the normal inactive brightness from 1 to 100 percent. + # + # In Screensaver and Screen On modes it is the normal visible brightness. + # In Screen Off mode it is the final ramp target before the panel powers off. + # In Screen Lock mode it is stored for the next unlocked mode. + # + + - number: + name: "Brightness" + unique_id: __KIOSK_ENTITY_PREFIX___brightness + default_entity_id: number.__KIOSK_ENTITY_PREFIX___brightness + + device: + identifiers: + - __KIOSK_ENTITY_PREFIX__ + name: "__KIOSK_NAME__" + manufacturer: "Dell" + model: "Portrait Touchscreen Kiosk" + suggested_area: "Lounge" + + command_topic: "__COMMAND_TOPIC_ROOT__/brightness/set" + state_topic: "__STATUS_TOPIC_ROOT__/brightness/state" + + availability_topic: "__STATUS_TOPIC_ROOT__/availability" + payload_available: "ON" + payload_not_available: "OFF" + + min: 1 + max: 100 + step: 1 + mode: slider + + unit_of_measurement: "%" + + optimistic: false + retain: false + + icon: mdi:brightness-6 + + #:########################################################################################:# + # __KIOSK_NAME__ Presence Brightness # + #:########################################################################################:# + # + # Sets the temporary brightness used after touch or qualifying camera motion. + # + # Changing it while Presence Active is ON immediately updates the physical + # backlight. + # + + - number: + name: "Presence Brightness" + unique_id: __KIOSK_ENTITY_PREFIX___presence_brightness + default_entity_id: number.__KIOSK_ENTITY_PREFIX___presence_brightness + + device: + identifiers: + - __KIOSK_ENTITY_PREFIX__ + name: "__KIOSK_NAME__" + manufacturer: "Dell" + model: "Portrait Touchscreen Kiosk" + suggested_area: "Lounge" + + entity_category: config + + command_topic: "__COMMAND_TOPIC_ROOT__/brightness/presence/set" + state_topic: "__STATUS_TOPIC_ROOT__/brightness/presence/state" + + availability_topic: "__STATUS_TOPIC_ROOT__/availability" + payload_available: "ON" + payload_not_available: "OFF" + + min: 1 + max: 100 + step: 1 + mode: slider + + unit_of_measurement: "%" + + optimistic: false + retain: false + + icon: mdi:brightness-7 + + #:########################################################################################:# + # __KIOSK_NAME__ Actual Brightness # + #:########################################################################################:# + # + # Reports the physical display backlight percentage. + # + # This may differ from Current Brightness while temporary activity is active or + # while the ten-step brightness ramp is running. + # + + - sensor: + name: "Actual Brightness" + unique_id: __KIOSK_ENTITY_PREFIX___actual_brightness + default_entity_id: sensor.__KIOSK_ENTITY_PREFIX___actual_brightness + + device: + identifiers: + - __KIOSK_ENTITY_PREFIX__ + name: "__KIOSK_NAME__" + manufacturer: "Dell" + model: "Portrait Touchscreen Kiosk" + suggested_area: "Lounge" + + entity_category: diagnostic + + state_topic: "__STATUS_TOPIC_ROOT__/brightness/actual/state" + + availability_topic: "__STATUS_TOPIC_ROOT__/availability" + payload_available: "ON" + payload_not_available: "OFF" + + unit_of_measurement: "%" + state_class: measurement + + icon: mdi:brightness-percent + + #:########################################################################################:# + # __KIOSK_NAME__ Presence Timeout # + #:########################################################################################:# + # + # Sets the shared touch and camera-presence timeout. + # + # The value is the total duration of the ten-step brightness ramp. Home Assistant + # displays whole minutes while MQTT stores and transfers seconds. + # + + - number: + name: "Presence Timeout" + unique_id: __KIOSK_ENTITY_PREFIX___presence_timeout + default_entity_id: number.__KIOSK_ENTITY_PREFIX___presence_timeout + + device: + identifiers: + - __KIOSK_ENTITY_PREFIX__ + name: "__KIOSK_NAME__" + manufacturer: "Dell" + model: "Portrait Touchscreen Kiosk" + suggested_area: "Lounge" + + entity_category: config + + command_topic: "__COMMAND_TOPIC_ROOT__/presence/timeout/set" + state_topic: "__STATUS_TOPIC_ROOT__/presence/timeout/state" + + availability_topic: "__STATUS_TOPIC_ROOT__/availability" + payload_available: "ON" + payload_not_available: "OFF" + + command_template: >- + {{ (value | float(1) * 60) | round(0) | int }} + + value_template: >- + {{ (value | float(60) / 60) | round(0) | int }} + + min: 1 + max: 1440 + step: 1 + mode: box + + unit_of_measurement: "min" + + optimistic: false + retain: false + + icon: mdi:timer-outline + + #:########################################################################################:# + # __KIOSK_NAME__ Presence Active # + #:########################################################################################:# + # + # Reports whether temporary touch or camera-presence behaviour is active. + # + # It remains ON through the brightness ramp and returns to OFF when the selected + # display mode has been restored. + # + + - binary_sensor: + name: "Presence Active" + unique_id: __KIOSK_ENTITY_PREFIX___presence_active + default_entity_id: binary_sensor.__KIOSK_ENTITY_PREFIX___presence_active + + device: + identifiers: + - __KIOSK_ENTITY_PREFIX__ + name: "__KIOSK_NAME__" + manufacturer: "Dell" + model: "Portrait Touchscreen Kiosk" + suggested_area: "Lounge" + + entity_category: diagnostic + + state_topic: "__STATUS_TOPIC_ROOT__/presence/state" + + availability_topic: "__STATUS_TOPIC_ROOT__/availability" + payload_available: "ON" + payload_not_available: "OFF" + + payload_on: "ON" + payload_off: "OFF" + + icon: mdi:account-eye + + #:########################################################################################:# + # __KIOSK_NAME__ Motion Wake # + #:########################################################################################:# + # + # Controls whether camera motion counts as display activity. + # + # Motion Wake does not affect touchscreen activity. Screen Lock ignores camera + # motion regardless of this switch while motion detection continues reporting. + # + + - switch: + name: "Motion Wake" + unique_id: __KIOSK_ENTITY_PREFIX___motion_wake + default_entity_id: switch.__KIOSK_ENTITY_PREFIX___motion_wake + + device: + identifiers: + - __KIOSK_ENTITY_PREFIX__ + name: "__KIOSK_NAME__" + manufacturer: "Dell" + model: "Portrait Touchscreen Kiosk" + suggested_area: "Lounge" + + entity_category: config + + command_topic: "__COMMAND_TOPIC_ROOT__/motion_wake/set" + state_topic: "__STATUS_TOPIC_ROOT__/motion_wake/state" + + availability_topic: "__STATUS_TOPIC_ROOT__/availability" + payload_available: "ON" + payload_not_available: "OFF" + + payload_on: "ON" + payload_off: "OFF" + + optimistic: false + retain: false + + icon: mdi:motion-sensor + + #:########################################################################################:# + # __KIOSK_NAME__ Volume # + #:########################################################################################:# + # + # Controls the active PipeWire audio-sink volume from 0 to 100 percent. + # + + - number: + name: "Volume" + unique_id: __KIOSK_ENTITY_PREFIX___volume + default_entity_id: number.__KIOSK_ENTITY_PREFIX___volume + + device: + identifiers: + - __KIOSK_ENTITY_PREFIX__ + name: "__KIOSK_NAME__" + manufacturer: "Dell" + model: "Portrait Touchscreen Kiosk" + suggested_area: "Lounge" + + command_topic: "__COMMAND_TOPIC_ROOT__/audio/volume/set" + state_topic: "__STATUS_TOPIC_ROOT__/audio/volume/state" + + availability_topic: "__STATUS_TOPIC_ROOT__/availability" + payload_available: "ON" + payload_not_available: "OFF" + + min: 0 + max: 100 + step: 1 + mode: slider + + unit_of_measurement: "%" + + optimistic: false + retain: false + + icon: mdi:volume-high + + #:########################################################################################:# + # __KIOSK_NAME__ Mute # + #:########################################################################################:# + # + # Controls the mute state of the active PipeWire audio sink. + # + + - switch: + name: "Mute" + unique_id: __KIOSK_ENTITY_PREFIX___mute + default_entity_id: switch.__KIOSK_ENTITY_PREFIX___mute + + device: + identifiers: + - __KIOSK_ENTITY_PREFIX__ + name: "__KIOSK_NAME__" + manufacturer: "Dell" + model: "Portrait Touchscreen Kiosk" + suggested_area: "Lounge" + + command_topic: "__COMMAND_TOPIC_ROOT__/audio/mute/set" + state_topic: "__STATUS_TOPIC_ROOT__/audio/mute/state" + + availability_topic: "__STATUS_TOPIC_ROOT__/availability" + payload_available: "ON" + payload_not_available: "OFF" + + payload_on: "ON" + payload_off: "OFF" + + optimistic: false + retain: false + + icon: mdi:volume-mute + + #:########################################################################################:# + # __KIOSK_NAME__ Screen On # + #:########################################################################################:# + # + # Reports the real physical panel state from Linux DPMS. + # + # This can report ON while Display Mode remains Screen Off because touch or + # qualifying camera motion has temporarily woken the panel. + # + + - binary_sensor: + name: "Screen On" + unique_id: __KIOSK_ENTITY_PREFIX___screen_on + default_entity_id: binary_sensor.__KIOSK_ENTITY_PREFIX___screen_on + + device: + identifiers: + - __KIOSK_ENTITY_PREFIX__ + name: "__KIOSK_NAME__" + manufacturer: "Dell" + model: "Portrait Touchscreen Kiosk" + suggested_area: "Lounge" + + entity_category: diagnostic + + state_topic: "__STATUS_TOPIC_ROOT__/screen/state" + + availability_topic: "__STATUS_TOPIC_ROOT__/availability" + payload_available: "ON" + payload_not_available: "OFF" + + payload_on: "ON" + payload_off: "OFF" + + device_class: power + icon: mdi:monitor + + #:########################################################################################:# + # __KIOSK_NAME__ Screensaver Active # + #:########################################################################################:# + # + # Reports whether XScreenSaver is currently running. + # + # In Screensaver mode it normally reports ON, but temporarily reports OFF while + # touch or qualifying camera motion displays the Home Assistant kiosk. + # + + - binary_sensor: + name: "Screensaver Active" + unique_id: __KIOSK_ENTITY_PREFIX___screensaver_active + default_entity_id: binary_sensor.__KIOSK_ENTITY_PREFIX___screensaver_active + + device: + identifiers: + - __KIOSK_ENTITY_PREFIX__ + name: "__KIOSK_NAME__" + manufacturer: "Dell" + model: "Portrait Touchscreen Kiosk" + suggested_area: "Lounge" + + entity_category: diagnostic + + state_topic: "__STATUS_TOPIC_ROOT__/screensaver/state" + + availability_topic: "__STATUS_TOPIC_ROOT__/availability" + payload_available: "ON" + payload_not_available: "OFF" + + payload_on: "ON" + payload_off: "OFF" + + icon: mdi:monitor-shimmer + + #:########################################################################################:# + # __KIOSK_NAME__ Motion # + #:########################################################################################:# + # + # Reports raw movement detected by the local Motion camera service. + # + # Motion continues reporting in Screen Lock and while Motion Wake is OFF. It only + # affects display activity when Motion Wake is ON and Display Mode is not + # Screen Lock. + # + + - binary_sensor: + name: "Motion" + unique_id: __KIOSK_ENTITY_PREFIX___motion + default_entity_id: binary_sensor.__KIOSK_ENTITY_PREFIX___motion + + device: + identifiers: + - __KIOSK_ENTITY_PREFIX__ + name: "__KIOSK_NAME__" + manufacturer: "Dell" + model: "Portrait Touchscreen Kiosk" + suggested_area: "Lounge" + + state_topic: "__STATUS_TOPIC_ROOT__/motion/state" + + availability_topic: "__STATUS_TOPIC_ROOT__/availability" + payload_available: "ON" + payload_not_available: "OFF" + + payload_on: "ON" + payload_off: "OFF" + + device_class: motion diff --git a/home-assistant/render-package.py b/home-assistant/render-package.py new file mode 100644 index 0000000..3bca184 --- /dev/null +++ b/home-assistant/render-package.py @@ -0,0 +1,49 @@ +#!/usr/bin/env python3 +# SPDX-License-Identifier: GPL-3.0-or-later +"""Render the MQTT kiosk Home Assistant package from its parameterized template.""" +import argparse +import json +import re +from pathlib import Path + +parser = argparse.ArgumentParser() +parser.add_argument("--name", required=True) +parser.add_argument("--entity-prefix", required=True, help="HA device/entity slug, e.g. lounge_kiosk") +parser.add_argument("--command-root", required=True, help="MQTT command topic root, e.g. kiosk/commands/lounge") +parser.add_argument("--status-root", required=True, help="MQTT status topic root, e.g. kiosk/status/lounge") +parser.add_argument("--manufacturer", default="Generic") +parser.add_argument("--model", default="Linux Touchscreen Kiosk") +parser.add_argument("--area", default="") +parser.add_argument("--output", required=True, type=Path) +args = parser.parse_args() + +if not re.fullmatch(r"[a-z][a-z0-9_]*", args.entity_prefix): + parser.error("--entity-prefix must contain lowercase letters, digits, and underscores") +topic_pattern = r"[A-Za-z0-9_.-]+(?:/[A-Za-z0-9_.-]+)*" +if not re.fullmatch(topic_pattern, args.command_root): + parser.error("--command-root must be a non-empty MQTT topic path without wildcards") +if not re.fullmatch(topic_pattern, args.status_root): + parser.error("--status-root must be a non-empty MQTT topic path without wildcards") + +text = Path(__file__).with_name("kiosk-package.yaml.in").read_text() +quoted_values = { + "__KIOSK_NAME__": args.name, + "__MANUFACTURER__": args.manufacturer, + "__MODEL__": args.model, + "__AREA__": args.area, +} +for marker, value in quoted_values.items(): + text = text.replace(f'"{marker}"', json.dumps(value, ensure_ascii=False)) + text = text.replace(marker, value) +for marker, value in { + "__KIOSK_ENTITY_PREFIX__": args.entity_prefix, + "__COMMAND_TOPIC_ROOT__": args.command_root, + "__STATUS_TOPIC_ROOT__": args.status_root, +}.items(): + text = text.replace(marker, value) +if re.search(r"__[A-Z_]+__", text): + raise SystemExit("Unresolved template marker remains") +if not args.area: + text = text.replace(' suggested_area: ""\n', "") +args.output.parent.mkdir(parents=True, exist_ok=True) +args.output.write_text(text) diff --git a/runtime/availability-watch.sh b/runtime/availability-watch.sh new file mode 100755 index 0000000..63dbea7 --- /dev/null +++ b/runtime/availability-watch.sh @@ -0,0 +1,43 @@ +#!/usr/bin/env bash +# SPDX-License-Identifier: GPL-3.0-or-later + +set -u + +KIOSK_CONFIG_FILE="${KIOSK_CONFIG_FILE:-$HOME/.config/ha-kiosk/config}" +if [[ -r "$KIOSK_CONFIG_FILE" ]]; then + # shellcheck source=/dev/null + source "$KIOSK_CONFIG_FILE" +fi +: "${KIOSK_ID:=kiosk}" +: "${COMMAND_ROOT:=kiosk/commands}" +: "${STATUS_ROOT:=kiosk/status}" +AVAILABILITY_TOPIC="${STATUS_ROOT}/${KIOSK_ID}/availability" +PING_TOPIC="${COMMAND_ROOT}/${KIOSK_ID}/availability/ping" +PUBLISH_INTERVAL_SECONDS="${AVAILABILITY_INTERVAL_SECONDS:-30}" + +publish_available() { + /usr/bin/mosquitto_pub -r -t "$AVAILABILITY_TOPIC" -m "ON" +} + +# Keep the MQTT connection that owns the Last Will open in the background. +/usr/bin/mosquitto_sub \ + -t "$PING_TOPIC" \ + --will-topic "$AVAILABILITY_TOPIC" \ + --will-payload "OFF" \ + --will-retain & +subscriber_pid=$! + +cleanup() { + kill "$subscriber_pid" 2>/dev/null || true + wait "$subscriber_pid" 2>/dev/null || true +} +trap cleanup EXIT INT TERM + +# Reassert retained availability after Mosquitto reconnects internally. The +# Last Will has already published OFF when a broker connection was lost. +while kill -0 "$subscriber_pid" 2>/dev/null; do + publish_available || true + sleep "$PUBLISH_INTERVAL_SECONDS" +done + +wait "$subscriber_pid" diff --git a/runtime/config.example b/runtime/config.example new file mode 100644 index 0000000..b049ed3 --- /dev/null +++ b/runtime/config.example @@ -0,0 +1,25 @@ +# SPDX-License-Identifier: GPL-3.0-or-later +# Per-kiosk settings. Copy to ~/.config/ha-kiosk/config. +# This file is sourced by Bash; quote values containing spaces. +KIOSK_ID=my_kiosk +KIOSK_ENTITY_PREFIX=my_kiosk +KIOSK_NAME="My Kiosk" +KIOSK_MANUFACTURER=Generic +KIOSK_MODEL="Linux Touchscreen Kiosk" +KIOSK_AREA="" +COMMAND_ROOT=kiosk/commands +STATUS_ROOT=kiosk/status +KIOSK_URL="http://homeassistant.local:8123/" +KIOSK_DISPLAY=:0 +KIOSK_XAUTHORITY="$HOME/.Xauthority" +CHROME_BIN=/usr/bin/google-chrome-stable +CHROME_USER_DATA_DIR="$HOME/.config/ha-kiosk/chrome-profile" +TOUCH_DEVICE_NAME="Touchscreen Device Name" +TOUCH_DISPLAY_OUTPUT=eDP-1 +SCREEN_LOCK_BRIGHTNESS=0 +BROWSER_SERVICE=ha-kiosk-browser.service +MOTION_SERVICE=my_kiosk-motion.service +MOTION_EVENT_SCRIPT="$HOME/my_kiosk-motion-event.sh" +MQTT_REPUBLISH_INTERVAL_SECONDS=30 +MQTT_HEARTBEAT_TIMEOUT_SECONDS=90 +AVAILABILITY_INTERVAL_SECONDS=30 diff --git a/runtime/ha-kiosk-availability.service b/runtime/ha-kiosk-availability.service new file mode 100644 index 0000000..7a1b2f9 --- /dev/null +++ b/runtime/ha-kiosk-availability.service @@ -0,0 +1,17 @@ +# SPDX-License-Identifier: GPL-3.0-or-later +[Unit] +Description=Home Assistant Kiosk MQTT availability +After=network-online.target +Wants=network-online.target +StartLimitIntervalSec=0 + +[Service] +Type=simple +EnvironmentFile=%h/.config/ha-kiosk/systemd.env +ExecStart=%h/.local/lib/ha-kiosk-mqtt-control/availability-watch.sh +ExecStopPost=/usr/bin/mosquitto_pub -r -t ${STATUS_ROOT}/${KIOSK_ID}/availability -m OFF +Restart=always +RestartSec=10 + +[Install] +WantedBy=default.target diff --git a/runtime/ha-kiosk-browser.service b/runtime/ha-kiosk-browser.service new file mode 100644 index 0000000..2e36daf --- /dev/null +++ b/runtime/ha-kiosk-browser.service @@ -0,0 +1,15 @@ +# SPDX-License-Identifier: GPL-3.0-or-later +[Unit] +Description=Home Assistant touchscreen kiosk browser +After=graphical-session.target network-online.target +Wants=network-online.target + +[Service] +Type=simple +EnvironmentFile=-%h/.config/ha-kiosk/systemd.env +ExecStart=%h/.local/lib/ha-kiosk-mqtt-control/ha-kiosk-launcher.sh +Restart=always +RestartSec=5 + +[Install] +WantedBy=default.target diff --git a/runtime/ha-kiosk-launcher.sh b/runtime/ha-kiosk-launcher.sh new file mode 100755 index 0000000..131491c --- /dev/null +++ b/runtime/ha-kiosk-launcher.sh @@ -0,0 +1,36 @@ +#!/usr/bin/env bash +# SPDX-License-Identifier: GPL-3.0-or-later +set -euo pipefail + +KIOSK_CONFIG_FILE="${KIOSK_CONFIG_FILE:-$HOME/.config/ha-kiosk/config}" +if [[ -r "$KIOSK_CONFIG_FILE" ]]; then + # shellcheck source=/dev/null + source "$KIOSK_CONFIG_FILE" +fi + +: "${KIOSK_URL:?Set KIOSK_URL in ~/.config/ha-kiosk/config}" +: "${TOUCH_DEVICE_NAME:=Touchscreen Device Name}" +: "${TOUCH_DISPLAY_OUTPUT:=eDP-1}" +: "${KIOSK_DISPLAY:=:0}" +: "${KIOSK_XAUTHORITY:=$HOME/.Xauthority}" +: "${CHROME_BIN:=/usr/bin/google-chrome-stable}" +: "${CHROME_USER_DATA_DIR:=$HOME/.config/ha-kiosk/chrome-profile}" +export DISPLAY="$KIOSK_DISPLAY" +export XAUTHORITY="$KIOSK_XAUTHORITY" + +# Allow the desktop and touchscreen to initialise. +sleep 2 + +# Map the touchscreen to the rotated built-in display. +xinput map-to-output \ + "$TOUCH_DEVICE_NAME" \ + "$TOUCH_DISPLAY_OUTPUT" + +# Start Home Assistant in Chrome kiosk mode. +"$CHROME_BIN" \ + --user-data-dir="$CHROME_USER_DATA_DIR" \ + --kiosk \ + --noerrdialogs \ + --disable-session-crashed-bubble \ + --no-first-run \ + "$KIOSK_URL" diff --git a/runtime/ha-kiosk-screen-control.service b/runtime/ha-kiosk-screen-control.service new file mode 100644 index 0000000..8241933 --- /dev/null +++ b/runtime/ha-kiosk-screen-control.service @@ -0,0 +1,15 @@ +# SPDX-License-Identifier: GPL-3.0-or-later +[Unit] +Description=Home Assistant Kiosk MQTT Screen Control +After=network-online.target graphical-session.target +Wants=network-online.target + +[Service] +Type=simple +EnvironmentFile=-%h/.config/ha-kiosk/systemd.env +ExecStart=%h/.local/lib/ha-kiosk-mqtt-control/screen-control.sh +Restart=always +RestartSec=5 + +[Install] +WantedBy=default.target diff --git a/runtime/screen-control.sh b/runtime/screen-control.sh new file mode 100755 index 0000000..4474ef9 --- /dev/null +++ b/runtime/screen-control.sh @@ -0,0 +1,1256 @@ +#!/usr/bin/env bash +# SPDX-License-Identifier: GPL-3.0-or-later + +#:########################################################################################:# +# HA Kiosk MQTT Control Script # +#:########################################################################################:# +# +# TITLE: +# HA Kiosk MQTT Control +# +# VERSION: +# V3.0 - 2026-09-26 +# +# PURPOSE: +# Provides local MQTT control and state reporting for a Linux touchscreen kiosk. +# +# CONTROLS: +# - Four persistent display modes using one MQTT select. +# - Saved current brightness and physical backlight brightness. +# - Temporary presence brightness from touch or camera motion. +# - Shared touch and presence timeout using a ten-step brightness ramp. +# - Speaker volume and mute using PipeWire wpctl. +# - Actual screen, screensaver, brightness, and presence state reporting. +# +# DISPLAY MODES: +# Screen Lock: +# - Disables touchscreen input. +# - Stops XScreenSaver. +# - Keeps the physical display off. +# - Ignores touch and camera-presence activity. +# +# Screen Off: +# - Keeps the touchscreen enabled. +# - Keeps the physical display off while presence is inactive. +# - Touch always wakes the display. +# - Camera motion wakes the display when Motion Wake is enabled. +# - Returns to Screen Off after the presence ramp reaches Current Brightness. +# +# Screensaver: +# - Starts XScreenSaver immediately at Current Brightness. +# - Touch stops the screensaver and activates Presence Brightness. +# - Camera motion does the same when Motion Wake is enabled. +# - Returns to XScreenSaver at Current Brightness after the presence ramp. +# +# Screen On: +# - Keeps the display on at Current Brightness while presence is inactive. +# - Touch activates Presence Brightness. +# - Camera motion does the same when Motion Wake is enabled. +# - Returns to Current Brightness after the presence ramp. +# +# PRESENCE OPERATION: +# - Touch and camera motion share the same Presence Timeout. +# - Touch always counts as activity except in Screen Lock mode. +# - Camera motion counts as activity only when Motion Wake is enabled. +# - Activity turns the display on and applies Presence Brightness immediately. +# - A touch starts or restarts the ten-step brightness ramp immediately unless +# qualifying camera motion is currently holding presence active. +# - Qualifying camera motion holds presence active until motion ends. +# - The latest saved Current Brightness is used as the ramp target. +# - The selected display mode determines what happens after the final ramp step. +# - A Presence End MQTT command can run a one-off ramp without changing the +# saved Presence Timeout. +# +# MQTT AUTHENTICATION: +# Configure Mosquitto client defaults securely on this host. This script uses +# the installed mosquitto_pub and mosquitto_sub client configuration. +# +# VERSION HISTORY: +# V3.0 - 2026-09-26 +# - Parameterized kiosk identity, MQTT roots, display settings and service names. +# - Added periodic retained-state refresh and an MQTT subscriber heartbeat watchdog. +# - Kept the browser in an independent restartable systemd service. +# - Added a Presence End MQTT command for one-off presence ramps. +# +# V2.0 - 2026-07-28 +# - Replaced separate Screen and Screensaver command switches with one +# persistent four-option Display Mode control. +# - Added Screen Lock, Screen Off, Screensaver, and Screen On modes. +# - Added direct touchscreen activity detection using XInput RawTouchBegin. +# - Made touch and camera presence use the same Presence Timeout and ramp. +# - Added automatic return to each selected mode after presence finishes. +# - Added touchscreen disable and display enforcement for Screen Lock. +# - Retained actual Screen and Screensaver state topics as diagnostics. +# +# V1.7 - 2026-07-27 +# - Re-enabled DPMS after XScreenSaver activation. +# - Corrected Screen state reporting while the screensaver is running. +# +# V1.6 - 2026-07-27 +# - Changed Screensaver ON to explicitly turn the display on through DPMS. +# - Ensured the Screen state reports ON whenever the screensaver is enabled. +# +# V1.5 - 2026-07-27 +# - Changed Motion Wake ON to immediately wake the display when motion is +# currently detected or presence behaviour is already active. +# - Removed the requirement to wait for a new motion event after enabling +# Motion Wake. +# +# V1.4 - 2026-07-27 +# - Added persistent MQTT control for motion-triggered display wake-up. +# - Kept camera motion detection active while Motion Wake is disabled. +# - Added retained Motion Wake state reporting. +# +# V1.3 - 2026-07-27 +# - Replaced the fixed presence-timeout delay with a ten-step brightness ramp. +# - Spread the ten ramp steps evenly across the configured timeout. +# - Made the ramp follow the latest saved Current Brightness value. +# - Added immediate ramp cancellation when new movement is detected. +# +# V1.2 - 2026-07-27 +# - Added persistent Current Brightness and Presence Brightness values. +# - Added local presence handling from the retained Motion MQTT state. +# - Added a configurable local presence timeout. +# - Added reporting of the actual physical backlight level. +# +# V1.1 - 2026-07-27 +# - Added MQTT control and reporting for XScreenSaver. +# - Forced XScreenSaver OFF whenever the control service starts. +# - Changed Mosquitto commands to use protected client configuration files. +# +# V1.0 - 2026-07-26 +# - Initial screen, brightness, volume, and mute controls. +# + +set -u + +# Optional per-device shell configuration (never commit the real file). +KIOSK_CONFIG_FILE="${KIOSK_CONFIG_FILE:-$HOME/.config/ha-kiosk/config}" +if [[ -r "$KIOSK_CONFIG_FILE" ]]; then + # shellcheck source=/dev/null + source "$KIOSK_CONFIG_FILE" +fi + +: "${KIOSK_ID:=kiosk}" +: "${COMMAND_ROOT:=kiosk/commands}" +: "${STATUS_ROOT:=kiosk/status}" +: "${BROWSER_SERVICE:=ha-kiosk-browser.service}" +: "${MQTT_REPUBLISH_INTERVAL_SECONDS:=30}" +: "${MQTT_HEARTBEAT_TIMEOUT_SECONDS:=90}" +: "${MOTION_SERVICE:=${KIOSK_ID}-motion.service}" +: "${MOTION_EVENT_SCRIPT:=$HOME/${KIOSK_ID}-motion-event.sh}" +: "${STATE_DIR:=${XDG_STATE_HOME:-$HOME/.local/state}/ha-kiosk-${KIOSK_ID}}" +export DISPLAY="${KIOSK_DISPLAY:-:0}" +export XAUTHORITY="${KIOSK_XAUTHORITY:-$HOME/.Xauthority}" + +#:########################################################################################:# +# Device Settings # +#:########################################################################################:# + +TOUCH_DEVICE_NAME="${TOUCH_DEVICE_NAME:-Touchscreen Device Name}" +TOUCH_DISPLAY_OUTPUT="${TOUCH_DISPLAY_OUTPUT:-eDP-1}" +SCREEN_LOCK_BRIGHTNESS="${SCREEN_LOCK_BRIGHTNESS:-0}" + +#:########################################################################################:# +# MQTT Topics # +#:########################################################################################:# + +DISPLAY_MODE_COMMAND_TOPIC="${COMMAND_ROOT}/${KIOSK_ID}/display_mode/set" +DISPLAY_MODE_STATE_TOPIC="${STATUS_ROOT}/${KIOSK_ID}/display_mode/state" + +# These state topics now report actual physical conditions only. +SCREEN_STATE_TOPIC="${STATUS_ROOT}/${KIOSK_ID}/screen/state" +SCREENSAVER_STATE_TOPIC="${STATUS_ROOT}/${KIOSK_ID}/screensaver/state" + +CURRENT_BRIGHTNESS_COMMAND_TOPIC="${COMMAND_ROOT}/${KIOSK_ID}/brightness/set" +CURRENT_BRIGHTNESS_STATE_TOPIC="${STATUS_ROOT}/${KIOSK_ID}/brightness/state" +ACTUAL_BRIGHTNESS_STATE_TOPIC="${STATUS_ROOT}/${KIOSK_ID}/brightness/actual/state" + +PRESENCE_BRIGHTNESS_COMMAND_TOPIC="${COMMAND_ROOT}/${KIOSK_ID}/brightness/presence/set" +PRESENCE_BRIGHTNESS_STATE_TOPIC="${STATUS_ROOT}/${KIOSK_ID}/brightness/presence/state" +PRESENCE_ACTIVE_STATE_TOPIC="${STATUS_ROOT}/${KIOSK_ID}/presence/state" + +PRESENCE_TIMEOUT_COMMAND_TOPIC="${COMMAND_ROOT}/${KIOSK_ID}/presence/timeout/set" +PRESENCE_TIMEOUT_STATE_TOPIC="${STATUS_ROOT}/${KIOSK_ID}/presence/timeout/state" +PRESENCE_END_COMMAND_TOPIC="${COMMAND_ROOT}/${KIOSK_ID}/presence/end" + +MOTION_STATE_TOPIC="${STATUS_ROOT}/${KIOSK_ID}/motion/state" + +MOTION_WAKE_COMMAND_TOPIC="${COMMAND_ROOT}/${KIOSK_ID}/motion_wake/set" +MOTION_WAKE_STATE_TOPIC="${STATUS_ROOT}/${KIOSK_ID}/motion_wake/state" + +MOTION_SERVICE="${MOTION_SERVICE}" +MOTION_EVENT_SCRIPT="${MOTION_EVENT_SCRIPT}" + +VOLUME_COMMAND_TOPIC="${COMMAND_ROOT}/${KIOSK_ID}/audio/volume/set" +VOLUME_STATE_TOPIC="${STATUS_ROOT}/${KIOSK_ID}/audio/volume/state" + +MUTE_COMMAND_TOPIC="${COMMAND_ROOT}/${KIOSK_ID}/audio/mute/set" +MUTE_STATE_TOPIC="${STATUS_ROOT}/${KIOSK_ID}/audio/mute/state" + +CHROME_RESTART_COMMAND_TOPIC="${COMMAND_ROOT}/${KIOSK_ID}/chrome/restart" +MQTT_HEARTBEAT_TOPIC="${STATUS_ROOT}/${KIOSK_ID}/control/heartbeat" +MQTT_REPUBLISH_INTERVAL_SECONDS="${MQTT_REPUBLISH_INTERVAL_SECONDS:-30}" +MQTT_HEARTBEAT_TIMEOUT_SECONDS="${MQTT_HEARTBEAT_TIMEOUT_SECONDS:-90}" + +# Previous command topics are cleared during initialisation and are no longer +# subscribed to by this script. +LEGACY_SCREEN_COMMAND_TOPIC="${COMMAND_ROOT}/${KIOSK_ID}/screen/set" +LEGACY_SCREENSAVER_COMMAND_TOPIC="${COMMAND_ROOT}/${KIOSK_ID}/screensaver/set" + +#:########################################################################################:# +# Local State # +#:########################################################################################:# + +STATE_DIR="${STATE_DIR}" +DISPLAY_MODE_FILE="$STATE_DIR/display_mode" +CURRENT_BRIGHTNESS_FILE="$STATE_DIR/current_brightness" +PRESENCE_BRIGHTNESS_FILE="$STATE_DIR/presence_brightness" +PRESENCE_ACTIVE_FILE="$STATE_DIR/presence_active" +PRESENCE_TIMEOUT_FILE="$STATE_DIR/presence_timeout_seconds" +MOTION_WAKE_FILE="$STATE_DIR/motion_wake" +MQTT_EVENT_FIFO="$STATE_DIR/mqtt-events.fifo" +TOUCH_EVENT_FIFO="$STATE_DIR/touch-events.fifo" + +mkdir -p "$STATE_DIR" +chmod 700 "$STATE_DIR" + +#:########################################################################################:# +# MQTT Publishing # +#:########################################################################################:# + +mqtt_publish() { + /usr/bin/mosquitto_pub "$@" +} + +publish_retained() { + local topic="$1" + local payload="$2" + + mqtt_publish \ + -r \ + -t "$topic" \ + -m "$payload" +} + +#:########################################################################################:# +# Value Helpers # +#:########################################################################################:# + +clamp_integer() { + local value="$1" + local minimum="$2" + local maximum="$3" + + if (( value < minimum )); then + value="$minimum" + elif (( value > maximum )); then + value="$maximum" + fi + + printf '%s\n' "$value" +} + +read_integer_file() { + local file="$1" + local fallback="$2" + local minimum="$3" + local maximum="$4" + local value="" + + if [[ -r "$file" ]]; then + read -r value < "$file" || true + fi + + if [[ ! "$value" =~ ^[0-9]+$ ]]; then + value="$fallback" + fi + + clamp_integer "$value" "$minimum" "$maximum" +} + +write_state_file() { + local file="$1" + local value="$2" + local temporary_file="${file}.tmp" + + printf '%s\n' "$value" > "$temporary_file" + chmod 600 "$temporary_file" + mv -f "$temporary_file" "$file" +} + +get_current_brightness() { + read_integer_file "$CURRENT_BRIGHTNESS_FILE" 100 1 100 +} + +get_presence_brightness() { + read_integer_file "$PRESENCE_BRIGHTNESS_FILE" 80 1 100 +} + +get_presence_timeout() { + read_integer_file "$PRESENCE_TIMEOUT_FILE" 300 5 86400 +} + +get_motion_wake() { + local value="ON" + + if [[ -r "$MOTION_WAKE_FILE" ]]; then + read -r value < "$MOTION_WAKE_FILE" || true + fi + + case "${value^^}" in + OFF) + printf 'OFF\n' + ;; + + *) + printf 'ON\n' + ;; + esac +} + +get_presence_active() { + local value="OFF" + + if [[ -r "$PRESENCE_ACTIVE_FILE" ]]; then + read -r value < "$PRESENCE_ACTIVE_FILE" || true + fi + + case "${value^^}" in + ON) + printf 'ON\n' + ;; + + *) + printf 'OFF\n' + ;; + esac +} + +get_display_mode() { + local value="Screen On" + + if [[ -r "$DISPLAY_MODE_FILE" ]]; then + read -r value < "$DISPLAY_MODE_FILE" || true + fi + + case "${value^^}" in + "SCREEN LOCK") + printf 'Screen Lock\n' + ;; + + "SCREEN OFF") + printf 'Screen Off\n' + ;; + + "SCREENSAVER") + printf 'Screensaver\n' + ;; + + *) + printf 'Screen On\n' + ;; + esac +} + + +#:########################################################################################:# +# Camera Service Functions # +#:########################################################################################:# + +camera_should_run() { + if [[ "$(get_motion_wake)" == "ON" ]] && + [[ "$(get_display_mode)" != "Screen Lock" ]]; then + return 0 + fi + + return 1 +} + +sync_camera_service() { + if camera_should_run; then + if ! /usr/bin/systemctl --user \ + is-active --quiet "$MOTION_SERVICE"; then + + /usr/bin/systemctl --user \ + start "$MOTION_SERVICE" \ + >/dev/null 2>&1 || true + fi + + else + if /usr/bin/systemctl --user \ + is-active --quiet "$MOTION_SERVICE"; then + + /usr/bin/systemctl --user \ + stop "$MOTION_SERVICE" \ + >/dev/null 2>&1 || true + fi + + # Ensure the retained Motion state returns to OFF even when Motion is + # deliberately stopped before it publishes an event-end message. + if [[ -x "$MOTION_EVENT_SCRIPT" ]]; then + "$MOTION_EVENT_SCRIPT" end >/dev/null 2>&1 || true + fi + fi +} + +set_presence_active() { + local value="${1^^}" + + case "$value" in + ON|OFF) + write_state_file "$PRESENCE_ACTIVE_FILE" "$value" + publish_retained "$PRESENCE_ACTIVE_STATE_TOPIC" "$value" + ;; + esac +} + +set_display_mode_state() { + local mode="$1" + + write_state_file "$DISPLAY_MODE_FILE" "$mode" + publish_retained "$DISPLAY_MODE_STATE_TOPIC" "$mode" +} + +#:########################################################################################:# +# Display and Audio Helpers # +#:########################################################################################:# + +set_physical_brightness() { + local brightness="$1" + + /usr/bin/brightnessctl \ + --device=intel_backlight \ + set "${brightness}%" \ + >/dev/null +} + +get_physical_brightness() { + /usr/bin/brightnessctl \ + --device=intel_backlight \ + --machine-readable | + /usr/bin/cut -d',' -f4 | + /usr/bin/tr -d '%' +} + +get_screen_state() { + /usr/bin/xset q | + /usr/bin/awk '/Monitor is/ { print toupper($3) }' +} + +touchscreen_is_enabled() { + /usr/bin/xinput \ + list-props "$TOUCH_DEVICE_NAME" | + /usr/bin/awk '/Device Enabled/ { print $NF; exit }' +} + +touchscreen_enable() { + /usr/bin/xinput \ + enable "$TOUCH_DEVICE_NAME" \ + >/dev/null 2>&1 || true + + /usr/bin/xinput \ + map-to-output "$TOUCH_DEVICE_NAME" "$TOUCH_DISPLAY_OUTPUT" \ + >/dev/null 2>&1 || true +} + +touchscreen_disable() { + /usr/bin/xinput \ + disable "$TOUCH_DEVICE_NAME" \ + >/dev/null 2>&1 || true +} + +#:########################################################################################:# +# Chrome Kiosk Functions # +#:########################################################################################:# + +restart_chrome_kiosk() { + /usr/bin/systemctl --user restart "$BROWSER_SERVICE" +} + +#:########################################################################################:# +# Screensaver Functions # +#:########################################################################################:# + +screensaver_is_running() { + /usr/bin/pgrep -x xscreensaver >/dev/null 2>&1 +} + +screensaver_start() { + # The screensaver requires the physical display to be on. + /usr/bin/xset +dpms + /usr/bin/xset dpms force on + + if ! screensaver_is_running; then + /usr/bin/xscreensaver \ + -no-splash \ + >/dev/null 2>&1 & + + for _ in {1..20}; do + if screensaver_is_running; then + break + fi + + /usr/bin/sleep 0.1 + done + fi + + /usr/bin/xscreensaver-command \ + -activate \ + >/dev/null 2>&1 || true + + # XScreenSaver disables DPMS while activating. Re-enable it afterwards so + # physical screen state reporting and manual DPMS control continue to work. + /usr/bin/xset +dpms + /usr/bin/xset dpms force on +} + +screensaver_stop() { + /usr/bin/xscreensaver-command \ + -exit \ + >/dev/null 2>&1 || true + + /usr/bin/pkill \ + -x glmatrix \ + >/dev/null 2>&1 || true +} + +#:########################################################################################:# +# Display Mode Functions # +#:########################################################################################:# + +apply_display_mode_base_state() { + local mode="" + local current_brightness="" + + mode="$(get_display_mode)" + current_brightness="$(get_current_brightness)" + + case "$mode" in + "Screen Lock") + touchscreen_disable + screensaver_stop + /usr/bin/xset +dpms + /usr/bin/xset dpms force off + set_physical_brightness "$SCREEN_LOCK_BRIGHTNESS" + ;; + + "Screen Off") + touchscreen_enable + screensaver_stop + set_physical_brightness "$SCREEN_LOCK_BRIGHTNESS" + /usr/bin/xset +dpms + /usr/bin/xset dpms force off + ;; + + "Screensaver") + touchscreen_enable + set_physical_brightness "$current_brightness" + screensaver_start + ;; + + "Screen On") + touchscreen_enable + screensaver_stop + set_physical_brightness "$current_brightness" + /usr/bin/xset +dpms + /usr/bin/xset dpms force on + ;; + esac +} + +enforce_display_mode() { + local mode="" + local screen_state="" + local touch_enabled="" + + mode="$(get_display_mode)" + screen_state="$(get_screen_state)" + touch_enabled="$(touchscreen_is_enabled)" + + case "$mode" in + "Screen Lock") + if [[ "$touch_enabled" != "0" ]]; then + touchscreen_disable + fi + + if screensaver_is_running; then + screensaver_stop + fi + + if [[ "$screen_state" != "OFF" ]] || + [[ "$(get_physical_brightness)" -gt "$SCREEN_LOCK_BRIGHTNESS" ]]; then + printf '%s Screen Lock corrected unexpected DPMS state: %s\n' \ + "$(/usr/bin/date --iso-8601=seconds)" \ + "${screen_state:-UNKNOWN}" \ + >&2 + + /usr/bin/xset +dpms + /usr/bin/xset dpms force off + set_physical_brightness "$SCREEN_LOCK_BRIGHTNESS" + fi + ;; + + "Screen Off") + if [[ "$touch_enabled" != "1" ]]; then + touchscreen_enable + fi + + if [[ "$(get_presence_active)" != "ON" ]]; then + if screensaver_is_running; then + screensaver_stop + fi + + #if [[ "$screen_state" != "OFF" ]]; then + /usr/bin/xset +dpms + /usr/bin/xset dpms force off + #fi + fi + ;; + + "Screensaver") + if [[ "$touch_enabled" != "1" ]]; then + touchscreen_enable + fi + + if [[ "$(get_presence_active)" != "ON" ]]; then + if [[ "$screen_state" != "ON" ]] || + ! screensaver_is_running; then + screensaver_start + fi + fi + ;; + + "Screen On") + if [[ "$touch_enabled" != "1" ]]; then + touchscreen_enable + fi + + if [[ "$(get_presence_active)" != "ON" ]]; then + if screensaver_is_running; then + screensaver_stop + fi + + if [[ "$screen_state" != "ON" ]]; then + /usr/bin/xset +dpms + /usr/bin/xset dpms force on + fi + fi + ;; + esac +} + +set_display_mode() { + local mode="$1" + + cancel_presence_ramp + set_presence_active "OFF" + set_display_mode_state "$mode" + apply_display_mode_base_state + sync_camera_service +} + +#:########################################################################################:# +# Presence Functions # +#:########################################################################################:# + +presence_ramp_pid="" + +cancel_presence_ramp() { + if [[ -n "$presence_ramp_pid" ]] && + /usr/bin/kill -0 "$presence_ramp_pid" >/dev/null 2>&1; then + /usr/bin/kill "$presence_ramp_pid" >/dev/null 2>&1 || true + wait "$presence_ramp_pid" 2>/dev/null || true + fi + + presence_ramp_pid="" +} + +activate_presence() { + local mode="" + local presence_brightness="" + + mode="$(get_display_mode)" + + if [[ "$mode" == "Screen Lock" ]]; then + return + fi + + cancel_presence_ramp + + presence_brightness="$(get_presence_brightness)" + + touchscreen_enable + screensaver_stop + /usr/bin/xset +dpms + /usr/bin/xset dpms force on + set_physical_brightness "$presence_brightness" + set_presence_active "ON" +} + +run_presence_ramp() { + local timeout_seconds="${1:-}" + local interval_seconds="" + local remaining_steps="" + local actual_brightness="" + local target_brightness="" + local brightness_difference="" + local brightness_change="" + local next_brightness="" + + if [[ -z "$timeout_seconds" ]]; then + timeout_seconds="$(get_presence_timeout)" + fi + + interval_seconds="$( + /usr/bin/awk \ + -v timeout="$timeout_seconds" \ + 'BEGIN { printf "%.3f\n", timeout / 10 }' + )" + + for ((remaining_steps = 10; remaining_steps >= 1; remaining_steps--)); do + /usr/bin/sleep "$interval_seconds" + + # Stop without changing the selected display mode when cancelled. + if [[ "$(get_presence_active)" != "ON" ]]; then + return + fi + + actual_brightness="$(get_physical_brightness)" + target_brightness="$(get_current_brightness)" + + if [[ ! "$actual_brightness" =~ ^[0-9]+$ ]] || + [[ ! "$target_brightness" =~ ^[0-9]+$ ]]; then + continue + fi + + brightness_difference=$((target_brightness - actual_brightness)) + + # The final step always applies the exact latest Current Brightness. + if (( remaining_steps == 1 )); then + next_brightness="$target_brightness" + + elif (( brightness_difference >= 0 )); then + brightness_change=$(( + (brightness_difference + remaining_steps / 2) / + remaining_steps + )) + + next_brightness=$((actual_brightness + brightness_change)) + + else + brightness_change=$(( + ((-brightness_difference) + remaining_steps / 2) / + remaining_steps + )) + + next_brightness=$((actual_brightness - brightness_change)) + fi + + next_brightness="$( + clamp_integer "$next_brightness" 1 100 + )" + + set_physical_brightness "$next_brightness" + done + + # Re-read the target so the final level includes any Current Brightness + # changes received while the ramp was running. + target_brightness="$(get_current_brightness)" + set_physical_brightness "$target_brightness" + set_presence_active "OFF" + apply_display_mode_base_state +} + +schedule_presence_ramp() { + local timeout_seconds="${1:-}" + + cancel_presence_ramp + + if [[ "$(get_presence_active)" != "ON" ]]; then + return + fi + + run_presence_ramp "$timeout_seconds" & + presence_ramp_pid="$!" +} + +handle_touch_activity() { + if [[ "$(get_display_mode)" == "Screen Lock" ]]; then + return + fi + + activate_presence + + # Qualifying camera motion holds presence active. Otherwise, a touch starts + # or restarts the shared Presence Timeout immediately. + if [[ "$current_motion_state" == "ON" ]] && + [[ "$(get_motion_wake)" == "ON" ]]; then + return + fi + + schedule_presence_ramp +} + +#:########################################################################################:# +# Initialisation # +#:########################################################################################:# + +current_display_mode="$(get_display_mode)" +current_brightness="$(get_current_brightness)" +presence_brightness="$(get_presence_brightness)" +presence_timeout="$(get_presence_timeout)" +motion_wake="$(get_motion_wake)" + +write_state_file "$DISPLAY_MODE_FILE" "$current_display_mode" +write_state_file "$CURRENT_BRIGHTNESS_FILE" "$current_brightness" +write_state_file "$PRESENCE_BRIGHTNESS_FILE" "$presence_brightness" +write_state_file "$PRESENCE_TIMEOUT_FILE" "$presence_timeout" +write_state_file "$PRESENCE_ACTIVE_FILE" "OFF" +write_state_file "$MOTION_WAKE_FILE" "$motion_wake" + +# Enable manual DPMS control without configuring an automatic display-off timeout. +/usr/bin/xset +dpms + +# A service restart ends temporary presence and restores the selected base mode. +screensaver_stop +set_presence_active "OFF" +apply_display_mode_base_state +sync_camera_service + +# Remove retained commands from the two controls replaced by Display Mode. +for legacy_topic in \ + "$LEGACY_SCREEN_COMMAND_TOPIC" \ + "$LEGACY_SCREENSAVER_COMMAND_TOPIC"; do + mqtt_publish \ + -r \ + -n \ + -t "$legacy_topic" \ + >/dev/null 2>&1 || true +done + +publish_retained "$DISPLAY_MODE_STATE_TOPIC" "$current_display_mode" +publish_retained "$CURRENT_BRIGHTNESS_STATE_TOPIC" "$current_brightness" +publish_retained "$PRESENCE_BRIGHTNESS_STATE_TOPIC" "$presence_brightness" +publish_retained "$PRESENCE_TIMEOUT_STATE_TOPIC" "$presence_timeout" +publish_retained "$PRESENCE_ACTIVE_STATE_TOPIC" "OFF" +publish_retained "$MOTION_WAKE_STATE_TOPIC" "$motion_wake" + +#:########################################################################################:# +# State Reporting # +#:########################################################################################:# + +( + previous_display_mode="" + previous_screen_state="" + previous_actual_brightness="" + previous_current_brightness="" + previous_presence_brightness="" + previous_presence_active="" + previous_presence_timeout="" + previous_motion_wake="" + previous_volume="" + previous_mute_state="" + previous_screensaver_state="" + last_full_state_publish=0 + + while true; do + + current_display_mode="$(get_display_mode)" + current_screen_state="$(get_screen_state)" + actual_brightness="$(get_physical_brightness)" + saved_current_brightness="$(get_current_brightness)" + saved_presence_brightness="$(get_presence_brightness)" + current_presence_active="$(get_presence_active)" + saved_presence_timeout="$(get_presence_timeout)" + current_motion_wake="$(get_motion_wake)" + + audio_state="$( + /usr/bin/wpctl get-volume @DEFAULT_AUDIO_SINK@ + )" + + current_volume="$( + /usr/bin/awk \ + '{ printf "%.0f\n", $2 * 100 }' \ + <<< "$audio_state" + )" + + if /usr/bin/grep -q '\[MUTED\]' <<< "$audio_state"; then + current_mute_state="ON" + else + current_mute_state="OFF" + fi + + if screensaver_is_running; then + current_screensaver_state="ON" + else + current_screensaver_state="OFF" + fi + + state_report_epoch="$(/usr/bin/date +%s)" + if (( state_report_epoch - last_full_state_publish >= MQTT_REPUBLISH_INTERVAL_SECONDS )); then + # Reassert retained state after a broker restart, even when unchanged. + mqtt_publish -t "$MQTT_HEARTBEAT_TOPIC" -m "$state_report_epoch" + publish_retained "$DISPLAY_MODE_STATE_TOPIC" "$current_display_mode" + if [[ "$current_screen_state" == "ON" || "$current_screen_state" == "OFF" ]]; then + publish_retained "$SCREEN_STATE_TOPIC" "$current_screen_state" + fi + if [[ "$actual_brightness" =~ ^[0-9]+$ ]]; then + publish_retained "$ACTUAL_BRIGHTNESS_STATE_TOPIC" "$actual_brightness" + fi + publish_retained "$CURRENT_BRIGHTNESS_STATE_TOPIC" "$saved_current_brightness" + publish_retained "$PRESENCE_BRIGHTNESS_STATE_TOPIC" "$saved_presence_brightness" + publish_retained "$PRESENCE_ACTIVE_STATE_TOPIC" "$current_presence_active" + publish_retained "$PRESENCE_TIMEOUT_STATE_TOPIC" "$saved_presence_timeout" + publish_retained "$MOTION_WAKE_STATE_TOPIC" "$current_motion_wake" + if [[ "$current_volume" =~ ^[0-9]+$ ]]; then + publish_retained "$VOLUME_STATE_TOPIC" "$current_volume" + fi + publish_retained "$MUTE_STATE_TOPIC" "$current_mute_state" + publish_retained "$SCREENSAVER_STATE_TOPIC" "$current_screensaver_state" + last_full_state_publish="$state_report_epoch" + fi + + if [[ "$current_display_mode" != "$previous_display_mode" ]]; then + publish_retained "$DISPLAY_MODE_STATE_TOPIC" "$current_display_mode" + previous_display_mode="$current_display_mode" + fi + + if [[ "$current_screen_state" == "ON" || + "$current_screen_state" == "OFF" ]]; then + if [[ "$current_screen_state" != "$previous_screen_state" ]]; then + publish_retained "$SCREEN_STATE_TOPIC" "$current_screen_state" + previous_screen_state="$current_screen_state" + fi + fi + + if [[ "$actual_brightness" =~ ^[0-9]+$ ]] && + [[ "$actual_brightness" != "$previous_actual_brightness" ]]; then + publish_retained "$ACTUAL_BRIGHTNESS_STATE_TOPIC" "$actual_brightness" + previous_actual_brightness="$actual_brightness" + fi + + if [[ "$saved_current_brightness" != "$previous_current_brightness" ]]; then + publish_retained "$CURRENT_BRIGHTNESS_STATE_TOPIC" "$saved_current_brightness" + previous_current_brightness="$saved_current_brightness" + fi + + if [[ "$saved_presence_brightness" != "$previous_presence_brightness" ]]; then + publish_retained "$PRESENCE_BRIGHTNESS_STATE_TOPIC" "$saved_presence_brightness" + previous_presence_brightness="$saved_presence_brightness" + fi + + if [[ "$current_presence_active" != "$previous_presence_active" ]]; then + publish_retained "$PRESENCE_ACTIVE_STATE_TOPIC" "$current_presence_active" + previous_presence_active="$current_presence_active" + fi + + if [[ "$saved_presence_timeout" != "$previous_presence_timeout" ]]; then + publish_retained "$PRESENCE_TIMEOUT_STATE_TOPIC" "$saved_presence_timeout" + previous_presence_timeout="$saved_presence_timeout" + fi + + if [[ "$current_motion_wake" != "$previous_motion_wake" ]]; then + publish_retained "$MOTION_WAKE_STATE_TOPIC" "$current_motion_wake" + previous_motion_wake="$current_motion_wake" + fi + + if [[ "$current_volume" =~ ^[0-9]+$ ]] && + [[ "$current_volume" != "$previous_volume" ]]; then + publish_retained "$VOLUME_STATE_TOPIC" "$current_volume" + previous_volume="$current_volume" + fi + + if [[ "$current_mute_state" != "$previous_mute_state" ]]; then + publish_retained "$MUTE_STATE_TOPIC" "$current_mute_state" + previous_mute_state="$current_mute_state" + fi + + if [[ "$current_screensaver_state" != "$previous_screensaver_state" ]]; then + publish_retained "$SCREENSAVER_STATE_TOPIC" "$current_screensaver_state" + previous_screensaver_state="$current_screensaver_state" + fi + + /usr/bin/sleep 2 + done +) & + +state_reporter_pid="$!" + +#:########################################################################################:# +# Event Listeners # +#:########################################################################################:# + +rm -f "$MQTT_EVENT_FIFO" "$TOUCH_EVENT_FIFO" +mkfifo "$MQTT_EVENT_FIFO" "$TOUCH_EVENT_FIFO" +chmod 600 "$MQTT_EVENT_FIFO" "$TOUCH_EVENT_FIFO" + +# Open both FIFOs read/write in the parent so listener startup does not block and +# a listener failure cannot silently end the main event loop. +exec 3<>"$MQTT_EVENT_FIFO" +exec 4<>"$TOUCH_EVENT_FIFO" + +/usr/bin/stdbuf -oL /usr/bin/mosquitto_sub \ + -t "$DISPLAY_MODE_COMMAND_TOPIC" \ + -t "$CURRENT_BRIGHTNESS_COMMAND_TOPIC" \ + -t "$PRESENCE_BRIGHTNESS_COMMAND_TOPIC" \ + -t "$PRESENCE_TIMEOUT_COMMAND_TOPIC" \ + -t "$PRESENCE_END_COMMAND_TOPIC" \ + -t "$MOTION_STATE_TOPIC" \ + -t "$MOTION_WAKE_COMMAND_TOPIC" \ + -t "$VOLUME_COMMAND_TOPIC" \ + -t "$MUTE_COMMAND_TOPIC" \ + -t "$CHROME_RESTART_COMMAND_TOPIC" \ + -t "$MQTT_HEARTBEAT_TOPIC" \ + -F "%t|%p" \ + > "$MQTT_EVENT_FIFO" & + +mqtt_listener_pid="$!" + +( + /usr/bin/stdbuf \ + -oL \ + /usr/bin/xinput test-xi2 --root | + /usr/bin/awk ' + /EVENT type 22 \(RawTouchBegin\)/ { + print "TOUCH" + fflush() + } + ' +) > "$TOUCH_EVENT_FIFO" & + +touch_listener_pid="$!" + +cleanup() { + cancel_presence_ramp + + for process_id in \ + "$state_reporter_pid" \ + "$mqtt_listener_pid" \ + "$touch_listener_pid"; do + if /usr/bin/kill -0 "$process_id" >/dev/null 2>&1; then + /usr/bin/kill "$process_id" >/dev/null 2>&1 || true + fi + done + + exec 3>&- 3<&- + exec 4>&- 4<&- + + rm -f "$MQTT_EVENT_FIFO" "$TOUCH_EVENT_FIFO" +} + +trap cleanup EXIT INT TERM + +#:########################################################################################:# +# MQTT Command Handler # +#:########################################################################################:# + +current_motion_state="OFF" + +handle_mqtt_message() { + local topic="$1" + local payload="$2" + + case "$topic" in + + "$MQTT_HEARTBEAT_TOPIC") + if [[ "$payload" =~ ^[0-9]+$ ]]; then + last_mqtt_heartbeat_epoch="$payload" + fi + ;; + + "$DISPLAY_MODE_COMMAND_TOPIC") + case "${payload^^}" in + "SCREEN LOCK") + set_display_mode "Screen Lock" + ;; + + "SCREEN OFF") + set_display_mode "Screen Off" + ;; + + "SCREENSAVER") + set_display_mode "Screensaver" + ;; + + "SCREEN ON") + set_display_mode "Screen On" + ;; + esac + ;; + + "$CURRENT_BRIGHTNESS_COMMAND_TOPIC") + if [[ "$payload" =~ ^[0-9]+$ ]]; then + payload="$(clamp_integer "$payload" 1 100)" + write_state_file "$CURRENT_BRIGHTNESS_FILE" "$payload" + publish_retained "$CURRENT_BRIGHTNESS_STATE_TOPIC" "$payload" + + if [[ "$(get_presence_active)" != "ON" ]]; then + case "$(get_display_mode)" in + "Screensaver"|"Screen On") + set_physical_brightness "$payload" + ;; + esac + fi + fi + ;; + + "$PRESENCE_BRIGHTNESS_COMMAND_TOPIC") + if [[ "$payload" =~ ^[0-9]+$ ]]; then + payload="$(clamp_integer "$payload" 1 100)" + write_state_file "$PRESENCE_BRIGHTNESS_FILE" "$payload" + publish_retained "$PRESENCE_BRIGHTNESS_STATE_TOPIC" "$payload" + + if [[ "$(get_presence_active)" == "ON" ]]; then + set_physical_brightness "$payload" + fi + fi + ;; + + "$PRESENCE_TIMEOUT_COMMAND_TOPIC") + if [[ "$payload" =~ ^[0-9]+$ ]]; then + payload="$(clamp_integer "$payload" 5 86400)" + write_state_file "$PRESENCE_TIMEOUT_FILE" "$payload" + publish_retained "$PRESENCE_TIMEOUT_STATE_TOPIC" "$payload" + + if [[ "$(get_presence_active)" == "ON" ]]; then + if [[ "$current_motion_state" != "ON" ]] || + [[ "$(get_motion_wake)" != "ON" ]]; then + schedule_presence_ramp + fi + fi + fi + ;; + + "$PRESENCE_END_COMMAND_TOPIC") + if [[ "$payload" =~ ^[0-9]+$ ]] && + (( payload >= 1 && payload <= 3600 )); then + schedule_presence_ramp "$payload" + fi + ;; + + "$MOTION_STATE_TOPIC") + case "${payload^^}" in + ON) + current_motion_state="ON" + + if [[ "$(get_motion_wake)" == "ON" ]] && + [[ "$(get_display_mode)" != "Screen Lock" ]]; then + activate_presence + fi + ;; + + OFF) + current_motion_state="OFF" + + if [[ "$(get_motion_wake)" == "ON" ]] && + [[ "$(get_presence_active)" == "ON" ]]; then + schedule_presence_ramp + fi + ;; + esac + ;; + + "$MOTION_WAKE_COMMAND_TOPIC") + case "${payload^^}" in + ON) + write_state_file "$MOTION_WAKE_FILE" "ON" + publish_retained "$MOTION_WAKE_STATE_TOPIC" "ON" + sync_camera_service + + if [[ "$current_motion_state" == "ON" ]] && + [[ "$(get_display_mode)" != "Screen Lock" ]]; then + activate_presence + fi + ;; + + OFF) + write_state_file "$MOTION_WAKE_FILE" "OFF" + publish_retained "$MOTION_WAKE_STATE_TOPIC" "OFF" + sync_camera_service + + # Disabling Motion Wake stops current motion from indefinitely holding + # presence active. Touch-triggered presence still uses the same timeout. + if [[ "$current_motion_state" == "ON" ]] && + [[ "$(get_presence_active)" == "ON" ]]; then + schedule_presence_ramp + fi + ;; + esac + ;; + + "$VOLUME_COMMAND_TOPIC") + if [[ "$payload" =~ ^[0-9]+$ ]]; then + payload="$(clamp_integer "$payload" 0 100)" + + /usr/bin/wpctl \ + set-volume \ + @DEFAULT_AUDIO_SINK@ \ + "${payload}%" + fi + ;; + + "$MUTE_COMMAND_TOPIC") + case "${payload^^}" in + ON) + /usr/bin/wpctl set-mute @DEFAULT_AUDIO_SINK@ 1 + ;; + + OFF) + /usr/bin/wpctl set-mute @DEFAULT_AUDIO_SINK@ 0 + ;; + esac + ;; + + "$CHROME_RESTART_COMMAND_TOPIC") + case "${payload^^}" in + PRESS|RESTART) + restart_chrome_kiosk + ;; + esac + ;; + + esac +} + +#:########################################################################################:# +# Main Event Loop # +#:########################################################################################:# + +last_mqtt_heartbeat_epoch="$(/usr/bin/date +%s)" + +while true; do + + if ! /usr/bin/kill -0 "$mqtt_listener_pid" >/dev/null 2>&1; then + exit 1 + fi + + if ! /usr/bin/kill -0 "$touch_listener_pid" >/dev/null 2>&1; then + exit 1 + fi + + current_epoch="$(/usr/bin/date +%s)" + if (( current_epoch - last_mqtt_heartbeat_epoch > MQTT_HEARTBEAT_TIMEOUT_SECONDS )); then + exit 1 + fi + + if IFS='|' read -r -t 0.20 -u 3 topic payload; then + handle_mqtt_message "$topic" "$payload" + + # Drain any additional MQTT messages already waiting in the FIFO. + while IFS='|' read -r -t 0.01 -u 3 topic payload; do + handle_mqtt_message "$topic" "$payload" + done + fi + + while IFS= read -r -t 0.01 -u 4 touch_event; do + if [[ "$touch_event" == "TOUCH" ]]; then + handle_touch_activity + fi + done + + # Check the requested display mode after every event-loop cycle. + # The MQTT read timeout limits this to approximately five checks per second. + enforce_display_mode + +done diff --git a/runtime/systemd.env.example b/runtime/systemd.env.example new file mode 100644 index 0000000..05f68c5 --- /dev/null +++ b/runtime/systemd.env.example @@ -0,0 +1,4 @@ +# SPDX-License-Identifier: GPL-3.0-or-later +# Values used by systemd ExecStopPost. Keep these simple (no spaces). +KIOSK_ID=my_kiosk +STATUS_ROOT=kiosk/status diff --git a/telemetry/kiosk-telemetry.py b/telemetry/kiosk-telemetry.py new file mode 100755 index 0000000..09c91ae --- /dev/null +++ b/telemetry/kiosk-telemetry.py @@ -0,0 +1,245 @@ +#!/usr/bin/env python3 +# SPDX-License-Identifier: GPL-3.0-or-later +"""Publish low-overhead Linux kiosk performance telemetry to MQTT.""" + +import glob +import json +import os +import socket +import time + +import psutil +import paho.mqtt.client as mqtt # type: ignore[import-not-found] + + +MQTT_HOST = os.environ["MQTT_HOST"] +MQTT_PORT = int(os.environ.get("MQTT_PORT", "1883")) +MQTT_USER = os.environ.get("MQTT_USER") +MQTT_PASSWORD = os.environ.get("MQTT_PASSWORD") +KIOSK_ID = os.environ.get("KIOSK_ID", "kiosk") +KIOSK_ENTITY_PREFIX = os.environ.get("KIOSK_ENTITY_PREFIX", f"{KIOSK_ID}_kiosk") +KIOSK_NAME = os.environ.get("KIOSK_NAME", f"{KIOSK_ID.replace('-', ' ').title()} Kiosk") +KIOSK_MANUFACTURER = os.environ.get("KIOSK_MANUFACTURER", "Unknown") +KIOSK_MODEL = os.environ.get("KIOSK_MODEL", "Linux Touchscreen Kiosk") +MQTT_TOPIC = os.environ.get("MQTT_TOPIC", f"{KIOSK_ID}/kiosk/performance") +SAMPLE_SECONDS = max(5, int(os.environ.get("SAMPLE_SECONDS", "10"))) + +STATE_TOPIC = f"{MQTT_TOPIC}/state" +AVAILABILITY_TOPIC = f"{MQTT_TOPIC}/availability" +DISCOVERY_PREFIX = os.environ.get("MQTT_DISCOVERY_PREFIX", "homeassistant") + +DEVICE = { + "identifiers": [KIOSK_ENTITY_PREFIX], + "name": KIOSK_NAME, + "manufacturer": KIOSK_MANUFACTURER, + "model": KIOSK_MODEL, +} + +METRICS = { + "system_cpu_percent": ("System CPU", "%", None, "measurement", "mdi:cpu-64-bit"), + "system_iowait_percent": ("CPU I/O Wait", "%", None, "measurement", "mdi:timer-sand"), + "load_1m": ("Load 1 Minute", None, None, "measurement", "mdi:gauge"), + "load_5m": ("Load 5 Minutes", None, None, "measurement", "mdi:gauge"), + "memory_percent": ("Memory Used", "%", None, "measurement", "mdi:memory"), + "cpu_temperature": ("CPU Temperature", "°C", "temperature", "measurement", "mdi:thermometer"), + "cpu_frequency": ("CPU Frequency", "MHz", "frequency", "measurement", "mdi:sine-wave"), + "fan_speed": ("Fan Speed", "rpm", None, "measurement", "mdi:fan"), + "processor_fan_speed": ("Processor Fan Speed", "rpm", None, "measurement", "mdi:fan"), + "motherboard_fan_speed": ("Motherboard Fan Speed", "rpm", None, "measurement", "mdi:fan"), + "chrome_cpu_percent": ("Chrome CPU", "%", None, "measurement", "mdi:google-chrome"), + "chrome_browser_cpu_percent": ("Chrome Browser CPU", "%", None, "measurement", "mdi:web"), + "chrome_renderer_cpu_percent": ("Chrome Renderer CPU", "%", None, "measurement", "mdi:monitor-dashboard"), + "chrome_gpu_cpu_percent": ("Chrome GPU Process CPU", "%", None, "measurement", "mdi:expansion-card"), + "chrome_utility_cpu_percent": ("Chrome Utility CPU", "%", None, "measurement", "mdi:cog-transfer"), + "chrome_memory": ("Chrome Memory", "MB", "data_size", "measurement", "mdi:memory"), + "chrome_processes": ("Chrome Processes", None, None, "measurement", "mdi:format-list-numbered"), + "gpu_busy_percent": ("GPU Busy", "%", None, "measurement", "mdi:expansion-card-variant"), + "network_receive_rate": ("Network Receive Rate", "kB/s", "data_rate", "measurement", "mdi:download-network"), + "network_transmit_rate": ("Network Transmit Rate", "kB/s", "data_rate", "measurement", "mdi:upload-network"), + "disk_read_rate": ("Disk Read Rate", "kB/s", "data_rate", "measurement", "mdi:harddisk"), + "disk_write_rate": ("Disk Write Rate", "kB/s", "data_rate", "measurement", "mdi:harddisk"), +} + + +def round_or_none(value, digits=1): + return round(value, digits) if value is not None else None + + +def cpu_temperature(): + values = [] + try: + for entries in psutil.sensors_temperatures().values(): + values.extend(entry.current for entry in entries if entry.current is not None) + except (AttributeError, OSError): + pass + return max(values) if values else None + + +def fan_speeds(): + result: dict[str, float | None] = { + "maximum": None, + "processor": None, + "motherboard": None, + } + try: + for entries in psutil.sensors_fans().values(): + for entry in entries: + if entry.current is None: + continue + result["maximum"] = max(result["maximum"] or 0, entry.current) + label = (entry.label or "").lower() + if "processor" in label: + result["processor"] = entry.current + elif "motherboard" in label: + result["motherboard"] = entry.current + except (AttributeError, OSError): + pass + return result + + +def gpu_busy_percent(): + for pattern in ( + "/sys/class/drm/card*/device/gpu_busy_percent", + "/sys/class/drm/card*/gt_busy_percent", + ): + for path in glob.glob(pattern): + try: + with open(path, encoding="ascii") as source: + return float(source.read().strip()) + except (OSError, ValueError): + continue + return None + + +def chrome_processes(): + processes = [] + for process in psutil.process_iter(["name", "cmdline"]): + try: + name = (process.info["name"] or "").lower() + command = " ".join(process.info["cmdline"] or []).lower() + if not any(token in name for token in ("chrome", "chromium")): + continue + if "--type=renderer" in command: + group = "renderer" + elif "--type=gpu-process" in command: + group = "gpu" + elif "--type=utility" in command: + group = "utility" + elif "--type=" not in command: + group = "browser" + else: + group = "other" + process.cpu_percent(None) + processes.append((process, group)) + except (psutil.AccessDenied, psutil.NoSuchProcess, psutil.ZombieProcess): + continue + return processes + + +def publish_discovery(client): + for key, (name, unit, device_class, state_class, icon) in METRICS.items(): + config = { + "name": name, + "unique_id": f"{KIOSK_ENTITY_PREFIX}_{key}", + "state_topic": STATE_TOPIC, + "availability_topic": AVAILABILITY_TOPIC, + "value_template": f"{{{{ value_json.{key} }}}}", + "device": DEVICE, + "icon": icon, + } + if unit: + config["unit_of_measurement"] = unit + if device_class: + config["device_class"] = device_class + if state_class: + config["state_class"] = state_class + topic = f"{DISCOVERY_PREFIX}/sensor/{KIOSK_ENTITY_PREFIX}/{key}/config" + client.publish(topic, json.dumps(config, separators=(",", ":")), qos=1, retain=True) + + +def on_connect(client, userdata, flags, reason_code, properties=None): + """Restore all MQTT state after the initial connection or a reconnect.""" + publish_discovery(client) + client.publish(AVAILABILITY_TOPIC, "online", qos=1, retain=True) + + +def collect_sample(): + chrome = chrome_processes() + net_before = psutil.net_io_counters() + disk_before = psutil.disk_io_counters() + cpu_times = psutil.cpu_times_percent(interval=SAMPLE_SECONDS, percpu=False) + net_after = psutil.net_io_counters() + disk_after = psutil.disk_io_counters() + + cpu_by_group = {group: 0.0 for group in ("browser", "renderer", "gpu", "utility", "other")} + chrome_memory = 0 + active_processes = 0 + for process, group in chrome: + try: + cpu_by_group[group] += process.cpu_percent(None) + chrome_memory += process.memory_info().rss + active_processes += 1 + except (psutil.AccessDenied, psutil.NoSuchProcess, psutil.ZombieProcess): + continue + + load_1m, load_5m, _ = os.getloadavg() + frequency = psutil.cpu_freq() + fans = fan_speeds() + interval = float(SAMPLE_SECONDS) + disk_read_rate = None + disk_write_rate = None + if disk_before is not None and disk_after is not None: + disk_read_rate = (disk_after.read_bytes - disk_before.read_bytes) / interval / 1024 + disk_write_rate = (disk_after.write_bytes - disk_before.write_bytes) / interval / 1024 + sample = { + "timestamp": int(time.time()), + "hostname": socket.gethostname(), + "sample_seconds": SAMPLE_SECONDS, + "system_cpu_percent": round_or_none(100.0 - cpu_times.idle), + "system_iowait_percent": round_or_none(getattr(cpu_times, "iowait", 0.0)), + "load_1m": round(load_1m, 2), + "load_5m": round(load_5m, 2), + "memory_percent": round_or_none(psutil.virtual_memory().percent), + "cpu_temperature": round_or_none(cpu_temperature()), + "cpu_frequency": round_or_none(frequency.current if frequency else None, 0), + "fan_speed": round_or_none(fans["maximum"], 0), + "processor_fan_speed": round_or_none(fans["processor"], 0), + "motherboard_fan_speed": round_or_none(fans["motherboard"], 0), + "chrome_browser_cpu_percent": round_or_none(cpu_by_group["browser"]), + "chrome_renderer_cpu_percent": round_or_none(cpu_by_group["renderer"]), + "chrome_gpu_cpu_percent": round_or_none(cpu_by_group["gpu"]), + "chrome_utility_cpu_percent": round_or_none(cpu_by_group["utility"]), + "chrome_cpu_percent": round_or_none(sum(cpu_by_group.values())), + "chrome_memory": round(chrome_memory / 1048576, 1), + "chrome_processes": active_processes, + "gpu_busy_percent": round_or_none(gpu_busy_percent()), + "network_receive_rate": round((net_after.bytes_recv - net_before.bytes_recv) / interval / 1024, 1), + "network_transmit_rate": round((net_after.bytes_sent - net_before.bytes_sent) / interval / 1024, 1), + "disk_read_rate": round_or_none(disk_read_rate), + "disk_write_rate": round_or_none(disk_write_rate), + } + return sample + + +def main(): + client = mqtt.Client(client_id=f"{KIOSK_ID}-kiosk-telemetry") + if MQTT_USER: + client.username_pw_set(MQTT_USER, MQTT_PASSWORD) + client.will_set(AVAILABILITY_TOPIC, "offline", qos=1, retain=True) + client.on_connect = on_connect + client.reconnect_delay_set(min_delay=1, max_delay=30) + client.connect(MQTT_HOST, MQTT_PORT, keepalive=60) + client.loop_start() + + try: + while True: + payload = json.dumps(collect_sample(), separators=(",", ":"), allow_nan=False) + client.publish(STATE_TOPIC, payload, qos=0, retain=False) + finally: + client.publish(AVAILABILITY_TOPIC, "offline", qos=1, retain=True).wait_for_publish() + client.disconnect() + client.loop_stop() + + +if __name__ == "__main__": + main() diff --git a/telemetry/kiosk-telemetry.service b/telemetry/kiosk-telemetry.service new file mode 100644 index 0000000..580fda1 --- /dev/null +++ b/telemetry/kiosk-telemetry.service @@ -0,0 +1,15 @@ +# SPDX-License-Identifier: GPL-3.0-or-later +[Unit] +Description=Kiosk MQTT performance telemetry +Wants=network-online.target +After=network-online.target + +[Service] +Type=simple +EnvironmentFile=%h/.config/ha-kiosk/telemetry.env +ExecStart=/usr/bin/python3 %h/.local/lib/ha-kiosk-mqtt-control/kiosk-telemetry.py +Restart=always +RestartSec=10 + +[Install] +WantedBy=default.target diff --git a/telemetry/telemetry.env.example b/telemetry/telemetry.env.example new file mode 100644 index 0000000..1861e46 --- /dev/null +++ b/telemetry/telemetry.env.example @@ -0,0 +1,14 @@ +# SPDX-License-Identifier: GPL-3.0-or-later +# Copy to ~/.config/ha-kiosk/telemetry.env. This example has no credentials. +MQTT_HOST=127.0.0.1 +MQTT_PORT=1883 +MQTT_USER= +MQTT_PASSWORD= +KIOSK_ID=my_kiosk +KIOSK_ENTITY_PREFIX=my_kiosk +KIOSK_NAME="My Kiosk" +KIOSK_MANUFACTURER=Generic +KIOSK_MODEL="Linux Touchscreen Kiosk" +MQTT_TOPIC=my_kiosk/performance +MQTT_DISCOVERY_PREFIX=homeassistant +SAMPLE_SECONDS=10