Client Integration: OctoPrint

[its-leofisher]

This Repo

• Update docs for specific Integration Steps
  • Update diagram for OctoPrint Setup
  • Integrate API Key Authentication instead of JWT
    • Autogenerate on initial Setup and allow to autogenerate via CLI Command
  • New endpoint to grab Primary Device and Mapping Data
    • Rate Limit - See ### Key Based Rate Limiting Docs
    • Devices Endpoint: REST Routes
      • /v1/devices
        • GET - /v1/devices - List All Devices
        • GET - /v1/devices/id - Get specific device
        • PUT - /v1/devices/id - Update Device Settings: Status and Color
  • Set up postman

Octoprint Plugin Repo

• Octoprint plugin to assign Printing statuses and behaviors
  • Settings
    • Statuses, Behaviors, Enable/Disable toggle
    • Scheduled Time for example do not send requests between 10pm and 8am. or always on.
    • Access token (Generated during setup.py)
  • Statuses via Events Mixin
    • PrintStarted, PrintFailed, PrintDone, PrintCancelling, PrintCancelled, PrintPaused, PrintResumed
    • https://docs.octoprint.org/en/master/events/index.html#printing
    • Events Docs: https://docs.octoprint.org/en/master/plugins/mixins.html#eventhandlerplugin
    • Event Implementation Example: https://github.com/OctoPrint/OctoPrint-Growl?tab=readme-ov-file
  • Phase 2
    • Display all devices available and select it. Going Light will need a get_devices endpoint and a update_devices endpoint to assign