diff --git a/.github/workflows/pre_release.yaml b/.github/workflows/pre_release.yaml index e18b9ff0..6eee8a77 100644 --- a/.github/workflows/pre_release.yaml +++ b/.github/workflows/pre_release.yaml @@ -55,9 +55,6 @@ jobs: - name: Download firmware run: ./dev.sh make firmware - - name: Build with Basic firmware - run: ./dev.sh make build PROFILE=basic OUTPUT_FILE=U1_basic_${{ env.GIT_VERSION }}_upgrade.bin - - name: Build with Extended Fluidd firmware run: ./dev.sh make build PROFILE=extended OUTPUT_FILE=U1_extended_${{ env.GIT_VERSION }}_upgrade.bin diff --git a/.github/workflows/pull_request.yaml b/.github/workflows/pull_request.yaml index 9f60ac8e..f79d8179 100644 --- a/.github/workflows/pull_request.yaml +++ b/.github/workflows/pull_request.yaml @@ -94,33 +94,17 @@ jobs: - name: Download firmware run: ./dev.sh make firmware - - name: Build with Basic firmware - run: ./dev.sh make build PROFILE=basic OUTPUT_FILE=U1_basic_${{ env.GIT_VERSION }}_upgrade.bin - - name: Build with Extended Fluidd firmware run: ./dev.sh make build PROFILE=extended OUTPUT_FILE=U1_extended_${{ env.GIT_VERSION }}_upgrade.bin - - name: Build DEVEL version of Basic firmware - run: ./dev.sh make build PROFILE=basic-devel OUTPUT_FILE=U1_basic_${{ env.GIT_VERSION }}_devel.bin - - name: Build DEVEL version of Extended Fluidd firmware run: ./dev.sh make build PROFILE=extended-devel OUTPUT_FILE=U1_extended_${{ env.GIT_VERSION }}_devel.bin - - uses: actions/upload-artifact@v4 - with: - name: basic-build - path: U1_basic_*_upgrade.bin - - uses: actions/upload-artifact@v4 with: name: extended-build path: U1_extended_*_upgrade.bin - - uses: actions/upload-artifact@v4 - with: - name: basic-devel-build - path: U1_basic_*_devel.bin - - uses: actions/upload-artifact@v4 with: name: extended-devel-build @@ -137,9 +121,7 @@ jobs: echo "${{ env.GIT_VERSION }}" > pr-info/version echo "${{ env.JOB_START }}" > pr-info/job_start echo "$(date +%s)" > pr-info/job_end - echo basic-build >> pr-info/artifacts echo extended-build >> pr-info/artifacts - echo basic-devel-build >> pr-info/artifacts echo extended-devel-build >> pr-info/artifacts - name: Upload PR info diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a6c1bbba..db60da54 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,8 +2,9 @@ ## License Status -This project is free to use for personal usage. Individual components may have -their own specific licenses as indicated in their respective directories. +The main project is licensed under the GNU General Public License v3.0 +(GPL-3.0). Individual components may have their own specific licenses as +indicated in their respective directories. ## Contributor Agreement @@ -13,13 +14,12 @@ By contributing to this project, you agree to the following terms: modifications, or additions you contribute to this project. 2. **License Compatibility**: You understand that contributions to the main - project will be covered under the personal use license, while contributions - to specific components (such as tools/upfile) will be covered under their - respective licenses. + project will be covered under GPLv3, while contributions to specific + components (such as tools/upfile) will be covered under their respective + licenses. 3. **Permission to Use**: You grant permission to distribute, modify, and use - your contributions under the project's license terms, including the personal - use restriction for the main project. + your contributions under the project's applicable license terms. 4. **Original Work**: You certify that your contributions are your original work or that you have the right to submit them under these terms. diff --git a/HEROES.md b/HEROES.md new file mode 100644 index 00000000..77a6173f --- /dev/null +++ b/HEROES.md @@ -0,0 +1,81 @@ +# Heroes + +This file recognizes contributors who made significant contributions to each release. +Add your Ko-Fi or Buy Me a Coffee link next to your name by opening a PR. + +--- + +## Support the Heroes + +You can thank them here: + +| GitHub | Discord | Contributions | Support | +|---|---|---|---| +| [@horzadome](https://github.com/horzadome) | `@horzadome` | Timelapse recovery tool, remote screen PWA, monitoring, WLAN powersave | [![Ko-Fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/horzadome) | +| [@QuinnDamerell](https://github.com/QuinnDamerell) | | OctoEverywhere cloud remote access | | +| [@Argolein](https://github.com/Argolein) | `@Argolein` | TMC motor driver optimizations and Klipper patches | | +| [@mcristina422](https://github.com/mcristina422) | | Tailscale VPN remote access | | +| [@MaxKaenner](https://github.com/MaxKaenner) | | Filament auto-replenish bug fix | | +| [@justinh-rahb](https://github.com/justinh-rahb) | `@wildtang3nt` | V4L2 camera controls and Mainsail Remote Screen support | [![Buy Me A Coffee](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://buymeacoffee.com/wildtang3nt) | +| [@suchmememanyskill](https://github.com/suchmememanyskill) | `@Sims` | OpenRFID | [![Ko-Fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/suchmememanyskill) | +| [@morgendagen](https://github.com/morgendagen) | | OpenSpool `subtype` field for material specification | | + +--- + +## v1.2.0-paxx12-14 + +| Contributor | Contribution | PR | +|---|---|---| +| [@suchmememanyskill](https://github.com/suchmememanyskill) | OpenRFID filament-detection service | [#306](https://github.com/paxx12/SnapmakerU1-Extended-Firmware/pull/306) | + +--- + +## v1.1.1-paxx12-13 + +| Contributor | Contribution | PR | +|---|---|---| +| [@QuinnDamerell](https://github.com/QuinnDamerell) | OctoEverywhere cloud remote access, `fake-service` cross-compile fix, OctoEverywhere updates | [#244](https://github.com/paxx12/SnapmakerU1-Extended-Firmware/pull/244), [#220](https://github.com/paxx12/SnapmakerU1-Extended-Firmware/pull/220), [#286](https://github.com/paxx12/SnapmakerU1-Extended-Firmware/pull/286), [#297](https://github.com/paxx12/SnapmakerU1-Extended-Firmware/pull/297) | +| [@Argolein](https://github.com/Argolein) | TMC motor driver optimizations and Klipper patches | [#227](https://github.com/paxx12/SnapmakerU1-Extended-Firmware/pull/227) | + +--- + +## v1.1.0-paxx12-12 + +| Contributor | Contribution | PR | +|---|---|---| +| [@mcristina422](https://github.com/mcristina422) | Initial Tailscale VPN remote access support | [#188](https://github.com/paxx12/SnapmakerU1-Extended-Firmware/pull/188) | +| [@MaxKaenner](https://github.com/MaxKaenner) | Found and reported filament auto-replenish bug fix | [#165](https://github.com/paxx12/SnapmakerU1-Extended-Firmware/pull/165) | + +--- + +## v1.0.0-paxx12-11 + +| Contributor | Contribution | PR | +|---|---|---| +| [@justinh-rahb](https://github.com/justinh-rahb) | V4L2 camera controls with web interface and settings persistence, Mainsail 2.17.0 update | [#131](https://github.com/paxx12/SnapmakerU1-Extended-Firmware/pull/131) | +| [@suchmememanyskill](https://github.com/suchmememanyskill) | Double buffering support in `fb-http-server.py` | | + +--- + +## v1.0.0-paxx12-10 + +| Contributor | Contribution | PR | +|---|---|---| +| [@horzadome](https://github.com/horzadome) | Timelapse recovery tool, initial monitoring support | [#97](https://github.com/paxx12/SnapmakerU1-Extended-Firmware/pull/97) | + +--- + +## v0.9.4-paxx12-2 + +| Contributor | Contribution | PR | +|---|---|---| +| [@horzadome](https://github.com/horzadome) | Remote screen access with PWA support, `curl` addition | [#56](https://github.com/paxx12/SnapmakerU1-Extended-Firmware/pull/56) | +| [@morgendagen](https://github.com/morgendagen) | Non-standard OpenSpool `subtype` field for material specification | [#70](https://github.com/paxx12/SnapmakerU1-Extended-Firmware/pull/70) | + +--- + +## v0.9.4-paxx12-1 + +| Contributor | Contribution | PR | +|---|---|---| +| [@horzadome](https://github.com/horzadome) | WLAN powersave watcher, IPv6 disable option | [#48](https://github.com/paxx12/SnapmakerU1-Extended-Firmware/pull/48), [#47](https://github.com/paxx12/SnapmakerU1-Extended-Firmware/pull/47) | diff --git a/LICENSE b/LICENSE index 1c9a6a1c..f288702d 100644 --- a/LICENSE +++ b/LICENSE @@ -1,9 +1,674 @@ -LICENSE + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 -This project is free to use for personal usage. + 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. -Individual components may have their own specific licenses. Please refer to the -LICENSE files in their respective directories for details. + Preamble -By contributing to this project, you acknowledge and agree to the terms outlined -in the CONTRIBUTING.md file. + 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/Makefile b/Makefile index 7ca6ec7f..1866ca62 100644 --- a/Makefile +++ b/Makefile @@ -32,9 +32,15 @@ endif .PHONY: build build: $(OUTPUT_FILE) +EXTRACT_DIR := tmp/extracted + .PHONY: extract extract: firmware/$(FIRMWARE_FILE) tools - ./scripts/extract_squashfs.sh $< tmp/extracted + ./scripts/extract_squashfs.sh $< $(EXTRACT_DIR) + +.PHONY: overlays +overlays: + @echo $(OVERLAYS) .PHONY: profiles profiles: diff --git a/README.md b/README.md index 12c377a6..297c53fc 100644 --- a/README.md +++ b/README.md @@ -62,12 +62,21 @@ If you find this project useful and would like to support its development: * US store: [https://snapmaker-us.myshopify.com?ref=paxx12](https://snapmaker-us.myshopify.com?ref=paxx12) * Global store: [https://test-snapmaker.myshopify.com?ref=paxx12](https://test-snapmaker.myshopify.com?ref=paxx12) +🖨️ **Buy a Snapmaker Printer from Official Store** - use discount code `PAXX12CUSTOM` to get $20 off Snapmaker U1 printer + + * EU store: [https://snapmaker-eu.myshopify.com?ref=paxx12](https://snapmaker-eu.myshopify.com?ref=paxx12) + * US store: [https://snapmaker-us.myshopify.com?ref=paxx12](https://snapmaker-us.myshopify.com?ref=paxx12) + * Global store: [https://test-snapmaker.myshopify.com?ref=paxx12](https://test-snapmaker.myshopify.com?ref=paxx12) + ## Contributing See [CONTRIBUTING.md](CONTRIBUTING.md) for information about contributing to this project. +See [HEROES.md](HEROES.md) for contributors who made significant contributions to each release. + ## License -This project is free to use for personal usage. See [LICENSE](LICENSE) for details. +The main project is licensed under the GNU General Public License v3.0 +(GPL-3.0). See [LICENSE](LICENSE) for details. For licensing information about individual tools and dependencies, see their respective directories. diff --git a/RELEASE.md b/RELEASE.md index 056dceb2..bc636066 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -12,6 +12,8 @@ - TBD +See [HEROES.md](HEROES.md) for all-time contributors. + ## Install For detailed installation instructions, see the [Installation Guide](docs/install.md). @@ -48,3 +50,9 @@ If you find this project useful and would like to support its development, you c * EU store: [https://snapmaker-eu.myshopify.com?ref=paxx12](https://snapmaker-eu.myshopify.com?ref=paxx12) * US store: [https://snapmaker-us.myshopify.com?ref=paxx12](https://snapmaker-us.myshopify.com?ref=paxx12) * Global store: [https://test-snapmaker.myshopify.com?ref=paxx12](https://test-snapmaker.myshopify.com?ref=paxx12) + +🖨️ **Buy a Snapmaker Printer from Official Store** - use discount code `PAXX12CUSTOM` to get $20 off Snapmaker U1 printer + + * EU store: [https://snapmaker-eu.myshopify.com?ref=paxx12](https://snapmaker-eu.myshopify.com?ref=paxx12) + * US store: [https://snapmaker-us.myshopify.com?ref=paxx12](https://snapmaker-us.myshopify.com?ref=paxx12) + * Global store: [https://test-snapmaker.myshopify.com?ref=paxx12](https://test-snapmaker.myshopify.com?ref=paxx12) diff --git a/docs/camera_support.md b/docs/camera_support.md index 84d78430..e28d690b 100644 --- a/docs/camera_support.md +++ b/docs/camera_support.md @@ -4,7 +4,6 @@ title: Camera Support # Camera Support -**Available in: Extended firmware only** The extended firmware includes hardware-accelerated camera support with WebRTC streaming. diff --git a/docs/cloud.md b/docs/cloud.md index 6d35e880..b06cf460 100644 --- a/docs/cloud.md +++ b/docs/cloud.md @@ -4,7 +4,6 @@ title: Cloud Remote Access (Experimental) # Cloud Remote Access (Experimental) -**Available in: Extended firmware only** Control your printer remotely using cloud-based remote access providers. diff --git a/docs/data_persistence.md b/docs/data_persistence.md index 5e6f9967..5161d2a8 100644 --- a/docs/data_persistence.md +++ b/docs/data_persistence.md @@ -4,8 +4,6 @@ title: Data Persistence # Data Persistence -**Available in: Basic and Extended firmware** - By default, Snapmaker firmware resets all system changes on reboot for stability. ## Enable System Persistence diff --git a/docs/design/filament_detect.md b/docs/design/filament_detect.md new file mode 100644 index 00000000..869ec8de --- /dev/null +++ b/docs/design/filament_detect.md @@ -0,0 +1,278 @@ +--- +title: External RFID Support +--- + +# External RFID Support + +This document defines the external RFID integration contract for Snapmaker U1 Extended Firmware. +For build and overlay workflow context, see [Building from Source](../development.md). + +## `filament_detect` Fields + +The `filament_detect` object holds per-channel filament state in `FILAMENT_INFO_STRUCT`. The same +field names are: + +- returned by `GET /printer/objects/query?filament_detect` at `result.status.filament_detect.info[channel]` +- accepted by `POST /printer/filament_detect/set` in the `info` object (writable subset; unknown keys rejected) + +Writable fields: + +| Field | Type | Accepted values / format | Notes | +|---|---|---|---| +| `VENDOR` | `string` | Any string | | +| `MAIN_TYPE` | `string` | `PLA`, `PETG`, `ABS`, `TPU`, `PVA` | Other values accepted but not RFID-protocol-mapped | +| `SUB_TYPE` | `string` | `Basic`, `Matte`, `SnapSpeed`, `Silk`, `Support`, `HF`, `95A`, `95A HF` | Other values accepted but not RFID-protocol-mapped | +| `RGB_1` | `int` | Integer RGB value | | +| `ALPHA` | `int` | Integer 0..255 | | +| `HOTEND_MIN_TEMP` | `int` | Integer | | +| `HOTEND_MAX_TEMP` | `int` | Integer | | +| `BED_TEMP` | `int` | Integer | | +| `CARD_UID` | `list[int]` | Array of byte ints | | +| `SKU` | `int` | Integer | | + +Read-only fields (returned by query, not accepted by `set`): + +| Field | Notes | +|---|---| +| `ARGB_COLOR` | Derived: `(ALPHA << 24) \| RGB_1` | +| `OFFICIAL` | `true` when `info` is non-empty (set by firmware) | +| `MANUFACTURER` | | +| `VERSION` | | +| `TRAY` | | +| `COLOR_NUMS` | | +| `RGB_2..RGB_5` | | +| `DIAMETER` | | +| `WEIGHT` | | +| `LENGTH` | | +| `DRYING_TEMP` | | +| `DRYING_TIME` | | +| `BED_TYPE` | | +| `FIRST_LAYER_TEMP` | | +| `OTHER_LAYER_TEMP` | | +| `MF_DATE` | | +| `RSA_KEY_VERSION` | | + +## API Contract: `filament_detect/set` + +Endpoint: + +- `POST /printer/filament_detect/set` + +Request shape: + +```json +{ + "channel": 0, + "info": { + "VENDOR": "Generic", + "MAIN_TYPE": "PLA", + "SUB_TYPE": "Basic", + "RGB_1": 16737792, + "ALPHA": 255, + "HOTEND_MIN_TEMP": 200, + "HOTEND_MAX_TEMP": 220, + "BED_TEMP": 55, + "CARD_UID": [161, 178, 195, 212], + "SKU": 12345 + } +} +``` + +| Field | Required | Type | Accepted values | +|---|---|---|---| +| `channel` | Yes | `int` | `0..3` | +| `info` | No | `object` | If missing/empty, treated as clear/reset | + +Response: + +- Success: `{"state": "success"}` +- Error: `{"state": "error", "message": "..."}` + +## OpenSpool U1 Extended Format Input + +This firmware uses an OpenSpool variant named **OpenSpool U1 Extended Format**. + +Minimum payload: + +```json +{ + "protocol": "openspool", + "type": "PLA", + "color_hex": "#FF6600" +} +``` + +Extended payload: + +```json +{ + "protocol": "openspool", + "version": "1.0", + "brand": "Generic", + "type": "PLA", + "subtype": "Basic", + "color_hex": "#FF6600", + "additional_color_hexes": ["00FF00"], + "alpha": 255, + "min_temp": 200, + "max_temp": 220, + "bed_min_temp": 55, + "bed_max_temp": 60, + "diameter": 1.75, + "weight": 1000 +} +``` + +OpenSpool U1 Extended mapping profile: + +| OpenSpool field | `filament_detect/set.info` | `print_task_config` target | Rule | +|---|---|---|---| +| `brand` | `VENDOR` | `filament_vendor[channel]` | string passthrough | +| `type` | `MAIN_TYPE` | `filament_type[channel]` | recommended uppercase | +| `subtype` | `SUB_TYPE` | `filament_sub_type[channel]` | string passthrough | +| `color_hex` | `RGB_1` | `filament_color_rgba[channel]` | normalize to `RRGGBB`, convert to int; alpha appended later | +| `alpha` | `ALPHA` | `filament_color_rgba[channel]` | int passthrough; combined with `RGB_1` as `RRGGBBAA` | +| `min_temp` | `HOTEND_MIN_TEMP` | `N/A` | stored in `filament_detect` only | +| `max_temp` | `HOTEND_MAX_TEMP` | `N/A` | stored in `filament_detect` only | +| `bed_min_temp`/`bed_max_temp` | `BED_TEMP` | `N/A` | collapsed to single bed temp | +| `protocol` | `N/A` | `N/A` | parser validation only | +| `version` | `N/A` | `N/A` | no endpoint field | +| `additional_color_hexes` | `N/A` | `N/A` | no endpoint field; parser-only path supports extra colors | +| `diameter` | `N/A` | `N/A` | no endpoint field | +| `weight` | `N/A` | `N/A` | no endpoint field | + +### Example + +Source OpenSpool U1 Extended payload: + +```json +{ + "protocol": "openspool", + "version": "1.0", + "brand": "Generic", + "type": "PLA", + "subtype": "Basic", + "color_hex": "#3366CC", + "alpha": 128, + "min_temp": 205, + "max_temp": 225, + "bed_min_temp": 55, + "bed_max_temp": 60 +} +``` + +Call 1 (external bridge/client transformation and write): + +```bash +curl -s http:///printer/filament_detect/set \ + -H 'Content-Type: application/json' \ + -d '{ + "channel": 0, + "info": { + "VENDOR": "Generic", + "MAIN_TYPE": "PLA", + "SUB_TYPE": "Basic", + "RGB_1": 3368652, + "ALPHA": 128, + "HOTEND_MIN_TEMP": 205, + "HOTEND_MAX_TEMP": 225, + "BED_TEMP": 55 + } + }' +``` + +Call 1 response: + +```json +{ + "state": "success" +} +``` + +Call 2 (read `filament_detect`): + +```bash +curl -s 'http:///printer/objects/query?filament_detect' +``` + +Call 2 response (relevant subset): + +```json +{ + "result": { + "status": { + "filament_detect": { + "info": [ + { + "VENDOR": "Generic", + "MAIN_TYPE": "PLA", + "SUB_TYPE": "Basic", + "RGB_1": 3368652, + "ALPHA": 128, + "ARGB_COLOR": 2150852300, + "HOTEND_MIN_TEMP": 205, + "HOTEND_MAX_TEMP": 225, + "BED_TEMP": 55, + "OFFICIAL": true + } + ] + } + } + } +} +``` + +Call 3 (read `print_task_config`): + +```bash +curl -s 'http:///printer/objects/query?print_task_config' +``` + +Call 3 response (relevant subset): + +```json +{ + "result": { + "status": { + "print_task_config": { + "filament_vendor": ["Generic"], + "filament_type": ["PLA"], + "filament_sub_type": ["Basic"], + "filament_color_rgba": ["3366CC80"], + "filament_official": [true] + } + } + } +} +``` + +Transformation trace for this example: + +| Source | Transformed value | Target field | +|---|---|---| +| `brand = "Generic"` | `VENDOR = "Generic"` | `filament_detect.info[0].VENDOR` | +| `type = "PLA"` | `MAIN_TYPE = "PLA"` | `filament_detect.info[0].MAIN_TYPE` | +| `subtype = "Basic"` | `SUB_TYPE = "Basic"` | `filament_detect.info[0].SUB_TYPE` | +| `color_hex = "#3366CC"` | `RGB_1 = 3368652` | `filament_detect.info[0].RGB_1 = 3368652` | +| `alpha = 128` | `ALPHA = 128` | `filament_detect.info[0].ALPHA = 128` | +| derived | `ARGB_COLOR = (0x80 << 24) \| 0x3366CC` | `filament_detect.info[0].ARGB_COLOR = 2150852300` | +| `min_temp = 205` | `HOTEND_MIN_TEMP = 205` | `filament_detect.info[0].HOTEND_MIN_TEMP` | +| `max_temp = 225` | `HOTEND_MAX_TEMP = 225` | `filament_detect.info[0].HOTEND_MAX_TEMP` | +| `bed_min_temp = 55`, `bed_max_temp = 60` | `BED_TEMP = 55` | `filament_detect.info[0].BED_TEMP` | +| `OFFICIAL` rule | non-empty `info` | `filament_detect.info[0].OFFICIAL = true` | +| `RGB_1 + ALPHA` | `3366CC80` | `print_task_config.filament_color_rgba[0]` | +| mirrored identity | `Generic PLA Basic` | `print_task_config.filament_vendor/type/sub_type[0]` | + +## References + +Repository overlays: + +- `overlays/firmware-extended/13-rfid-support/root/home/lava/klipper/klippy/extras/filament_protocol_ndef.py` +- `overlays/firmware-extended/13-rfid-support/patches/02-add-ndef-protocol.patch` +- `overlays/firmware-extended/13-rfid-support/patches/05-add-filament-detect-set-endpoint.patch` + +Klipper source code: + +- `/home/lava/lava/klipper/klippy/extras/filament_detect.py` +- `/home/lava/lava/klipper/klippy/extras/filament_protocol.py` +- `/home/lava/lava/klipper/klippy/extras/print_task_config.py` diff --git a/docs/development.md b/docs/development.md index 3d2e91e1..29b33930 100644 --- a/docs/development.md +++ b/docs/development.md @@ -15,11 +15,12 @@ The custom firmware uses an overlay system to modify the base Snapmaker firmware Each overlay is self-contained and numbered to control application order. This modular approach makes it easy to: - Enable/disable features by including/excluding overlays -- Maintain different firmware profiles (basic vs extended) - Add custom modifications without conflicts For external third-party components, see [Third-Party Integrations](design/third_party.md). +For external RFID API and mapping details, see [External RFID Support](design/filament_detect.md). + ## Prerequisites - Docker installed on your system @@ -52,12 +53,6 @@ Build tools and download firmware: ./dev.sh make firmware ``` -Build basic firmware: - -```bash -./dev.sh make build PROFILE=basic OUTPUT_FILE=firmware/U1_basic.bin -``` - Build extended firmware: ```bash @@ -72,10 +67,7 @@ Open a shell in the development environment: ## Profiles -The build system supports two profiles: - -- `basic` - simple modifications not changing key components of the firmware -- `extended` - extensive modifications changing key components of the firmware +The build system supports the `extended` profile with extensive modifications to the firmware. ## Overlays @@ -83,15 +75,14 @@ Overlays are organized into categories based on their scope and build profile. E ### Overlay Categories -- **common/** - Core modifications applied to all firmware profiles (basic and extended) -- **firmware-basic/** - Modifications specific to the basic firmware profile +- **common/** - Core modifications applied to all firmware profiles - **firmware-extended/** - Modifications specific to the extended firmware profile - **devel/** - Development tools and utilities (only included with DEVEL=1 flag) - **staging/** - Disabled overlays kept for potential future use ## Build Options -- `basic-devel` or `extended-devel` - Add development overlays from `overlays/devel/` to the selected profile +- `extended-devel` - Add development overlays from `overlays/devel/` - e.g. `./dev.sh make build PROFILE=extended DEVEL=1` ### Devel Profile Features @@ -230,7 +221,7 @@ PASSWORD=mypassword ./dev.sh ./scripts/dev/upgrade-firmware.sh root@192.168.1.10 The project uses GitHub Actions for automated releases: 1. Changes pushed to `main` trigger a pre-release build -2. Both basic and extended firmwares are built +2. Extended firmware is built 3. Version is auto-incremented using `scripts/next_version.sh` 4. Release artifacts are published to GitHub Releases diff --git a/docs/firmware_config.md b/docs/firmware_config.md index cb0ca26b..d513d123 100644 --- a/docs/firmware_config.md +++ b/docs/firmware_config.md @@ -4,7 +4,6 @@ title: Firmware Configuration # Firmware Configuration -**Available in: Extended firmware** > **Note for users upgrading to v1.1.0:** The configuration file has been renamed from `extended.cfg` to `extended2.cfg`. During the first boot after upgrading a new `extended2.cfg` will be created with default settings. You will need to migrate your custom settings from `extended.cfg` to `extended2.cfg` manually or use `http://IP/firmware-config` @@ -51,6 +50,7 @@ Toggle settings directly from the web interface: | VPN Provider | None, Tailscale | Enable VPN remote access (Experimental) | | Cloud | None, OctoEverywhere | Enable Cloud-based remote access (Experimental) | | Tweaks | TMC AutoTune, TMC Reduced Current, Object Processing, AFC Stub | Experimental Klipper tweaks ([tweaks](tweaks.md)) | +| RFID Detection System | External, Snapmaker, OpenRFID, OpenRFID (force generic vendor) | Set how filament is detected ([rfid_support](rfid_support.md)) | Changes are applied immediately and relevant services are restarted. @@ -150,6 +150,16 @@ Note: Remote screen requires additional Moonraker configuration. See [Remote Scr **logs** - Camera service logging destination - `syslog` - Enable logging to `/var/log/messages` +#### [components] + +**rfid** - Filament tag detection system +- `snapmaker` (default) - Snapmaker's built-in RFID reader +- `external` - Disable built-in readers (useful for external readers) +- `openrfid` - Alternative detection with extended spool/tag support +- `openrfid-generic` - Same as openrfid, labels all spool vendors as generic + +See [Alternative Filament Detection](rfid_support.md#alternative-detection-systems) for setup instructions. + #### [remote_access] **ssh** - Enable SSH remote access via dropbear @@ -196,6 +206,10 @@ usb: none # Enable RTSP streaming server: true, false rtsp: false +[components] +# Filament tag detection system: external, snapmaker, openrfid, openrfid-generic +rfid: snapmaker + [remote_access] # Enable SSH access: true, false ssh: false diff --git a/docs/index.md b/docs/index.md index 483941a1..fcafac3f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -37,21 +37,9 @@ For developers who want to build custom firmware, see [Building from Source](dev Join the [Snapmaker Discord](https://discord.com/invite/snapmaker-official-1086575708903571536) and visit the **#u1-printer** channel to connect with other users using the custom firmware, share experiences, and get help. -## Firmware Variants +## Features -### Basic Firmware - -Stock firmware with SSH access and minimal debugging features: - -- [SSH Access](ssh_access.md) - Remote shell access with `root/snapmaker` and `lava/snapmaker` -- [Firmware Configuration](firmware_config.md) - Web-based system administration and firmware upgrades -- [Data Persistence](data_persistence.md) - Persistent storage configuration across firmware updates -- USB Ethernet Adapters - Hot-plug support with automatic DHCP configuration -- Fluidd web interface with basic camera support - -### Extended Firmware - -Heavily expanded firmware with extensive features and customization. Includes all basic features plus: +Heavily expanded firmware with extensive features and customization: **Web & Configuration:** @@ -71,6 +59,7 @@ Heavily expanded firmware with extensive features and customization. Includes al - [Klipper Tweaks](tweaks.md) - Experimental [TMC driver optimizations](tweaks.md#tmc-autotune), [reduced current](tweaks.md#tmc-reduced-current), and [object processing for adaptive mesh](tweaks.md#object-processing-for-adaptive-mesh) - [AFC-Lite Stub](afc-lite.md) - Experimental AFC UI compatibility layer for Fluidd/Mainsail - [RFID Filament Tag Support](rfid_support.md) - NTAG213/215/216 support for OpenSpool format +- [Alternative Filament Detection](rfid_support.md#alternative-detection-systems) - Alternative detection implementations with extended spool/tag support from Bambu, Creality, Anycubic, and others **Monitoring & Notifications:** @@ -84,6 +73,8 @@ Heavily expanded firmware with extensive features and customization. Includes al ## Support +See [Heroes](https://github.com/paxx12/SnapmakerU1/blob/main/HEROES.md) for contributors who made significant contributions to each release. + If you find this project useful and would like to support its development, you can: [![Buy Me A Coffee](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://buymeacoffee.com/paxx12) @@ -93,3 +84,9 @@ If you find this project useful and would like to support its development, you c * EU store: [https://snapmaker-eu.myshopify.com?ref=paxx12](https://snapmaker-eu.myshopify.com?ref=paxx12) * US store: [https://snapmaker-us.myshopify.com?ref=paxx12](https://snapmaker-us.myshopify.com?ref=paxx12) * Global store: [https://test-snapmaker.myshopify.com?ref=paxx12](https://test-snapmaker.myshopify.com?ref=paxx12) + +🖨️ **Buy a Snapmaker Printer from Official Store** - use discount code `PAXX12CUSTOM` to get $20 off Snapmaker U1 printer + + * EU store: [https://snapmaker-eu.myshopify.com?ref=paxx12](https://snapmaker-eu.myshopify.com?ref=paxx12) + * US store: [https://snapmaker-us.myshopify.com?ref=paxx12](https://snapmaker-us.myshopify.com?ref=paxx12) + * Global store: [https://test-snapmaker.myshopify.com?ref=paxx12](https://test-snapmaker.myshopify.com?ref=paxx12) diff --git a/docs/install.md b/docs/install.md index 061604b3..7c5bb183 100644 --- a/docs/install.md +++ b/docs/install.md @@ -19,9 +19,6 @@ This guide covers installing custom firmware on your Snapmaker U1 3D printer. 1. **Download Firmware** - Get the latest `.bin` file from the [Releases page](https://github.com/paxx12/SnapmakerU1/releases) - - Choose between Basic or Extended firmware: - - **Basic** - Stock firmware with SSH access and minimal debugging features - - **Extended** - Heavily expanded with hardware accelerated camera (WebRTC), RFID support, remote screen, monitoring, and extensive customization 2. **Prepare USB Drive** - Format a USB drive as FAT32 diff --git a/docs/klipper_includes.md b/docs/klipper_includes.md index 4814a4d4..1f4df2e5 100644 --- a/docs/klipper_includes.md +++ b/docs/klipper_includes.md @@ -4,7 +4,6 @@ title: Klipper and Moonraker Custom Includes # Klipper and Moonraker Custom Includes -**Available in: Extended firmware** Add custom Klipper and Moonraker configuration files through the Fluidd/Mainsail web interface. diff --git a/docs/monitoring.md b/docs/monitoring.md index 5888f4d3..acf59605 100644 --- a/docs/monitoring.md +++ b/docs/monitoring.md @@ -4,7 +4,6 @@ title: Monitoring # Monitoring -**Available in: Extended firmware** Expose printer metrics for integration with monitoring systems like Grafana, Home Assistant, or DataDog. Track print progress, temperatures, and operational data. diff --git a/docs/remote_screen.md b/docs/remote_screen.md index 22ff023c..937c65d7 100644 --- a/docs/remote_screen.md +++ b/docs/remote_screen.md @@ -4,7 +4,6 @@ title: Remote Screen Access # Remote Screen Access -**Available in: Extended firmware only** View and control your printer's touchscreen remotely from any web browser. diff --git a/docs/rfid_support.md b/docs/rfid_support.md index 2c5cf2e3..7d99b796 100644 --- a/docs/rfid_support.md +++ b/docs/rfid_support.md @@ -4,12 +4,11 @@ title: RFID Filament Tag Support # RFID Filament Tag Support -**Available in: All firmware (extended adds OpenSpool support)** The Snapmaker U1 automatically detects filament properties by reading RFID tags on spools. **Firmware Support:** -- **Original & Basic:** Mifare Classic 1K with Snapmaker proprietary format +- **Original:** Mifare Classic 1K with Snapmaker proprietary format - **Extended:** Adds NTAG215/216 support with OpenSpool format ## Supported Formats @@ -120,18 +119,66 @@ Use the **NFC Tools** app (iOS/Android) to inspect tags: **Compatible tag types:** NTAG213/215/216, Mifare Classic 1K **Note:** ISO15693 tags (OpenPrintTag) are not supported +## Alternative Detection Systems + + +The OpenRFID detection system is an alternative to Snapmaker's built-in filament tag detection, based on the [OpenRFID](https://github.com/suchmememanyskill/OpenRFID) project. It adds support for tagged spools from multiple manufacturers. + +To enable it, navigate to the [firmware-config](firmware_config.md) web interface, go to **Snapmaker Components > RFID Detection System**, and select **OpenRFID** or **OpenRFID (force generic vendor)**. + +- **OpenRFID** - Filament is identified by brand and type. Spools unrecognized by Snapmaker Orca are hidden in Snapmaker Orca. +- **OpenRFID (force generic vendor)** - Same as OpenRFID, but spools are labeled as Generic so they always appear in Snapmaker Orca. +- **External** - Disables the built-in readers entirely, useful for external readers such as [wasikuss/snapmaker-u1-remote-rfid-reader](https://github.com/wasikuss/snapmaker-u1-remote-rfid-reader). + +### Supported Tags + +| System | Enabled by default | Remarks | +|--------|-------------------|---------| +| Bambu | No | Requires additional configuration (see below) | +| Creality | No | Requires additional configuration (see below) | +| Anycubic | Yes | - | +| Snapmaker | Yes | - | +| Elegoo | No | Elegoo spools tagged with RFID work unreliably | +| [OpenSpool](https://openspool.io/) | Yes | - | +| TigerTag | Yes | Fully offline implementation | + +### Bambu / Creality Spool Configuration + +Bambu and Creality tagged spools require authentication keys. Edit the user configuration file to enable them: + +``` +/oem/printer_data/config/extended/openrfid_user.cfg +``` + +For **Bambu** spools: +```ini +[bambu_lab_tag_processor] +key = +``` + +For **Creality** spools: +```ini +[creality_tag_processor] +key = +encryption_key = +``` + +After editing, restart the printer. + ## Troubleshooting **Tag not detected:** - Ensure tag is NTAG213/215/216 or Mifare Classic 1K - Position tag within 1-3cm of reader antenna +- Ensure you place on tag on the side next to the U1 housing, which will depend on which side of the printer you load the spool +- If a vendor tag is present, for example Bambu Lab filament tags, this will usually interfere with reading a user-provided tag (you can cover up the vendor tag with foil tape) - Manually read tag: `FILAMENT_DT_UPDATE CHANNEL=` then `FILAMENT_DT_QUERY CHANNEL=` -- Check `klipper.log` for detection messages +- Check `klippy.log` for detection messages **OpenPrintTag tags don't work:** - Expected - OpenPrintTag uses ISO15693 which is not supported by U1 hardware - Use NTAG tags with OpenSpool format instead **NTAG tags only work on extended firmware:** -- Basic and original firmware only support Mifare Classic 1K with Snapmaker proprietary format +- Original firmware only supports Mifare Classic 1K with Snapmaker proprietary format - Extended firmware adds NTAG215/216 support diff --git a/docs/ssh_access.md b/docs/ssh_access.md index 3de9e785..a10012e4 100644 --- a/docs/ssh_access.md +++ b/docs/ssh_access.md @@ -4,27 +4,9 @@ title: SSH Access # SSH Access -**Available in: Basic and Extended firmware** +Starting with v1.2.0, SSH access is supported natively via the printer GUI. -The custom firmware enables SSH access to the Snapmaker U1 printer. - -## Configuration (Extended Firmware) - -In Extended firmware, SSH is disabled by default. - -### Using firmware-config Web UI (preferred) - -Navigate to the [firmware-config](firmware_config.md) web interface, go to the Remote Access section, and enable SSH Access. - -### Manual Setup (advanced) - -**Step 1:** Edit `/home/lava/printer_data/config/extended/extended2.cfg` to enable SSH: -```ini -[remote_access] -ssh: true -``` - -**Step 2:** Reboot the printer for changes to take effect. +Navigate to `Settings` > `Maintenance` > `Root Access` > Agree (scroll down to accept) > `Open`. ## Credentials diff --git a/docs/vpn.md b/docs/vpn.md index 47463987..6a3bc1ce 100644 --- a/docs/vpn.md +++ b/docs/vpn.md @@ -4,8 +4,6 @@ title: VPN Remote Access (Experimental) # VPN Remote Access (Experimental) -**Available in: Extended firmware only** - Control your printer remotely using a VPN provider. > **Note**: VPN providers are downloaded on-demand when enabled by the user. See [third-party integration design](design/third_party.md) for details on how external components are managed. diff --git a/overlays/common/02-enable-ssh/patches/01-enable-ssh.patch b/overlays/common/02-enable-ssh/patches/01-enable-ssh.patch index 03ecd798..e60eff08 100644 --- a/overlays/common/02-enable-ssh/patches/01-enable-ssh.patch +++ b/overlays/common/02-enable-ssh/patches/01-enable-ssh.patch @@ -1,11 +1,15 @@ --- a/etc/init.d/S50dropbear 2025-11-06 06:29:13.000000000 +0100 +++ b/etc/init.d/S50dropbear 2025-11-20 16:56:47.536854286 +0100 -@@ -3,7 +3,7 @@ +@@ -3,9 +3,9 @@ # Starts dropbear sshd. # --[ x"$(custom_misc vertype 2>/dev/null)" = x"dbg" ] || exit 0 -+# [ x"$(custom_misc vertype 2>/dev/null)" = x"dbg" ] || exit 0 +-if [ "$2" != "--force" ] ; then +- [ x"$(custom_misc vertype 2>/dev/null)" = x"dbg" ] || exit 0 +-fi ++# if [ "$2" != "--force" ] ; then ++# [ x"$(custom_misc vertype 2>/dev/null)" = x"dbg" ] || exit 0 ++# fi # Allow a few customizations from a config file test -r /etc/default/dropbear && . /etc/default/dropbear diff --git a/overlays/firmware-basic/01-enable-native-camera-fluidd/patches/04-enable-moonraker-camera.patch b/overlays/firmware-basic/01-enable-native-camera-fluidd/patches/04-enable-moonraker-camera.patch deleted file mode 100644 index 1567abf1..00000000 --- a/overlays/firmware-basic/01-enable-native-camera-fluidd/patches/04-enable-moonraker-camera.patch +++ /dev/null @@ -1,14 +0,0 @@ ---- a/home/lava/origin_printer_data/config/moonraker.conf -+++ b/home/lava/origin_printer_data/config/moonraker.conf -@@ -46,3 +46,11 @@ - mqtt_protocol: v5 - status_interval: 2 - default_qos: 1 -+ -+[webcam case] -+service: mjpegstreamer-adaptive -+stream_url: /server/files/camera/monitor.jpg -+snapshot_url: /server/files/camera/monitor.jpg -+target_fps: 2 -+target_fps_idle: 1 -+aspect_ratio: 16:9 diff --git a/overlays/firmware-basic/01-enable-native-camera-fluidd/root/etc/init.d/S99fluidd_camera b/overlays/firmware-basic/01-enable-native-camera-fluidd/root/etc/init.d/S99fluidd_camera deleted file mode 100755 index 1659bfc7..00000000 --- a/overlays/firmware-basic/01-enable-native-camera-fluidd/root/etc/init.d/S99fluidd_camera +++ /dev/null @@ -1,43 +0,0 @@ -#!/bin/sh -# -# Camera capture loop -# - -log() { - logger -p user.info -t "CAM[$$]" -- "$1" - echo "$1" -} - -case "$1" in - start) - log "Starting camera capture loop..." - - ln -s /tmp/.monitor.jpg /oem/printer_data/camera/monitor.jpg - - json_content='{"jsonrpc":"2.0","method":"camera.take_a_photo","params":{"reason":"debug","timestamp":false,"filepath":"/tmp/.monitor.jpg"},"id":1}' - - ( - while sleep 1; do - mosquitto_pub -t camera/request -m "$json_content" - done - ) & - echo $! >/var/run/camera-capture.pid - ;; - - stop) - log "Stopping camera capture loop..." - kill "$(cat /var/run/camera-capture.pid)" 2>/dev/null - rm -f /var/run/camera-capture.pid - ;; - - restart) - "$0" stop - sleep 1 - "$0" start - ;; - - *) - echo "Usage: $0 {start|stop|restart}" - exit 1 - ;; -esac diff --git a/overlays/firmware-extended/10-firmware-config/root/usr/local/bin/firmware-config.py b/overlays/firmware-extended/10-firmware-config/root/usr/local/bin/firmware-config.py index ca92ddec..a122dbce 100755 --- a/overlays/firmware-extended/10-firmware-config/root/usr/local/bin/firmware-config.py +++ b/overlays/firmware-extended/10-firmware-config/root/usr/local/bin/firmware-config.py @@ -305,6 +305,8 @@ def handle_get_settings(self): settings_list.append({ "id": setting_id, "label": config["label"], + "description": config.get("description"), + "help_url": config.get("help_url"), "current": current_value, "options": options_data }) @@ -389,6 +391,8 @@ def handle_get_actions(self): actions_list.append({ "id": action_id, "label": cfg.get("label", action_id), + "description": cfg.get("description"), + "help_url": cfg.get("help_url"), "confirm": cfg.get("confirm", False), "background": cfg.get("background", False), "download_file": cfg.get("download_file") diff --git a/overlays/firmware-extended/10-firmware-config/root/usr/local/share/firmware-config/extended/extended2.cfg b/overlays/firmware-extended/10-firmware-config/root/usr/local/share/firmware-config/extended/extended2.cfg index 7422778e..669f7eea 100644 --- a/overlays/firmware-extended/10-firmware-config/root/usr/local/share/firmware-config/extended/extended2.cfg +++ b/overlays/firmware-extended/10-firmware-config/root/usr/local/share/firmware-config/extended/extended2.cfg @@ -16,6 +16,9 @@ usb: none # Enable RTSP streaming server: true, false rtsp: false +[components] +rfid: external, snapmaker, openrfid, openrfid-generic + [remote_access] # Enable SSH access: true, false ssh: false diff --git a/overlays/firmware-extended/10-firmware-config/root/usr/local/share/firmware-config/functions/05_settings.yaml b/overlays/firmware-extended/10-firmware-config/root/usr/local/share/firmware-config/functions/05_settings.yaml new file mode 100644 index 00000000..7fc790f8 --- /dev/null +++ b/overlays/firmware-extended/10-firmware-config/root/usr/local/share/firmware-config/functions/05_settings.yaml @@ -0,0 +1,13 @@ +settings: + web: + label: Web + camera: + label: Camera + remote_access: + label: Remote Access + snapmaker_components: + label: Snapmaker Components + tweaks: + label: Tweaks + monitoring_debugging: + label: Monitoring & Debugging diff --git a/overlays/firmware-extended/10-firmware-config/root/usr/local/share/firmware-config/functions/06_actions.yaml b/overlays/firmware-extended/10-firmware-config/root/usr/local/share/firmware-config/functions/06_actions.yaml new file mode 100644 index 00000000..37ac6b1e --- /dev/null +++ b/overlays/firmware-extended/10-firmware-config/root/usr/local/share/firmware-config/functions/06_actions.yaml @@ -0,0 +1,9 @@ +actions: + troubleshooting: + label: Troubleshooting + recovery: + label: Recovery + services: + label: Services + system: + label: System diff --git a/overlays/firmware-extended/10-firmware-config/root/usr/local/share/firmware-config/functions/12_settings_firmware_config.yaml b/overlays/firmware-extended/10-firmware-config/root/usr/local/share/firmware-config/functions/12_settings_firmware_config.yaml index 16959482..54d6b854 100644 --- a/overlays/firmware-extended/10-firmware-config/root/usr/local/share/firmware-config/functions/12_settings_firmware_config.yaml +++ b/overlays/firmware-extended/10-firmware-config/root/usr/local/share/firmware-config/functions/12_settings_firmware_config.yaml @@ -1,9 +1,9 @@ settings: web: - label: Web items: firmware-config: label: Firmware Config + description: Enable or disable this web configuration interface. get_cmd: - /usr/local/bin/extended-config.py - get diff --git a/overlays/firmware-extended/10-firmware-config/root/usr/local/share/firmware-config/functions/15_settings_security.yaml b/overlays/firmware-extended/10-firmware-config/root/usr/local/share/firmware-config/functions/15_settings_security.yaml index d9abcda9..b2837f20 100644 --- a/overlays/firmware-extended/10-firmware-config/root/usr/local/share/firmware-config/functions/15_settings_security.yaml +++ b/overlays/firmware-extended/10-firmware-config/root/usr/local/share/firmware-config/functions/15_settings_security.yaml @@ -1,9 +1,9 @@ settings: remote_access: - label: Remote Access items: authorization: label: Web Authentication (Experimental) + description: Password-protect access to Fluidd and Firmware Config via Moonraker authentication. get_cmd: - bash - -c diff --git a/overlays/firmware-extended/10-firmware-config/root/usr/local/share/firmware-config/functions/20_actions_troubleshooting.yaml b/overlays/firmware-extended/10-firmware-config/root/usr/local/share/firmware-config/functions/20_actions_troubleshooting.yaml index 337f8977..a829ab22 100644 --- a/overlays/firmware-extended/10-firmware-config/root/usr/local/share/firmware-config/functions/20_actions_troubleshooting.yaml +++ b/overlays/firmware-extended/10-firmware-config/root/usr/local/share/firmware-config/functions/20_actions_troubleshooting.yaml @@ -1,9 +1,9 @@ actions: troubleshooting: - label: Troubleshooting items: show-status: label: Show MCUs Version + description: Display firmware version of all connected MCUs. cmd: - /home/lava/bin/systemUpgrade.sh - show-status @@ -12,7 +12,8 @@ actions: collect-logs: label: Collect System Logs - confirm: "Collecting system logs might take a few minutes. Do not close the window until done. Continue?" + description: Bundle and download a system log archive for troubleshooting. + confirm: "Collecting system logs might take a few minutes. These logs contain sensitive information like the serial number and Wi-Fi SSID, and should not be shared publicly. Continue?" cmd: - /home/lava/bin/sysinfoCollection.sh - "no" @@ -21,10 +22,10 @@ actions: download_file: /userdata/logs.tar.gz recovery: - label: Recovery items: reset-extended-to-defaults: label: Reset Extended to Defaults + description: Clear all extended settings and reboot to a clean state. confirm: "Reset all extended settings to defaults and reboot?" background: true cmd: @@ -38,6 +39,7 @@ actions: reset-to-backup-firmware: label: Reset Extended to Backup Firmware + description: Clear all extended settings, switch to the backup firmware slot, and reboot. confirm: "Reset all extended settings to defaults, switch to backup firmware and reboot?" background: true cmd: @@ -51,6 +53,7 @@ actions: switch-to-backup-firmware: label: Switch to Backup Firmware + description: Boot from the backup firmware slot on next reboot. confirm: "Switch to backup firmware and reboot?" background: true cmd: diff --git a/overlays/firmware-extended/10-firmware-config/root/usr/local/share/firmware-config/functions/21_actions_services.yaml b/overlays/firmware-extended/10-firmware-config/root/usr/local/share/firmware-config/functions/21_actions_services.yaml index 2f9fcd52..b90ceab8 100644 --- a/overlays/firmware-extended/10-firmware-config/root/usr/local/share/firmware-config/functions/21_actions_services.yaml +++ b/overlays/firmware-extended/10-firmware-config/root/usr/local/share/firmware-config/functions/21_actions_services.yaml @@ -1,9 +1,9 @@ actions: services: - label: Services items: restart-klipper: label: Restart Klipper + description: Restart the Klipper firmware service. confirm: true cmd: - /etc/init.d/S60klipper @@ -12,6 +12,7 @@ actions: restart-moonraker: label: Restart Moonraker + description: Restart the Moonraker API server. confirm: true cmd: - /etc/init.d/S61moonraker diff --git a/overlays/firmware-extended/10-firmware-config/root/usr/local/share/firmware-config/functions/22_actions_system.yaml b/overlays/firmware-extended/10-firmware-config/root/usr/local/share/firmware-config/functions/22_actions_system.yaml index 69fd3898..ebf0fee7 100644 --- a/overlays/firmware-extended/10-firmware-config/root/usr/local/share/firmware-config/functions/22_actions_system.yaml +++ b/overlays/firmware-extended/10-firmware-config/root/usr/local/share/firmware-config/functions/22_actions_system.yaml @@ -1,9 +1,9 @@ actions: system: - label: System items: reboot-system: label: Reboot System + description: Reboot the printer system. confirm: true cmd: - /sbin/reboot diff --git a/overlays/firmware-extended/10-firmware-config/root/usr/local/share/firmware-config/html/index.html b/overlays/firmware-extended/10-firmware-config/root/usr/local/share/firmware-config/html/index.html index dc39ef1f..d7093907 100644 --- a/overlays/firmware-extended/10-firmware-config/root/usr/local/share/firmware-config/html/index.html +++ b/overlays/firmware-extended/10-firmware-config/root/usr/local/share/firmware-config/html/index.html @@ -35,8 +35,12 @@ .info-value { font-family: monospace; font-size: 14px; word-break: break-all; } .row { display: flex; justify-content: space-between; align-items: center; padding: 12px; background: var(--item); border-radius: 6px; margin-bottom: 8px; cursor: pointer; transition: background 0.2s; } .row:hover { background: var(--hover); } - .row-label { color: #fff; font-size: 14px; font-weight: 500; flex: 1; } - .row select { background: var(--card); border: 1px solid #555; border-radius: 6px; padding: 8px 12px; color: var(--text); font-size: 13px; cursor: pointer; min-width: 150px; } + .row-label-wrap { flex: 1; } + .row-label { color: #fff; font-size: 14px; font-weight: 500; } + .row-desc { display: block; font-size: 12px; color: var(--muted); margin-top: 2px; } + .row-help { font-size: 12px; color: var(--accent); margin-left: 6px; vertical-align: middle; } + .row-help:hover { text-decoration: none; opacity: 0.8; } + .row select { align-self: flex-start; background: var(--card); border: 1px solid #555; border-radius: 6px; padding: 8px 12px; color: var(--text); font-size: 13px; cursor: pointer; min-width: 150px; max-width: 150px; } .row select:focus { outline: none; border-color: var(--accent); } .links-grid { display: grid; grid-template-columns: repeat(auto-fit, minmax(200px, 1fr)); gap: 12px; } .link-item { background: var(--item); padding: 12px 16px; border-radius: 6px; text-decoration: none; display: flex; align-items: center; gap: 10px; transition: background 0.2s; } @@ -274,7 +278,10 @@

Firmware Config ` ).join('')} @@ -305,8 +312,11 @@

Firmware Config