├── .gitignore ├── CAD ├── Belay_Alpha1_2024-10-04_Parasolid.7z └── Belay_Alpha1_2024-10-04_STEP.7z ├── Images ├── 5mm_and_6mm_collets.png ├── belay_demo_1.30_0.70.gif └── render.png ├── Kalico ├── kalico_config │ ├── LICENSE.txt │ ├── extruder_stepper │ │ └── belay_extruder_stepper.cfg │ └── trad_rack │ │ └── belay_trad_rack.cfg └── klippy_module │ ├── COPYING │ ├── belay.py │ └── install.sh ├── Klipper_Stuff ├── README.md └── klippy_module │ ├── COPYING │ └── belay.py ├── LICENSE.md ├── Print_Settings_and_File_Key.txt ├── README.md ├── STLs ├── README.md ├── [a]_slider_(5mm_collet)_x1_rev2.STL ├── [a]_slider_(6mm_collet)_x1_rev2.STL ├── [a]_slider_(ecas04)_x1_rev1.STL ├── cover_x1_rev2.STL ├── sensor_housing_(5mm_collet)_x1_rev2.STL ├── sensor_housing_(6mm_collet)_x1_rev2.STL └── sensor_housing_(ecas04)_x1_rev1.STL ├── docs ├── Quick_Start.md ├── README.md ├── images │ ├── add_cover.png │ ├── add_entry_clip.png │ ├── add_entry_collet.png │ ├── add_entry_tube.png │ ├── add_exit_collet.png │ ├── add_exit_tube_and_clip.png │ ├── add_microswitch.png │ ├── add_slider.png │ ├── pull_entry_tube.png │ ├── wire_crimp_example.jpg │ ├── wiring_example.jpg │ └── wiring_example_2.jpg └── kalico │ ├── Config_Reference.md │ ├── G-Codes.md │ └── Status_Reference.md └── eDrawings └── Belay Alpha 2023-12-14.EASM /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | *backups* 3 | -------------------------------------------------------------------------------- /CAD/Belay_Alpha1_2024-10-04_Parasolid.7z: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Annex-Engineering/Belay/af9f1eccc7b6b5463cac9f0f18a48ca3d337f846/CAD/Belay_Alpha1_2024-10-04_Parasolid.7z -------------------------------------------------------------------------------- /CAD/Belay_Alpha1_2024-10-04_STEP.7z: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Annex-Engineering/Belay/af9f1eccc7b6b5463cac9f0f18a48ca3d337f846/CAD/Belay_Alpha1_2024-10-04_STEP.7z -------------------------------------------------------------------------------- /Images/5mm_and_6mm_collets.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Annex-Engineering/Belay/af9f1eccc7b6b5463cac9f0f18a48ca3d337f846/Images/5mm_and_6mm_collets.png -------------------------------------------------------------------------------- /Images/belay_demo_1.30_0.70.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Annex-Engineering/Belay/af9f1eccc7b6b5463cac9f0f18a48ca3d337f846/Images/belay_demo_1.30_0.70.gif -------------------------------------------------------------------------------- /Images/render.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Annex-Engineering/Belay/af9f1eccc7b6b5463cac9f0f18a48ca3d337f846/Images/render.png -------------------------------------------------------------------------------- /Kalico/kalico_config/LICENSE.txt: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2023 ANNEX Engineering 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /Kalico/kalico_config/extruder_stepper/belay_extruder_stepper.cfg: -------------------------------------------------------------------------------- 1 | [belay my_belay] 2 | extruder_type: extruder_stepper 3 | extruder_stepper_name: my_extruder_stepper 4 | sensor_pin: ^PA0 5 | multiplier_high: 1.05 6 | multiplier_low: 0.95 7 | debug_level: 1 8 | 9 | [extruder_stepper my_extruder_stepper] 10 | extruder: extruder 11 | #step_pin: 12 | #dir_pin: 13 | #enable_pin: 14 | #microsteps: 15 | #rotation_distance: 16 | # The above commented-out parameters must be set. These should match 17 | # what you would use in the [extruder] section if you used this 18 | # extruder as your primary extruder. Other parameters such as 19 | # full_steps_per_rotation or gear_ratio may also be useful or 20 | # needed. 21 | # 22 | # See the "stepper" section in Kalico's Configuration Reference for 23 | # details on these parameters: 24 | # https://docs.kalico.gg/Config_Reference.html#stepper 25 | # 26 | # In addition, you may want to add a 27 | # [tmc2209 extruder_stepper my_extruder_stepper] section or similar: 28 | # https://docs.kalico.gg/TMC_Drivers.html -------------------------------------------------------------------------------- /Kalico/kalico_config/trad_rack/belay_trad_rack.cfg: -------------------------------------------------------------------------------- 1 | [belay my_belay] 2 | extruder_type: trad_rack 3 | sensor_pin: ^PA0 4 | multiplier_high: 1.05 5 | multiplier_low: 0.95 6 | debug_level: 1 7 | 8 | # Make sure sync_to_extruder is set to True in the [trad_rack] section -------------------------------------------------------------------------------- /Kalico/klippy_module/COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /Kalico/klippy_module/belay.py: -------------------------------------------------------------------------------- 1 | # Belay extruder-syncing sensor support 2 | # 3 | # Copyright (C) 2023-2024 Ryan Ghosh 4 | # 5 | # This file may be distributed under the terms of the GNU GPLv3 license. 6 | DIRECTION_UPDATE_INTERVAL = 0.1 7 | POSITION_TIME_DIFF = 0.3 8 | 9 | 10 | class Belay: 11 | def __init__(self, config): 12 | self.printer = config.get_printer() 13 | self.reactor = self.printer.get_reactor() 14 | 15 | # initial type-specific setup 16 | type_options = ["trad_rack", "extruder_stepper"] 17 | self.type = config.getchoice( 18 | "extruder_type", {t: t for t in type_options} 19 | ) 20 | if self.type == "trad_rack": 21 | enable_events = ["trad_rack:synced_to_extruder"] 22 | disable_events = ["trad_rack:unsyncing_from_extruder"] 23 | self.enable_initial = False 24 | elif self.type == "extruder_stepper": 25 | self.extruder_stepper_name = config.get("extruder_stepper_name") 26 | enable_events = [] 27 | disable_events = [] 28 | self.enable_initial = True 29 | 30 | # register event handlers 31 | self.printer.register_event_handler( 32 | "klippy:connect", self.handle_connect 33 | ) 34 | self.printer.register_event_handler("klippy:ready", self.handle_ready) 35 | for event in enable_events: 36 | self.printer.register_event_handler(event, self.handle_enable) 37 | for event in disable_events: 38 | self.printer.register_event_handler(event, self.handle_disable) 39 | 40 | # register button 41 | sensor_pin = config.get("sensor_pin") 42 | buttons = self.printer.load_object(config, "buttons") 43 | buttons.register_buttons([sensor_pin], self.sensor_callback) 44 | 45 | # read other values 46 | self.multiplier_high = config.getfloat( 47 | "multiplier_high", default=1.05, minval=1.0 48 | ) 49 | self.multiplier_low = config.getfloat( 50 | "multiplier_low", default=0.95, minval=0.0, maxval=1.0 51 | ) 52 | self.debug_level = config.getint( 53 | "debug_level", default=0.0, minval=0.0, maxval=2.0 54 | ) 55 | 56 | # other variables 57 | self.name = config.get_name().split()[1] 58 | self.enabled = False 59 | self.last_state = False 60 | self.last_direction = True 61 | self.set_multiplier = None 62 | self.enable_conditions = [lambda: not self.enabled] 63 | self.disable_conditions = [lambda: self.enabled] 64 | self.gcode = self.printer.lookup_object("gcode") 65 | self.toolhead = None 66 | self.update_direction_timer = self.reactor.register_timer( 67 | self.update_direction 68 | ) 69 | 70 | # register commands 71 | self.gcode.register_mux_command( 72 | "QUERY_BELAY", 73 | "BELAY", 74 | self.name, 75 | self.cmd_QUERY_BELAY, 76 | desc=self.cmd_QUERY_BELAY_help, 77 | ) 78 | self.gcode.register_mux_command( 79 | "BELAY_SET_MULTIPLIER", 80 | "BELAY", 81 | self.name, 82 | self.cmd_BELAY_SET_MULTIPLIER, 83 | desc=self.cmd_BELAY_SET_MULTIPLIER_help, 84 | ) 85 | 86 | # register extruder_stepper-only commands 87 | if self.type == "extruder_stepper": 88 | self.gcode.register_mux_command( 89 | "BELAY_SET_STEPPER", 90 | "BELAY", 91 | self.name, 92 | self.cmd_BELAY_SET_STEPPER, 93 | desc=self.cmd_BELAY_SET_STEPPER_help, 94 | ) 95 | 96 | def handle_connect(self): 97 | self.toolhead = self.printer.lookup_object("toolhead") 98 | 99 | # finish type-specific setup 100 | if self.type == "trad_rack": 101 | trad_rack = self.printer.lookup_object("trad_rack") 102 | self.set_multiplier = trad_rack.set_fil_driver_multiplier 103 | self.enable_conditions.append(trad_rack.is_fil_driver_synced) 104 | self.disable_conditions.append(trad_rack.is_fil_driver_synced) 105 | elif self.type == "extruder_stepper": 106 | self._set_extruder_stepper(self.extruder_stepper_name) 107 | 108 | def _set_extruder_stepper(self, extruder_stepper_name): 109 | printer_extruder_stepper = self.printer.lookup_object( 110 | "extruder_stepper {}".format(extruder_stepper_name) 111 | ) 112 | stepper = printer_extruder_stepper.extruder_stepper.stepper 113 | base_rotation_dist = stepper.get_rotation_distance()[0] 114 | self.set_multiplier = lambda m: stepper.set_rotation_distance( 115 | base_rotation_dist / m 116 | ) 117 | 118 | def handle_ready(self): 119 | if self.enable_initial: 120 | self.handle_enable() 121 | 122 | def handle_enable(self): 123 | for condition in self.enable_conditions: 124 | if not condition(): 125 | return 126 | self.enabled = True 127 | self.reactor.update_timer(self.update_direction_timer, self.reactor.NOW) 128 | self.update_multiplier() 129 | 130 | def handle_disable(self): 131 | for condition in self.disable_conditions: 132 | if not condition(): 133 | return 134 | self.reset_multiplier() 135 | self.reactor.update_timer( 136 | self.update_direction_timer, self.reactor.NEVER 137 | ) 138 | self.enabled = False 139 | 140 | def sensor_callback(self, eventtime, state): 141 | self.last_state = state 142 | if self.enabled: 143 | self.update_multiplier() 144 | 145 | def update_multiplier(self, print_msg=True): 146 | if self.last_state == self.last_direction: 147 | # compressed/forward or expanded/backward 148 | multiplier = self.multiplier_high 149 | else: 150 | # compressed/backward or expanded/forward 151 | multiplier = self.multiplier_low 152 | self.set_multiplier(multiplier) 153 | if (print_msg and self.debug_level >= 1) or self.debug_level >= 2: 154 | self.gcode.respond_info( 155 | "Set secondary extruder multiplier: %f" % multiplier 156 | ) 157 | 158 | def reset_multiplier(self): 159 | self.set_multiplier(1.0) 160 | if self.debug_level >= 1: 161 | self.gcode.respond_info("Reset secondary extruder multiplier") 162 | 163 | def update_direction(self, eventtime): 164 | mcu = self.printer.lookup_object("mcu") 165 | print_time = mcu.estimated_print_time(eventtime) 166 | extruder = self.toolhead.get_extruder() 167 | curr_pos = extruder.find_past_position(print_time) 168 | past_pos = extruder.find_past_position( 169 | max(0.0, print_time - POSITION_TIME_DIFF) 170 | ) 171 | prev_direction = self.last_direction 172 | self.last_direction = curr_pos >= past_pos 173 | if self.last_direction != prev_direction: 174 | if self.debug_level >= 2: 175 | self.gcode.respond_info( 176 | "New Belay sensor direction: %s" % self.last_direction 177 | ) 178 | self.update_multiplier(False) 179 | return eventtime + DIRECTION_UPDATE_INTERVAL 180 | 181 | cmd_QUERY_BELAY_help = "Report Belay sensor state" 182 | 183 | def cmd_QUERY_BELAY(self, gcmd): 184 | if self.last_state: 185 | state_info = "compressed" 186 | else: 187 | state_info = "expanded" 188 | self.gcode.respond_info("belay {}: {}".format(self.name, state_info)) 189 | 190 | cmd_BELAY_SET_MULTIPLIER_help = ( 191 | "Sets multiplier_high and/or multiplier_low. Does not persist across" 192 | " restarts." 193 | ) 194 | 195 | def cmd_BELAY_SET_MULTIPLIER(self, gcmd): 196 | self.multiplier_high = gcmd.get_float( 197 | "HIGH", self.multiplier_high, minval=1.0 198 | ) 199 | self.multiplier_low = gcmd.get_float( 200 | "LOW", self.multiplier_low, minval=0.0, maxval=1.0 201 | ) 202 | 203 | cmd_BELAY_SET_STEPPER_help = ( 204 | "Select the extruder_stepper object to be controlled by the Belay" 205 | ) 206 | 207 | def cmd_BELAY_SET_STEPPER(self, gcmd): 208 | self.handle_disable() 209 | self._set_extruder_stepper(gcmd.get("STEPPER")) 210 | self.handle_enable() 211 | 212 | def get_status(self, eventtime): 213 | return {"last_state": self.last_state, "enabled": self.enabled} 214 | 215 | 216 | def load_config_prefix(config): 217 | return Belay(config) 218 | -------------------------------------------------------------------------------- /Kalico/klippy_module/install.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | set -e 4 | 5 | branch=${1:-main} 6 | module_dir=Kalico/klippy_module 7 | script_dir=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd ) 8 | repo_source=https://github.com/Annex-Engineering/Belay.git 9 | repo_dir=belay_klippy_module 10 | 11 | if [[ "$script_dir" == *$module_dir ]]; then 12 | cd $script_dir 13 | git checkout $branch 14 | git pull 15 | else 16 | cd ~ 17 | git clone --filter=blob:none --no-checkout $repo_source $repo_dir 18 | cd $repo_dir 19 | git sparse-checkout set --cone 20 | git checkout $branch 21 | git sparse-checkout set $module_dir 22 | cd $module_dir 23 | fi 24 | 25 | find * -name '*.py' -exec ln -sf $PWD/{} ~/klipper/klippy/extras/{} \; 26 | -------------------------------------------------------------------------------- /Klipper_Stuff/README.md: -------------------------------------------------------------------------------- 1 | This folder is no longer in use; it is only being kept temporarily to 2 | avoid breaking existing installs of the belay klippy module. 3 | Please see the [Kalico folder](/Kalico/) instead. 4 | -------------------------------------------------------------------------------- /Klipper_Stuff/klippy_module/COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /Klipper_Stuff/klippy_module/belay.py: -------------------------------------------------------------------------------- 1 | # Belay extruder-syncing sensor support 2 | # 3 | # Copyright (C) 2023-2024 Ryan Ghosh 4 | # 5 | # This file may be distributed under the terms of the GNU GPLv3 license. 6 | DIRECTION_UPDATE_INTERVAL = 0.1 7 | POSITION_TIME_DIFF = 0.3 8 | 9 | 10 | class Belay: 11 | WARNING_MSG = ( 12 | "[belay]: belay.py has been moved to a different folder in" 13 | " the Belay repo. Please delete the ~/belay_klippy_module directory," 14 | ' then redo the steps here under "Klippy module ' 15 | ' installation" (including using curl to download the updated' 16 | " install script) to update your belay installation to use the new" 17 | " folder:" 18 | " https://github.com/Annex-Engineering/Belay/blob/main/docs/Quick_Start.md#klippy-module-installation" 19 | "\nThe old folder is being kept intact for now but will be deleted" 20 | " soon. After that happens, attempting to update belay through" 21 | " Moonraker may break the belay install." 22 | ) 23 | 24 | def __init__(self, config): 25 | self.printer = config.get_printer() 26 | self.reactor = self.printer.get_reactor() 27 | 28 | # warning to use belay.py from the new folder instead 29 | pconfig = self.printer.lookup_object("configfile") 30 | pconfig.runtime_warning(self.WARNING_MSG) 31 | 32 | # initial type-specific setup 33 | type_options = ["trad_rack", "extruder_stepper"] 34 | self.type = config.getchoice( 35 | "extruder_type", {t: t for t in type_options} 36 | ) 37 | if self.type == "trad_rack": 38 | enable_events = ["trad_rack:synced_to_extruder"] 39 | disable_events = ["trad_rack:unsyncing_from_extruder"] 40 | self.enable_initial = False 41 | elif self.type == "extruder_stepper": 42 | self.extruder_stepper_name = config.get("extruder_stepper_name") 43 | enable_events = [] 44 | disable_events = [] 45 | self.enable_initial = True 46 | 47 | # register event handlers 48 | self.printer.register_event_handler( 49 | "klippy:connect", self.handle_connect 50 | ) 51 | self.printer.register_event_handler("klippy:ready", self.handle_ready) 52 | for event in enable_events: 53 | self.printer.register_event_handler(event, self.handle_enable) 54 | for event in disable_events: 55 | self.printer.register_event_handler(event, self.handle_disable) 56 | 57 | # register button 58 | sensor_pin = config.get("sensor_pin") 59 | buttons = self.printer.load_object(config, "buttons") 60 | buttons.register_buttons([sensor_pin], self.sensor_callback) 61 | 62 | # read other values 63 | self.multiplier_high = config.getfloat( 64 | "multiplier_high", default=1.05, minval=1.0 65 | ) 66 | self.multiplier_low = config.getfloat( 67 | "multiplier_low", default=0.95, minval=0.0, maxval=1.0 68 | ) 69 | self.debug_level = config.getint( 70 | "debug_level", default=0.0, minval=0.0, maxval=2.0 71 | ) 72 | 73 | # other variables 74 | self.name = config.get_name().split()[1] 75 | self.enabled = False 76 | self.last_state = False 77 | self.last_direction = True 78 | self.set_multiplier = None 79 | self.enable_conditions = [lambda: not self.enabled] 80 | self.disable_conditions = [lambda: self.enabled] 81 | self.gcode = self.printer.lookup_object("gcode") 82 | self.toolhead = None 83 | self.update_direction_timer = self.reactor.register_timer( 84 | self.update_direction 85 | ) 86 | 87 | # register commands 88 | self.gcode.register_mux_command( 89 | "QUERY_BELAY", 90 | "BELAY", 91 | self.name, 92 | self.cmd_QUERY_BELAY, 93 | desc=self.cmd_QUERY_BELAY_help, 94 | ) 95 | self.gcode.register_mux_command( 96 | "BELAY_SET_MULTIPLIER", 97 | "BELAY", 98 | self.name, 99 | self.cmd_BELAY_SET_MULTIPLIER, 100 | desc=self.cmd_BELAY_SET_MULTIPLIER_help, 101 | ) 102 | 103 | # register extruder_stepper-only commands 104 | if self.type == "extruder_stepper": 105 | self.gcode.register_mux_command( 106 | "BELAY_SET_STEPPER", 107 | "BELAY", 108 | self.name, 109 | self.cmd_BELAY_SET_STEPPER, 110 | desc=self.cmd_BELAY_SET_STEPPER_help, 111 | ) 112 | 113 | def handle_connect(self): 114 | self.toolhead = self.printer.lookup_object("toolhead") 115 | 116 | # finish type-specific setup 117 | if self.type == "trad_rack": 118 | trad_rack = self.printer.lookup_object("trad_rack") 119 | self.set_multiplier = trad_rack.set_fil_driver_multiplier 120 | self.enable_conditions.append(trad_rack.is_fil_driver_synced) 121 | self.disable_conditions.append(trad_rack.is_fil_driver_synced) 122 | elif self.type == "extruder_stepper": 123 | self._set_extruder_stepper(self.extruder_stepper_name) 124 | 125 | def _set_extruder_stepper(self, extruder_stepper_name): 126 | printer_extruder_stepper = self.printer.lookup_object( 127 | "extruder_stepper {}".format(extruder_stepper_name) 128 | ) 129 | stepper = printer_extruder_stepper.extruder_stepper.stepper 130 | base_rotation_dist = stepper.get_rotation_distance()[0] 131 | self.set_multiplier = lambda m: stepper.set_rotation_distance( 132 | base_rotation_dist / m 133 | ) 134 | 135 | def handle_ready(self): 136 | if self.enable_initial: 137 | self.handle_enable() 138 | 139 | # warning to use belay.py from the new folder instead 140 | self.reactor.register_callback( 141 | lambda _: self.gcode.respond_info(self.WARNING_MSG), 142 | self.reactor.monotonic() + 1, 143 | ) 144 | 145 | def handle_enable(self): 146 | for condition in self.enable_conditions: 147 | if not condition(): 148 | return 149 | self.enabled = True 150 | self.reactor.update_timer(self.update_direction_timer, self.reactor.NOW) 151 | self.update_multiplier() 152 | 153 | def handle_disable(self): 154 | for condition in self.disable_conditions: 155 | if not condition(): 156 | return 157 | self.reset_multiplier() 158 | self.reactor.update_timer( 159 | self.update_direction_timer, self.reactor.NEVER 160 | ) 161 | self.enabled = False 162 | 163 | def sensor_callback(self, eventtime, state): 164 | self.last_state = state 165 | if self.enabled: 166 | self.update_multiplier() 167 | 168 | def update_multiplier(self, print_msg=True): 169 | if self.last_state == self.last_direction: 170 | # compressed/forward or expanded/backward 171 | multiplier = self.multiplier_high 172 | else: 173 | # compressed/backward or expanded/forward 174 | multiplier = self.multiplier_low 175 | self.set_multiplier(multiplier) 176 | if (print_msg and self.debug_level >= 1) or self.debug_level >= 2: 177 | self.gcode.respond_info( 178 | "Set secondary extruder multiplier: %f" % multiplier 179 | ) 180 | 181 | def reset_multiplier(self): 182 | self.set_multiplier(1.0) 183 | if self.debug_level >= 1: 184 | self.gcode.respond_info("Reset secondary extruder multiplier") 185 | 186 | def update_direction(self, eventtime): 187 | mcu = self.printer.lookup_object("mcu") 188 | print_time = mcu.estimated_print_time(eventtime) 189 | extruder = self.toolhead.get_extruder() 190 | curr_pos = extruder.find_past_position(print_time) 191 | past_pos = extruder.find_past_position( 192 | max(0.0, print_time - POSITION_TIME_DIFF) 193 | ) 194 | prev_direction = self.last_direction 195 | self.last_direction = curr_pos >= past_pos 196 | if self.last_direction != prev_direction: 197 | if self.debug_level >= 2: 198 | self.gcode.respond_info( 199 | "New Belay sensor direction: %s" % self.last_direction 200 | ) 201 | self.update_multiplier(False) 202 | return eventtime + DIRECTION_UPDATE_INTERVAL 203 | 204 | cmd_QUERY_BELAY_help = "Report Belay sensor state" 205 | 206 | def cmd_QUERY_BELAY(self, gcmd): 207 | if self.last_state: 208 | state_info = "compressed" 209 | else: 210 | state_info = "expanded" 211 | self.gcode.respond_info("belay {}: {}".format(self.name, state_info)) 212 | 213 | cmd_BELAY_SET_MULTIPLIER_help = ( 214 | "Sets multiplier_high and/or multiplier_low. Does not persist across" 215 | " restarts." 216 | ) 217 | 218 | def cmd_BELAY_SET_MULTIPLIER(self, gcmd): 219 | self.multiplier_high = gcmd.get_float( 220 | "HIGH", self.multiplier_high, minval=1.0 221 | ) 222 | self.multiplier_low = gcmd.get_float( 223 | "LOW", self.multiplier_low, minval=0.0, maxval=1.0 224 | ) 225 | 226 | cmd_BELAY_SET_STEPPER_help = ( 227 | "Select the extruder_stepper object to be controlled by the Belay" 228 | ) 229 | 230 | def cmd_BELAY_SET_STEPPER(self, gcmd): 231 | self.handle_disable() 232 | self._set_extruder_stepper(gcmd.get("STEPPER")) 233 | self.handle_enable() 234 | 235 | def get_status(self, eventtime): 236 | return {"last_state": self.last_state, "enabled": self.enabled} 237 | 238 | 239 | def load_config_prefix(config): 240 | return Belay(config) 241 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | This work is licensed under CC BY-NC-SA 4.0. To view a copy of this 2 | license, visit http://creativecommons.org/licenses/by-nc-sa/4.0/ 3 | 4 | This license applies to all files except for those in subfolders that 5 | contain their own license file. In such cases, the license file in the 6 | subfolder takes precendence for files within the subfolder. 7 | -------------------------------------------------------------------------------- /Print_Settings_and_File_Key.txt: -------------------------------------------------------------------------------- 1 | Primary Color: nothing at start of file name 2 | Accent Color: [a]_ at start of file name 3 | Quantity Required: _x# near end of file name 4 | File Revision: _rev# at end of file name 5 | 6 | Do not use XY compensation, hole shrinking compensation, or any 7 | similar slicer setting that modifies the geometry to try to account 8 | for shrinkage. Elephant foot compensation (also known as XY first 9 | layer compensation) is okay. 10 | 11 | Nozzle Size: 0.5mm 12 | Recommended FDM Materials: ASA, Polymaker or 3DXTech Recommended 13 | Alternate Approved FDM Materials: PC, 3DXTech Recommended 14 | Layer Height: 0.20mm to 0.25mm 15 | Extrusion Width: Forced 0.5mm 16 | Infill Percentage: 40% minimum (at 0.8mm Width) 17 | Infill Type: Grid, Gyroid, Honeycomb, Triangle or Cubic 18 | Wall Count: 3 minimum (at 0.5mm Width) 19 | Solid Top/Bottom Layers: 4 minimum (at 0.5mm Height) 20 | 21 | Nozzle Size: 0.4mm 22 | Recommended FDM Materials: ASA, Polymaker or 3DXTech Recommended 23 | Alternate Approved FDM Materials: PC, 3DXTech Recommended 24 | Layer Height: 0.20mm to 0.25mm 25 | Extrusion Width: 0.40 to 0.45mm 26 | Infill Percentage: 40% minimum (at 0.6mm Width) 27 | Infill Type: Grid, Gyroid, Honeycomb, Triangle or Cubic 28 | Wall Count: 4 minimum (at 0.4mm Width) 29 | Solid Top/Bottom Layers: 4 minimum (at 0.25mm Height) 30 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Belay - Extruder Sync Sensor 2 | 3 | ![Open Alpha](https://img.shields.io/badge/Open%20Alpha-blue) 4 | 5 | Belay is a sensor for FFF 3D printers for keeping a secondary extruder 6 | in sync with the primary extruder, avoiding error accumulation 7 | regardless of how long a print may be. Either a 8 | [Trad Rack](https://github.com/Annex-Engineering/TradRack) or a normal 9 | extruder can be used as the secondary extruder. See 10 | [purpose and how it works](#purpose-and-how-it-works) for more 11 | details. 12 | 13 | This project is inspired by the Filament Buffer used by Bambu Lab on their X1 14 | and P1 Series printers. 15 | 16 | Our discord server can be found here: 17 | 18 | [![Join me on Discord](https://discord.com/api/guilds/641407187004030997/widget.png?style=banner2)](https://discord.gg/MzTR3zE) 19 | 20 | ![Image of Belay](Images/render.png?raw=true) 21 | 22 | ## Getting started 23 | 24 | See the [Quick Start document](/docs/Quick_Start.md) to get started. 25 | 26 | ## Purpose and how it works 27 | 28 | Long filament paths or very heavy spools can cause extra resistance 29 | in filament movement, potentially causing the printer's extruder to 30 | struggle. One solution is to add a secondary extruder in series with 31 | the primary extruder to take some of the load; often the secondary 32 | extruder is synced directly to the primary extruder. 33 | 34 | However, without a feedback system, the 2 extruders may gradually 35 | drift out of sync from even a small mismatch in how well their 36 | `rotation_distance` calibrations match the actual movement ratios. 37 | Longer prints will build up to a larger mismatch, which may add extra 38 | resistance to the filament's movement and eventually cause one of the 39 | extruders to slip or skip. 40 | 41 | Belay prevents error accumulation by dynamically adjusting the 42 | `rotation_distance` setting of the secondary extruder to prevent 43 | buildup of excess slack or tension in the filament between the 2 44 | extruders. The bowden tube going from the secondary extruder to the 45 | primary extruder is split into 2 pieces, and Belay goes between them. 46 | When extruding forward, if the tubes before and after Belay 47 | start getting pulled together, it sets a higher multiplier (lower 48 | `rotation_distance`) for the secondary extruder. If the tubes start 49 | getting pushed apart, it sets a lower multiplier. The multipliers are 50 | reversed when extruding backward. 51 | 52 | The following gif shows Belay in use during a print with exaggerated 53 | multipliers of 1.30 and 0.70 to illustrate its movement: 54 | 55 | ![Belay Demo](Images/belay_demo_1.30_0.70.gif) 56 | 57 | (With the default multipliers of 1.05 and 0.95, the movement of the 58 | slider is much slower and shorter and becomes difficult to see, at 59 | least without very high extrusion flowrates) 60 | 61 | ## Status and future plans 62 | 63 | Belay is currently in open alpha. The code has been in use by a few 64 | people using Trad Rack and has been working well so far, but the 65 | current mechanical design is relatively new and may change 66 | significantly. 67 | 68 | Some things we may want to try in the future: 69 | 70 | - Using an analog hall effect sensor (or similar) and PID control, 71 | instead of the digital switch and bang-bang control that is 72 | currently used 73 | - Using the sensor to detect clogs/tangles (for example by detecting 74 | if the slider reaches either end of its travel via a 2nd switch or by 75 | replacing the digital switch with an analog one, using an analog 76 | sensor to determine if the slider is moving too fast for the 77 | commanded extrusion speed, etc.) 78 | -------------------------------------------------------------------------------- /STLs/README.md: -------------------------------------------------------------------------------- 1 | # What to print 2 | 3 | All parts in the STLs folder need to be printed, with the exception 4 | that some parts have multiple variants (for different bowden tube 5 | collet types) and you only need 1 variant of each of these parts: 6 | 7 | ## Collet types 8 | 9 | The following bowden tube collet types are supported: 10 | 11 | - "5mm collet" (E3D V6, Bondtech LGX) 12 | - "6mm collet" (UM2) 13 | - ECAS04 14 | 15 | The filename of each variant of the slider and sensor_housing STLs will contain 16 | either `(5mm_collet)`, `(6mm_collet)`, or `(ecas04)` to indicate the collet type 17 | it is meant for. 18 | 19 | "5mm" and "6mm" refer to the approximate diameter of the part of the collet that 20 | the collet clip goes around, highlighted in blue below: 21 | 22 | ![5mm and 6mm collets](/Images/5mm_and_6mm_collets.png?raw=true) 23 | 24 | If using the 5mm or 6mm collet options, a collet clip should be used to prevent 25 | the bowden tube from moving. A collet clip is unnecessary if using the ECAS04 26 | option. 27 | -------------------------------------------------------------------------------- /STLs/[a]_slider_(5mm_collet)_x1_rev2.STL: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Annex-Engineering/Belay/af9f1eccc7b6b5463cac9f0f18a48ca3d337f846/STLs/[a]_slider_(5mm_collet)_x1_rev2.STL -------------------------------------------------------------------------------- /STLs/[a]_slider_(6mm_collet)_x1_rev2.STL: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Annex-Engineering/Belay/af9f1eccc7b6b5463cac9f0f18a48ca3d337f846/STLs/[a]_slider_(6mm_collet)_x1_rev2.STL -------------------------------------------------------------------------------- /STLs/[a]_slider_(ecas04)_x1_rev1.STL: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Annex-Engineering/Belay/af9f1eccc7b6b5463cac9f0f18a48ca3d337f846/STLs/[a]_slider_(ecas04)_x1_rev1.STL -------------------------------------------------------------------------------- /STLs/cover_x1_rev2.STL: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Annex-Engineering/Belay/af9f1eccc7b6b5463cac9f0f18a48ca3d337f846/STLs/cover_x1_rev2.STL -------------------------------------------------------------------------------- /STLs/sensor_housing_(5mm_collet)_x1_rev2.STL: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Annex-Engineering/Belay/af9f1eccc7b6b5463cac9f0f18a48ca3d337f846/STLs/sensor_housing_(5mm_collet)_x1_rev2.STL -------------------------------------------------------------------------------- /STLs/sensor_housing_(6mm_collet)_x1_rev2.STL: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Annex-Engineering/Belay/af9f1eccc7b6b5463cac9f0f18a48ca3d337f846/STLs/sensor_housing_(6mm_collet)_x1_rev2.STL -------------------------------------------------------------------------------- /STLs/sensor_housing_(ecas04)_x1_rev1.STL: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Annex-Engineering/Belay/af9f1eccc7b6b5463cac9f0f18a48ca3d337f846/STLs/sensor_housing_(ecas04)_x1_rev1.STL -------------------------------------------------------------------------------- /docs/Quick_Start.md: -------------------------------------------------------------------------------- 1 | # Quick Start 2 | 3 | This document provides an overview of how to get a Belay sensor 4 | running. 5 | 6 | **Table of Contents** 7 | - [Prerequisites](#prerequisites) 8 | - [BOM/sourcing](#bomsourcing) 9 | - [Printed parts](#printed-parts) 10 | - [Assembly](#assembly) 11 | - [Wiring](#wiring) 12 | - [Kalico installation](#kalico-installation) 13 | - [Klippy module](#klippy-module) 14 | - [Klippy module installation](#klippy-module-installation) 15 | - [Enabling Moonraker updates](#enabling-moonraker-updates) 16 | - [Config files](#config-files) 17 | - [Testing](#testing) 18 | - [Check sensor polarity](#check-sensor-polarity) 19 | - [First print](#first-print) 20 | - [Further reading](#further-reading) 21 | 22 | ## Prerequisites 23 | 24 | Your 3D printer must meet the following requirements to work with 25 | Belay: 26 | 27 | - Must use 1.75mm filament. 28 | - Must run [Kalico](http://github.com/KalicoCrew/kalico) or 29 | [Klipper](https://github.com/Klipper3d/klipper) firmware. 30 | - The toolhead or primary extruder must have a collet/coupling to 31 | secure a 4mm bowden tube at its inlet. The secondary extruder must 32 | have one at its outlet as well. 33 | 34 | ## BOM/sourcing 35 | 36 | The following hardware is required: 37 | 38 | | Component/Item | Qty Required | Notes | 39 | | --- | --- | --- | 40 | | Omron D2F-L Microswitch | 1 | See Trad Rack BOM/sourcing guide for other variants that will work | 41 | | Collet | 2 | See Trad Rack BOM/sourcing guide for an ECAS04 source | 42 | | Collet clip | 2 | Only needed if using a 5mm or 6mm collet | 43 | | M2 x 12mm Pan Head Self Tapping Screw | 2 | Longer screws will also work but will stick out | 44 | 45 | See [the STLs README](/STLs/README.md#collet-types) for collet type options. 46 | Some example sources for 5mm/6mm collets and collet clips: 47 | - 5mm collet - [KB3D](https://kb-3d.com/store/spare-parts/487-bondtech-push-fit-collar-for-bowden-coupling-175mm-7350011413331.html) 48 | - 5mm collet clip - [KB3D](https://kb-3d.com/store/e3d/48-e3d-bowden-collet-clip-175mm-1644688775189.html) 49 | - 6mm collet and collet clip - [AliExpress](https://www.aliexpress.us/item/2255801046836641.html) 50 | 51 | See the 52 | [Annex BOM/sourcing guide](https://docs.google.com/spreadsheets/d/1O3eyVuQ6M4F03MJSDs4Z71_XyNjXL5HFTZr1jsaAtRc/edit?usp=sharing) 53 | for recommended sources for all other components. 54 | 55 | ## Printed parts 56 | 57 | See the following files/folders: 58 | 59 | - [Print Settings and File Key](/Print_Settings_and_File_Key.txt): 60 | print settings to use and info on reading the STL filenames. 61 | - [STLs folder](/STLs): contains all STL files. 62 | - [STLs README](/STLs/README.md): information on what parts to print. 63 | 64 | ## Assembly 65 | 66 | This section lists the assembly steps. If you are using ECAS04 collets, you can 67 | ignore any time a step tells you to add a collet clip. 68 | 69 | Insert the 2 collets into the sensor housing and slider: 70 | 71 | ![](images/add_exit_collet.png?raw=true) 72 | ![](images/add_entry_collet.png?raw=true) 73 | 74 | Place the slider into the sensor housing. Make sure the arrow is visible and 75 | facing the same direction as in the image: 76 | 77 | ![](images/add_slider.png?raw=true) 78 | 79 | Place the cover onto the sensor housing: 80 | 81 | ![](images/add_cover.png?raw=true) 82 | 83 | Insert the microswitch from the bottom and secure with 2 M2x12 screws (going 84 | through the cover, through the switch, and into the sensor housing). Make sure 85 | the tip of the lever on the microswitch is pointing to the left: 86 | 87 | ![](images/add_microswitch.png?raw=true) 88 | 89 | Push the slider to the left until it reaches the end of its travel. 90 | Then insert the entry bowden tube and push it in as far as it can go. 91 | The tube should extend past the left end of the slider and into the 92 | sensor housing: 93 | 94 | ![](images/add_entry_tube.png?raw=true) 95 | 96 | Gently pull the tube until the slider reaches the other end of its travel: 97 | 98 | ![](images/pull_entry_tube.png?raw=true) 99 | 100 | > [!IMPORTANT] 101 | > The tube should extend past the left end of the slider and into the sensor 102 | > housing, as shown by the orange highlighted portion in the image above. If you 103 | > can see a gap in the filament path, then the tube was not inserted all the 104 | > way, and you need to retry the previous 2 steps (move the slider to the left 105 | > end of its travel before pushing the tube further in, then pull the tube until 106 | > the slider reaches the right end of its travel). 107 | 108 | Add a collet clip by inserting it through the slot in the cover: 109 | 110 | ![](images/add_entry_clip.png?raw=true) 111 | 112 | Insert the exit bowden tube, then add a collet clip: 113 | 114 | ![](images/add_exit_tube_and_clip.png?raw=true) 115 | 116 | ## Wiring 117 | 118 | The microswitch has 3 solder points, but we're only going to be using 2 of them. Specifically, we'll be using the two solder points on the left and right sides of the housing. You can ignore the middle one. 119 | 120 | The wires will not be used to carry any substantial current. So you don't have to worry about using a specific gauge of wire. 121 | 122 | Solder 2 wires to the microswitch as shown below: 123 | 124 | ![](images/wiring_example_2.jpg?raw=true) 125 | 126 | Make sure you secure them to the sensor housing with a 127 | zip tie as shown below. This will keep any stresses from moving the belay around off the solder points. 128 | 129 | ![](images/wiring_example.jpg?raw=true) 130 | 131 | Next, you'll need to identify a port on your controller board to use. An endstop port is the easiest option, but you can use almost any available port with an input signal pin and a ground pin. Make sure you note the microcontroller pin name for the signal pin of this port, as you'll need it when we get to setting up the belay in Kalico or Klipper later. In this example, we'll be using an endstop port. This is a 3-pin port, and connects using a JST-XH connector. 132 | 133 | The port's pins are 3.3v, ground, and signal. The Belay only needs to connect to the ground and signal pins. You'll need to crimp the wires and then make sure you insert them in the connector aligned with the proper pins. It does not matter which wire is connected to ground or signal. 134 | ![](images/wire_crimp_example.jpg?raw=true) 135 | 136 | That's all it takes to wire the belay. Whenever you're ready, you can run the wire and plug it in to your printer's controller board. Remember that sensor pin name for the next steps. 137 | 138 | ## Kalico installation 139 | 140 | This section lists the steps to get Belay set up to work with Kalico or Klipper: 141 | 142 | ### Klippy module 143 | 144 | This section involves adding the Belay Klippy module(s) to Klipper 145 | and enabling updates through Moonraker. 146 | 147 | If you are using [Kalico](http://github.com/KalicoCrew/kalico), 148 | you can skip to [setting up config files](#config-files) since 149 | Kalico already includes the belay module. 150 | 151 | #### Klippy module installation 152 | 153 | Run the following commands to download and install the Klippy 154 | module(s): 155 | 156 | ``` 157 | cd ~ 158 | curl -LJO https://raw.githubusercontent.com/Annex-Engineering/Belay/main/Kalico/klippy_module/install.sh 159 | chmod +x install.sh 160 | ./install.sh 161 | ``` 162 | 163 | Then remove the install script with the following command: 164 | 165 | ``` 166 | rm install.sh 167 | ``` 168 | 169 | Finally, restart the klipper service using the following command: 170 | 171 | ``` 172 | sudo systemctl restart klipper 173 | ``` 174 | 175 | > [!TIP] 176 | > If you ever need to run the install script again in the future (for 177 | > example if additional Klippy modules get added), you can do so 178 | > without recreating the `belay_klippy_module` directory using the 179 | > following commands: 180 | > ``` 181 | > cd ~ 182 | > ./belay_klippy_module/Kalico/klippy_module/install.sh 183 | > ``` 184 | > If unspecified, `branch_name` defaults to `main`. 185 | 186 | #### Enabling Moonraker updates 187 | 188 | To enable updates of the Belay Klippy module(s) through Moonraker, 189 | add the following to your `moonraker.conf` file. This file is usually 190 | located in `~/printer_data/config/`: 191 | 192 | ``` 193 | [update_manager belay] 194 | type: git_repo 195 | path: ~/belay_klippy_module 196 | origin: https://github.com/Annex-Engineering/Belay.git 197 | primary_branch: main 198 | managed_services: klipper 199 | ``` 200 | 201 | Then restart the moonraker service using the following command: 202 | 203 | ``` 204 | sudo systemctl restart moonraker 205 | ``` 206 | 207 | ### Config files 208 | 209 | Sample config files are provided for different secondary extruder 210 | types. Copy the file from the corresponding subfolder of the 211 | [kalico_config folder](/Kalico/kalico_config/) and 212 | [include it](https://docs.kalico.gg/Config_Reference.html#include) 213 | in your main printer config file. 214 | 215 | Change the `sensor_pin` config option to match the pin you are using. 216 | In addition, make sure to follow all instructions left in the comments 217 | of the config file (which are specific to the type of secondary 218 | extruder you are using) for any further changes that may be needed. 219 | 220 | Restart Kalico once you have finished making changes to the config 221 | file(s). 222 | 223 | ## Testing 224 | 225 | This section explains how to test that Belay is working properly: 226 | 227 | ### Check sensor polarity 228 | 229 | Push the bowden tubes before and after Belay together by hand so that 230 | Belay is compressed. Run the following command and observe the console 231 | output: 232 | 233 | ``` 234 | QUERY_BELAY BELAY=my_belay 235 | ``` 236 | 237 | Then pull the bowden tubes apart so that Belay is expanded and run 238 | the command again. 239 | 240 | The expected result is that the console should have reported that 241 | belay my_belay was "compressed" the first time and "expanded" the 242 | second time. If these are reversed, add or remove `!` in the value for 243 | `sensor_pin` in the config file. If the reported states matched, then 244 | it is likely that either the wrong pin was used or there is a problem 245 | with wiring. 246 | 247 | ### First print 248 | 249 | During a print, Belay's slider should stay close to the middle of its 250 | travel range without hitting either end. 251 | 252 | The recommended starting value for the `debug_level` config option is 253 | `1`. With this setting, the extruder multiplier set by Belay will be 254 | reported in the console whenever Belay's switch changes state. 255 | 256 | Throughout a print with `debug_level` set to 1, the reported 257 | multiplier should generally flip back and forth between the values of 258 | the config options `multiplier_high` and `multiplier_low` (which 259 | default to `1.05` and `0.95` respectively). However, it is possible 260 | that the same multiplier may appear in the console 2 or more times in 261 | a row if the state of the switch changed during a retraction; this is 262 | normal. 263 | 264 | If Belay seems to be working and you do not want to see these messages 265 | in the console anymore, you can set `debug_level` to `0` in the config 266 | to disable them. 267 | 268 | 269 | ## Further reading 270 | 271 | See the [Overview document](README.md) to see the full documents 272 | available for Belay, for example to see all available gcode commands 273 | or config options. 274 | -------------------------------------------------------------------------------- /docs/README.md: -------------------------------------------------------------------------------- 1 | # Overview 2 | 3 | Welcome to the Belay documentation. If you want to get running as 4 | quickly as possible with minimal reading, see the 5 | [Quick Start document](Quick_Start.md). 6 | 7 | ## Getting started 8 | - [Quick Start](Quick_Start.md): information on how to get Belay 9 | running. 10 | 11 | ## Kalico 12 | - [Config Reference](kalico/Config_Reference.md): config settings for 13 | Belay. 14 | - [G-Codes](kalico/G-Codes.md): commands added by the belay 15 | klippy module. 16 | - [Status Reference](kalico/Status_Reference.md): information 17 | available to macros (and similar) from the belay klippy module. 18 | -------------------------------------------------------------------------------- /docs/images/add_cover.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Annex-Engineering/Belay/af9f1eccc7b6b5463cac9f0f18a48ca3d337f846/docs/images/add_cover.png -------------------------------------------------------------------------------- /docs/images/add_entry_clip.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Annex-Engineering/Belay/af9f1eccc7b6b5463cac9f0f18a48ca3d337f846/docs/images/add_entry_clip.png -------------------------------------------------------------------------------- /docs/images/add_entry_collet.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Annex-Engineering/Belay/af9f1eccc7b6b5463cac9f0f18a48ca3d337f846/docs/images/add_entry_collet.png -------------------------------------------------------------------------------- /docs/images/add_entry_tube.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Annex-Engineering/Belay/af9f1eccc7b6b5463cac9f0f18a48ca3d337f846/docs/images/add_entry_tube.png -------------------------------------------------------------------------------- /docs/images/add_exit_collet.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Annex-Engineering/Belay/af9f1eccc7b6b5463cac9f0f18a48ca3d337f846/docs/images/add_exit_collet.png -------------------------------------------------------------------------------- /docs/images/add_exit_tube_and_clip.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Annex-Engineering/Belay/af9f1eccc7b6b5463cac9f0f18a48ca3d337f846/docs/images/add_exit_tube_and_clip.png -------------------------------------------------------------------------------- /docs/images/add_microswitch.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Annex-Engineering/Belay/af9f1eccc7b6b5463cac9f0f18a48ca3d337f846/docs/images/add_microswitch.png -------------------------------------------------------------------------------- /docs/images/add_slider.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Annex-Engineering/Belay/af9f1eccc7b6b5463cac9f0f18a48ca3d337f846/docs/images/add_slider.png -------------------------------------------------------------------------------- /docs/images/pull_entry_tube.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Annex-Engineering/Belay/af9f1eccc7b6b5463cac9f0f18a48ca3d337f846/docs/images/pull_entry_tube.png -------------------------------------------------------------------------------- /docs/images/wire_crimp_example.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Annex-Engineering/Belay/af9f1eccc7b6b5463cac9f0f18a48ca3d337f846/docs/images/wire_crimp_example.jpg -------------------------------------------------------------------------------- /docs/images/wiring_example.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Annex-Engineering/Belay/af9f1eccc7b6b5463cac9f0f18a48ca3d337f846/docs/images/wiring_example.jpg -------------------------------------------------------------------------------- /docs/images/wiring_example_2.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Annex-Engineering/Belay/af9f1eccc7b6b5463cac9f0f18a48ca3d337f846/docs/images/wiring_example_2.jpg -------------------------------------------------------------------------------- /docs/kalico/Config_Reference.md: -------------------------------------------------------------------------------- 1 | # Belay Configuration reference 2 | 3 | This document is modeled after Kalico's 4 | [Config Reference document](https://docs.kalico.gg/Config_Reference.html) 5 | but only contains items pertaining to Belay. 6 | 7 | ### [belay] 8 | 9 | Belay extruder sync sensors (one may define any number of sections 10 | with a "belay" prefix). 11 | 12 | ``` 13 | [belay my_belay] 14 | extruder_type: 15 | # The type of secondary extruder. Available choices are 'trad_rack' 16 | # or 'extruder_stepper'. This parameter must be specified. 17 | extruder_stepper_name: 18 | # The name of the extruder_stepper being used as the secondary 19 | # extruder. Must be specified if extruder_type is set to 20 | # 'extruder_stepper', but should not be specified otherwise. For 21 | # example, if the config section for the secondary extruder is 22 | # [extruder_stepper my_extruder_stepper], this parameter's value 23 | # would be 'my_extruder_stepper'. 24 | #multiplier_high: 1.05 25 | # High multiplier to set for the secondary extruder when extruding 26 | # forward and Belay is compressed or when extruding backward and 27 | # Belay is expanded. The default is 1.05. 28 | #multiplier_low: 0.95 29 | # Low multiplier to set for the secondary extruder when extruding 30 | # forward and Belay is expanded or when extruding backward and 31 | # Belay is compressed. The default is 0.95. 32 | #debug_level: 0 33 | # Controls messages sent to the console. If set to 0, no messages 34 | # will be sent. If set to 1, multiplier resets will be reported, and 35 | # the multiplier will be reported whenever it is set in response to 36 | # a switch state change. If set to 2, the behavior is the same as 1 37 | # but with an additional message whenever the multiplier is set in 38 | # response to detecting an extrusion direction change. The default 39 | # is 0. 40 | ``` 41 | -------------------------------------------------------------------------------- /docs/kalico/G-Codes.md: -------------------------------------------------------------------------------- 1 | # G-Codes 2 | 3 | This document is modeled after Kalico's 4 | [G-Codes document](https://docs.kalico.gg/G-Codes.html) but only 5 | contains items pertaining to Belay. 6 | 7 | ### QUERY_BELAY 8 | `QUERY_BELAY BELAY=`: Queries the state of the belay 9 | specified by `BELAY`. 10 | 11 | ### BELAY_SET_MULTIPLIER 12 | `BELAY_SET_MULTIPLIER BELAY= [HIGH=] 13 | [LOW=]`: Sets the values of multiplier_high and/or 14 | multiplier_low for the belay specified by `BELAY`, overriding their 15 | values from the corresponding 16 | [belay config section](Config_Reference.md#belay). Values set by this 17 | command will not persist across restarts. 18 | 19 | ### BELAY_SET_STEPPER 20 | `BELAY_SET_STEPPER BELAY= STEPPER=`: Selects 21 | the extruder_stepper whose multiplier will be controlled by the belay specified 22 | by `BELAY`. The multiplier for the previous stepper will be reset back 23 | to 1 before switching to the new stepper. Stepper selections made by this 24 | command will not persist across restarts. This command is only available if 25 | extruder_type is set to 'extruder_stepper' in the corresponding 26 | [belay config section](Config_Reference.md#belay). 27 | -------------------------------------------------------------------------------- /docs/kalico/Status_Reference.md: -------------------------------------------------------------------------------- 1 | # Status Reference 2 | 3 | This document is modeled after Kalico's 4 | [Status Reference document](https://docs.kalico.gg/Status_Reference.html) 5 | but only contains items pertaining to Belay. 6 | 7 | ## belay 8 | 9 | The following information is available in 10 | [belay some_name](Config_Reference.md#belay) objects: 11 | - `printer["belay "].last_state`: Returns True if the belay's 12 | sensor is in a triggered state (indicating its slider is compressed). 13 | - `printer["belay "].enabled`: Returns True if the belay is 14 | currently enabled. 15 | -------------------------------------------------------------------------------- /eDrawings/Belay Alpha 2023-12-14.EASM: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Annex-Engineering/Belay/af9f1eccc7b6b5463cac9f0f18a48ca3d337f846/eDrawings/Belay Alpha 2023-12-14.EASM --------------------------------------------------------------------------------