Machine integration

[wolflu05]

This PR adds the machines feature described in #4789 .

fixes #4789

---

📝 Todos

Beta Give feedback

1. 🚚 driver errors
2. 🚚 handle error function for machines and registry
3. 🚚 Init driver function
4. 🚚 Machine update hook function (only partially working)
5. 🚚 Machine has unapplied changes (restart required)
6. 🚚 Machine restart hook
7. 🚚 get_machines should by default only return initialized machines
8. 🚚 funtion to check if all required settings are defined
9. 🚚 Machine States (Ready, Connecting, …) (waiting on Refactor states/status #4857)
10. 🚚 export everything required from the plugin app
11. 🚚 get all machines, can be maybe used in combination with event mixin
12. 🚚 get_machines function for driver to return all machines belonging to that driver
13. 🚚 separate machine type and base driver
14. 📫 API GET available machine types / drivers
15. 📫 API CRUD machines
16. 📫 API CRUD machine settings
17. 📫 API Permissions
18. 💄 PUI Settings Page
19. 💄 PUI machine list: table
20. 💄 PUI machine list: registry errors
21. 💄 PUI machine list: add machine
22. 💄 PUI machine detail: view
23. 💄 PUI machine type table with detail drawer: showing machine type info and list available drivers and Which plugin provides that type
24. 💄 PUI machine driver drawer with some info about it
25. 💄 PUI driver drawer error stack + show all machines
26. 🎰 LABEL PRINTING machine type
27. 🎰 LABEL PRINTING: print_label
28. 🎰 LABEL PRINTING: print_labels
29. 🎰 LABEL PRINTING: location setting (useful for basic location scoping)
30. 🎰 LABEL PRINTING: get_printers (implement at driver level, useful for filtering the printers based on certain hardware aspects)
31. 🎰 LABEL PRINTING: number of copies printing option
32. 🎰 LABEL PRINTING: include request in get_printers kwargs
33. 🎰 LABEL PRINTING: remember last used printer machine per user
34. ✨ Add Machine Settings and separat from driver settings (Machine settings could be used for e.g. printer location)
35. ✨ Machine active
36. ✨ Sync machine registry with creating/updating/deleting of machines
37. 🚒 dont initialize if machine is not fully configured (error handeling)
38. 🚒 Check if machine initialized without error (error handeling)
39. 🚒 Check if driver implements all required functions (error handeling)
40. ♻️ refactor to mixin for override detection (add/check required configuration to classes, required_{attributed,overrides})
41. ♻️ refactor machine pk should be UUID
42. ♻️ refactor rename base_driver to machine_type
43. ♻️ refactor move check into own check function isPlgRegistryLoaded (Prevent MachineConfig.ready to be executed twice)

⚠️ Before merge

Beta Give feedback

1. check TODO: comments
2. fix style (precommit)
3. remove debug messages
4. Remove badly working django admin interface for machine integration
5. Cups plugin providing a fully working example driver (Refactor to use machine driver API wolflu05/inventree-cups-plugin#6)
6. Docs
7. Tests
8. bump api version

♻️ External PRs/Refactors

Beta Give feedback

1. Skip ready functions if not in main thread or plugins are not loaded yet #5005
   breaking enhancement plugin +3
2. Label plugin refactor #5251
   api breaking enhancement plugin report +5
3. Refactor: BaseInvenTreeSetting #4834
   refactor +1
   
4. Refactor model helpers into own file #4927
   refactor +1
   
5. Added required attribute to settings/plugins, refactor: allValues #5224
   enhancement plugin refactor +3
6. Printing options #5786
   api enhancement plugin +3
7. Form improvements #5837
   enhancement user interface +2

💡Further ideas (Not this PR)

Moved to #6486

[wolflu05]

@matmair Do you think the Base Drivers should be exported from the machine or plugin app? (The notification adapters defined in common are exported through the plugin app)

[matmair]

@wolflu05 if you are not against it I would suggest it. The idea is that there always is a simple and steady path for the things we expose for plugins while we are free to refactor the inner workings and structure without breaking plugins.

[wolflu05]

I'm planning on add the ability that machines can expose their current states. E.g. for a label printer: Ready, Printing, Disconnected, ... do you think this makes sense to define per Machine Type or per CustomMachineDriver? (Want to have a proper Interface with Enums).

Per MachineType has the ability that they are equal across all label printers. However something custom like "out of labels", "machine opened" ... is not possible. I guess there are more different states on other machine types like PnP. What about having both abilities? MachineType specific states and a machine status that's just a simple string?

[matmair]

@wolflu05 status/state, in general, needs a bit of a refactor (see #4289, #4589). To keep this PR somewhat my suggestion would be to add enums to the machine type and enable drivers to define current state (the enum from machine) and state text (free text, by default from machine type state but can be set to "anything")

[wolflu05]

9 months passed now, this is my biggest PR and I learned a lot about InvenTree and Django during that time. Now this PR is finally ready for review 🚀 . @SchrodingersGat @matmair

I can recommend to start reviewing this by reading the docs to understand how the machine registry, custom drivers and types work before taking a deeper look into the code.

As an example, I adapted my cups label printer plugin to use the new driver interface. You can find it here if you want to see a real driver actually being implemented.
EDIT: I now also implemented a dedicated Dymo driver that uses native printer commands in inventree-dymo-plugin. (That driver is simpler than the cups driver.)

During this PR I collected a list of related things that can be further improvements (see initial comment) which I will post in a new issue once this is merged.

If you have any questions, feel free to comment, I'm really curious about your feedback.

[matmair]

LGTM; huge work effort, thanks @wolflu05

[SchrodingersGat]

@wolflu05 this is a massive effort to get this up and running, apologies for any road blocks along the way :)

This all looks good, but please appreciate that with such a large contribution, there are going to be some teething issue and bugs we have not spotted. It all appears to be in order and I am happy to merge now, so that we have some time before the next release to spot any obvious issues.

Without any machines to fill in myself, it is hard to create any test data to work with.

As we progress, it would be great to work on some more examples for the documentation of different types of machines, as we build those up.

No doubt you will be tagged in a number of issues / questions around all this :)

BTW regarding the style issue - once #6481 is merged, please merge master back in to your branch and we should be good to go.

[SchrodingersGat]

Congrats and thanks @wolflu05 - let's hope it is a smooth integration from here!

[wolflu05]

This all looks good, but please appreciate that with such a large contribution, there are going to be some teething issue and bugs we have not spotted. [...] No doubt you will be tagged in a number of issues / questions around all this :)

This is actually the largest PR I've ever done. All good, feel free to ping me if there is anything I can help with. Hopefully we don't find to much issues 😆.

Without any machines to fill in myself, it is hard to create any test data to work with.

If you want to test it, you can create a simple driver and place it anywhere in the code like this:

Testing driver

from plugin.machine.machine_types import LabelPrinterBaseDriver

class TestLabelPrinterDriver(LabelPrinterBaseDriver):
    """Label printer driver for Dymo printers."""

    SLUG = "test-driver"
    NAME = "Test Driver"
    DESCRIPTION = "Test label printing driver for InvenTree"

    MACHINE_SETTINGS = {
        "CONNECTION_URL": {
            "name": "Connection url",
            "description": "Connection url for the machine in format user@server:port/route",
            "required": True,
        }
    }

    def print_labels(self, machine, label, items, request, **kwargs):
        print("==== Print label")
        print(machine, label, items, request, kwargs)
        print(machine.get_setting('CONNECTION_URL', 'D'))
        print("="*10)

As we progress, it would be great to work on some more examples for the documentation of different types of machines, as we build those up.

Definitely, I think the documentation around this has big potential, also the generated part from the docstrings.

Congrats and thanks @wolflu05 - let's hope it is a smooth integration from here!

Thank you very much for merging, this is a great step forward, I actually really hadn't expected to get this merged that quick. And yes, let's hope it is a smooth integration 😆 .