CONTROLS/Macros - Revision history

Tanderson at 18:55, 4 September 2018

2018-09-04T18:55:42Z

Tanderson: /* Commands */

2018-08-29T23:19:32Z

‎Commands

Tanderson: table of script parameters

2018-08-29T22:02:31Z

table of script parameters

Larsbrubaker: clarity

2017-03-14T17:41:21Z

clarity

Larsbrubaker: new scripting commands

2017-03-14T17:40:18Z

new scripting commands

MatterHackers: /* Commands */

2016-12-23T18:17:47Z

‎Commands

MatterHackers: /* Commands */

2016-12-23T18:16:42Z

‎Commands

MatterHackers at 18:14, 23 December 2016

2016-12-23T18:14:43Z

MatterHackers: MatterHackers moved page Controls/Macros to CONTROLS/Macros

2016-12-01T21:04:44Z

MatterHackers moved page Controls/Macros to CONTROLS/Macros

MatterHackers at 00:22, 16 January 2016

2016-01-16T00:22:05Z

← Older revision		Revision as of 18:55, 4 September 2018
Line 1:		Line 1:
		+	{{Migrated\|printer-controls/macros}}
	__NOTOC__{{DISPLAYTITLE:Macros}}Macros are snippets of saved code which can be called with the click of a button instead of having to be typed repeatedly.		__NOTOC__{{DISPLAYTITLE:Macros}}Macros are snippets of saved code which can be called with the click of a button instead of having to be typed repeatedly.

@@ Line 79: / Line 79: @@
 Optional parameter variables (content must be in quotes):
 {| class="wikitable"
 |-
 | title || Main text to show || <pre>title:"Trim Filament"</pre>
@@ Line 84: / Line 86: @@
 | markdown || The contents of the message in Markdown formatted text. May contain images from the internet. Use <br> for line breaks || <pre>markdown:"Trim the end of the filament to ensure a good load.<br>![](https://www.matterhackers.com/r/c3zLyf)<br>Make sure you trim it at a slight angle."</pre>
 |-
-| Example || Example || Example
+| wait_ok || Script execution will wait for the user to click 'Continue' || <pre>wait_ok:"true"</pre>
 |-
-| Example || Example || Example
+| repeat_gcode || G-Code to repeat until expire time reached. Lines can be separated with a <nowiki>|</nowiki>. || <pre>repeat_gcode:"G1 E.1 F150|G4 P10"</pre>
 |-
-| Example || Example || Example
+| expire || The max amount of time to run repeate_gcode or show this message (seconds) || <pre>expire:"300"</pre>
 |-
-| Example || Example || Example
+| count_down || Show a timer counting down from this time || <pre>count_down:"28"</pre>
-|-
-| Example || Example || Example
 |}
 <code>choose_material</code>
@@ Line 108: / Line 101: @@
 Optional parameter variables (content must be in quotes):
 *title: [main text to show]
 === Example Script ===

@@ Line 78: / Line 78: @@
 Optional parameter variables (content must be in quotes):
-*title: [main text to show]
+*: [the contents of the message in Markdown formatted text]
 *image: [a url of the image you wish to show]
 *wait_ok: [script execution will wait for the user to click 'ok']

@@ Line 96: / Line 96: @@
 === Example Script ===
-The following box shows an example of a script used for loading filament:
+The following is an example of a script used for loading filament:
 <pre>; host.choose_material(title:"Choose the material that you are loading.")

@@ Line 49: / Line 49: @@
 Click the '''Cancel''' button to discard changes.
-== Macro Scripting ==
+== Macro Scripting (Starting in version 1.7) ==
 Macro Scripting allows for the use of advanced functions in macros. These functions are called by using commands.
@@ Line 57: / Line 57: @@
 To use a macro scripting command, begin the line with the following function:
-<code>; Command:</code>
+<code>; host.:</code>
 Then add a command and any applicable parameters.
-<code>; Command:[command] "[parameters]"</code>
+<code>; command([parameters])"</code>
 The result should look something like this:
-<code>; Command:Message "Waiting for extruder to heat to [temperature]."</code>
+<code>; host.show_message(title:"Waiting for extruder to heat to [temperature].")</code>
 === Commands ===
-<code>Message</code>
+<code>ding()</code>
 Shows the specified message.
-Optional parameter variables:
+Optional parameter variables (content must be in quotes):
-*ExpectedSeconds: [time]
+*title: [main text to show]
-*ExpectedTemperature: [temp]
+*image: [a url of the image you wish to show]
-<code>ChooseMaterial</code>
+<code>choose_material</code>
 Shows the choose material window.
-<code>WaitOK</code>
+Optional parameter variables (content must be in quotes):
-Show the specified message and waits for user to click OK to continue sending code.
+*title: [main text to show]
 === Example Script ===
@@ Line 90: / Line 98: @@
 The following box shows an example of a script used for loading filament:
-<pre>; Command:ChooseMaterial "Choose the material that you are loading."
+<pre>; host.choose_material(title:"Choose the material that you are loading.")
 M104 S[temperature] ; start heating up the extruder
 M302 S0  ; Allow extrusion at any temperature
-; Command:WaitOK "Put filament into extruder and click Continue."
+G91                 ; Relative positioning
-; Command:Message "Loading filament..." ExpectedSeconds:28
+; host.show_message(title:"Put filament into extruder and click Continue.", repeat_gcode:"G1 E.1 F150|G4 P10", expire:"90", image:"https://s3.amazonaws.com/cdn.freshdesk.com/data/helpdesk/attachments/production/5035400628/original/20150903_115628.jpg?1441307271")
 G92 E0              ; reset the extruder position to 0
 G91                 ; Relative positioning
@@ Line 108: / Line 119: @@
 M302 S150  ; Set cold extrude temp back to reasonable
-; Command:Message "Waiting for extruder to heat to [temperature]."
+; host.show_message(title:"Waiting for extruder to heat to [temperature].")
 M109 S[temperature] ; heat up the extruder
 ; extrude slowly so that we can prime the extruder
-G1 E100 F300        ; extrude the filament slowly
+; host.show_message(title:"Click 'Continue' when filament is running cleanly.", repeat_gcode:"G1 E1 F300|G4 P10", expire:"90")
 G4 S1               ; wait for move to finish
@@ Line 119: / Line 129: @@
 G92 E0              ; reset the extruder position to 0
-M104 S0             ; turn the extruder temperatuer off</pre>
+M104 S0             ; turn the extruder temperature off
 [[Category:Controls]]
 [[Category:Features]]

← Older revision	Revision as of 21:04, 1 December 2016
(No difference)

← Older revision		Revision as of 00:22, 16 January 2016
Line 49:		Line 49:
	Click the '''Cancel''' button to discard changes.		Click the '''Cancel''' button to discard changes.

		+	[[Category:Controls]]
	[[Category:Features]]		[[Category:Features]]