Injected Properties
OctoPrint’s plugin subsystem will inject a bunch of properties into each mixin implementation. An overview of these properties follows.
self._identifierThe plugin’s identifier.
self._plugin_nameThe plugin’s name, as taken from either the
__plugin_name__control property or the package info.self._plugin_versionThe plugin’s version, as taken from either the
__plugin_version__control property or the package info.self._plugin_infoThe
octoprint.plugin.core.PluginInfoobject associated with the plugin.self._basefolderThe plugin’s base folder where it’s installed. Can be used to refer to files relative to the plugin’s installation location, e.g. included scripts, templates or assets.
self._datafolderThe plugin’s additional data folder path. Can be used to store additional files needed for the plugin’s operation (cache, data files etc). Plugins should not access this property directly but instead utilize
get_plugin_data_folder()which will make sure the path actually does exist and if not create it before returning it.self._loggerA
logging.Loggerinstance logging to the log targetoctoprint.plugin.<plugin identifier>.self._settingsThe plugin’s personalized settings manager, injected only into plugins that include the
SettingsPluginmixin. An instance ofoctoprint.plugin.PluginSettings.self._plugin_managerOctoPrint’s plugin manager object, an instance of
octoprint.plugin.core.PluginManager.self._printer_profile_managerOctoPrint’s printer profile manager, an instance of
octoprint.printer.profile.PrinterProfileManager.self._event_busOctoPrint’s event bus, an instance of
octoprint.events.EventManager.self._analysis_queueOctoPrint’s analysis queue for analyzing GCODEs or other files, an instance of
octoprint.filemanager.analysis.AnalysisQueue.self._slicing_managerOctoPrint’s slicing manager, an instance of
octoprint.slicing.SlicingManager.self._file_managerOctoPrint’s file manager, an instance of
octoprint.filemanager.FileManager.self._printerOctoPrint’s printer management object, an instance of
octoprint.printer.PrinterInterface.self._user_managerOctoPrint’s user manager, an instance of
octoprint.access.users.UserManager.self._connectivity_checkerOctoPrint’s connectivity checker, an instance of
octoprint.util.ConnectivityChecker.
See also
PluginandOctoPrintPluginClass documentation also containing the properties shared among all mixin implementations.
- Available Mixins
Some mixin types trigger the injection of additional properties.