├── .editorconfig
├── .github
└── ISSUE_TEMPLATE.md
├── .gitignore
├── LICENSE.md
├── MANIFEST.in
├── README.md
├── _config.yml
├── babel.cfg
├── docs
└── assets
│ └── img
│ ├── bed-leveling.png
│ ├── install.png
│ ├── klipper-config.png
│ ├── message-log.png
│ ├── offset.png
│ ├── performance-graph.png
│ ├── pid-tuning.png
│ └── settings.png
├── octoprint_klipper
├── __init__.py
├── modules
│ ├── KlipperLogAnalyzer.py
│ └── __init__.py
├── static
│ ├── css
│ │ └── klipper.css
│ ├── img
│ │ └── spinner.gif
│ ├── js
│ │ ├── klipper.js
│ │ ├── klipper_graph.js
│ │ ├── klipper_leveling.js
│ │ ├── klipper_offset.js
│ │ ├── klipper_param_macro.js
│ │ ├── klipper_pid_tuning.js
│ │ ├── klipper_settings.js
│ │ └── lib
│ │ │ └── Chart.bundle.min.js
│ └── less
│ │ └── klipper.less
└── templates
│ ├── klipper_graph_dialog.jinja2
│ ├── klipper_leveling_dialog.jinja2
│ ├── klipper_navbar.jinja2
│ ├── klipper_offset_dialog.jinja2
│ ├── klipper_param_macro_dialog.jinja2
│ ├── klipper_pid_tuning_dialog.jinja2
│ ├── klipper_settings.jinja2
│ ├── klipper_sidebar.jinja2
│ └── klipper_tab_main.jinja2
├── requirements.txt
└── setup.py
/.editorconfig:
--------------------------------------------------------------------------------
1 | # This file is for unifying the coding style for different editors and IDEs
2 | # editorconfig.org
3 |
4 | root = true
5 |
6 | [*]
7 | end_of_line = lf
8 | charset = utf-8
9 | insert_final_newline = true
10 | trim_trailing_whitespace = true
11 |
12 | [**.py]
13 | indent_style = tab
14 |
15 | [**.js]
16 | indent_style = space
17 | indent_size = 4
18 |
--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE.md:
--------------------------------------------------------------------------------
1 | Before submitting your issue please make sure to provide the following information
2 |
3 | About your environment:
4 | - Distribution version. Eg. octopi, armbian
5 | - Octoprint version
6 |
7 | - An OctoPrint log file. You can access and download it in the OctoPrint settings under the "Logging" menu entry.
8 |
9 | Thanks
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | *.pyc
2 | *.swp
3 | .idea
4 | *.iml
5 | build
6 | dist
7 | *.egg*
8 | .DS_Store
9 | *.zip
10 |
--------------------------------------------------------------------------------
/LICENSE.md:
--------------------------------------------------------------------------------
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 |
--------------------------------------------------------------------------------
/MANIFEST.in:
--------------------------------------------------------------------------------
1 | include README.md
2 | recursive-include octoprint_klipper/templates *
3 | recursive-include octoprint_klipper/translations *
4 | recursive-include octoprint_klipper/static *
5 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # OctoPrint Klipper Plugin
2 |
3 | This plugin assists in managing and monitoring the [Klipper](https://github.com/KevinOConnor/klipper) 3D printer firmware.
4 |
5 | ### Features
6 | - Simplified connection dialog.
7 | - Restart Host and MCU processes.
8 | - User defineable macro buttons with optional parameter dialogs.
9 | - Assisted bed leveling wizard with user definable probe points.
10 | - PID Tuning Dialog.
11 | - Dialog to set a coordinate offset for future GCODE move commands.
12 | - Message log displaying messages from Klipper prepended with "//" and "!!".
13 | - Basic Klipper configuration editor
14 | - Performance graph displaying key parameters extracted from the Klipper logs.
15 |
16 | ## Installation
17 |
18 | Search for "Klipper" in OctoPrints Plugin Manager.
19 |
20 | 
21 |
22 | or install manually using this URL / zip:
23 |
24 | https://github.com/mmone/OctoPrintKlipper/archive/master.zip
25 |
26 | ## Update
27 |
28 | OctoPrint will inform you when a new version of this plugin becomes available.
29 |
30 | ## Configuration
31 |
32 | Click on the wrench icon in the titlebar to open OctoPrints settings dialog. Select "OctoKlipper" at the bottom of the settings dialog.
33 |
34 | ## Contributions
35 |
36 | Also for the moment this plugin does what I wanted it to do, it is far from finished, pull requests are welcome. If you want to get started, the OctoPrint Plugin API is quite well documented here: [docs.octoprint.org/en/master/plugins](http://docs.octoprint.org/en/master/plugins).
37 |
38 |
39 | ## Screenshots
40 |
41 | #### Message Log
42 | 
43 |
44 | #### Bed Leveling
45 | 
46 |
47 | #### PID Tuning
48 | 
49 |
50 | #### Coordinate Offset
51 | 
52 |
53 | #### Settings
54 | 
55 |
56 | #### Klipper Config
57 | 
58 |
59 | #### Performance Graph
60 | 
61 |
62 |
--------------------------------------------------------------------------------
/_config.yml:
--------------------------------------------------------------------------------
1 | theme: jekyll-theme-minimal
2 | title: OctoPrint Plugin for Klipper
3 |
--------------------------------------------------------------------------------
/babel.cfg:
--------------------------------------------------------------------------------
1 | [python: */**.py]
2 | [jinja2: */**.jinja2]
3 | extensions=jinja2.ext.autoescape, jinja2.ext.with_
4 |
5 | [javascript: */**.js]
6 | extract_messages = gettext, ngettext
7 |
--------------------------------------------------------------------------------
/docs/assets/img/bed-leveling.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mmone/OctoprintKlipperPlugin/aaf045df554f23809544c189b0b5bddf3d9e840b/docs/assets/img/bed-leveling.png
--------------------------------------------------------------------------------
/docs/assets/img/install.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mmone/OctoprintKlipperPlugin/aaf045df554f23809544c189b0b5bddf3d9e840b/docs/assets/img/install.png
--------------------------------------------------------------------------------
/docs/assets/img/klipper-config.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mmone/OctoprintKlipperPlugin/aaf045df554f23809544c189b0b5bddf3d9e840b/docs/assets/img/klipper-config.png
--------------------------------------------------------------------------------
/docs/assets/img/message-log.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mmone/OctoprintKlipperPlugin/aaf045df554f23809544c189b0b5bddf3d9e840b/docs/assets/img/message-log.png
--------------------------------------------------------------------------------
/docs/assets/img/offset.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mmone/OctoprintKlipperPlugin/aaf045df554f23809544c189b0b5bddf3d9e840b/docs/assets/img/offset.png
--------------------------------------------------------------------------------
/docs/assets/img/performance-graph.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mmone/OctoprintKlipperPlugin/aaf045df554f23809544c189b0b5bddf3d9e840b/docs/assets/img/performance-graph.png
--------------------------------------------------------------------------------
/docs/assets/img/pid-tuning.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mmone/OctoprintKlipperPlugin/aaf045df554f23809544c189b0b5bddf3d9e840b/docs/assets/img/pid-tuning.png
--------------------------------------------------------------------------------
/docs/assets/img/settings.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mmone/OctoprintKlipperPlugin/aaf045df554f23809544c189b0b5bddf3d9e840b/docs/assets/img/settings.png
--------------------------------------------------------------------------------
/octoprint_klipper/__init__.py:
--------------------------------------------------------------------------------
1 | # coding=utf-8
2 | # OctoPrint Klipper Plugin
3 | #
4 | # Copyright (C) 2018 Martin Muehlhaeuser
5 | #
6 | # This file may be distributed under the terms of the GNU GPLv3 license.
7 |
8 | from __future__ import absolute_import
9 | import datetime
10 | import logging
11 | import octoprint.plugin
12 | import octoprint.plugin.core
13 | import glob
14 | import os
15 | from octoprint.util.comm import parse_firmware_line
16 | from .modules import KlipperLogAnalyzer
17 | import flask
18 |
19 | class KlipperPlugin(
20 | octoprint.plugin.StartupPlugin,
21 | octoprint.plugin.TemplatePlugin,
22 | octoprint.plugin.SettingsPlugin,
23 | octoprint.plugin.AssetPlugin,
24 | octoprint.plugin.SimpleApiPlugin,
25 | octoprint.plugin.EventHandlerPlugin):
26 |
27 | _parsing_response = False
28 | _message = ""
29 |
30 | #-- Startup Plugin
31 |
32 | def on_after_startup(self):
33 | klipper_port = self._settings.get(["connection", "port"])
34 | additional_ports = self._settings.global_get(["serial", "additionalPorts"])
35 |
36 | if klipper_port not in additional_ports:
37 | additional_ports.append(klipper_port)
38 | self._settings.global_set(["serial", "additionalPorts"], additional_ports)
39 | self._settings.save()
40 | self._logger.info("Added klipper serial port {} to list of additional ports.".format(klipper_port))
41 |
42 | #-- Settings Plugin
43 |
44 | def get_settings_defaults(self):
45 | return dict(
46 | connection = dict(
47 | port="/tmp/printer",
48 | replace_connection_panel=True
49 | ),
50 | macros = [dict(
51 | name="E-Stop",
52 | macro="M112",
53 | sidebar=True,
54 | tab=True
55 | )],
56 | probe = dict(
57 | height=0,
58 | lift=5,
59 | speed_xy=1500,
60 | speed_z=500,
61 | points=[dict(
62 | name="point-1",
63 | x=0,
64 | y=0
65 | )]
66 | ),
67 | configuration = dict(
68 | path="~/printer.cfg",
69 | reload_command="RESTART"
70 | )
71 | )
72 |
73 | def on_settings_load(self):
74 | data = octoprint.plugin.SettingsPlugin.on_settings_load(self)
75 |
76 | filepath = os.path.expanduser(
77 | self._settings.get(["configuration", "path"])
78 | )
79 | try:
80 | f = open(filepath, "r")
81 | data["config"] = f.read()
82 | f.close()
83 | except IOError:
84 | self._logger.error(
85 | "Error: Klipper config file not found at: {}".format(filepath)
86 | )
87 | return data
88 |
89 | def on_settings_save(self, data):
90 | if "config" in data:
91 | try:
92 | filepath = os.path.expanduser(
93 | self._settings.get(["configuration", "path"])
94 | )
95 | f = open(filepath, "w")
96 | f.write(data["config"])
97 | f.close()
98 | self._logger.info(
99 | "Writing Klipper config to {}".format(filepath)
100 | )
101 | # Restart klipply to reload config
102 | self._printer.commands(self._settings.get(["configuration", "reload_command"]))
103 | self.logInfo("Reloading Klipper Configuration.")
104 | except IOError:
105 | self._logger.error(
106 | "Error: Couldn't write Klipper config file: {}".format(filepath)
107 | )
108 | data.pop("config", None) # we dont want to write the klipper conf to the octoprint settings
109 | else:
110 | octoprint.plugin.SettingsPlugin.on_settings_save(self, data)
111 |
112 | def get_settings_restricted_paths(self):
113 | return dict(
114 | admin=[
115 | ["connection", "port"],
116 | ["configuration", "path"],
117 | ["configuration", "replace_connection_panel"]
118 | ],
119 | user=[
120 | ["macros"],
121 | ["probe"]
122 | ]
123 | )
124 |
125 | def get_settings_version(self):
126 | return 2
127 |
128 | def on_settings_migrate(self, target, current):
129 | if current is None:
130 | settings = self._settings
131 |
132 | if settings.has(["serialport"]):
133 | settings.set(["connection", "port"], settings.get(["serialport"]) )
134 | settings.remove(["serialport"])
135 |
136 | if settings.has(["replace_connection_panel"]):
137 | settings.set(
138 | ["connection", "replace_connection_panel"],
139 | settings.get(["replace_connection_panel"])
140 | )
141 | settings.remove(["replace_connection_panel"])
142 |
143 | if settings.has(["probeHeight"]):
144 | settings.set(["probe", "height"], settings.get(["probeHeight"]))
145 | settings.remove(["probeHeight"])
146 |
147 | if settings.has(["probeLift"]):
148 | settings.set(["probe", "lift"], settings.get(["probeLift"]))
149 | settings.remove(["probeLift"])
150 |
151 | if settings.has(["probeSpeedXy"]):
152 | settings.set(["probe", "speed_xy"], settings.get(["probeSpeedXy"]))
153 | settings.remove(["probeSpeedXy"])
154 |
155 | if settings.has(["probeSpeedZ"]):
156 | settings.set(["probe", "speed_z"], settings.get(["probeSpeedZ"]))
157 | settings.remove(["probeSpeedZ"])
158 |
159 | if settings.has(["probePoints"]):
160 | points = settings.get(["probePoints"])
161 | points_new = []
162 | for p in points:
163 | points_new.append(dict(name="", x=int(p["x"]), y=int(p["y"]), z=0))
164 | settings.set(["probe", "points"], points_new)
165 | settings.remove(["probePoints"])
166 |
167 | if settings.has(["configPath"]):
168 | settings.set(["config_path"], settings.get(["configPath"]))
169 | settings.remove(["configPath"])
170 |
171 | #-- Template Plugin
172 |
173 | def get_template_configs(self):
174 | return [
175 | dict(type="navbar", custom_bindings=True),
176 | dict(type="settings", custom_bindings=True),
177 | dict(
178 | type="generic",
179 | name="Assisted Bed Leveling",
180 | template="klipper_leveling_dialog.jinja2",
181 | custom_bindings=True
182 | ),
183 | dict(
184 | type="generic",
185 | name="PID Tuning",
186 | template="klipper_pid_tuning_dialog.jinja2",
187 | custom_bindings=True
188 | ),
189 | dict(
190 | type="generic",
191 | name="Coordinate Offset",
192 | template="klipper_offset_dialog.jinja2",
193 | custom_bindings=True
194 | ),
195 | dict(
196 | type="tab",
197 | name="Klipper",
198 | template="klipper_tab_main.jinja2",
199 | suffix="_main",
200 | custom_bindings=True
201 | ),
202 | dict(type="sidebar",
203 | custom_bindings=True,
204 | icon="rocket",
205 | replaces= "connection" if self._settings.get_boolean(["connection", "replace_connection_panel"]) else ""
206 | ),
207 | dict(
208 | type="generic",
209 | name="Performance Graph",
210 | template="klipper_graph_dialog.jinja2",
211 | custom_bindings=True
212 | ),
213 | dict(
214 | type="generic",
215 | name="Macro Dialog",
216 | template="klipper_param_macro_dialog.jinja2",
217 | custom_bindings=True
218 | )
219 | ]
220 |
221 | #-- Asset Plugin
222 |
223 | def get_assets(self):
224 | return dict(
225 | js=["js/klipper.js",
226 | "js/klipper_settings.js",
227 | "js/klipper_leveling.js",
228 | "js/klipper_pid_tuning.js",
229 | "js/klipper_offset.js",
230 | "js/klipper_param_macro.js",
231 | "js/klipper_graph.js"
232 | ],
233 | css=["css/klipper.css"],
234 | less=["css/klipper.less"]
235 | )
236 |
237 | #-- Event Handler Plugin
238 |
239 | def on_event(self, event, payload):
240 | if "Connecting" == event:
241 | self.updateStatus("info", "Connecting ...")
242 | elif "Connected" == event:
243 | self.updateStatus("info", "Connected to host")
244 | self.logInfo("Connected to host via {} @{}bps".format(payload["port"], payload["baudrate"]))
245 | elif "Disconnected" == event:
246 | self.updateStatus("info", "Disconnected from host")
247 | elif "Error" == event:
248 | self.updateStatus("error", "Error")
249 | self.logError(payload["error"])
250 |
251 | #-- GCODE Hook
252 |
253 | def on_parse_gcode(self, comm, line, *args, **kwargs):
254 | if "FIRMWARE_VERSION" in line:
255 | printerInfo = parse_firmware_line(line)
256 | if "FIRMWARE_VERSION" in printerInfo:
257 | self.logInfo("Firmware version: {}".format(printerInfo["FIRMWARE_VERSION"]))
258 | elif "//" in line:
259 | self._message = self._message + line.strip('/')
260 | if not self._parsing_response:
261 | self.updateStatus("info", self._message)
262 | self._parsing_response = True
263 | else:
264 | if self._parsing_response:
265 | self._parsing_response = False
266 | self.logInfo(self._message)
267 | self._message = ""
268 | if "!!" in line:
269 | msg = line.strip('!')
270 | self.updateStatus("error", msg)
271 | self.logError(msg)
272 | return line
273 |
274 | def get_api_commands(self):
275 | return dict(
276 | listLogFiles=[],
277 | getStats=["logFile"],
278 | loadConfig=["configFile"]
279 | )
280 |
281 | def on_api_command(self, command, data):
282 | if command == "listLogFiles":
283 | files = []
284 | for f in glob.glob("/tmp/*.log*"):
285 | filesize = os.path.getsize(f)
286 | files.append(dict(
287 | name=os.path.basename(f) + " ({:.1f} KB)".format(filesize / 1000.0),
288 | file=f,
289 | size=filesize
290 | ))
291 | return flask.jsonify(data=files)
292 | elif command == "getStats":
293 | if "logFile" in data:
294 | log_analyzer = KlipperLogAnalyzer.KlipperLogAnalyzer(data["logFile"])
295 | return flask.jsonify(log_analyzer.analyze())
296 | elif command == "loadConfig":
297 | kc = Parser()
298 | sections = kc.load(data["configFile"])
299 | return flask.jsonify(sections)
300 |
301 | def get_update_information(self):
302 | return dict(
303 | klipper=dict(
304 | displayName=self._plugin_name,
305 | displayVersion=self._plugin_version,
306 | type="github_release",
307 | current=self._plugin_version,
308 | user="mmone",
309 | repo="OctoprintKlipperPlugin",
310 | pip="https://github.com/mmone/OctoPrintKlipper/archive/{target_version}.zip"
311 | )
312 | )
313 |
314 | #-- Helpers
315 | def sendMessage(self, type, subtype, payload):
316 | self._plugin_manager.send_plugin_message(
317 | self._identifier,
318 | dict(
319 | time=datetime.datetime.now().strftime("%H:%M:%S"),
320 | type=type,
321 | subtype=subtype,
322 | payload=payload
323 | )
324 | )
325 |
326 | def pollStatus(self):
327 | self._printer.commands("STATUS")
328 |
329 | def updateStatus(self, type, status):
330 | self.sendMessage("status", type, status)
331 |
332 | def logInfo(self, message):
333 | self.sendMessage("log", "info", message)
334 |
335 | def logError(self, error):
336 | self.sendMessage("log", "error", error)
337 |
338 | def __plugin_load__():
339 | global __plugin_implementation__
340 | global __plugin_hooks__
341 |
342 | __plugin_implementation__ = KlipperPlugin()
343 | __plugin_hooks__ = {
344 | "octoprint.comm.protocol.gcode.received": __plugin_implementation__.on_parse_gcode,
345 | "octoprint.plugin.softwareupdate.check_config": __plugin_implementation__.get_update_information
346 | }
347 |
348 |
--------------------------------------------------------------------------------
/octoprint_klipper/modules/KlipperLogAnalyzer.py:
--------------------------------------------------------------------------------
1 | # Copyright (C) 2016-2018 Kevin O'Connor
2 |
3 | import flask
4 | import optparse, datetime
5 |
6 | class KlipperLogAnalyzer():
7 | MAXBANDWIDTH=25000.
8 | MAXBUFFER=2.
9 | STATS_INTERVAL=5.
10 | TASK_MAX=0.0025
11 | APPLY_PREFIX = ['mcu_awake', 'mcu_task_avg', 'mcu_task_stddev', 'bytes_write',
12 | 'bytes_read', 'bytes_retransmit', 'freq', 'adj']
13 |
14 | def __init__(self, log_file):
15 | self.log_file = log_file
16 |
17 | def analyze(self):
18 | data = self.parse_log(self.log_file, None)
19 | if not data:
20 | result = dict(error= "No relevant data available in \"{}\"".format(self.log_file))
21 | else:
22 | result = self.plot_mcu(data, self.MAXBANDWIDTH)
23 | return result
24 |
25 | def parse_log(self, logname, mcu):
26 | if mcu is None:
27 | mcu = "mcu"
28 | mcu_prefix = mcu + ":"
29 | apply_prefix = { p: 1 for p in self.APPLY_PREFIX }
30 | out = []
31 |
32 | try:
33 | f = open(logname, 'rb')
34 |
35 | for line in f:
36 | parts = line.split()
37 | if not parts or parts[0] not in ('Stats', 'INFO:root:Stats'):
38 | #if parts and parts[0] == 'INFO:root:shutdown:':
39 | # break
40 | continue
41 | prefix = ""
42 | keyparts = {}
43 | for p in parts[2:]:
44 | if '=' not in p:
45 | prefix = p
46 | if prefix == mcu_prefix:
47 | prefix = ''
48 | continue
49 | name, val = p.split('=', 1)
50 | if name in apply_prefix:
51 | name = prefix + name
52 | keyparts[name] = val
53 | if keyparts.get('bytes_write', '0') == '0':
54 | continue
55 | keyparts['#sampletime'] = float(parts[1][:-1])
56 | out.append(keyparts)
57 | f.close()
58 | except IOError:
59 | print("Couldn't open log file")
60 | return out
61 |
62 | def find_print_restarts(self, data):
63 | runoff_samples = {}
64 | last_runoff_start = last_buffer_time = last_sampletime = 0.
65 | last_print_stall = 0
66 | for d in reversed(data):
67 | # Check for buffer runoff
68 | sampletime = d['#sampletime']
69 | buffer_time = float(d.get('buffer_time', 0.))
70 | if (last_runoff_start and last_sampletime - sampletime < 5
71 | and buffer_time > last_buffer_time):
72 | runoff_samples[last_runoff_start][1].append(sampletime)
73 | elif buffer_time < 1.:
74 | last_runoff_start = sampletime
75 | runoff_samples[last_runoff_start] = [False, [sampletime]]
76 | else:
77 | last_runoff_start = 0.
78 | last_buffer_time = buffer_time
79 | last_sampletime = sampletime
80 | # Check for print stall
81 | print_stall = int(d['print_stall'])
82 | if print_stall < last_print_stall:
83 | if last_runoff_start:
84 | runoff_samples[last_runoff_start][0] = True
85 | last_print_stall = print_stall
86 | sample_resets = {sampletime: 1 for stall, samples in runoff_samples.values()
87 | for sampletime in samples if not stall}
88 | return sample_resets
89 |
90 | def plot_mcu(self, data, maxbw):
91 | # Generate data for plot
92 | basetime = lasttime = data[0]['#sampletime']
93 | lastbw = float(data[0]['bytes_write']) + float(data[0]['bytes_retransmit'])
94 | sample_resets = self.find_print_restarts(data)
95 | times = []
96 | bwdeltas = []
97 | loads = []
98 | awake = []
99 | hostbuffers = []
100 | for d in data:
101 | st = d['#sampletime']
102 | timedelta = st - lasttime
103 | if timedelta <= 0.:
104 | continue
105 | bw = float(d['bytes_write']) + float(d['bytes_retransmit'])
106 | if bw < lastbw:
107 | lastbw = bw
108 | continue
109 | load = float(d['mcu_task_avg']) + 3*float(d['mcu_task_stddev'])
110 | if st - basetime < 15.:
111 | load = 0.
112 | pt = float(d['print_time'])
113 | hb = float(d['buffer_time'])
114 | if hb >= self.MAXBUFFER or st in sample_resets:
115 | hb = 0.
116 | else:
117 | hb = 100. * (self.MAXBUFFER - hb) / self.MAXBUFFER
118 | hostbuffers.append(hb)
119 | times.append(st)
120 | bwdeltas.append(100. * (bw - lastbw) / (maxbw * timedelta))
121 | loads.append(100. * load / self.TASK_MAX)
122 | awake.append(100. * float(d.get('mcu_awake', 0.)) / self.STATS_INTERVAL)
123 | lasttime = st
124 | lastbw = bw
125 |
126 | result = dict(
127 | times= times,
128 | bwdeltas= bwdeltas,
129 | loads= loads,
130 | awake= awake,
131 | buffers= hostbuffers
132 | )
133 | return result
134 |
135 | def plot_frequency(self, data, mcu):
136 | all_keys = {}
137 | for d in data:
138 | all_keys.update(d)
139 | one_mcu = mcu is not None
140 | graph_keys = { key: ([], []) for key in all_keys
141 | if (key in ("freq", "adj") or (not one_mcu and (
142 | key.endswith(":freq") or key.endswith(":adj")))) }
143 | basetime = lasttime = data[0]['#sampletime']
144 | for d in data:
145 | st = d['#sampletime']
146 | for key, (times, values) in graph_keys.items():
147 | val = d.get(key)
148 | if val not in (None, '0', '1'):
149 | times.append(st)
150 | values.append(float(val)/1000000.0)
151 |
152 | return values
153 |
--------------------------------------------------------------------------------
/octoprint_klipper/modules/__init__.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mmone/OctoprintKlipperPlugin/aaf045df554f23809544c189b0b5bddf3d9e840b/octoprint_klipper/modules/__init__.py
--------------------------------------------------------------------------------
/octoprint_klipper/static/css/klipper.css:
--------------------------------------------------------------------------------
1 | .plugin-klipper-log {
2 | padding: 3px;
3 | overflow-y: scroll;
4 | height: 400px;
5 | border: 1px solid #eee;
6 | }
7 |
8 | .plugin-klipper-log .log-item {
9 | margin: 3px auto 0 auto;
10 | border: 1px solid #ddd;
11 | border-radius: 3px;
12 | background-color: #eeeeef;
13 | color: 333;
14 | }
15 |
16 | .plugin-klipper-log .error {
17 | background-color: #eebabb;
18 | }
19 |
20 | .plugin-klipper-log .log-item .ts {
21 | display: inline-block;
22 | width: 13%;
23 | height: 100%;
24 | vertical-align: top;
25 | font-size: 0.8em;
26 | padding: 0 0 0 5px;
27 | }
28 |
29 | .plugin-klipper-log .log-item .msg {
30 | display: inline-block;
31 | width: 84%;
32 | height: 100%;
33 | }
34 |
35 | .clear-btn {
36 | margin-top: 6px;
37 | }
38 |
39 | #plugin-klipper-config {
40 | font-family: monospace;
41 | }
42 |
43 | #klipper_graph_dialog form {
44 | margin: 0;
45 | }
46 |
47 | #klipper_graph_dialog .graph-footer {
48 | bottom:0;
49 | }
50 |
51 | #klipper_graph_dialog input {
52 | display: inline-block;
53 | }
54 |
55 | #klipper_graph_dialog .status-label {
56 | display: block;
57 | position: absolute;
58 | margin: 5px 0 0 10px;
59 | }
60 |
61 | #klipper_graph_dialog .fill-checkbox {
62 | display: block;
63 | position: absolute;
64 | bottom: 5px;
65 | margin-left: 10px;
66 | }
67 |
68 | #klipper_graph_canvas {
69 | margin-top: 15px;
70 | }
--------------------------------------------------------------------------------
/octoprint_klipper/static/img/spinner.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mmone/OctoprintKlipperPlugin/aaf045df554f23809544c189b0b5bddf3d9e840b/octoprint_klipper/static/img/spinner.gif
--------------------------------------------------------------------------------
/octoprint_klipper/static/js/klipper.js:
--------------------------------------------------------------------------------
1 | // OctoPrint Klipper Plugin
2 | //
3 | // Copyright (C) 2018 Martin Muehlhaeuser
4 | //
5 | // This file may be distributed under the terms of the GNU GPLv3 license.
6 |
7 | $(function() {
8 | function KlipperViewModel(parameters) {
9 | var self = this;
10 |
11 | self.settings = parameters[0];
12 | self.loginState = parameters[1];
13 | self.connectionState = parameters[2];
14 | self.levelingViewModel = parameters[3];
15 | self.paramMacroViewModel = parameters[4];
16 |
17 | self.shortStatus = ko.observable();
18 | self.logMessages = ko.observableArray();
19 |
20 | self.showLevelingDialog = function() {
21 | var dialog = $("#klipper_leveling_dialog");
22 | dialog.modal({
23 | show: 'true',
24 | backdrop: 'static',
25 | keyboard: false
26 | });
27 | self.levelingViewModel.initView();
28 | }
29 |
30 | self.showPidTuningDialog = function() {
31 | var dialog = $("#klipper_pid_tuning_dialog");
32 | dialog.modal({
33 | show: 'true',
34 | backdrop: 'static',
35 | keyboard: false
36 | });
37 | }
38 |
39 | self.showOffsetDialog = function() {
40 | var dialog = $("#klipper_offset_dialog");
41 | dialog.modal({
42 | show: 'true',
43 | backdrop: 'static'
44 | });
45 | }
46 |
47 | self.showGraphDialog = function() {
48 | var dialog = $("#klipper_graph_dialog");
49 | dialog.modal({
50 | show: 'true',
51 | minHeight: "500px",
52 | maxHeight: "600px"
53 | });
54 | }
55 |
56 | self.executeMacro = function(macro) {
57 | var paramObjRegex = /{(.*?)}/g;
58 |
59 | if (macro.macro().match(paramObjRegex) == null) {
60 | OctoPrint.control.sendGcode(
61 | macro.macro().replace(/(?:\r\n|\r|\n)/g, " ")
62 | );
63 | } else {
64 | self.paramMacroViewModel.process(macro);
65 |
66 | var dialog = $("#klipper_macro_dialog");
67 | dialog.modal({
68 | show: 'true',
69 | backdrop: 'static'
70 | });
71 | }
72 | }
73 |
74 | self.onGetStatus = function() {
75 | OctoPrint.control.sendGcode("Status")
76 | }
77 |
78 | self.onRestartFirmware = function() {
79 | OctoPrint.control.sendGcode("FIRMWARE_RESTART")
80 | };
81 |
82 | self.onRestartHost = function() {
83 | OctoPrint.control.sendGcode("RESTART")
84 | };
85 |
86 | self.onAfterBinding = function() {
87 | self.connectionState.selectedPort(self.settings.settings.plugins.klipper.connection.port());
88 | }
89 |
90 | self.onDataUpdaterPluginMessage = function(plugin, message) {
91 | if(plugin == "klipper") {
92 | if(message["type"] == "status") {
93 | self.shortStatus(message["payload"]);
94 | } else {
95 | self.logMessage(message["time"], message["subtype"], message["payload"]);
96 | }
97 | }
98 | }
99 |
100 | self.logMessage = function(timestamp, type, message) {
101 | self.logMessages.push({
102 | time: timestamp,
103 | type: type,
104 | msg: message.replace(/\n/gi, " ")}
105 | );
106 | }
107 |
108 | self.onClearLog = function() {
109 | self.logMessages.removeAll();
110 | };
111 |
112 | self.isActive = function() {
113 | return self.connectionState.isOperational() && self.loginState.isUser();
114 | }
115 | }
116 |
117 | OCTOPRINT_VIEWMODELS.push({
118 | construct: KlipperViewModel,
119 | dependencies: [
120 | "settingsViewModel",
121 | "loginStateViewModel",
122 | "connectionViewModel",
123 | "klipperLevelingViewModel",
124 | "klipperMacroDialogViewModel"
125 | ],
126 | elements: ["#tab_plugin_klipper_main", "#sidebar_plugin_klipper", "#navbar_plugin_klipper"]
127 | });
128 | });
--------------------------------------------------------------------------------
/octoprint_klipper/static/js/klipper_graph.js:
--------------------------------------------------------------------------------
1 | // OctoPrint Klipper Plugin
2 | //
3 | // Copyright (C) 2018 Martin Muehlhaeuser
4 | //
5 | // This file may be distributed under the terms of the GNU GPLv3 license.
6 |
7 | $(function() {
8 |
9 | function KlipperGraphViewModel(parameters) {
10 | var self = this;
11 | self.loginState = parameters[0];
12 |
13 | self.header = OctoPrint.getRequestHeaders({
14 | "content-type": "application/json",
15 | "cache-control": "no-cache"
16 | });
17 |
18 | self.apiUrl = OctoPrint.getSimpleApiUrl("klipper");
19 |
20 | self.availableLogFiles = ko.observableArray();
21 | self.logFile = ko.observable();
22 | self.status = ko.observable();
23 | self.datasets = ko.observableArray();
24 | self.datasetFill = ko.observable(false);
25 | self.canvas;
26 | self.canvasContext;
27 | self.chart;
28 | self.spinnerDialog;
29 |
30 | self.onStartup = function() {
31 | self.canvas = $("#klipper_graph_canvas")[0]
32 | self.canvasContext = self.canvas.getContext("2d");
33 | self.spinnerDialog = $("#klipper_graph_spinner");
34 |
35 | Chart.defaults.global.elements.line.borderWidth=1;
36 | Chart.defaults.global.elements.line.fill= false;
37 | Chart.defaults.global.elements.point.radius= 0;
38 |
39 | var myChart = new Chart(self.canvas, {
40 | type: "line"
41 | });
42 |
43 | if(self.loginState.loggedIn()) {
44 | self.listLogFiles();
45 | }
46 | }
47 |
48 | self.onUserLoggedIn = function(user) {
49 | self.listLogFiles();
50 | }
51 |
52 | self.listLogFiles = function() {
53 | var settings = {
54 | "crossDomain": true,
55 | "url": self.apiUrl,
56 | "method": "POST",
57 | "headers": self.header,
58 | "processData": false,
59 | "dataType": "json",
60 | "data": JSON.stringify({command: "listLogFiles"})
61 | }
62 |
63 | $.ajax(settings).done(function (response) {
64 | self.availableLogFiles.removeAll();
65 | self.availableLogFiles(response["data"]);
66 | });
67 | }
68 |
69 | self.saveGraphToPng = function() {
70 | button = $('#download-btn');
71 | var dataURL = self.canvas.toDataURL("image/png");//.replace("image/png", "image/octet-stream");
72 | button.attr("href", dataURL);
73 | }
74 |
75 | self.showSpinner = function(showDialog) {
76 | if (showDialog) {
77 | self.spinnerDialog.modal({
78 | show: true,
79 | keyboard: false,
80 | backdrop: "static"
81 | });
82 | } else {
83 | self.spinnerDialog.modal("hide");
84 | }
85 | }
86 |
87 | self.toggleDatasetFill = function() {
88 | if(self.datasets) {
89 | for (i=0; i < self.datasets().length; i++) {
90 | self.datasets()[i].fill = self.datasetFill();
91 | }
92 | self.chart.update();
93 | }
94 | return true
95 | }
96 |
97 | self.convertTime = function(val) {
98 | return moment(val, "X");
99 | }
100 |
101 | self.loadData = function() {
102 | var settings = {
103 | "crossDomain": true,
104 | "url": self.apiUrl,
105 | "method": "POST",
106 | "headers": self.header,
107 | "processData": false,
108 | "dataType": "json",
109 | "data": JSON.stringify(
110 | {
111 | command: "getStats",
112 | logFile: self.logFile()
113 | }
114 | )
115 | }
116 |
117 | self.showSpinner(true);
118 |
119 | $.ajax(settings).done(function (response) {
120 | self.status("")
121 | self.datasetFill(false);
122 |
123 | self.showSpinner(false);
124 |
125 | if("error" in response) {
126 | self.status(response.error);
127 | } else {
128 | self.datasets.removeAll();
129 | self.datasets.push(
130 | {
131 | label: "MCU Load",
132 | backgroundColor: "rgba(199, 44, 59, 0.5)",
133 | borderColor: "rgb(199, 44, 59)",
134 | yAxisID: 'y-axis-1',
135 | data: response.loads
136 | });
137 |
138 | self.datasets.push(
139 | {
140 | label: "Bandwith",
141 | backgroundColor: "rgba(255, 130, 1, 0.5)",
142 | borderColor: "rgb(255, 130, 1)",
143 | yAxisID: 'y-axis-1',
144 | data: response.bwdeltas
145 | });
146 |
147 | self.datasets.push(
148 | {
149 | label: "Host Buffer",
150 | backgroundColor: "rgba(0, 145, 106, 0.5)",
151 | borderColor: "rgb(0, 145, 106)",
152 | yAxisID: 'y-axis-1',
153 | data: response.buffers
154 | });
155 |
156 | self.datasets.push(
157 | {
158 | label: "Awake Time",
159 | backgroundColor: "rgba(33, 64, 95, 0.5)",
160 | borderColor: "rgb(33, 64, 95)",
161 | yAxisID: 'y-axis-1',
162 | data: response.awake
163 | });
164 |
165 | self.chart = new Chart(self.canvas, {
166 | type: "line",
167 | data: {
168 | labels: response.times,
169 | datasets: self.datasets()
170 | },
171 | options: {
172 | elements:{
173 | line: {
174 | tension: 0
175 | }
176 | },
177 | scales: {
178 | xAxes: [{
179 | type: 'time',
180 | time: {
181 | parser: self.convertTime,
182 | tooltipFormat: "HH:mm",
183 | displayFormats: {
184 | minute: "HH:mm",
185 | second: "HH:mm",
186 | millisecond: "HH:mm"
187 | }
188 | },
189 | scaleLabel: {
190 | display: true,
191 | labelString: 'Time'
192 | }
193 | }],
194 | yAxes: [{
195 | scaleLabel: {
196 | display: true,
197 | labelString: '%'
198 | },
199 | position: 'left',
200 | id: 'y-axis-1'
201 | }
202 | ]
203 | },
204 | legend: {
205 |
206 | }
207 | }
208 | });
209 | }
210 | });
211 | }
212 | }
213 |
214 | OCTOPRINT_VIEWMODELS.push({
215 | construct: KlipperGraphViewModel,
216 | dependencies: ["loginStateViewModel"],
217 | elements: ["#klipper_graph_dialog"]
218 | });
219 | });
220 |
--------------------------------------------------------------------------------
/octoprint_klipper/static/js/klipper_leveling.js:
--------------------------------------------------------------------------------
1 | // OctoPrint Klipper Plugin
2 | //
3 | // Copyright (C) 2018 Martin Muehlhaeuser
4 | //
5 | // This file may be distributed under the terms of the GNU GPLv3 license.
6 |
7 | $(function() {
8 | function KlipperLevelingViewModel(parameters) {
9 | var self = this;
10 | self.settings = parameters[0];
11 | self.loginState = parameters[1];
12 |
13 | self.activePoint = ko.observable(-1);
14 | self.pointCount = ko.observable();
15 | self.points = ko.observableArray();
16 |
17 | self.initView = function() {
18 | self.points(self.settings.settings.plugins.klipper.probe.points());
19 | self.pointCount(
20 | self.points().length
21 | );
22 | }
23 |
24 | self.startLeveling = function() {
25 | OctoPrint.control.sendGcode("G28")
26 | self.moveToPoint(0);
27 | }
28 |
29 | self.stopLeveling = function() {
30 | OctoPrint.control.sendGcode("G1 Z" +
31 | (self.settings.settings.plugins.klipper.probe.height()*1 +
32 | self.settings.settings.plugins.klipper.probe.lift()*1)
33 | );
34 | self.gotoHome();
35 | }
36 |
37 | self.gotoHome = function() {
38 | OctoPrint.control.sendGcode("G28");
39 | self.activePoint(-1);
40 | }
41 |
42 | self.nextPoint = function() {
43 | self.moveToPoint(self.activePoint()+1);
44 | }
45 |
46 | self.previousPoint = function() {
47 | self.moveToPoint(self.activePoint()-1);
48 | }
49 |
50 | self.jumpToPoint = function(item) {
51 | self.moveToPoint(
52 | self.points().indexOf(item)
53 | );
54 | }
55 | /*
56 | self.pointCount = function() {
57 | return self.settings.settings.plugins.klipper.probe.points().length;
58 | }
59 | */
60 | self.moveToPosition = function(x, y) {
61 | OctoPrint.control.sendGcode(
62 | "G1 Z" + (self.settings.settings.plugins.klipper.probe.height() * 1 +
63 | self.settings.settings.plugins.klipper.probe.lift()*1) +
64 | " F" + self.settings.settings.plugins.klipper.probe.speed_z()
65 | );
66 | OctoPrint.control.sendGcode(
67 | "G1 X" + x + " Y" + y +
68 | " F" + self.settings.settings.plugins.klipper.probe.speed_xy()
69 | );
70 | OctoPrint.control.sendGcode(
71 | "G1 Z" + self.settings.settings.plugins.klipper.probe.height() +
72 | " F" + self.settings.settings.plugins.klipper.probe.speed_z()
73 | );
74 | }
75 |
76 | self.moveToPoint = function(index) {
77 | var point = self.points()[index];
78 |
79 | self.moveToPosition(point.x(), point.y());
80 | self.activePoint(index);
81 | }
82 | }
83 |
84 | OCTOPRINT_VIEWMODELS.push({
85 | construct: KlipperLevelingViewModel,
86 | dependencies: ["settingsViewModel", "loginStateViewModel"],
87 | elements: ["#klipper_leveling_dialog"]
88 | });
89 | });
--------------------------------------------------------------------------------
/octoprint_klipper/static/js/klipper_offset.js:
--------------------------------------------------------------------------------
1 | // OctoPrint Klipper Plugin
2 | //
3 | // Copyright (C) 2018 Martin Muehlhaeuser
4 | //
5 | // This file may be distributed under the terms of the GNU GPLv3 license.
6 |
7 | $(function() {
8 | function KlipperOffsetDialogViewModel(parameters) {
9 | var self = this;
10 |
11 | self.offsetX = ko.observable();
12 | self.offsetY = ko.observable();
13 | self.offsetZ = ko.observable();
14 | self.adjust = ko.observable();
15 |
16 | self.onStartup = function() {
17 | self.offsetX(0);
18 | self.offsetY(0);
19 | self.offsetZ(0);
20 | self.adjust(false);
21 | }
22 |
23 | self.setOffset = function() {
24 | if(self.adjust()) {
25 | OctoPrint.control.sendGcode("SET_GCODE_OFFSET X_ADJUST=" + self.offsetX() +
26 | " Y_ADJUST=" + self.offsetY() +
27 | " Z_ADJUST=" + self.offsetZ());
28 | } else {
29 | OctoPrint.control.sendGcode("SET_GCODE_OFFSET X=" + self.offsetX() +
30 | " Y=" + self.offsetY() +
31 | " Z=" + self.offsetZ());
32 | }
33 | }
34 | }
35 |
36 | OCTOPRINT_VIEWMODELS.push({
37 | construct: KlipperOffsetDialogViewModel,
38 | dependencies: [],
39 | elements: ["#klipper_offset_dialog"]
40 | });
41 | });
42 |
--------------------------------------------------------------------------------
/octoprint_klipper/static/js/klipper_param_macro.js:
--------------------------------------------------------------------------------
1 | // OctoPrint Klipper Plugin
2 | //
3 | // Copyright (C) 2018 Martin Muehlhaeuser
4 | //
5 | // This file may be distributed under the terms of the GNU GPLv3 license.
6 |
7 | $(function() {
8 | function KlipperMacroDialogViewModel(parameters) {
9 | var self = this;
10 |
11 | self.parameters = ko.observableArray();
12 | self.interpolatedCmd;
13 | self.macro;
14 | self.macroName = ko.observable();
15 |
16 | var paramObjRegex = /{(.*?)}/g;
17 | var keyValueRegex = /(\w*)\s*:\s*([\w\s°"|]*)/g;
18 |
19 | self.process = function(macro) {
20 | self.macro = macro.macro();
21 | self.macroName(macro.name());
22 |
23 | var matches = self.macro.match(paramObjRegex);
24 | var params = [];
25 |
26 | for (var i=0; i < matches.length; i++) {
27 | var obj = {};
28 | var res = keyValueRegex.exec(matches[i]);
29 |
30 | while (res != null) {
31 | if("options" == res[1]) {
32 | obj["options"] = res[2].trim().split("|");
33 | } else {
34 | obj[res[1]] = res[2].trim();
35 | }
36 | res = keyValueRegex.exec(matches[i]);
37 | }
38 |
39 | if(!("label" in obj)) {
40 | obj["label"] = "Input " + (i+1);
41 | }
42 |
43 | if(!("unit" in obj)) {
44 | obj["unit"] = "";
45 | }
46 |
47 | if("default" in obj) {
48 | obj["value"] = obj["default"];
49 | }
50 |
51 | params.push(obj);
52 | }
53 | self.parameters(params);
54 | }
55 |
56 | self.executeMacro = function() {
57 | var i=-1;
58 |
59 | function replaceParams(match) {
60 | i++;
61 | return self.parameters()[i]["value"];
62 | }
63 |
64 | expanded = self.macro.replace(paramObjRegex, replaceParams)
65 | expanded = expanded.replace(/(?:\r\n|\r|\n)/g, " ");
66 |
67 | OctoPrint.control.sendGcode(expanded);
68 | }
69 | }
70 |
71 | OCTOPRINT_VIEWMODELS.push({
72 | construct: KlipperMacroDialogViewModel,
73 | dependencies: [],
74 | elements: ["#klipper_macro_dialog"]
75 | });
76 | });
77 |
--------------------------------------------------------------------------------
/octoprint_klipper/static/js/klipper_pid_tuning.js:
--------------------------------------------------------------------------------
1 | // OctoPrint Klipper Plugin
2 | //
3 | // Copyright (C) 2018 Martin Muehlhaeuser
4 | //
5 | // This file may be distributed under the terms of the GNU GPLv3 license.
6 |
7 | $(function() {
8 | function KlipperPidTuningViewModel(parameters) {
9 | var self = this;
10 |
11 | self.heaterName = ko.observable();
12 | self.targetTemperature = ko.observable();
13 |
14 | self.onStartup = function() {
15 | self.heaterName("");
16 | self.targetTemperature(190);
17 | }
18 |
19 | self.startTuning = function() {
20 | OctoPrint.control.sendGcode("PID_CALIBRATE HEATER=" + self.heaterName() + " TARGET=" + self.targetTemperature());
21 | }
22 | }
23 |
24 | OCTOPRINT_VIEWMODELS.push({
25 | construct: KlipperPidTuningViewModel,
26 | dependencies: [],
27 | elements: ["#klipper_pid_tuning_dialog"]
28 | });
29 | });
30 |
--------------------------------------------------------------------------------
/octoprint_klipper/static/js/klipper_settings.js:
--------------------------------------------------------------------------------
1 | // OctoPrint Klipper Plugin
2 | //
3 | // Copyright (C) 2018 Martin Muehlhaeuser
4 | //
5 | // This file may be distributed under the terms of the GNU GPLv3 license.
6 |
7 | $(function() {
8 | $('#klipper-settings a:first').tab('show');
9 | function KlipperSettingsViewModel(parameters) {
10 | var self = this;
11 | self.settings = parameters[0];
12 |
13 | self.addMacro = function() {
14 | self.settings.settings.plugins.klipper.macros.push({
15 | name: 'Macro',
16 | macro: '',
17 | sidebar: true,
18 | tab: true
19 | });
20 | }
21 |
22 | self.removeMacro = function(macro) {
23 | self.settings.settings.plugins.klipper.macros.remove(macro);
24 | }
25 |
26 | self.moveMacroUp = function(macro) {
27 | self.moveItemUp(self.settings.settings.plugins.klipper.macros, macro)
28 | }
29 |
30 | self.moveMacroDown = function(macro) {
31 | self.moveItemDown(self.settings.settings.plugins.klipper.macros, macro)
32 | }
33 |
34 | self.addProbePoint = function() {
35 | self.settings.settings.plugins.klipper.probe.points.push(
36 | {
37 | name: 'point-#',
38 | x:0, y:0, z:0
39 | }
40 | );
41 | }
42 |
43 | self.removeProbePoint = function(point) {
44 | self.settings.settings.plugins.klipper.probe.points.remove(point);
45 | }
46 |
47 | self.moveProbePointUp = function(macro) {
48 | self.moveItemUp(self.settings.settings.plugins.klipper.probe.points, macro)
49 | }
50 |
51 | self.moveProbePointDown = function(macro) {
52 | self.moveItemDown(self.settings.settings.plugins.klipper.probe.points, macro)
53 | }
54 |
55 | self.moveItemDown = function(list, item) {
56 | var i = list().indexOf(item);
57 | if (i < list().length - 1) {
58 | var rawList = list();
59 | list.splice(i, 2, rawList[i + 1], rawList[i]);
60 | }
61 | }
62 |
63 | self.moveItemUp = function(list, item) {
64 | var i = list().indexOf(item);
65 | if (i > 0) {
66 | var rawList = list();
67 | list.splice(i-1, 2, rawList[i], rawList[i-1]);
68 | }
69 | }
70 | }
71 |
72 | OCTOPRINT_VIEWMODELS.push({
73 | construct: KlipperSettingsViewModel,
74 | dependencies: ["settingsViewModel"],
75 | elements: ["#settings_plugin_klipper"]
76 | });
77 | });
--------------------------------------------------------------------------------
/octoprint_klipper/static/less/klipper.less:
--------------------------------------------------------------------------------
1 | #tab_plugin_klipper iframe {
2 | width: 100%;
3 | height: 600px;
4 | border: 1px solid #808080;
5 | }
--------------------------------------------------------------------------------
/octoprint_klipper/templates/klipper_graph_dialog.jinja2:
--------------------------------------------------------------------------------
1 |