diff --git a/kvitals/LICENSE b/kvitals/LICENSE new file mode 100644 index 00000000..f288702d --- /dev/null +++ b/kvitals/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/kvitals/README.md b/kvitals/README.md new file mode 100644 index 00000000..76db7810 --- /dev/null +++ b/kvitals/README.md @@ -0,0 +1,71 @@ +# KVitals + +Live CPU, RAM, GPU, temperature, fan, battery, network, and disk vitals +for the Noctalia bar, panel, and desktop. A Luau port of the KVitals +Plasma widget by yassine20011 (GPL-3.0). + +## Plugin + +| Field | Value | +| --- | --- | +| ID | `royalebiskut/kvitals` | +| Entries | Service: `sampler`; bar widget: `metrics`; panel: `sparkline`; desktop widget: `tile` | + +## Requirements + +- `cat` (coreutils) and `ip` (iproute2) on `PATH`. +- The Noctalia System Monitor service enabled for CPU, RAM, GPU, and load + data (`[system.monitor]` in the shell config). + +## Usage + +1. Install the plugin from the store and enable `royalebiskut/kvitals`. +2. Add the bar widget `metrics` from the Add-widget picker. +3. Add the desktop tile `tile` from the desktop widgets editor. +4. Left-click the bar widget to open the sparkline panel. +5. Right-click the bar widget to open the settings. + +Open the panel with: + +```sh +noctalia msg panel-toggle royalebiskut/kvitals:sparkline +``` + +## Settings + +Settings live under Settings -> Plugins -> KVitals. + +| Setting | Type | Default | Description | +| --- | --- | --- | --- | +| `refresh_ms` | `int` | `1000` | Sample interval in milliseconds. | +| `temp_unit` | `select` | `c` | Celsius or Fahrenheit. | +| `net_unit` | `select` | `auto` | Unit for network rates. | +| `metric_order` | `string_list` | `cpu, ram, temp, gpu, vram, fan, battery, net, disk` | Order of the metrics in the bar, panel, and desktop tile. | +| `enabled_cpu`, `enabled_ram`, `enabled_temp`, `enabled_gpu`, `enabled_vram`, `enabled_fan`, `enabled_battery`, `enabled_net`, `enabled_disk` | `bool` | `true` | Show or hide each metric. | +| `cpu_act` / `cpu_crit`, `ram_act` / `ram_crit`, `temp_act` / `temp_crit`, `gpu_act` / `gpu_crit`, `vram_act` / `vram_crit`, `disk_act` / `disk_crit` | `int` | per metric | Activity and critical thresholds in percent. Values at the activity level tint the metric toward the accent color; critical uses the accent color fully. | +| `net_act` / `net_crit` | `double` | `1` / `50` | Network thresholds in MB/s. | +| `icon_cpu`, `icon_ram`, `icon_temp`, `icon_gpu`, `icon_vram`, `icon_fan`, `icon_net`, `icon_disk` | `select` | per metric | Icon for each metric. | +| `accent_color`, `font_color` | `color` | theme | Colors for critical values, icons, and text. | +| `show_cpu_freq`, `show_power_draw`, `show_net_ip` | `bool` | `true` / `true` / `false` | Detail toggles for CPU clock, battery power draw, and the local IP address. | + +Per-instance widget settings: `display_mode` (icons, text, or both), +`font_size`, and `hide_absent`. Panel settings: `show_graphs` and +`graph_height`. Desktop tile settings: `show_glyphs` and `font_size`. + +## IPC + +No extra IPC events. The bar widget opens the panel on left-click and the +settings on right-click. + +## Notes + +- Read-only: sysfs (`/sys/class/hwmon`, `/sys/class/power_supply`, CPU + cpufreq), `/proc/diskstats`, and the host System Monitor service. + The plugin writes no files and makes no network calls. +- Spawns `cat` for tiny sysfs reads and `ip -j -brief addr` every + 30 seconds for the local IPv4 address (only when `show_net_ip` is + enabled and `ip` exists). +- GPU VRAM comes from the host System Monitor (amdgpu sysfs on AMD, + NVML on NVIDIA). +- License: GPL-3.0. Port of KVitals by yassine20011 + (https://github.com/yassine20011/kvitals). diff --git a/kvitals/desktop.luau b/kvitals/desktop.luau new file mode 100644 index 00000000..492ca9ca --- /dev/null +++ b/kvitals/desktop.luau @@ -0,0 +1,76 @@ +--!nonstrict +-- KVitals desktop tile: the same metric chips as the bar widget, stacked +-- vertically and pinned to the desktop. Reads the plugin state like every +-- other surface. + +local format = require("./lib/format.luau") +local chips = require("./lib/chips.luau") + +local sample = noctalia.state.get("kvitals.sample") +local config = noctalia.state.get("kvitals.config") +local ready = noctalia.state.get("kvitals.ready") == true + +local font_size = noctalia.getConfig("font_size") or 12 +local show_glyphs = noctalia.getConfig("show_glyphs") +if show_glyphs == nil then show_glyphs = true end + +local function chipColor(chip) + if chip.tint == "critical" then return config.accent end + if chip.tint == "active" then return format.withAlpha(config.accent, 0.65) end + return config.font +end + +local function render() + if not ready or sample == nil or config == nil then + desktopWidget.render(ui.label({ + text = "…", + fontSize = font_size, + color = "on_surface_variant", + })) + return + end + + local children = {} + for _, id in ipairs(config.metricOrder) do + if config.enabled[id] then + local chip = chips.chip(id, sample, config) + if chip then + local node + if show_glyphs then + node = ui.row({ gap = 6, align = "center" }, { + ui.glyph({ name = chip.glyph, size = math.floor(font_size * 1.25) }), + ui.label({ text = chip.text, fontSize = font_size, fontWeight = "medium", color = chipColor(chip) }), + }) + else + node = ui.label({ text = chip.text, fontSize = font_size, fontWeight = "medium", color = chipColor(chip) }) + end + table.insert(children, node) + end + end + end + + if #children == 0 then + children = { ui.label({ text = "-", fontSize = font_size, color = "on_surface_variant" }) } + end + + desktopWidget.render(ui.column({ gap = 8, align = "start" }, children)) +end + +noctalia.state.watch("kvitals.sample", function(value) + sample = value + render() +end) + +noctalia.state.watch("kvitals.config", function(value) + config = value + render() +end) + +noctalia.state.watch("kvitals.ready", function(value) + ready = value == true + render() +end) + +function update() + render() +end diff --git a/kvitals/lib/chips.luau b/kvitals/lib/chips.luau new file mode 100644 index 00000000..5290389e --- /dev/null +++ b/kvitals/lib/chips.luau @@ -0,0 +1,236 @@ +--!nonstrict +-- Shared metric descriptors for the bar widget, panel, and desktop tile. +-- +-- A chip is a plain table: { id, glyph, text, tint, charging }. +-- tint is nil (normal), "active" (at or above the activity threshold), +-- or "critical" (at or above the critical threshold). Pure functions over +-- the sample and the resolved config from the plugin state. + +local format = require("./format.luau") + +local M = {} + +local function tintLevel(thresholds, value) + if value == nil or thresholds == nil then return nil end + local act = thresholds.act or 50 + local crit = thresholds.crit or 90 + if value >= crit then return "critical" end + if value >= act then return "active" end + return nil +end + +local builders = { + cpu = function(s, c) + if s.cpu == nil or s.cpu.usage == nil then return nil end + local text = format.pct(s.cpu.usage) + if c.showCpuFreq and s.cpuFreqHz then + text = text .. " " .. format.freqCompact(s.cpuFreqHz) + end + return { + glyph = c.icons.cpu or "cpu", + text = text, + tint = tintLevel(c.thresholds.cpu, s.cpu.usage), + } + end, + + ram = function(s, c) + if s.ram == nil or s.ram.usage == nil then return nil end + return { + glyph = c.icons.ram or "database", + text = format.pct(s.ram.usage), + tint = tintLevel(c.thresholds.ram, s.ram.usage), + } + end, + + temp = function(s, c) + if s.cpu == nil or s.cpu.temp == nil then return nil end + return { + glyph = c.icons.temp or "temperature", + text = format.temp(s.cpu.temp, c.tempUnit, false), + tint = tintLevel(c.thresholds.temp, s.cpu.temp), + } + end, + + gpu = function(s, c) + if s.gpu == nil then return nil end + if s.gpu.usage ~= nil then + return { + glyph = c.icons.gpu or "device-desktop-analytics", + text = format.pct(s.gpu.usage), + tint = tintLevel(c.thresholds.gpu, s.gpu.usage), + } + end + if s.gpu.temp ~= nil then + return { + glyph = c.icons.gpu or "device-desktop-analytics", + text = format.temp(s.gpu.temp, c.tempUnit, false), + tint = tintLevel(c.thresholds.gpu, s.gpu.temp), + } + end + return nil + end, + + vram = function(s, c) + if s.gpu == nil or s.gpu.vramUsed == nil or s.gpu.vramTotal == nil then return nil end + if s.gpu.vramTotal <= 0 then return nil end + local pct = s.gpu.vramUsed / s.gpu.vramTotal * 100 + return { + glyph = c.icons.vram or "memory", + text = format.ramBytes(s.gpu.vramUsed) .. " / " .. format.ramBytes(s.gpu.vramTotal), + tint = tintLevel(c.thresholds.vram, pct), + } + end, + + fan = function(s, _c) + if s.fanRpm == nil then return nil end + return { glyph = c.icons.fan or "wind", text = format.rpm(s.fanRpm), tint = nil } + end, + + battery = function(s, c) + if s.battery == nil or s.battery.capacity == nil then return nil end + local text = format.pct(s.battery.capacity) + if c.showPowerDraw and s.battery.powerW then + text = text .. " " .. format.watts(s.battery.powerW) + end + local charging = false + if s.battery.status ~= nil and string.find(s.battery.status, "[Cc]harging") then + charging = true + end + return { + glyph = charging and "battery-charging" or "battery", + text = text, + tint = nil, + charging = charging, + } + end, + + net = function(s, c) + if s.net == nil or s.net.rx == nil then return nil end + local text = "↓" .. format.netBytes(s.net.rx, c.netUnit) .. " ↑" .. format.netBytes(s.net.tx, c.netUnit) + -- Thresholds are in MB/s. + return { + glyph = c.icons.net or "network", + text = text, + tint = tintLevel(c.thresholds.net, s.net.rx / 1000000), + } + end, + + disk = function(s, c) + if s.diskIo == nil then return nil end + local text = "↓" .. format.netBytes(s.diskIo.rx, c.netUnit) .. " ↑" .. format.netBytes(s.diskIo.tx, c.netUnit) + if s.diskTempC then + text = text .. " " .. format.temp(s.diskTempC, c.tempUnit, false) + end + return { + glyph = c.icons.disk or "device-floppy", + text = text, + tint = tintLevel(c.thresholds.disk, s.diskTempC), + } + end, +} + +-- One chip for a metric id, or nil when the metric is disabled or its +-- sensor is absent. +function M.chip(id, sample, config) + if sample == nil or config == nil then return nil end + if not config.enabled[id] then return nil end + local builder = builders[id] + if builder == nil then return nil end + local chip = builder(sample, config) + if chip == nil then return nil end + chip.id = id + return chip +end + +-- Ordered, enabled chips for a sample. Absent sensors are skipped. +function M.chips(sample, config) + local out = {} + if sample == nil or config == nil then return out end + for _, id in ipairs(config.metricOrder) do + local chip = M.chip(id, sample, config) + if chip then + table.insert(out, chip) + end + end + return out +end + +-- Detailed tooltip rows: { key = ..., value = ... }. +function M.tooltipRows(sample, config) + local rows = {} + if sample == nil or config == nil then return rows end + local function add(key, value) + if value ~= nil and value ~= "" then + table.insert(rows, { key = key, value = value }) + end + end + + if sample.cpu and sample.cpu.usage ~= nil then + local parts = { format.pct(sample.cpu.usage) } + if sample.cpuFreqHz then table.insert(parts, format.freqHz(sample.cpuFreqHz)) end + if sample.cpu.temp then table.insert(parts, format.temp(sample.cpu.temp, config.tempUnit, true)) end + add("CPU", table.concat(parts, " · ")) + end + + if sample.ram then + add("RAM", string.format("%s / %s (%s)", + format.ramBytes(sample.ram.used), format.ramBytes(sample.ram.total), format.pct(sample.ram.usage))) + if sample.swap and sample.swap.total and sample.swap.total > 0 then + add("Swap", string.format("%s / %s", + format.ramBytes(sample.swap.used), format.ramBytes(sample.swap.total))) + end + end + + if sample.gpu then + local parts = {} + if sample.gpu.usage ~= nil then table.insert(parts, format.pct(sample.gpu.usage)) end + if sample.gpu.temp ~= nil then table.insert(parts, format.temp(sample.gpu.temp, config.tempUnit, true)) end + if #parts > 0 then add("GPU", table.concat(parts, " · ")) end + end + + if sample.gpu and sample.gpu.vramUsed ~= nil and sample.gpu.vramTotal ~= nil then + add("VRAM", string.format("%s / %s (%s)", + format.ramBytes(sample.gpu.vramUsed), format.ramBytes(sample.gpu.vramTotal), + format.pct(sample.gpu.vramUsed / sample.gpu.vramTotal * 100))) + end + + if sample.fanRpm then + add("Fan", format.rpm(sample.fanRpm) .. " RPM") + end + + if sample.battery and sample.battery.capacity ~= nil then + local parts = { format.pct(sample.battery.capacity) } + if sample.battery.status and sample.battery.status ~= "" then + table.insert(parts, sample.battery.status) + end + if sample.battery.powerW then table.insert(parts, format.watts(sample.battery.powerW)) end + add("Battery", table.concat(parts, " · ")) + end + + if sample.net and sample.net.rx ~= nil then + local parts = { "↓ " .. format.netBytes(sample.net.rx, config.netUnit) .. "/s", + "↑ " .. format.netBytes(sample.net.tx, config.netUnit) .. "/s" } + if config.showNetIp and sample.netIp then table.insert(parts, sample.netIp) end + add("Network", table.concat(parts, " · ")) + end + + if sample.diskIo then + local parts = { "↓ " .. format.netBytes(sample.diskIo.rx, config.netUnit) .. "/s", + "↑ " .. format.netBytes(sample.diskIo.tx, config.netUnit) .. "/s" } + if sample.diskTempC then table.insert(parts, format.temp(sample.diskTempC, config.tempUnit, true)) end + if sample.diskUsage and sample.diskUsage.usagePercent ~= nil then + table.insert(parts, format.pct(sample.diskUsage.usagePercent) .. " used") + end + add("Disk", table.concat(parts, " · ")) + end + + if sample.load and #sample.load > 0 then + local parts = {} + for _, v in ipairs(sample.load) do table.insert(parts, format.load(v)) end + add("Load", table.concat(parts, " · ")) + end + + return rows +end + +return M diff --git a/kvitals/lib/datasrc.luau b/kvitals/lib/datasrc.luau new file mode 100644 index 00000000..148c3f2e --- /dev/null +++ b/kvitals/lib/datasrc.luau @@ -0,0 +1,304 @@ +--!nonstrict +-- sysfs / proc data sources: battery, fan, disk temperature, CPU frequency, +-- disk I/O deltas, and the local IPv4 address. +-- +-- These are the readings the host System Monitor does not expose. All file +-- reads go through lib/sys.luau's serial queue. Paths are discovered once at +-- load, so a tick performs at most five tiny reads plus one occasional +-- `ip` subprocess. + +local sys = require("./sys.luau") + +local M = {} + +-- Discovered paths (nil when the sensor is absent). +local batteryDir = nil +local fanInput = nil +local diskTempInput = nil +local cpuFreqInput = nil + +local hasIp = noctalia.commandExists("ip") + +-- Disk I/O delta state. +local prevDiskRead = 0 +local prevDiskWrite = 0 +local prevDiskMs = nil + +-- Local IP (refreshed every 30 ticks). +local currentIp = nil +local ipTick = 0 + +local function trim(s) + if s == nil then return "" end + return (s:gsub("^%s+", ""):gsub("%s+$", "")) +end + +-- ── hwmon scan ─────────────────────────────────────────────────────────── + +-- Finds the first live fan input and the best disk-temperature input. +local function scanHwmon() + local dirs = noctalia.listDir("/sys/class/hwmon") or {} + local fans = {} + local temps = {} + + for _, dir in ipairs(dirs) do + local base = "/sys/class/hwmon/" .. dir + local driver = trim(noctalia.readFile(base .. "/name")) + local inputs = noctalia.listDir(base) or {} + + for _, name in ipairs(inputs) do + local fanN = string.match(name, "^fan(%d+)_input$") + if fanN then + local rpm = tonumber(noctalia.readFile(base .. "/" .. name)) + if rpm and rpm > 0 then + table.insert(fans, { path = base .. "/" .. name, rpm = rpm }) + end + end + + local tempN = string.match(name, "^temp(%d+)_input$") + if tempN then + local label = trim(noctalia.readFile(base .. "/temp" .. tempN .. "_label")) + local milli = tonumber(noctalia.readFile(base .. "/" .. name)) + table.insert(temps, { + path = base .. "/" .. name, + driver = driver, + label = label, + valueC = (milli or 0) / 1000, + }) + end + end + end + + if #fans > 0 then + fanInput = fans[1].path + end + + -- Score: NVMe and ATA controllers beat everything else. + local best = nil + local bestScore = -1 + local function score(t) + local s = 0 + if t.driver:match("nvme") then s = s + 4 end + if t.driver:match("ahci") or t.driver:match("ata") then s = s + 3 end + if t.label:match("Composite") then s = s + 3 end + if t.label:match("[Dd]isk") or t.label:match("[Dd]rive") then s = s + 2 end + if t.valueC > 0 and t.valueC < 200 then s = s + 1 end + return s + end + for _, t in ipairs(temps) do + local s = score(t) + if s > bestScore then + bestScore = s + best = t + end + end + if best ~= nil then + diskTempInput = best.path + end +end + +-- ── power_supply scan ──────────────────────────────────────────────────── + +local function scanBattery() + local dirs = noctalia.listDir("/sys/class/power_supply") or {} + for _, dir in ipairs(dirs) do + local base = "/sys/class/power_supply/" .. dir + if trim(noctalia.readFile(base .. "/type")) == "Battery" then + batteryDir = base + return + end + end +end + +-- ── CPU frequency path ─────────────────────────────────────────────────── + +local function scanCpuFreq() + local p = "/sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq" + if noctalia.fileExists(p) then + cpuFreqInput = p + return + end + p = "/sys/devices/system/cpu/cpu0/cpufreq/cpuinfo_cur_freq" + if noctalia.fileExists(p) then + cpuFreqInput = p + end +end + +-- ── /proc/diskstats ────────────────────────────────────────────────────── + +-- Returns (sectorsRead, sectorsWritten) byte totals over physical devices. +local function parseDiskstats(contents) + local rx, tx = 0, 0 + if contents == nil then return rx, tx end + for line in contents:gmatch("[^\n]+") do + local major, minor, name, rest = line:match("(%d+)%s+(%d+)%s+(%S+)%s+(.*)") + if major and minor and name and rest then + if not (name:match("^loop") or name:match("^ram") or name:match("^zram") + or name:match("^dm%-") or name:match("^sr") or name:match("^md")) then + local tokens = {} + for token in rest:gmatch("%S+") do + table.insert(tokens, token) + end + -- Field order after the device name: + -- reads, merged, sectors read, ms read, writes, merged, sectors written. + local sectorsRead = tonumber(tokens[3]) or 0 + local sectorsWritten = tonumber(tokens[7]) or 0 + rx = rx + sectorsRead * 512 + tx = tx + sectorsWritten * 512 + end + end + end + return rx, tx +end + +-- ── battery reading ────────────────────────────────────────────────────── + +-- Reads capacity, status, and power draw. cb({capacity, status, powerW}). +local function readBattery(cb) + if batteryDir == nil then + cb(nil) + return + end + local out = {} + sys.readInt(batteryDir .. "/capacity", function(capacity) + out.capacity = capacity + sys.read(batteryDir .. "/status", function(status) + out.status = trim(status) + local powerNow = batteryDir .. "/power_now" + if noctalia.fileExists(powerNow) then + sys.readInt(powerNow, function(uw) + if uw then out.powerW = uw / 1000000 end + cb(out) + end) + else + sys.readInt(batteryDir .. "/current_now", function(uA) + if uA == nil then + cb(out) + return + end + sys.readInt(batteryDir .. "/voltage_now", function(uV) + if uV then out.powerW = uA * uV / 1000000000000 end + cb(out) + end) + end) + end + end) + end) +end + +-- ── local IP ───────────────────────────────────────────────────────────── + +local function refreshIp() + noctalia.runAsync("ip -j -brief addr", function(result) + if not result or result.exitCode ~= 0 then return end + local parsed = noctalia.json.decode(result.stdout) + if parsed == nil or type(parsed) ~= "table" then return end + local found = nil + for _, iface in ipairs(parsed) do + if found then break end + local name = iface.ifname + if name ~= "lo" and type(iface.addr_info) == "table" then + for _, addr in ipairs(iface.addr_info) do + if addr.family == "inet" and addr["local"] and not addr["local"]:match("^127%.") then + found = addr["local"] + break + end + end + end + end + if found then currentIp = found end + end, 2000) +end + +-- ── init ───────────────────────────────────────────────────────────────── + +scanHwmon() +scanBattery() +scanCpuFreq() +prevDiskRead, prevDiskWrite = parseDiskstats(noctalia.readFile("/proc/diskstats")) +prevDiskMs = noctalia.nowMs() + +-- ── tick ───────────────────────────────────────────────────────────────── + +-- Gathers all sensor readings for one sample. cb(extras) fires once, after +-- every queued read completes. extras is a flat table of whatever is present. +function M.tickAsync(cb) + local out = {} + local pending = 0 + + local function done() + pending = pending - 1 + if pending == 0 then cb(out) end + end + + local function enqueue(fn, key) + pending = pending + 1 + fn(function(value) + out[key] = value + done() + end) + end + + if cpuFreqInput then + enqueue(function(doneRead) + sys.readInt(cpuFreqInput, function(khz) + doneRead(khz and khz * 1000 or nil) -- kHz -> Hz + end) + end, "cpuFreqHz") + end + + if fanInput then + enqueue(function(doneRead) + sys.readInt(fanInput, function(rpm) + doneRead(rpm) + end) + end, "fanRpm") + end + + if diskTempInput then + enqueue(function(doneRead) + sys.readInt(diskTempInput, function(milli) + doneRead(milli and milli / 1000 or nil) -- millidegrees -> °C + end) + end, "diskTempC") + end + + enqueue(function(doneRead) + readBattery(doneRead) + end, "battery") + + enqueue(function(doneRead) + local now = noctalia.nowMs() + sys.read("/proc/diskstats", function(contents) + local rx, tx = parseDiskstats(contents) + if prevDiskMs == nil then + prevDiskRead, prevDiskWrite, prevDiskMs = rx, tx, now + doneRead({ rx = 0, tx = 0 }) + return + end + local dt = (now - prevDiskMs) / 1000 + local drx = 0 + local dtx = 0 + if dt > 0 then + drx = (rx - prevDiskRead) / dt + dtx = (tx - prevDiskWrite) / dt + if drx < 0 then drx = 0 end + if dtx < 0 then dtx = 0 end + end + prevDiskRead, prevDiskWrite, prevDiskMs = rx, tx, now + doneRead({ rx = drx, tx = dtx }) + end) + end, "diskIo") + + out.netIp = currentIp + ipTick = ipTick + 1 + if hasIp and ipTick % 30 == 1 then + refreshIp() + end + + if pending == 0 then + cb(out) + end +end + +return M diff --git a/kvitals/lib/format.luau b/kvitals/lib/format.luau new file mode 100644 index 00000000..4736c2a2 --- /dev/null +++ b/kvitals/lib/format.luau @@ -0,0 +1,107 @@ +--!nonstrict +-- Number and unit formatting helpers (KVitals-style, unit-aware). +-- Pure functions; no host calls beyond what is passed in. + +local M = {} + +-- Bytes with automatic decimal scaling. Returns "512B", "340K", "1.2M". +function M.autoBytes(bytes) + if bytes == nil then return "-" end + local b = bytes + if b < 1000 then return string.format("%dB", math.floor(b + 0.5)) end + b = b / 1000 + if b < 1000 then return string.format("%.1fK", b) end + b = b / 1000 + if b < 1000 then return string.format("%.1fM", b) end + b = b / 1000 + return string.format("%.2fG", b) +end + +-- Bytes per second with a fixed unit from the net_unit setting. +-- unit is "auto", "kb", or "mb". +function M.netBytes(bytes, unit) + if bytes == nil then return "-" end + if unit == "kb" then return string.format("%.0fK", bytes / 1000) end + if unit == "mb" then return string.format("%.1fM", bytes / 1000000) end + return M.autoBytes(bytes) +end + +-- RAM bytes with binary scaling. Returns "6.1G", "512M". +function M.ramBytes(bytes) + if bytes == nil then return "-" end + local b = bytes + if b < 1024 then return string.format("%dB", math.floor(b + 0.5)) end + b = b / 1024 + if b < 1024 then return string.format("%.0fK", b) end + b = b / 1024 + if b < 1024 then return string.format("%.1fM", b) end + b = b / 1024 + return string.format("%.2fG", b) +end + +-- Percent value. Returns "45%". +function M.pct(value) + if value == nil then return "-" end + return string.format("%.0f%%", value) +end + +-- Temperature. unit is "c" or "f"; suffix true appends the unit letter. +-- Returns "52°", "52°C", or "52°F". +function M.temp(celsius, unit, suffix) + if celsius == nil then return "-" end + local value = celsius + if unit == "f" then value = celsius * 9 / 5 + 32 end + local text = string.format("%.0f°", value) + if suffix then + text = text .. (unit == "f" and "F" or "C") + end + return text +end + +-- CPU frequency, compact. Returns "3.20G" or "850M". +function M.freqCompact(hz) + if hz == nil then return "-" end + if hz >= 1e9 then return string.format("%.2fG", hz / 1e9) end + if hz >= 1e6 then return string.format("%.0fM", hz / 1e6) end + return string.format("%.0fK", hz / 1e3) +end + +-- CPU frequency, full. Returns "3.20 GHz" or "850 MHz". +function M.freqHz(hz) + if hz == nil then return "-" end + if hz >= 1e9 then return string.format("%.2f GHz", hz / 1e9) end + if hz >= 1e6 then return string.format("%.0f MHz", hz / 1e6) end + return string.format("%.0f kHz", hz / 1e3) +end + +-- Fan speed in RPM. Returns "1200". +function M.rpm(value) + if value == nil then return "-" end + return string.format("%d", value) +end + +-- Power draw in watts. Returns "12W" or "12.3W". +function M.watts(w) + if w == nil then return "-" end + if w >= 100 then return string.format("%.0fW", w) end + return string.format("%.1fW", w) +end + +-- Load average. Returns "1.2". +function M.load(value) + if value == nil then return "-" end + return string.format("%.2f", value) +end + +-- Add an alpha channel to a color for translucent rendering. +-- Role token "primary" -> "primary/0.65"; hex "#8f9bff" -> "#8f9bffa6". +function M.withAlpha(color, alpha) + if color == nil then return nil end + if string.sub(color, 1, 1) == "#" then + local a = string.format("%02x", math.floor(alpha * 255 + 0.5)) + return color .. a + end + return color .. "/" .. tostring(alpha) +end + +return M diff --git a/kvitals/lib/sys.luau b/kvitals/lib/sys.luau new file mode 100644 index 00000000..e4bbaef6 --- /dev/null +++ b/kvitals/lib/sys.luau @@ -0,0 +1,71 @@ +--!nonstrict +-- Serial async sysfs reader. +-- +-- Keeps at most one `cat` subprocess in flight. Sysfs and pseudo-files are +-- polled every refresh, so a strict queue keeps the load flat and the +-- readings in order. Reads are tiny; the queue drains in milliseconds. +-- +-- Uses noctalia.runAsync because noctalia.readFileAsync (plugin API 23) is +-- not present on the beta.7 host. Paths come from sysfs discovery and are +-- always plain absolute paths without spaces or shell metacharacters. + +local queue = {} +local running = false +local READ_TIMEOUT_MS = 3000 + +local function pump() + running = false + local job = table.remove(queue, 1) + if job == nil then return end + running = true + + local launched = noctalia.runAsync("cat " .. job.path, function(result) + local okResult = result ~= nil + local contents = nil + local err = nil + if not okResult or result.timedOut then + err = "timeout" + elseif result.exitCode ~= 0 then + err = "exit " .. tostring(result.exitCode) + else + contents = result.stdout or "" + end + job.cb(contents, err) + pump() + end, READ_TIMEOUT_MS) + + if not launched then + job.cb(nil, "launch failed") + pump() + end +end + +local M = {} + +-- Queue a read. cb(contents, err); both may be nil on failure. +function M.read(path, cb) + if path == nil or path == "" then + cb(nil, "no path") + return + end + table.insert(queue, { path = path, cb = cb }) + if not running then pump() end +end + +-- Queue a read parsed as the first integer. cb(number or nil). +function M.readInt(path, cb) + M.read(path, function(contents) + if contents == nil then + cb(nil) + return + end + local n = tonumber(string.match(contents, "%d+")) + if n == nil then + cb(nil) + return + end + cb(n) + end) +end + +return M diff --git a/kvitals/panel.luau b/kvitals/panel.luau new file mode 100644 index 00000000..c173b563 --- /dev/null +++ b/kvitals/panel.luau @@ -0,0 +1,187 @@ +--!nonstrict +-- KVitals sparkline panel: live graphs and a metrics summary, opened near +-- the bar widget. The host diffs the tree, so re-rendering on every sample +-- is free. + +local format = require("./lib/format.luau") +local chips = require("./lib/chips.luau") + +local sample = noctalia.state.get("kvitals.sample") +local history = noctalia.state.get("kvitals.history") +local config = noctalia.state.get("kvitals.config") +local ready = noctalia.state.get("kvitals.ready") == true + +local graph_height = noctalia.getConfig("graph_height") or 64 +local show_graphs = noctalia.getConfig("show_graphs") +if show_graphs == nil then show_graphs = true end + +-- ── helpers ────────────────────────────────────────────────────────────── + +local function section(title, glyphName, control) + return ui.column({ gap = 8 }, { + ui.row({ gap = 8, align = "center" }, { + ui.glyph({ name = glyphName, size = 14, color = "on_surface_variant" }), + ui.label({ text = title, fontSize = 12, fontWeight = "medium", color = "on_surface_variant" }), + }), + control, + }) +end + +-- Normalize a byte-rate series to 0-1 against the window maximum. +local function normalizeRates(values) + local maxValue = 1 + for _, v in ipairs(values) do + if v > maxValue then maxValue = v end + end + local out = {} + for _, v in ipairs(values) do + table.insert(out, v / maxValue) + end + return out +end + +local function graphRow(title, glyphName, values, values2, color, color2, currentText) + if values == nil or #values < 2 then return nil end + return ui.column({ gap = 4 }, { + ui.row({ gap = 8, align = "center" }, { + ui.glyph({ name = glyphName, size = 14, color = "on_surface_variant" }), + ui.label({ text = title, fontSize = 12, fontWeight = "medium", color = "on_surface_variant", flexGrow = 1 }), + ui.label({ text = currentText, fontSize = 12, color = "on_surface" }), + }), + ui.graph({ + values = values, + values2 = values2, + color = color, + color2 = color2, + lineWidth = 2, + fillOpacity = 0.18, + height = graph_height, + }), + }) +end + +local function detailRow(key, value) + if value == nil or value == "" then return nil end + return ui.row({ gap = 8, align = "center" }, { + ui.label({ text = key, fontSize = 12, color = "on_surface_variant", flexGrow = 1 }), + ui.label({ text = value, fontSize = 12, fontWeight = "medium", color = "on_surface" }), + }) +end + +-- ── render ────────────────────────────────────────────────────────────── + +local function render() + local body = {} + + -- Header. + table.insert(body, ui.row({ align = "center", justify = "space_between", gap = 8 }, { + ui.row({ gap = 8, align = "center", flexGrow = 1 }, { + ui.glyph({ name = "activity", size = 18, color = config and config.accent or "primary" }), + ui.label({ text = noctalia.tr("panel.title"), fontSize = 16, fontWeight = "bold", color = "on_surface", flexGrow = 1 }), + }), + ui.button({ glyph = "settings", variant = "ghost", tooltip = noctalia.tr("panel.open_settings"), onClick = "onOpenSettings" }), + ui.button({ glyph = "circle-x", variant = "ghost", onClick = "onCloseClicked" }), + })) + + local rows = {} + + -- Graphs. + if ready and sample and history and show_graphs then + local accent = config.accent or "primary" + local current = {} + for _, chip in ipairs(chips.chips(sample, config)) do + current[chip.id] = chip.text + end + local g = {} + table.insert(g, graphRow("CPU", "cpu", history.cpu, nil, accent, nil, current.cpu)) + table.insert(g, graphRow("RAM", "database", history.ram, nil, accent, nil, current.ram)) + table.insert(g, graphRow("GPU", "device-desktop-analytics", history.gpu, nil, accent, nil, current.gpu)) + if history.vram and #history.vram >= 2 then + table.insert(g, graphRow("VRAM", "memory", history.vram, nil, accent, nil, current.vram)) + end + if history.netRx and #history.netRx >= 2 then + table.insert(g, graphRow( + "NET", "network", + normalizeRates(history.netRx), normalizeRates(history.netTx), + accent, "secondary", + current.net)) + end + local graphs = {} + for _, node in ipairs(g) do + if node then table.insert(graphs, node) end + end + if #graphs > 0 then + table.insert(rows, ui.column({ gap = 14 }, graphs)) + end + end + + -- Details grid, two columns. + if ready and sample then + local details = chips.tooltipRows(sample, config) + local left, right = {}, {} + for index, row in ipairs(details) do + local node = detailRow(row.key, row.value) + if node then + if index % 2 == 1 then + table.insert(left, node) + else + table.insert(right, node) + end + end + end + if #left > 0 or #right > 0 then + table.insert(rows, ui.row({ gap = 24, align = "start" }, { + ui.column({ gap = 8, flexGrow = 1 }, left), + ui.column({ gap = 8, flexGrow = 1 }, right), + })) + end + end + + table.insert(body, ui.scroll({ flexGrow = 1, gap = 20 }, rows)) + + -- Footer. + table.insert(body, ui.label({ + text = noctalia.tr("about.based_on"), + fontSize = 11, + color = "on_surface_variant", + })) + + panel.render(ui.column({ flexGrow = 1, gap = 16 }, body)) +end + +-- ── entry points ───────────────────────────────────────────────────────── + +function onOpen(_context) + graph_height = noctalia.getConfig("graph_height") or 64 + local g = noctalia.getConfig("show_graphs") + if g ~= nil then show_graphs = g end + render() +end + +function onCloseClicked() + panel.close() +end + +function onOpenSettings() + noctalia.openSettings() +end + +noctalia.state.watch("kvitals.sample", function(value) + sample = value + render() +end) + +noctalia.state.watch("kvitals.history", function(value) + history = value + render() +end) + +noctalia.state.watch("kvitals.config", function(value) + config = value + render() +end) + +noctalia.state.watch("kvitals.ready", function(value) + ready = value == true + render() +end) diff --git a/kvitals/plugin.toml b/kvitals/plugin.toml new file mode 100644 index 00000000..a3bf5b16 --- /dev/null +++ b/kvitals/plugin.toml @@ -0,0 +1,509 @@ +# KVitals for Noctalia — live system vitals in the bar, panel, and desktop. +# +# A Luau port of the KVitals KDE Plasma widget (GPL-3.0). +# Upstream: https://github.com/yassine20011/kvitals +# +# Architecture: one headless [[service]] samples the host System Monitor, +# sysfs, and /proc, then publishes to the plugin state. The [[widget]], +# [[panel]], and [[desktop_widget]] are thin clients that watch that state. +# +# Settings are plugin-level ([[setting]] at the root): one set shared by +# every entry, edited from Settings -> Plugins, seeded into +# noctalia.getConfig everywhere. Per-instance presentation settings live +# under their entry. + +id = "royalebiskut/kvitals" +name = "KVitals" +version = "0.1.0" +plugin_api = 22 +author = "royalebiskut" +license = "GPL-3.0" +icon = "cpu" +description = "Live CPU, RAM, GPU, temperature, fan, battery, network, and disk vitals for the bar and desktop." +dependencies = ["cat", "ip"] +tags = ["system", "hardware", "bar", "panel", "desktop", "network", "indicator"] + +# ── General ────────────────────────────────────────────────────────────── + +[[setting]] +key = "refresh_ms" +type = "int" +min = 250 +max = 10000 +default = 1000 +label_key = "settings.refresh_ms.label" +description_key = "settings.refresh_ms.description" + +[[setting]] +key = "temp_unit" +type = "select" +default = "c" +label_key = "settings.temp_unit.label" +description_key = "settings.temp_unit.description" +options = [ + { value = "c", label_key = "settings.temp_unit.options.c" }, + { value = "f", label_key = "settings.temp_unit.options.f" }, +] + +[[setting]] +key = "net_unit" +type = "select" +default = "auto" +label_key = "settings.net_unit.label" +description_key = "settings.net_unit.description" +options = [ + { value = "auto", label_key = "settings.net_unit.options.auto" }, + { value = "kb", label_key = "settings.net_unit.options.kb" }, + { value = "mb", label_key = "settings.net_unit.options.mb" }, +] + +[[setting]] +key = "metric_order" +type = "string_list" +default = ["cpu", "ram", "temp", "gpu", "vram", "fan", "battery", "net", "disk"] +label_key = "settings.metric_order.label" +description_key = "settings.metric_order.description" + +# ── Metric toggles ─────────────────────────────────────────────────────── + +[[setting]] +key = "enabled_cpu" +type = "bool" +default = true +label_key = "settings.enabled_cpu.label" +description_key = "settings.enabled_cpu.description" + +[[setting]] +key = "enabled_ram" +type = "bool" +default = true +label_key = "settings.enabled_ram.label" +description_key = "settings.enabled_ram.description" + +[[setting]] +key = "enabled_temp" +type = "bool" +default = true +label_key = "settings.enabled_temp.label" +description_key = "settings.enabled_temp.description" + +[[setting]] +key = "enabled_gpu" +type = "bool" +default = true +label_key = "settings.enabled_gpu.label" +description_key = "settings.enabled_gpu.description" + +[[setting]] +key = "enabled_vram" +type = "bool" +default = true +label_key = "settings.enabled_vram.label" +description_key = "settings.enabled_vram.description" + +[[setting]] +key = "enabled_fan" +type = "bool" +default = true +label_key = "settings.enabled_fan.label" +description_key = "settings.enabled_fan.description" + +[[setting]] +key = "enabled_battery" +type = "bool" +default = true +label_key = "settings.enabled_battery.label" +description_key = "settings.enabled_battery.description" + +[[setting]] +key = "enabled_net" +type = "bool" +default = true +label_key = "settings.enabled_net.label" +description_key = "settings.enabled_net.description" + +[[setting]] +key = "enabled_disk" +type = "bool" +default = true +label_key = "settings.enabled_disk.label" +description_key = "settings.enabled_disk.description" + +# ── Detail options ─────────────────────────────────────────────────────── + +[[setting]] +key = "show_cpu_freq" +type = "bool" +default = true +label_key = "settings.show_cpu_freq.label" +description_key = "settings.show_cpu_freq.description" + +[[setting]] +key = "show_power_draw" +type = "bool" +default = true +label_key = "settings.show_power_draw.label" +description_key = "settings.show_power_draw.description" + +[[setting]] +key = "show_net_ip" +type = "bool" +default = false +label_key = "settings.show_net_ip.label" +description_key = "settings.show_net_ip.description" + +# ── Thresholds (activity / critical) ───────────────────────────────────── + +[[setting]] +key = "cpu_act" +type = "int" +min = 0 +max = 100 +default = 50 +label_key = "settings.cpu_act.label" +description_key = "settings.threshold.description" + +[[setting]] +key = "cpu_crit" +type = "int" +min = 0 +max = 100 +default = 90 +label_key = "settings.cpu_crit.label" +description_key = "settings.threshold.description" + +[[setting]] +key = "ram_act" +type = "int" +min = 0 +max = 100 +default = 60 +label_key = "settings.ram_act.label" +description_key = "settings.threshold.description" + +[[setting]] +key = "ram_crit" +type = "int" +min = 0 +max = 100 +default = 90 +label_key = "settings.ram_crit.label" +description_key = "settings.threshold.description" + +[[setting]] +key = "temp_act" +type = "int" +min = 0 +max = 150 +default = 60 +label_key = "settings.temp_act.label" +description_key = "settings.threshold.description" + +[[setting]] +key = "temp_crit" +type = "int" +min = 0 +max = 150 +default = 85 +label_key = "settings.temp_crit.label" +description_key = "settings.threshold.description" + +[[setting]] +key = "gpu_act" +type = "int" +min = 0 +max = 100 +default = 50 +label_key = "settings.gpu_act.label" +description_key = "settings.threshold.description" + +[[setting]] +key = "gpu_crit" +type = "int" +min = 0 +max = 100 +default = 95 +label_key = "settings.gpu_crit.label" +description_key = "settings.threshold.description" + +[[setting]] +key = "vram_act" +type = "int" +min = 0 +max = 100 +default = 60 +label_key = "settings.vram_act.label" +description_key = "settings.threshold.description" + +[[setting]] +key = "vram_crit" +type = "int" +min = 0 +max = 100 +default = 90 +label_key = "settings.vram_crit.label" +description_key = "settings.threshold.description" + +[[setting]] +key = "net_act" +type = "double" +min = 0 +max = 1000 +default = 1 +label_key = "settings.net_act.label" +description_key = "settings.net_threshold.description" + +[[setting]] +key = "net_crit" +type = "double" +min = 0 +max = 1000 +default = 50 +label_key = "settings.net_crit.label" +description_key = "settings.net_threshold.description" + +[[setting]] +key = "disk_act" +type = "int" +min = 0 +max = 100 +default = 80 +label_key = "settings.disk_act.label" +description_key = "settings.threshold.description" + +[[setting]] +key = "disk_crit" +type = "int" +min = 0 +max = 100 +default = 95 +label_key = "settings.disk_crit.label" +description_key = "settings.threshold.description" + +# ── Colors ─────────────────────────────────────────────────────────────── + +[[setting]] +key = "accent_color" +type = "color" +default = "primary" +label_key = "settings.accent_color.label" +description_key = "settings.accent_color.description" + +[[setting]] +key = "font_color" +type = "color" +default = "on_surface" +label_key = "settings.font_color.label" +description_key = "settings.font_color.description" + +# ── Metric icons ───────────────────────────────────────────────────────── + +[[setting]] +key = "icon_cpu" +type = "select" +default = "cpu" +label_key = "settings.icon_cpu.label" +description_key = "settings.icon.description" +options = [ + { value = "cpu", label_key = "settings.icon.options.cpu" }, + { value = "cpu-2", label_key = "settings.icon.options.cpu_2" }, + { value = "device-desktop", label_key = "settings.icon.options.device_desktop" }, + { value = "dashboard", label_key = "settings.icon.options.dashboard" }, + { value = "chart-dots", label_key = "settings.icon.options.chart_dots" }, + { value = "binary", label_key = "settings.icon.options.binary" }, + { value = "bug", label_key = "settings.icon.options.bug" }, +] + +[[setting]] +key = "icon_ram" +type = "select" +default = "database" +label_key = "settings.icon_ram.label" +description_key = "settings.icon.description" +options = [ + { value = "database", label_key = "settings.icon.options.database" }, + { value = "stack-2", label_key = "settings.icon.options.stack_2" }, + { value = "box", label_key = "settings.icon.options.box" }, + { value = "archive", label_key = "settings.icon.options.archive" }, + { value = "binary", label_key = "settings.icon.options.binary" }, + { value = "device-floppy", label_key = "settings.icon.options.device_floppy" }, +] + +[[setting]] +key = "icon_temp" +type = "select" +default = "temperature" +label_key = "settings.icon_temp.label" +description_key = "settings.icon.description" +options = [ + { value = "temperature", label_key = "settings.icon.options.temperature" }, + { value = "thermometer", label_key = "settings.icon.options.thermometer" }, + { value = "flame", label_key = "settings.icon.options.flame" }, + { value = "droplet", label_key = "settings.icon.options.droplet" }, + { value = "snowflake", label_key = "settings.icon.options.snowflake" }, + { value = "sun", label_key = "settings.icon.options.sun" }, +] + +[[setting]] +key = "icon_gpu" +type = "select" +default = "device-desktop-analytics" +label_key = "settings.icon_gpu.label" +description_key = "settings.icon.description" +options = [ + { value = "device-desktop-analytics", label_key = "settings.icon.options.device_desktop_analytics" }, + { value = "device-desktop", label_key = "settings.icon.options.device_desktop" }, + { value = "viewfinder", label_key = "settings.icon.options.viewfinder" }, + { value = "screen-share", label_key = "settings.icon.options.screen_share" }, + { value = "photo", label_key = "settings.icon.options.photo" }, + { value = "video", label_key = "settings.icon.options.video" }, + { value = "components", label_key = "settings.icon.options.components" }, +] + +[[setting]] +key = "icon_vram" +type = "select" +default = "memory" +label_key = "settings.icon_vram.label" +description_key = "settings.icon.description" +options = [ + { value = "memory", label_key = "settings.icon.options.memory" }, + { value = "database", label_key = "settings.icon.options.database" }, + { value = "stack-2", label_key = "settings.icon.options.stack_2" }, + { value = "box", label_key = "settings.icon.options.box" }, + { value = "archive", label_key = "settings.icon.options.archive" }, + { value = "binary", label_key = "settings.icon.options.binary" }, + { value = "device-floppy", label_key = "settings.icon.options.device_floppy" }, +] + +[[setting]] +key = "icon_fan" +type = "select" +default = "wind" +label_key = "settings.icon_fan.label" +description_key = "settings.icon.description" +options = [ + { value = "wind", label_key = "settings.icon.options.wind" }, + { value = "propeller", label_key = "settings.icon.options.propeller" }, + { value = "refresh", label_key = "settings.icon.options.refresh" }, + { value = "rotate", label_key = "settings.icon.options.rotate" }, + { value = "plane", label_key = "settings.icon.options.plane" }, + { value = "helicopter", label_key = "settings.icon.options.helicopter" }, + { value = "blade", label_key = "settings.icon.options.blade" }, +] + +[[setting]] +key = "icon_net" +type = "select" +default = "network" +label_key = "settings.icon_net.label" +description_key = "settings.icon.description" +options = [ + { value = "network", label_key = "settings.icon.options.network" }, + { value = "transfer", label_key = "settings.icon.options.transfer" }, + { value = "exchange", label_key = "settings.icon.options.exchange" }, + { value = "wifi", label_key = "settings.icon.options.wifi" }, + { value = "wifi-2", label_key = "settings.icon.options.wifi_2" }, + { value = "arrow-left-right", label_key = "settings.icon.options.arrow_left_right" }, + { value = "globe", label_key = "settings.icon.options.globe" }, + { value = "activity", label_key = "settings.icon.options.activity" }, +] + +[[setting]] +key = "icon_disk" +type = "select" +default = "device-floppy" +label_key = "settings.icon_disk.label" +description_key = "settings.icon.description" +options = [ + { value = "device-floppy", label_key = "settings.icon.options.device_floppy" }, + { value = "server", label_key = "settings.icon.options.server" }, + { value = "database", label_key = "settings.icon.options.database" }, + { value = "archive", label_key = "settings.icon.options.archive" }, + { value = "folder", label_key = "settings.icon.options.folder" }, + { value = "usb", label_key = "settings.icon.options.usb" }, +] + +# ── Entries ────────────────────────────────────────────────────────────── + +[[service]] +id = "sampler" +entry = "service.luau" + +[[widget]] +id = "metrics" +entry = "widget.luau" + + [[widget.setting]] + key = "display_mode" + type = "select" + default = "both" + label_key = "settings.display_mode.label" + description_key = "settings.display_mode.description" + options = [ + { value = "both", label_key = "settings.display_mode.options.both" }, + { value = "text", label_key = "settings.display_mode.options.text" }, + { value = "icons", label_key = "settings.display_mode.options.icons" }, + ] + + [[widget.setting]] + key = "font_size" + type = "int" + min = 8 + max = 24 + default = 12 + label_key = "settings.font_size.label" + description_key = "settings.font_size.description" + + [[widget.setting]] + key = "hide_absent" + type = "bool" + default = true + label_key = "settings.hide_absent.label" + description_key = "settings.hide_absent.description" + +[[panel]] +id = "sparkline" +entry = "panel.luau" +width = 560 +height = 460 +placement = "floating" +position = "auto" +open_near_click = true +dismiss_on_outside_click = true + + [[panel.setting]] + key = "show_graphs" + type = "bool" + default = true + label_key = "settings.show_graphs.label" + description_key = "settings.show_graphs.description" + + [[panel.setting]] + key = "graph_height" + type = "int" + min = 32 + max = 160 + default = 64 + label_key = "settings.graph_height.label" + description_key = "settings.graph_height.description" + +[[desktop_widget]] +id = "tile" +entry = "desktop.luau" + + [[desktop_widget.setting]] + key = "show_glyphs" + type = "bool" + default = true + label_key = "settings.show_glyphs.label" + description_key = "settings.show_glyphs.description" + + [[desktop_widget.setting]] + key = "font_size" + type = "int" + min = 8 + max = 24 + default = 12 + label_key = "settings.font_size.label" + description_key = "settings.font_size.description" diff --git a/kvitals/service.luau b/kvitals/service.luau new file mode 100644 index 00000000..87e97659 --- /dev/null +++ b/kvitals/service.luau @@ -0,0 +1,202 @@ +--!nonstrict +-- KVitals sampler service. +-- +-- Aggregates the host System Monitor, sysfs/proc data sources, and a +-- rolling history, then publishes one merged sample to the plugin state +-- every refresh_ms. The bar widget, panel, and desktop tile watch that +-- state; they never touch the sensors themselves. +-- +-- Published keys: +-- kvitals.sample one merged sample table +-- kvitals.history rolling per-metric series (cpu/ram/gpu as 0-1, net in B/s) +-- kvitals.config resolved plugin settings (units, toggles, thresholds) +-- kvitals.ready true once the first sample lands + +local datasrc = require("./lib/datasrc.luau") + +local HISTORY_LEN = 60 + +local DEFAULTS = { + cpu = { act = 50, crit = 90 }, + ram = { act = 60, crit = 90 }, + temp = { act = 60, crit = 85 }, + gpu = { act = 50, crit = 95 }, + vram = { act = 60, crit = 90 }, + net = { act = 1, crit = 50 }, + disk = { act = 80, crit = 95 }, +} + +local config = {} +local sample = nil +local history = nil + +-- ── config ─────────────────────────────────────────────────────────────── + +local function readConfig() + local function threshold(keyAct, keyCrit, def) + return { + act = noctalia.getConfig(keyAct) or def.act, + crit = noctalia.getConfig(keyCrit) or def.crit, + } + end + -- Older configs do not contain "vram"; insert it after "gpu" once. + local order = noctalia.getConfig("metric_order") + or { "cpu", "ram", "temp", "gpu", "vram", "fan", "battery", "net", "disk" } + local hasVram = false + for _, id in ipairs(order) do + if id == "vram" then hasVram = true break end + end + if not hasVram then + local migrated = {} + local inserted = false + for _, id in ipairs(order) do + table.insert(migrated, id) + if id == "gpu" and not inserted then + table.insert(migrated, "vram") + inserted = true + end + end + if not inserted then table.insert(migrated, "vram") end + order = migrated + end + return { + refreshMs = noctalia.getConfig("refresh_ms") or 1000, + tempUnit = noctalia.getConfig("temp_unit") or "c", + netUnit = noctalia.getConfig("net_unit") or "auto", + metricOrder = order, + enabled = { + cpu = noctalia.getConfig("enabled_cpu") ~= false, + ram = noctalia.getConfig("enabled_ram") ~= false, + temp = noctalia.getConfig("enabled_temp") ~= false, + gpu = noctalia.getConfig("enabled_gpu") ~= false, + vram = noctalia.getConfig("enabled_vram") ~= false, + fan = noctalia.getConfig("enabled_fan") ~= false, + battery = noctalia.getConfig("enabled_battery") ~= false, + net = noctalia.getConfig("enabled_net") ~= false, + disk = noctalia.getConfig("enabled_disk") ~= false, + }, + showCpuFreq = noctalia.getConfig("show_cpu_freq") ~= false, + showPowerDraw = noctalia.getConfig("show_power_draw") ~= false, + showNetIp = noctalia.getConfig("show_net_ip") == true, + icons = { + cpu = noctalia.getConfig("icon_cpu") or "cpu", + ram = noctalia.getConfig("icon_ram") or "database", + temp = noctalia.getConfig("icon_temp") or "temperature", + gpu = noctalia.getConfig("icon_gpu") or "device-desktop-analytics", + vram = noctalia.getConfig("icon_vram") or "memory", + fan = noctalia.getConfig("icon_fan") or "wind", + net = noctalia.getConfig("icon_net") or "network", + disk = noctalia.getConfig("icon_disk") or "device-floppy", + }, + thresholds = { + cpu = threshold("cpu_act", "cpu_crit", DEFAULTS.cpu), + ram = threshold("ram_act", "ram_crit", DEFAULTS.ram), + temp = threshold("temp_act", "temp_crit", DEFAULTS.temp), + gpu = threshold("gpu_act", "gpu_crit", DEFAULTS.gpu), + vram = threshold("vram_act", "vram_crit", DEFAULTS.vram), + net = threshold("net_act", "net_crit", DEFAULTS.net), + disk = threshold("disk_act", "disk_crit", DEFAULTS.disk), + }, + accent = noctalia.getConfig("accent_color") or "primary", + font = noctalia.getConfig("font_color") or "on_surface", + } +end + +-- ── history ring ───────────────────────────────────────────────────────── + +local function newHistory() + return { cpu = {}, ram = {}, gpu = {}, vram = {}, netRx = {}, netTx = {} } +end + +local function pushSeries(series, value) + if value == nil then return end + table.insert(series, value) + if #series > HISTORY_LEN then + table.remove(series, 1) + end +end + +-- ── publish ────────────────────────────────────────────────────────────── + +local function publish() + noctalia.state.set("kvitals.sample", sample) + noctalia.state.set("kvitals.history", history) + noctalia.state.set("kvitals.config", config) + noctalia.state.set("kvitals.ready", true) +end + +-- ── sampling ───────────────────────────────────────────────────────────── + +local function tick() + local now = noctalia.nowMs() + local stats = noctalia.systemStats() + local round = {} + round.ok = stats ~= nil + round.sampledAtMs = now + + if stats then + round.cpu = { usage = stats.cpu.usagePercent, temp = stats.cpu.tempC } + round.ram = { + usage = stats.ram.usagePercent, + used = stats.ram.usedMb * 1000000, + total = stats.ram.totalMb * 1000000, + } + round.swap = { + used = stats.swap.usedMb * 1000000, + total = stats.swap.totalMb * 1000000, + } + round.gpu = { + usage = stats.gpu.usagePercent, + temp = stats.gpu.tempC, + vramUsed = stats.gpu.vramUsedBytes, + vramTotal = stats.gpu.vramTotalBytes, + } + round.net = { rx = stats.net.rxBytesPerSec, tx = stats.net.txBytesPerSec } + round.load = stats.loadAvg + end + + round.diskUsage = noctalia.diskStats("/") + + datasrc.tickAsync(function(extras) + round.battery = extras.battery + round.fanRpm = extras.fanRpm + round.diskTempC = extras.diskTempC + round.cpuFreqHz = extras.cpuFreqHz + round.diskIo = extras.diskIo + round.netIp = extras.netIp + + if history == nil then history = newHistory() end + if round.cpu then pushSeries(history.cpu, round.cpu.usage / 100) end + if round.ram then pushSeries(history.ram, round.ram.usage / 100) end + if round.gpu and round.gpu.usage then pushSeries(history.gpu, round.gpu.usage / 100) end + if round.gpu and round.gpu.vramUsed and round.gpu.vramTotal and round.gpu.vramTotal > 0 then + pushSeries(history.vram, round.gpu.vramUsed / round.gpu.vramTotal) + end + if round.net then + pushSeries(history.netRx, round.net.rx) + pushSeries(history.netTx, round.net.tx) + end + + sample = round + publish() + end) +end + +-- ── entry points ───────────────────────────────────────────────────────── + +config = readConfig() +noctalia.setUpdateInterval(config.refreshMs) + +function update() + tick() +end + +function onConfigChanged() + config = readConfig() + noctalia.setUpdateInterval(config.refreshMs) + publish() +end + +function onEnable() + tick() +end diff --git a/kvitals/thumbnail.webp b/kvitals/thumbnail.webp new file mode 100644 index 00000000..d9a3ff67 Binary files /dev/null and b/kvitals/thumbnail.webp differ diff --git a/kvitals/translations/en.json b/kvitals/translations/en.json new file mode 100644 index 00000000..0e4e23ba --- /dev/null +++ b/kvitals/translations/en.json @@ -0,0 +1,266 @@ +{ + "about": { + "based_on": "Based on KVitals by yassine20011 (GPL-3.0)." + }, + "metric": { + "cpu": "CPU", + "ram": "RAM", + "temp": "Temp", + "gpu": "GPU", + "vram": "VRAM", + "fan": "Fan", + "battery": "Battery", + "net": "Network", + "disk": "Disk", + "load": "Load" + }, + "panel": { + "hint": "Click the bar widget to toggle this panel. Right-click it to open settings.", + "open_settings": "Open KVitals settings", + "title": "KVitals" + }, + "settings": { + "accent_color": { + "label": "Accent color", + "description": "Color used for critical values, graphs, and icons. Leave as primary to follow the theme." + }, + "cpu_act": { + "label": "CPU activity threshold" + }, + "cpu_crit": { + "label": "CPU critical threshold" + }, + "disk_act": { + "label": "Disk activity threshold" + }, + "disk_crit": { + "label": "Disk critical threshold" + }, + "display_mode": { + "label": "Bar display mode", + "description": "Show metric icons, text, or both in the bar.", + "options": { + "both": "Icons and text", + "icons": "Icons only", + "text": "Text only" + } + }, + "enabled_battery": { + "label": "Show battery", + "description": "Show battery percentage and power draw." + }, + "enabled_cpu": { + "label": "Show CPU", + "description": "Show CPU usage and temperature." + }, + "enabled_disk": { + "label": "Show disk", + "description": "Show disk I/O and temperature." + }, + "enabled_fan": { + "label": "Show fan", + "description": "Show fan speed in RPM." + }, + "enabled_gpu": { + "label": "Show GPU", + "description": "Show GPU usage, temperature, and VRAM." + }, + "enabled_vram": { + "label": "Show VRAM", + "description": "Show graphics memory usage." + }, + "enabled_net": { + "label": "Show network", + "description": "Show network up and down rates." + }, + "enabled_ram": { + "label": "Show RAM", + "description": "Show memory usage." + }, + "enabled_temp": { + "label": "Show temperature", + "description": "Show CPU temperature." + }, + "font_color": { + "label": "Font color", + "description": "Color of the metric text. Leave as on_surface to follow the theme." + }, + "icon": { + "description": "Choose the icon for this metric.", + "options": { + "cpu": "CPU", + "cpu_2": "CPU 2", + "device_desktop": "Desktop", + "device_desktop_analytics": "Desktop chart", + "dashboard": "Dashboard", + "chart_dots": "Chart", + "binary": "Binary", + "bug": "Bug", + "database": "Database", + "stack_2": "Stack", + "box": "Box", + "archive": "Archive", + "device_floppy": "Floppy", + "temperature": "Temperature", + "thermometer": "Thermometer", + "flame": "Flame", + "droplet": "Droplet", + "snowflake": "Snowflake", + "sun": "Sun", + "viewfinder": "Viewfinder", + "screen_share": "Screen share", + "photo": "Photo", + "video": "Video", + "components": "Components", + "memory": "Memory", + "wind": "Wind", + "propeller": "Propeller", + "refresh": "Refresh", + "rotate": "Rotate", + "plane": "Plane", + "helicopter": "Helicopter", + "blade": "Blade", + "network": "Network", + "transfer": "Transfer", + "exchange": "Exchange", + "wifi": "WiFi", + "wifi_2": "WiFi 2", + "arrow_left_right": "Arrows", + "globe": "Globe", + "activity": "Activity", + "server": "Server", + "folder": "Folder", + "usb": "USB" + } + }, + "icon_cpu": { + "label": "CPU icon", + "description": "Choose the icon for this metric." + }, + "icon_ram": { + "label": "RAM icon", + "description": "Choose the icon for this metric." + }, + "icon_temp": { + "label": "Temperature icon", + "description": "Choose the icon for this metric." + }, + "icon_gpu": { + "label": "GPU icon", + "description": "Choose the icon for this metric." + }, + "icon_vram": { + "label": "VRAM icon", + "description": "Choose the icon for this metric." + }, + "icon_fan": { + "label": "Fan icon", + "description": "Choose the icon for this metric." + }, + "icon_net": { + "label": "Network icon", + "description": "Choose the icon for this metric." + }, + "icon_disk": { + "label": "Disk icon", + "description": "Choose the icon for this metric." + }, + "font_size": { + "label": "Font size", + "description": "Text size in pixels." + }, + "graph_height": { + "label": "Graph height", + "description": "Height of each sparkline in the panel." + }, + "gpu_act": { + "label": "GPU activity threshold" + }, + "gpu_crit": { + "label": "GPU critical threshold" + }, + "vram_act": { + "label": "VRAM activity threshold" + }, + "vram_crit": { + "label": "VRAM critical threshold" + }, + "hide_absent": { + "label": "Hide absent sensors", + "description": "Hide metrics whose sensor is not present." + }, + "metric_order": { + "label": "Metric order", + "description": "Order of the metrics in the bar, panel, and desktop tile." + }, + "net_act": { + "label": "Network activity threshold (MB/s)" + }, + "net_crit": { + "label": "Network critical threshold (MB/s)" + }, + "net_unit": { + "label": "Network unit", + "description": "Unit for network rates.", + "options": { + "auto": "Automatic", + "kb": "Kilobytes", + "mb": "Megabytes" + } + }, + "ram_act": { + "label": "RAM activity threshold" + }, + "ram_crit": { + "label": "RAM critical threshold" + }, + "refresh_ms": { + "label": "Refresh interval (ms)", + "description": "How often the sensors are sampled." + }, + "show_cpu_freq": { + "label": "Show CPU frequency", + "description": "Show the current CPU clock in the CPU chip and panel." + }, + "show_graphs": { + "label": "Show graphs", + "description": "Show live sparklines in the panel." + }, + "show_glyphs": { + "label": "Show icons", + "description": "Show metric icons in the desktop tile." + }, + "show_net_ip": { + "label": "Show IP address", + "description": "Show the local IPv4 address in the tooltip and panel." + }, + "show_power_draw": { + "label": "Show power draw", + "description": "Show the battery power draw in watts." + }, + "temp_act": { + "label": "Temperature activity threshold" + }, + "temp_crit": { + "label": "Temperature critical threshold" + }, + "temp_unit": { + "label": "Temperature unit", + "description": "Celsius or Fahrenheit.", + "options": { + "c": "Celsius", + "f": "Fahrenheit" + } + }, + "threshold": { + "description": "Values at or above this level tint the metric toward the accent color." + }, + "net_threshold": { + "description": "Network rates in MB/s. Values at or above this level tint the metric." + } + }, + "widget": { + "no_data": "No data", + "sysmon_off": "System monitor off" + } +} \ No newline at end of file diff --git a/kvitals/widget.luau b/kvitals/widget.luau new file mode 100644 index 00000000..69817ffb --- /dev/null +++ b/kvitals/widget.luau @@ -0,0 +1,134 @@ +--!nonstrict +-- KVitals bar widget: compact metric chips that tint toward the accent +-- color as a value crosses its activity threshold. +-- +-- Left click toggles the sparkline panel. Right click opens the settings. +-- The host's built-in middle-click default (open this widget's settings) +-- stays untouched. The tree is one control tall, so the capsule clips +-- cleanly in a horizontal or vertical bar. + +local format = require("./lib/format.luau") +local chips = require("./lib/chips.luau") + +local PANEL_ID = "royalebiskut/kvitals:sparkline" + +local sample = noctalia.state.get("kvitals.sample") +local config = noctalia.state.get("kvitals.config") +local ready = noctalia.state.get("kvitals.ready") == true + +-- Per-instance presentation settings (the host rebuilds this entry when +-- they change). +local font_size = noctalia.getConfig("font_size") or 12 +local display_mode = noctalia.getConfig("display_mode") or "both" +local hide_absent = noctalia.getConfig("hide_absent") +if hide_absent == nil then hide_absent = true end + +local function chipColor(chip) + if chip.tint == "critical" then return config.accent end + if chip.tint == "active" then return format.withAlpha(config.accent, 0.65) end + return config.font +end + +local function hasSysfsData(s) + return s.battery ~= nil or s.fanRpm ~= nil or s.diskTempC ~= nil + or s.cpuFreqHz ~= nil or s.diskIo ~= nil +end + +local function chipNode(chip) + local color = chipColor(chip) + local label = ui.label({ + text = chip.text, + fontSize = font_size, + fontWeight = "medium", + color = color, + }) + + if display_mode == "text" then + return label + end + + local glyph = ui.glyph({ + name = chip.glyph, + size = math.floor(font_size * 1.25), + color = display_mode == "icons" and config.accent or nil, + }) + + if display_mode == "icons" then + return glyph + end + + return ui.row({ gap = 4, align = "center" }, { glyph, label }) +end + +local function render() + local container = barWidget.isVertical() and ui.column or ui.row + + if not ready or sample == nil then + barWidget.render(ui.row({ gap = 6, align = "center" }, { + ui.glyph({ name = "activity", size = 14, color = "on_surface_variant" }), + ui.label({ text = "…", fontSize = font_size, color = "on_surface_variant" }), + })) + return + end + + if sample.ok == false and not hasSysfsData(sample) then + barWidget.render(ui.row({ gap = 6, align = "center" }, { + ui.glyph({ name = "alert-triangle", size = 14, color = "on_surface_variant" }), + ui.label({ text = noctalia.tr("widget.sysmon_off"), fontSize = font_size, color = "on_surface_variant" }), + })) + return + end + + local children = {} + for _, id in ipairs(config.metricOrder) do + if config.enabled[id] then + local chip = chips.chip(id, sample, config) + if chip then + table.insert(children, chipNode(chip)) + elseif not hide_absent then + table.insert(children, ui.label({ + text = "–", + fontSize = font_size, + color = "on_surface_variant", + })) + end + end + end + + if #children == 0 then + children = { + ui.label({ text = "-", fontSize = font_size, color = "on_surface_variant" }), + } + end + + barWidget.render(container({ gap = 8, align = "center" }, children)) + barWidget.setTooltip(chips.tooltipRows(sample, config)) +end + +noctalia.state.watch("kvitals.sample", function(value) + sample = value + render() +end) + +noctalia.state.watch("kvitals.config", function(value) + config = value + render() +end) + +noctalia.state.watch("kvitals.ready", function(value) + ready = value == true + render() +end) + +function update() + noctalia.setUpdateInterval(1000) + render() +end + +function onClick() + noctalia.togglePanel(PANEL_ID) +end + +function onRightClick() + noctalia.openSettings() +end