Settings
All the settings - briefly explained. Settings marked with no-ui cannot be changed via the UI, thus need to be edited by modifying .config/octodash/config.json.
The URL or IP where your OctoPrint installation is located. If you've installed OctoDash on the same device as OctoPrint you should use localhost or 127.0.0.1 here.
default: localhost
The port of your OctoPrint API. If you're using localhost or 127.0.0.1 you should use 5000 here. If you use the OctoPi image and have a different URL use 80. Otherwise use the port of your forward proxy.
default: 5000
The API Key for the OctoPrint API. Maybe also called Application Key or Access Token. Learn how to get one here. ONLY use the API Key here and nowhere else. If you share your config please remove the Access Token
no-ui
default: ``
The name of your printer, which will be displayed in the bottom left corner. Leave empty if you don't want to show a name.
default: ``
The speed in mm/s which will be used by OctoDash to move the X and Y-Axis in the control screen.
default: 150
The speed in mm/s which will be used by OctoDash to move the Z-Axis in the control screen.
default: 5
The temperature in °C that will be used as the default for heating up the nozzle for changing the filament and if you click on the nozzle, while the printer is idling.
default: 200
The temperature in °C that will be used as the default if you click on the heatbed, while the printer is idling.
default: 60
Fan speed in % that will be used as the default if you click on the fan, while the printer is idling.
default: 100
When this is enabled OctoDash won't extrude any Filament, but rather will send the M600 command to the printer after heating up the nozzle. This then allows to use the printers filament change process.
default: false
The amount of filament that should be pushed through the nozzle to clean out the old filament.
default: 30
The distance the filament needs to travel between the Extruder and the Hotend. This will be used for the Filament Change Process. Make sure to set this fairly accurate (± 10mm). For a standard Ender-3 Pro this 440mm works great. This value should be fairly short for direct drive extruders. If you're unsure about your measurement, it is better to start with a smaller than measured value and slowly increase until enough filament is retracted / extruded.
default: 0
The speed that should be used to unload, and load the first 75% of the Filament. Make sure to also set a higher or equal max axis speed in OctoPrint, as otherwise OctoPrint might slow down the Extruder Movement.
default: 30
The speed that should be used to load the last 20% of the Filament.
default: 3
The thickness of the filament you're using in mm. Should be 1.75 or 3 in most cases. Will be used to calculate the filament amount.
default: 1.75
The average density of the filaments you're printing in g/cm³. Will be used to calculate the filament amount.
default: 1.25
The command that is used to for babystepping Z. The value will be appended to the end of the command - so M290 Z will result in M290 Z0.01.
no-ui default: 'M290 Z'
The interval which OctoDash waits between asking OctoPrint for new information in ms. Shouldn't be too short (< 1000ms) to prevent unnecessary load.
no-ui
default: 2000
Whether you're using a touchscreen or not. Based on this selection different screens will be loaded.
no-ui
default: true
Turn the screen off after 5 minutes, if OctoDash is sleeping. Only working for displays that support dpms (i.e. official Raspberry Pi Display). The screen will turn back on, once touched.
default: false
The command that is executed to turn off the screen
no-ui - octodash.screenSleepCommand
default: xset dpms force standby
The command that is executed to wake up the screen
no-ui - octodash.screenWakeupCommand
default: xset s off && xset -dpms && xset s noblank
The default attribute to sort files by (can always be temporarily changed in the file view, by clicking sort in the top right corner).
default: name
Whether to sort ascending or descending.
default: asc
Define up to 6 Custom Actions more info here
Can't be changed at the moment Whether the Display Layer Progress Plugin is installed and enabled.
default: true
Whether the Enclosure Plugin is installed and enabled.
default: false
The id of the sensor, whose values should be used.
default: ``
Whether the Filament Manager Plugin is installed and enabled.
default: true
Whether the Preheat Button Plugin is installed and enabled.
default: true
Whether the Print Time Genius Plugin is installed and enabled.
default: true
Whether the PSU Control Plugin is installed and enabled.
default: false
Whether the TPLink Smartplug Plugin is installed and enabled.
default: false
Whether to send an on-signal to the PSU Control Plugin when OctoDash is exiting sleep mode.
default: false
You can also edit these settings with your favorite code editor. The settings file is located at ~/.config/octodash/config.json
