no way to compare when less than two revisions
Differences
This shows you the differences between two versions of the page.
— | configuring-smoothie [2022/07/17 17:35] (current) – created - external edit 127.0.0.1 | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | == Configuration file | ||
+ | One of the really appreciated features of the Smoothie firmware is that it doesn' | ||
+ | |||
+ | Instead, Smoothie is configured simply by editing a configuration file on its sd-card. | ||
+ | |||
+ | Simply edit the configuration file, **unmount/ | ||
+ | |||
+ | You can find a default config file for 3D printing [[https:// | ||
+ | |||
+ | < | ||
+ | <br/> | ||
+ | <a href=" | ||
+ | <br/> | ||
+ | </ | ||
+ | |||
+ | Please remember that the config file on the SD card you got with your Smooothieboard may not be current, always download the newest version with the button above. | ||
+ | |||
+ | The file consists of key and value pairs. Most values are commented to indicate what they mean, but a lot of them are also explained in this documentation. | ||
+ | |||
+ | Example : | ||
+ | |||
+ | < | ||
+ | default_feed_rate | ||
+ | </ | ||
+ | |||
+ | Where < | ||
+ | |||
+ | You can find a complete list of possible configuration options [[/ | ||
+ | |||
+ | {{page> | ||
+ | |||
+ | <callout type=" | ||
+ | |||
+ | If you are configuring a delta 3D printer, you will save a lot of time and effort by starting with the delta example file instead of the normal example file. | ||
+ | |||
+ | You can find the delta example file [[https:// | ||
+ | |||
+ | </ | ||
+ | |||
+ | <callout type=" | ||
+ | |||
+ | If a line begins with a < | ||
+ | |||
+ | Some values are commented by default, you need to uncomment them by removing the < | ||
+ | |||
+ | For example this line : | ||
+ | |||
+ | < | ||
+ | # | ||
+ | </ | ||
+ | |||
+ | Will completely be ignored by Smoothie. To make Smoothie take it into account again, remove the < | ||
+ | |||
+ | </ | ||
+ | |||
+ | <callout type=" | ||
+ | |||
+ | Make sure all your lines are shorter than 132 characters. Lines longer than this can cause issues. | ||
+ | |||
+ | This should not be a problem if you do not add further comments, just be careful if you do. | ||
+ | </ | ||
+ | |||
+ | Smoothie will not work without a valid configuration file on the SD card. | ||
+ | |||
+ | The filename must be < | ||
+ | |||
+ | |||
+ | <callout type=" | ||
+ | It is not recommended you allow the sdcard to [[https:// | ||
+ | |||
+ | " | ||
+ | |||
+ | Concurrent access to the sdcard via the host and the smoothie is not supported. The sdcard must be safely removed or unmounted then smoothie reset after copying or editing files from the host mount point. | ||
+ | |||
+ | This is especially true on Macs which randomly like to read and write the sdcard. If this happens during a print it will cause pauses and other printing problems. | ||
+ | |||
+ | </ | ||
+ | |||
+ | <callout type=" | ||
+ | Smoothieboard comes with a configuration file already on the SD card. You need to get only a new configuration file if you are making your own board, or if you are upgrading your firmware. | ||
+ | |||
+ | </ | ||
+ | |||
+ | <callout type=" | ||
+ | |||
+ | If you are upgrading from a previous version of master or edge check for upgrade notes in the github root directory. | ||
+ | https:// | ||
+ | |||
+ | </ | ||
+ | |||
+ | == Options | ||
+ | |||
+ | You can find all configuration options on this page : | ||
+ | |||
+ | And you can also find the configuration options for each module, in that module' | ||
+ | |||
+ | == Includes | ||
+ | |||
+ | You don't need to put all of your configuration in a single file. | ||
+ | |||
+ | You can have " | ||
+ | |||
+ | Here is how it works : | ||
+ | |||
+ | First, make a file with a new name, for example, " | ||
+ | |||
+ | < | ||
+ | acceleration 100 | ||
+ | </ | ||
+ | |||
+ | Then in your main ( file named " | ||
+ | |||
+ | < | ||
+ | include myconfig | ||
+ | </ | ||
+ | |||
+ | And now, when configuration is read, Smoothie will read both files, and take their options into account as if they were a single file. | ||
+ | |||
+ | If you have a long and complex configuration, | ||
+ | |||
+ | == Encoding | ||
+ | |||
+ | If you make the config file by yourself please save it using ANSI encoding. | ||
+ | |||
+ | Using Unicode can cause problems. | ||
+ | |||
+ | To avoid problems, use the default file on github ( see link above ) as your starting point. | ||
+ | |||
+ | <callout type=" | ||
+ | |||
+ | If you use Notepad++ to edit the configuration file, make sure you switch the file encoding to " | ||
+ | |||
+ | Another good simple text editor that runs under Windows and will edit Smoothie config files with no problems is: https:// | ||
+ | |||
+ | ANSI and UTF8 are equivalent for a subset of characters but sometimes quotes and such can be replaced with Unicode variants. | ||
+ | |||
+ | </ | ||
+ | |||
+ | == Console configuration commands | ||
+ | |||
+ | There are [[http:// | ||
+ | |||
+ | These commands are : | ||
+ | |||
+ | < | ||
+ | config-get sd acceleration | ||
+ | </ | ||
+ | |||
+ | Will return the current acceleration setting from the SD card | ||
+ | |||
+ | < | ||
+ | config-set sd acceleration 1000 | ||
+ | </ | ||
+ | |||
+ | Will set the current acceleration setting to 1000. | ||
+ | |||
+ | You need to reset the board after changing a value for it to be taken into account. | ||
+ | |||
+ | You can find more information at [[http:// | ||
+ | |||
+ | == Config Overrides | ||
+ | |||
+ | Many settings in smoothie can be set immediately with < | ||
+ | |||
+ | There is a set of M-codes (< | ||
+ | |||
+ | As these settings can be temporarily overridden with Mxxx commands there is a way to save these settings. Once saved they are reloaded on reset or boot overriding the settings in the config file. If you then edit the config file, make sure the setting you are editing is not being overridden by the override file (< | ||
+ | |||
+ | ^ M-code ^ Description ^ Example | | ||
+ | | < | ||
+ | | < | ||
+ | | < | ||
+ | | < | ||
+ | | < | ||
+ | |||
+ | <callout type=" | ||
+ | Do not issue < | ||
+ | Also do not issue M500 in a gcode file, it is not intended to be executed that way and may well crash the system. It is a manual command only. | ||
+ | |||
+ | </ | ||
+ | |||
+ | < | ||
+ | ;Steps per unit: | ||
+ | M92 X80.00000 Y80.00000 Z1259.84253 | ||
+ | ; | ||
+ | M204 S2000.00000 | ||
+ | ;X- Junction Deviation, S - Minimum Planner speed: | ||
+ | M205 X0.05000 S0.00000 | ||
+ | ;Max feedrates in mm/sec, XYZ cartesian, ABC actuator: | ||
+ | M203 X333.00000 Y333.00000 Z3.33330 A333.00000 B333.00000 C3.33330 | ||
+ | ;E Steps per mm: | ||
+ | M92 E367.0000 | ||
+ | ;Extruder current: | ||
+ | M907 E1.50000 | ||
+ | ;PID settings: | ||
+ | M301 S1 P35.5000 I2.5830 D122.0000 | ||
+ | ;Home offset (mm): | ||
+ | M206 X-15.00 Y15.00 Z5.90 | ||
+ | |||
+ | |||
+ | Additionally a delta will save... | ||
+ | M665/666 is used when you want to make an adjustment during calibration and not have to reboot your Smoothie. | ||
+ | ;Trim (mm). Note M666 expect all values to be specified as negative and with a decimal point in mm | ||
+ | ;Example M666 X-6.14 Y-0.97 Z-6.05 | ||
+ | M666 | ||
+ | |||
+ | ;M665 allows you to set the diagonal rod length L, the delta_radius R, and Max Z all in mm. The L and R values are optional if you don't want/need to override the config settings. | ||
+ | ;Example: M665 L220.0 R113.8 Z244.0 | ||
+ | M665 | ||
+ | </ | ||
+ | |||
+ | <callout type=" | ||
+ | |||
+ | Edit the config-override file yourself, only use the commands to edit the values. | ||
+ | </ | ||
+ | |||
+ | |||
+ | == Advanced pin configuration | ||
+ | |||
+ | {{page> | ||
+ | |||
+ | == Hard setting configuration | ||
+ | |||
+ | You can do away with an editable configuration file altogether if that makes sense in your setup. For example if you don't want users do have an easy way to edit he configuration by editing the configuration file on the SD card. | ||
+ | |||
+ | To do this, remove the configuration file from the SD card. Then follow the instructions at http:// | ||
+ | |||
+ | Now the firmware will be configured with the values you set, but users won't be able to edit them using the SD card, and modifying values will require compiling and reflashing. | ||
+ | |||
+ | This is useful for example if you are an OEM selling machines where users are not meant to play around with configuration. |