Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
player [2017/01/25 18:37]
arthur
player [2020/05/21 13:41] (current)
wolfmanjm [Playing G-code files]
Line 1: Line 1:
 += Playing G-code files
 +
 The Player module allows you to play files from the SD card.  The Player module allows you to play files from the SD card. 
  
Line 4: Line 6:
  
 Mac users beware: it appears that the play function does not accept files that have a space in their name.  Mac users beware: it appears that the play function does not accept files that have a space in their name. 
 +
 +Files on sdcard **MUST** be line terminated by ''​\n''​ **ONLY**, not ''​\r''​ (Note for MAC users).
 +On the very latest version of smoothieware it will tolerate ''​\r\n''​ terminated lines.
 +
  
 == Configuration == Configuration
Line 9: Line 15:
 Here are all the available options for the Player module Here are all the available options for the Player module
  
-||~ Option ​||~ Example value ||~ Explanation ​||+Option ​Example value Explanation ​^
 {{page>​player-options}} {{page>​player-options}}
  
Line 16: Line 22:
 Here are all the available commands for the Player module Here are all the available commands for the Player module
  
-=== <​kbd>​play</​kbd>​ +<​html><​h3>​<​kbd>​play</​kbd><​/h3></html>
-You can use the « <kbd>play</kbd» command to execute files stored on the SD card.+
  
-You must specify a file name and its path, for example : +You can use the <​kbd>​play</​kbd>​ command to execute files stored on the SD card.
  
-[[code]]+You must specify a file name and its path, for example : 
 + 
 +<code>
 play /​sd/​gcodefile.gcode play /​sd/​gcodefile.gcode
-[[/code]]+</code>
  
-By default, the command will be quiet. If you want the command to output every G-code in the file to the serial port ( the command was called from ), add the <​kbd>​-v</​kbd>​ ( verbose ) parameter : +By default, the command will be quiet. If you want the command to output every G-code in the file to the serial port ( the command was called from ), add the <​kbd>​-v</​kbd>​ ( verbose ) parameter :
  
-[[code]]+<code>
 play /​sd/​gcodefile.gcode -v play /​sd/​gcodefile.gcode -v
-[[/code]]+</code>
 <callout type="​warning"​ icon="​true"​ title="​ Pronterface">​ <callout type="​warning"​ icon="​true"​ title="​ Pronterface">​
  
 Pronterface will ignore commands it does not understand, unless you prefix them with <​kbd>​@</​kbd>​. Pronterface will ignore commands it does not understand, unless you prefix them with <​kbd>​@</​kbd>​.
  
-Therefore, send your command as Â« <​kbd>​@play /​sd/​gcodefile.gcode</​kbd> ​» and it will work+Therefore, send your command as <​kbd>​@play /​sd/​gcodefile.gcode</​kbd>​ and it will work
 </​callout>​ </​callout>​
 <callout type="​danger"​ icon="​true"​ title="​ Repetier">​ <callout type="​danger"​ icon="​true"​ title="​ Repetier">​
Line 45: Line 52:
 </​callout>​ </​callout>​
  
-===  ​<​kbd>​progress</​kbd>​+ 
 +<​html><​h3>​<​kbd>​progress</​kbd></​h3></​html>
 When a file is playing, you can use the <​kbd>​progress</​kbd>​ command to get a report of the current position in the file, and elapsed time. When a file is playing, you can use the <​kbd>​progress</​kbd>​ command to get a report of the current position in the file, and elapsed time.
  
-===  ​<​kbd>​abort</​kbd>​+<​html><​h3>​<​kbd>​abort</​kbd></​h3></​html>
 You can also use the <​kbd>​abort</​kbd>​ command to stop the execution of the file. You can also use the <​kbd>​abort</​kbd>​ command to stop the execution of the file.
  
-=== <​kbd>​suspend</​kbd>​+<​html><​h3>​<​kbd>​suspend</​kbd></​h3></​html>
  
 Can be used for either sd card playing or when streaming from [[Pronterface]] or Octoprint. Can be used for either sd card playing or when streaming from [[Pronterface]] or Octoprint.
Line 69: Line 77:
  
 **NOTE** Issuing a home after a suspend will cancel the suspend and you will not be able to resume. **NOTE** Issuing a home after a suspend will cancel the suspend and you will not be able to resume.
 +
 +**NOTE** the queue must drain before it will suspend, if you need to have the system suspend quicker the only way to do it is to set the config variable ''​mm_per_line_segment 1''​ this will mean it will stop within 32mm, but there is a performance penalty for segmenting when you do not need to.
  
 {{page>​stopping-smoothie}} {{page>​stopping-smoothie}}
  
-=== <​kbd>​resume</​kbd>​+<​html><​h3>​<​kbd>​resume</​kbd></​h3></​html>
  
 Will resume a suspended print it does the following... Will resume a suspended print it does the following...
Line 83: Line 93:
 == G-codes == G-codes
  
-The following G-codes are supported by the Player module : +The following G-codes are supported by the Player module :
  
 * <​kbd>​M21</​kbd>​ : Initialize the SD card. This does nothing in Smoothie but is kept for compatibility * <​kbd>​M21</​kbd>​ : Initialize the SD card. This does nothing in Smoothie but is kept for compatibility
Line 93: Line 103:
 * <​kbd>​M32</​kbd>​ : Select a file, and start playing it, for example :​ <​kbd>​M32 file.gcode</​kbd>​ * <​kbd>​M32</​kbd>​ : Select a file, and start playing it, for example :​ <​kbd>​M32 file.gcode</​kbd>​
 * <​kbd>​M600</​kbd>​ : Suspend print in progress (use console command resume or M601 to continue) * <​kbd>​M600</​kbd>​ : Suspend print in progress (use console command resume or M601 to continue)
 +* <​kbd>​M600.1</​kbd>​ : Suspend print in progress, but leave heaters on
 * <​kbd>​M601</​kbd>​ : Resume print after suspend * <​kbd>​M601</​kbd>​ : Resume print after suspend