commit 18e21ffcdb2768a7209bcbd1c84a2d233d8b6e4c Author: Stefan de Konink Date: Sun Jan 4 20:54:12 2026 +0100 Initial commit PyMeshCore GUI is an open-source desktop application for interacting with the MeshCore network. It focuses on **chatting, prototyping, and development** on top of MeshCore, with an emphasis on desktop workflows and developer accessibility. The project is built using PySide6 (Qt for Python) and meshcore-py. diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..67dffcb --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +**/.idea +**/__pycache__/ +**/.venv +*.pyc +uv.lock diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..746b4ab --- /dev/null +++ b/README.md @@ -0,0 +1,63 @@ +# PyMeshCore GUI + +**PyMeshCore GUI** is an open-source desktop application for interacting with the MeshCore network. +It focuses on **chatting, prototyping, and development** on top of MeshCore, with an emphasis on +desktop workflows and developer accessibility. + +The project is built using **PySide6 (Qt for Python)** and **meshcore-py**. + +This is an early, experimental release. + +--- + +## Motivation + +MeshCore provides powerful mesh networking capabilities, but existing clients are closed source. +PyMeshCore GUI aims to explore what an **open, extensible desktop client** can look like, while also +serving as a platform for experimentation and future development. + +The long-term vision is a **full Qt-based stack**, potentially including a native C++ core +(`QMeshCore`) with a clean GUI layered on top. + +--- + +## Features (Current) + +- Desktop GUI built with PySide6 +- MeshCore connectivity via `meshcore-py` +- Chat-oriented interface +- Designed for experimentation and prototyping +- Cross-platform (where supported by dependencies) + +--- + +## Installation + +This project uses **uv**. + +```bash +uv sync +``` + +--- + +## Running + +```bash +uv run meshcore_gui +``` + +--- + +## Project Status + +PyMeshCore GUI is under active development and should be considered alpha software. +APIs, UI, and internal structure may change at any time. + +Contributions, feedback, and experimentation are welcome. + +--- + +## License + +This project is licensed under the GNU General Public License v3 (GPLv3). diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..aa1c5c1 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,29 @@ +[project] +name = "PyMeshCoreGUI" +version = "0.1.0" +description = "An open source Qt application build on MeshCore." +authors = [ + { name = "Stefan de Konink", email = "stefan@konink.de" }, +] +dependencies = [ + "PySide6", + "meshcore", +] + +requires-python = ">=3.12" + +[project.scripts] +meshcore-gui = "meshcore_gui.main:main" + +[build-system] +requires = ["setuptools"] +build-backend = "setuptools.build_meta" + +[tool.ruff] +line-length = 88 + +[tool.black] +line-length = 88 + +[tool.ty] +# Configuration for ty (if any) can go here diff --git a/src/PyMeshCoreGUI.egg-info/PKG-INFO b/src/PyMeshCoreGUI.egg-info/PKG-INFO new file mode 100644 index 0000000..bda16be --- /dev/null +++ b/src/PyMeshCoreGUI.egg-info/PKG-INFO @@ -0,0 +1,8 @@ +Metadata-Version: 2.4 +Name: PyMeshCoreGUI +Version: 0.1.0 +Summary: An open source Qt application build on MeshCore. +Author-email: Stefan de Konink +Requires-Python: >=3.12 +Requires-Dist: PySide6 +Requires-Dist: meshcore diff --git a/src/PyMeshCoreGUI.egg-info/SOURCES.txt b/src/PyMeshCoreGUI.egg-info/SOURCES.txt new file mode 100644 index 0000000..aae0a0a --- /dev/null +++ b/src/PyMeshCoreGUI.egg-info/SOURCES.txt @@ -0,0 +1,35 @@ +pyproject.toml +src/PyMeshCoreGUI.egg-info/PKG-INFO +src/PyMeshCoreGUI.egg-info/SOURCES.txt +src/PyMeshCoreGUI.egg-info/dependency_links.txt +src/PyMeshCoreGUI.egg-info/entry_points.txt +src/PyMeshCoreGUI.egg-info/requires.txt +src/PyMeshCoreGUI.egg-info/top_level.txt +src/meshcore_gui/__init__.py +src/meshcore_gui/main.py +src/meshcore_gui/controllers/__init__.py +src/meshcore_gui/controllers/channel_controller.py +src/meshcore_gui/controllers/contact_controller.py +src/meshcore_gui/controllers/meshcore_controller.py +src/meshcore_gui/controllers/message_controller.py +src/meshcore_gui/models/__init__.py +src/meshcore_gui/models/channel.py +src/meshcore_gui/models/channel_list_model.py +src/meshcore_gui/models/contact.py +src/meshcore_gui/models/contact_list_model.py +src/meshcore_gui/models/message.py +src/meshcore_gui/models/message_list_model.py +src/meshcore_gui/utils/__init__.py +src/meshcore_gui/utils/async_executor.py +src/meshcore_gui/utils/parsing.py +src/meshcore_gui/views/__init__.py +src/meshcore_gui/views/main_window.py +src/meshcore_gui/wizard/__init__.py +src/meshcore_gui/wizard/wizard_companion.py +src/meshcore_gui/wizard/companion/__init__.py +src/meshcore_gui/wizard/companion/community_presets.py +src/meshcore_gui/wizard/companion/connection.py +src/meshcore_gui/wizard/companion/deviceselection.py +src/meshcore_gui/wizard/companion/devicestatus.py +src/meshcore_gui/wizard/companion/mc_bluetooth.py +src/meshcore_gui/wizard/companion/mc_serial.py \ No newline at end of file diff --git a/src/PyMeshCoreGUI.egg-info/dependency_links.txt b/src/PyMeshCoreGUI.egg-info/dependency_links.txt new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/src/PyMeshCoreGUI.egg-info/dependency_links.txt @@ -0,0 +1 @@ + diff --git a/src/PyMeshCoreGUI.egg-info/entry_points.txt b/src/PyMeshCoreGUI.egg-info/entry_points.txt new file mode 100644 index 0000000..e2f2913 --- /dev/null +++ b/src/PyMeshCoreGUI.egg-info/entry_points.txt @@ -0,0 +1,2 @@ +[console_scripts] +meshcore-gui = meshcore_gui.main:main diff --git a/src/PyMeshCoreGUI.egg-info/requires.txt b/src/PyMeshCoreGUI.egg-info/requires.txt new file mode 100644 index 0000000..5891704 --- /dev/null +++ b/src/PyMeshCoreGUI.egg-info/requires.txt @@ -0,0 +1,2 @@ +PySide6 +meshcore diff --git a/src/PyMeshCoreGUI.egg-info/top_level.txt b/src/PyMeshCoreGUI.egg-info/top_level.txt new file mode 100644 index 0000000..2e042a1 --- /dev/null +++ b/src/PyMeshCoreGUI.egg-info/top_level.txt @@ -0,0 +1 @@ +meshcore_gui diff --git a/src/meshcore_gui/__init__.py b/src/meshcore_gui/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/src/meshcore_gui/controllers/__init__.py b/src/meshcore_gui/controllers/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/src/meshcore_gui/controllers/channel_controller.py b/src/meshcore_gui/controllers/channel_controller.py new file mode 100644 index 0000000..293d6ac --- /dev/null +++ b/src/meshcore_gui/controllers/channel_controller.py @@ -0,0 +1,49 @@ +from PySide6.QtCore import QObject, Slot, Signal, Qt, QItemSelection +from PySide6.QtWidgets import QListView +from meshcore import EventType +from meshcore.events import Event + +from ..models.channel import Channel +from ..models.channel_list_model import ChannelListModel + + +class ChannelController(QObject): + selected = Signal(object) + + def __init__(self, view: QListView, parent: QObject | None = None): + super().__init__(parent) + self.view = view + self.model = ChannelListModel() + self.view.setModel(self.model) + self.view.setSelectionMode(QListView.SingleSelection) + selection_model = self.view.selectionModel() + selection_model.selectionChanged.connect(self._on_selected) + + def _on_selected(self, selected: QItemSelection, deselected: QItemSelection): + if not selected.indexes(): + return + + index = selected.indexes()[0] + data = index.data(Qt.UserRole) + if data and "channel_idx" in data: + self.model.set_new_message(data["channel_idx"], True) + self.selected.emit(data) + + @Slot(int) + def new_channel_message(self, channel_idx: int): + self.model.set_new_message(channel_idx, False) + + @Slot() + def deselect(self): + if self.view.selectionModel().hasSelection(): + self.view.selectionModel().clearSelection() + + @Slot(object) + def process_event(self, event: Event): + if event.type == EventType.CHANNEL_INFO: + channel = Channel(event.payload) + + if not channel.is_valid(): + return # Ignore invalid channel + + self.model.add_or_update(channel) diff --git a/src/meshcore_gui/controllers/contact_controller.py b/src/meshcore_gui/controllers/contact_controller.py new file mode 100644 index 0000000..49fae3f --- /dev/null +++ b/src/meshcore_gui/controllers/contact_controller.py @@ -0,0 +1,53 @@ +from PySide6.QtCore import QObject, Slot, Signal, Qt, QItemSelection +from PySide6.QtWidgets import QListView +from meshcore import EventType +from meshcore.events import Event + +from ..models.contact import Contact +from ..models.contact_list_model import ContactListModel + + +class ContactController(QObject): + selected = Signal(object) + + def __init__(self, view: QListView, parent: QObject | None = None): + super().__init__(parent) + + self.view = view + self.model = ContactListModel() + self.view.setModel(self.model) + self.view.setSelectionMode(QListView.SingleSelection) + selection_model = self.view.selectionModel() + selection_model.selectionChanged.connect(self._on_selected) + + def _on_selected(self, selected: QItemSelection, deselected: QItemSelection): + if not selected.indexes(): + return + + index = selected.indexes()[0] + data = index.data(Qt.UserRole) + if data and "public_key" in data: + self.model.set_new_message(data["public_key"], True) + self.selected.emit(data) + + @Slot(str) + def new_private_message(self, pubkey_prefix: str): + self.model.set_new_message(pubkey_prefix, False) + + @Slot() + def deselect(self): + if self.view.selectionModel().hasSelection(): + self.view.selectionModel().clearSelection() + + @Slot(object) + def process_event(self, event: Event): + if event.type == EventType.CONTACTS: + for contact_payload in event.payload.values(): + contact = Contact(contact_payload) + self.model.add_contact(contact) + + elif ( + event.type == EventType.NEW_CONTACT or event.type == EventType.NEXT_CONTACT + ): + contact = Contact(event.payload) + self.model.add_contact(contact) diff --git a/src/meshcore_gui/controllers/meshcore_controller.py b/src/meshcore_gui/controllers/meshcore_controller.py new file mode 100644 index 0000000..29b4155 --- /dev/null +++ b/src/meshcore_gui/controllers/meshcore_controller.py @@ -0,0 +1,126 @@ +import asyncio +from typing import Any + +from PySide6.QtCore import QObject, Signal, Slot +from meshcore import MeshCore, EventType +from meshcore.events import Event + +from ..utils.async_executor import AsyncExecutor +from ..utils.parsing import parse_rx_log_data + + +class MeshCoreController(QObject): + self_info_ready = Signal(object) + contacts_ready = Signal(object) + channels_ready = Signal(object) + event_received = Signal(object) + message_sent = Signal(object) + + def __init__(self, mc: MeshCore, executor: AsyncExecutor): + super().__init__() + self.mc = mc + self.executor = executor + self._subscriptions = [] + self._shutdown_called = False + + @Slot(object) + def process_event(self, event: Event): + if event.type == EventType.RX_LOG_DATA: + # TODO: Publish this to a dedicated debugging tab + print("RX_LOG_DATA", parse_rx_log_data(event.payload)) + + elif event.type == EventType.NO_MORE_MSGS: + pass + + @Slot() + def get_self_info(self): + """Emit self_info immediately""" + self.self_info_ready.emit(self.mc.self_info) + + @Slot() + def fetch_contacts(self): + """Fetch contacts async via executor""" + self.executor.submit_async( + self.mc.commands.get_contacts_async(), self.contacts_ready + ) + + @Slot() + def channel_info(self): + """Fetch contacts async via executor""" + + async def all_channels(): + for channel_idx in range(0, 40): + await self.mc.commands.get_channel(channel_idx) + + self.executor.submit_async(all_channels(), self.channels_ready) + + @Slot() + def send_adv(self): + self.executor.submit_async(self.mc.commands.send_advert(True), None) + + def set_radio(self, freq: float, bw: float, sf: int, cr: int): + self.executor.submit_async(self.mc.commands.set_radio(freq, bw, sf, cr), None) + + def reboot(self): + self.executor.submit_async(self.mc.commands.reboot(), self.reboot) + + def set_name(self, name: str): + self.executor.submit_async(self.mc.commands.set_name(name), None) + + def start_message_stream(self): + """ + Subscribe to MeshCore native message events. + Each event triggers a Qt signal to the GUI. + """ + + async def handle_message(event: Event): + self.event_received.emit(event) + + sub1 = self.mc.subscribe(None, handle_message) + + # Keep track of subscriptions so we can unsubscribe them later + self._subscriptions.extend([sub1]) + + # Start MeshCore automatic fetching + asyncio.run_coroutine_threadsafe( + self.mc.start_auto_message_fetching(), self.executor.loop + ) + + @Slot(dict, str) + def send_message(self, target: dict[str, Any], text: str): + if "channel_idx" in target: + self.executor.submit_async( + self.mc.commands.send_chan_msg(target["channel_idx"], text), + self.message_sent, + ) + + elif "public_key" in target: + self.executor.submit_async( + self.mc.commands.send_msg(target["public_key"], text), + self.message_sent, + ) + + def shutdown(self): + """Idempotent shutdown""" + if self._shutdown_called: + return + self._shutdown_called = True + + # Cancel subscriptions + for sub in self._subscriptions: + try: + self.mc.unsubscribe(sub) + except Exception: + pass + self._subscriptions.clear() + + async def stop_fetching(): + try: + await self.mc.stop_auto_message_fetching() + await self.mc.disconnect() + except Exception: + pass + + asyncio.run_coroutine_threadsafe(stop_fetching(), self.executor.loop) + + self.executor.shutdown() diff --git a/src/meshcore_gui/controllers/message_controller.py b/src/meshcore_gui/controllers/message_controller.py new file mode 100644 index 0000000..c7c2e56 --- /dev/null +++ b/src/meshcore_gui/controllers/message_controller.py @@ -0,0 +1,76 @@ +import time +from typing import Any + +from PySide6.QtCore import QObject, Signal, Slot +from PySide6.QtWidgets import QListView +from meshcore import EventType +from meshcore.events import Event + +from ..models.message import Message +from ..models.message_list_model import MessageListModel + + +class MessageController(QObject): + new_channel_message = Signal(int) + new_private_message = Signal(str) + + def __init__(self, view: QListView, parent: QObject | None = None): + super().__init__(parent) + + self.view: QListView = view + self.current_chat: int | str | None = None + self.channel_models: dict[int | str, MessageListModel] = {} + + def get_channel_model(self, chat: int | str) -> MessageListModel: + if chat not in self.channel_models: + self.channel_models[chat] = MessageListModel() + return self.channel_models[chat] + + @Slot(object) + def set_chat(self, payload: dict[str, Any]): + chat_id = None + if "channel_idx" in payload: + chat_id = payload["channel_idx"] + elif "public_key" in payload: + chat_id = payload["public_key"][0:12] + + if chat_id is not None: + self.current_chat = chat_id + model = self.get_channel_model(chat_id) + self.view.setModel(model) + + @Slot(dict, str) + def send_message(self, target: dict[str, Any], text: str): + chat_id = None + if "channel_idx" in target: + chat_id = target["channel_idx"] + elif "public_key" in target: + chat_id = target["public_key"][0:12] + + if chat_id is not None: + model = self.get_channel_model(chat_id) + model.add_message( + Message({"text": text, "sender_timestamp": int(time.time())}) + ) + + @Slot(object) + def process_event(self, event: Event): + if event.type == EventType.CHANNEL_MSG_RECV: + payload = event.payload + chat = payload["channel_idx"] + + model = self.get_channel_model(chat) + model.add_message(Message(payload)) + + if self.current_chat != chat: + self.new_channel_message.emit(chat) + + elif event.type == EventType.CONTACT_MSG_RECV: + payload = event.payload + chat = payload["pubkey_prefix"] + + model = self.get_channel_model(chat) + model.add_message(Message(payload)) + + if self.current_chat != chat: + self.new_private_message.emit(chat) diff --git a/src/meshcore_gui/main.py b/src/meshcore_gui/main.py new file mode 100644 index 0000000..b5296b1 --- /dev/null +++ b/src/meshcore_gui/main.py @@ -0,0 +1,222 @@ +import argparse +import asyncio +import signal +import sys +from meshcore import MeshCore + +from PySide6.QtCore import QCoreApplication, QObject, QSettings, QThread, QTimer, Slot +from PySide6.QtWidgets import QApplication + +from .controllers.channel_controller import ChannelController +from .controllers.contact_controller import ContactController +from .controllers.message_controller import MessageController +from .controllers.meshcore_controller import MeshCoreController + +from .utils.async_executor import AsyncExecutor +from .views.main_window import MeshCoreWidget +from .wizard.wizard_companion import CompanionWizard + + +class ApplicationController(QObject): + def __init__(self, executor, loop): + self.mc = None + self.meshcore_controller = None + self.executor = executor + self.loop = loop + + def attempt_connection(self): + async def init_mc(port, interace_type: str): + try: + if interface_type == "serial": + mc = await MeshCore.create_serial(port) + return mc + elif interface_type == "bluetooth": + mc = await MeshCore.create_ble(port) + return mc + except: + pass + + return None + + async def disconnect_mc(mc): + try: + await mc.disconnect() + except: + pass + + if self.mc is not None: + future = asyncio.run_coroutine_threadsafe(disconnect_mc(self.mc), self.loop) + self.mc = None + + port = None + settings = QSettings() + settings.beginGroup("interface") + interface_type = settings.value("type", False) + if interface_type == "serial": + port = settings.value("port") + elif interface_type == "bluetooth": + port = settings.value("addr") + settings.endGroup() + + if port is None: + return None + + future = asyncio.run_coroutine_threadsafe( + init_mc(port, interface_type), self.loop + ) + self.mc = future.result() + self.meshcore_controller = MeshCoreController(self.mc, self.executor) + + return self.mc is not None + + def start(self, force_wizard=False): + if force_wizard: + self.start_wizard() + + else: + if self.mc is None: + self.attempt_connection() + + if self.mc is not None: + self.start_main() + + else: + self.start_wizard() + + @Slot(bool) + def on_wizard_done(self, success: bool): + if success: + self.start() + + def start_wizard(self): + self.wizard = CompanionWizard(self) + self.wizard.completed.connect(self.on_wizard_done) + self.wizard.show() + + def start_main(self): + # --- GUI --- + self.widget = MeshCoreWidget() + self.widget.setWindowTitle("MeshCore Chat") + self.widget.resize(400, 600) + self.widget.show() + + # --- Controllers --- + self.message_controller = MessageController(self.widget.list_msgs) + self.contact_controller = ContactController(self.widget.list_contacts) + self.channel_controller = ChannelController(self.widget.list_channels) + + # --- Signal/Slot Connections --- + self.meshcore_controller.event_received.connect( + self.meshcore_controller.process_event + ) + self.meshcore_controller.event_received.connect( + self.message_controller.process_event + ) + self.meshcore_controller.event_received.connect( + self.contact_controller.process_event + ) + self.meshcore_controller.event_received.connect( + self.channel_controller.process_event + ) + self.meshcore_controller.self_info_ready.connect(self.widget.update_self_info) + self.meshcore_controller.message_sent.connect(self.widget.on_sent) + + self.contact_controller.selected.connect(self.message_controller.set_chat) + self.contact_controller.selected.connect(self.channel_controller.deselect) + self.contact_controller.selected.connect(self.widget.set_target) + + self.channel_controller.selected.connect(self.contact_controller.deselect) + self.channel_controller.selected.connect(self.message_controller.set_chat) + self.channel_controller.selected.connect(self.widget.set_target) + + self.message_controller.new_channel_message.connect( + self.channel_controller.new_channel_message + ) + self.message_controller.new_private_message.connect( + self.contact_controller.new_private_message + ) + + self.widget.text_submitted.connect(self.meshcore_controller.send_message) + self.widget.text_submitted.connect(self.message_controller.send_message) + self.widget.button_adv.clicked.connect(self.meshcore_controller.send_adv) + + # --- Initial actions --- + self.meshcore_controller.start_message_stream() + self.meshcore_controller.channel_info() + self.meshcore_controller.get_self_info() + self.meshcore_controller.fetch_contacts() + + +def main(): + parser = argparse.ArgumentParser(description="MeshCore GUI") + parser.add_argument( + "--port", default="/dev/ttyACM0", help="Serial port for the MeshCore device" + ) + parser.add_argument( + "--wizard", default=False, action="store_true", help="Start the wizard" + ) + args = parser.parse_args() + + if args.port is not None: + settings = QSettings() + settings.beginGroup("interface") + settings.setValue("port", args.port) + settings.endGroup() + + app = QApplication(sys.argv) + app.setQuitOnLastWindowClosed(True) + + # --- asyncio loop in background thread --- + loop = asyncio.new_event_loop() + asyncio.set_event_loop(loop) + + loop_thread = QThread() + + def start_loop(): + asyncio.set_event_loop(loop) + loop.run_forever() + + loop_thread.run = start_loop + loop_thread.start() + + executor = AsyncExecutor(loop) + + controller = ApplicationController(executor, loop) + controller.start(args.wizard) + + # --- Idempotent shutdown --- + shutdown_called = False + + def shutdown(*args): + nonlocal shutdown_called + if shutdown_called: + return + shutdown_called = True + + if controller.meshcore_controller: + controller.meshcore_controller.shutdown() + + loop.call_soon_threadsafe(loop.stop) + loop_thread.quit() + loop_thread.wait() + + app.quit() + + # --- Signal Handlers --- + signal.signal(signal.SIGINT, shutdown) + app.aboutToQuit.connect(shutdown) + + # Timer to allow Python's signal handler to run + timer = QTimer() + timer.start(500) + timer.timeout.connect(lambda: None) + + sys.exit(app.exec()) + + +if __name__ == "__main__": + QCoreApplication.setOrganizationName("Bliksem Labs B.V.") + QCoreApplication.setOrganizationDomain("bliksemlabs.com") + QCoreApplication.setApplicationName("MeshCoreGUI") + + main() diff --git a/src/meshcore_gui/models/__init__.py b/src/meshcore_gui/models/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/src/meshcore_gui/models/channel.py b/src/meshcore_gui/models/channel.py new file mode 100644 index 0000000..b6e4483 --- /dev/null +++ b/src/meshcore_gui/models/channel.py @@ -0,0 +1,29 @@ +from typing import Any + + +class Channel: + def __init__(self, payload: dict[str, Any]): + self.payload = payload + self.new_message = 0 + + def set_new_message(self, value: int): + if value == 0: + self.new_message = 0 + else: + self.new_message += value + + @property + def channel_idx(self) -> int | None: + return self.payload.get("channel_idx") + + @property + def name(self) -> str: + return self.payload.get("channel_name", "Unnamed channel") + + @property + def secret(self) -> bytes | None: + return self.payload.get("channel_secret") + + def is_valid(self) -> bool: + # Ignore channel if secret is 16 null-bytes + return self.secret is not None and self.secret != b"\x00" * 16 diff --git a/src/meshcore_gui/models/channel_list_model.py b/src/meshcore_gui/models/channel_list_model.py new file mode 100644 index 0000000..08f08f0 --- /dev/null +++ b/src/meshcore_gui/models/channel_list_model.py @@ -0,0 +1,63 @@ +from PySide6.QtCore import QAbstractListModel, QModelIndex, Qt +from PySide6.QtGui import QFont, QBrush, QColor + +from .channel import Channel + + +class ChannelListModel(QAbstractListModel): + def __init__(self, channels: list[Channel] | None = None): + super().__init__() + self._channels: list[Channel] = channels or [] + + def rowCount(self, parent: QModelIndex = QModelIndex()) -> int: + return len(self._channels) + + def data(self, index: QModelIndex, role: int = Qt.DisplayRole): + if not index.isValid(): + return None + + channel = self._channels[index.row()] + + if role == Qt.DisplayRole: + return channel.name + + elif role == Qt.UserRole: + return channel.payload + + elif role == Qt.FontRole and channel.new_message > 0: + font = QFont() + font.setBold(True) + return font + + elif role == Qt.ForegroundRole and channel.new_message > 0: + return QBrush(QColor("red")) # Mark new messages + + return None + + def add_or_update(self, channel: Channel): + # Update existing channel by channel_idx + for row, existing in enumerate(self._channels): + if existing.channel_idx == channel.channel_idx: + self._channels[row] = channel + idx = self.index(row) + self.dataChanged.emit(idx, idx, [Qt.DisplayRole, Qt.UserRole]) + return + + # New channel + self.beginInsertRows(QModelIndex(), len(self._channels), len(self._channels)) + self._channels.append(channel) + self.endInsertRows() + + def set_new_message(self, channel_idx: int, reset: bool = False): + for row, item in enumerate(self._channels): + if item.channel_idx == channel_idx: + if reset: + item.set_new_message(0) + else: + item.set_new_message(1) + + idx = self.index(row, 0) + self.dataChanged.emit( + idx, idx, [Qt.DisplayRole, Qt.FontRole, Qt.ForegroundRole] + ) + break diff --git a/src/meshcore_gui/models/contact.py b/src/meshcore_gui/models/contact.py new file mode 100644 index 0000000..2956fd5 --- /dev/null +++ b/src/meshcore_gui/models/contact.py @@ -0,0 +1,23 @@ +from typing import Any + + +class Contact: + """Simple container for contact payload""" + + def __init__(self, payload: dict[str, Any]): + self.payload = payload + self.new_message = 0 + + def set_new_message(self, value: int): + if value == 0: + self.new_message = 0 + else: + self.new_message += value + + @property + def name(self) -> str: + return self.payload.get("adv_name", "Unknown") + + @property + def public_key(self) -> str | None: + return self.payload.get("public_key") diff --git a/src/meshcore_gui/models/contact_list_model.py b/src/meshcore_gui/models/contact_list_model.py new file mode 100644 index 0000000..c82d351 --- /dev/null +++ b/src/meshcore_gui/models/contact_list_model.py @@ -0,0 +1,77 @@ +from PySide6.QtCore import QAbstractListModel, QModelIndex, Qt +from PySide6.QtGui import QFont, QBrush, QColor + +from .contact import Contact + + +class ContactListModel(QAbstractListModel): + """Model that manages a list of contacts for a QListView""" + + def __init__(self, contacts: list[Contact] | None = None): + super().__init__() + self._contacts = contacts or [] + + def data(self, index: QModelIndex, role: int = Qt.DisplayRole): + if not index.isValid(): + return None + contact = self._contacts[index.row()] + + if role == Qt.DisplayRole: + return contact.name + + elif role == Qt.UserRole: + return contact.payload + + elif role == Qt.FontRole and contact.new_message > 0: + font = QFont() + font.setBold(True) + return font + + elif role == Qt.ForegroundRole and contact.new_message > 0: + return QBrush(QColor("red")) + + return None + + def rowCount(self, parent: QModelIndex = QModelIndex()) -> int: + return len(self._contacts) + + def add_contact(self, contact: Contact): + """Add a new contact or update an existing one based on public_key""" + for row, existing in enumerate(self._contacts): + if existing.public_key == contact.public_key: + self._contacts[row] = contact + index = self.index(row) + self.dataChanged.emit(index, index, [Qt.DisplayRole, Qt.UserRole]) + return + + # If not found, add as a new contact + self.beginInsertRows(QModelIndex(), len(self._contacts), len(self._contacts)) + self._contacts.append(contact) + self.endInsertRows() + + def remove_contact(self, row: int): + """Remove contact at index""" + if 0 <= row < len(self._contacts): + self.beginRemoveRows(QModelIndex(), row, row) + self._contacts.pop(row) + self.endRemoveRows() + + def clear(self): + """Remove all contacts""" + self.beginResetModel() + self._contacts.clear() + self.endResetModel() + + def set_new_message(self, pubkey_prefix: str, reset: bool = False): + for row, item in enumerate(self._contacts): + if item.public_key and item.public_key.startswith(pubkey_prefix): + if reset: + item.set_new_message(0) + else: + item.set_new_message(1) + + idx = self.index(row, 0) + self.dataChanged.emit( + idx, idx, [Qt.DisplayRole, Qt.FontRole, Qt.ForegroundRole] + ) + break diff --git a/src/meshcore_gui/models/message.py b/src/meshcore_gui/models/message.py new file mode 100644 index 0000000..92dac17 --- /dev/null +++ b/src/meshcore_gui/models/message.py @@ -0,0 +1,22 @@ +from datetime import datetime +from typing import Any + + +class Message: + def __init__(self, payload: dict[str, Any]): + self.payload = payload + + @property + def timestamp(self) -> datetime | None: + ts = self.payload.get("sender_timestamp") + return datetime.fromtimestamp(ts) if ts else None + + @property + def text(self) -> str: + return self.payload.get("text", "") + + def formatted(self) -> str: + if self.timestamp: + time_str = self.timestamp.strftime("%Y-%m-%d %H:%M:%S") + return f"[{time_str}] {self.text}" + return self.text diff --git a/src/meshcore_gui/models/message_list_model.py b/src/meshcore_gui/models/message_list_model.py new file mode 100644 index 0000000..37866a7 --- /dev/null +++ b/src/meshcore_gui/models/message_list_model.py @@ -0,0 +1,36 @@ +from PySide6.QtCore import QAbstractListModel, QModelIndex, Qt + +from .message import Message + + +class MessageListModel(QAbstractListModel): + def __init__(self, messages: list[Message] | None = None): + super().__init__() + self._messages = messages or [] + + def rowCount(self, parent: QModelIndex = QModelIndex()) -> int: + return len(self._messages) + + def data(self, index: QModelIndex, role: int = Qt.DisplayRole): + if not index.isValid(): + return None + + msg = self._messages[index.row()] + + if role == Qt.DisplayRole: + return msg.formatted() + + if role == Qt.UserRole: + return msg.payload + + return None + + def add_message(self, message: Message): + self.beginInsertRows(QModelIndex(), len(self._messages), len(self._messages)) + self._messages.append(message) + self.endInsertRows() + + def clear(self): + self.beginResetModel() + self._messages.clear() + self.endResetModel() diff --git a/src/meshcore_gui/utils/__init__.py b/src/meshcore_gui/utils/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/src/meshcore_gui/utils/async_executor.py b/src/meshcore_gui/utils/async_executor.py new file mode 100644 index 0000000..a90361c --- /dev/null +++ b/src/meshcore_gui/utils/async_executor.py @@ -0,0 +1,29 @@ +import asyncio +from typing import Optional, Coroutine + +from PySide6.QtCore import QObject, Signal + + +class AsyncExecutor(QObject): + def __init__(self, loop: asyncio.AbstractEventLoop): + super().__init__() + self.loop = loop + + def submit_async(self, coro: Coroutine, signal: Optional[Signal] = None): + """Submit coroutine and emit signal on completion""" + future = asyncio.run_coroutine_threadsafe(coro, self.loop) + if signal: + future.add_done_callback(lambda f: self._emit_safe(f, signal)) + + def _emit_safe(self, fut: asyncio.Future, signal: Signal): + try: + result = fut.result() + except Exception as e: + print("Async call failed:", e) + return + signal.emit(result) + + def shutdown(self): + """Stop the loop safely""" + if self.loop.is_running(): + self.loop.call_soon_threadsafe(self.loop.stop) diff --git a/src/meshcore_gui/utils/parsing.py b/src/meshcore_gui/utils/parsing.py new file mode 100644 index 0000000..f067119 --- /dev/null +++ b/src/meshcore_gui/utils/parsing.py @@ -0,0 +1,63 @@ +import logging +from typing import Any + +_LOGGER = logging.getLogger(__name__) + + +def parse_rx_log_data(payload: Any) -> dict[str, Any]: + """Parse RX_LOG event payload to extract LoRa packet details. + + Expected format (hex): + byte0: header + byte1: path_len + next path_len bytes: path nodes + next byte: channel_hash (optional) + """ + result: dict[str, Any] = {} + + try: + hex_str = None + + if isinstance(payload, dict): + hex_str = payload.get("payload") or payload.get("raw_hex") + elif isinstance(payload, (str, bytes)): + hex_str = payload + + if not hex_str: + return result + + if isinstance(hex_str, bytes): + hex_str = hex_str.hex() + + hex_str = ( + str(hex_str).lower().replace(" ", "").replace("\n", "").replace("\r", "") + ) + + if len(hex_str) < 4: + return result + + result["header"] = hex_str[0:2] + + try: + path_len = int(hex_str[2:4], 16) + result["path_len"] = path_len + except ValueError: + return {} + + path_start = 4 + path_end = path_start + (path_len * 2) + + if len(hex_str) < path_end: + return {} + + path_hex = hex_str[path_start:path_end] + result["path"] = path_hex + result["path_nodes"] = [path_hex[i : i + 2] for i in range(0, len(path_hex), 2)] + + if len(hex_str) >= path_end + 2: + result["channel_hash"] = hex_str[path_end : path_end + 2] + + except Exception as ex: + _LOGGER.debug(f"Error parsing RX_LOG data: {ex}") + + return result diff --git a/src/meshcore_gui/views/__init__.py b/src/meshcore_gui/views/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/src/meshcore_gui/views/main_window.py b/src/meshcore_gui/views/main_window.py new file mode 100644 index 0000000..ead0ff4 --- /dev/null +++ b/src/meshcore_gui/views/main_window.py @@ -0,0 +1,92 @@ +from typing import Any, TYPE_CHECKING + +from PySide6.QtCore import Signal, Slot +from PySide6.QtGui import QCloseEvent +from PySide6.QtWidgets import ( + QWidget, + QVBoxLayout, + QLabel, + QPushButton, + QListView, + QHBoxLayout, + QLineEdit, +) + +if TYPE_CHECKING: + from controllers.meshcore_controller import MeshCoreController + + +class MeshCoreWidget(QWidget): + text_submitted = Signal(object, str) + + def __init__(self): + super().__init__() + self.controller: "MeshCoreController" | None = None + self.current_target: dict[str, Any] | None = None + + # GUI layout + self.layout = QVBoxLayout(self) + self.label_info = QLabel("Node info: ...") + self.button_adv = QPushButton("Adv") + self.list_contacts = QListView() + self.list_channels = QListView() + self.list_msgs = QListView() + + option_layout = QHBoxLayout() + option_layout.addWidget(self.label_info, stretch=1) + option_layout.addWidget(self.button_adv) + + option_panel = QWidget() + option_panel.setLayout(option_layout) + self.layout.addWidget(option_panel) + + self.layout.addWidget(QLabel("Contacts:")) + self.layout.addWidget(self.list_contacts) + self.layout.addWidget(QLabel("Channels:")) + self.layout.addWidget(self.list_channels) + self.layout.addWidget(QLabel("Messages:")) + self.layout.addWidget(self.list_msgs) + + # --- Input area --- + self.input_line = QLineEdit() + self.input_line.setPlaceholderText("Type a message…") + self.send_button = QPushButton("Send") + + input_layout = QHBoxLayout() + input_layout.addWidget(self.input_line, stretch=1) + input_layout.addWidget(self.send_button) + + input_panel = QWidget() + input_panel.setLayout(input_layout) + self.layout.addWidget(input_panel) + + self.send_button.clicked.connect(self._on_send_clicked) + self.input_line.returnPressed.connect(self._on_send_clicked) + + @Slot(object) + def set_target(self, target: dict[str, Any]): + self.current_target = target + + def _on_send_clicked(self): + if self.current_target is not None: + text = self.input_line.text().strip() + if text: + self.text_submitted.emit(self.current_target, text) + + @Slot(object) + def on_sent(self, event: Any): + self.input_line.clear() + + @Slot(object) + def update_self_info(self, info: dict[str, Any]): + self.label_info.setText(f"Node info: {info.get('name', 'N/A')}") + + def setController(self, controller: "MeshCoreController"): + self.controller = controller + + def closeEvent(self, event: QCloseEvent): + if self.controller: + # Stop streaming and executor loop + self.controller.shutdown() + + event.accept() # Allow the window to close diff --git a/src/meshcore_gui/wizard/__init__.py b/src/meshcore_gui/wizard/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/src/meshcore_gui/wizard/companion/__init__.py b/src/meshcore_gui/wizard/companion/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/src/meshcore_gui/wizard/companion/community-presets.json b/src/meshcore_gui/wizard/companion/community-presets.json new file mode 100644 index 0000000..f2ffb11 --- /dev/null +++ b/src/meshcore_gui/wizard/companion/community-presets.json @@ -0,0 +1,133 @@ +{ + "version": "community-presets-1.0", + "source": "MeshCore mobile app – community suggested presets", + "notes": "These presets are community-suggested RF settings as exposed in the MeshCore app UI. They are not guaranteed to be legally valid in all regions.", + "presets": [ + { + "id": "australia", + "name": "Australia", + "region": "Australia", + "frequency_mhz": 915.800, + "spreading_factor": 10, + "bandwidth_khz": 250, + "coding_rate": 5 + }, + { + "id": "australia_victoria", + "name": "Australia: Victoria", + "region": "Australia", + "frequency_mhz": 916.575, + "spreading_factor": 7, + "bandwidth_khz": 62.5, + "coding_rate": 8 + }, + { + "id": "eu_uk_narrow", + "name": "EU/UK (Narrow)", + "region": "EU/UK", + "frequency_mhz": 869.618, + "spreading_factor": 8, + "bandwidth_khz": 62.5, + "coding_rate": 8 + }, + { + "id": "eu_uk_long_range", + "name": "EU/UK (Long Range)", + "region": "EU/UK", + "frequency_mhz": 869.525, + "spreading_factor": 11, + "bandwidth_khz": 250, + "coding_rate": 5 + }, + { + "id": "eu_uk_medium_range", + "name": "EU/UK (Medium Range)", + "region": "EU/UK", + "frequency_mhz": 869.525, + "spreading_factor": 10, + "bandwidth_khz": 250, + "coding_rate": 5 + }, + { + "id": "czech_republic_narrow", + "name": "Czech Republic (Narrow)", + "region": "Czech Republic", + "frequency_mhz": 869.525, + "spreading_factor": 7, + "bandwidth_khz": 62.5, + "coding_rate": 5 + }, + { + "id": "eu_433_long_range", + "name": "EU 433MHz (Long Range)", + "region": "EU 433MHz", + "frequency_mhz": 433.650, + "spreading_factor": 11, + "bandwidth_khz": 250, + "coding_rate": 5 + }, + { + "id": "new_zealand", + "name": "New Zealand", + "region": "New Zealand", + "frequency_mhz": 917.375, + "spreading_factor": 11, + "bandwidth_khz": 250, + "coding_rate": 5 + }, + { + "id": "new_zealand_narrow", + "name": "New Zealand (Narrow)", + "region": "New Zealand", + "frequency_mhz": 917.375, + "spreading_factor": 7, + "bandwidth_khz": 62.5, + "coding_rate": 5 + }, + { + "id": "portugal_433", + "name": "Portugal 433", + "region": "Portugal", + "frequency_mhz": 433.375, + "spreading_factor": 9, + "bandwidth_khz": 62.5, + "coding_rate": 6 + }, + { + "id": "portugal_868", + "name": "Portugal 868", + "region": "Portugal", + "frequency_mhz": 869.618, + "spreading_factor": 7, + "bandwidth_khz": 62.5, + "coding_rate": 6 + }, + { + "id": "switzerland", + "name": "Switzerland", + "region": "Switzerland", + "frequency_mhz": 869.618, + "spreading_factor": 8, + "bandwidth_khz": 62.5, + "coding_rate": 8 + }, + { + "id": "usa_canada_recommended", + "name": "USA/Canada (Recommended)", + "region": "USA/Canada", + "frequency_mhz": 910.525, + "spreading_factor": 7, + "bandwidth_khz": 62.5, + "coding_rate": 5 + }, + { + "id": "vietnam", + "name": "Vietnam", + "region": "Vietnam", + "frequency_mhz": 920.250, + "spreading_factor": 11, + "bandwidth_khz": 250, + "coding_rate": 5 + } + ] +} diff --git a/src/meshcore_gui/wizard/companion/community_presets.py b/src/meshcore_gui/wizard/companion/community_presets.py new file mode 100644 index 0000000..a55810e --- /dev/null +++ b/src/meshcore_gui/wizard/companion/community_presets.py @@ -0,0 +1,61 @@ +from PySide6.QtWidgets import QWidget, QVBoxLayout, QComboBox +from PySide6.QtCore import QFile, QIODevice +from PySide6.QtCore import QJsonDocument + +class PresetSelector(QWidget): + def __init__(self, json_file): + super().__init__() + self.setWindowTitle("Community Presets") + + # Layout + layout = QVBoxLayout(self) + + # ComboBox + self.combo = QComboBox() + layout.addWidget(self.combo) + + # Load JSON and populate combobox + self.load_presets(json_file) + + def load_presets(self, json_file): + file = QFile(json_file) + if not file.open(QIODevice.ReadOnly | QIODevice.Text): + raise RuntimeError(f"Cannot open {json_file}") + + data = file.readAll() + file.close() + + doc = QJsonDocument.fromJson(data) + if not doc.isObject(): + raise ValueError("Invalid JSON root object") + + root = doc.object() + presets = root.get("presets", []) + + for preset in presets: + preset_lookup = "-".join( + [ + str(preset["frequency_mhz"]), + str(int(preset["bandwidth_khz"])), + str(preset["spreading_factor"]), + str(preset["coding_rate"]), + ] + ) + self.combo.addItem(preset["name"], userData=preset_lookup) + + def select_by_self_info(self, self_info: dict): + preset_lookup = "-".join( + [ + str(self_info["radio_freq"]), + str(int(self_info["radio_bw"])), + str(self_info["radio_sf"]), + str(self_info["radio_cr"]), + ] + ) + index = self.combo.findData(preset_lookup) + if index != -1: + self.combo.setCurrentIndex(index) + else: + self.combo.addItem("Custom", userData=preset_lookup) + index = self.combo.findData(preset_lookup) + self.combo.setCurrentIndex(index) diff --git a/src/meshcore_gui/wizard/companion/connection.py b/src/meshcore_gui/wizard/companion/connection.py new file mode 100644 index 0000000..5392ca8 --- /dev/null +++ b/src/meshcore_gui/wizard/companion/connection.py @@ -0,0 +1,42 @@ +from PySide6.QtWidgets import ( + QWizardPage, + QVBoxLayout, + QLabel, + QRadioButton, + QButtonGroup, +) + + +# ======================== +# Wizard Pages +# ======================== +class ConnectionTypePage(QWizardPage): + def __init__(self): + super().__init__() + self.setTitle("Choose connection type") + layout = QVBoxLayout() + self.setLayout(layout) + + layout.addWidget(QLabel("In which way do you wat to connect?")) + + self.serial_radio = QRadioButton("Serial") + self.serial_radio.setChecked(True) + self.bt_radio = QRadioButton("Bluetooth") + self.bt_radio.setEnabled(True) + self.tcp_radio = QRadioButton("TCP/IP") + self.tcp_radio.setEnabled(False) + layout.addWidget(self.serial_radio) + layout.addWidget(self.bt_radio) + layout.addWidget(self.tcp_radio) + + self.group = QButtonGroup() + self.group.addButton(self.serial_radio) + self.group.addButton(self.bt_radio) + self.group.addButton(self.tcp_radio) + + def validatePage(self) -> bool: + return ( + self.bt_radio.isChecked() + or self.serial_radio.isChecked() + or self.tcp_radio.isChecked() + ) diff --git a/src/meshcore_gui/wizard/companion/deviceselection.py b/src/meshcore_gui/wizard/companion/deviceselection.py new file mode 100644 index 0000000..194ce52 --- /dev/null +++ b/src/meshcore_gui/wizard/companion/deviceselection.py @@ -0,0 +1,74 @@ +from PySide6.QtWidgets import ( + QWizardPage, + QVBoxLayout, + QLabel, + QListWidget, + QLineEdit, +) +from PySide6.QtCore import Slot + +from .mc_bluetooth import BluetoothConnection +from .mc_serial import SerialConnection + + +class DeviceSelectionPage(QWizardPage): + def __init__(self, wizard): + super().__init__() + self.setTitle("Select Device") + self.wizard_ref = wizard + self.layout = QVBoxLayout() + self.setLayout(self.layout) + + self.label = QLabel("Select Device:") + self.layout.addWidget(self.label) + + self.device_list = QListWidget() + + self.ip_field = QLineEdit() + self.ip_field.setPlaceholderText("Hostname / IP") + self.port_field = QLineEdit() + self.port_field.setPlaceholderText("Port") + + def initializePage(self): + conn_page = self.wizard_ref.page(0) + + # Clear old widgets + self.device_list.clear() + self.layout.removeWidget(self.device_list) + self.layout.removeWidget(self.ip_field) + self.layout.removeWidget(self.port_field) + + if conn_page.bt_radio.isChecked(): + self.wizard_ref.connection = BluetoothConnection( + self.wizard_ref.application_controller + ) + self.label.setText("Select a Bluetooth device") + self.layout.addWidget(self.device_list) + + agent = self.wizard_ref.connection.agent + agent.deviceDiscovered.connect(self.add_device) + agent.finished.connect(self.scan_finished) + agent.start() + + elif conn_page.serial_radio.isChecked(): + self.wizard_ref.connection = SerialConnection( + self.wizard_ref.application_controller + ) + self.label.setText("Select a serial port") + devices = self.wizard_ref.connection.scan_devices() + self.device_list.addItems(devices) + self.layout.addWidget(self.device_list) + + elif conn_page.tcp_radio.isChecked(): + self.label.setText("TCP/IP connection") + self.layout.addWidget(self.ip_field) + self.layout.addWidget(self.port_field) + + @Slot(object) + def add_device(self, device_info): + self.device_list.addItem(device_info.name()) + self.wizard_ref.connection.device_list.append(device_info) + + @Slot() + def scan_finished(self): + pass diff --git a/src/meshcore_gui/wizard/companion/devicestatus.py b/src/meshcore_gui/wizard/companion/devicestatus.py new file mode 100644 index 0000000..bf94981 --- /dev/null +++ b/src/meshcore_gui/wizard/companion/devicestatus.py @@ -0,0 +1,116 @@ +from PySide6.QtWidgets import ( + QWizardPage, + QVBoxLayout, + QLabel, + QLineEdit, + QPushButton, +) + +from pathlib import Path + +from .mc_bluetooth import BluetoothConnection +from .mc_serial import SerialConnection +from .community_presets import PresetSelector + + +class DeviceStatusPage(QWizardPage): + def __init__(self, wizard): + super().__init__() + self.setTitle("Check device properties") + self.wizard_ref = wizard + layout = QVBoxLayout() + self.setLayout(layout) + + self.name_label = QLabel("Name") + self.name = QLineEdit() + layout.addWidget(self.name_label) + layout.addWidget(self.name) + + self.pubkey = QLineEdit() + self.pubkey.setEnabled(False) + self.pubkey_label = QLabel("Public Key") + layout.addWidget(self.pubkey_label) + layout.addWidget(self.pubkey) + + base_path = Path(__file__).parent + self.profile_dropdown = PresetSelector( + base_path / "community-presets.json" + ) + layout.addWidget(self.profile_dropdown) + + self.button_save = QPushButton("Save") + self.button_save.setEnabled(False) + layout.addWidget(self.button_save) + + self._initial_name = None + self._initial_profile = None + + self.name.textChanged.connect(self._update_dirty_state) + self.profile_dropdown.combo.currentIndexChanged.connect( + self._update_dirty_state + ) + self.button_save.clicked.connect(self._on_save_clicked) + + def _update_dirty_state(self) -> None: + name_changed = self.name.text() != self._initial_name + profile_changed = ( + self.profile_dropdown.combo.currentData() != self._initial_profile + ) + self._is_dirty = name_changed or profile_changed + self.button_save.setEnabled(self._is_dirty) + + def _on_save_clicked(self) -> None: + if not self._is_dirty: + return + + self._save_data() + + def _save_data(self) -> None: + new_name = self.name.text() + new_profile = self.profile_dropdown.combo.currentData() + + if new_name != self._initial_name: + self.wizard_ref.application_controller.meshcore_controller.set_name( + new_name + ) + self._initial_name = new_name + + if new_profile != self._initial_profile: + freq, bw, sf, cr = new_profile.split("-") + self.wizard_ref.application_controller.meshcore_controller.set_radio( + float(freq), float(bw), int(sf), int(cr) + ) + self._initial_profile = new_profile + + self._is_dirty = False + self.button_save.setEnabled(False) + + def validatePage(self) -> bool: + if self._is_dirty: + self._save_data() + return True + + def update_profile(self, application_controller): + self.info = self.wizard_ref.application_controller.mc.self_info + if "name" in self.info: + self.name.setText(self.info["name"]) + self.pubkey.setText(self.info["public_key"]) + self.profile_dropdown.select_by_self_info(self.info) + + self._initial_name = self.name.text() + self._initial_profile = self.profile_dropdown.combo.currentData() + self._is_dirty = False + self.button_save.setEnabled(False) + + def initializePage(self): + conn = self.wizard_ref.connection + if isinstance(conn, SerialConnection): + conn.connect( + self.wizard_ref.page(1).device_list.currentItem().text(), + self.update_profile, + ) + elif isinstance(conn, BluetoothConnection): + conn.connect( + self.wizard_ref.page(1).device_list.currentItem().text(), + self.update_profile, + ) diff --git a/src/meshcore_gui/wizard/companion/mc_bluetooth.py b/src/meshcore_gui/wizard/companion/mc_bluetooth.py new file mode 100644 index 0000000..f125094 --- /dev/null +++ b/src/meshcore_gui/wizard/companion/mc_bluetooth.py @@ -0,0 +1,53 @@ +from PySide6.QtCore import QObject, Slot, Signal, QSettings +from PySide6.QtBluetooth import ( + QBluetoothDeviceDiscoveryAgent, + QBluetoothDeviceInfo, +) + + +class BluetoothConnection(QObject): + """ + Bluetooth connection implemented using PySide6 QtBluetooth. + Supports asynchronous scanning with live updates, connecting via RFCOMM, + and returning device info after successful connection. + """ + + device_discovered = Signal(QBluetoothDeviceInfo) # signaal voor GUI live update + scan_finished = Signal() # signaal als scan klaar is + + def __init__(self, application_controller): + super().__init__() + self.application_controller = application_controller + self.device_list = [] # opgeslagen QBluetoothDeviceInfo objecten + self.connected_socket = None # QBluetoothSocket + self.device_info = None # dict met name/public_key + self.agent = QBluetoothDeviceDiscoveryAgent() + self.agent.setLowEnergyDiscoveryTimeout(5000) + + # Verbind agent signalen naar interne slots + self.agent.deviceDiscovered.connect(self._on_device_discovered) + self.agent.finished.connect(self._on_scan_finished) + + def start_scan(self): + self.device_list.clear() + self.agent.start() + + @Slot(QBluetoothDeviceInfo) + def _on_device_discovered(self, device_info: QBluetoothDeviceInfo): + self.device_list.append(device_info) + self.device_discovered.emit(device_info) + + @Slot() + def _on_scan_finished(self): + self.scan_finished.emit() + + def connect(self, device_name_or_address: str, slot) -> bool: + print(device_name_or_address) + settings = QSettings() + settings.beginGroup("interface") + settings.setValue("type", "bluetooth") + settings.setValue("addr", device_name_or_address) + settings.endGroup() + + if self.application_controller.attempt_connection(): + slot(self.application_controller) diff --git a/src/meshcore_gui/wizard/companion/mc_serial.py b/src/meshcore_gui/wizard/companion/mc_serial.py new file mode 100644 index 0000000..97894fa --- /dev/null +++ b/src/meshcore_gui/wizard/companion/mc_serial.py @@ -0,0 +1,39 @@ +from PySide6.QtSerialPort import QSerialPortInfo +from PySide6.QtCore import QSettings + + +class SerialConnection: + """ + Serial connection class using PySide6 QtSerialPort. + Only scans available serial ports on the host system. + """ + + def __init__(self, application_controller): + self.application_controller = application_controller + self.device_list = [] + self.connected_port = None + self.device_info = None + + def scan_devices(self) -> list[str]: + """ + Scan beschikbare seriële poorten en retourneer een lijst van naamstrings. + """ + self.device_list = QSerialPortInfo.availablePorts() + # Return human-readable strings, bijv. "COM3 - USB Serial" + devices = [] + for port in self.device_list: + name = port.systemLocation() # COM3 or /dev/ttyUSB0 + desc = port.description() # bv. "USB Serial" + devices.append(f"{name} - {desc}") + return devices + + def connect(self, device_string: str, slot) -> bool: + settings = QSettings() + settings.beginGroup("interface") + settings.setValue("type", "serial") + settings.setValue("port", device_string.split(" - ")[0]) # TODO + settings.setValue("baudrate", 115200) + settings.endGroup() + + if self.application_controller.attempt_connection(): + slot(self.application_controller) diff --git a/src/meshcore_gui/wizard/wizard_companion.py b/src/meshcore_gui/wizard/wizard_companion.py new file mode 100644 index 0000000..b85c3de --- /dev/null +++ b/src/meshcore_gui/wizard/wizard_companion.py @@ -0,0 +1,44 @@ +from PySide6.QtWidgets import QApplication, QWizard + +from PySide6.QtCore import Signal + +from .companion.connection import ConnectionTypePage +from .companion.deviceselection import DeviceSelectionPage +from .companion.devicestatus import DeviceStatusPage + + +# ======================== +# Wizard +# ======================== +class CompanionWizard(QWizard): + completed = Signal(bool) + + def accept(self): + self.completed.emit(True) + super().accept() + + def reject(self): + self.completed.emit(False) + super().reject() + + def __init__(self, application_controller): + super().__init__() + self.application_controller = application_controller + self.addPage(ConnectionTypePage()) + self.addPage(DeviceSelectionPage(self)) + self.addPage(DeviceStatusPage(self)) + self.setWindowTitle("Companion Wizard") + + +# ======================== +# Main +# ======================== +if __name__ == "__main__": + import sys + + app = QApplication(sys.argv) + + wizard = CompanionWizard() + wizard.show() + + sys.exit(app.exec())