├── .gitignore
├── GCodeWriter.py
├── LICENSE
├── OutputDevice.py
├── OutputDevicePlugin.py
├── README.en-us.md
├── README.md
├── __init__.py
├── _snapshots
├── preview.jpg
├── savetofile.png
├── screen_auth.png
├── sendto.png
└── touchscreen_auth.jpg
├── plugin.json
└── qt_comp.py
/.gitignore:
--------------------------------------------------------------------------------
1 | # Byte-compiled / optimized / DLL files
2 | __pycache__/
3 | *.py[cod]
4 | *$py.class
5 |
6 | # C extensions
7 | *.so
8 |
9 | # Distribution / packaging
10 | .Python
11 | build/
12 | develop-eggs/
13 | dist/
14 | downloads/
15 | eggs/
16 | .eggs/
17 | lib/
18 | lib64/
19 | parts/
20 | sdist/
21 | var/
22 | wheels/
23 | pip-wheel-metadata/
24 | share/python-wheels/
25 | *.egg-info/
26 | .installed.cfg
27 | *.egg
28 | MANIFEST
29 |
30 | # PyInstaller
31 | # Usually these files are written by a python script from a template
32 | # before PyInstaller builds the exe, so as to inject date/other infos into it.
33 | *.manifest
34 | *.spec
35 |
36 | # Installer logs
37 | pip-log.txt
38 | pip-delete-this-directory.txt
39 |
40 | # Unit test / coverage reports
41 | htmlcov/
42 | .tox/
43 | .nox/
44 | .coverage
45 | .coverage.*
46 | .cache
47 | nosetests.xml
48 | coverage.xml
49 | *.cover
50 | *.py,cover
51 | .hypothesis/
52 | .pytest_cache/
53 |
54 | # Translations
55 | *.mo
56 | *.pot
57 |
58 | # Django stuff:
59 | *.log
60 | local_settings.py
61 | db.sqlite3
62 | db.sqlite3-journal
63 |
64 | # Flask stuff:
65 | instance/
66 | .webassets-cache
67 |
68 | # Scrapy stuff:
69 | .scrapy
70 |
71 | # Sphinx documentation
72 | docs/_build/
73 |
74 | # PyBuilder
75 | target/
76 |
77 | # Jupyter Notebook
78 | .ipynb_checkpoints
79 |
80 | # IPython
81 | profile_default/
82 | ipython_config.py
83 |
84 | # pyenv
85 | .python-version
86 |
87 | # pipenv
88 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
89 | # However, in case of collaboration, if having platform-specific dependencies or dependencies
90 | # having no cross-platform support, pipenv may install dependencies that don't work, or not
91 | # install all needed dependencies.
92 | #Pipfile.lock
93 |
94 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow
95 | __pypackages__/
96 |
97 | # Celery stuff
98 | celerybeat-schedule
99 | celerybeat.pid
100 |
101 | # SageMath parsed files
102 | *.sage.py
103 |
104 | # Environments
105 | .env
106 | .venv
107 | env/
108 | venv/
109 | ENV/
110 | env.bak/
111 | venv.bak/
112 |
113 | # Spyder project settings
114 | .spyderproject
115 | .spyproject
116 |
117 | # Rope project settings
118 | .ropeproject
119 |
120 | # mkdocs documentation
121 | /site
122 |
123 | # mypy
124 | .mypy_cache/
125 | .dmypy.json
126 | dmypy.json
127 |
128 | # Pyre type checker
129 | .pyre/
130 | .vscode
131 | release.sh
132 |
133 | *.zip
134 | Makefile
135 |
--------------------------------------------------------------------------------
/GCodeWriter.py:
--------------------------------------------------------------------------------
1 | import base64
2 | from io import StringIO
3 | from typing import cast
4 |
5 | from UM.Mesh.MeshWriter import MeshWriter
6 | from UM.Logger import Logger
7 | from UM.PluginRegistry import PluginRegistry
8 |
9 | from cura.Snapshot import Snapshot
10 | from cura.CuraApplication import CuraApplication
11 | from cura.Settings.ExtruderManager import ExtruderManager
12 | from cura.Utils.Threading import call_on_qt_thread
13 | try:
14 | from PyQt6.QtCore import QBuffer
15 | from PyQt6.QtGui import QImage
16 | QBufferOpenMode = QBuffer.OpenModeFlag.ReadWrite
17 | except ImportError:
18 | from PyQt5.QtCore import QBuffer
19 | from PyQt5.QtGui import QImage
20 | QBufferOpenMode = QBuffer.ReadWrite
21 |
22 | from UM.i18n import i18nCatalog
23 |
24 | catalog = i18nCatalog("cura")
25 |
26 |
27 | class ModError(Exception):
28 | pass
29 |
30 |
31 | class SM2GCodeWriter(MeshWriter):
32 | PROCESSED_IDENTITY = ";Processed by Snapmaker2Plugin (https://github.com/macdylan/Snapmaker2Plugin)"
33 |
34 | @call_on_qt_thread
35 | def write(self,
36 | stream,
37 | nodes,
38 | mode=MeshWriter.OutputMode.TextMode) -> bool:
39 | if mode != MeshWriter.OutputMode.TextMode:
40 | Logger.error("SM2GCodeWriter does not support non-text mode.")
41 | self.setInformation(
42 | catalog.i18nc(
43 | "@error:not supported",
44 | "SM2GCodeWriter does not support non-text mode."))
45 | return False
46 |
47 | gcode = StringIO()
48 | writer = cast(
49 | MeshWriter,
50 | PluginRegistry.getInstance().getPluginObject("GCodeWriter"))
51 | success = writer.write(gcode, None)
52 |
53 | if not success:
54 | self.setInformation(writer.getInformation())
55 | return False
56 |
57 | gcode.seek(0)
58 | try:
59 | result = self.mod(gcode)
60 | stream.write(result.getvalue())
61 | Logger.info("SM2GCodeWriter done")
62 | return True
63 | except ModError as e:
64 | self.setInformation(str(e))
65 | Logger.error(e)
66 | return False
67 |
68 | def mod(self, data: StringIO) -> StringIO:
69 | i = 0
70 | for x in data:
71 | if i > 100:
72 | break
73 | if x.find(self.PROCESSED_IDENTITY) != -1:
74 | return data
75 | i += 1
76 |
77 | data.seek(0)
78 | gcodes = data.readlines()
79 |
80 | p = StringIO()
81 | p.write(self.PROCESSED_IDENTITY + "\n")
82 | p.write(";Header Start\n")
83 | p.write(gcodes[0]) # FLAVOR
84 | p.write(gcodes[1]) # TIME
85 | p.write(gcodes[2]) # Filament used
86 | p.write(gcodes[3]) # Layer height
87 | p.write(";header_type: 3dp\n")
88 |
89 | ss = self._createSnapshot()
90 | if ss:
91 | p.write(";thumbnail: data:image/png;base64,")
92 | p.write(self._encodeSnapshot(ss))
93 | p.write("\n")
94 |
95 | app = CuraApplication.getInstance()
96 | print_time = int(app.getPrintInformation().currentPrintTime
97 | ) * 1.07 # Times empirical parameter: 1.07
98 | print_speed = float(self._getValue("speed_infill"))
99 | print_temp = float(self._getValue("material_print_temperature"))
100 | bed_temp = float(self._getValue("material_bed_temperature")) or 0.0
101 |
102 | if not print_speed or not print_temp:
103 | raise ModError(
104 | "Unable to slice with the current settings: speed_infill or material_print_temperature"
105 | )
106 |
107 | p.write(";file_total_lines: %d\n" % len(gcodes))
108 | p.write(";estimated_time(s): %.0f\n" % print_time)
109 | p.write(";nozzle_temperature(°C): %.0f\n" % print_temp)
110 | p.write(";build_plate_temperature(°C): %.0f\n" % bed_temp)
111 | p.write(";work_speed(mm/minute): %.0f\n" % (print_speed * 60.0))
112 | p.write(gcodes[7].replace("MAXX:", "max_x(mm): ")) # max_x
113 | p.write(gcodes[8].replace("MAXY:", "max_y(mm): ")) # max_y
114 | p.write(gcodes[9].replace("MAXZ:", "max_z(mm): ")) # max_z
115 | p.write(gcodes[4].replace("MINX:", "min_x(mm): ")) # min_x
116 | p.write(gcodes[5].replace("MINY:", "min_y(mm): ")) # min_y
117 | p.write(gcodes[6].replace("MINZ:", "min_z(mm): ")) # min_z
118 | p.write(";Header End\n")
119 |
120 | p.write("".join(gcodes[10:]))
121 | return p
122 |
123 | def _createSnapshot(self) -> QImage:
124 | Logger.debug("Creating thumbnail image...")
125 | try:
126 | return Snapshot.snapshot(width=240, height=160)
127 | except Exception:
128 | Logger.logException("w", "Failed to create snapshot image")
129 | return None
130 |
131 | def _encodeSnapshot(self, snapshot: QImage) -> str:
132 | Logger.debug("Encoding thumbnail image...")
133 | try:
134 | thumbnail_buffer = QBuffer()
135 | thumbnail_buffer.open(QBufferOpenMode)
136 | thumbnail_image = snapshot
137 | thumbnail_image.save(thumbnail_buffer, "PNG")
138 | base64_bytes = base64.b64encode(thumbnail_buffer.data())
139 | base64_message = base64_bytes.decode('ascii')
140 | thumbnail_buffer.close()
141 | return base64_message
142 | except Exception:
143 | Logger.logException("w", "Failed to encode snapshot image")
144 |
145 | def _getValue(self, key) -> str:
146 | stack = ExtruderManager.getInstance().getActiveExtruderStack()
147 | if not stack:
148 | return ""
149 |
150 | GetType = stack.getProperty(key, "type")
151 | GetVal = stack.getProperty(key, "value")
152 |
153 | if str(GetType) == "float":
154 | GelValStr = "{:.4f}".format(GetVal).rstrip("0").rstrip(".")
155 | else:
156 | if str(GetType) == "enum":
157 | get_option = str(GetVal)
158 | GetOption = stack.getProperty(key, "options")
159 | GetOptionDetail = GetOption[get_option]
160 | GelValStr = GetOptionDetail
161 | else:
162 | GelValStr = str(GetVal)
163 |
164 | return GelValStr
165 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
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 |
--------------------------------------------------------------------------------
/OutputDevice.py:
--------------------------------------------------------------------------------
1 | import time
2 | import json
3 | from typing import List
4 | from io import StringIO
5 |
6 | from cura.CuraApplication import CuraApplication
7 | from cura.PrinterOutput.NetworkedPrinterOutputDevice import NetworkedPrinterOutputDevice, AuthState
8 | from cura.PrinterOutput.PrinterOutputDevice import ConnectionState
9 |
10 | from UM.Logger import Logger
11 | from UM.Message import Message
12 | from UM.FileHandler.WriteFileJob import WriteFileJob
13 |
14 | from .qt_comp import *
15 | from .GCodeWriter import SM2GCodeWriter
16 |
17 |
18 | class SM2OutputDevice(NetworkedPrinterOutputDevice):
19 |
20 | def __init__(self, device_id, address, token, properties={}, **kwargs):
21 | assert "@" in device_id
22 | super().__init__(device_id, address, properties, **kwargs)
23 |
24 | self._name, self._model = device_id.rsplit("@", 1)
25 | self._token = token
26 |
27 | self._filename = ""
28 | self._api_prefix = ":8080/api/v1"
29 | self._gcode_stream = StringIO()
30 |
31 | self.setPriority(2)
32 | self.setShortDescription("Send to {}".format(self._address)) # button
33 | self.setDescription("Send to {}".format(self._id)) # pop menu
34 | self.setConnectionText("Connected to {}".format(self._id))
35 |
36 | self.authenticationStateChanged.connect(
37 | self._onAuthenticationStateChanged)
38 | self.connectionStateChanged.connect(self._onConnectionStateChanged)
39 | self.writeFinished.connect(self._byebye)
40 |
41 | self._progress = PrintJobUploadProgressMessage(self)
42 | self._need_auth = PrintJobNeedAuthMessage(self)
43 |
44 | def getToken(self) -> str:
45 | return self._token
46 |
47 | def setToken(self, token: str):
48 | self._token = token
49 |
50 | def getModel(self) -> str:
51 | return self._model
52 |
53 | def setDeviceStatus(self, status: str):
54 | Logger.debug("%s setDeviceStatus: %s, last state: %s", self.getId(),
55 | status, self.connectionState)
56 | if status == "IDLE":
57 | if self.connectionState != ConnectionState.Connected:
58 | self.setConnectionState(ConnectionState.Connected)
59 | elif status in ("RUNNING", "PAUSED", "STOPPED"):
60 | if self.connectionState != ConnectionState.Busy:
61 | self.setConnectionState(ConnectionState.Busy)
62 |
63 | def _onConnectionStateChanged(self, id):
64 | Logger.debug("onConnectionStateChanged: id: %s, state: %s", id,
65 | self.connectionState)
66 | if id != self.getId():
67 | return
68 |
69 | if (self.connectionState == ConnectionState.Connected
70 | and self.authenticationState == AuthState.Authenticated):
71 | if self._sending_gcode and not self._progress.visible:
72 | self._progress.show()
73 | self._upload()
74 |
75 | def _onAuthenticationStateChanged(self):
76 | if self.authenticationState == AuthState.Authenticated:
77 | self._need_auth.hide()
78 | elif self.authenticationState == AuthState.AuthenticationRequested:
79 | self._need_auth.show()
80 | elif self.authenticationState == AuthState.AuthenticationDenied:
81 | self._token = ""
82 | self._sending_gcode = False
83 | self._need_auth.hide()
84 |
85 | def requestWrite(self,
86 | nodes,
87 | file_name=None,
88 | limit_mimetypes=False,
89 | file_handler=None,
90 | filter_by_machine=False,
91 | **kwargs) -> None:
92 | if self.connectionState == ConnectionState.Busy:
93 | Message(title="Unable to upload",
94 | text="{} is busy.".format(self.getId())).show()
95 | return
96 |
97 | if self._progress.visible or self._need_auth.visible:
98 | Logger.info("Still working in progress.")
99 | return
100 |
101 | # reset
102 | self._sending_gcode = True
103 | self.setConnectionState(ConnectionState.Closed)
104 | self.setAuthenticationState(AuthState.NotAuthenticated)
105 |
106 | self.writeStarted.emit(self)
107 | self._gcode_stream = StringIO()
108 | job = WriteFileJob(SM2GCodeWriter(), self._gcode_stream, nodes,
109 | SM2GCodeWriter.OutputMode.TextMode)
110 | job.finished.connect(self._onWriteJobFinished)
111 |
112 | message = Message(title="Preparing for upload",
113 | progress=-1,
114 | lifetime=0,
115 | dismissable=False,
116 | use_inactivity_timer=False)
117 | message.show()
118 |
119 | job.setMessage(message)
120 | job.start()
121 |
122 | def _onWriteJobFinished(self, job):
123 | self._hello()
124 |
125 | def _queryParams(self) -> List[QHttpPart]:
126 | return [
127 | self._createFormPart('name=token', self._token.encode()),
128 | self._createFormPart('name=_', "{}".format(time.time()).encode())
129 | ]
130 |
131 | def _hello(self) -> None:
132 | self.postFormWithParts("/connect", self._queryParams(),
133 | self._onRequestFinished)
134 |
135 | def _byebye(self):
136 | if self._token:
137 | self.postFormWithParts(
138 | "/disconnect", self._queryParams(),
139 | lambda r: self.setConnectionState(ConnectionState.Closed))
140 |
141 | def checkStatus(self):
142 | url = "/status?token={}&_={}".format(self._token, time.time())
143 | self.get(url, self._onRequestFinished)
144 |
145 | def _upload(self):
146 | Logger.debug("Start upload to {}".format(self._name))
147 | if not self._token:
148 | return
149 |
150 | print_info = CuraApplication.getInstance().getPrintInformation()
151 | job_name = print_info.jobName.strip()
152 | print_time = print_info.currentPrintTime
153 | material_name = "-".join(print_info.materialNames)
154 |
155 | self._filename = "{}_{}_{}.gcode".format(
156 | job_name, material_name,
157 | "{}h{}m{}s".format(print_time.days * 24 + print_time.hours,
158 | print_time.minutes, print_time.seconds))
159 |
160 | parts = self._queryParams()
161 | parts.append(
162 | self._createFormPart(
163 | 'name=file; filename="{}"'.format(self._filename),
164 | self._gcode_stream.getvalue().encode()))
165 | self._gcode_stream.close()
166 | self.postFormWithParts("/upload",
167 | parts,
168 | on_finished=self._onRequestFinished,
169 | on_progress=self._onUploadProgress)
170 |
171 | def _onUploadProgress(self, bytes_sent: int, bytes_total: int):
172 | if bytes_total > 0:
173 | perc = (bytes_sent / bytes_total) if bytes_total else 0
174 | self._progress.setProgress(perc * 100)
175 | self.writeProgress.emit()
176 |
177 | def _onRequestFinished(self, reply: QNetworkReply) -> None:
178 | http_url = reply.url().toString()
179 |
180 | if reply.error() not in (
181 | QNetworkReplyNetworkErrors.NoError,
182 | QNetworkReplyNetworkErrors.
183 | AuthenticationRequiredError # 204 is No Content, not an error
184 | ):
185 | Logger.warning("Error %d from %s", reply.error(), http_url)
186 | self.setConnectionState(ConnectionState.Closed)
187 | Message(title="Error",
188 | text=reply.errorString(),
189 | lifetime=0,
190 | dismissable=True).show()
191 | return
192 |
193 | http_code = reply.attribute(
194 | QNetworkRequestAttributes.HttpStatusCodeAttribute)
195 | Logger.info("Request: %s - %d", http_url, http_code)
196 | if not http_code:
197 | return
198 |
199 | http_method = reply.operation()
200 | if http_method == QNetworkAccessManagerOperations.GetOperation:
201 | if self._api_prefix + "/status" in http_url:
202 | if http_code == 200:
203 | self.setAuthenticationState(AuthState.Authenticated)
204 | resp = self._jsonReply(reply)
205 | device_status = resp.get("status", "UNKNOWN")
206 | self.setDeviceStatus(device_status)
207 | elif http_code == 401:
208 | self.setAuthenticationState(AuthState.AuthenticationDenied)
209 | elif http_code == 204:
210 | self.setAuthenticationState(
211 | AuthState.AuthenticationRequested)
212 | else:
213 | self.setAuthenticationState(AuthState.NotAuthenticated)
214 |
215 | elif http_method == QNetworkAccessManagerOperations.PostOperation:
216 | if self._api_prefix + "/connect" in http_url:
217 | if http_code == 200:
218 | resp = self._jsonReply(reply)
219 | token = resp.get("token")
220 | if self._token != token:
221 | self._token = token
222 | self.checkStatus() # check status and upload
223 |
224 | elif http_code == 403 and self._token:
225 | # expired
226 | self._token = ""
227 | self.connect()
228 | else:
229 | self.setConnectionState(ConnectionState.Closed)
230 | Message(
231 | title="Error",
232 | text=
233 | "Please check the touchscreen and try again (Err: {})."
234 | .format(http_code),
235 | lifetime=10,
236 | dismissable=True).show()
237 |
238 | # elif self._api_prefix + "/disconnect" in http_url:
239 | # self.setConnectionState(ConnectionState.Closed)
240 |
241 | elif self._api_prefix + "/upload" in http_url:
242 | self._progress.hide()
243 | self.writeFinished.emit()
244 | self._sending_gcode = False
245 |
246 | Message(title="Sent to {}".format(self.getId()),
247 | text="Start print on the touchscreen: {}".format(
248 | self._filename),
249 | lifetime=60).show()
250 |
251 | def _jsonReply(self, reply: QNetworkReply):
252 | try:
253 | return json.loads(bytes(reply.readAll()).decode("utf-8"))
254 | except json.decoder.JSONDecodeError:
255 | Logger.warning("Received invalid JSON from snapmaker.")
256 | return {}
257 |
258 |
259 | class PrintJobUploadProgressMessage(Message):
260 |
261 | def __init__(self, device: SM2OutputDevice):
262 | super().__init__(title="Sending to {}".format(device.getId()),
263 | progress=-1,
264 | lifetime=0,
265 | dismissable=False,
266 | use_inactivity_timer=False)
267 | self._device = device
268 | self._gTimer = QTimer()
269 | self._gTimer.setInterval(3 * 1000)
270 | self._gTimer.timeout.connect(lambda: self._heartbeat())
271 | self.inactivityTimerStart.connect(self._startTimer)
272 | self.inactivityTimerStop.connect(self._stopTimer)
273 |
274 | def show(self):
275 | self.setProgress(0)
276 | super().show()
277 |
278 | def update(self, percentage: int):
279 | if not self._visible:
280 | super().show()
281 | self.setProgress(percentage)
282 |
283 | def _heartbeat(self):
284 | self._device.checkStatus()
285 |
286 | def _startTimer(self):
287 | if self._gTimer and not self._gTimer.isActive():
288 | self._gTimer.start()
289 |
290 | def _stopTimer(self):
291 | if self._gTimer and self._gTimer.isActive():
292 | self._gTimer.stop()
293 |
294 |
295 | class PrintJobNeedAuthMessage(Message):
296 |
297 | def __init__(self, device: SM2OutputDevice):
298 | super().__init__(
299 | title="Screen authorization needed",
300 | text="Please tap Yes on Snapmaker touchscreen to continue.",
301 | lifetime=0,
302 | dismissable=True,
303 | use_inactivity_timer=False)
304 | self._device = device
305 | self.setProgress(-1)
306 | self._gTimer = QTimer()
307 | self._gTimer.setInterval(1500)
308 | self._gTimer.timeout.connect(lambda: self._onCheck(None, None))
309 | self.inactivityTimerStart.connect(self._startTimer)
310 | self.inactivityTimerStop.connect(self._stopTimer)
311 |
312 | def _startTimer(self):
313 | if self._gTimer and not self._gTimer.isActive():
314 | self._gTimer.start()
315 |
316 | def _stopTimer(self):
317 | if self._gTimer and self._gTimer.isActive():
318 | self._gTimer.stop()
319 |
320 | def _onCheck(self, *args, **kwargs):
321 | self._device.checkStatus()
322 |
--------------------------------------------------------------------------------
/OutputDevicePlugin.py:
--------------------------------------------------------------------------------
1 | import json
2 | import socket
3 | from typing import List, Dict
4 |
5 | from UM.Logger import Logger
6 | from UM.Platform import Platform
7 | from UM.Signal import signalemitter, Signal
8 | from UM.OutputDevice.OutputDevicePlugin import OutputDevicePlugin
9 | from UM.Application import Application
10 |
11 | from .qt_comp import *
12 | from .OutputDevice import SM2OutputDevice
13 |
14 | #MACHINE_SERIES = "Snapmaker A"
15 | DISCOVER_PORT = 20054
16 | DISCOVER_INTERVAL = 6000 # 6 seconds
17 |
18 |
19 | @signalemitter
20 | class DiscoverSocket:
21 | dataReady = Signal()
22 |
23 | def __init__(self, address_entry: QNetworkAddressEntry) -> None:
24 | self._address_entry = address_entry
25 | self._broadcast_address = address_entry.broadcast()
26 |
27 | self._socket = None # internal socket
28 |
29 | self._collect_timer = QTimer()
30 | self._collect_timer.setInterval(200)
31 | self._collect_timer.setSingleShot(True)
32 | self._collect_timer.timeout.connect(self.__collect)
33 |
34 | @property
35 | def address(self) -> QHostAddress:
36 | return self._address_entry.ip()
37 |
38 | def bind(self) -> bool:
39 | sock = QUdpSocket()
40 |
41 | bind_result = sock.bind(self._address_entry.ip(),
42 | mode=QAbstractSocket.BindFlag.DontShareAddress
43 | | QAbstractSocket.BindFlag.ReuseAddressHint)
44 | if not bind_result:
45 | return False
46 |
47 | if Platform.isWindows():
48 | # On Windows, QUdpSocket is unable to receive broadcast data, we use original socket instead
49 | sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM,
50 | socket.IPPROTO_UDP)
51 | sock.settimeout(0.2)
52 | sock.setsockopt(socket.SOL_SOCKET, socket.SO_BROADCAST, 1)
53 | sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
54 | sock.setsockopt(socket.IPPROTO_IP, socket.IP_MULTICAST_TTL, 255)
55 | self._socket = sock
56 | else:
57 | # On Unix, we use socket interface provided by Qt 6
58 | self._socket = sock
59 | sock.readyRead.connect(self.__read)
60 |
61 | return True
62 |
63 | def discover(self, message: bytes) -> None:
64 | if isinstance(self._socket, QUdpSocket):
65 | self._socket.writeDatagram(message, self._broadcast_address,
66 | DISCOVER_PORT)
67 | else:
68 | self._socket.sendto(
69 | message, (self._broadcast_address.toString(), DISCOVER_PORT))
70 | self._collect_timer.start()
71 |
72 | def abort(self) -> None:
73 | if not self._socket:
74 | return
75 |
76 | if isinstance(self._socket, QUdpSocket):
77 | self._socket.abort()
78 | else:
79 | self._socket.close()
80 |
81 | self._socket = None
82 |
83 | def __read(self) -> None:
84 | while self._socket.hasPendingDatagrams():
85 | data = self._socket.receiveDatagram()
86 | if data.isValid() and not data.senderAddress().isNull():
87 | try:
88 | message = bytes(data.data()).decode("utf-8")
89 | self.dataReady.emit(message)
90 | except UnicodeDecodeError as e:
91 | Logger.error("error decoding data: %s", e)
92 | pass
93 |
94 | def __collect(self) -> None:
95 | # the socket has abort and discover is cancelled
96 | if not self._socket:
97 | return
98 |
99 | if isinstance(self._socket, QUdpSocket):
100 | return
101 |
102 | while True:
103 | try:
104 | msg, _ = self._socket.recvfrom(128)
105 | except (TimeoutError, ConnectionError, socket.timeout) as e:
106 | Logger.error("error receiving data: %s", e)
107 | # normal timeout, or ConnectionError (including ConnectionAbortedError, ConnectionRefusedError,
108 | # ConnectionResetError) errors raise by the peer
109 | break
110 |
111 | try:
112 | message = msg.decode("utf-8")
113 | self.dataReady.emit(message)
114 | except UnicodeDecodeError as e:
115 | Logger.error("error decoding data: %s", e)
116 | pass
117 |
118 |
119 | class SM2OutputDevicePlugin(OutputDevicePlugin):
120 | PREFERENCE_KEY_TOKEN = "Snapmaker2PluginSettings/tokens"
121 |
122 | def __init__(self) -> None:
123 | super().__init__()
124 |
125 | self._discover_timer = QTimer()
126 | self._discover_timer.setInterval(DISCOVER_INTERVAL)
127 | self._discover_timer.setSingleShot(False)
128 | self._discover_timer.timeout.connect(self.__discover)
129 |
130 | self._discover_sockets = [] # type: List[QUdpSocket]
131 | self._tokens = {} # type: Dict[str, str]
132 |
133 | Application.getInstance().globalContainerStackChanged.connect(
134 | self._onGlobalContainerStackChanged)
135 | Application.getInstance().applicationShuttingDown.connect(self.stop)
136 |
137 | def _loadTokens(self) -> None:
138 | preferences = Application.getInstance().getPreferences()
139 | preferences.addPreference(self.PREFERENCE_KEY_TOKEN, "{}")
140 |
141 | try:
142 | self._tokens = json.loads(
143 | preferences.getValue(self.PREFERENCE_KEY_TOKEN))
144 | except ValueError:
145 | pass
146 |
147 | if not isinstance(self._tokens, dict):
148 | self._tokens = {}
149 |
150 | Logger.debug("(%d) tokens loaded.", len(self._tokens.keys()))
151 |
152 | def _saveTokens(self) -> None:
153 | updated = False
154 | devices = self.getOutputDeviceManager().getOutputDevices()
155 |
156 | for d in devices:
157 | if isinstance(d, SM2OutputDevice) and d.getToken():
158 | ex_token = self._tokens.get(d.getId(), "")
159 | if not ex_token or ex_token != d.getToken():
160 | self._tokens[d.getId()] = d.getToken()
161 | updated = True
162 |
163 | if updated:
164 | try:
165 | Application.getInstance().getPreferences().setValue(
166 | self.PREFERENCE_KEY_TOKEN, json.dumps(self._tokens))
167 | Logger.debug("(%d) tokens saved.", len(self._tokens.keys()))
168 | except ValueError:
169 | self._tokens = {}
170 |
171 | def _deviceId(self, name, model) -> str:
172 | return "{}@{}".format(name, model)
173 |
174 | def __prepare(self) -> None:
175 | self._discover_sockets = []
176 | for interface in QNetworkInterface.allInterfaces():
177 | for address_entry in interface.addressEntries():
178 | address = address_entry.ip()
179 | if address.isLoopback():
180 | continue
181 | if address.protocol() != QIPv4Protocol:
182 | continue
183 |
184 | sock = DiscoverSocket(address_entry)
185 | if sock.bind():
186 | Logger.info(
187 | "Discovering printers on network interface: %s",
188 | address.toString())
189 | sock.dataReady.connect(self.__onData)
190 | self._discover_sockets.append(sock)
191 |
192 | def __discover(self) -> None:
193 | if not self._discover_sockets:
194 | self.__prepare()
195 |
196 | for sock in self._discover_sockets:
197 | Logger.debug("Discovering networked printer... (interface: %s)",
198 | sock.address.toString())
199 | sock.discover(b"discover")
200 |
201 | self._saveTokens() # TODO
202 |
203 | # TODO: remove output devices that not reply message for a period of time
204 |
205 | def __onData(self, msg: str) -> None:
206 | """Parse message.
207 |
208 | msg: Snapmaker-DUMMY@127.0.0.1|model:Snapmaker 2 Model A350|status:IDLE
209 | """
210 | Logger.debug("got msg: %s", msg)
211 | parts = msg.split("|")
212 | if len(parts) < 1 or "@" not in parts[0]:
213 | # invalid message
214 | return
215 |
216 | name, address = parts[0].rsplit("@", 1)
217 |
218 | properties = {}
219 | for part in parts[1:]:
220 | if ":" not in part:
221 | continue
222 |
223 | key, value = part.split(":")
224 | properties[key] = value
225 |
226 | model = properties.get("model", "")
227 | Logger.debug("machine model is %s", model)
228 | if not model.startswith("Snapmaker 2"):
229 | return
230 |
231 | device_id = self._deviceId(name, model)
232 |
233 | device = self.getOutputDeviceManager().getOutputDevice(device_id)
234 | if not device:
235 | token = self._tokens.get(device_id, "")
236 | Logger.info("Discovered Snapmaker printer: %s@%s (token: '%s')",
237 | name, address, token)
238 | device = SM2OutputDevice(device_id, address, token, properties)
239 | self.getOutputDeviceManager().addOutputDevice(device)
240 |
241 | def start(self) -> None:
242 | if self._isSM2Container() and not self._discover_timer.isActive():
243 | self._loadTokens()
244 | self._discover_timer.start()
245 | Logger.info("Snapmaker discovering started.")
246 |
247 | def stop(self) -> None:
248 | if self._discover_timer.isActive():
249 | self._discover_timer.stop()
250 |
251 | for sock in self._discover_sockets:
252 | sock.abort()
253 |
254 | # clear all discover sockets
255 | self._discover_sockets.clear()
256 |
257 | self._saveTokens()
258 |
259 | Logger.info("Snapmaker discovering stopped.")
260 |
261 | def startDiscovery(self) -> None:
262 | self.__discover()
263 |
264 | def _onGlobalContainerStackChanged(self) -> None:
265 | if self._isSM2Container():
266 | self.start()
267 | else:
268 | self.stop()
269 |
270 | def _isSM2Container(self) -> bool:
271 | stack = Application.getInstance().getGlobalContainerStack()
272 | if not stack:
273 | return False
274 | machine_name = stack.getProperty("machine_name", "value")
275 | Logger.debug('machine name: %s', machine_name)
276 | return machine_name.startswith("Snapmaker A")
277 |
--------------------------------------------------------------------------------
/README.en-us.md:
--------------------------------------------------------------------------------
1 | [Please click here for Chinese README.md](README.md)
2 | # Snapmaker 2 Plugin for Cura
3 | - Automatically find all Snapmaker 2 devices in your LAN via UDP broadcast.
4 | - Send files directly to the printer over wifi, start printing from touchscreen.
5 | - Model thumbnails are displayed on touchscreen, optimized gcode for printing on Snapmaker 2.
6 |
7 | # Installation
8 | ## Pre-requisites
9 | Install profile from [snapmaker official cura profiles page](https://support.snapmaker.com/hc/en-us/articles/360044341034)
10 |
11 | ## From Cura Marketplace
12 | 1. Click the Marketplace button in upper right of main screen
13 | 2. Scroll though community plugins and click Snapmaker2Plugin icon
14 | 3. Click Install
15 | 4. Agree to GNU General Public License
16 | 5. Quit and restart Cura
17 |
18 | ## From github
19 | 1. Open the Show Configuration Folder from cura's Help menu and go to the plugins folder
20 | 2. It is recommended to clone this repo locally into this location using the command line `git clone https://github.com/macdylan/Snapmaker2Plugin.git` or
21 | 3. Download the zip package for [release](https://github.com/macdylan/Snapmaker2Plugin/releases) and unzip to the folder shown in step 1 (you should now have a folder called `Snapmaker2Plugin` in the `plugins` directory)
22 | 4. Quit and restart Cura
23 |
24 | # Usage
25 | - Click blue slice button in the workspace.
26 | - After slicing a model, the save file / device selection menu appears at the lower right of the worksapce
27 |
28 | 
29 |
30 | - Select the device you want to send and click Send to
31 | - You will only be prompted for this first time after snapmaker starts up.
32 |
33 | 
34 |
35 | - Tap Yes in Snapmaker 2 touchscreen WiFi Connection Request (only required the first time after boot)
36 |
37 | 
38 |
39 | - Wait for file upload process to complete
40 | - Tap start buton on touchscreen
41 | - Navigate to files and choose the file that was just uploaded to your snapmaker
42 |
43 | 
44 |
45 | - Tap start (or adjust settings as needed)
46 |
47 | Once printing has started you can close Cura as all progress is monitored on the Snapmakers touchscreen
48 |
49 | You can also use Save to file in Snapmaker G-code file format to disk if required
50 |
51 | 
52 |
53 | # Troubleshooting Snapmaker Discovery
54 | ⚠️ If your snapmaker name or IP address does not appear try the following steps:
55 | 1. Ensure you snapmaker is connected to wifi by checking your wireless router or checking on the Snapmakers touchscreen
56 | 2. Wait 5-10 seconds, Cura continuously looks for all compatible devices in the LAN and displays them automatically
57 | 3. Restart Snapmaker 2 (poweroff for **at least 15 seconds**) and wait for touchscreen to fully start and ensure it is connected to the right wireless lan
58 | 4. Check your computer's firewall to see if Cura access to the local area network is blocked (win10 is blocked by default)
59 | 5. Check the router settings to see if UDP broadcasting is blocked
60 | 6. If possible, make sure that your computer and the Snapmaker 2 have good wifi reception with your router to eliminate the chance of network issues.
61 |
62 | Please note that the instructions above are valid on firmware 1.12.1 and 1.12.3; touchscreen UI flows do vary by version; also as of writing wifi network connecitvity of the A350 can be unreliable.
63 |
64 |
65 | ---
66 | **__Make Something Wonderful__**
67 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | [Please click here for English README.md](README.en-us.md)
2 | # Snapmaker 2 Plugin for Cura
3 | - 无需配置,通过 UDP 广播自动查找局域网内所有 Snapmaker 2 设备
4 | - 无需保存文件,使用网络直接发送到打印机进行作业
5 | - 提供了 Snapmaker 2 兼容的 GCode 格式:显示缩略图、快速解析打印参数
6 |
7 | # Installation
8 | ## 打印机配置
9 | Cura 4.1 以后已经内置了 Snapmaker 2 的配置文件,参考 https://support.snapmaker.com/hc/en-us/articles/360044341034
10 |
11 | ## 从 Cura Marketplace 安装
12 | 1. 点击 Cura 主界面右上角的 市场 按钮
13 | 2. 点击右边图标,浏览器进入 网上市场,在左侧搜索框检索 Snapmaker2Plugin
14 | 3. 点击安装,确认协议条款等待安装完成
15 | 4. 重启 Cura
16 |
17 | ## 从 Github 安装
18 | 1. 从 Cura 的 Help 菜单下打开 Show Configuration Folder,进入 plugins 文件夹
19 | 2. 推荐使用 `git clone https://github.com/macdylan/Snapmaker2Plugin.git` 进行安装,或
20 | 3. 下载 [release](https://github.com/macdylan/Snapmaker2Plugin/releases) 的 zip 包,解压到该文件夹
21 | 4. 重启 Cura
22 |
23 | # Usage
24 | - 对模型切片后,将在 Save to File 按钮的位置出现设备选择菜单
25 |
26 | 
27 |
28 | - 选择需要发送的设备,点击 Send to
29 | - 从触摸屏进行连接授权
30 | - 等待文件发送完成
31 |
32 | 
33 |
34 | - 在 Snapmaker 2 触摸屏确认进行打印
35 |
36 | 
37 |
38 | 你也可以使用 Save to File,将文件保存为 Snapmaker G-code file(*.gcode) 格式
39 |
40 | 
41 |
42 | 以上说明适用于固件 1.12 后续版本,不同版本的界面可能有所调整。
43 |
44 | # 问题排查
45 | ⚠️ Snapmaker 2 的无线连接有时候不稳定,如果无法出现设备选择菜单,可按如下方法排查:
46 |
47 | 1. 检查 Snapmaker 2 是否已经联网
48 | 2. 检查电脑的防火墙,是否阻止了 Cura 访问局域网(win10 默认会阻止)
49 | 3. 等待 5-10 秒,Cura 会持续查找局域网内所有兼容设备并自动显示
50 | 4. 重启 Snapmaker 2 并等待联网,因为它的应答服务可能挂了
51 | 5. 检查路由器设置,是否阻止了 UDP 广播
52 | 6. 如果可能,确保电脑、Snapmaker 2、路由器尽可能靠近,避免丢包率过高
53 |
54 | 如仍无法解决,请提供 cura.log 文件到 issues 中以便分析,感谢你的帮助。
55 |
56 |
57 | ---
58 | **__Make Something Wonderful__**
59 |
--------------------------------------------------------------------------------
/__init__.py:
--------------------------------------------------------------------------------
1 | from .OutputDevicePlugin import SM2OutputDevicePlugin
2 | from .GCodeWriter import SM2GCodeWriter
3 |
4 |
5 | def getMetaData():
6 | return {
7 | "mesh_writer": {
8 | "output": [{
9 | "extension": "gcode",
10 | "description": "Snapmaker 2 G-code file",
11 | "mime_type": "text/x-gcode",
12 | "mode": SM2GCodeWriter.OutputMode.TextMode
13 | }]
14 | }
15 | }
16 |
17 |
18 | def register(app):
19 | return {
20 | "output_device": SM2OutputDevicePlugin(),
21 | "mesh_writer": SM2GCodeWriter()
22 | }
23 |
--------------------------------------------------------------------------------
/_snapshots/preview.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/macdylan/Snapmaker2Plugin/5bcb5f9d722bcd486b50ad56cda1d9cc5b465dcb/_snapshots/preview.jpg
--------------------------------------------------------------------------------
/_snapshots/savetofile.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/macdylan/Snapmaker2Plugin/5bcb5f9d722bcd486b50ad56cda1d9cc5b465dcb/_snapshots/savetofile.png
--------------------------------------------------------------------------------
/_snapshots/screen_auth.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/macdylan/Snapmaker2Plugin/5bcb5f9d722bcd486b50ad56cda1d9cc5b465dcb/_snapshots/screen_auth.png
--------------------------------------------------------------------------------
/_snapshots/sendto.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/macdylan/Snapmaker2Plugin/5bcb5f9d722bcd486b50ad56cda1d9cc5b465dcb/_snapshots/sendto.png
--------------------------------------------------------------------------------
/_snapshots/touchscreen_auth.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/macdylan/Snapmaker2Plugin/5bcb5f9d722bcd486b50ad56cda1d9cc5b465dcb/_snapshots/touchscreen_auth.jpg
--------------------------------------------------------------------------------
/plugin.json:
--------------------------------------------------------------------------------
1 | {
2 | "version": "8.1.0",
3 | "name": "Snapmaker 2.0 Connection",
4 | "description": "Provides support for Snapmaker 2.0",
5 | "author": "https://github.com/macdylan",
6 | "supported_sdk_versions": [
7 | "5.0.0",
8 | "6.0.0",
9 | "7.0.0",
10 | "8.0.0"
11 | ],
12 | "api": 5
13 | }
14 |
--------------------------------------------------------------------------------
/qt_comp.py:
--------------------------------------------------------------------------------
1 |
2 | try:
3 | from PyQt6.QtCore import QTimer, pyqtProperty, pyqtSignal
4 | from PyQt6.QtNetwork import (
5 | QHttpPart,
6 | QUdpSocket,
7 | QNetworkInterface,
8 | QAbstractSocket,
9 | QNetworkAddressEntry,
10 | QHostAddress,
11 | QNetworkRequest,
12 | QNetworkAccessManager,
13 | QNetworkReply
14 | )
15 | QIPv4Protocol = QAbstractSocket.NetworkLayerProtocol.IPv4Protocol
16 | QNetworkAccessManagerOperations = QNetworkAccessManager.Operation
17 | QNetworkRequestAttributes = QNetworkRequest.Attribute
18 | QNetworkReplyNetworkErrors = QNetworkReply.NetworkError
19 | except ImportError:
20 | from PyQt5.QtCore import QTimer, pyqtProperty, pyqtSignal
21 | from PyQt5.QtNetwork import (
22 | QHttpPart,
23 | QNetworkRequest,
24 | QNetworkAccessManager,
25 | QNetworkReply,
26 | QUdpSocket,
27 | QNetworkInterface,
28 | QAbstractSocket,
29 | QNetworkAddressEntry,
30 | QHostAddress
31 | )
32 | QNetworkAccessManagerOperations = QNetworkAccessManager
33 | QNetworkRequestAttributes = QNetworkRequest
34 | QNetworkReplyNetworkErrors = QNetworkReply
35 | if hasattr(QAbstractSocket, 'IPv4Protocol'):
36 | QIPv4Protocol = QAbstractSocket.IPv4Protocol
37 | else:
38 | QIPv4Protocol = QAbstractSocket.NetworkLayerProtocol.IPv4Protocol
39 |
--------------------------------------------------------------------------------