octoprint_compat: Compatibility with Cura Octoprint plugin to upload UFP files.
This PR is a minimal implementation of the Octoprint REST API that is required for Cura to be able to establish a connection and send gcode/UFP files to moonraker without errors. Currently it only supports the "global apikey authentication" method. Signed-off-by: Nickolas Grigoriadis <nagrigoriadis@gmail.com>
This commit is contained in:
Grigi
Arksine
parent
228ed34eb1
commit
39ab419c1f
|
|
@ -92,8 +92,7 @@ class MoonrakerApp:
|
|||
self.mutable_router = MutableRouter(self)
|
||||
app_handlers = [
|
||||
(AnyMatches(), self.mutable_router),
|
||||
(r"/websocket", WebSocket),
|
||||
(r"/api/version", EmulateOctoprintHandler)]
|
||||
(r"/websocket", WebSocket)]
|
||||
|
||||
self.app = tornado.web.Application(
|
||||
app_handlers,
|
||||
|
|
@ -368,11 +367,3 @@ class FileUploadHandler(AuthorizedRequestHandler):
|
|||
raise tornado.web.HTTPError(
|
||||
e.status_code, str(e))
|
||||
self.finish(result)
|
||||
|
||||
|
||||
class EmulateOctoprintHandler(AuthorizedRequestHandler):
|
||||
def get(self):
|
||||
self.finish({
|
||||
'server': "1.1.1",
|
||||
'api': "0.1",
|
||||
'text': "OctoPrint Upload Emulator"})
|
||||
|
|
|
|||
|
|
@ -0,0 +1,278 @@
|
|||
# Octoprint API compatibility
|
||||
#
|
||||
# Copyright (C) 2021 Nickolas Grigoriadis <nagrigoriadis@gmail.com>
|
||||
#
|
||||
# This file may be distributed under the terms of the GNU GPLv3 license.
|
||||
import logging
|
||||
|
||||
import utils
|
||||
|
||||
OCTO_VERSION = '1.5.0'
|
||||
|
||||
|
||||
class OctoprintCompat:
|
||||
"""
|
||||
Minimal implementation of the REST API as described here:
|
||||
https://docs.octoprint.org/en/master/api/index.html
|
||||
|
||||
So that Cura Octoprint plugin will function for:
|
||||
* Handshake
|
||||
* Upload gcode/ufp
|
||||
* Webcam config
|
||||
* Manual GCode submission
|
||||
* Heater temperatures
|
||||
"""
|
||||
|
||||
def __init__(self, config):
|
||||
self.server = config.get_server()
|
||||
self.software_version = config['system_args'].get('software_version')
|
||||
|
||||
# Local variables
|
||||
self.klippy_apis = None
|
||||
self.heaters = []
|
||||
|
||||
# Register status update event
|
||||
self.server.register_event_handler(
|
||||
'server:klippy_ready', self._init)
|
||||
|
||||
# Version & Server information
|
||||
self.server.register_endpoint(
|
||||
'/api/version', ['GET'], self._get_version, wrap_result=False)
|
||||
self.server.register_endpoint(
|
||||
'/api/server', ['GET'], self._get_server, wrap_result=False)
|
||||
|
||||
# Login, User & Settings
|
||||
self.server.register_endpoint(
|
||||
'/api/login', ['POST'], self._post_login_user, wrap_result=False)
|
||||
self.server.register_endpoint(
|
||||
'/api/currentuser', ['GET'], self._post_login_user,
|
||||
wrap_result=False)
|
||||
self.server.register_endpoint(
|
||||
'/api/settings', ['GET'], self._get_settings, wrap_result=False)
|
||||
|
||||
# File operations
|
||||
# Note that file upload is handled in file_manager.py
|
||||
# TODO: List/info/select/delete files
|
||||
|
||||
# Job operations
|
||||
self.server.register_endpoint(
|
||||
'/api/job', ['GET'], self._get_job, wrap_result=False)
|
||||
# TODO: start/cancel/restart/pause jobs
|
||||
|
||||
# Printer operations
|
||||
self.server.register_endpoint(
|
||||
'/api/printer', ['GET'], self._get_printer, wrap_result=False)
|
||||
self.server.register_endpoint(
|
||||
'/api/printer/command', ['POST'], self._post_command,
|
||||
wrap_result=False)
|
||||
# TODO: head/tool/bed/chamber specific read/issue
|
||||
|
||||
# Printer profiles
|
||||
self.server.register_endpoint(
|
||||
'/api/printerprofiles', ['GET'], self._get_printerprofiles,
|
||||
wrap_result=False)
|
||||
|
||||
# System
|
||||
# TODO: shutdown/reboot/restart operations
|
||||
|
||||
async def _init(self):
|
||||
self.klippy_apis = self.server.lookup_plugin('klippy_apis')
|
||||
# Fetch heaters
|
||||
try:
|
||||
result = await self.klippy_apis.query_objects({'heaters': None})
|
||||
except self.server.error as e:
|
||||
logging.info(f'Error Configuring heaters: {e}')
|
||||
return
|
||||
self.heaters = result.get('heaters', {}).get('available_sensors', [])
|
||||
|
||||
async def printer_state(self):
|
||||
if not self.klippy_apis:
|
||||
return 'Offline'
|
||||
if self.server.klippy_state != 'ready':
|
||||
return 'Error'
|
||||
result = await self.klippy_apis.query_objects({'print_stats': None})
|
||||
return {
|
||||
'standby': 'Operational',
|
||||
'printing': 'Printing',
|
||||
'paused': 'Paused',
|
||||
'complete': 'Operational'
|
||||
}.get(result.get('state', 'standby'), 'Error')
|
||||
|
||||
async def printer_temps(self):
|
||||
temps = {}
|
||||
if not self.klippy_apis:
|
||||
return temps
|
||||
if self.heaters:
|
||||
result = await self.klippy_apis.query_objects(
|
||||
{heater: None for heater in self.heaters})
|
||||
for heater in self.heaters:
|
||||
data = result[heater]
|
||||
name = 'bed'
|
||||
if heater.startswith('extruder'):
|
||||
try:
|
||||
tool_no = int(heater[8:])
|
||||
except ValueError:
|
||||
tool_no = 0
|
||||
name = f'tool{tool_no}'
|
||||
|
||||
temps[name] = {
|
||||
'actual': int(data['temperature'] * 100.0) / 100.0,
|
||||
'offset': 0,
|
||||
'target': data['target'],
|
||||
}
|
||||
return temps
|
||||
|
||||
async def _get_version(self, web_request):
|
||||
"""
|
||||
Version information
|
||||
"""
|
||||
return {
|
||||
'server': OCTO_VERSION,
|
||||
'api': '0.1',
|
||||
'text': f'OctoPrint (Moonraker {self.software_version})',
|
||||
}
|
||||
|
||||
async def _get_server(self, web_request):
|
||||
"""
|
||||
Server status
|
||||
"""
|
||||
return {
|
||||
'server': OCTO_VERSION,
|
||||
'safemode': (
|
||||
None if self.server.klippy_state == 'ready' else 'settings')
|
||||
}
|
||||
|
||||
async def _post_login_user(self, web_request):
|
||||
"""
|
||||
Confirm session login.
|
||||
|
||||
Since we only support apikey auth, do nothing.
|
||||
Report hardcoded user called _api
|
||||
"""
|
||||
return {
|
||||
'_is_external_client': False,
|
||||
'_login_mechanism': 'apikey',
|
||||
'name': '_api',
|
||||
'active': True,
|
||||
'user': True,
|
||||
'admin': True,
|
||||
'apikey': None,
|
||||
'permissions': [],
|
||||
'groups': ['admins', 'users'],
|
||||
}
|
||||
|
||||
async def _get_settings(self, web_request):
|
||||
"""
|
||||
Used to parse Octoprint capabilities
|
||||
|
||||
Hardcode capabilities to be basically there and use default
|
||||
fluid/mainsail webcam path.
|
||||
"""
|
||||
return {
|
||||
'plugins': {
|
||||
'UltimakerFormatPackage': {
|
||||
'align_inline_thumbnail': False,
|
||||
'inline_thumbnail': False,
|
||||
'inline_thumbnail_align_value': 'left',
|
||||
'inline_thumbnail_scale_value': '50',
|
||||
'installed': True,
|
||||
'installed_version': '0.2.2',
|
||||
'scale_inline_thumbnail': False,
|
||||
'state_panel_thumbnail': True,
|
||||
},
|
||||
},
|
||||
'feature': {
|
||||
'sdSupport': False,
|
||||
'temperatureGraph': False
|
||||
},
|
||||
# TODO: Get webcam settings from config file to allow user
|
||||
# to customise this.
|
||||
'webcam': {
|
||||
'flipH': False,
|
||||
'flipV': False,
|
||||
'rotate90': False,
|
||||
'streamUrl': '/webcam/?action=stream',
|
||||
'webcamEnabled': True,
|
||||
},
|
||||
}
|
||||
|
||||
async def _get_job(self, web_request):
|
||||
"""
|
||||
Get current job status
|
||||
"""
|
||||
return {
|
||||
'job': {
|
||||
'file': {'name': None,},
|
||||
'estimatedPrintTime': None,
|
||||
'filament': {'length': None},
|
||||
'user': None,
|
||||
},
|
||||
'progress': {
|
||||
'completion': None,
|
||||
'filepos': None,
|
||||
'printTime': None,
|
||||
'printTimeLeft': None,
|
||||
'printTimeOrigin': None,
|
||||
},
|
||||
'state': await self.printer_state()
|
||||
}
|
||||
|
||||
async def _get_printer(self, web_request):
|
||||
"""
|
||||
Get Printer status
|
||||
"""
|
||||
state = await self.printer_state()
|
||||
return {
|
||||
'temperature': await self.printer_temps(),
|
||||
'state': {
|
||||
'text': state,
|
||||
'flags': {
|
||||
'operational': state not in ['Error', 'Offline'],
|
||||
'paused': state == 'Paused',
|
||||
'printing': state == 'Printing',
|
||||
'cancelling': state == 'Cancelling',
|
||||
'pausing': False,
|
||||
'error': state == 'Error',
|
||||
'ready': state == 'Operational',
|
||||
'closedOrError': state in ['Error', 'Offline'],
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
async def _post_command(self, web_request):
|
||||
"""
|
||||
Request to run some gcode command
|
||||
"""
|
||||
commands = web_request.get('commands', [])
|
||||
for command in commands:
|
||||
logging.info(f'Executing GCode: {command}')
|
||||
try:
|
||||
await self.klippy_apis.run_gcode(command)
|
||||
except self.server.error:
|
||||
msg = f"Error executing GCode {command}"
|
||||
logging.exception(msg)
|
||||
|
||||
return {}
|
||||
|
||||
async def _get_printerprofiles(self, web_request):
|
||||
"""
|
||||
Get Printer profiles
|
||||
"""
|
||||
return {
|
||||
'profiles': {
|
||||
'_default': {
|
||||
'id': '_default',
|
||||
'name': 'Default',
|
||||
'color': 'default',
|
||||
'model': 'Default',
|
||||
'default': True,
|
||||
'current': True,
|
||||
'heatedBed': 'heater_bed' in self.heaters,
|
||||
'heatedChamber': 'chamber' in self.heaters,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
def load_plugin(config):
|
||||
return OctoprintCompat(config)
|
||||
Loading…
Reference in New Issue