Dictionary - Longus/FluidNC GitHub Wiki
Status Notes
Contents items without working links are marked with inline Code Spans
``
Items requiring attention are marked ✪
Config Key Dictionary
See FluidNC-Config-File-Overview
allow_single_axis:
Type:Boolean
Default: true
Details: Allows single axis homing for the axis (example: $HX to home the X axis).
Set to false if you do not have limits switches, or to block the command. You might want to block it because a single axis home unlocks the machine even though other axes may not be homed. Soft limits are only accurate on homed axes and will not protect a machine that has not homed all axes.
axes:
Type: Section name.
See FluidNC-Motor-Setup
Details: ✪
board:
Type: ✪
Range: ✪character limit?
Default: Null
Interactions: None
Details: Descriptive text such as "ESP32 Dev Controller V4".
card_detect_pin:
Type: ESP 32 Pin
Range: ✪
Default: ✪
Interactions: ✪
Details: ✪
coolant:
Type: Section name.
See Coolant
Details: ✪
cs_pin:
Type: ESP 32 Pin
Range: ✪
Default: ✪
Interactions: ✪
Details: ✪
control:
Type: Section name.
See [✪](https://github.com/longus/FluidNC/wiki/✪)
Details: ✪
cycle:
Type: [Integer]()
Range: -1 to 6
Default: -1
Interactions: multi-axis homing cannot be used with CoreXY, because 2 motors are used for each axis move.
Details: A setting of 1 or greater enables the axis for homing with $H. Anything lower than 1 will be an inactive cycle and no homing will occur for that axis.
Homing cycles allow you to home axes sequentially or group a few axes into a single cycle for multi-axis homing. Assign the same number to multiple axes to home them in the same cycle.
Typically you would put the Z axis on cycle: 1 and the other axes on higher cycles.
dir_delay_us:
Type: [✪]()
Range: ✪
Default: ✪
Interactions: ✪
Details: ✪
direction_pin:
Type: ESP 32 Pin
Range: ✪
Default: ✪
Interactions: ✪
Details: ✪
direction_pin:
Type: ESP 32 Pin
Range: ✪
Default: ✪
Interactions: ✪
Details: ✪
direction_pin:
Type: ESP 32 Pin
Range: ✪
Default: ✪
Interactions: ✪
Details: ✪
disable_delay_us:
Type: [✪]()
Range: ✪
Default: ✪
Interactions: ✪
Details: ✪
disable_pin:
Type: ESP 32 Pin
Range: ✪
Default: ✪
Interactions: ✪
Details: ✪
disable_pin:
Type: ESP 32 Pin
Range: ✪
Default: ✪
Interactions: ✪
Details: ✪
disable_with_s0:
Type: [✪]()
Range: ✪
Default: ✪
Interactions: ✪
Details: ✪
enable_pin:
Type: ESP 32 Pin
Range: ✪
Default: ✪
Interactions: ✪
Details: ✪
engine:
Type: [✪]()
Range: [RMT | TIMED | I2S_static | I2S_STREAM]
Default: ✪
Interactions: ✪
Details: ✪
feed_mm_per_min
Type: Float
Range: ✪, workable values are generally 50.000 — 100.000
Default: 50.000
Details: Usually a slower rate when in close proximity to the limit switch, to do the pulloff and second touch.
feed_scaler
Type: Float
Range: ✪, workable value is slightly higher than 1
Default: 1.100
Details: Sets how far the machine will move to try to find the limit switch in the slower feed phase of homing. It is multiplied by the pulloff_mm of the axis. For example, where feed_scaler is 1.100, and pulloff_mm is 3.000, the controller will give up after moving 3.300 mm.
flood_pin:
Type: ESP 32 Pin
Range: ✪
Default: ✪
Interactions: ✪
Details: ✪
hard_limits
Type: Boolean
Default: false
Details: Enables the use of limit switches to stop the motor when you get to the end of travel. It only works if you have a limit switch at each end. When a limit switch is touched, motion is stopped in a rapid uncontrolled manner, an alarm is given, accurate position is lost, and you must re-home.
Since they are controlled by limit switches this is defined at the same level as the limit switches, in the axes/[x|y|z|a|b|c]/motor[0|1] section.
homing: (see [FluidNC Limit Switch and Homing Setup
(https://github.com/longus/FluidNC/wiki/FluidNC-Homing))
i2so:
Type: Section name.
See [✪](https://github.com/longus/FluidNC/wiki/✪)
Details: ✪
idle_ms:
Type: [✪]()
Range: ✪
Default: ✪
Interactions: ✪
Details: ✪
limit_all_pin:
Type: ESP 32 Pin
Range: ✪
Default: NO_PIN
Interactions: Cannot be used with limit_neg_pin or limit_pos_pin.
Details: Used when you have 2 limit switches, one at each end of travel, wired to one input pin.
The drawback to this configuration is that if a limit switch is activated before homing, the controller does not know at which end of travel the activated limit switch is located. Since it could be either end, it cannot know which direction is appropriate, so it cannot pull off. You must do pull off manually.
limit_neg_pin:
Type: ESP 32 Pin
Range: ✪
Default: NO_PIN
Interactions: Cannot be used with the limit_all_pin
Details: Pin used for the limit switch at the negative end of travel.
limit_pos_pin:
Type: [ESP 32 Pin](https://github.com/bdring/
FluidNC/wiki/FluidNC-Setting-Up-I-O-Pins)
Range: ✪
Default: NO_PIN
Interactions: Cannot be used with the limit_
all_pin.
Details: Pin used for the limit switch at the positive end of travel.
macros:
Type: Section name.
See [✪](https://github.com/longus/FluidNC/wiki/✪)
Details: ✪
max_travel_mm:
Type: [✪]()
Range: ✪
Default: ✪
Interactions: ✪
Details: ✪
miso_pin:
Type: ESP 32 Pin
Range: ✪
Default: ✪
Interactions: ✪
Details: ✪
mist_pin:
Type: ESP 32 Pin
Range: ✪
Default: ✪
Interactions: ✪
Details: ✪
mosi_pin:
Type: ESP 32 Pin
Range: ✪
Default: ✪
Interactions: ✪
Details: ✪
motor[0|1]:
Type: Section name.
see FluidNC-Motor-Setup)
Details: ✪
mpos_mm:
Type: Float
Range: ✪
Default: 0.000
Details: Sets the machine position after homing and limit switch pulloff in millimeters. If you want the machine position to be zero at the limit switch, set this to zero. Keep in mind the homing direction ([positive_direction]()) and the [pulloff_mm]() values when you choose this number.
ms1_pin:
Type: ESP 32 Pin
Range: ✪
Default: ✪
Interactions: ✪
Details: ✪
ms1_pin:
Type: ESP 32 Pin
Range: ✪
Default: ✪
Interactions: ✪
Details: ✪
ms2_pin:
Type: ESP 32 Pin
Range: ✪
Default: ✪
Interactions: ✪
Details: ✪
ms2_pin:
Type: ESP 32 Pin
Range: ✪
Default: ✪
Interactions: ✪
Details: ✪
ms3_pin:
Type: ESP 32 Pin
Range: ✪
Default: ✪
Interactions: ✪
Details: ✪
ms3_pin:
Type: ESP 32 Pin
Range: ✪
Default: ✪
Interactions: ✪
Details: ✪
name:
Type: String
Range: ✪character limit?
Default: Null
Interactions: None
Details: Descriptive text such as "ESP32 Dev Controller V4".
null_motor
Type:
Range: ✪
Default:
Interactions:
Details:
output_pin:
Type: [✪]()
Range: ✪
Default: ✪
Interactions: ✪
Details: ✪
positive_direction:
Type: Boolean
Default: true
Details: Controls the direction in which the axis moves when homing. true will home in the positive direction, where positive means moving towards a higher position value.
probe:
Type: Section name.
See [Probe](https://github.com/longus/FluidNC/wiki/Probe)
Details: ✪
probe_pin:
Type: [✪]()
Range: ✪
Default: ✪
Interactions: ✪
Details: ✪
pulloff_mm
Type: Float
Range: ✪
Default: 1.000
Details: Sets how many millimeters the motor will back off of the limit switch after touching. If you have a 2 motor ganged axis and your limit switches are not accurately aligned, you can give each axis a slightly different value.
pulse_us:
Type: [✪]()
Range: ✪
Default: ✪
Interactions: ✪
Details: ✪
PWM:
Type: Section name.
See Fluid-Spindle-Setup
Details: ✪
pwm_hz:
Type: [✪]()
Range: ✪
Default: ✪
Interactions: ✪
Details: ✪
reset_pin:
Type: ESP 32 Pin
Range: ✪
Default: ✪
Interactions: ✪
Details: ✪
s0_with_disable:
Type: [✪]()
Range: ✪
Default: ✪
Interactions: ✪
Details: ✪
sck_pin:
Type: ESP 32 Pin
Range: ✪
Default: ✪
Interactions: ✪
Details: ✪
sdcard:
Type: Section name.
See SD Card
Details: ✪
seek_mm_per_min
Type: Float
Range: greater than 0.000, workable values are generally 200.000 — 800.000
Default: 200.000
Details: Usually a faster rate to do the initial seeking of the limit switch.
seek_scaler
Type: Float
Range: ✪, workable value is slightly higher than 1
Default: 1.100
Details: Sets how far the machine will move to try to find the limit switch. It is multiplied by the max_travel_mm of the axis. For example, where seek_scaler is 1.100, and max_travel_mm is 500.000, the controller will give up after moving 550.000 mm.
settle_ms
Type: 32-bit Unsigned Integer
Range: ✪, workable values are generally 250 — 500
Default: 250
Details: Sets the amount of time (in milliseconds) the machine will pause between moves to allow the machine to settle.
shared_stepper_disable_pin:
Type: ESP 32 Pin
Range: ✪
Default: NO_PIN
Interactions: ✪
Details: ✪
soft_limits:
Type: Boolean
Default: ✪
Interactions: ✪
Details: ✪
speed_map:
Type: [✪]()
Range: ✪
Default: ✪
Interactions: ✪
Details: ✪
spi:
Type: Section name.
See [✪](https://github.com/longus/FluidNC/wiki/✪)
Details: ✪
spindown_ms:
Type: [✪]()
Range: ✪
Default: ✪
Interactions: ✪
Details: ✪
spinup_ms:
Type: [✪]()
Range: ✪
Default: ✪
Interactions: ✪
Details: ✪
start:
Type: Section name.
See [✪](https://github.com/longus/FluidNC/wiki/✪)
Details: ✪
step_pin:
Type: ESP 32 Pin
Range: ✪
Default: ✪
Interactions: ✪
Details: ✪
stepping:
Type: Section name.
See FluidNC-Motor-Setup
Details: ✪
stepstick:
Type: Section name.
See [✪](https://github.com/longus/FluidNC/wiki/✪)
Details: ✪