FluidNC Commands and Settings - Longus/FluidNC GitHub Wiki
FluidNC commands and setting use a $ format. They can only be used in idle mode.
Commands are used for actions (like homing or disabling motors) or retrieve information (like gcode offsets). You can get a complete list of them with the $CMD command. Many commands have a full name format as well as a shorter version. Like $Gcode/Mode and $G. All standard Grbl $ commands are supported.
Note: Details for each command will be added soon.
- $Settings/Restore or $RST
- $GCode/StartupLines or $N
- $Build/Info or $I
- $System/Sleep or $SLP
- $Home/C or $HC
- $Home/B or $HB
- $Home/A or $HA
- $Home/Z or $HZ
- $Home/Y or $HY
- $Home/X or $HX Home the X axis only
- $Motor/Disable or $MD Disable all axes. Or you can disable them by letter, like $MD=X to disable the X axis. All axes will automatically enable when any motion command is received.
- $Home or $H Home all axes as the cycles are setup in the YAML file
-
$GCode/Offsets or $ # - $Settings/Stats or $V
- $Settings/Erase or $NVX
- $Alarm/Disable or $X
- $GCode/Check or $C
- $GCode/Modes or $G
- $Errors/List or $E Use to show the meaning of errors. $E will show you them all. $E=3 will tell you what error 3 means.
- $Alarms/List or $A
- $Commands/List or $CMD
- $Settings/ListChanged or $SC
- $Settings/List or $S
- $Limits/Show or $Limits
- $GrblNames/List or $L
-
$GrblSettings/List or $ $ - $Jog or $J
- $State or $T
$Help or $ - $Config/Dump or $CD
- $WebUI/Help or $ESP
- $WebUI/Help or $ESP0
- $WebUI/List or $ESP400
- $WebUI/Set or $ESP401 =P=position T=type V=value
- $Radio/State or $ESP115 =ON|OFF
- $SD/Status or $ESP200
- $SD/List or $ESP210
- $SD/Delete or $ESP215 =file_or_directory_path
- $SD/Run or $ESP220 =path
- $SD/Show or $ESP221 =path -$LocalFS/Delete =path
- $LocalFS/ListJSON =path
- $LocalFS/List =path
- $LocalFS/Run or $ESP700 =path
- $LocalFS/Show or $ESP701 =path
- $LocalFS/Format or $ESP710 =FORMAT
- $LocalFS/Size or $ESP720
- $Bye =RESTART
- $System/Control or $ESP444 =RESTART
- $System/Stats or $ESP420
- $Firmware/Info or $ESP800
Settings are used to set saved values. Most settings are now in the config file, but there a a few like $Confg/Filename that need to be outside the config file. You can see all of them with $S. We only support a few standard Grbl $ settings. We tried to support any setting that might be used during normal operation like $10. Standard Grbl settings that are used to setup a machine are not supported. This is because FluidNC has many times more settings than Grbl.
You set the value by setting a value like this $Config/Filename=test.yaml. You can see the current value by just sending the setting name like $Config/Filename. If you send just a part of the setting name like $STA, all setting with STA in the name will be show with their current values.
Settings have different types like integer, float, String and Enum. Enum is one of a list of values. You can see the valid type by sending something like $Wifi/Mode=*. It will respond with [MSG:INFO: Valid options: Off AP STA STA>AP].
The list of settings depends whether your firmware was compiled for WiFi or Bluetooth. Below is a list of all settings.
1