2015-01-27 13:21:41 +00:00
|
|
|
.. _sec-plugins-mixins:
|
|
|
|
|
|
|
|
|
|
Available plugin mixins
|
|
|
|
|
=======================
|
|
|
|
|
|
2015-02-27 19:28:24 +00:00
|
|
|
The following plugin mixins are currently available:
|
|
|
|
|
|
|
|
|
|
.. contents::
|
|
|
|
|
:local:
|
|
|
|
|
|
|
|
|
|
Please note that all plugin mixins inherit from :class:`~octoprint.plugin.core.Plugin` and
|
2015-03-06 00:42:49 +00:00
|
|
|
:class:`~octoprint.plugin.types.OctoPrintPlugin`, which also provide attributes of interest to plugin developers.
|
2015-02-27 19:28:24 +00:00
|
|
|
|
|
|
|
|
.. _sec-plugins-mixins-startupplugin:
|
|
|
|
|
|
|
|
|
|
StartupPlugin
|
|
|
|
|
-------------
|
|
|
|
|
|
|
|
|
|
.. autoclass:: octoprint.plugin.StartupPlugin
|
|
|
|
|
:members:
|
|
|
|
|
|
|
|
|
|
.. _sec-plugins-mixins-shutdownplugin:
|
|
|
|
|
|
|
|
|
|
ShutdownPlugin
|
|
|
|
|
--------------
|
|
|
|
|
|
|
|
|
|
.. autoclass:: octoprint.plugin.ShutdownPlugin
|
|
|
|
|
:members:
|
|
|
|
|
|
|
|
|
|
.. _sec-plugins-mixins-settingsplugin:
|
|
|
|
|
|
|
|
|
|
SettingsPlugin
|
|
|
|
|
--------------
|
|
|
|
|
|
|
|
|
|
.. autoclass:: octoprint.plugin.SettingsPlugin
|
|
|
|
|
:members:
|
|
|
|
|
|
|
|
|
|
.. _sec-plugins-mixins-assetplugin:
|
|
|
|
|
|
|
|
|
|
AssetPlugin
|
|
|
|
|
-----------
|
|
|
|
|
|
|
|
|
|
.. autoclass:: octoprint.plugin.AssetPlugin
|
|
|
|
|
:members:
|
|
|
|
|
|
|
|
|
|
.. _sec-plugins-mixins-templateplugin:
|
|
|
|
|
|
|
|
|
|
TemplatePlugin
|
|
|
|
|
--------------
|
|
|
|
|
|
|
|
|
|
.. autoclass:: octoprint.plugin.TemplatePlugin
|
|
|
|
|
:members:
|
|
|
|
|
|
|
|
|
|
.. _sec-plugins-mixins-simpleapiplugin:
|
|
|
|
|
|
|
|
|
|
SimpleApiPlugin
|
|
|
|
|
---------------
|
|
|
|
|
|
|
|
|
|
.. autoclass:: octoprint.plugin.SimpleApiPlugin
|
|
|
|
|
:members:
|
|
|
|
|
|
|
|
|
|
.. _sec-plugins-mixins-blueprintplugin:
|
|
|
|
|
|
|
|
|
|
BlueprintPlugin
|
|
|
|
|
---------------
|
|
|
|
|
|
|
|
|
|
.. autoclass:: octoprint.plugin.BlueprintPlugin
|
|
|
|
|
:members:
|
|
|
|
|
|
|
|
|
|
.. _sec-plugins-mixins-eventhandlerplugin:
|
|
|
|
|
|
|
|
|
|
EventHandlerPlugin
|
|
|
|
|
------------------
|
|
|
|
|
|
|
|
|
|
.. autoclass:: octoprint.plugin.EventHandlerPlugin
|
|
|
|
|
:members:
|
|
|
|
|
|
|
|
|
|
.. _sec-plugins-mixins-progressplugin:
|
|
|
|
|
|
|
|
|
|
ProgressPlugin
|
|
|
|
|
--------------
|
|
|
|
|
|
|
|
|
|
.. autoclass:: octoprint.plugin.ProgressPlugin
|
|
|
|
|
:members:
|
|
|
|
|
|
|
|
|
|
.. _sec-plugins-mixins-slicerplugin:
|
|
|
|
|
|
|
|
|
|
SlicerPlugin
|
|
|
|
|
------------
|
|
|
|
|
|
|
|
|
|
.. autoclass:: octoprint.plugin.SlicerPlugin
|
|
|
|
|
:members:
|
|
|
|
|
|