go back Back

Machine Plugin Refactor

21 Aug 2025 Oliver

Machine Plugin Refactor

In preparation for the upcoming 1.0.0 release, we have made some breaking changes to the machine registry plugin system.

These changes require that any existing plugins which implement custom machine drivers must be updated to use the new plugin system. A new mixin class, MachineDriverMixin, has been introduced to facilitate this transition.

Plugin developers should refer to the notes below to determine how to update their plugins.

References

Changes

The linked pull request makes a number of changes to both the plugin system and machine registry.

The most significant of these changes is the introduction of the MachineDriverMixin class, which now provides a standard interface for plugins which register custom machine drivers, or custom machine types.

Plugin developers can refer to linked pull request, in addition to the updated plugin mixin documentation, for more information on how to implement this new interface.

The required changes to existing plugins are minimal, and should be straightforward to implement.

Example

As an example, the inventree-brother-plugin has been updated to use the new MachineDriverMixin class.

Refer to this pull request to see the changes made to the plugin.