Gcode

This page describes the RepRapFirmware supported G-codes, originally based on the information from the [http://reprap.org/wiki/G-code RepRap wiki G-code page].

This page describes the RepRapFirmware supported G-codes, originally based on the information from the http://reprap.org/wiki/G-code.

G-Codes are a widely used machine control language. They are human readable and editable. RepRapFirmware follows the philosophy of "G-code everywhere", in essence the users or external program's interaction with the firmware should be through G-codes. There are G-codes for all supported control and configuration inputs along with status and debugging information.

There are some G-Codes listed on the http://reprap.org/wiki/G-code that are not implemented in RepRapFirmware. More details can be found on the G-Codes not implemented page.

-----

A typical piece of G-code sent to a machine running RepRapFirmware might look like this (The meaning of these codes (and more) is explained below on this page.)

G10 P0 S195 R175
T0
G1 X100 Y100 Z0.3 F3000
G1 X100.4 Y99.3 E0.23 F600
...many 1000 more lines...

-----

A design philosophy of RepRapFirmware is "G-code everywhere" what this means is explained in this sub section

The G-code can originate from a number of sources:

Sent to over USB (for example from http://www.pronterface.com/)
Sent by the Duet Web Control Web (DWC) Interface
Sent by an external controller such as the PanelDue.

In all cases the G-Code could

be entered by user one line at time, for example during configuration or testing
be sent by the User Interface (Pronterface, Web Interface or PanelDue) in response to the user pressing buttons
originate from macros that are triggered on startup, on certain events (such as error conditions), or called by the user or UI.
be from a g-code file which are normally stored on the on-board or external SD card.

A key difference from other 3d printer firmwares is not employing a separate command set (other than G-codes) to configure the printer. To that end RepRapFirmware has a large collection of configuration g-codes that allow the behaviour of the machine to be controlled. For some examples of when these G-Codes are employed have a look at these wiki pages:

The advantage of "G-code everywhere" is the same commands can be send from any of the G-Code sources, and originate from the user, a UI, macro or file and it will generate the same response from the firmware. This greatly improves the ease and power of firmware configuration and operation.

-----

This section explains the elements that make up a G-Code command.

Comments

G-Code comments begin at a semicolon, and end at the end of the line:

T0 ; This is a comment
G92 E0
''';So is this'''
G28

Alternatively, comments can be enclosed in brackets, but they must start and end on the same line:

G28 (here come the axes to be homed) X Y

Comments and white space will be ignored by RepRapFirmware when executing the G-Code

-----

A RepRap G-Code is a list of fields that are separated by white spaces or line breaks. A field can be interpreted as a command, parameter, or for any other special purpose. It consists of one letter directly followed by a number, or can be only a stand-alone letter (Flag). The letter gives information about the meaning of the field (see the list below in this section). Numbers can be integers (128) or fractional numbers (12.42), depending on context. For example, an X coordinate can take integers (X175) or fractionals (X17.62), but selecting extruder number 2.76 would make no sense. In this description, the numbers in the fields are represented by nnn as a placeholder.

In RepRapFirmware, some parameters can be followed by more than one number, with colon used to separate them. Typically this is used to specify extruder parameters, with one value provided per extruder. If only one value is provided where a value is needed for each extruder, then that value is applied to all extruders.

Letter	Meaning
Gnnn	Standard G-Code command, such as move to a point
Mnnn	RepRap-defined command, such as turn on a cooling fan
Tnnn	Select tool nnn. In RepRap, a tool is typically associated with a nozzle, which may be fed by one or more extruders.
Snnn	Command parameter, such as time in seconds; temperatures; voltage to send to a motor
Pnnn	Command parameter, such as time in milliseconds; proportional (Kp) in PID Tuning
Xnnn	A X coordinate, usually to move to. This can be an Integer or Fractional number.
Ynnn	A Y coordinate, usually to move to. This can be an Integer or Fractional number.
Znnn	A Z coordinate, usually to move to. This can be an Integer or Fractional number.
U,V,W	Additional axis coordinates
Innn	Parameter - X-offset in arc move (Not yet implemented in RepRapFirmware); integral (Ki) in PID Tuning; signal inversion
Jnnn	Parameter - Y-offset in arc move (Not yet implemented in RepRapFirmware)
Dnnn	Parameter - used for diameter; derivative (Kd) in PID Tuning; drive number
Hnnn	Parameter - used for heater number in PID Tuning
Fnnn	Feedrate in mm per minute. (Speed of print head movement)
Rnnn	Parameter - used for temperatures
Qnnn	Parameter - not currently used
Ennn	Length of filament to move through the extruder. This is exactly like X, Y and Z, but for the length of filament to consume.
Nnnn	Line number. Used to request repeat transmission in the case of communications errors. Optional
*nnn	Checksum. Used to check for communications errors. Optional

The original NIST GCode standard requires gcode interpreters to be case-insensitive, except for characters in comments. However, not all 3D printer firmwares conform to this and some recognise uppercase command letters and parameters only.

RepRapFirmware version 1.19 and later is case-insensitive, except for characters within quoted strings. RepRapFirmware version 1.18 and earlier accept only uppercase letters for command and parameter letters.

In RepRapFirmware, quoted strings are permitted anywhere a string parameter is expected. This allows file names, WiFi passwords etc. to contain spaces, semicolons and other characters that would otherwise not be permitted. Double-quote characters are used to delimit the string, and any double-quote character within the string must be repeated.

Unfortunately, many gcode sender programs convert all characters to uppercase and don't provide any means to disable this feature. Therefore, within a quoted-string, the single-quote character is used as a flag to force the following character to lowercase. If you want to include a single quote character in the string, use two single quote characters to represent one single quote character.

Example: to add SSID MYROUTER with password ABCxyz;" 123 to the WiFi network list, use command:

M587 S"MYROUTER" P"ABCxyz;"" 123"

or if you can't send lowercase characters:

M587 S"MYROUTER" P"ABC'X'Y'Z;"" 123"

This is an optional feature that is seldom used as g-code files are normally printed form the on-board SD card.

N: Line number

Example: N123

If present, the line number should be the first field in a line. For G-code stored in files on SD cards the line number is usually omitted.

If checking is supported, the firmware expects line numbers to increase by 1 each line, and if that doesn't happen it is flagged as an error. But you can reset the count using M110 (see below).

*: Checksum

Example: *71

If present, the checksum should be the last field in a line, but before a comment. For G-code stored in files on SD cards the checksum is usually omitted.

If checking is supported, the RepRap firmware checks the checksum against a locally-computed value and, if they differ, requests a repeat transmission of the line of the given number.

Method

Example: N123 [...G Code in here...] *71

The firmware checks the line number and the checksum.

You can leave both of these out - RepRap will still work, but it won't do checking. You have to have both or neither though.

If only one appears, it produces an error.

The checksum "cs" for a G-Code string "cmd" (including its line number) is computed by exor-ing the bytes in the string up to and not including the * character as follows:

int cs = 0;
for(i = 0; cmd[i] != '*' && cmd[i] != NULL; i++)
 cs = cs ^ cmd[i];
cs &= 0xff; // Defensive programming...

and the value is appended as a decimal integer to the command after the * character.

-----

RepRapFirmware allows multiple G- and M-commands to be included in a single line. Each occurrence of G or M on the line that is preceded by a space or tab character and is not inside a quoted string or a command starts a new command.

RepRapFirmware stores some commands in a ring buffer internally for execution. This means that there is no (appreciable) delay while a command is acknowledged and the next transmitted. In turn, this means that sequences of line segments can be plotted without a dwell between one and the next. As soon as one of these buffered commands is received it is acknowledged and stored locally. If the local buffer is full, then the acknowledgement is delayed until space for storage in the buffer is available. PC host programs rely on this for flow control when the controller electronics does not support device level flow control.

Only the G0 to G3 movement commands are buffered by RepRapFirmware. All other G, M or T commands are not buffered. When M555 P6 is used to select nanoDLP compatibility mode, no commands are buffered.

When an unbuffered command is received it is stored, but it is not acknowledged to the host until the buffer is exhausted and then the command has been executed.

----

G0 : Rapid Move
G1 : Controlled *(linear) Move

Usage

Firmware 2.02 and later⁴
- G0 Xnnn Ynnn Znnn Ennn Fnnn Snnn Hnnn
- G1 Xnnn Ynnn Znnn Ennn Fnnn Snnn Hnnn

Firmware 2.01 and earlier
- G0 Xnnn Ynnn Znnn Ennn Fnnn Snnn
- G1 Xnnn Ynnn Znnn Ennn Fnnn Snnn

Parameters

Not all parameters need to be used, but at least one of XYZEF must be used
Xnnn The position to move to on the X axis
Ynnn The position to move to on the Y axis
Znnn The position to move to on the Z axis
Ennn The amount to extrude between the starting point and ending point
Fnnn The feed rate per minute of the move between the starting point and ending point (if supplied)
Hnnn Move type (firmware 2.02 and later only)
Snnn In firmware 2.02 and later, when switched into Laser mode (see M452), this parameter sets the laser power. When not switched into Laser mode, and always in firmware 2.01 and earlier, it defines the move type (see the description of the H parameter).
Rn Return to the coordinates stored in restore point #n (see G60). Any X, Y, Z and other axis parameters in the command are used as offsets from the stored position. Axes not mentioned are not moved, so use offset 0 for axes you want to restore to the stored value. For example, G1 X0 Y0 Z2 will move to 2mm above the position stored in the restore point.

Very important! If you use M452 to put your machine into Laser mode, when upgrading firmware from 2.01 or earlier to 2.02 or later you must replace all S parameters in G0/G1 commands in homing files etc. by H parameters. This is because S is now used to control laser power, for compatibility with programs that generate GCode files for laser cutters.

The meaning of the H parameter (and the S parameter when it is not controlling laser power) is as follows:

H0 no special action (default)
H1 terminate the move when the endstop switch is triggered and set the axis position to the axis limit defined by M208. On delta printers, H1 also selects individual motor mode as for H2. Normally used with relative motor coordinates (see G91).
H2 Individual motor mode. X refers to the X motor, Y refers to the Y motor, and so on. Normally used with relative motor coordinates (see G91).
H3 terminate the move when the endstop switch is triggered and set the axis limit to the current position, overriding the value that was set by M208.

Examples

G0 X12 ;(move to 12mm on the X axis)
G0 F1500 ;(Set the feedrate to 1500mm/minute)
G1 X90.6 Y13.8 E22.4 ;(Move to 90.6mm on the X axis and 13.8mm on the Y axis while extruding 22.4mm of material)

RepRapFirmware treats G0 and G1 in the same way 'except as follows:

On SCARA and similar architectures that normally require linear motion to be approximated by short segments, a single continuous non-segmented movement will be used if this can be done without the print head dropping below the current Z height.
In Laser and CNC mode, G0 moves are executed at the maximum feed rate available, to comply with the NIST GCode standard, This feed rate is set by the M203 command.

Feedrate

G1 F1500
G1 X50 Y25.3 E22.4

In the above example, we set the feedrate to 1500mm/minute on line 1, then move to 50mm on the X axis and 25.3mm on the Y axis while extruding 22.4mm of filament between the two points.

G1 F1500
G1 X50 Y25.3 E22.4 F3000

However, in the above example, we set a feedrate of 1500mm/minute on line 1, then do the move described above accelerating to a feedrate of 3000 mm/minute as it does so. The extrusion will accelerate along with the X and Y movement, so everything stays synchronized.

Feedrate is treated as simply another variable (like X, Y, Z, and E) to be linearly interpolated. This gives complete control over the acceleration and deceleration of the printer head in such a way that ensures that everything moves smoothly together, and the right volume of material is extruded at all points. The feedrate specified may not be reached due to a lower feedrate limit being configured, or the move being too short for the axis to accelerate and decelerate in time.

For CNC users especially: RRF has a default minimum movement speed of 0.5mm/sec. In firmware 2.03 and later this can be changed using the I ('i') parameter of the M203 command.

G0/G1 S and H parameter

Firmware 2.01 and below.
Parameter	Meaning
G1 Xnnn Ynnn Znnn S0	Ignore endstops while moving.
G1 Xnnn Ynnn Znnn S1	Sense endstops while moving. On Delta (only), axis letters refer to individual towers.
G1 Xnnn Ynnn Znnn S2	Ignore endstops while moving. Also ignore if axis has not been homed. On Delta and CoreXY, axis letters refer to individual towers.
G1 Xnnn Ynnn Znnn S3	Sense endstops while measuring axis length, and set the appropriate M208 limit to the measured position at which the endstop switch triggers.
Firmware 2.02 and above, BEFORE M452 Laser Mode.
S parameter behaves as shown above.
Firmware 2.02 and above, BEFORE or AFTER M452 Laser Mode.
Parameter	Meaning
G1 Xnnn Ynnn Znnn H0	Ignore endstops while moving.
G1 Xnnn Ynnn Znnn H1	Sense endstops while moving (ignoring the axis limits). On Delta (only), axis letters refer to individual towers.
G1 Xnnn Ynnn Znnn H2	Ignore endstops while moving. Also ignore if axis has not been homed. On Delta and Core XY, axis letters refer to individual towers.
G1 Xnnn Ynnn Znnn H3	Sense endstops while measuring axis length, setting the appropriate M208 limit to the measured position at which the endstop switch triggers.
Firmware 2.02 and above, AFTER M452 Laser Mode.
S parameter sets laser power with range of 0 to 254. H parameter behaves as shown above.

-----

Supported by firmware 1.18 and later.

Usage

G2 Xnnn Ynnn Innn Jnnn Ennn Fnnn (Clockwise Arc)
G3 Xnnn Ynnn Innn Jnnn Ennn Fnnn (Counter-Clockwise Arc)

Parameters

Xnnn The position to move to on the X axis.
Ynnn The position to move to on the Y axis.
Innn The X coordinate of the arc centre relative to the current X coordinate (optional, ignored if R parameter is present).
Jnnn The Y coordinate of the arc centre relative to the current Y coordinate (optional, ignored if R parameter is present).
Ennn The amount to extrude between the starting point and ending point.
Fnnn The feedrate per minute of the move between the starting point and ending point (optional, defaults to the current feed rate).
Rnnn The radius of the arc (optional)

Either the R parameter must be provided, or at least one of I and J must be provided. To draw a complete circle, define the position of the centre using I and/or J and make X and Y the same as the current X and Y coordinates.

Examples

G2 X90.6 Y13.8 I5 J10 E22.4 (Move in a Clockwise arc from the current point to point (X=90.6,Y=13.8), with a center point at (X=current_X+5, Y=current_Y+10), extruding 22.4mm of material between starting and stopping)
G3 X90.6 Y13.8 I5 J10 E22.4 (Move in a Counter-Clockwise arc from the current point to point (X=90.6,Y=13.8), with a center point at (X=current_X+5, Y=current_Y+10), extruding 22.4mm of material between starting and stopping)
G2 X100 Y50 R200 (draw a clockwise arc with radius 200 from the current position to X=100 Y=50)

Pause the machine for a period of time.

Parameters

Pnnn Time to wait, in milliseconds
Snnn Time to wait, in seconds

Example

G4 P200

In this case sit still doing nothing for 200 milliseconds. During delays the state of the machine (for example the temperatures of its extruders) will still be preserved and controlled.

-----

This form of the G10 command is recognised by having a P, R or S parameter but no L parameter.

Usage

G10 Pnnn Xnnn Ynnn Znnn Rnnn Snnn

Parameters

Pnnn Tool number
Xnnn X offset
Ynnn Y offset
U,V,Wnnn U, V and W axis offsets¹
Znnn Z offset²
Rnnn Standby temperature(s)
Snnn Active temperature(s)

Order dependency

If this command refers to any axes other than X, Y and Z then it must appear later in config.g than the M584 command that creates those additional axes.

Examples:

G10 P2 X17.8 Y-19.3 Z0.0 (sets the offset for tool (or in older implementations extrude head) 2 to the X, Y, and Z values specified)
G10 P1 R140 S205 (set standby and active temperatures for tool 1)

Remember that any parameter that you don't specify will automatically be set to the last value for that parameter. That usually means that you want explicitly to set Z0.0. RepRapFirmware will report the tool parameters if only the tool number is specified.

The R value is the standby temperature in ^oC that will be used for the tool, and the S value is its operating temperature. If you don't want the tool to be at a different temperature when not in use, set both values the same. See the T code (select tool) below. In tools with multiple heaters the temperatures for them all are specified thus: R100.0:90.0:20.0 S185.0:200.0:150.0 .

Tool offsets are given as the offset of the nozzle relative to the print head reference point, so the signs are opposite to what you might expect because tool offsets are subtracted from the required printing locations during printing.

M117: Display Message

Example

M117 Hello World

This causes the given message to be shown in the status line on an attached LCD or if no LCD is attached, this message will be reported on the web interface.

M118: Send Message to Specific Target

Supported in RepRapFirmware 1.21 and later.

Parameters

Pnnn Message type (0 = Generic [default], 1 = USB, 2 = PanelDue/UART, 3 = HTTP, 4 = Telnet) (optional)

* S"msg" Message to send

Example

M118 S"Hello Duet"

This code may be used to send messages to a specific target. Basically it is a simple wrapper for RepRapFirmware's Platform::Message method.

Note that the implementation in RepRapFirmware always requires the S-parameter to be passed. If it is omitted, an error will be reported.

Example

M119

Returns the current state of the configured endstops. Takes into account any 'inverted endstop' settings, so one can confirm that the machine is interpreting the endstops correctly.

Example

M120

Push the state of the machine onto a stack. Called automatically when a macro file is run. It pushes the following values on the stack:

Current feedrate
Extruder positions
Whether moves (and separately extrusion) are relative or absolute

Example

M121

Recover the last state pushed onto the stack.

Example

M122

Sending an M122 causes the RepRap to transmit diagnostic information.

M122 can also be used with a P parameter to report specific information. The details vary between releases. As at RepRapFirmware version 2.03 they are:

P1 print summary test report
P100 print a summary of recent moves (only if move logging is enabled in the firmware build)
P101 print the status of an attached DueX expansion board
P102 print how long it takes to evaluate the square root of a 62-bit unsigned integer
P103 print how long it takes to evaluate sine and cosine
P104 print how long it takes to write a file to the SD card (specify the file size in Mbytes in the S parameter, default 10)
P105 print the sizes of various objects used by RepRapFirmware

Note: do not use M122 with a P parameter of 1000 or greater. There are a few values that deliberately cause the firmware to crash, which are used to test the error reporting facilities. As at firmware 2.03 these are:

P1001 cause a watchdog reset
P1002 test what happens when a module gets stuck in a spin loop
P1003 test what happens when we write a blocking message to USB
P1004 test integer division by zero
P1005 test the response to an unaligned memory access
P1006 test the response to accessing an invalid region of memory

RepRapFirmware 3 on Duet 3 supports an additional B parameter, which is the CAN address of the board for which diagnostic information is reported.

Parameters

Snnn Heat sample time in milliseconds

Example

M135 S300

Set the PID to measure temperatures and calculate the power to send to the heaters every 300ms.

NOTE: removed in RRF 2.03beta2

Parameters

Pnnn Bed heater index¹, default 0
Hnnn Heater number
Snnn Active/Target temperature
Rnnn Standby temperature

Examples

M140 S55
M140 S65 R40

The first example sets the temperature of the build bed to 55^oC and returns control to the host immediately (i.e. before that temperature has been reached by the bed). There is an optional R field that sets the bed standby temperature, e.g. to 40^oC in the second example

If the absolute negative temperature (-273 or lower) is passed as target temperature, the bed heater to be switched off

M140 S-273

RepRapFirmware also provides an optional 'H' parameter to set the hot bed heater number(s). If no heated bed is present, a negative value may be specified to disable it. M140 commands with H parameters would normally be used only in the config.g file.

¹ Only supported in RepRapFirmware 1.20 and later. On the Duet 2 WiFi and Duet 2 Ethernet you can configure up to 4 bed heaters.

Parameters

Pnnn Chamber index¹
Hnnn Heater number
Snnn Active/Target temperature
Rnnn Standby temperature

Examples

M141 S30
M141 H0

Set the temperature of the chamber to 30^oC and return control to the host immediately (i.e. before that temperature has been reached by the chamber).

¹ Only supported in RepRapFirmware 1.20 and later.

Parameters

H Heater number (RepRapFirmware 1.17 and later, default 1 which is normally the first hot end)
S Maximum temperature
P Heater protection instance (defaults to H parameter if omitted)¹
X Heater to supervise (by default this is equal to the heater number, can be a virtual heater too)¹
A Action to trigger (0: Generate heater fault [default] 1: Switch off permanently 2: Switch off temporarily)¹
C Condition for temperature event (0: Temperature too high [default] 1: Temperature too low)¹

Examples

M143 S275 ; set the maximum temperature of the hot-end to 275°C
M143 H0 S125 ; set the maximum bed temperature to 125C

The default maximum temperature for all heaters was 300°C prior to RepRapFirmware version 1.13, and 262°C from 1.13. At RepRapFirmware 1.17 the default maximum temperatures were 262C for extruders and 125C for the bed. In more recent versions the default maximum heater temperature is 290C, to allow the hot end to be tightened at 285C as per the E3D recommendation.

When the temperature of the heater exceeds this value a heater error will be triggered.

Note ¹. Supported in RepRapFirmware 1.20-b11+2 and later.

Starting from this version RepRapFirmware allows more granular control over the heater subsystem. By default each heater has one heater protection instance assigned to it, which is by default configured to generate a heater fault if the maximum heater temperature is exceeded.

To control heaters via two thermistors, RepRapFirmware allows the configuration of extra heater elements whose index starts from 100. On the Duet 2 Wifi and Duet 2 Ethernet there are 8 extra heater protections available (100-107).

Example: You have heater 3 mapped to a chamber heater which is supposed to be temporarily turned off when the temperature in it exceeds 65C. The thermistor for the chamber is set up as a virtual heater on channel 104 and can be viewed on the "Extra" panel on DWC (refer to M305 for further details on how to set this up). To achieve this you can configure an extra heater protection with the following gcode:

M143 P100 H3 X104 A2 C0 S65

Parameters

Pnnn Bed index¹
Sn 0 = put bed heater on standby (default), 1 = make bed heater active

Example

M144

Switch the bed to its standby temperature. M144 S1 will set it back to its active temperature.

¹ Only supported in RepRapFirmware 1.20 and later.

Parameters

Rnnn red (0-255)
Unnn green (0-255)
Bnnn blue (0-255)
Ynn brightness (0-31)
Snnn number of LEDs in strip to set, default 30
Fn F1 if further commands for later LEDs in the strip follow; F0 (default) if this command programs the entire strip, or this is the last of several commands to program the strip (causes the next M150 command to start from the beginning of the strip again)

Example

M150 R255 U128 B192 Y16 S100 F0 ; set 100 LEDs to the same colour

This is only supported on controllers that have an output connector for DotStar LEDs.

Range for RGB values is 0-255. The specified RGB values will be sent to the number of LEDs in the LED strip as specified by the S parameter, pushing the existing colours along the strip. To set all the LEDs the same colour, make the S parameter equal to or a little longer than the number of LEDs in the strip.

Parameters

Snnn minimum target temperature, waits while heating
Pnnn Bed index¹
Rnnn accurate target temperature, waits while heating and cooling

Example

M190 S60

Set the temperature of the bed to 60C and wait for the temperature to be reached.

¹ Only supported in RepRapFirmware 1.20 and later.

Parameters

Snnn minimum target temperature, waits while heating
Pnnn Chamber index¹
Rnnn accurate target temperature, waits while heating and cooling

Example

M191 P60

Set the temperature of the build chamber to 60C and wait for the temperature to be reached.

¹ Only supported in RepRapFirmware 1.20 and later.

Parameters

Daaa:bbb:ccc... Sets filament diameter to aaa for extruder 0, bbb for extruder 1 and so on. If any of aaa, bbb etc. are zero then volumetric extrusion is disabled for that extruder.
Daaa Sets filament diameter (or disables volumetric extrusion) for all extruders

Examples

M200 D0 ; disable volumetric extrusion on all extruders
M200 D1.75 ; set all extruder filament diameters to 1.75mm
M200 D1.75:3.0:1.75 ; set extruder 0 to 1.75mm, extruder 1 to 3.0mm and all remaining extruders to 1.75mm

Volumetric extrusion is an option you can set in some slicers whereby all extrusion amounts are specified in mm³ (cubic millimetres) of filament instead of mm of filament. This makes the gcode independent of the filament diameter, potentially allowing the same gcode to run on different printers. The purpose of the M200 command is to inform the firmware that the gcode input files have been sliced for volumetric extrusion, and to provide the filament diameter so that the firmware can adjust the requested extrusion amount accordingly.

Sending M200 without parameters reports the current volumetric extrusion state and (where appropriate) filament diameter for each extruder.

Note that if you use slicer-commanded retraction, the retraction amounts must be specified in mm³ too. If instead you use firmware retraction, then the firmware retraction amounts specified using the M207 command are still interpreted as mm.

This command is supported in RepRapFirmware 1.19beta10 and later.

Parameters

Xnnn Acceleration for X axis
Ynnn Acceleration for Y axis
Znnn Acceleration for Z axis
Unnn Acceleration for U axis
Vnnn Acceleration for V axis
Wnnn Acceleration for W axis
Ennn Acceleration for extruder drives

Order dependency

If this command refers to any axes other than X, Y and Z then it must be later in config.g than the M584 command that creates those additional axes.

Example

M201 X1000 Y1000 Z100 E2000

Sets the acceleration that axes can do in mm/second^2 for print moves. For consistency with the rest of G Code movement this should be in mm/(minute^2), but that gives really silly numbers and one can get lost in all the zeros. So for this we use seconds.

----

To calculate the maximum acceleration values for an axis an online Maximum Acceleration Calculator can be used.

Parameters

Xnnn Maximum feedrate for X axis
Ynnn Maximum feedrate for Y axis
Znnn Maximum feedrate for Z axis
Unnn Maximum feedrate for U axis
Vnnn Maximum feedrate for V axis
Wnnn Maximum feedrate for W axis
Ennn:nnn... Maximum feedrates for extruder drives
Innn Minimum overall movement speed (firmware 2.03 and later), default 30mm/min

Order dependency

If this command refers to any axes other than X, Y and Z then it must be later in config.g than the M584 command that creates those additional axes.

Example

M203 X6000 Y6000 Z300 E10000

Sets the maximum feedrates that your machine can do in mm/min

Parameters

Pnnn Acceleration for printing moves
Tnnn Acceleration for travel moves

Example

M204 P500 T2000

Use M201 to set per-axis accelerations and extruder accelerations. RepRapFirmware applies the M204 accelerations to the move as a whole, and also applies the limits set by M201 to each axis and extruder.

Values are in mm/s².

This command is supported by firmware version 1.18RC1 and later.

Xnnn X axis max instantaneous speed change in mm/sec
Ynnn Y axis max instantaneous speed change in mm/sec
Znnn Z axis max instantaneous speed change in mm/sec
Unnn, Vnnn, Wnnn etc. U, V, W axis max instantaneous speed change in mm/sec

Order dependence

If this command refers to any axes other than X, Y and Z then it must be later in config.g than the M584 command that creates those additional axes.

This command is provided as an alternative to M566 for compatibility with Marlin. In M566 the units are mm/min as with all other speeds. In M205 they are in mm/sec.

Parameters

Xnnn X axis offset
Ynnn Y axis offset
Znnn Z axis offset
Unnn U axis offset
Vnnn V axis offset
Wnnn W axis offset

Order dependency

If this command refers to any axes other than X, Y and Z then it must be later in config.g than the M584 command that creates those additional axes.

Example

M206 X10.0 Y10.0 Z-0.4

The values specified will be subtracted from the coordinates given in G0, G1 and related commands. In firmware builds that support workplace coordinates, this command is equivalent to G10 P1 L2 with the X, Y, Z... parameters negated.

Parameters

Snnn positive length to retract, in mm
Rnnn positive or negative additional length to un-retract, in mm, default zero
Fnnn retraction feedrate, in mm/min
Tnnn feedrate for un-retraction if different from retraction, mm/min (RepRapFirmware 1.16 and later only)
Znnn additional zlift/hop

Example

M207 S4.0 F2400 Z0.075

Sets the retract length used by the G10 and G11 firmware retraction and advance commands.

Parameters

Snnn 0 = set axis maximum (default), 1 = set axis minimum
Xnnn X axis limit
Ynnn Y axis limit
Znnn Z axis limit

Alternative (from RepRapFirmware 2.02/1.23)

Xaaa:bbb X axis minimum and maximum limit
Yaaa:bbb Y axis minimum and maximum limit
Zaaa:bbb Z axis minimum and maximum limit

Order dependence

If this command refers to any axes other than X, Y and Z then it must be later in config.g than the M584 command that creates those additional axes.

Example

M208 X200 Y200 Z90 ; set axis maxima
M208 X-5 Y0 Z0 S1 ; set axis minima
M208 X-5:200 Y0:200 Z0:90 ; set axis minima and maxima

The values specified set the software limits for axis travel in the specified direction. The axis limits you set are also the positions assumed when an endstop is triggered.

Note The M208 minimum Z value applies to deltas. The M208 XY min/max and Z max values don't.

Parameters

Snnn Speed factor override percentage (0..100 or higher)

Example

M220 S80

Sets the speed factor override percentage.

Parameters

Snnn Extrude factor override percentage (0..100 or higher), default 100%
Dnnn Extruder drive number (RepRapFirmware only), default 0

Example

M221 S70
M221 S95 D1

Sets extrude factor override percentage. In the case of RepRapFirmware, sets the extrusion factor percentage for the specified extruder drive only.

Example

M226

Initiates a pause in the same way as if the pause button is pressed. That is, program execution is stopped and the printer waits for user interaction. M226 is intended for use in the GCode file being printed, for example to pause after a particular layer has completed. So it waits until all the moves in the queue have been completed. M25 is intended for use from a different source of GCodes (Like the web interface console, PanelDue or a Macro) so if you need to pause from those use M25 instead.

Send and/or receive data over the i2c bus. Supported in RepRapFirmware 1.21 and later.

Parameters

Ann I2C address
Bnn:nn:nn... Bytes to send (optional in firmware 2.02 and later)
Rnn Number of bytes to receive (optional) - firmware 2.02 and later only

Examples

M260 A5 B65 ; Send 'A' to address 5 now
M260 A"x7F" B65 ; Send 'A' to address 7F (hex)
M260 A0 B82:101:112:82:97:112 ; Send 'RepRap' to address 0
M260 A"x71" B19 R2 ; send 19 to address 71 (hex) and read 2 bytes back

Hex addresses are only supported in firmware 2.02 and later.

Deprecated in RRF 2.02 and later. Use M260 instead.

Parameters

Ann I2C address
Bnn How many bytes to request

Example

M261 A99 B5 ; Request 5 bytes from Address 99

Set servo position absolute.

Parameters

Pnnn Servo index
Snnn Angle or microseconds
I1 Invert polarity

Example

M280 P1 S50

S values below 200 are treated as angles, and 200 or greater as the pulse width in microseconds.

The optional I1 parameter causes the polarity of the servo pulses to be inverted compared to normal for that output pin. The I parameter is not remembered between M280 commands (unlike the I parameter in M106 commands), so if you need inverted polarity then you must include I1 in every M280 command you send.

The servo index is the same as the pin number for the M42 command. See Using servos and controlling unused IO pins for details for the Duet 2 Wifi and Ethernet or the table below for the 0.8.5.

Duet 0.8.5 M280 P value to Expansion Port Pin Mapping
P	Name	Expansion Port Pin
Use M307 H# A-1 C-1 D-1 before using these pins
3	PC4_PWML1	18
4	PC23_PWML6	21
5	PC22_PWML5	22
6	PC21_PWML4	23

Supported in firmware version 1.18 and later.

Parameters

Snnn Amount to baby step Z in mm. Positive values raise the head or lower the bed, negative values do the opposite.
Znnn Synonym for S (RepRapFirmware 1.21 and later)
X,Y,U... Amount to babystep other axes (RRF 2.03 and later)
Rn (Optional, RepRapFirmware 1.21 and later) R1 = relative (add to any existing babystep amount, the default), R0 = absolute (set babystepping offset to the specified amount)

Examples

M290 S0.05 ; babystep the head up 0.05mm
M290 R0 S0 ; clear babystepping (RepRapFirmware 1.21 and later only)

This command tells the printer to apply the specified additional offset to the Z coordinate for all future moves, and to apply the offset to moves that have already been queued if this can be done. Baby stepping is cumulative, for example after M290 S0.1 followed by M290 S-0.02, an offset of 0.08mm is used.

M290 with no parameters reports the accumulated baby stepping offset. Marlin doesn't track accumulated babysteps.

In RepRapFirmware 1.19 and earlier, the babystepping offset is reset to zero when the printer is homed or the bed is probed. In RepRapFirmware 1.21 and later, homing and bed probing don't reset babystepping, but you can reset it explicitly using M290 R0 S0.

M291: Display message and optionally wait for response

Supported in firmware version 1.19 and later.

Parameters

P"message" The message to display, which must be enclosed in double quotation marks. If the message itself contains a double quotation mark, use two double quotation marks to represent it. Max 256 characters.
R"message" Optional title for the message box. Must be enclosed in double quotation marks too. Max 256 characters.
Sn Message box mode (see below), default 1
Tn Timeout in seconds, ignored if S=2 or S=3. The message will be cancelled after this amount of time, if the user does not cancel it before then. A zero or negative value means that the message does not time out (it may still be cancelled by the user if it has a Close button). The default value is 10 seconds (this applies to modes 0 and 1 only).
X, Y, Zn 0 = no special action (default), 1 = display jog buttons alongside the message to allow the user to adjust the head position on the specified axis

This command provides a more flexible alternative to M117, in particular messages that time out, messages that suspend execution until the user acknowledges them, and messages that allow the user to adjust the height of the print head before acknowledging them.

Allowed message box modes are:

0. No buttons are displayed (non-blocking)
1. Only "Close" is displayed (non-blocking)
2. Only "OK" is displayed (blocking, send M292 to resume the execution)
3. "OK" and "Cancel" are displayed (blocking, send M292 to resume the execution or M292 P1 to cancel the operation in progress)

The combination S0 T0 is not permitted, because that would generate a message box with no close button and that never times out, which would lock up the user interface.

M292: Acknowledge message

Parameters:

Pnnn Whether the current operation shall be cancelled (P=1) or continued (P=0).

This command is sent by the user interface when the user acknowledges a message that was displayed because of a M291 command with parameter S=2 or S=3. The P parameter is ignored unless M291 was called with S=3.

Supported in firmware version 1.19 and later.

Parameters

Snnn frequency in Hz
Pnnn duration in milliseconds

Example

M300 S300 P1000

Play beep sound, use to notify events like the end of printing. If an LCD device is attached to RepRapFirmware, a sound is played via the add-on touch screen control panel. Else the web interface will play a beep sound.

Parameters

Hnnn heater number
Pnnn proportional (Kp)
Innn integral (Ki)
Dnnn derivative (Kd)

Examples

M301 H1 P20 I0.5 D100

Sets Proportional (P), Integral (I) and Derivative (D) values for hot end. See also M303

H: Is the heater number, and is compulsory. H0 is the bed, H1 is the first hot end, H2 the second etc.
P: Proportional value
I: Integral value
D: Derivative value

The P, I and D values must be provided scaled by a factor of 255, for compatibility with older firmwares.

Note: PID parameters are computed automatically when the M307 command is used to define the heater model, or from the default heater model if no M307 command is provided. You can use M301 to override those computed PID parameters, but this is not recommended because it prevents RepRapFirmware from using different PID parameters depending on the heating phase.

Parameters

This command can be used without any additional parameters.
Pnnn Cold extrude allow state (RepRapFirmware)
Snnn Minimum extrusion temperature (RepRapFirmware 2.02 and later)
Rnnn Minimum retraction temperature (RepRapFirmware 2.02 and later)

Examples

M302 ; Report current state
M302 P1 ; Allow cold extrusion
M302 S120 R110 ; Allow extrusion starting from 120°C and retractions already from 110°C

This tells the printer to only allow movement of the extruder motor above a certain temperature, or if disabled, to allow extruder movement when the hotend is below a safe printing temperature.

The minimum temperatures for extrusion can be set using the Snnn parameter with a default value of 160°C if unset. A minimum retraction temperature can be set with the Rnnn parameter. The default for this is 90°C.

M302 with no parameters it will report the current cold extrusion state.

Parameters

Hnnn heater number
Pnnn PWM to use, 0 to 1 (you should normally use 1 i.e. full power), default 1
Snnn target temperature

Examples

M303 H1 P0.4 S240 ; tune heater 1 using 40% PWM, target temperature 240C

PID Tuning refers to a control algorithm used to tune heating behaviour for hot ends and heated beds. This command computes the process model parameters (see M307), which are in turn used to calculate the PID constants. Note that the tuning algorithm will overshoot the target temperature; the amount of overshoot depends on how powerful the heater is. See Wiki:Tuning Temperature Control.

Tuning is performed asynchronously. Run M303 with no parameters to see the current tuning state or the last tuning result.

Parameters

This command can be used without any additional parameters.
Pnnn proportional (Kp)
Innn integral (Ki)
Dnnn derivative (Kd)

Examples

M304 P1 I2 D3
M304 ; Report parameters

Sets Proportional, Integral and Derivative values for bed. This command is identical to M301 except that the H parameter (heater number) defaults to zero.

Parameters

Pnnn Heater number (0, 1, 2...) or virtual heater number (100, 101, 102...)
S"name" Heater name (optional). Named virtual heaters are shown in Duet Web Control; anonymous virtual heaters are not.
Xnnn Heater ADC channel, or thermocouple or PT100 adapter channel; defaults to the same value as the P parameter
Tnnn (for thermistor sensors) The thermistor resistance at 25^oC
T"c" (for MAX31856-based thermocouple sensor daughter boards) The thermocouple type letter, default K
Bnnn If the sensor is a thermistor, this is the Beta value. For the Steinhart-Hart thermistor model, this is the reciprocal of the B coefficient
Cnnn If the sensor is a thermistor, this is the Steinhart-Hart C coefficient, default 0
Rnnn If the sensor is a thermistor, PT100 or PT1000 sensor, this is the Series resistor value, see here for more information if you need it: Connecting thermistors or PT1000 temperature sensors
Lnnn If the sensor is a thermistor, this is the ADC low offset. If it is a current loop sensor, this is the temperature when the current is 4mA.
Hnnn If the sensor is a thermistor, this is the ADC high offset. If it is a current loop sensor, this is the temperature when the current is 20mA.
Fnn (where nn is 50 or 60) If the sensor interface uses a MAX31856 thermocouple chip or MAX31865 PT100 chip, this is the local mains frequency. Readings will be timed to optimise rejection of interference at this frequency.
Wn Configure number of wires used to connect PT100 sensor. Should be [2..4].

Example

M305 P1 T100000 R1000 B4200

Sets the parameters for temperature measurement. The example above tells the firmware that for heater 1 (P parameter: 0 = heated bed, 1 = first extruder) the thermistor 25C resistance (T parameter) is 100Kohms, the thermistor series resistance (R parameter) is 1Kohms, the thermistor beta (B parameter) is 4200. All parameters other than P are optional. If only the P parameter is given, the existing values are displayed. DuetWebControl 1.19.2 and newer support optional units to be set by the S parameter in the form of "Heater name [Unit]".

RepRapFirmware also supports ADC gain and offset correction and a thermistor selection facility. Example:

M305 P1 T100000 R1000 B4200 H14 L-11 X2

The H correction affects the reading at high ADC input voltages, so it has the greatest effect at low temperatures. The L correction affects the reading at low input voltages, which correspond to high temperatures. The ADC on the Duet 2 WiFi and Duet 2 Ethernet is self-calibrating, so you should not need to provide any corrections when using these controllers.

The X parameter tells the firmware which temperature sensor channel to use channel, as follows:

Channels 0, 1... are the thermistor inputs for heaters 0, 1 etc.
Channels 100, 101... are MAX31855 thermocouple channels using chip selects CS1, CS2... on the SPI bus, see Connecting thermocouples.
Channels 150, 151... are MAX31856 thermocouple channels using chip selects CS1, CS2... on the SPI bus
Channels 200, 201... are MAX31865 PT100 channels using chip selects CS1, CS2... on the SPI bus, see Connecting PT100 temperature sensors.
Channels 300, 301... are current loop channels using chip selects CS1, CS2... on the SPI bus
Channels 400, 401... are DHTxx temperature channels. The DATA line of the DHTxx must be connected to one of pins CS1, CS2... on the SPI bus. Specify the sensor type (11 for DHT11, 21 for DHT21 or 22 for DHT22) via the T-parameter. e.g. M305 P102 X401 T22 S"DHT temperature"
Channels 450, 451... are as 400, 401... but specify the corresponding humidity sensor of the DHTxx
Channels 500, 501... are the thermistor inputs, but configured for PT1000 sensors rather than thermistors. Only the R, H and L parameters are significant, see example below.
Channel 1000 is the on-chip microcontroller temperature sensor
Channel 1001 represents the temperature warning and overheat flags on the TMC2660, TMC2224 or other smart drivers on the Duet main board. It reads 0C when there is no warning, 100C if any driver reports over-temperature warning , and 150C if any driver reports over temperature shutdown.
Channel 1002 is as channel 1001 but for drivers on the Duex 2 or Duex 5 expansion board.

If the M305 command for a real heater does not specify a sensor channel and the heater has not been configured yet, then it defaults to using the thermistor associated with that heater.

PT1000 Example:

M305 P1 X501 R2200 ; heater 1 uses a PT1000 connected to thermistor channel 1 which has a 2.2K series resistor (i.e a Duet 2 Maestro)

Note: PT1000 sensors connected to thermistor inputs have lower resolution than PT100 sensors connected via the PT100 daughter board. The accuracy of PT1000 sensors should be very good on the Duet 2 Maestro and generally good on the Duet 2 Wifi and Duet 2 Ethernet. However, it may be poor on the Duet 06, Duet 085 and other SAM3X8E-based electronics. See the PT1000 documentation for more details.

Virtual heaters 100, 101 and 102 are preconfigured to use temperature sensor channels 1000, 1001 and 1002 respectively. We suggest you use virtual heaters 103 upwards if you want to create additional virtual heaters.

If you send the following command:

M305 P101

you should get the response "Heater 101 uses TMC2660 temperature warnings sensor channel 1001". But as this virtual heater has no name, it doesn't show up in DWC. You can fix that by sending:

M305 P101 S"Drivers"

After that, if you go to the "Extra" tab in DWC (where is says Tools/Heaters/Extra), you will see "Drivers" as an entry.

Parameters

Hn Heater number (0 is usually the bed heater)
Annn gAin, expressed as ultimate temperature rise obtained in degC divided by the PWM fraction. For example, if G=180 then at 50% PWM the ultimate temperature rise would be 90C.
Cnnn dominant time Constant of the heating process in seconds
Dnnn Dead time in seconds
Innn Invert PWM signal (I0 = not inverted, I1 = invert PWM/bang-bang signal for inverted temperature control [e.g. with Peltier elements], I2 = full PWM signal inversion, I3 = both) (supported by RRF > 1.20)
Vnnn (optional) Power voltage at which the heater was calibrated, zero or negative means not known (supported by RRF > 1.20)

Two additional parameters help control the heating process:

Bn selects Bang-bang control instead of PID if non-zero. Default at power-up is 0 for extruder heaters, 1 for the bed heater.
Fnnn PWM frequency to use (RepRapFirmware 1.20 and later).
Snnn maximum PWM to be used used with this heater on a scale of 0 to 1. Default 1.0.
Vnnn VIN supply voltage at which the A parameter was calibrated (RepRapFirmware 1.20 and later). This allows the PID controller to compensate for changes in supply voltage. A value of zero disables compensation for changes in supply voltage.

Examples

M307 H0 ; report the process parameters for heater 0
M307 H1 A346.2 C140 D5.3 B0 S0.8 V23.8; set process parameters for heater 1, use PID, and limit heater 1 PWM to 80%

Each heater and its corresponding load may be approximated as a first order process with dead time, which is characterised by the gain, time constant and dead time parameters. The model can used to calculate optimum PID parameters (including using different values for the heating or cooling phase and the steady state phase), to better detect heater faults, and to calculate feed-forward terms to better respond to changes in the load. Normally these model parameters are found by auto tuning - see M303 and Wiki:Tuning Temperature Control.

For those platforms that provide power voltage monitoring, the calibration voltage setting allows the heating controller to adjust the power automatically in response to changes in the power supply voltage. For example, if a bed or chamber heater is turned on or off, this may cause the power supply voltage to change a little, which if not corrected for would change the extruder heater power.

RepRapFirmware 1.16 and later allow the PID controller for a heater to be disabled by setting the A, C and D parameters to -1. This frees up the corresponding heater control pin for use as a general purpose I/O pin to use with the M42 or M280 command.

Coming soon in RepRapFirmware 3.

Common Parameters

Sn Sensor number
P"pin_name" The name of the control board pin that this sensor uses. For thermistors it is the thermistor input pin name. For sensors connected to the SPI bus it is the name of the output pin used as the chip select.
Y"sensor_type" The sensor and interface type, e.g. "thermistor", "pt1000", "rtdmax31865", "max31855", "max31856", "linear-analog", "dht22-temp", "dht22-humidity", "current-loop-pyro", "mcutemp", "drivers", "drivers-duex"
A"name" Sensor name (optional), displayed in the web interface

Additional parameters for thermistors

Tnnn (for thermistor sensors) Thermistor resistance at 25°C
Bnnn Beta value, or the reciprocal of the Steinhart-Hart thermistor model B coefficient
Cnnn Steinhart-Hart C coefficient, default 0
Rnnn Series resistor value
Lnnn ADC low offset correction, default 0 (ignored if the hardware supports automatic ADC gain and offset calibration)
Hnnn ADC high offset correction, default 0 (ignored if the hardware supports automatic ADC gain and offset calibration)

Additional parameters for PT1000 sensors

Rnnn Series resistor value
Lnnn ADC low offset correction, default 0 (ignored if the hardware supports automatic ADC gain and offset calibration)
Hnnn ADC high offset correction, default 0 (ignored if the hardware supports automatic ADC gain and offset calibration)

Additional parameters for MAX31856-based thermocouple sensors

T"c" The thermistor type letter, default K
Fnn (where nn is 50 or 60) The local mains frequency. Readings will be timed to optimise rejection of interference at this frequency.

Additional parameters for MAX31865-based PT100 sensors

Rnnn Series resistor value
Fnn (where nn is 50 or 60) The local mains frequency. Readings will be timed to optimise rejection of interference at this frequency.

Additional parameters for linear analog sensors

Fn F0 = unfiltered (fast response), F1 = filtered (slower response, but noise reduced and ADC oversampling used to increase resolution)
Lnnn The temperature or other value when the ADC output is zero
Hnnn The temperature or other value when the ADC output is full scale

This code replaces M305 in RepRapFirmware 3. In earlier versions of RepRapFirmware, sensors only existed in combination with heaters, which necessitated the concept of a "virtual heater" to represent a sensor with no associated heater (e.g. MCU temperature sensor). RepRapFirmware 3 allows sensors to be defined independently of heaters. The association between heaters and sensors is defined using M950.

M308 can be used in the following ways:

M308 Snn Y"type" [other parameters] ; delete sensor nn if it exists, create a new one with default settings, and configure it using the other parameters. At least the pin name must also be provided, unless the sensor doesn't use a pin (e.g. MCU temperature sensor).

M308 Snn ; report the settings of sensor nn

M308 A"name" ; report the settings of the first sensor named "name"

M308 Snn [any other parameters except Y] ; amend the settings of sensor nn

Sensor type names obey the same rules as pin names, i.e. case is not significant, neither are hyphen and underscore characters.

Usage

M350 Xnn Ynn Znn Enn Inn

Parameters

Not all parameters need to be used, but at least ''one'' should be used. As with other commands, RepRapFirmware reports the current settings if no parameters are used.
Xnn Set stepping mode for the X axis
Ynn Set stepping mode for the Y axis
Znn Set stepping mode for the Z axis
Enn Set stepping mode for Extruder 0 (use Enn:nn:nn etc. for multiple extruders)
Inn Enable (nn=1) or disable (nn=0) microstep interpolation mode for the specified drivers, if they support it. The Duet 2 WiFi/Ethernet support interpolation (to x256 microstepping) only when configured for x16 microstepping. The Duet 2 Maestro supports interpolation at all microstep settings.

Modes (nn)

1 = full step
2 = half step
4 = quarter step
8 = 1/8 step
16 = 1/16 step
32 = 1/32 step
64 = 1/64 step
128 = 1/128 step
256 = 1/256 step

Order dependency

This command must be later in config.g than any M584 command.

Examples

M350 Z1 ;set the Z-axis' driver to use full steps
M350 E4:4:4 ;set extruders 0-2 to use quarter steps)

When M350 is processed, the steps/mm will be adjusted automatically to allow for any changes in microstepping. Therefore you can either:

a) Set Steps/mm correctly for the default 1/16 microstepping, then set the microstepping to the desired amount using M350:

M92 X80 Y80 Z400 ; set axis steps/mm
M92 E420:430 ; set extruder 0 and 1 steps/mm
M350 X128 Y128 Z128 E128:128 ; set microstepping

b) Set the microstepping using M350 and then set the correct steps/mm for that microstepping amount:

M350 X128 Y128 Z128 E128:128 ; set microstepping
M92 X640 Y640 Z3200 ; set axis steps/mm @128 microstepping
M92 E3360:3440 ; set extruder 0 and 1 steps/mm

Assuming that in the first example the microstepping was initially at the default x16, both the above examples result in the same steps/mm settings.

Note: microstep interpolation is available on the TMC2660 drivers used on the Duet 2 WiFi and Duet 2 Ethernet, but only when microstepping is set to 16. In other configurations, specifying I1 has no effect. Microstepping interpolation is available on the TMC2224 drivers used on the Duet 2 Maestro at all microstepping settings,

Saves the height map.

Parameters

P"filename" Name of the file to save to

Usage

M374
M374 P"MyAlternateHeightMap.csv"

This saves the grid parameters and height map into the specified file, or the default file heightmap.csv if no filename was specified. To load the height map automatically at startup, use command G29 S1 or M375 in the config.g file.

The G29 S0 command automatically saves the height map to file, therefore you do not need to use M374 after G29 S0.

Loads the grid matrix file

Parameters

P"filename"

Examples

M375
M375 P"MyAlternateHeightMap.csv"

Without parameters loads default grid (sys/heightmap.csv), and with specified filename attempts to load the specified grid. If not available will not modify the current grid.

In RepRapFirmware this command is equivalent to the G29 S1 command.

Parameters

Hnnn Height (mm) over which to taper off the bed compensation

Example

M376 H10

This command specifies that bed compensation should be tapered linearly over the specified height, so that full bed compensation is applied at Z=0 and no bed compensation is applied when Z is at or above that height. If H is zero or negative then no tapering is applied, so compensation is performed throughout the entire print.

RepRapFirmware does not adjust the extrusion factor to account for the layer height varying when tapered bed compensation is used. Therefore it is recommended that the taper height be set to at least 20x the maximum error in the height map, so that the maximum amount of the resulting over- or under- extrusion is limited to 5%.

Example

M400

Finishes all current moves and and thus clears the buffer. That's identical to G4 P0.

Example: M401

This runs macro file sys/deployprobe.g.

Example: M402

This runs macro file sys/retractprobe.g.

Parameters

Nnnn Filament width (in mm)
Dnnn Nozzle diameter (in mm)

Examples

M404 N1.75
M404 N3.0 D1.0

Enter the nominal filament width (3mm, 1.75mm) or will display nominal filament width without parameters.

The 'D' parameter is used to properly detect the first layer height when files are parsed or a new print is being started.

The values of this command are currently only used for the print monitor.

Parameters

Snnn Response type
Rnnn Response sequence number

Example

M408 S0

Report a JSON-style response by specifying the desired type using the 'S' parameter.

The following response types are supported:

Type 0 is a short-form response, similar to the response used by older versions of the web interface.
Type 1 is like type 0 except that static values are also included.
Type 2 is similar to the response provided by the web server for Duet Web Control.
Type 3 is an extended version of type 2 which includes some additional parameters that aren't expected to change very frequently.
Type 4 is an extended version of type 2 which may be used to poll for current printer statistics.
Type 5 reports the current machine configuration.

Here is an example of a typical type 0 response:

{"status":"I","heaters":[25.0,29.0,28.3],"active":[-273.1,0.0,0.0],"standby":[-273.1,0.0,0.0],"hstat":[0,2,1],"pos":[-11.00,0.00,0.00],"extr":[0.0,0.0],

"sfactor":100.00, "efactor":[100.00,100.00],"tool":1,"probe":"535","fanPercent":[75.0,0.0],"fanRPM":0,"homed":[0,0,0],"fraction_printed":0.572}

The response is set as a single line with a newline character at the end. The meaning of the fields is:

status: I=idle, P=printing from SD card, S=stopped (i.e. needs a reset), C=running config file (i.e starting up), A=paused, D=pausing, R=resuming from a pause, B=busy (e.g. running a macro), F=performing firmware update

heaters: current heater temperatures, numbered as per the machine (typically, heater 0 is the bed)

active: active temperatures of the heaters

standby: standby temperatures of the heaters

hstat: status of the heaters, 0=off, 1=standby, 2=active, 3=heater fault. Heater 0 is normally the bed heater, heaters 1, 2.. are the extruder heaters.

pos: the X, Y and Z (and U, V, W if present) axis positions of the current tool (if a tool is selected), or of the print head reference point if no tool is selected

extr: the positions of the extruders

sfactor: the current speed factor (see M220 command)

efactor: the current extrusion factors (see M221 command), one value per extruder

tool: the selected tool number. A negative number typically means no tool selected.

probe: the Z-probe reading

fanPercent: the speeds of the controllable fans, in percent of maximum

fanRPM: the print cooling fan RPM

homed: the homed status of the X, Y and Z axes (and U, V, W if they exist), or towers on a delta. 0=axis has not been homed so position is not reliable, 1=axis has been homed so position is reliable.

fraction_printed: the fraction of the file currently being printed that has been read and at least partially processed.

message: the message to be displayed on the screen (only present if there is a message to display)

timesLeft: an array of the estimated remaining print times (in seconds) calculated by different methods. These are currently based on the proportion of the file read,

the proportion of the total filament consumed, and the proportion of the total layers already printed. Only present if a print from SD card is in progress.

seq: the sequence number of the most recent non-trivial G-code response or error message. Only present if the R parameter was provided and the current sequence number is greater than that.

resp: the most recent non-trivial G-code response or error message. Only present if the R parameter was provided and the current sequence number is greater.

The type 1 response comprises these fields plus some additional ones that do not generally change and therefore do not need to be fetched as often. The extra fields include:

myName: the name of the printer

firmwareName: the name of the firmware, e.g. "RepRapFirmware" or "Smoothieware"

geometry: one of "cartesian", "delta", "corexy, "corexz" etc.

axes: the number of axes

volumes: the number of SD card slots available

numTools: the number of available tools numbered contiguously starting from 0

The fields may be in any order in the response. Other implementations may omit fields and/or add additional fields.

For a more detailed comparison of type 2 - 5, see http://reprap.org/wiki/RepRap_Firmware_S....

PanelDue currently uses only M408 S0 and M408 S1.

Example

M450

Printers can be used for different task by exchanging the toolhead. Depending on the tool, a different behavior of some commands can be expected. This command reports the current working mode. Possible responses are:

PrinterMode:FFF

PrinterMode:Laser

PrinterMode:CNC

The default at power up is FFF.

Parameters

none

Example

M451

Switches to Fused Filament Fabrication mode for filament printing.

Parameters

Pnnn Logical pin number used to control the laser
In Invert (I1) or don't invert (I0, default) the output polarity
Rnnn The value of the S parameter in M3 commands that corresponds to full laser power, default 255
Fnnn The PWM frequency used to drive the laser

Example

M452 P2 R255 F200 ; switch to laser mode using the heater 2 (E1 heater) output pins to control the laser

Switches to laser mode. This mode enables handling of a laser pin and makes sure that the laser is only activated during G1 moves if laser was enabled or E is increasing. G0 moves should never enable the laser. M3/M5 can be used to enable/disable the laser for moves. Logical pin numbers for the P parameter are as defined for the M42 and M208 commands. If a heater or fan output is used to control the laser, you must disable the corresponding heater (see M307) or fan (see M106) first.

Very important! If you use M452 to put your machine into Laser mode and are running Firmware 2.02 or above, you must replace all S parameters in G0/G1 commands in homing files etc. by H parameters. This is because S is now used to control laser power.

Parameters

Snnn (optional) Spindle index, defaults to 0. Duet 2 supports 4 spindles max
Pfff:rrr Logical pin numbers used to drive the spindle motor in clockwise and counterclockwise directions. Omit the ":rrr" part if the spindle turns clockwise only.
In Invert (I1) or don't invert (I0, default) the output polarity
Rnnn Spindle RPM that is achieved at full PWM. Used to convert the S parameter in M3 and M4 commands to a PWM value.
Fnnn (optional) The PWM frequency to use
Tnnn (optional) Assign spindle to a tool allowing better control in DWC

Example

M453 P2 R5000 ; switch to CNC mode using heater 2 (E1 heater) pins to control the spindle motor

Switches to CNC mode. In this mode M3/M4/M5 control the pins defined for the milling device. By default, no output is assigned to the spindle motor. Logical pin numbers for the P parameters are as defined for the M42 and M208 commands. If you wish to assign a heater or fan output to control the spindle motor as in the above example, you must first disable the corresponding heater (see M307) or fan (see M106).

Parameters

P"name" Name of directory to create

Example

M470 P"/sys/config.d"

This will create a new directory on the SD-Card. If not otherwise specified the default root should be the first/internal SD-Card.

Supported in RRF >= 2.03.

Parameters

S"name" Name of existing file/directory
T"name" New name of file/directory
Dnnn Setting this to 1 will delete an existing file that matches the T parameter value

Usage

M471 S"source/name" T"dest/name" D1

Example

M471 S"/sys/config-override.g" T"/sys/config-override.g.bak"

Rename or move a file or directory. Using the D parameter can delete a file with the target name. Renaming or moving across directories is possible though not from one SD-Card to another.

Supported in RRF >= 2.03.

Usage

M500
M500 P31

Save current parameters to the sys/config-override.g on the SD card. (similar to other firmware's storing to EEPROM). Implemented in RepRapFirmware 1.17 and later. The parameters stored are:

M307 auto tune results
PID parameters, if you used M301 to override the auto tune PID settings
Delta printer M665 and M666 settings
Any M208 axis limits that were determined using a G1 S3 move
G31 trigger height, trigger value and X and Y offsets for each possible Z probe type (in later firmware versions the G31 parameters are not stored unless the P31 parameter is present)

Ensure that M501 is at the end of config.g in order for the values in config-override.g to be loaded on startup.

Parameters

None

Example

M501

Set the active parameters to those stored in sys/config-override.g on the SD card. This command should be included near the end of the config.g file so that the stored parameters will be loaded at startup. It can also be used to revert parameters to the values stored in config-override.g after experimenting with them.

Example

M502

This command resets all tunable parameters to their values, as set in config.g. This doesn't reset any parameters stored in the sys/config-override.g, so it must be followed with M500 if you want to do that.

Example

M503

This command asks the firmware to reply with the current print settings stored in sys/config.g. The reply output includes the G-Code commands to produce each setting. For example, the Steps Per Unit values are displayed as an M92 command.

Note that the output may be truncated if it is too long. M503 does not include values stored in config-override.g.

Parameters

P"name" ; name of folder, default path is the existing sys path if a relative path is given

Example

M505 P"experimental" ; change config file path from /sys/ to /sys/experimental/

Following this command, files that would normally be fetched from /sys/ (for example, homing files and system macro files in RepRapFirmware) are fetched from the specified folder instead. Any such files that are already being executed will continue to run.

This command can be used to allow multiple configurations to be maintained easily. In RepRapFirmware the file /sys/config.g can contain just these two lines:

M505 P"config1"
M98 P"config.g"

The first line changes the config file folder to /sys/config1 and the second one executes file config.g in that folder. To select an alternative configuration, only the first line needs to be edited.

Parameters

Pnnn The MAC address

Examples

M540 P0xBE:0xEF:0xDE:0xAD:0xFE:0xED
M540 PDE:AD:BE:EF:CA:FE

Sets the http://en.wikipedia.org/wiki/MAC_address of the printer. This should be done before any other network commands. The MAC address is six one-byte hexadecimal numbers separated by colons. The 0x prefix is optional.

All devices running on the same network shall all have different MAC addresses. For your printers, changing the last digit is sufficient.

Note on the Duet 2 Wifi the MAC address is unique and set on the Wifi Module so this command has no effect. The default MAC address on a Duet 2 Ethernet is generated from the unique processor ID so there is normally no need to change it.

Parameters

Pnnn Machine name

Example

M550 PGodzilla

Sets the name of the printer to (in this case) Godzilla. The name can be any string of printable characters except ';', which still means start comment.

Parameters

Pnnn Password

Example

M551 Pmy-very-secret-word

The code 'P' is not part of the password. Note that as this is sent in clear it does not (nor is it intended to) offer a security. But on machines that are (say) on a network, it might prevent idle messing about. The password can contain any printable characters except ';', which still means start comment.

if the specified password differs from the default one (i.e. reprap), the user will be asked to enter it when a connection is established.

Parameters for Duet 2 Ethernet and 06/085

Pnnn IP address, 0.0.0.0 means acquire an IP address using DHCP
Snnn 0 = disable networking, 1 = enable networking
Rnnn (optional, RepRapFirmware 1.17 and earlier only) HTTP port, default 80

Parameters for Duet 2 WiFi

P"ssid" (optional, RepRapFirmware 1.20 and later) SSID of network to connect to. The SSID and password must already have been registered using M587. If this parameter is not present, the Duet 2 WiFi will try to connect to the strongest network that is broadcasting its SSID and whose SSID has been registered using M587.
Snnn 0 = disable networking, 1 = enable networking as a client, 2 = enable networking as an access point , -1 = disable WiFi module

Example (Duet 2 Ethernet)

M552 S1 P192.168.1.14

Sets the IP address of the machine to (in this case) 192.168.1.14. If the S parameter is not present then the enable/disable state of the network interface is not changed.

Example (Duet 2 WiFi)

M552 S1 P"MyNetwork"

M552 with no parameters reports the current network state and IP address.

In firmware 1.18 and later the HTTP port address is set using the M586 command, so the R parameter of this command is no longer supported.

On the Duet 2 WiFi running firmware 1.19 and later, the IP address is set in the M587 command when you configure the access point details.

Parameters

Pnnn Net mask

Example

M553 P255.255.255.0

Sets the network mask of the RepRap machine to (in this case) 255.255.255.0. A restart may be required before the new network mask is used. If no 'P' field is specified, this echoes the existing network mask configured.

DuetWifiFirmware versions 1.18 and earlier do not support setting the network mask manually.

Parameters

Pnnn Gateway

Example

M554 P192.168.1.1

Sets the Gateway IP address of the RepRap machine to (in this case) 192.168.1.1. A restart may be required before the new gateway IP address is used. If no 'P' field is specified, this echoes the existing Gateway IP address configured.

DuetWifiFirmware versions 1.18 and earlier do not support setting the gateway address.

Parameters

Pnnn Emulation type

Example

M555 P1

Set the firmware to a mode where its input and (especially) output behaves similar to other established firmware. The value of the 'P' argument is:

value	Firmware
0	RepRap_Firmware
1	RepRap_Firmware
2	Marlin
3	Teacup
4	Sprinter
5	Repetier
6	nanoDLP (RRF 2.02RC6 and later)

Currently, only RepRapFirmware, Marlin and nanoDLP emulations are supported.

Parameters

Snnn Height of the measured distances
Xnnn Deviation in X direction
Ynnn Deviation in Y direction
Znnn Deviation in Z direction

Example

M556 S100 X0.7 Y-0.2 Z0.6

This tells software the tangents of the angles between the axes of the machine obtained by printing then measuring a test part. The S parameter (100 here) is the length of a triangle along each axis in mm. The X, Y and Z figures are the number of millimeters of the short side of the triangle that represents how out of true a pair of axes is. The X figure is the error between X and Y, the Y figure is the error between Y and Z, and the Z figure is the error between X and Z. Positive values indicate that the angle between the axis pair is obtuse, negative acute.

Printable parts for calibrating the deviation from orthogonality can be found at https://github.com/reprappro/RepRapFirmw....

Parameters to define G29 probe grid (all values in mm)

Xaaa:bbb Minimum and maximum X coordinates to probe
Yaaa:bbb Minimum and maximum Y coordinates to probe
Raaa Radius to probe
Saaa Probe point spacing (RepRapFirmware 1.19beta10 and later also support Saaa:bbb)
Pnn or Pxx:yy (RRF 2.02 and later) Number of points to probe in the X and Y axis directions (alternative to specifying the probe point spacing)

Examples

M557 X0:200 Y0:220 S20
M557 R150 S15

Parameters to define G32 probe points (Cartesian/CoreXY printers only, deprecated and not supported in firmware 1.18 and later)

Pnnn Probe point number
Xnnn X coordinate
Ynnn Y coordinate

Example

M557 P1 X30 Y40.5

Set the points at which the bed will be probed to compensate for its plane being slightly out of horizontal.

The first form defines the grid for G29 bed probing. For Cartesian printers, specify minimum and maximum X and Y values to probe and the probing interval. For Delta printers, specify the probing radius. If you define both, the probing area will be the intersection of the rectangular area and the circle. There is a firmware-dependent maximum number of probe points supported. Currently this is 121 on the Duet 06/085 (enough for a 11x11 grid) and 441 for the Duet 2 WiFi and Duet 2 Ethernet (enough for a 21x21 grid)

The second form defines the points for for G32 bed probing. The P value is the index of the point (indices start at 0) and the X and Y values are the position to move extruder 0 to to probe the bed. An implementation should allow a minimum of three points (P0, P1 and P2). This just records the point coordinates; it does not actually do the probing. See G32. Defining the probe points in this way is deprecated in RepRapFirmware, you should define them in a bed.g file instead.

Parameters

Pnnn Z probe type
Fnnn Feed rate (i.e. probing speed, mm/min)
Hnnn Dive height (mm). When using mesh bed compensation or running G30 commands with specified XY coordinates (for example from the bed.g file), the firmware moves the Z probe to this height above where it expects the bed to be before commencing probing. The maximum depth of probing from this position is twice the dive height. A large dive height will tolerate a very uneven bed or poor calibration. A small dive height will make probing faster, because the Z probe has less distance to travel before reaching the bed. Default value if omitted is 5mm.
Innn Invert (I1) or do not invert (I0, default) the Z probe reading (RepRapFirmware 1.16 and later)
Rnnn Z probe recovery time after triggering, default zero (seconds) (RepRapFirmware 1.17 and later)
Tnnn Travel speed to and between probe points (mm/min)
Annn Maximum number of times to probe each point, default 1. Maximum, as of 2.03, is 31. Setting M558 A parameter to anything >31 set it to 0 instead of to 31
Snnn Tolerance when probing multiple times, default 0.03mm
Bn If 1, turn off bed heater while probing, default (B0) leaves heater on. (RepRapFirmware 1.21 and later)
Cn Endstop input number when the probe type is P4, default 3 (RepRapFirmware 2.02/1.23 and later)

Obsolete parameters

Xnnn If nonzero, use probe for homing X axis (RRF 1.19 and earlier)
Ynnn If nonzero, use probe for homing Y axis (RRF 1.19 and earlier)
Znnn If nonzero, use probe for homing Z axis (RRF 1.19 and earlier)

Example

M558 P1 X0 Y0 Z1 F500 T5000 H3

The H parameter defines the Z probe dive height, which is the height above the trigger height from which probing starts. The default is 3mm or 5mm depending on firmware version. You may wish to increase it during initial calibration.

A Z probe may be a switch, an IR proximity sensor, or some other device. This selects which to use:

P0 indicates that no Z probe is present. Whenever Z probing is commanded, you will be prompted to jog the Z axis until the nozzle is just touching the bed and then signal completion.
P1 specifies an unmodulated or smart IR probe, or any other probe type that emulates one (probe output is an analog signal that rises with decreasing nozzle height above the bed). If there is a control signal to the probe, it is driven high when the probe type is P1.
P2 specifies a simple modulated IR probe, where the modulation is commanded directly by the main board firmware using the control signal to the probe.
P3 is similar to P1 but drives the control signal to the probe low. This may be used to switch between different Z probes.
P4 selects a switch for bed probing. In recent firmware versions the C parameter specifies the endstop input number, default 3 (on the Duets this is the E0 endstop input).
P5 (from RepRapFirmware 1.14) selects a switch by default (normally closed) for bed probing between the In and Gnd pins of the Z-probe connector (Duet 0.8.5 and Duet 2 WiFi).
P6 is as P4 but the switch is connected to an alternative connector (on the Duet series, the E1 endstop connector). Deprecated in recent firmware versions, use P4 C4 instead.
P7 (from RepRapFirmware 1.20) selects a switch (by default normally closed) connected to the Z endstop input. Deprecated in recent firmware versions, use P4 C2 instead.
P8 (from RepRapFirmware 1.20) is as P5 but is unfiltered, for faster response time.
P9 (from RepRapFirmware 1.21RC2) is as P5 but for a BLTouch probe that needs to be retracted and redeployed between probe points.
P10 means use Z motor stall detection as the Z probe trigger.

In RepRapFirmware versions 1.20beta4 and earlier, the X, Y and Z parameters specify whether each axis uses the Z probe as a substitute homing switch or not. If the parameter is nonzero, the Z probe is used for homing that axis. If the parameter is zero, the endstop switch for that axis is used for homing instead. In firmware 1.20beta6 and later, use the S parameter in the M574 command instead to indicate whether you are using a homing switch or a Z probe for homing X and Y.

The A and S parameters control multiple probing. Probing is repeated until two consecutive probe attempts produce results that differ by no more than the S parameter; then the average of those two results is used. However, if the number of attempts specified by the A parameter is reached without getting two consecutive results within tolerance of each other, no further probe attempts are made and the average result of all the attempts is used.

Related commands: G29, G30, G31, G32, M401, M402.

Parameters

Pfilename. File name to upload to, default is config.g. If the filename does not include a path, the default is /sys.
Snnn File size for binary transfer. If not present, the transfer is terminated by a M29 command
Cnnn CRC-32 of the file (optional)

Example

M559

Was used by the original web interface to upload a configuration file. Can now be used to upload any file.

Parameters

As for M559 except the default filename is reprap.htm and the default path is /www. If the S parameter is absent then the file data is terminated by a special string as described below.

Example

M560

Was used by the original web interface to upload a file that is the control page. Now deprecated. After sending M560 the file (usually an HTML file) should be sent, terminated by the string :

<!-- **EoF** -->

Clearly that string cannot exist in the body of the file, but can be put on the end to facilitate this process.

Example

M561

This cancels any bed-plane fitting as the result of probing (or anything else) and returns the machine to moving in the user's coordinate system.

Parameters

Pnnn Heater number

Example

M562 P2

Reset a temperature fault on heater/sensor 2. If the heater has switched off and locked because it has detected a fault, this will reset the fault condition and allow you to use the heater again. Obviously to be used with caution. If the fault persists it will lock out again after you have issued this command. P0 is the bed; P1 the first extruder, and so on.

In firmware 1.20 and later, M562 with no parameters will clear a heater fault on all heaters

Parameters

Pnnn Tool number
S"name"'' Tool name (optional)
Dnnn Extruder drive(s)
Hnnn Heater(s)
Fnnn Fan(s) to map fan 0 to (RepRapFirmware 1.16 and later)
Xnnn Axis or axes to map X movement to (RepRapFirmware 1.16 and later)
Ynnn Axis or axes to map Y movement to (RepRapFirmware 1.19 and later)
Lnnn Drive to use for filament mapping. By default RRF will use the first and only extruder drive if this parameter is not specified (supported by RRF >= 2.02)

Example

M563 P0 D0:2:3 H1:3 ; create a tool using extruder drives 0, 2 and 3 and heaters 1 and 3
M563 P1 D1 H2 X3 ; create a tool using extruder drive 1 and heater 2 with X movement mapped to the U axis
M563 P2 D0:1 H1:2 X0:3 F0:2 ; create a tool using extruder drives 0 and 1, heaters 1 and 2, with X movement mapped to both X and U axes and fan 0 mapped to fans 0 and 2
M563 P3 D0 H1 S"Chocolate extruder" ; create a named tool using extruder drive 0 and heater 1

Description

Tools are usually (though not necessarily) extruders. Normally an M563 command to define a tool is immediately followed by a G10 command to set the tool's offsets and temperatures.

P The 'P' field specifies the tool number. Tool numbers can have any positive integer value and 0. If you use the M563 command with a P value for a tool that has already been defined, and you provide any other parameters, that tool is redefined using the new values you provide.

D The 'D' field specifies the drive(s) used by the tool - in the first example drives 0, 2 and 3. Drive 0 is the first drive in the machine after the movement drives (usually X, Y and Z). If there is no 'D' field the tool has no drives. Tools are driven using multiple values in the 'E' field of G1 commands, each controlling the corresponding drive in the 'D' field above, as follows:

G1 X90.6 Y13.8 E2.24:2.24:15.89
G1 X70.6 E0:0:42.4

The first line moves straight to the point (90.6, 13.8) extruding a total of 2.24mm of filament from both drives 0 and 2 and 15.98mm of filament from drive 3. The second line moves back 20mm in X extruding 42.4mm of filament from drive 3.

Alternatively, if the slicer does not support generating G1 commands with multiple values for the extrusion amount, the M567 command can be used to define a tool mix ratio.

The 'D' field number corresponds to the 'E' parameter defined in the M584 command. '0' means first 'E' driver in M584 and so on.

H The 'H' field specifies the tool's heaters - in the first example heaters 1 and 3. Heater 0 is usually the hot bed (if any) so the first extruder heater is usually 1. If there is no H field the tool has no heaters.

It is permissible for different tools to share some (or all) of their drives and heaters. So, for example, you can define two tools with identical hardware, but that just operate at different temperatures.

F The print cooling fan of the tool, default 0. Use this parameter if you are not using fan 0 as the print cooling fan for the tool you are defining.

""Example""

To map more than one fan to the tool, the definition would typically look like this :

M563 P0 D0 H1 F0:1 ; tool 0 uses extruder drive 0 and heater 1. Fan 0 and Fan 1 are mapped to tool 0

X, Y The X and Y mapping option is used to create tools on machines with multiple independent X and/or Y carriages. The additional carriages are set up as axes U, V etc. (see M584) and the X mapping option in M563 defines which carriage or carriages are used.

S As shown in the example above the S parameter can be used to give a tool a name.

RepRapFirmware supports an additional form of the M563 command. The command:

M563 S1

means add 1 (the value of the S parameter) to all tool numbers found in the remainder of the current input stream (e.g. the current file if the command is read from a file on the SD card), or until a new M563 command of this form is executed. The purpose of this is to provide compatibility between systems in which tool numbers start at 1, and programs such as slic3r that assume tools are numbered from zero.

Note: M563 with just a P parameter just reports the existing configuration of the tool. Therefore, if you want to create a tool with no heaters and no extruders, you must provide at least one other parameter. For example, you can use the S parameter to name the tool.

RepRapFirmware allows the deletion of existing tools if M563 is called in this way:

M563 P1 D-1 H-1

Parameters

Hnnn H1 = forbid movement of axes that have not been homed, H0 = allow movement of axes that have not been homed (firmware 1.21 and later)
Snnn S1 = limit movement within axis boundaries, S0 = allow movement outside boundaries

Example

M564 S0 H0

Allow moves outside the print volume and before homing, or not. If the S parameter is 0, then you can send G codes to drive the RepRap outside its normal working volume, and it will attempt to do so. Likewise if the H parameter is zero you can move the head or bed along axes that have not been homed. The default behaviour is S1 H1. On some types of printer (e.g. Delta and SCARA), movement before homing may be prohibited regardless of the H parameter.

Parameters

Xnnn Maximum instantaneous speed change of the X axis (mm/min)
Ynnn Maximum instantaneous speed change of the Y axis
Znnn Maximum instantaneous speed change of the Z axis
Ennn Maximum instantaneous speed change of the extruder drives
Pn Jerk policy (RepRapFirmware 2.03 and later)

Example

M566 X600 Y600 Z50 E600

Sets the maximum allowable speed change (sometimes called 'jerk speed') of each motor when changing direction.

The model files and gcode files used by repraps generally render circles and other curves shapes as a sequence of straight line segments. If the motors were not allowed any instantaneous speed change, they would have to come to a stop at the junction between each pair of line segments. By allowing a certain amount of instantaneous speed change, printing speed can be maintained when the angle between the two line segments is small enough.

If you set these X and Y values too low, then the printer will be slow at printing curves. If they are too high then the printer may be noisy when cornering and you may suffer ringing and other print artefacts, or even missed steps.

When mesh bed compensation is used, movement may be jerky if the allowed Z jerk is too low, because the Z speed needs to change abruptly as the head moves between squares in the mesh.

The default jerk policy is 0, which replicates the behaviour of earlier versions of RRF (jerk is only applied between two printing moves, or between two travel moves, and only if they both involve XY movement or neither does). Changing the jerk policy to 1 allows jerk to be applied between any pair of moves.

Note: The minimum jerk speed supported in as at firmware version 2.02RC3 is 0.1mm/sec.

Parameters

Pnnn Tool number
Ennn Mix ratios

Example

M567 P2 E0.1:0.2:0.1:0.6

This example sets the mix ratio for tool 2 (the P value). When mixing is then turned on (see M568), only single E values need to be sent on a G1 command (any extra E values will be ignored, but are not illegal):

G1 X20 E1.3

This will move to X=20 extruding a total length of filament of 1.3mm. The first drive of tool 2 will extrude 0.1*1.3mm, the second 0.2*1.3mm and so on. The ratios don't have to add up to 1.0 - the calculation done is as just described. But it is normally sensible if they do, otherwise under or over extrusion would occur.

WARNING: Currently the firmware will allow to set a mixing ratio where every extruder will drive at 100% - in case of a setup where several extruders feed the same hotend (like Diamond Hotends) this can lead to dangerously high pressures that could damage the printer.

See also M568.

Deprecated: from firmware 1.19 onwards, this command is no longer required or supported. If a G1 command for the tool provides just one E value, then the mix ratio defined by M567 will always be used.

Parameters

Pnnn Tool number
Snnn Whether mix ratios should be activated

Example

M568 P2 S0

Turn on/off automatic mix ratios for tool 2. If the S parameter is 0 mixing is turned off; if it is non-zero it is turned on.

After turning off command G1 instructions must send as many E values as the tool has drives:

G1 X20 E0.2:0.4:0.166:0.3

The off state is the default.

Parameters

Pnnn Motor driver number
Snnn Direction of movement of the motor(s) attached to this driver: 0 = backwards, 1 = forwards (default 1)
Rnnn Driver enable polarity: 0 = active low, 1 = active high, -1 = driver is always disabled and is not monitored (default 0)
Tnnn (firmware 1.14 and later) Minimum driver step pulse width and interval in microseconds
Taa:bb:cc:dd (firmware 1.21 and later) Minimum driver step pulse width, step pulse interval, direction setup time and direction hold time, in microseconds
Dnn (firmware 2.0 and later, only applies to TMC2660 and TMC22xx stepper drivers) Driver mode: 0=constant off time, 1=random off time, 2=spread cycle, 3=stealthChop or stealthChop2 (mode 3 for TMC22xx only). The default is spreadCycle for TMC2660 drivers and stealthChop2 for TMC22xx. In stealthChop mode the drivers will switch over to spreadCycle automatically at high speeds, see the V parameter.
Fnn (firmware 2.02 and later) Off-time in the chopper control register, 1 to 15
Cnnnn (firmware 2.0 and later, only applies to TMC2660 and TMC22xx stepper drivers) Lowest 17 bits of the chopper control register value.
Bnn (firmware 2.02RC1 and later) Blanking time (tbl) in the chopper control register, 0 to 3. See the TMC driver datasheet.
Hnn (firmware 2.02RC2 and later) thigh parameter for those stepper driver chips that support it. Send M569 P# (where # is the driver number) with no additional parameters to see how this translates into mm/sec. See also the V parameter.
Yaa:bb or Yaa:bb:cc (firmware 2.02RC2 and later) Hysteresis start, end and decrement values in the chopper control register. See the TMC driver datasheet for the meaning.
Vnnn (firmware 2.02RC1 and later) tpwmthrs parameter for those stepper driver chips that support it. This is the interval in clock cycles between 1/256 microsteps below which the drivers will switch from stealthChop to to spreadCycle mode. Only applies when the driver is configured in stealthChop mode. Typical value are from 100 (high speed) to 4000 (low speed). Send M569 P# (where # is the driver number) with no additional parameters to see how this translates into mm/sec.

Examples

M569 P0 S0 ; reverse the direction of the motor attached to driver 0
M569 P5 R1 T2.5:2.5:5:0 ; driver 5 requires an active high enable, 2.5us minimum step pulse, 2.5us minimum step interval, 5us DIR setup time and no hold time

Notes

If no T parameter is given, then the step pulse width and interval are guaranteed to be suitable for the on-board drivers only. RepRapFirmware only remembers the highest T parameters seen in any M569 command, and applies that value to all drivers for which any nonzero T parameter was specified. Therefore if you reduce the T parameters, you must restart the firmware for the change to take effect.

Some versions of RepRapFirmware prior to 1.14 also provided XYZ and E parameters to allow the mapping from axes and extruders to stepper driver numbers to be changed. From 1.14 onward, this functionality is provided by M584 instead.

Parameters for RepRapFirmware 1.14 and earlier

Snnn Heater timeout (in seconds)

Example

M570 S120

After a heater has been switched on, wait 120 seconds for it to get close to the set temperature. If it takes longer than this, raise a heater fault.

Parameters for RepRapFirmware 1.15e and later

Hnnn Heater number
Pnnn Time in seconds for which a temperature anomaly must persist on this heater before raising a heater fault (default 5 seconds)
Tnnn Permitted temperature excursion from the setpoint for this heater (default 15C)
Snnn Timeout in minutes for print to be cancelled after heater fault (Firmware 1.20 and later).

Order dependency

When using RepRapFirmware 3 the M570 command must come later in config,g than the M950 command that creates the heater specified in the H parameter.

Example

M570 H1 P4 T15

Warning! Heating fault detection is provided to reduce the risk of starting a fire if a dangerous fault occurs, for example if the heater cartridge or thermistor falls out of the heater block. You should carefully consider sensible values for the detection time or permitted temperature excursion, setting them to incorrectly will reduce the protection. Also note that this protection should not be relied upon exclusively. Protection against fire should be provided external to the operation of the firmware as well (fuses, fire detection, do not print unattended etc)

Parameters

Snnn Output value
Fnnn Output PWM frequency (RepRapFirmware 1.17 and later)
Pnnn Logical pin number (RepRapFirmware 1.17 and later), defaults to the FAN0 output in firmware 1.19 and earlier until M571 with a P parameter has been seen

Example

M571 P3 F200
M571 S0.5

This turns the controlled pin output on whenever extrusion is being done, and turns it off when the extrusion is finished. The output could control a fan or a stirrer or anything else that needs to work just when extrusion is happening. It also can be used to control a laser beam. The S parameter sets the value of the PWM to the output. 0.0 is off; 1.0 is fully on.

In RepRapFirmware 1.17 and later you can use the P parameter to change the pin used and you can also set the PWM frequency. Pin numbers are the same as in the M42 and M280 commands. The pin you specify must not be in use for anything else, so if it is normally used as a heater you must disable the heater first using M307, or if it is used for a fan you must disable the fan using M106 with the I-1 parameter.

RepRapFirmware 1.20 and later do not default to using the FAN0 output, so you must send M571 with a P parameter at least once to define the pin that you wish to use.

Parameters

Dnnn Extruder number
Snnn Pressure advance amount (in seconds)

Examples

M572 D0 S0.1 ; set extruder 0 pressure advance to 0.1 seconds
M572 D0:1:2 S0.2 ; set extruder 0, 1 and 2 pressure advance to 0.2 seconds (RepRapFirmware 1.20 and later)

This sets the pressure advance coefficient (S parameter) for the specified extruder (D parameter). Supported by RepRapFirmware-dc42, -ch and -dn.

Pressure advance causes the extruder drive position to be advanced or retarded during printing moves by an additional amount proportional to the rate of extrusion. At the end of a move when the extrusion rate is decreasing, this may result in the extruder drive moving backwards (i.e. retracting). Therefore, if you enable this feature, you may need to reduce the amount of retraction you use in your slicing program to avoid over-retraction.

For Bowden extruders, an S value between 0.1 and 0.25 usually gives the best print quality. Direct extruders need smaller values, for example 0.05. Mixing hot ends need larger values.

Parameters

Pnnn Heater number

Example

M573 P1

This gives a running average (usually taken over about five seconds) of the PWM to the heater specified by the P field. If you know the voltage of the supply and the resistance of the heater this allows you to work out the power going to the heater. Scale: 0 to 1.

Parameters

Xnnn Position of X endstop: 0 = none, 1 = low end, 2 = high end.
Ynnn Position of Y endstop: 0 = none, 1 = low end, 2 = high end.
Znnn Position of Z endstop: 0 = none, 1 = low end, 2 = high end.
E Select extruder endstops to define active high or low (RepRapFirmware 1.16 and earlier only)
Snnn Endstop type: 0 = active low endstop input, 1 = active high endstop input, 2 = Z probe, 3 = motor load detection

Order dependency

If this command refers to any axes other than X, Y and Z then it must be later in config.g than the M584 command that creates those additional axes.

Example

M574 X1 Y2 Z0 S1 ; X endstop at low end, Y endstop at high end, no Z endstop, all active high

This defines the type of endstop switch or opto sensor that the printer has for each axis: 0 = none, 1 = low end, 2 = high end. The optional S parameter defines whether the endstop input is active high (S1, the default) or low (S0). A normally-closed endstop switch wired in the usual way produces an active high output (S1).

This is intended for use with boards that provide a single endstop input for each axis that may be used for either a high or a low end endstop, such as the Duet. On delta printers, the XYZ parameters refer to the towers and the endstops should normally all be high end (i.e. at the top of the towers).

In RepRapFirmware 1.16 and earlier, the M574 command with E parameter is used to specify whether a Z probe connected to the E0 endstop input produces an active high (S1) or active low (S0) output. In RepRapFirmware 1.17 and later, use the I parameter of the M558 command instead.

The S2 and S3 options are supported in firmware 1.20 and later.

Parameters

Pnnn Serial channel number
Bnnn Baud rate
Snnn Whether checksums should be used

Example

M575 P1 B57600 S1

This sets the communications parameters of the serial comms channel specified by the P parameter. P0 specifies the main serial interface (typically a USB port, or serial-over-USB), while P1 specifies an auxiliary serial port (for example, the port used to connect a PanelDue). The B parameter is the required baud rate (this parameter is typically ignored if the port is a true USB port). The S parameter is a bitmap of features. The lowest bit, if set, specifies that only commands that include a valid checksum should be accepted from this comms channel.

Parameters

Snnn Desired endstop level
Xnnn Select X axis endstop
Ynnn Select Y axis endstop
Znnn Select Z axis endstop
Ennn Select extruder drive endstop

Example

M577 E0 S1

Wait for an endstop switch to be pressed. The example above will wait until the first extruder endstop is triggered.

The following trigger types may be used using the 'S' parameter:

0: Endstop not hit

1: Low endstop hit

2: High endstop hit

3: Near endstop (only Z probe)

This command is not enabled unless the SUPPORT_INKJET feature is enabled when the firmware is built.

Parameters

Pnnn Inkjet head number
Snnn Bit pattern

Example

M578 P3 S5

This fires inkjet head 3 (the P field) using the bit pattern specified by the S field. The example shown would fire bits 101. If the P parameter is ommitted inkjet 0 is assumed.

This is a version of the M700 command used by http://reprap.org/wiki/Inkshield.

An alternative way of controlling inkjets would be to use the P parameter on the G1 command, in conjunction with the M670 command.

Parameters

Xnnn Scale factor for X axis
Ynnn Scale factor for Y axis
Znnn Scale factor for Z axis
U, V, W, A, B, C Scale factors for additional axes

Example

M579 X1.0127 Y0.998

On a Cartesian RepRap you can get prints exactly the right size by tweaking the axis steps/mm using the M92 G Code above. But this does not work so easily for Delta and other RepRaps for which there is cross-talk between the axes. This command allows you to adjust the X, Y, and Z axis scales directly. So, if you print a part for which the Y length should be 100mm and measure it and find that it is 100.3mm long then you set Y0.997 (= 100/100.3).

On a suitable-configured IDEX printer, a scaling factor of -1 for the U axis can be used to turn a ditto print into a mirror image print.

This M-code is not available by default. To enable it change the value of SUPPORT_ROLAND in the Pins_*.h file from 0 to 1 and recompile the firmware

Parameters

Rnnn Whether Roland mode should be activated
Pnnn Initial text to send to the Roland controller

Example

M580 R1 PVS4;!VZ2;!MC1;

This is not really anything to do with RepRap, but it is convenient. The http://www.rolanddg.com/product/3d/3d/md... are very widely available in hackerspaces and maker groups, but annoyingly they don't speak G Codes. As all RepRap firmware includes a G-Code interpreter, it is often easy to add functions to convert G Codes to http://altlab.org/d/content/m/pangelo/id.... M580 selects a Roland device for output if the R field is 1, and returns to native mode if the R field is 0. The optional P string is sent to the Roland if R is 1. It is permissible to call this repeatedly with R set to 1 and different strings in the P field to communicate directly with a Roland.

Parameters

Tnn Logical trigger number to associate the endstop input(s) with, from zero up to a firmware-specific maximum (e.g. 9 for RepRapFirmware)
X, Y, Z, E Selects endstop input(s) to monitor
P Reserved, may be used in future to allow general I/O pins to cause triggers
S Whether trigger occurs on a rising edge of that input (S1, default), falling edge (S0), or ignores that input (S-1). By default, all triggers ignore all inputs.
C Condition: whether to trigger at any time (C0, default) or only when printing a file from SD card (C1)

Example

M581 E1:2 S1 T2 C1 ; invoke trigger 2 when a rising edge is detected on the E1 or E2 endstop input and a file is being printed from SD card

When M581 is executed, if the T parameter is present but the other parameters are omitted, the trigger inputs and edge polarities for that trigger number are reported. Otherwise, the specified inputs and their polarities are added to the conditions that cause that trigger. Using S-1 with no X Y Z or E parameters sets the trigger back to ignoring all inputs.

Trigger number 0 causes an emergency stop as if M112 had been received. Trigger number 1 causes the print to be paused as if M25 had been received. Any trigger number # greater then 1 causes the macro file sys/trigger#.g to be executed. Polling for further trigger conditions is suspended until the trigger macro file has been completed. RepRapFirmware does not wait for all queued moves to be completed before executing the macro, so you may wish to use the M400 command at the start of your macro file. If several triggers are pending, the one with the lowest trigger number takes priority.

Parameters

T Trigger number to poll

Example

M582 T2 ; check levels of inputs that give rise to trigger #2

Triggers set up by the M581 command are normally activated only when the specified inputs change state. This command provides a way of causing the trigger to be executed if the input is at a certain level. For each of the inputs associated with the trigger, the trigger condition will be checked as if the input had just changed from the opposite state to the current state.

For example, if you use M581 to support an out-of-filament sensor, then M582 allows you to check for out-of-filament just before starting a print.

Parameters

Xnnn Driver number(s) for X motor(s)
Ynnn Driver number(s) for Y motor(s)
Znnn Driver number(s) for Z motor(s)
U, V, W, A, B, Cnnn Driver number(s) for additional axes U, V, W, A, B and C (UVW available in RepRapFirmware 1.16 and later; UVWABC available in RepRapFirmware 1.19 and later)
Ennn Driver number(s) for E motor(s)
Pnnn Number of visible axes, defaults to the total number of axes configured.

Order dependence

M584 must come earlier in config.g than any M350 and M906 commands. If it creates new axes, it must also be earlier than any M92, M201, M203, M208, M350, M566, M574 , M667 and M669 commands.

Example

M584 X0 Y1 Z2:3 E4:5:6 ; Driver 0 controls the X motor, 1 controls Y, 2 and 3 control Z motors, 4 5 and 6 control E motors

VERY IMPORTANT! Assigning a drive using M584 does not remove its old assignment. Therefore, if you assign a drive that defaults to being an extruder drive, you should also assign the extruder drives explicitly as in the above example. Failure to do so may result in unexpected behaviour.

You can use M584 to create additional axes - for example, to represent additional carriages on a machine with multiple independent X carriages. In 1.20 and later firmware you can create new axes in any order. In earlier firmware versions, additional axes must be created in the order UVWABC. You can hide some of the last axes you create using the P parameter. Hidden axes have no homing buttons or jog controls in the user interface.

On the Duet 2 WiFi and Duet 2 Ethernet, if you configure multiple drivers for an axis, either all of them must be TMC2660 drivers on the Duet or a Duet expansion board, or none of them must be. This is to facilitate dynamic microstepping and other features of the TMC2660.

Supported in RRF 1.20beta2 and later.

In machines with at least one tool probe this code allows to update the current tool's offset by driving it into a given endstop.

This code works similarily to G1 .. S1 except that it sets the current tool's offset instead of the machine position and that a custom endstop number can be used.

Parameters

Xnnn - Probe tool in X direction where nnn specifies the expected distance between the trigger point of your endstop switch and the starting point
Ynnn - Probe tool in Y direction where nnn specifies the expected distance between the trigger point of your endstop switch and the starting point
Znnn - Probe tool in Z direction where nnn specifies the expected distance between the trigger point of your endstop switch and the starting point
U,V,W,A,B,Cnnn - As for X,Y,Z above
Ennn - Custom endstop number to use (optional). This must be the drive number of the according endstop (i.e. X=0, Y=1, Z=2, E0=3 etc.)
Lnnn - Trigger level of the custom endstop (optional, 0 = active-low, 1 = active-high). This requires the 'E' parameter to be present (supported in RRF > 2.0)
Fnnn - Requested feedrate of the probing move. If this parameter is omitted, the last set feedrate is used
Snnn - Direction of the probing move. S=0 (default) means travel fowards (towards the axis maximum), S=1 means go backwards (towards the axis minimum)
Rnnn - Probing radius, i.e. the relative movement amount from the current position (optional, if used the S parameter is ignored) [requires RRF 1.20beta8 or later]

Note that you can only specify one axis per M585 call and that XYZ are not the only possible axes for this code (UVWABC would be valid as well).

The values of the XYZ parameters are the absolute distances between the position at which the endstop is actually triggered and your own start position. It is mandatory to measure this distance once before M585 can be used reliably. An example: Say you wish to probe the tool offset on the X axis. If the trigger position of your endstop is at X=210 and you want to drive your tool from X=190 into the endstop switch, you need to specify -20 as your X parameter because you expect to travel 20mm towards the endstop switch and need to correct this factor. If you drive the tool backwards (e.g. from X=210 to X=190), the correction factor should be 20.

In case you are using different switches for tool probing, RepRapFirmware allows you to use a custom endstop, but note that they need to be connected active-high if any of the extruder endstops are used. If a different endstop than the axis endstop is used, the drive number of the matching endstop can be specified via the optional E parameter (e.g. E4 for the E1 endstop).

In principle the following workflow should be performed for each axis using a macro file:

Reset the axis tool offset (G10 Pxx X0 Y0 Z0)
Select your tool (Txx)
Move the tool to your starting position (G1 X?? Y?? Z?? F3000)
Drive the tool into the endstop, stop there and apply the new tool offset with the given correction factor (M585 XYZ?? F1000 E??)
Call G10 Pxx with your tool number to get the corrected tool offset or call M500 (supported in RRF 1.20beta3 and later) to store the probed tool offsets on the SD card

You may wish to enhance this workflow depending on your own requirements and endstop configuration.

Parameters:

Pnn Protocol: 0 = HTTP or HTTPS, 1 = FTP or SFTP, 2 = Telnet or SSH (which of the two choices depends on the T parameter)
Snn 0 = disable this protocol, 1 = enable this protocol
Rnn TCP port number to use for the specified protocol. Ignored unless S = 1. If this parameter is not provided then the default port for that protocol and TLS setting is used.
Tnn 0 = don't use TLS, 1 = use TLS. Ignored unless S = 1. If this parameter is not provided, then TLS will be used if the firmware supports it and a security certificate has been configured. If T1 is given but the firmware does not support TLS or no certificate is available, then the protocol will not be enabled and an error message will be returned. Note: TLS has not yet been implemented in RepRapFirmware, therefore T1 will not work.

M586 with no S parameter reports the current support for the available protocols.

RepRapFirmware 1.18 and later enable only HTTP (or HTTPS if supported) protocol by default. If you wish to enable FTP and/or Telnet, enable them using this command once or twice in config.g.

This command must not be used in the config.g file

Parameters:

S"ccc" Network SSID
P"ccc" Network password
Inn.nn.nn.nn (optional) IP address to use when connected to this network. If zero or not specified then an IP address will be acquired via DHCP.
Jnn.nn.nn.nn (optional) Gateway IP address to use when connected to this network.
Knn.nn.nn.nn (optional) Netmask to use when connected to this network

The SSID and password must always be enclosed in double quotation marks.

Many programs used to send GCodes convert all characters to uppercase. In firmware 1.19.2 and later, within any quoted string you can use a single-quote character to indicate that the following character should be changed to lowercase. For example, M587 S"ABC" P"P'A'S'SW'O'R'D" would specify that the password is PassWord. Use two single quote characters to represent one actual single quote character in the password or in the SSID.

M587 with no parameters lists all the remembered SSIDs, but not the remembered passwords.

The M587 command will fail if the WiFi module has not yet been taken out of reset. So if the WiFi module has not been started, send M552 S0 to put it in idle mode first.

Important! Do not use M587 within config.g. As well as being a security hazard, writing the access point parameters to WiFi chip every time you start the Duet may eventually wear out the flash memory. Also, the wifi module does not get enabled until the end of running config.g. It is better to use a macro to send M587 (source: https://forum.duet3d.com/post/42798)

This command must not be used in the config,g file

Parameters:

S"ccc" Network SSID to remove from the remembered list

The specified SSID will be removed from the remembered list and the associated password cleared out of EEPROM. If the SSID is given as "*" then all remembered networks will be forgotten.

The M588 command will fail if the WiFi module has not yet been taken out of reset. So if the WiFi module has not been started, send M552 S0 to put it in idle mode first. M588 does not work from within config.g at startup.

This command must not be used in the config,g file

Parameters:

S"ccc" The SSID that the WiFi interface should use when it is commanded to run as an access point
P"ccc" The WiFi password
Inn.nn.nn.nn The IP address to use
Cnn The WiFi channel to use (optional)

WPA2 security will be used by default.

The M589 command will fail if the WiFi module has not yet been taken out of reset. So if the WiFi module has not been started, send M552 S0 to put it in idle mode first. M589 does not work from within config.g at startup.

This configures filament sensing for the specified extruder. The sensor may be a simple filament presence detector, or a device that measures movement of filament, or both. The action on a filament error is to pause the print and advise you that there has been a filament error. Note that filament monitoring in RRF is only active when printing from SD card.

Parameters (firmware 1.21 and later)

Dnn Extruder drive number (0, 1, 2...),
Pnn Type of sensor: 0=none, 1=simple sensor (high signal when filament present), 2=simple sensor (low signal when filament present), 3=Duet3D rotating magnet sensor, 4=Duet3D rotating magnet sensor with microswitch, 5 = Duet3D laser sensor, 6 = Duet3D laser sensor with microswitch, 7 = pulse-generating sensor
Cnn Which input the filament sensor is connected to. On Duet electronics: 0=X endstop input, 1=Y endstop input, 2=Z endstop input, 3=E0 endstop input etc. If you have a Duex 2 or Duex 5 in your system, note that C5 thru C9 (the endstop inputs on the DueX) cannot be used for filament monitors, but C10 and C11 (the endstop inputs on the CONN_LCD connector) can.
Sn 0 = disable filament monitoring (default), 1 = enable filament monitoring when printing from SD card. Supported for all filament sensor types in firmwares 1.21.1 and in 2.0 and later. In firmware 1.21 this parameter is not supported for sensor types 1 and 2. Filament monitors accumulate calibration data (where applicable) even when filament monitoring is disabled.

Additional parameters for Duet3D laser filament monitor

Raa:bb Allow the filament movement reported by the sensor to be between aa% and bb% of the commanded values; if it is outside these values and filament monitoring is enabled, the print will be paused
Enn minimum extrusion length before a commanded/measured comparison is done, default 3mm
An (firmware 2.03 and later) 1 = check All extruder motion, 0 = only check extruder motion of printing moves (moves with both movement and forward extrusion)

Additional parameters for Duet3D rotating magnet filament monitor

Lnn Filament movement per complete rotation of the sense wheel, in mm
R, E, A As for Duet3D laser filament monitor

Additional parameters for a pulse generating filament monitor

Lnn Filament movement per pulse in mm
R, E As for Duet3D laser filament monitor

Example

M591 D0 P3 C3 S1 R70:130 L24.8 E3.0   ; Duet3D rotating magnet sensor for extruder drive 0 is connected to E0 endstop input, enabled, sensitivity 24.8mm.rev, 70% to 130% tolerance, 3mm detection length

M591 D0    ; display filament sensor parameters for extruder drive 0

Parameters (firmware 1.20 and earlier)

Dnn Extruder drive number (0, 1, 2...),
Pnn Type of sensor: 0=none, 1=simple sensor (high signal when filament present), 2=simple sensor (low signal when filament present), 3=Duet3D rotating magnet sensor, 4=Duet3D rotating magnet sensor with microswitch
Cnn Which input the filament sensor is connected to. On Duet electronics: 0=X endstop input, 1=Y endstop input, 2=Z endstop input, 3=E0 endstop input etc.

Additional parameters for Duet3D rotating magnet filament monitor

Snn Sensitivity, in mm of filament movement per complete rotation of the sense wheel.
Rnn Tolerance as a percentage of the commanded extrusion amount. A negative value puts the firmware in calibration mode.
Enn minimum extrusion length before a commanded/measured comparison is done, default 3mm

Examples

* M591 D0 P5 C3  R70:140 E3.0 S1   ; Duet3D rotating magnet sensor for extruder drive 0 is connected to E0 endstop input, sensitivity 1.05, tolerance 70% to 140%, 3mm detection length
* M591 D1 ; display filament sensor parameters for extruder drive 1

Documentation

Parameters

Dnn Extruder drive number (0, 1, 2...)
Annn A coefficient in the extrusion formula, default zero
Bnnn B coefficient in the extrusion formula, default zero
Lnnn Upper limit of the nonlinear extrusion compensation, default 0.2
T nnn Reserved for future use, for the temperature at which these values are valid

Examples

M592 D0 A0.01 B0.0005 ; set parameters for extruder drive 0

M592 D0 ; report parameters for drive 0

Most extruder drives use toothed shafts to grip the filament and drive it through the hot end. As the extrusion speed increases, so does the back pressure from the hot end, and the increased back pressure causes the amount of filament extruded per step taken by the extruder stepper motor to reduce. This may be because at high back pressures, each tooth compresses and skates over the surface of the filament for longer before it manages to bite. See forum post http://forums.reprap.org/read.php?262,80... and the graph at http://forums.reprap.org/file.php?262,fi... for an example.

Nonlinear extrusion is an experimental feature in RepRapFirmware to compensate for this effect. The amount of extrusion requested is multiplied by (1 + min(L, A*v + B*v^2)) where v is the requested extrusion speed (calculated from the actual speed at which the move will take place) in mm/sec.

Nonlinear extrusion is not applied to extruder-only movements such as retractions and filament loading.

Parameters

Fnnn Frequency of ringing to cancel in Hz. Zero or negative values disable the feature.
Lnnn Minimum acceleration allowed. The current default is 10mm/sec^2. It is unlikely that you will need to change this value.

Example

M593 F40.5  ; cancel ringing at 40.5Hz

Supported in firmware 2.02 and later. By default, Dynamic Acceleration Adjustment (DAA) is disabled. If it is enabled, then acceleration and deceleration rates will be adjusted per-move to cancel out ringing at the specified frequency. Acceleration limits set by M201 and M204 will still be honoured when DAA is enabled, so DAA will only ever reduce acceleration. Therefore your M201 and M204 limits must be high enough so that DAA can reduce the acceleration to the optimum value.

DAA is most useful to avoid exciting low-frequency ringing, for which S-curve acceleration is ineffective and may make the ringing worse. High-frequency ringing would be better countered by using S-curve acceleration.

To measure the ringing frequency, take a print that exhibits ringing on the perimeters (for example a cube), preferably printed single-wall or external-perimeters-first. Divide the speed at which the outer perimeter was printed (in mm/sec) by the distance between adjacent ringing peaks (in mm). When measuring the distance between peaks, ignore peaks close to the corner where the ringing started (these peaks will be spaced more closely) because the print head will have been accelerating in that area.

Cartesian and CoreXY printers will typically have different frequencies of ringing for the X and Y axes. In this case it is is usually best to aim to cancel the lower ringing frequency. If the frequencies are not much different, in a moving-bed cartesian printer you can reduce the higher ringing frequency by adding mass to that axis or reducing belt tension on that axis. Note that X axis ringing causes artefacts predominantly on the Y face of the test cube, and vice versa.

Parameters

Pn P1 = enter height following mode, P0 = leave height following mode

Height following mode allows the Z position of the tool to be controlled by a PID controller using feedback from a sensor. See also M951.

If a movement command (e.g. G1) explicitly mentions the Z axis while height following mode is active, existing moves in the pipeline will be allowed to complete and the machine allowed to come to a standstill. Then height following mode will be terminated and the new move executed.

This command behaves like M226 except that if macro file filament-change.g exists in /sys on the SD card, it is run in preference to pause.g. Supported in firmware 2.02 and later.

This command is sent by nanoDLP to set the parameters for the peel move used after curing a layer. RepRapFirmware 2.02 ignores this command. If you use RepRapFirmware 2.03 with nanoDLP, create an empty M650.g file in the /sys folder of the SD card so that RRF will ignore it without emitting an error message.

This command is sent by nanoDLP to execute a peel move after exposing a layer. RepRapFirmware 2.02 executes macro /sys/peel-move.g in response to this command. To use RepRapFirmware 2.03 or later with nanoDLP, create a macro file M651.g in the /sys folder of the SD card and populate it with the commands needed to execute the peel move.

Parameters

Lnnn Diagonal rod length²
Rnnn Delta radius
Bnnn Safe printing radius
Hnnn Nozzle height above the bed when homed after allowing for endstop corrections
Xnnn X tower position correction¹
Ynnn Y tower position correction¹
Znnn Z tower position correction¹

Examples

M665 L250 R160 B80 H240 X0 Y0 Z0

Set the delta calibration variables

Notes

¹X, Y and Z tower angular offsets from the ideal (i.e. equilateral triangle) positions, in degrees, measured anti-clockwise looking down on the printer.

²In RRF 2.03 and later, multiple L values can be provided, for example L260.1:260.2:260.0. The values are the lengths of the rods to the X, Y and Z towers respectively. If more than 3 values are provided, the firmware assumes that there are as many towers as L values up to the maximum supported (currently 6). The XY coordinates of the additional towers must be defined subsequently using the M669 command. If only one L value is provided, the machine is assumed to have 3 towers with all rods having the same length.

Parameters

Xnnn X axis endstop adjustment
Ynnn Y axis endstop adjustment
Znnn Z axis endstop adjustment
Annn X bed tilt in percent¹
Bnnn Y bed tilt in percent¹

Example

M666 X-0.1 Y+0.2 Z0

Sets delta endstops adjustments.

Positive endstop adjustments move the head closer to the bed when it is near the corresponding tower. Endstop corrections are expressed in mm.

¹RepRapFirmware 1.16 and later.

This command is deprecated in RRF 2.03 and later. Use M669 instead.

Parameters

Snnn CoreXY mode
Xnnn X axis scale factor (RRF 2.02 and earlier)
Ynnn Y axis scale factor (RRF 2.02 and earlier)
Znnn Z axis scale factor (RRF 2.02 and earlier)

Order dependency

M667 must come earlier in config.g than any M671 command.

Example

M667 S1

M667 S0 selects Cartesian mode (unless the printer is configured as a delta using the M665 command). Forward motion of the X motor moves the head in the +X direction. Similarly for the Y motor and Y axis, and the Z motor and Z axis. This is the default state of the firmware on power up.

M667 S1 selects CoreXY mode. Forward movement of the X motor moves the head in the +X and +Y directions. In firmware 1.19 and later, forward movement of the Y motor moves the head in the +X and -Y directions.

M667 S2 selects CoreXZ mode. Forward movement of the X motor moves the head in the +X and +Z directions. In firmware 1.19 and later, forward movement of the Z motor moves the head in the -X and +Z directions.

In versions of RRF prior to 2.03, additional parameters X, Y and Z may be given to specify factors to scale the motor movements by for the corresponding axes. For example, to specify a CoreXZ machine in which the Z axis moves 1/3 of the distance of the X axis for the same motor movement, use M667 S2 Z3. The default scaling factor after power up is 1.0 for all axes.

In RRF 2.03 and later the XYZ parameters are no longer supported. Use the M669 XYZ parameters to alter the movement matrix instead.

To change the motor directions, see the M569 command.

Parameters

Knnn Kinematics type: 0 = Cartesian, 1 = CoreXY, 2 = CoreXZ, 3 = linear delta, 4 = serial SCARA, 5 = CoreXYU, 6 = Hangprinter, 7 = polar, 8 = CoreXYUV, 9 = reserved for linear delta + Z axis, 10 = rotary delta, 11 = Mark Forged, 12 = reserved for Collinear Tripteron

Note: RepRapFirmware 2.03 and later can support any kinematics for which the movement of each axis is a linear combination of the movement of the motors. The relationship between axis movement and motor movement is defined by a matrix. So K0, K1, K2, K5, K8 and K11 all select the same kinematics, but with different default matrices.

Order dependency

M669 must come earlier in config.g than any M671 command.

Selects the specified kinematics, then uses the other parameters to configure it. If the K parameter is missing then the other parameters are used to update the configuration data for the current kinematics. If no parameters are given then the current kinematics and configuration parameters will be reported.

Xnn:nn:nn... Motor movement coefficients required to move X axis (first row of matrix)
Ynn:nn:nn... Motor movement coefficients required to move Y axis (second row of matrix)
Znn:nn:nn... Motor movement coefficients required to move Z axis (third row of matrix)
Unn:nn:nn..., Vnn:nn:nn... etc. Motor movement coefficients required to move U, V... axes (third and subsequent rows of matrix)

All these parameters are optional. The movement coefficient matrices are initialised to suitable value for the kinematics type you selected in the M667 or M669 command, but you can modify them using these parameters. If you send M669 with no parameters, the existing matrix will be reported.

Pnnn Proximal arm length (mm)
Dnnn Distal arm length (mm)
Annn:nnn Proximal arm joint movement minimum and maximum angles, in degrees anticlockwise seen from above relative to the X axis
Bnnn:nnn Proximal-to-distal arm joint movement minimum and maximum angles, in degrees anticlockwise seen from above relative to both arms in line
Cnnn:nnn:nnn Crosstalk factors. The first component is the proximal motor steps to equivalent distal steps factor, the second is the proximal motor steps to equivalent Z motor steps factor, and the third component is the distal motor steps to equivalent Z motor steps factor.
Rnnn (optional, RRF 2.03 and later only) Minimum permitted printing radius from the proximal axis. If not specified, it will be calculated to be slightly larger than the distance between nozzle and proximal axis when the distal axis is homed.
Snnn Segments per second (because smooth XY motion is approximated by means of segmentation)
Tnnn Minimum segment length (mm) (because smooth XY motion is approximated by means of segmentation)
Xnnn X offset of bed origin from proximal joint
Ynnn Y offset of bed origin from proximal joint

Examples

M669 K4 P300 D250 A-90:90 B-135:135 C0:0:0 S100 X300 Y0

The minimum and maximum arm angles are also the arm angles assumed by the firmware when the homing switches are triggered. The P, D, A and B parameters are mandatory. The C, X and Y parameters default to zero, and the segmentation parameters default to firmware-dependent values.

Annn Maximum turntable acceleration in degrees per second^2
Fnnn Maximum turntable speed in degrees per second
Hnnn Radius of the nozzle from the centre of the turntable when the radius arm homing switch is triggered
Raaa:bbb Minimum (aaa) and maximum (bbb) radius on the turntable reachable by the nozzle.
Snnn Segments per second (because smooth XY motion is approximated by means of segmentation)
Tnnn Minimum segment length (mm) (because smooth XY motion is approximated by means of segmentation)
Xnnn X offset of bed origin from turntable centre (not yet implemented)
Ynnn Y offset of bed origin from proximal joint (not yet implemented)

There is currently no facility for offsetting the radius arm sideways from the centre of rotation of the turntable, or for moving the origin.

Parameters

Pnn:nn:nn... List of logical port numbers that bits 0, 1, 2... control
Tnnn port switching time advance in milliseconds

RepRapFirmware 1.19 and later provides an optional P parameter on the G1 command to allow I/O ports to be set to specified states for the duration of the move. The argument to the P parameter is a bitmap giving the required state of each port. The M670 command specifies the mapping between the bits of that argument and logical port numbers. Optionally, the T parameter can be used to advance the I/O port switching a short time before the corresponding move begins.

Parameters

Xnn:nn:nn... List of between 2 and 4 X coordinates of the leadscrews that drive the Z axis or the bed levelling screws
Ynn:nn:nn... List of between 2 and 4 Y coordinates of the leadscrews that drive the Z axis or the bed levelling screws
Snn Maximum correction to apply to each leadscrew in mm (optional, default 1.0)
Pnnn Pitch of the bed levelling screws (not used when bed levelling using independently-driven leadscrews). Defaults to 0.5mm which is correct for M3 bed levelling screws.
Fnn Fudge factor, default 1.0

Order dependency

M671 must come later in config.g than any M667 or M669 command.

Example

M671 X-15.0:100.0:215.0 Y220.0:-20.0:220.0 ; Z leadscrews are at (-15,220), (100,-20) and (215,220)

Informs the firmware of the positions of the leadscrews used to raise/lower the bed or gantry. When this command is used to define the leadscrew positions, the numbers of X and Y coordinates must both be equal to the number of drivers used for the Z axis (see the M584 command). This allows the firmware to perform bed levelling by adjusting the leadscrew motors individually after bed probing. See the G32 command.

For machines without multiple independently-driven Z leadscrews, this command can also be used to define the positions of the bed levelling screws instead. Then bed probing can be used to calculate and display the adjustment required to each screw to level the bed. The thread pitch (P parameter) is used to translate the height adjustment needed to the number of turns of the levelling screws.

For printers that print directly onto a desktop and have levelling feet, this command can be used to define the coordinates of the levelling feet, so that bed probing can be used to calculate and display the adjustments needed to the feet. In this case the displayed corrections must be reversed. For example, "0.2 turn down" means the bed needs to be lowered or the printer raised by 0.2 turn lower at that screw position.

The firmware algorithm assumes perfect gimbal joints between the bed and the leadscrews, so that the bed is completely free to adopt the plane (or the twisted plane if there are 4 leadscrews) defined by the leadscrews. In real printers this is rarely the case and the corrections are insufficient to level the bed, so multiple G32 commands need to be sent if the bed is a long way off level. The F parameter allows for the corrections calculated by the firmware to be multiplied by a factor so as to achieve faster convergence in this situation.

Note: the M671 command in config.g must come after any command to change the kinematics, for example M667 or M669.

Parameters

Snn:nn:nn... Sequence of 8-bit unsigned values to send to the currently-selected Z probe

Example

M672 S105:50:205

This command is for sending configuration data to programmable Z probes such as the Duet3D delta effector, for example to set the sensitivity. The specified command bytes are sent to the probe. The Duet3D probe stores the configuration data in non-volatile memory, so there is no need to send this command every time the probe is used.

For the Duet3d smart effector:

*To program the sensor, send command M672 S105:aaa:bbb replacing aaa by the desired sensitivity and bbb by 255 - aaa. The green LED will flash 4 times if the command is accepted. When you subsequently power up the effector, the green LED will flash three times instead of twice to indicate that a custom sensitivity is being used.

*To revert to factory settings, send command M672 S131:131. The green LED will flash 5 times if the command is accepted. When you subsequently power up the effector, the green LED will flash twice to indicate that default settings are being used.

See the Smart effector and carriage adapters for delta printer documentation for more details.

Parameters

U,V,W,A,B,C Rotary axis name on which the plane is mounted
Pnnn Factor to multiply the correction amount with (defaults to 1)

Example

M673 A

This code is intended to align a plane that is mounted on a rotary axis. This code is intended to align a plane that is mounted on a rotary axis. To make use of this code it is required to take two probe points via G30 P first.

Supported in RepRapFirmware 2.02 and later.

This code is intended to determine the Z center point of a stash that is mounted on a rotary axis. This code is yet to be implemented.

Parameters

X,Y,Z Axis to probe on
Fnnnn Probing feedrate
Rnnn Distance to move away from the lower endstop before the next probing move starts

Examples

M675 X R2 F1200

This code is intended to find the center of a cavity that can be measured using the configured axis endstop. If using a Z probe for this purpose, make sure the endstop type for the corresponding axis is updated before this code is run. Once this code starts, RepRapFirmware will move to the lower end looking for an endstop to be triggered. Once it is triggered, the lower position is saved and the axis maximum is probed. As soon as both triggers have been hit, the center point is calculated and the machine moves to the calculated point.

Parameters

This command can be used without any additional parameters.
Snn Filament to load

Example

M701 S"PLA"

RepRapFirmware 1.19 and later implements a filament management mechanism to load and unload different materials.

This code may be used to load a material for the active tool, however be aware that this code will work only for tools that have exactly one extruder assigned.

When called the firmware does the following:

1) Run the macro file "load.g" in the subdirectory of the given material (e.g. /filaments/PLA/load.g)

2) Change the filament name of the associated tool, so it can be reported back to Duet Web Control

If this code is called without any parameters, RepRapFirmware will report the name of the loaded filament (if any).

Parameters

This command can be used without any additional parameters.

Example

M702

In contrast to M701 this code is intended to unload the previously loaded filament from the selected tool. RepRapFirmware will do the following when called:

1) Run the macro file "unload.g" in the subdirectory of the given material (e.g. /filaments/PLA/unload.g)

2) Change the filament name of the current tool, so it can be reported back to Duet Web Control

Parameters

This command can be used without any additional parameters.

Example

M703

After assigning a filament to a tool, this command may be used to run /filaments/<filament name>/config.g to set parameters like temperatures, extrusion factor, retract distance. If no filament is loaded, the code completes without a warning.

If the filaments feature is used, it is recommended to put this code into tpost*.g to ensure the right filament parameters are set. Supported in RepRapFirmware 2.02 and newer.

Example

M750

This code may be used as an OEM extension to enable scanner functionality in the firmware. After a regular start of RepRapFirmware, the 3D scan extension is disabled by default, but if additional scanner components are attached, this code may be used to enable certain OEM functions.

Example

M751

When a 3D scanner board is attached to the USB port, this code is used to turn on communication between the 3D printing and the scanner board. If the USB connection is removed while the 3D scanner configuration is active, the firmware will disable it again and restore the default communication parameters.

Parameters

Snnn: Length/degrees of the scan
Rnnn: Resolution (new in RRF 2.0) [optional, defaults to 100]
Nnnn: Scanner mode (new in RRF 2.0) [optional, 0=Linear (default), 1=Rotary]
Pnnn: Filename for the scan

Example

M752 S300 Pmyscan

Instruct the attached 3D scanner to initiate a new 3D scan and to upload it to the board's SD card (i.e. in the "scans" directory). Before the SCAN command is sent to the scanner, the macro file "scan_pre.g" is executed and when the scan has finished, the macro file "scan_post.g" is run. Be aware that both files must exist to avoid error messages.

Example

M753

Instruct the attached 3D scanner to cancel the current operation. Cancelling uploads is not supported.

Parameters

Nnnn: Scanner mode (new in RRF 2.0) [optional, 0=Linear (default), 1=Rotary]

Example

M754

Calibrates the attached 3D scanner. Before the calibration is performed by the external scanner, "calibrate_pre.g" is run and when it is complete, "calibrate_post.g" is executed.

Parameters

Pnnn Whether to turn on (> 0) or off (<= 0) the alignment feature

Examples

M755 P1

M755 P0

Sends the ALIGN ON/OFF command the attached 3D scanner. Some devices turn on a laser when this command is received. If the 'P' parameter is missing, equal to, or less than 0, the alignment feature is turned off. Depending on whether the alignment is turned on or off, either align_on.g or align_off.g is executed before the ALIGN command is sent to the scanner.

Example

M756

Sends the SHUTDOWN command the attached 3D scanner.

Supported in RepRapFirmware version 1.16 and later.

Parameters

Pnnn Current date in the format YYYY-MM-DD
Snnn Current time in the format HH:MM:SS

Example

M905 P2016-10-26 S00:23:12

Updates the machine's local date and time or reports them if no parameters are specified. The time should be specified in 24-hours format as in "13:45" instead of 1:45PM.

Parameters

Xnnn X drive motor current¹
Ynnn Y drive motor current¹
Znnn Z drive motor current¹
Ennn E drive(s) motor current(s)¹
Innn Motor current idle factor (0..100)²

Order dependency

This command must be later in config.g than any M584 command.

Example

M906 X300 Y500 Z200 E350:350

Sets the currents to send to the stepper motors for each axis. The values are in milliamps.

Notes

¹Current setting on the Duet 2 WiF/Ethernet is done in steps of 100mA and is rounded down. Current setting on the Duet Maestro is in steps of 50mA and rounded down.

²This is the percentage of normal that the motor currents should be reduced to when the printer becomes idle but the motors have not been switched off. The default value is 30% and will always be at least 100mA - starting from RRF 2.02 setting it to 0 will disable the steppers after timeout like M18|M84 do and if an axis is related to the motor, throw out the "homing" of it, since it is likely that the position cannot be precisely determined anymore.

Firmware 1.20 and later:

Parameters

Saaa Auto save threshold in volts. The print will be stopped automatically and resume parameters saved if the voltage falls below this value. Set to around 1V to 2V lower than the voltage that appears at the Duet VIN terminals at full load. A negative or zero value disables auto save.
Raaa Resume threshold in volts. Must be greater than the auto save voltage. Set to a high value to disable auto resume.
P"command string" G-Code commands to run when the print is stopped.

Example

M911 S19.8 R22.0 P"M913 X0 Y0 G91 M83 G1 Z3 E-5 F1000"

When the supply voltage falls below the auto save threshold while a print from SD card is in progress, all heaters will be turned off, printing will be stopped immediately (probably in the middle of a move), the position saved, and the specified command string executed. You should typically do the following in the command string:

*If possible, use M913 to reduce the motor current in order to conserve power. For example, on most printers except deltas you can probably set the X and Y motor currents to zero.

*Retract a little filament and raise the head a little. Ideally the retraction should happen first, but depending on the power reserve when low voltage is detected, it may be best to do both simultaneously.

M911 with no parameters displays the current enable/disable state, and the threshold voltages if enabled.

Firmware 1.19:

Parameters

Saaa:bbb:ccc Shutdown threshold (aaa), pause threshold (bbb) and resume threshold (ccc) all in volts, with aaa < bbb < ccc

Example

M911 S12.0:19.5:22.0

Enables auto-pause if the power voltage drops below the pause threshold. The firmware records the current state of the print so that it can be resumed when power is restored and executes the pause procedure to attempt to park the print head using the residual energy in the power supply capacitors. If the supply voltage continues to drop below the shutdown threshold, the firmware disables all heaters and motors and goes into the shutdown state until either the voltage exceeds the resume threshold or the board is reset. In either case, it may be possible to resume the paused print. If the supply voltage does not fall below the shutdown threshold but recovers and exceeds the resume threshold, then the print is resumed automatically.

If any of the three values is zero or negative, or the three values are not in ascending order, then auto-save is disabled.

M911 with no parameters displays the current enable/disable state, and the threshold voltages if enabled.

Parameters

Pnnn Temperature monitor channel, default 0
Snnn Value to be added to the temperature reading in degC

Example:

M912 P0 S10.5

Many microcontrollers used to control 3D printers have built-in temperature monitors, but they normally need to be calibrated for temperature reading offset. The S parameter specifies the value that should be added to the raw temperature reading to provide a more accurate result.

(Currently only for the CPU on-chip temperature sensor P0. Other P parameter could in the future be added for boards with multiple on-chip sensors)

Parameters

X, Y, Z, E Percentage of normal current to use for the specified axis or extruder motor(s)

Example:

M913 X50 Y50 Z50 ; set X Y Z motors to 50% of their normal current

M913 E30:30 ; set extruders 0 and 1 to 30% of their normal current

This allows motor currents to be set to a specified percentage of their normal values as set by M906. It can be used (for example) to reduce motor current during course homing, to make homing quieter or to reduce the risk of damage to endstops, and to reduce current while loading filament to guard against the possibility of feeding too much filament. Use M913 again with the appropriate parameters set to 100 to restore the normal currents.

Important! When M913 is executed, it does not wait for all motion to stop first (unlike M906). This is so that it can be used in the M911 power fail script. When using M913 elsewhere, you will typically want to use M400 immediately before M913.

This command is supported in the Alligator build of RepRapFirmware only.

Parameters

Sn Expansion voltage signal level, n must be 3 or 5

Example

M914 S5 ; set expansion signal level to 5V

M914 ; report expansion signal voltage level

Parameters

Pnnn:nnn:... Drive number(s) to configure
X,Y,Z,U,V,W,A,B,C Axes to configure (alternative to using the P parameter)
Snnn Stall detection threshold (-64 to +63, values below -10 not recommended). Lower values make stall detection more sensitive. S3 is a good starting point for many motors.
Fn Stall detection filter mode, 1 = filtered (one reading per 4 full steps), 0 = unfiltered (default, 1 reading per full step)
Hnnn (optional) Minimum motor full steps per second for stall detection to be considered reliable, default 200
Tnnn (optional) Coolstep control register, 16-bit unsigned integer
Rn Action to take on detecting a stall from any of these drivers: 0 = no action (default), 1 = just log it, 2 = pause print, 3 = pause print, execute /sys/rehome.g, and resume print

Order dependency

If this command refers to any axes other than X, Y and Z then it must appear later in config.g than the M584 command that creates those additional axes.

Examples

M915 P0:2:3 S10 F1 R0
M915 X Y S5 R2

This sets the stall detection parameters and optionally the low-load current reduction parameters for TMC2660, TMC2130 or similar driver chips. Use either the P parameter to specify which driver number(s) you want to configure, or the axis names of the axes that those motors drive (the parameters will then be applied to all the drivers associated with any of those axes).

If any of the S, F, T and R parameters are absent, the previous values for those parameters associated with the specified drivers will continue to be used. If all the parameters are absent, the existing settings for the specified drive(s) will be reported.

See the Trinamic TMC2660 and TMC2130 datasheets for more information about the operation and limitations of motor stall detection.

Supported in firmware 1.20 beta 2 and later.

Parameters

none

Example

M916

If the last print was not completed and resume information has been saved (either because the print was paused or because of a power failure), then the heater temperatures, tool selection, head position, mix ratio, mesh bed compensation height map etc. are restored from the saved values and printing is resumed.

RepRapFirmware also requires macro file /sys/resurrect-prologue.g to be present on the SD card before you can use M916. This file is executed after the heater temperatures have been set, but before waiting for them to reach the assigned temperatures. You should put commands in this file to home the printer as best as you can without disturbing the print on the bed. To wait for the heaters to reach operating temperature first, use command M116 at the start of the file.

Version 1.19 of RepRapFirmware does not support M916 but you can achieve the same effect using command M98 P/sys/resurrect.g.

Supported in firmware 1.20 beta 7 and later for the Duet 2 Maestro.

Parameters

X,Y,Z,E Percentage of normal current to use when the motor is standing still or moving slowly, default 100

Order dependency

If this command refers to any axes other than X, Y and Z then it must appear later in config.g than the M584 command that creates those additional axes.

Example

M917 X70 Y70 Z80 E70:70

Some motor drivers (e.g. TMC2660) allow higher motor currents to be used while the motor is moving. This command sets the percentage of the current set by M906 that is to be used when the motor is stationary but not idle, or moving very slowly.

Standstill current reduction is not the same as idle current reduction. The standstill current must be high enough to produce accurate motion at low speeds. The idle current needs only to be high enough to hold the motor position well enough so that when the current is restored to normal, the position is the same as it was before the current was reduced to idle.

This command is used to tell RepRapFirmware about a directly-connected dumb LCD or similar display. Supported on Duet 2 Maestro.

Parameters

Pn Directly-connected display type: P1 = 128x64 pixel mono graphics display using ST7920 display driver chip
En The number of pulses generated by the rotary encoder per detent. Typical values are 2 and 4. Negative values (e.g. -2 and -4) reverse the encoder direction.
F (optional, supported in RRF 2.03 and later) SPI clock frequency in Hz, default 2000000 (i.e. 2MHz)

Example

M918 P1 E2

Parameters

P"filename" The name of the file to log to. Only used if the S1 parameter is present. A default filename will be used if this parameter is missing.
Sn S1 = start logging, S0 = stop logging

Example

M929 P"eventlog.txt" S1 ; start logging to file eventlog.txt
M929 S0 ; stop logging

When event logging is enabled, important events such as power up, start/finish printing and (if possible) power down will be logged to the SD card. Each log entry is a single line of text, starting with the date and time if available, or the elapsed time since power up if not. If the log file already exists, new log entries will be appended to the existing file.

Caution: do not rename or delete the current log file while logging is enabled!

Supported in RepRapFirmware 3.

M950 is used to create heaters, fans and GPIO ports and to assign pins to them. Each M950 command assigns a pin or pins to a single device. So every M950 command must have exactly one of the H, F, P or S parameters.

If a M950 command has C and/or Q parameters, then the pin allocation and/or frequency will be configured accordingly. Otherwise, the current configuration will be reported.

Parameters:

Hnn Heater number
Fnn Fan number
Pnn or Snn GPIO or Servo number (the only difference is the default PWM frequency)
C"name" Pin name(s) and optional inversion status. Pin name "nil" frees up the pin. A leading '!' character inverts the output. A leading '^' character enables the pullup resistor. The '^' and '!' characters may be placed in either order.
Qnn PWM frequency in Hz (optional)
T Temperature sensor number, required only when creating a heater [not yet implemented]. See M308.

Examples:

M950 H1 C"out1" Q100 T1 ; create heater 1
M950 H2 C"nil" ; disable heater 2 and free up the associated pin
M950 F3 C"heater2" Q100 ; Fan 3 is connected to heater 2 pin, PWM at 100Hz
M950 P0 C"exp.heater3" ; create GPIO port 0 attached to heater 3 pin on expansion connector
M950 F2 C"!fan2+^pb6" ; Fan 2 uses the Fan2 output, but we are using a PWM fan so the output needs to be inverted, also we are using PB6 as a tacho input with pullup resistor enabled

Supported in RepRapFirmware 3.x

Height following mode allows the Z position of the tool to be controlled by a PID controller using feedback from a sensor. See also M594.

Parameters:

Snn or Hnn Sensor number
Pnn.n Proportional factor, in mm per sensor unit
Inn.n Integral factor, in mm per sensor unit per second
Dnn.n Derivative factor, in mm per rate of change of sensor units (change in sensor unit per second)
Fnn.n (optional) Sample and correction frequency (Hz), default 5Hz
Znn.n:nn.n Minimum and maximum permitted Z values

If commanding the motors to increase Z causes the sensor value to increase, then all of P, I and D must be positive. If commanding the motors to increase Z causes the sensor value to decrease, then all of P, I and D must be negative.

Parameters

Sn.n Requested bit rate in Mbits/second. Ignored if it is lower than the bit rate for the negotiation phase.
T0.n Fraction of the bit time between the bit start and the sample point (optional)
J0.n Maximum jump time as a fraction of the bit time (optional)
C0.n Transmitter delay compensation time in nanoseconds (optional)

Example

M952 S4.0 T0.6 J0.2

This command allows the bandwidth of the CAN bus to be optimised, by increasing the data rate during transmission of CAN-FD data packets by means of the BRS (bit rate switch) feature. The maximum speed supported by CAN-FD is 8Mbits/sec but the practical limit depends on the cable length, cable quality, number of devices on the bus and CAN interface hardware used. The rate specified will be rounded down to the nearest achievable rate.

Parameters

Snnn Firmware module number(s), default 0

Example:

M997 S0:1 - update firmware modules 0 and 1

This command triggers a firmware update if the necessary files are present on the SD card. In RepRapFirmware on the Duet series, module numbers are as follows:

0 - main firmware, filename sys/RepRapFirmware.bin (older Duets) or sys/Duet2CombinedFirmware (Duet 2). File sys/iap.bin (Duet) or sys/iap4e.bin (Duet 2) must also be present.

1 - web server firmware, filename sys/DuetWiFiServer.bin (Duet 2 WiFi only)

2 - web server file system, filename sys/DuetWebControl.bin (needed only when using RepRapFirmware 1.18 series and earlier for Duet 2 WiFi)

3 - put the WiFi module into bootloader mode, so that firmware can be uploaded directly via its serial port

See Installing and Updating Firmware for detailed documentation.

Parameters

Pnnn Line number

Example

M998 P34

Request a resend of line 34. In some implementations the input-handling code overwrites the incoming G Code with this when it detects, for example, a checksum error. Then it leaves it up to the GCode interpreter to request the resend.

Parameters

This command can be used without any additional parameters.
Pnnn Reset flags¹

Example

M999

Restarts the firmware using a software reset.

Notes

¹This also puts the board into firmware upload mode (as if the Erase button had been pressed) if parameter PERASE is present.

----

Parameters

nnn: Tool number to select. A negative number deselects all tools.
R1: Select the tool that was active when the print was last paused (firmware 1.20 and later)
Pnnn: Bitmap of all the macros to be run (dc42 build 1.19 or later and ch fork 1.17b or later)
Tool number

Example

T0 ; select tool 0
T1 P0 ; select tool 1 but don't run any tool change macro files
T R1 ; select the tool that was active last time the print was paused
T ; report the current tool number

If Tn is used to select tool n but that tool is already active, the command does nothing. Otherwise, the sequence followed is:

If another tool is already selected and all axes have been homed, run macro tfree#.g where # is the number of that tool
If another tool is already selected, deselect it and set its heaters to their standby temperatures (as defined by the R parameter in the most recent G10 command for that tool)
If all axes have been homed, run macro tpre#.g where # is the number of the new tool
Set the new tool to its operating temperatures specified by the S parameter in the most recent G10 command for that tool
If all axes have been homed, run macro tpost#.g where # is the number of the new tool. Typically this file would contain at least a M116 command to wait for its temperatures to stabilise.
Apply any X, Y, Z offset for the new tool specified by G10
Use the new tool.

Selecting a non-existent tool (100, say) just does Steps 1-2 above¹. That is to say it leaves the previous tool in its standby state. You can, of course, use the G10 command beforehand to set that standby temperature to anything you like.

After a reset tools will not start heating until they are selected. You can either put them all at their standby temperature by selecting them in turn, or leave them off so they only come on if/when you first use them. The M0, M1 and M112 commands turn them all off. You can, of course, turn them all off with the M1 command, then turn some back on again. Don't forget also to turn on the heated bed (if any) if you use that trick.

Tool numbering starts at 0 by default however M563 allows the user to specify tool numbers, so with them you can have tools 17, 99 and 203 if you want. Negative numbers are not allowed.

Notes

¹ Selecting a non-existent tool also removes any X/Y/Z offset applied for the old tool.

² Under special circumstances, the execution of those macro files may not be desired. RepRapFirmware 1.19 or later supports an optional P parameter to specify which macros shall be run. If it is absent then all of the macros above will be run, else you can pass a bitmap of all the macros to be executed. The bitmap of this value consists of tfree=1, tpre=2 and tpost=4.

Note that you may wish to include a move to a parking position 'within the tfreeN.g gcode macro in order to allow the new extruder to reach temperature while not in contact with the print.

----

Codes for print head movements follow the http://www.nist.gov/manuscript-publicati..., so RepRapFirmware should be usable for CNC milling and similar applications but be aware of the G-Codes not implemented. See also on https://en.wikipedia.org/wiki/G-code.

For more information and background, along with the master list of all RepRap G-Codes check the http://reprap.org/wiki/G-code.

For the technically minded, G-Code line endings are Unix Line Endings (\n), but will accept Windows Line Endings (\r\n), so you should not need to worry about converting between the two, but it is best practice to use Unix Line Endings where possible.

All communication is in printable ASCII characters. Messages sent back

to the host computer are terminated by a newline and look like this:

xx [line number to resend] [T:93.2 B:22.9] [C: X:9.2 Y:125.4 Z:3.7 E:1902.5] [Some debugging or other information may be here]

xx can be one of:

ok means that no error has been detected.

rs means resend, and is followed by the line number to resend.

!! means that a hardware fault has been detected. The RepRap machine will

shut down immediately after it has sent this message.

The T: and B: values are the temperature of the currently-selected extruder

and the bed respectively, and are only sent in response to M105. If such temperatures don't exist (for example for an extruder that works at room temperature and doesn't have a sensor) then a value below absolute zero (-273^oC) is returned.

C: means that coordinates follow. Those are the X: Y: etc values. These are only

sent in response to M114 and M117.

The RepRap machine may also send lines that look like this:

// This is some debugging or other information on a line on its own. It may be sent at any time.

Such lines will always be preceded by //.

On the latest version of Pronterface and Octoprint (1.2.0+) a special comment of the form:

// action:command

is allowed to be sent from the firmware, the command can currently be pause, resume or disconnect which will execute those commands on the host.

As this is also a comment other hosts will just ignore these commands.

The most common response is simply:

When the machine boots up it sends the string

start

once to the host before sending anything else. This should not be replaced or augmented

by version numbers and the like. M115 (see above) requests those.

All this means that every line sent by RepRap to the host computer except the start line has a two-character prefix (one of ok, rs, !! or //). The machine should never send a line without such a prefix.

Exceptions:

RepRapFirmware responds to some commands with a reply string in JSON format, terminated by a newline. This allows later firmware revisions to include additional information without confusing clients (e.g. PanelDue) that do not expect it, and to make responses self-describing so that the client will not be confused if responses are delayed or lost. The commands affected are:

M20 S2
M36
M408

Slicers will optionally add G-Code scripts to the beginning and end of their output file to perform specified actions before and/or after a print such as z-probing the build-area, heating/cooling the bed and hotend, performing ooze free "nozzle wipe" startup routine, switching system power on/off, and even "ejecting" parts. For general information and examples (not specific to RepRapFirmware) there is more info on the http://reprap.org/wiki/Start_G-Code_rout... and http://reprap.org/wiki/End_G-Code_routin... pages.

2 Comments

Add Comment

Hi, can somebody with knowledge elaborate on an example for M143 -> Annn? What does “Switch heater of temporarily” mean? Will it pause and unpause automatic? In a print? With a heater fault I can say for sure that it will “pause(.g)” the print, but then I can reset the heater fault and resume. How is the behaviour with the other 2 options?

Lucas Bahle - May 7 Reply

AFAIR mode 1 turns off the heater once it reaches the threshold. In mode 2 it is turned off as long as the protect condition is met. No heater fault is generated in both cases, thus the print is not paused either. This heater protection system allows multiple sensors (even RH sensors) to be coupled to a single heater. Another use-case could be a the protection of a heater using a backup temperature sensor.

The last example in the M143 description already describes a valid demo of mode 2.

Christian Hammacher - May 7

Gcode

Introduction

G-Code Everywhere

G-Code Structure

Comments

Fields

Case sensitivity

Quoted strings

Checking

Multiple commands on a single line

Buffering

G-commands

G0 & G1: Move

G2 & G3: Controlled Arc Move

G4: Dwell

G10: Tool Offset

G10: Set workplace coordinate offset or tool offset

G10: Retract

G11: Unretract

G17: Select XY plane for arc moves

G20: Set Units to Inches

G21: Set Units to Millimeters

G28: Home

G29: Mesh bed probe

G30: Single Z-Probe

G31: Set or Report Current Probe status

G32: Probe Z and calculate Z plane

G53 Use absolute coordinates

G54 to G59.3: Select coordinate system

G60: Save current position to slot

G90: Set to Absolute Positioning

G91: Set to Relative Positioning

G92: Set Position

M-commands

M0: Stop or Unconditional stop

M1: Sleep or Conditional stop

M3: Spindle On, Clockwise (CNC specific)

M4: Spindle On, Counterclockwise (CNC specific)

M5: Spindle Off (CNC specific)

M18: Disable all stepper motors

M20: List SD card

M21: Initialize SD card

M22: Release SD card

M23: Select SD file

M24: Start/resume SD print

M25: Pause SD print

M26: Set SD position

M27: Report SD print status

M28: Begin write to SD card

M29: Stop writing to SD card

M30: Delete a file on the SD card

M32: Select file and start SD print

M36: Return file information

M37: Simulation mode

M38: Compute SHA1 hash of target file

M39: Report SD card information

M42: Switch I/O pin

M80: ATX Power On

M81: ATX Power Off

M82: Set extruder to absolute mode

M83: Set extruder to relative mode

M84: Stop idle hold

M92: Set axis steps per unit

M98: Call Macro/Subprogram

M99: Return from Macro/Subprogram

M104: Set Extruder Temperature

M105: Get Extruder Temperature

M106: Fan On

M107: Fan Off

M108: Cancel Heating

M109: Set Extruder Temperature and Wait

M110: Set Current Line Number

M111: Set Debug Level

M112: Emergency Stop

M114: Get Current Position

M115: Get Firmware Version and Capabilities

M116: Wait

M117: Display Message

M118: Send Message to Specific Target

M119: Get Endstop Status