config.yaml Reference - Longus/FluidNC GitHub Wiki

Contents:

• name:
• board:
• kinematics:
• stepping:
  • engine:
  • idle_ms:
  • pulse_us:
  • dir_delay_us:
  • disable_delay_us:
• axes:
  • shared_stepper_disable_pin:
  • [x|y|z|a|b|c]:
    • acceleration_mm_per_sec2:
    • max_rate_mm_per_min:
    • max_travel_mm:
    • soft_limits:
    • steps_per_mm:
    • homing:
      • allow_single_axis:
      • cycle:
      • debounce_ms:
      • feed_mm_per_min:
      • feed_scaler:
      • mpos_mm:
      • positive_direction:
      • seek_mm_per_min:
      • seek_scaler:
      • settle_ms:
    • motor[0|1]:
      • hard_limits:
      • limit_all_pin:
      • limit_neg_pin:
      • limit_pos_pin:
      • null_motor:
      • pulloff_mm:
      • [Stepping Option ✪] standard_stepper:
        • step_pin:
        • direction_pin:
        • disable_pin:
      • [Stepping Option ✪] stepstick:
        • step_pin:
        • direction_pin:
        • disable_pin:
        • ms1_pin:
        • ms2_pin:
        • ms3_pin:
        • reset_pin:
      • [Stepping Option ✪] tmc_2130:
        • cs_pin:
        • direction_pin:
        • disable_pin:
        • hold_amps:
        • homing_mode:
        • microsteps:
        • r_sense_ohms:
        • run_amps:
        • run_mode:
        • spi_index:
        • stallguard:
        • stallguard_debug:
        • step_pin:
        • toff_coolstep:
        • toff_disable:
        • toff_stealthchop:
        • use_enable:
      • [Stepping Option ✪] tmc_2209:
        • step_pin:
        • direction_pin:
        • disable_pin:
        • uart:
          • txd_pin:
          • rxd_pin:
          • rts_pin:
          • cts_pin:
          • baud:
          • mode:
        • r_sense_ohms:
        • run_amps:
        • hold_amps:
        • microsteps:
        • stallguard:
        • toff_disable:
        • toff_stealthchop:
        • toff_coolstep:
        • run_mode:
        • homing_mode:
        • use_enable:
      • [Stepping Option ✪] tmc_5160:
        • step_pin:
        • direction_pin:
        • disable_pin:
        • cs_pin:
        • spi_index:
        • r_sense_ohms:
        • run_amps:
        • hold_amps:
        • microsteps:
        • stallguard:
        • stallguard_debug:
        • toff_disable:
        • toff_stealthchop:
        • toff_coolstep:
        • run_mode:
        • homing_mode:
        • use_enable:
      • [Stepping Option ✪] rc_servo:
        • output_pin:
        • pwm_hz:
        • min_pulse_us:
        • max_pulse_us:
      • [Stepping Option ✪] Dynamixel Servo (Protocol 2):
        • id:
        • uart:
          • txd_pin:
          • rxd_pin:
          • rts_pin:
          • baud:
          • mode:
        • count_min:
        • count_max:
      • [Stepping Option ✪] Dynamixel Servo:
      • [Stepping Option ✪] Unipolar Motors:
• i2so:
  • bck_pin:
  • data_pin:
  • ws_pin:
• spi:
  • miso_pin:
  • mosi_pin:
  • sck_pin:
• sdcard:
  • card_detect_pin:
  • cs_pin:
• control:
  • safety_door_pin:
  • reset_pin:
  • feed_hold_pin:
  • cycle_start_pin:
  • macro0_pin:
  • macro1_pin:
  • macro2_pin:
  • macro3_pin:
• coolant:
  • flood_pin:
  • mist_pin:
  • delay_ms:
• probe:
  • probe_pin:
  • check_mode_start:
• macros:
  • startup_line0:
  • startup_line1:
  • macro0:
  • macro1:
  • macro2:
  • macro3:
• start:
  • must_home:
• PWM:
  • direction_pin:
  • disable_with_s0:
  • enable_pin:
  • output_pin:
  • pwm_hz:
  • s0_with_disable:
  • speed_map:
  • spindown_ms:
  • spinup_ms:
  • tool_num:

Details:

See FluidNC-Config-File-Overview

name:

Type: String
Range: ✪character limit?
Default: Null
Interactions: None
Details: Descriptive text such as "ESP32 Dev Controller V4".

board:

Type: ✪
Range: ✪character limit?
Default: Null
Interactions: None
Details: Descriptive text such as "ESP32 Dev Controller V4".

stepping:

See FluidNC-Motor-Setup

• engine:
  Type: ✪
  Range: [RMT | TIMED | I2S_static | I2S_STREAM]
  Default: ✪
  Interactions: ✪
  Details: ✪

• idle_ms:
  Type: ✪
  Range: ✪
  Default: ✪
  Interactions: ✪
  Details: ✪

• pulse_us:
  Type: ✪
  Range: ✪
  Default: ✪
  Interactions: ✪
  Details: ✪

• dir_delay_us:
  Type: ✪
  Range: ✪
  Default: ✪
  Interactions: ✪
  Details: ✪

• disable_delay_us:
  Type: ✪
  Range: ✪
  Default: ✪
  Interactions: ✪
  Details: ✪

axes:

See FluidNC-Motor-Setup

• shared_stepper_disable_pin: Type: ESP 32 Pin
  Range: ✪
  Default: ✪
  Interactions: ✪
  Details: ✪

• [x|y|z|a|b|c]:

  • [steps_per_mm:] Type: ✪
    Range: ✪
    Default: ✪
    Interactions: ✪
    Details: ✪

  • [max_rate_mm_per_min:] Type: ✪
    Range: ✪
    Default: ✪
    Interactions: ✪
    Details: ✪

  • [acceleration_mm_per_sec2:] Type: ✪
    Range: ✪
    Default: ✪
    Interactions: ✪
    Details: ✪

  • [max_travel_mm:] Type: ✪
    Range: ✪
    Default: ✪
    Interactions: ✪
    Details: ✪

  • [soft_limits:] Type: Boolean
    Default: ✪
    Interactions: ✪
    Details: ✪

  • homing: (see FluidNC Limit Switch and Homing Setup)

    • 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.

    • 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.

    • 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.

    • 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 and the pulloff_mm values when you choose this number.

    • 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.

    • 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.

    • 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.

  • motor[0|1]: (see FluidNC-Motor-Setup)

    • null_motor
      Type:
      Range: ✪
      Default:
      Interactions:
      Details:

    • 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
      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.

    • 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.

    • 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.

    • 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.

    • [A✪ Option 1] stepstick:

      • step_pin:
        Type: ✪
        Range: ✪
        Default: ✪
        Interactions: ✪
        Details: ✪

      • direction_pin:
        Type: ✪
        Range: ✪
        Default: ✪
        Interactions: ✪
        Details: ✪

      • disable_pin:
        Type: ✪
        Range: ✪
        Default: ✪
        Interactions: ✪
        Details: ✪

      • ms1_pin:
        Type: ✪
        Range: ✪
        Default: ✪
        Interactions: ✪
        Details: ✪

      • ms2_pin:
        Type: ✪
        Range: ✪
        Default: ✪
        Interactions: ✪
        Details: ✪

      • ms3_pin:
        Type: ✪
        Range: ✪
        Default: ✪
        Interactions: ✪
        Details: ✪

      • reset_pin:
        Type: ✪
        Range: ✪
        Default: ✪
        Interactions: ✪
        Details: ✪

    • [A✪ Option 1] tmc_2130:

      • step_pin:
        Type: ✪
        Range: ✪
        Default: ✪
        Interactions: ✪
        Details: ✪

      • direction_pin:
        Type: ✪
        Range: ✪
        Default: ✪
        Interactions: ✪
        Details: ✪

      • disable_pin:
        Type: ✪
        Range: ✪
        Default: ✪
        Interactions: ✪
        Details: ✪

      • ms1_pin:
        Type: ✪
        Range: ✪
        Default: ✪
        Interactions: ✪
        Details: ✪

      • ms2_pin:
        Type: ✪
        Range: ✪
        Default: ✪
        Interactions: ✪
        Details: ✪

      • ms3_pin:
        Type: ✪
        Range: ✪
        Default: ✪
        Interactions: ✪
        Details: ✪

      • reset_pin:
        Type: ✪
        Range: ✪
        Default: ✪
        Interactions: ✪
        Details: ✪

spi:

See FluidNC-Motor-Setup

• miso_pin:
  Type: ESP 32 Pin
  Range: ✪
  Default: ✪
  Interactions: ✪
  Details: ✪

• mosi_pin:
  Type: ESP 32 Pin
  Range: ✪
  Default: ✪
  Interactions: ✪
  Details: ✪

• sck_pin:
  Type: ESP 32 Pin
  Range: ✪
  Default: ✪
  Interactions: ✪
  Details: ✪

sdcard:

See SD Card

• cs_pin:
  Type: ✪
  Range: ✪
  Default: ✪
  Interactions: ✪
  Details: ✪

• card_detect_pin:
  Type: ✪
  Range: ✪
  Default: ✪
  Interactions: ✪
  Details: ✪

coolant:

See Coolant

• flood_pin:
  Type: ✪
  Range: ✪
  Default: ✪
  Interactions: ✪
  Details: ✪

• mist_pin:
  Type: ✪
  Range: ✪
  Default: ✪
  Interactions: ✪
  Details: ✪

probe:

See Probe

• probe_pin:
  Type: ✪
  Range: ✪
  Default: ✪
  Interactions: ✪
  Details: ✪

PWM:

See Fluid-Spindle-Setup

• pwm_hz:
  Type: ✪
  Range: ✪
  Default: ✪
  Interactions: ✪
  Details: ✪

• output_pin:
  Type: ✪
  Range: ✪
  Default: ✪
  Interactions: ✪
  Details: ✪

• enable_pin:
  Type: ✪
  Range: ✪
  Default: ✪
  Interactions: ✪
  Details: ✪

• direction_pin:
  Type: ✪
  Range: ✪
  Default: ✪
  Interactions: ✪
  Details: ✪

• disable_with_s0:
  Type: ✪
  Range: ✪
  Default: ✪
  Interactions: ✪
  Details: ✪

• s0_with_disable:
  Type: ✪
  Range: ✪
  Default: ✪
  Interactions: ✪
  Details: ✪

• spinup_ms:
  Type: ✪
  Range: ✪
  Default: ✪
  Interactions: ✪
  Details: ✪

• spindown_ms:
  Type: ✪
  Range: ✪
  Default: ✪
  Interactions: ✪
  Details: ✪

• tool_num:
  Type: ✪
  Range: ✪
  Default: ✪
  Interactions: ✪
  Details: ✪

• speed_map:
  Type: ✪
  Range: ✪
  Default: ✪
  Interactions: ✪
  Details: ✪