3diy
/
OctoprintKlipperPlugin
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Shortcut to printer.cfg with granulary access (#29) 

* Shortcut to printer.cfg with granulary access

* added button to sidebar

* restyle
This commit is contained in:
thelastWallE 2021-03-11 19:42:05 +01:00
parent d6cbf8d867
commit 1b1014f58c
5 changed files with 118 additions and 74 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
octoprint_klipper/__init__.py
View File

@ -21,8 +21,10 @@ import glob
import os import os
import sys import sys
from octoprint.util.comm import parse_firmware_line from octoprint.util.comm import parse_firmware_line
from octoprint.access.permissions import Permissions, ADMIN_GROUP, USER_GROUP
from .modules import KlipperLogAnalyzer from .modules import KlipperLogAnalyzer
import flask import flask
from flask_babel import gettext
class KlipperPlugin( class KlipperPlugin(
octoprint.plugin.StartupPlugin, octoprint.plugin.StartupPlugin,
@ -49,6 +51,17 @@ class KlipperPlugin(
#-- Settings Plugin #-- Settings Plugin
def get_additional_permissions(self, *args, **kwargs):
return [
dict(key="CONFIG",
name="Config Klipper",
description=gettext("Allows to config klipper"),
default_groups=[ADMIN_GROUP],
dangerous=True,
roles=["admin"]
)
]
def get_settings_defaults(self): def get_settings_defaults(self):
return dict( return dict(
connection = dict( connection = dict(
@ -358,6 +371,7 @@ def __plugin_load__():
global __plugin_hooks__ global __plugin_hooks__
__plugin_implementation__ = KlipperPlugin() __plugin_implementation__ = KlipperPlugin()
__plugin_hooks__ = { __plugin_hooks__ = {
"octoprint.access.permissions": __plugin_implementation__.get_additional_permissions,
"octoprint.comm.protocol.gcode.received": __plugin_implementation__.on_parse_gcode, "octoprint.comm.protocol.gcode.received": __plugin_implementation__.on_parse_gcode,
"octoprint.plugin.softwareupdate.check_config": __plugin_implementation__.get_update_information "octoprint.plugin.softwareupdate.check_config": __plugin_implementation__.get_update_information
} }

23
octoprint_klipper/static/js/klipper.js
View File

@ -22,6 +22,7 @@ $(function() {
self.connectionState = parameters[2]; self.connectionState = parameters[2];
self.levelingViewModel = parameters[3]; self.levelingViewModel = parameters[3];
self.paramMacroViewModel = parameters[4]; self.paramMacroViewModel = parameters[4];
self.access = parameters[5];
self.shortStatus = ko.observable(); self.shortStatus = ko.observable();
self.logMessages = ko.observableArray(); self.logMessages = ko.observableArray();
@ -127,6 +128,25 @@ $(function() {
self.isActive = function() { self.isActive = function() {
return self.connectionState.isOperational() && self.loginState.isUser(); return self.connectionState.isOperational() && self.loginState.isUser();
} }
// OctoKlipper settings link
self.openOctoKlipperSettings = function(profile_type) {
if (
!self.loginState.hasPermission(
self.access.permissions.PLUGIN_KLIPPER_CONFIG
)
)
return;
$('a#navbar_show_settings').click();
$('li#settings_plugin_klipper_link a').click();
if(profile_type)
{
var query= "#klipper-settings a[data-profile-type='"+profile_type+"']";
$(query).click();
}
};
} }
OCTOPRINT_VIEWMODELS.push({ OCTOPRINT_VIEWMODELS.push({
@ -136,7 +156,8 @@ $(function() {
"loginStateViewModel", "loginStateViewModel",
"connectionViewModel", "connectionViewModel",
"klipperLevelingViewModel", "klipperLevelingViewModel",
"klipperMacroDialogViewModel" "klipperMacroDialogViewModel",
"accessViewModel"
], ],
elements: ["#tab_plugin_klipper_main", "#sidebar_plugin_klipper", "#navbar_plugin_klipper"] elements: ["#tab_plugin_klipper_main", "#sidebar_plugin_klipper", "#navbar_plugin_klipper"]
}); });

8
octoprint_klipper/templates/klipper_settings.jinja2
View File

@ -1,9 +1,9 @@
<form class="form-horizontal"> <form class="form-horizontal">
<ul class="nav nav-pills" id="klipper-settings"> <ul class="nav nav-pills" id="klipper-settings">
<li><a href="#basic" data-toggle="tab">Basic</a></li> <li><a href="#basic" data-toggle="tab" data-profile-type="klipper-basic">Basic</a></li>
<li><a href="#macros" data-toggle="tab">Macros</a></li> <li><a href="#macros" data-toggle="tab" data-profile-type="klipper-macros">Macros</a></li>
<li><a href="#level" data-toggle="tab">Bed Leveling</a></li> <li><a href="#level" data-toggle="tab" data-profile-type="klipper-bed">Bed Leveling</a></li>
<li><a href="#conf" data-toggle="tab">Klipper Configuration</a></li> <li><a href="#conf" data-toggle="tab" data-profile-type="klipper-config">Klipper Configuration</a></li>
</ul> </ul>
<div class="tab-content"> <div class="tab-content">
<!-- Basics --> <!-- Basics -->

5
octoprint_klipper/templates/klipper_sidebar.jinja2
View File

@ -5,6 +5,11 @@
<button class="btn btn-block" data-bind="click: connectionState.connect, text: connectionState.buttonText(), enable: loginState.isUser()">{{ _('Connect') }}</button> <button class="btn btn-block" data-bind="click: connectionState.connect, text: connectionState.buttonText(), enable: loginState.isUser()">{{ _('Connect') }}</button>
</div> </div>
</div> </div>
<div class="control-group">
<div class="controls">
<button class="btn btn-block" data-bind="visible: loginState.hasPermissionKo(access.permissions.PLUGIN_KLIPPER_CONFIG), click: function() {openOctoKlipperSettings('klipper-config');}">{{ _('Open Klipper config') }}</button>
</div>
</div>
<div class="control-group"> <div class="control-group">
<div class="controls"> <div class="controls">
<label class="control-label small"><i class="icon-list-alt"></i> {{ _('Macros') }}</label> <label class="control-label small"><i class="icon-list-alt"></i> {{ _('Macros') }}</label>

142
octoprint_klipper/templates/klipper_tab_main.jinja2
View File

@ -1,72 +1,76 @@
<div class="row-fluid"> <div class="row-fluid">
<div class="span8"> <div class="span8">
<label><i class="icon-tasks"></i> {{ _('Messages') }}</label> <label>
<div class="plugin-klipper-log" data-bind="foreach: logMessages"> <i class="icon-tasks"></i> {{ _('Messages') }}
<div class="log-item" data-bind="css: type"> </label>
<div data-bind="text: time" class="ts" ></div> <div class="plugin-klipper-log" data-bind="foreach: logMessages">
<div data-bind="html: msg" class="msg"></div> <div class="log-item" data-bind="css: type">
</div> <div data-bind="text: time" class="ts"></div>
</div> <div data-bind="html: msg" class="msg"></div>
&nbsp;
<button class="btn btn-mini pull-right clear-btn" data-bind="click: onClearLog, enable: isActive()"
title="Clear Log">
<i class="fa fa-trash"></i>{{ _('Clear') }}
</button>
</div>
<div class="span4">
<div class="control-group">
<div class="control-group">
<div class="controls">
<label class="control-label"></label>
<button class="btn btn-block btn-small" data-bind="click: onGetStatus, enable: isActive()"
title="Query Klipper for its current status">
<i class="fa icon-black fa-info-circle"></i> {{ _('Get Status') }}
</button>
</div>
</div>
<div class="control-group">
<div class="controls">
<label class="control-label small"><i class="icon-refresh"></i> {{ _('Restart') }}</label>
<button class="btn btn-block btn-small" data-bind="click: onRestartHost, enable: isActive()"
title="This will cause the host software to reload its config and perform an internal reset">
{{ _('Host') }}
</button>
<button class="btn btn-block btn-small" data-bind="click: onRestartFirmware, enable: isActive()"
title="Similar to a host restart, but also clears any error state from the micro-controller">
{{ _('Firmware') }}
</button>
</div>
</div>
<div class="control-group">
<div class="controls">
<label class="control-label"><i class="icon-wrench"></i> {{ _('Tools') }}</label>
<button class="btn btn-block btn-small" data-bind="click: showLevelingDialog, enable: isActive()"
title="Assists in manually leveling your printbed by moving the head to a configurable set of positions in sequence.">
{{ _('Assisted Bed Leveling') }}
</button>
<button class="btn btn-block btn-small" data-bind="click: showPidTuningDialog, enable: isActive()"
title="Determines optimal PID parameters by heat cycling the hotend/bed.">
{{ _('PID Tuning') }}
</button>
<button class="btn btn-block btn-small" data-bind="click: showOffsetDialog, enable: isActive()"
title="Sets a offset for subsequent GCODE coordinates.">
{{ _('Coordinate Offset') }}
</button>
<button class="btn btn-block btn-small" data-bind="click: showGraphDialog, enable: isActive()"
title="Assists in debugging performance issues by analyzing the Klipper log files.">
{{ _('Performance Graph') }}
</button>
</div>
</div>
<div class="controls">
<label class="control-label"><i class="icon-list-alt"></i> {{ _('Macros') }}</label>
<div data-bind="foreach: settings.settings.plugins.klipper.macros">
<!-- ko if: tab -->
<button class="btn btn-block btn-small" data-bind="text: name, click: $parent.executeMacro, enable: $parent.isActive()">
</button>
<!-- /ko -->
</div> </div>
</div> </div>
</div> &nbsp;
</div> <button class="btn btn-mini pull-right clear-btn" data-bind="click: onClearLog, enable: isActive()"
title="Clear Log">
<i class="fa fa-trash"></i> {{ _('Clear') }}
</button>
</div>
<div class="span4">
<div class="control-group">
<div class="control-group">
<div class="controls">
<label class="control-label"></label>
<button class="btn btn-block btn-small" data-bind="click: onGetStatus, enable: isActive()" title="Query Klipper for its current status">
<i class="fa icon-black fa-info-circle"></i> {{ _('Get Status') }}
</button>
<button class="btn btn-block btn-small" data-bind="visible: loginState.hasPermissionKo(access.permissions.PLUGIN_KLIPPER_CONFIG), click: function() {openOctoKlipperSettings('klipper-config');}" title="Open the Klipper configurationfile">
<i class="fa icon-black fa-file-code-o"></i> {{ _('Open Klipper config') }}
</button>
</div>
</div>
<div class="control-group">
<div class="controls">
<label class="control-label small"><i class="icon-refresh"></i> {{ _('Restart') }}</label>
<button class="btn btn-block btn-small" data-bind="click: onRestartHost, enable: isActive()"
title="This will cause the host software to reload its config and perform an internal reset">
{{ _('Host') }}
</button>
<button class="btn btn-block btn-small" data-bind="click: onRestartFirmware, enable: isActive()"
title="Similar to a host restart, but also clears any error state from the micro-controller">
{{ _('Firmware') }}
</button>
</div>
</div>
<div class="control-group">
<div class="controls">
<label class="control-label"><i class="icon-wrench"></i> {{ _('Tools') }}</label>
<button class="btn btn-block btn-small" data-bind="click: showLevelingDialog, enable: isActive()"
title="Assists in manually leveling your printbed by moving the head to a configurable set of positions in sequence.">
{{ _('Assisted Bed Leveling') }}
</button>
<button class="btn btn-block btn-small" data-bind="click: showPidTuningDialog, enable: isActive()"
title="Determines optimal PID parameters by heat cycling the hotend/bed.">
{{ _('PID Tuning') }}
</button>
<button class="btn btn-block btn-small" data-bind="click: showOffsetDialog, enable: isActive()"
title="Sets a offset for subsequent GCODE coordinates.">
{{ _('Coordinate Offset') }}
</button>
<button class="btn btn-block btn-small" data-bind="click: showGraphDialog, enable: isActive()"
title="Assists in debugging performance issues by analyzing the Klipper log files.">
{{ _('Performance Graph') }}
</button>
</div>
</div>
<div class="controls">
<label class="control-label"><i class="icon-list-alt"></i> {{ _('Macros') }}</label>
<div data-bind="foreach: settings.settings.plugins.klipper.macros">
<!-- ko if: tab -->
<button class="btn btn-block btn-small" data-bind="text: name, click: $parent.executeMacro, enable: $parent.isActive()">
</button>
<!-- /ko -->
</div>
</div>
</div>
</div>
</div> </div>