octoprint.schema¶

class octoprint.schema.BaseModel¶

model_config : ClassVar[ConfigDict] = {'use_enum_values': True, 'validate_default': True}¶

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class octoprint.schema.BaseModelExtra(**extra_data: Any)¶

model_config : ClassVar[ConfigDict] = {'extra': 'allow', 'use_enum_values': True, 'validate_default': True}¶

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

octoprint.schema.config¶

class octoprint.schema.config.Config(*, accessControl: AccessControlConfig = AccessControlConfig(salt=None, userManager='octoprint.access.users.FilebasedUserManager', groupManager='octoprint.access.groups.FilebasedGroupManager', permissionManager='octoprint.access.permissions.PermissionManager', userfile=None, groupfile=None, autologinLocal=False, localNetworks=['127.0.0.0/8', '::1/128'], autologinAs=None, autologinHeadsupAcknowledged=False, trustBasicAuthentication=False, checkBasicAuthenticationPassword=True, trustRemoteUser=False, remoteUserHeader='REMOTE_USER', trustRemoteGroups=False, remoteGroupsHeader='REMOTE_GROUPS', remoteGroupsMapping={}, addRemoteUsers=False, defaultReauthenticationTimeout=5, sessionStaleAfter=15), api: ApiConfig = ApiConfig(key=None, apps={}, allowCrossOrigin=False), appearance: AppearanceConfig = AppearanceConfig(name='', color='default', colorTransparent=False, colorIcon=True, defaultLanguage='_default', showFahrenheitAlso=False, fuzzyTimes=True, closeModalsWithClick=True, showInternalFilename=True, components=ComponentConfig(order=ComponentOrderConfig(navbar=['settings', 'systemmenu', 'plugin_announcements', 'plugin_logging_seriallog', 'plugin_logging_plugintimingslog', 'plugin_pi_support', 'plugin_health_check', 'login'], sidebar=['plugin_firmware_check_warning', 'plugin_firmware_check_info', 'connection', 'state', 'files'], tab=['temperature', 'control', 'plugin_gcodeviewer', 'terminal', 'timelapse'], settings=['section_printer', 'serial', 'printerprofiles', 'temperatures', 'terminalfilters', 'gcodescripts', 'section_features', 'features', 'webcam', 'accesscontrol', 'plugin_gcodeviewer', 'api', 'plugin_appkeys', 'section_octoprint', 'server', 'folders', 'appearance', 'plugin_logging', 'plugin_pluginmanager', 'plugin_softwareupdate', 'plugin_announcements', 'plugin_eventmanager', 'plugin_backup', 'plugin_tracking', 'plugin_errortracking', 'plugin_pi_support'], usersettings=['access', 'interface'], wizard=['plugin_softwareupdate_update', 'plugin_backup', 'plugin_corewizard_acl', 'plugin_corewizard_onlinecheck'], about=['about', 'plugin_pi_support', 'supporters', 'authors', 'changelog', 'license', 'thirdparty', 'plugin_pluginmanager', 'plugin_achievements', 'plugin_achievements_2', 'systeminfo'], generic=[]), disabled=ComponentDisabledConfig(navbar=[], sidebar=[], tab=[], settings=[], usersettings=[], wizard=[], about=[], generic=[]))), controls: list[ControlConfig | ContainerConfig] = [], devel: DevelConfig = DevelConfig(stylesheet='css', cache=DevelCacheConfig(enabled=True, preemptive=True), webassets=DevelWebassetsConfig(bundle=True, clean_on_startup=True, minify=True, minify_plugins=False), useFrozenDictForPrinterState=True, showLoadingAnimation=True, sockJsConnectTimeout=30.0, pluginTimings=False, enableRateLimiter=True, enableCsrfProtection=True), estimation: EstimationConfig = EstimationConfig(printTime=PrintTimeEstimationConfig(statsWeighingUntil=0.5, validityRange=0.15, forceDumbFromPercent=0.3, forceDumbAfterMin=30.0, stableThreshold=60)), events: EventsConfig = EventsConfig(enabled=True, subscriptions=[]), feature: FeatureConfig = FeatureConfig(temperatureGraph=True, sdSupport=True, keyboardControl=True, pollWatched=False, modelSizeDetection=True, rememberFileFolder=False, printStartConfirmation=False, printCancelConfirmation=True, uploadOverwriteConfirmation=True, fileDeleteConfirmation=True, autoUppercaseBlacklist=['M117', 'M118', 'M707', 'M708'], g90InfluencesExtruder=False, enforceReallyUniversalFilenames=False, enableDragDropUpload=True), folder: FolderConfig = FolderConfig(uploads=None, timelapse=None, timelapse_tmp=None, logs=None, virtualSd=None, watched=None, plugins=None, slicingProfiles=None, printerProfiles=None, scripts=None, translations=None, generated=None, data=None), gcodeAnalysis: GcodeAnalysisConfig = GcodeAnalysisConfig(maxExtruders=10, throttle_normalprio=0.01, throttle_highprio=0.0, throttle_lines=100, runAt='idle', bedZ=0.0), plugins: PluginsConfig = PluginsConfig(disabled=[], forced_compatible=[], sorting_order={}, flags={}), printerParameters: PrinterParametersConfig = PrinterParametersConfig(pauseTriggers=[]), printerProfiles: PrinterProfilesConfig = PrinterProfilesConfig(default=None), scripts: ScriptsConfig = ScriptsConfig(gcode=GcodeScriptsConfig(afterPrinterConnected=None, beforePrinterDisconnected=None, beforePrintStarted=None, afterPrintCancelled="; disable motors\nM84\n\n;disable all heaters\n{% snippet 'disable_hotends' %}\n{% snippet 'disable_bed' %}\n;disable fan\nM106 S0", afterPrintDone=None, beforePrintPaused=None, afterPrintResumed=None, beforeToolChange=None, afterToolChange=None, snippets={'disable_hotends': '{% if printer_profile.extruder.sharedNozzle %}M104 T0 S0\n{% else %}{% for tool in range(printer_profile.extruder.count) %}M104 T{{ tool }} S0\n{% endfor %}{% endif %}', 'disable_bed': '{% if printer_profile.heatedBed %}M140 S0\n{% endif %}'})), serial: SerialConfig = SerialConfig(port=None, baudrate=None, exclusive=True, lowLatency=False, autoconnect=False, autorefresh=True, autorefreshInterval=1, log=False, timeout=SerialTimeoutConfig(detectionFirst=10.0, detectionConsecutive=2.0, connection=10.0, communication=30.0, communicationBusy=3.0, temperature=5.0, temperatureTargetSet=2.0, temperatureAutoreport=2.0, sdStatus=1.0, sdStatusAutoreport=1.0, posAutoreport=5.0, resendOk=0.5, baudrateDetectionPause=1.0, positionLogWait=10.0), maxCommunicationTimeouts=SerialMaxTimeouts(idle=2, printing=5, long=5), maxWritePasses=5, additionalPorts=[], additionalBaudrates=[], blacklistedPorts=[], blacklistedBaudrates=[], longRunningCommands=['G4', 'G28', 'G29', 'G30', 'G32', 'M400', 'M226', 'M600'], blockedCommands=['M0', 'M1'], ignoredCommands=[], pausingCommands=['M0', 'M1', 'M25'], emergencyCommands=['M112', 'M108', 'M410'], checksumRequiringCommands=['M110'], helloCommand='M110 N0', suppressSecondHello=False, disconnectOnErrors=True, ignoreErrorsFromFirmware=False, terminalLogSize=20, lastLineBufferSize=50, logResends=True, supportResendsWithoutOk='detect', logPositionOnPause=True, logPositionOnCancel=False, abortHeatupOnCancel=True, waitForStartOnConnect=False, waitToLoadSdFileList=True, alwaysSendChecksum=False, neverSendChecksum=False, sendChecksumWithUnknownCommands=False, unknownCommandsNeedAck=False, sdRelativePath=False, sdAlwaysAvailable=False, sdLowerCase=False, sdCancelCommand='M25', maxNotSdPrinting=2, swallowOkAfterResend=True, repetierTargetTemp=False, externalHeatupDetection=True, supportWait=True, ignoreIdenticalResends=False, identicalResendsCountdown=7, supportFAsCommand=False, firmwareDetection=True, blockWhileDwelling=False, useParityWorkaround='detect', maxConsecutiveResends=10, sendM112OnError=True, disableSdPrintingDetection=False, ackMax=1, sanityCheckTools=True, notifySuppressedCommands='warn', capabilities=SerialCapabilities(autoreport_temp=True, autoreport_sdstatus=True, autoreport_pos=True, busy_protocol=True, emergency_parser=True, extended_m20=True, lfn_write=True), resendRatioThreshold=10, resendRatioStart=100, ignoreEmptyPorts=False, encoding='ascii', enableShutdownActionCommand=False, triggerOkForM29=True), server: ServerConfig = ServerConfig(host=None, port=5000, firstRun=True, startOnceInSafeMode=False, ignoreIncompleteStartup=False, seenWizards={}, secretKey=None, heartbeat=900, reverseProxy=ReverseProxyConfig(prefixHeader=None, schemeHeader=None, hostHeader=None, serverHeader=None, portHeader=None, prefixFallback=None, schemeFallback=None, hostFallback=None, serverFallback=None, portFallback=None, trustedProxies=[], trustLocalhostProxies=True), uploads=UploadsConfig(maxSize=1073741824, nameSuffix='name', pathSuffix='path'), maxSize=102400, commands=CommandsConfig(systemShutdownCommand=None, systemRestartCommand=None, serverRestartCommand=None, localPipCommand=None), onlineCheck=OnlineCheckConfig(enabled=None, interval=900, host='1.1.1.1', port=53, name='octoprint.org'), pluginBlacklist=PluginBlacklistConfig(enabled=None, url='https://plugins.octoprint.org/blacklist.json', ttl=900, timeout=3.05), pythonEolCheck=PythonEolCheckConfig(enabled=True, url='https://get.octoprint.org/python-eol', ttl=1440, fallback={'3.7': PythonEolEntry(date='2023-06-27', last_octoprint='1.11.*'), '3.8': PythonEolEntry(date='2024-10-31', last_octoprint=None)}), diskspace=DiskspaceConfig(warning=524288000, critical=209715200), preemptiveCache=PreemptiveCacheConfig(exceptions=[], until=7), ipCheck=IpCheckConfig(enabled=True, trustedSubnets=[]), allowFraming=False, cookies=CookiesConfig(secure=False, samesite='Lax'), allowedLoginRedirectPaths=[]), slicing: SlicingConfig = SlicingConfig(enabled=True, defaultSlicer=None, defaultProfiles={}), system: SystemConfig = SystemConfig(actions=[]), temperature: TemperatureConfig = TemperatureConfig(profiles=[TemperatureProfile(name='ABS', extruder=210, bed=100), TemperatureProfile(name='PLA', extruder=180, bed=60)], cutoff=30, sendAutomatically=False, sendAutomaticallyAfter=1), terminalFilters: list[TerminalFilterEntry] = [TerminalFilterEntry(name='Suppress temperature messages', regex='(Send: (N\\d+\\s+)?M105)|(Recv:\\s+(ok\\s+([PBN]\\d+\\s+)*)?([BCLPR]|T\\d*):-?\\d+)'), TerminalFilterEntry(name='Suppress SD status messages', regex='(Send: (N\\d+\\s+)?M27)|(Recv: SD printing byte)|(Recv: Not SD printing)'), TerminalFilterEntry(name='Suppress position messages', regex='(Send:\\s+(N\\d+\\s+)?M114)|(Recv:\\s+(ok\\s+)?X:[+-]?([0-9]*[.])?[0-9]+\\s+Y:[+-]?([0-9]*[.])?[0-9]+\\s+Z:[+-]?([0-9]*[.])?[0-9]+\\s+E\\d*:[+-]?([0-9]*[.])?[0-9]+).*'), TerminalFilterEntry(name='Suppress wait responses', regex='Recv: wait'), TerminalFilterEntry(name='Suppress processing responses', regex='Recv: (echo:\\s*)?busy:\\s*processing')], webcam: WebcamConfig = WebcamConfig(webcamEnabled=True, timelapseEnabled=True, ffmpeg=None, ffmpegThreads=1, ffmpegVideoCodec='libx264', bitrate='10000k', watermark=True, ffmpegCommandline='{ffmpeg} -framerate {fps} -i "{input}" -vcodec {videocodec} -threads {threads} -b:v {bitrate} -f {containerformat} -y {filters} "{output}"', ffmpegThumbnailCommandline='{ffmpeg} -sseof -1 -i "{input}" -update 1 -q:v 0.7 "{output}"', timelapse=TimelapseConfig(type='off', fps=25, postRoll=0, renderAfterPrint='always', options=TimelapseOptions(interval=None, capturePostRoll=None, retractionZHop=None)), cleanTmpAfterDays=7, renderAfterPrintDelay=0, defaultWebcam='classic', snapshotWebcam='classic'))¶

accessControl : AccessControlConfig¶

api : ApiConfig¶

appearance : AppearanceConfig¶

controls : list[ControlConfig | ContainerConfig]¶

devel : DevelConfig¶

estimation : EstimationConfig¶

events : EventsConfig¶

feature : FeatureConfig¶

folder : FolderConfig¶

gcodeAnalysis : GcodeAnalysisConfig¶

model_config : ClassVar[ConfigDict] = {'use_enum_values': True, 'validate_default': True}¶

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

plugins : PluginsConfig¶

printerParameters : PrinterParametersConfig¶

printerProfiles : PrinterProfilesConfig¶

scripts : ScriptsConfig¶

serial : SerialConfig¶

server : ServerConfig¶

slicing : SlicingConfig¶

system : SystemConfig¶

temperature : TemperatureConfig¶

terminalFilters : list[TerminalFilterEntry]¶

webcam : WebcamConfig¶

class octoprint.schema.config.access_control.AccessControlConfig(*, salt: str | None = None, userManager: str = 'octoprint.access.users.FilebasedUserManager', groupManager: str = 'octoprint.access.groups.FilebasedGroupManager', permissionManager: str = 'octoprint.access.permissions.PermissionManager', userfile: str | None = None, groupfile: str | None = None, autologinLocal: bool = False, localNetworks: list[str] = ['127.0.0.0/8', '::1/128'], autologinAs: str | None = None, autologinHeadsupAcknowledged: bool = False, trustBasicAuthentication: bool = False, checkBasicAuthenticationPassword: bool = True, trustRemoteUser: bool = False, remoteUserHeader: str = 'REMOTE_USER', trustRemoteGroups: bool = False, remoteGroupsHeader: str = 'REMOTE_GROUPS', remoteGroupsMapping: dict[str, str] = {}, addRemoteUsers: bool = False, defaultReauthenticationTimeout: int = 5, sessionStaleAfter: int = 15)¶

addRemoteUsers : bool¶

If a remote user is not found, add them. Use this only if all users from the remote system can use OctoPrint.

autologinAs : str | None¶

The name of the user to automatically log on clients originating from localNetworks as. Must be the name of one of your configured users.

autologinHeadsupAcknowledged : bool¶

Whether the user has acknowledged the heads-up about the importance of a correct reverse proxy configuration in the presence of autologin.

autologinLocal : bool¶

If set to true, will automatically log on clients originating from any of the networks defined in localNetworks as the user defined in autologinAs.

checkBasicAuthenticationPassword : bool¶

Whether to also check the password provided through Basic Authentication, if the Basic Authentication header is to be trusted. Disabling this will only match the user name in the Basic Authentication header and login the user without further checks, thus disable with caution.

defaultReauthenticationTimeout : int¶

Default timeout after which to require reauthentication by a user for dangerous changes, in minutes. Defaults to 5 minutes. Set to 0 to disable reauthentication requirements (SECURITY IMPACT!).

groupManager : str¶

groups.yaml in the default configuration folder).

Type:¶

The group manager implementation to use for accessing group information. Currently only a filebased user manager is implemented which stores configured groups in a YAML file (Default

groupfile : str | None¶

The YAML group file to use. If left out defaults to groups.yaml in the default configuration folder.

localNetworks : list[str]¶

A list of networks or IPs for which an automatic logon as the user defined in autologinAs will take place. If available OctoPrint will evaluate the X-Forwarded-For HTTP header for determining the client’s IP address. Defaults to anything originating from localhost.

model_config : ClassVar[ConfigDict] = {'use_enum_values': True, 'validate_default': True}¶

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

permissionManager : str¶

The permission manager implementation to use.

remoteGroupsHeader : str¶

Header used by the reverse proxy to convey the authenticated user’s groups.

remoteGroupsMapping : dict[str, str]¶

Mapping from groups in the header to groups in OctoPrint.

remoteUserHeader : str¶

Header used by the reverse proxy to convey the authenticated user.

salt : str | None¶

Secret salt used for password hashing. DO NOT TOUCH! If changed you will no longer be able to log in with your existing accounts. Default unset, generated on first run.

sessionStaleAfter : int¶

Default time after which to consider a session stale due to no activity and to remove it.

trustBasicAuthentication : bool¶

Whether to trust Basic Authentication headers. If you have setup Basic Authentication in front of OctoPrint and the user names you use there match OctoPrint accounts, by setting this to true users will be logged into OctoPrint as the user during Basic Authentication. ONLY ENABLE THIS if your OctoPrint instance is only accessible through a connection locked down through Basic Authentication!

trustRemoteGroups : bool¶

Whether to trust remote groups headers. If you have setup authentication in front of OctoPrint and the groups names you use there match OctoPrint accounts, by setting this to true the user’s groups will be set to the groups provided in the header. ONLY ENABLE THIS if your OctoPrint instance is only accessible through a connection locked down through an authenticating reverse proxy!

trustRemoteUser : bool¶

Whether to trust remote user headers. If you have setup authentication in front of OctoPrint and the user names you use there match OctoPrint accounts, by setting this to true users will be logged into OctoPrint as the user provided in the header. ONLY ENABLE THIS if your OctoPrint instance is only accessible through a connection locked down through an authenticating reverse proxy!

userManager : str¶

users.yaml in the default configuration folder).

Type:¶

The user manager implementation to use for accessing user information. Currently only a filebased user manager is implemented which stores configured accounts in a YAML file (Default

userfile : str | None¶

The YAML user file to use. If left out defaults to users.yaml in the default configuration folder.

class octoprint.schema.config.api.ApiConfig(*, key: str | None = None, apps: dict[str, str] = {}, allowCrossOrigin: bool = False)¶

allowCrossOrigin : bool¶

Whether to allow cross origin access to the API or not.

apps : dict[str, str]¶

key : str | None¶

Global API key, deprecated, use User API keys instead. Unset by default, will be generated on first run.

model_config : ClassVar[ConfigDict] = {'use_enum_values': True, 'validate_default': True}¶

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class octoprint.schema.config.appearance.AppearanceConfig(*, name: str = '', color: ColorEnum = ColorEnum.default, colorTransparent: bool = False, colorIcon: bool = True, defaultLanguage: str = '_default', showFahrenheitAlso: bool = False, fuzzyTimes: bool = True, closeModalsWithClick: bool = True, showInternalFilename: bool = True, components: ComponentConfig = ComponentConfig(order=ComponentOrderConfig(navbar=['settings', 'systemmenu', 'plugin_announcements', 'plugin_logging_seriallog', 'plugin_logging_plugintimingslog', 'plugin_pi_support', 'plugin_health_check', 'login'], sidebar=['plugin_firmware_check_warning', 'plugin_firmware_check_info', 'connection', 'state', 'files'], tab=['temperature', 'control', 'plugin_gcodeviewer', 'terminal', 'timelapse'], settings=['section_printer', 'serial', 'printerprofiles', 'temperatures', 'terminalfilters', 'gcodescripts', 'section_features', 'features', 'webcam', 'accesscontrol', 'plugin_gcodeviewer', 'api', 'plugin_appkeys', 'section_octoprint', 'server', 'folders', 'appearance', 'plugin_logging', 'plugin_pluginmanager', 'plugin_softwareupdate', 'plugin_announcements', 'plugin_eventmanager', 'plugin_backup', 'plugin_tracking', 'plugin_errortracking', 'plugin_pi_support'], usersettings=['access', 'interface'], wizard=['plugin_softwareupdate_update', 'plugin_backup', 'plugin_corewizard_acl', 'plugin_corewizard_onlinecheck'], about=['about', 'plugin_pi_support', 'supporters', 'authors', 'changelog', 'license', 'thirdparty', 'plugin_pluginmanager', 'plugin_achievements', 'plugin_achievements_2', 'systeminfo'], generic=[]), disabled=ComponentDisabledConfig(navbar=[], sidebar=[], tab=[], settings=[], usersettings=[], wizard=[], about=[], generic=[])))¶

closeModalsWithClick : bool¶

color : ColorEnum¶

Use this to color the navigation bar.

colorIcon : bool¶

colorTransparent : bool¶

Makes the color of the navigation bar “transparent”. In case your printer uses acrylic for its frame 😉.

components : ComponentConfig¶

Configures the order and availability of the UI components.

defaultLanguage : str¶

Default language of OctoPrint. If left unset OctoPrint will try to match up available languages with the user’s browser settings.

fuzzyTimes : bool¶

model_config : ClassVar[ConfigDict] = {'use_enum_values': True, 'validate_default': True}¶

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name : str¶

<>”)

Type:¶

Use this to give your OctoPrint instance a name. It will be displayed in the title bar (as “<Name> [OctoPrint]”) and in the navigation bar (as “OctoPrint

showFahrenheitAlso : bool¶

showInternalFilename : bool¶

Show the internal filename in the files sidebar, if necessary.

class octoprint.schema.config.appearance.ColorEnum(*values)¶

blue = 'blue'¶

default = 'default'¶

green = 'green'¶

orange = 'orange'¶

red = 'red'¶

violet = 'violet'¶

yellow = 'yellow'¶

class octoprint.schema.config.appearance.ComponentConfig(*, order: ComponentOrderConfig = ComponentOrderConfig(navbar=['settings', 'systemmenu', 'plugin_announcements', 'plugin_logging_seriallog', 'plugin_logging_plugintimingslog', 'plugin_pi_support', 'plugin_health_check', 'login'], sidebar=['plugin_firmware_check_warning', 'plugin_firmware_check_info', 'connection', 'state', 'files'], tab=['temperature', 'control', 'plugin_gcodeviewer', 'terminal', 'timelapse'], settings=['section_printer', 'serial', 'printerprofiles', 'temperatures', 'terminalfilters', 'gcodescripts', 'section_features', 'features', 'webcam', 'accesscontrol', 'plugin_gcodeviewer', 'api', 'plugin_appkeys', 'section_octoprint', 'server', 'folders', 'appearance', 'plugin_logging', 'plugin_pluginmanager', 'plugin_softwareupdate', 'plugin_announcements', 'plugin_eventmanager', 'plugin_backup', 'plugin_tracking', 'plugin_errortracking', 'plugin_pi_support'], usersettings=['access', 'interface'], wizard=['plugin_softwareupdate_update', 'plugin_backup', 'plugin_corewizard_acl', 'plugin_corewizard_onlinecheck'], about=['about', 'plugin_pi_support', 'supporters', 'authors', 'changelog', 'license', 'thirdparty', 'plugin_pluginmanager', 'plugin_achievements', 'plugin_achievements_2', 'systeminfo'], generic=[]), disabled: ComponentDisabledConfig = ComponentDisabledConfig(navbar=[], sidebar=[], tab=[], settings=[], usersettings=[], wizard=[], about=[], generic=[]))¶

disabled : ComponentDisabledConfig¶

Disabled components per container. If a component is included here it will not be included in OctoPrint’s UI at all. Note that this might mean that critical functionality will not be available if no replacement is registered.

model_config : ClassVar[ConfigDict] = {'use_enum_values': True, 'validate_default': True}¶

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

order : ComponentOrderConfig¶

Defines the order of the components within their respective containers.

class octoprint.schema.config.appearance.ComponentDisabledConfig(*, navbar: list[str] = [], sidebar: list[str] = [], tab: list[str] = [], settings: list[str] = [], usersettings: list[str] = [], wizard: list[str] = [], about: list[str] = [], generic: list[str] = [])¶

about : list[str]¶

Disabled about dialog items.

generic : list[str]¶

Disabled generic items.

model_config : ClassVar[ConfigDict] = {'use_enum_values': True, 'validate_default': True}¶

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

navbar : list[str]¶

Disabled navbar items.

settings : list[str]¶

Disabled settings.

sidebar : list[str]¶

Disabled sidebar items.

tab : list[str]¶

Disabled tabs.

usersettings : list[str]¶

Disabled user settings.

wizard : list[str]¶

Disabled wizards.

class octoprint.schema.config.appearance.ComponentOrderConfig(*, navbar: list[str] = ['settings', 'systemmenu', 'plugin_announcements', 'plugin_logging_seriallog', 'plugin_logging_plugintimingslog', 'plugin_pi_support', 'plugin_health_check', 'login'], sidebar: list[str] = ['plugin_firmware_check_warning', 'plugin_firmware_check_info', 'connection', 'state', 'files'], tab: list[str] = ['temperature', 'control', 'plugin_gcodeviewer', 'terminal', 'timelapse'], settings: list[str] = ['section_printer', 'serial', 'printerprofiles', 'temperatures', 'terminalfilters', 'gcodescripts', 'section_features', 'features', 'webcam', 'accesscontrol', 'plugin_gcodeviewer', 'api', 'plugin_appkeys', 'section_octoprint', 'server', 'folders', 'appearance', 'plugin_logging', 'plugin_pluginmanager', 'plugin_softwareupdate', 'plugin_announcements', 'plugin_eventmanager', 'plugin_backup', 'plugin_tracking', 'plugin_errortracking', 'plugin_pi_support'], usersettings: list[str] = ['access', 'interface'], wizard: list[str] = ['plugin_softwareupdate_update', 'plugin_backup', 'plugin_corewizard_acl', 'plugin_corewizard_onlinecheck'], about: list[str] = ['about', 'plugin_pi_support', 'supporters', 'authors', 'changelog', 'license', 'thirdparty', 'plugin_pluginmanager', 'plugin_achievements', 'plugin_achievements_2', 'systeminfo'], generic: list[str] = [])¶

about : list[str]¶

Order of about dialog items.

generic : list[str]¶

Order of generic items.

model_config : ClassVar[ConfigDict] = {'use_enum_values': True, 'validate_default': True}¶

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

navbar : list[str]¶

Order of navbar items.

settings : list[str]¶

Order of settings.

sidebar : list[str]¶

Order of sidebar items.

tab : list[str]¶

Order of tabs.

usersettings : list[str]¶

Order of user settings.

wizard : list[str]¶

Order of wizards.

class octoprint.schema.config.controls.ContainerConfig¶

children : list[ContainerConfig | ControlConfig]¶

A list of children controls or containers contained within this container.

layout : LayoutEnum¶

The layout to use for laying out the contained children, either from top to bottom (vertical) or from left to right (horizontal).

model_config : ClassVar[ConfigDict] = {'use_enum_values': True, 'validate_default': True}¶

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name : str | None¶

A name to display above the container, basically a section header.

class octoprint.schema.config.controls.ControlConfig(*, name: str, command: str | None = None, commands: list[str] | None = None, script: str | None = None, javascript: str | None = None, additionalClasses: str | None = None, enabled: str | None = None, input: list[ControlInputConfig] | None = [], regex: str | None = None, template: str | None = None, confirm: str | None = None)¶

additionalClasses : str | None¶

Additional classes to apply to the button of a command, commands, script or javascript control, other than the default btn. Can be used to visually style the button, e.g. set to btn-danger to turn the button red.

command : str | None¶

A single GCODE command to send to the printer. Will be rendered as a button which sends the command to the printer upon click. The button text will be the value of the name attribute. Mutually exclusive with commands and script. The rendered button be disabled if the printer is currently offline or printing or alternatively if the requirements defined via the enabled attribute are not met.

commands : list[str] | None¶

A list of GCODE commands to send to the printer. Will be rendered as a button which sends the commands to the printer upon click. The button text will be the value of the name attribute. Mutually exclusive with command and script. The rendered button will be disabled if the printer is currently offline or printing or alternatively if the requirements defined via the enabled attribute are not met.

confirm : str | None¶

A text to display to the user to confirm his button press. Can be used with sensitive custom controls like changing EEPROM values in order to prevent accidental clicks. The text will be displayed in a confirmation dialog.

enabled : str | None¶

A JavaScript snippet returning either true or false determining whether the control should be enabled or not. This allows to override the default logic for the enable state of the control (disabled if printer is offline). The JavaScript snippet is eval’d and processed in a context where the control it is part of is provided as local variable data and the ControlViewModel is available as self.

input : list[ControlInputConfig] | None¶

A list of definitions of input parameters for a command or commands, to be rendered as additional input fields. command/commands may contain placeholders to be replaced by the values obtained from the user for the defined input fields.

javascript : str | None¶

A JavaScript snippet to be executed when the button rendered for command or commands is clicked. This allows to override the direct sending of the command or commands to the printer with more sophisticated behaviour. The JavaScript snippet is eval’d and processed in a context where the control it is part of is provided as local variable data and the ControlViewModel is available as self.

model_config : ClassVar[ConfigDict] = {'use_enum_values': True, 'validate_default': True}¶

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name : str¶

The name of the control, will be displayed either on the button if it’s a control sending a command or as a label for controls which only display output.

regex : str | None¶

//docs.python.org/3/library/re.html#regular-expression-syntax) to match against lines received from the printer to retrieve information from it (e.g. specific output). Together with template this allows rendition of received data from the printer within the UI.

Type:¶

A [regular expression <re-syntax>](https

script : str | None¶

The name of a full blown [GCODE script]() to send to the printer. Will be rendered as a button which sends the script to the printer upon click. The button text will be the value of the name attribute. Mutually exclusive with command and commands. The rendered button will be disabled if the printer is currently offline or printing or alternatively if the requirements defined via the enabled attribute are not met. Values of input parameters will be available in the template context under the parameter variable (e.g. an input parameter speed will be available in the script template as parameter.speed). On top of that all other variables defined in the [GCODE template context]() will be available.

template : str | None¶

{temperature}` for a regex T:s*(?P<temperature>d+(.d*)) or positional groups within the regex (e.g. Position: X={0}, Y={1}, Z={2}, E={3} for a regex X:([0-9.]+) Y:([0-9.]+) Z:([0-9.]+) E:([0-9.]+)).

Type:¶

A template to use for rendering the match of regex. May contain placeholders in [Python Format String Syntax](https

Type:¶

//docs.python.org/3/library/string.html#formatstrings) for either named groups within the regex (e.g. `Temperature

class octoprint.schema.config.controls.ControlInputConfig(*, name: str, parameter: str, default: str | int | float | bool, slider: ControlSliderInputConfig | None = None)¶

default : str | int | float | bool¶

Default value for the input field.

model_config : ClassVar[ConfigDict] = {'use_enum_values': True, 'validate_default': True}¶

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name : str¶

Name to display for the input field.

parameter : str¶

Internal parameter name for the input field, used as a placeholder in command/commands.

slider : ControlSliderInputConfig | None¶

If this attribute is included, instead of an input field a slider control will be rendered.

class octoprint.schema.config.controls.ControlSliderInputConfig(*, min: int = 0, max: int = 255, step: int = 1)¶

max : int¶

Maximum value of the slider.

min : int¶

Minimum value of the slider.

model_config : ClassVar[ConfigDict] = {'use_enum_values': True, 'validate_default': True}¶

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

step : int¶

Step size per slider tick.

class octoprint.schema.config.controls.LayoutEnum(*values)¶

horizontal = 'horizontal'¶

horizontal_grid = 'horizontal_grid'¶

vertical = 'vertical'¶

class octoprint.schema.config.devel.DevelCacheConfig(*, enabled: bool = True, preemptive: bool = True)¶

enabled : bool¶

Whether to enable caching. Defaults to true. Setting it to false will cause the UI to always be fully rerendered on request to / on the server.

model_config : ClassVar[ConfigDict] = {'use_enum_values': True, 'validate_default': True}¶

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

preemptive : bool¶

Whether to enable the preemptive cache.

class octoprint.schema.config.devel.DevelConfig(*, stylesheet: StylesheetEnum = StylesheetEnum.css, cache: DevelCacheConfig = DevelCacheConfig(enabled=True, preemptive=True), webassets: DevelWebassetsConfig = DevelWebassetsConfig(bundle=True, clean_on_startup=True, minify=True, minify_plugins=False), useFrozenDictForPrinterState: bool = True, showLoadingAnimation: bool = True, sockJsConnectTimeout: float = 30, pluginTimings: bool = False, enableRateLimiter: bool = True, enableCsrfProtection: bool = True)¶

cache : DevelCacheConfig¶

Settings for OctoPrint’s internal caching.

enableCsrfProtection : bool¶

Enable or disable the CSRF protection. Careful, disabling this reduces security.

enableRateLimiter : bool¶

Enable or disable the rate limiter. Careful, disabling this reduces security.

model_config : ClassVar[ConfigDict] = {'use_enum_values': True, 'validate_default': True}¶

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

pluginTimings : bool¶

showLoadingAnimation : bool¶

Enable or disable the loading animation.

sockJsConnectTimeout : float¶

stylesheet : StylesheetEnum¶

Settings for stylesheet preference. OctoPrint will prefer to use the stylesheet type specified here. Usually (on a production install) that will be the compiled css (default). Developers may specify less here too.

useFrozenDictForPrinterState : bool¶

webassets : DevelWebassetsConfig¶

Settings for OctoPrint’s web asset merging and minifying.

class octoprint.schema.config.devel.DevelWebassetsConfig(*, bundle: bool = True, clean_on_startup: bool = True, minify: bool = True, minify_plugins: bool = False)¶

bundle : bool¶

if this is set to false, no minification will take place regardless of the minify setting.

Type:¶

If set to true, OctoPrint will merge all JS, all CSS and all Less files into one file per type to reduce request count. Setting it to false will load all assets individually. Note

clean_on_startup : bool¶

Whether to delete generated web assets on server startup (forcing a regeneration).

minify : bool¶

if bundle is set to false, no minification will take place either.

Type:¶

If set to true, OctoPrint will the core and library javascript assets. Note

minify_plugins : bool¶

if bundle or minify are set to false, no minification of the plugin assets will take place either.

Type:¶

If set to true, OctoPrint will also minify the third party plugin javascript assets. Note

model_config : ClassVar[ConfigDict] = {'use_enum_values': True, 'validate_default': True}¶

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class octoprint.schema.config.devel.StylesheetEnum(*values)¶

css = 'css'¶

less = 'less'¶

class octoprint.schema.config.estimation.EstimationConfig(*, printTime: PrintTimeEstimationConfig = PrintTimeEstimationConfig(statsWeighingUntil=0.5, validityRange=0.15, forceDumbFromPercent=0.3, forceDumbAfterMin=30.0, stableThreshold=60))¶

model_config : ClassVar[ConfigDict] = {'use_enum_values': True, 'validate_default': True}¶

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

printTime : PrintTimeEstimationConfig¶

Parameters for the print time estimation during an ongoing print job.

class octoprint.schema.config.estimation.PrintTimeEstimationConfig(*, statsWeighingUntil: float = 0.5, validityRange: float = 0.15, forceDumbFromPercent: float = 0.3, forceDumbAfterMin: float = 30.0, stableThreshold: int = 60)¶

forceDumbAfterMin : float¶

If no estimate could be calculated until this many minutes into the print and no statistical data is available, use dumb linear estimate.

forceDumbFromPercent : float¶

If no estimate could be calculated until this percentage and no statistical data is available, use dumb linear estimate. Value between 0 and 1.0.

model_config : ClassVar[ConfigDict] = {'use_enum_values': True, 'validate_default': True}¶

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

stableThreshold : int¶

Average fluctuation between individual calculated estimates to consider in stable range. Seconds of difference.

statsWeighingUntil : float¶

Until which percentage to do a weighted mixture of statistical duration (analysis or past prints) with the result from the calculated estimate if that’s already available. Utilized to compensate for the fact that the earlier in a print job, the least accuracy even a stable calculated estimate provides.

validityRange : float¶

Range the assumed percentage (based on current estimated statistical, calculated or mixed total vs elapsed print time so far) needs to be around the actual percentage for the result to be used.

class octoprint.schema.config.events.EventSubscription(*, event: str, name: str | None = None, command: str, type: SubscriptionTypeEnum, enabled: bool = True, debug: bool = False)¶

command : str¶

The command to execute when the event is triggered, either a GCODE or a system command.

debug : bool¶

If set to true, OctoPrint will log the command after performing all placeholder replacements.

enabled : bool¶

Whether the event subscription should be enabled.

event : str¶

The event to subscribe to.

model_config : ClassVar[ConfigDict] = {'use_enum_values': True, 'validate_default': True}¶

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name : str | None¶

The event name to show on the UI

type : SubscriptionTypeEnum¶

The type of the command.

class octoprint.schema.config.events.EventsConfig(*, enabled: bool = True, subscriptions: list[EventSubscription] = [])¶

enabled : bool¶

Whether event subscriptions should be enabled or not.

model_config : ClassVar[ConfigDict] = {'use_enum_values': True, 'validate_default': True}¶

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

subscriptions : list[EventSubscription]¶

A list of event subscriptions.

class octoprint.schema.config.events.SubscriptionTypeEnum(*values)¶

gcode = 'gcode'¶

system = 'system'¶

class octoprint.schema.config.feature.FeatureConfig(*, temperatureGraph: bool = True, sdSupport: bool = True, keyboardControl: bool = True, pollWatched: bool = False, modelSizeDetection: bool = True, rememberFileFolder: bool = False, printStartConfirmation: bool = False, printCancelConfirmation: bool = True, uploadOverwriteConfirmation: bool = True, fileDeleteConfirmation: bool = True, autoUppercaseBlacklist: list[str] = ['M117', 'M118', 'M707', 'M708'], g90InfluencesExtruder: bool = False, enforceReallyUniversalFilenames: bool = False, enableDragDropUpload: bool = True)¶

autoUppercaseBlacklist : list[str]¶

Commands that should never be auto-uppercased when sent to the printer through the Terminal tab.

enableDragDropUpload : bool¶

Enable drag and drop upload overlay

enforceReallyUniversalFilenames : bool¶

Replace all special characters and spaces with text equivalent to make them universally compatible. Most OS filesystems work fine with unicode characters, but just in case you can revert to the older behaviour by setting this to true.

fileDeleteConfirmation : bool¶

Whether to show a confirmation when about to delete a file

g90InfluencesExtruder : bool¶

Whether G90/G91 also influence absolute/relative mode of extruders.

keyboardControl : bool¶

Whether to enable the keyboard control feature in the control tab.

modelSizeDetection : bool¶

Whether to enable model size detection and warning (true) or not (false).

model_config : ClassVar[ConfigDict] = {'use_enum_values': True, 'validate_default': True}¶

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

pollWatched : bool¶

Whether to actively poll the watched folder (true) or to rely on the OS’s file system notifications instead (false).

printCancelConfirmation : bool¶

Whether to show a confirmation on print cancelling (true) or not (false)

printStartConfirmation : bool¶

Whether to show a confirmation on print start (true) or not (false)

rememberFileFolder : bool¶

Whether to remember the selected folder on the file manager.

sdSupport : bool¶

Specifies whether support for SD printing and file management should be enabled.

temperatureGraph : bool¶

Whether to enable the temperature graph in the UI or not.

uploadOverwriteConfirmation : bool¶

Whether to show a confirmation when about to overwrite an uploaded file