ManuelW/octoprint-customControl
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

More Work done

Browse Source
This commit is contained in:
Marc 2015-04-19 21:19:54 +02:00
parent 5e91ff77dc
commit f531220f8d
6 changed files with 469 additions and 176 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
octoprint_customControl/__init__.py
View File

@ -26,10 +26,10 @@ class CustomControlPlugin(octoprint.plugin.SettingsPlugin,
return dict(
js=[
"js/customControl.js",
"js/containerDialog.js",
"js/customControlDialog.js",
],
css=["css/customControls.css"],
less=["less/customControls.css"]
less=["less/customControls.less"]
)
# If you want your plugin to be registered within OctoPrint under a different name than what you defined in setup.py

33
octoprint_customControl/static/js/containerDialog.js
View File

@ -1,33 +0,0 @@
$(function () {
function ContainerDialogViewModel(parameters) {
var self = this;
self.element = ko.observable();
self.layouts = ko.observableArray([
{ name: gettext("Vertical"), key: "vertical" },
{ name: gettext("Horizontal"), key: "horizontal" },
{ name: gettext("Horizontal grid"), key: "horizontal_grid" }
]);
self.show = function (f) {
var dialog = $("#containerDialog");
var primarybtn = $('.btn-primary', dialog);
primarybtn.unbind('click').bind('click', f);
dialog.modal({
show: 'true',
backdrop: 'static',
keyboard: false
});
}
}
// view model class, parameters for constructor, container to bind to
OCTOPRINT_VIEWMODELS.push([
ContainerDialogViewModel,
[],
"#containerDialog"
]);
});

343
octoprint_customControl/static/js/customControl.js
View File

@ -5,7 +5,8 @@
self.loginState = parameters[0];
self.settingsViewModel = parameters[1];
self.controlViewModel = parameters[2];
self.containerDialogViewModel = parameters[3];
self.customControlDialogViewModel = parameters[3];
self.popup = undefined;
@ -14,16 +15,16 @@
self.controlsFromServer = [];
self.additionalControls = [];
self.staticID = 0;
self.staticID = 0;
self._showPopup = function (options, eventListeners) {
if (self.popup !== undefined) {
self.popup.remove();
}
self.popup = new PNotify(options);
}
self.popup = new PNotify(options);
if (eventListeners) {
var popupObj = self.popup.get();
var popupObj = self.popup.get();
_.each(eventListeners, function (value, key) {
popupObj.on(key, value);
})
@ -65,12 +66,38 @@
return controls;
};
self._processInput = function (control) {
for (var i = 0; i < control.input.length; i++) {
if (!control.processed) {
control.input[i].value = ko.observable(control.input[i].default);
control.input[i].default = ko.observable(control.input[i].default);
}
if (control.processed)
control.input[i].value(control.input[i].default());
if (!control.input[i].hasOwnProperty("slider"))
control.input[i].slider = ko.observable(false);
else if (!control.processed)
control.input[i].slider = ko.observable(control.input[i].slider);
}
}
self._processControl = function (parent, control) {
control.id = ko.observable("settingsCustomControl_id" + self.staticID++);
control.parent = parent;
if (control.hasOwnProperty("template") && control.hasOwnProperty("key") && control.hasOwnProperty("template_key") && !control.hasOwnProperty("output"))
control.output = ko.observable("");
if (control.hasOwnProperty("template") && control.hasOwnProperty("regex")) {
if (control.processed) {
control.template(control.template());
control.regex(control.regex());
}
else {
control.template = ko.observable(control.template);
control.regex = ko.observable(control.regex);
control.output = ko.computed(function () { return control.template(); });
}
}
if (control.hasOwnProperty("children")) {
if (control.processed) {
@ -87,27 +114,19 @@
control.layout = ko.observable("vertical");
else
control.layout = ko.observable(control.layout);
control.width = ko.observable(control.hasOwnProperty("width") ? control.width : "2");
control.offset = ko.observable(control.hasOwnProperty("offset") ? control.offset : "");
}
}
if (!control.processed) {
if (control.hasOwnProperty("name"))
control.name = ko.observable(control.name);
control.width = ko.observable(control.hasOwnProperty("width") ? control.width : "2");
control.offset = ko.observable(control.hasOwnProperty("offset") ? control.offset : "");
}
if (control.hasOwnProperty("input")) {
for (var i = 0; i < control.input.length; i++) {
if (!control.processed) {
control.input[i].value = ko.observable(control.input[i].default);
control.input[i].default = ko.observable(control.input[i].default);
}
if (control.processed)
control.input[i].value(control.input[i].default());
if (!control.input[i].hasOwnProperty("slider"))
control.input[i].slider = ko.observable(false);
else if (!control.processed)
control.input[i].slider = ko.observable(control.input[i].slider);
}
self._processInput(control);
}
var js;
@ -144,16 +163,16 @@
return "settingsCustomControls_controlTemplate";
}
}
self.rowCss = function (customControl) {
var span = "span2";
var offset = "";
var span = "span2";
var offset = "";
if (customControl.hasOwnProperty("width") && customControl.width() != "") {
span = "span" + customControl.width();
}
}
if (customControl.hasOwnProperty("offset") && customControl.offset() != "") {
offset = "offset" + customControl.offset();
}
}
return span + " " + offset;
};
@ -173,114 +192,179 @@
return undefined;
}
self.createElement = function (invokedOn, contextParent, selectedMenu) {
if (invokedOn.attr('id') == "base") {
self.customControlDialogViewModel.show(function (ret) {
self.controlsFromServer.push(ret);
self.rerenderControls();
});
}
else {
var parentElement = self.searchElement(self.controlsFromServer, contextParent.attr('id'));
if (parentElement == undefined) {
self._showPopup({
title: gettext("Something went wrong while creating the new Element"),
type: "error"
});
return;
}
self.customControlDialogViewModel.show(function (ret) {
parentElement.children.push(self._processControl(parentElement, ret));
});
}
}
self.deleteElement = function (invokedOn, contextParent, selectedMenu) {
var element = self.searchElement(self.controlsFromServer, contextParent.attr('id'));
if (element == undefined) {
self._showPopup({
title: gettext("Something went wrong while creating the new Element"),
type: "error"
});
return;
}
showConfirmationDialog("", function (e) {
if (element.parent != undefined)
element.parent.children.remove(element);
else {
self.controlsFromServer = _.without(self.controlsFromServer, element);
self.rerenderControls();
}
});
}
self.editElement = function (invokedOn, contextParent, selectedMenu) {
var element = self.searchElement(self.controlsFromServer, contextParent.attr('id'));
if (element == undefined) {
self._showPopup({
title: gettext("Something went wrong while creating the new Element"),
type: "error"
});
return;
}
var title = "Edit Container";
var type = "container";
var data = {
parent: element.parent,
};
if (element.hasOwnProperty("name"))
data.name = element.name();
if (element.hasOwnProperty("layout")) {
data.layout = element.layout();
title = "Edit Container";
type = "container";
}
if (element.hasOwnProperty("command")) {
data.commands = element.command;
title = "Edit Command";
type = "command";
}
if (element.hasOwnProperty("commands")) {
data.commands = element.commands;
title = "Edit Command";
type = "command";
}
if (element.hasOwnProperty("input"))
{
data.input = [];
_.each(element.input(), function (element, index, list) {
data.input[index] = ko.mapping.toJS(element);
});
}
if (element.hasOwnProperty("template")) {
data.template = element.template();
title = "Edit Output";
type = "output";
}
if (element.hasOwnProperty("regex"))
data.regex = element.regex();
if (element.hasOwnProperty("width"))
data.width = element.width();
if (element.hasOwnProperty("offset"))
data.offset = element.offset();
self.customControlDialogViewModel.reset(data);
self.customControlDialogViewModel.title(gettext(title));
self.customControlDialogViewModel.type(type);
self.customControlDialogViewModel.show(function (ret) {
switch (self.customControlDialogViewModel.type()) {
case "container": {
element.name(ret.name);
element.layout(ret.layout);
}
case "command": {
if (ret.hasOwnProperty("name"))
element.name(ret.name);
delete element.command;
delete element.commands;
delete element.input;
if (ret.command != undefined)
element.command = ret.command;
if (ret.commands != undefined)
element.commands = ret.commands;
if (ret.input != undefined) {
element.input = ret.input;
self._processInput(element);
}
break;
}
case "output": {
element.template(ret.template);
element.regex(ret.regex);
}
}
if (element.parent.layout() == "horizontal_grid") {
if (ret.width != undefined && ret.width != "")
element.width(ret.width);
if (ret.offset != undefined && ret.offset != "")
element.offset(ret.offset);
}
});
}
self.controlContextMenu = function (invokedOn, contextParent, selectedMenu)
{
switch (selectedMenu.attr('cmd')) {
case "createContainer": {
if (invokedOn.attr('id') == "base") {
self.containerDialogViewModel.element({
name: undefined,
children:[],
layout: "vertical",
width: "2",
offset: ""
});
self.customControlDialogViewModel.reset();
self.customControlDialogViewModel.title(gettext("Create container"));
self.customControlDialogViewModel.type("container");
self.containerDialogViewModel.show(function (e) {
self.controlsFromServer.push(self.containerDialogViewModel.element());
self.rerenderControls();
});
}
else {
var parentElement = self.searchElement(self.controlsFromServer, contextParent.attr('id'));
if (parentElement == undefined) {
self._showPopup({
title: gettext("Something went wrong while creating the new Element"),
type:"error"
});
return;
}
self.containerDialogViewModel.element({
parent: parentElement,
name: undefined,
children: [],
layout: "vertical",
width: "2",
offset: ""
});
self.containerDialogViewModel.show(function (e) {
parentElement.children.push(self._processControl(parentElement, self.containerDialogViewModel.element()));
});
}
self.createElement(invokedOn, contextParent, selectedMenu);
break;
}
case "editContainer": {
var element = self.searchElement(self.controlsFromServer, contextParent.attr('id'));
if (element == undefined) {
self._showPopup({
title: gettext("Something went wrong while creating the new Element"),
type: "error"
});
return;
}
case "createCommand": {
self.customControlDialogViewModel.reset();
self.customControlDialogViewModel.title(gettext("Create Command"));
self.customControlDialogViewModel.type("command");
var dialog = $('#containerDialog');
var primarybtn = $('.btn-primary', dialog);
var el = {
parent: element.parent,
name: ko.observable(element.name()),
layout: ko.observable(element.layout()),
width: ko.observable("2"),
offset: ko.observable("")
};
if (element.hasOwnProperty("width"))
el.width(element.width());
if (element.hasOwnProperty("offset"))
el.offset(element.offset());
self.containerDialogViewModel.element(el);
primarybtn.unbind('click').bind('click', function (e) {
var ele = self.containerDialogViewModel.element();
element.name(ele.name());
element.layout(ele.layout());
if (ele.parent.layout() == "horizontal_grid") {
if (ele.width() != undefined)
element.width(ele.width());
if (ele.offset() != undefined)
element.offset(ele.offset());
}
});
dialog.modal({
show: 'true',
backdrop: 'static',
keyboard: false
});
self.createElement(invokedOn, contextParent, selectedMenu);
break;
}
case "deleteContainer": {
var element = self.searchElement(self.controlsFromServer, contextParent.attr('id'));
if (element == undefined) {
self._showPopup({
title: gettext("Something went wrong while creating the new Element"),
type: "error"
});
return;
}
case "createOutput": {
self.customControlDialogViewModel.reset();
self.customControlDialogViewModel.title(gettext("Create Output"));
self.customControlDialogViewModel.type("output");
showConfirmationDialog("", function (e) {
if (element.parent != undefined)
element.parent.children.remove(element);
else {
self.controlsFromServer = _.without(self.controlsFromServer, element);
self.rerenderControls();
}
});
self.createElement(invokedOn, contextParent, selectedMenu);
break;
}
case "deleteElement": {
self.deleteElement(invokedOn, contextParent, selectedMenu);
break;
}
case "editElement": {
self.editElement(invokedOn, contextParent, selectedMenu);
break;
}
}
}
@ -299,6 +383,7 @@
delete list[i].id;
delete list[i].parent;
delete list[i].processed;
delete list[i].output;
if (list[i].hasOwnProperty("children"))
self.recursiveDeleteProperties(list[i].children());
@ -317,7 +402,7 @@
// view model class, parameters for constructor, container to bind to
OCTOPRINT_VIEWMODELS.push([
CustomControlViewModel,
["loginStateViewModel", "settingsViewModel", "controlViewModel", "containerDialogViewModel"],
["loginStateViewModel", "settingsViewModel", "controlViewModel", "customControlDialogViewModel"],
"#settings_plugin_octoprint_customControl"
]);
});

169
octoprint_customControl/static/js/customControlDialog.js Normal file
View File

@ -0,0 +1,169 @@
$(function () {
function customControlDialogViewModel(parameters) {
var self = this;
self.element = ko.observable(ko.mapping.fromJS({
name: undefined,
commands: "",
script: "",
javascript: "",
enabled: "",
children: [],
input: [],
layout: "vertical",
regex: "",
template: "",
confirm: "",
width: "2",
offset: "",
parent: undefined
}));
self.title = ko.observable(gettext("Create Container"));
self.type = ko.observable("container");
self.useInputs = ko.observable(false);
self.useJavaScript = ko.observable(false);
self.useEnabled = ko.observable(false);
self.layouts = ko.observableArray([
{ name: gettext("Vertical"), key: "vertical" },
{ name: gettext("Horizontal"), key: "horizontal" },
{ name: gettext("Horizontal grid"), key: "horizontal_grid" }
]);
self.types = ko.observableArray([
{ name: gettext("Container"), key: "container" },
{ name: gettext("Command"), key: "command" },
{ name: gettext("Output"), key: "output" }
]);
self.hasSlider = ko.computed(function () {
if (self.element() == undefined || self.element().input == undefined)
return false;
_.each(self.element().input(), function (element, index, list) {
if (element.hasOwnProperty("slider"))
return true;
});
return false;
});
self.span = function(parameter) {
return ko.computed(function () {
if (self.hasSlider())
return "span2";
switch (parameter) {
case "name":
case "parameter":
return "span4";
case "default":
return "span3";
}
return "span2";
});
}
self.reset = function (data) {
var element = {
name: undefined,
commands: "",
script: "",
javascript: "",
enabled: "",
input: [],
layout: "vertical",
regex: "",
template: "",
confirm: "",
width: "2",
offset: "",
parent: undefined
};
if (typeof data == "object")
element = _.extend(element, data);
self.element(ko.mapping.fromJS(element));
}
self.show = function (f) {
var dialog = $("#customControlDialog");
var primarybtn = $('.btn-primary', dialog);
primarybtn.unbind('click').bind('click', function (e) {
var obj = ko.mapping.toJS(self.element());
var el = {};
switch (self.type()) {
case "container": {
el.name = obj.name;
el.layout = obj.layout;
el.children = [];
el.width = obj.width;
el.offset = obj.offset;
break;
}
case "command": {
el.name = obj.name;
if (obj.commands.indexOf('\n') == -1)
el.command = obj.commands;
else
el.commands = obj.commands;
el.width = obj.width;
el.offset = obj.offset;
if (self.useInputs()) {
el.input = [];
_.each(obj.input, function (element, index, list) {
var input = {
name: element.name,
parameter: element.parameter,
default: element.default
};
if (element.hasOwnProperty("slider")) {
input["slider"] = {
};
if (element.slider.hasOwnProperty("min") && element.slider.min != "")
input.slider.min = element.slider.min;
if (element.slider.hasOwnProperty("max") && element.slider.max != "")
input.slider.max = element.slider.max;
if (element.slider.hasOwnProperty("step") && element.slider.step != "")
input.slider.step = element.slider.step;
}
});
}
break;
}
case "output": {
el.template = obj.template;
el.regex = obj.regex;
el.width = obj.width;
el.offset = obj.offset;
break;
}
}
f(el);
});
dialog.modal({
show: 'true',
backdrop: 'static',
keyboard: false
});
}
}
// view model class, parameters for constructor, container to bind to
OCTOPRINT_VIEWMODELS.push([
customControlDialogViewModel,
[],
"#customControlDialog"
]);
});

77
octoprint_customControl/templates/octoprint_customControl.jinja2
View File

@ -1,21 +1,92 @@
<div id="containerDialog" class="modal hide">
<div id="customControlDialog" class="modal hide">
<div class="modal-header">
<h3>{{ _('Container Dialog') }}</h3>
<h3 data-bind="text: title"></h3>
</div>
<div class="modal-body">
<form class="form-horizontal" data-bind="with: element">
<!-- ko if: $root.type() == "command" || $root.type() == "container" -->
<div class="control-group">
<label class="control-label">{{ _('Name') }}</label>
<div class="controls">
<input data-bind="value: name, valueAllowUnset: true"></input>
</div>
</div>
<!-- /ko -->
<!-- ko if: $root.type() == "container" -->
<div class="control-group">
<label class="control-label">{{ _('Layout') }}</label>
<div class="controls">
<select data-bind="options: $parent.layouts, optionsText: 'name', optionsValue: 'key', value: layout, valueAllowUnset: false"></select>
<select data-bind="options: $root.layouts, optionsText: 'name', optionsValue: 'key', value: layout, valueAllowUnset: false"></select>
</div>
</div>
<!-- /ko -->
<!--<div class="control-group">
<label class="control-label">{{ _('Type') }}</label>
<div class="controls">
<select data-bind="options: $root.types, optionsText: 'name', optionsValue: 'key', value: $root.type, valueAllowUnset: false"></select>
</div>
</div>-->
<!-- ko if: $root.type() == "command" -->
<div class="control-group">
<label class="control-label">{{ _('Commands') }}</label>
<div class="controls">
<textarea style="width: 97%; height: auto" data-bind="value: commands"></textarea>
</div>
</div>
<div class="control-group">
<label class="control-label"><input type="checkbox" data-bind="checked: $root.useInputs"></input>{{ _('Use Inputs') }}</label>
</div>
<!-- ko if: $root.useInputs -->
<div class="control-group">
<label class="control-label">{{ _('Inputs') }}</label>
<div class="row-fluid">
<div class="span12">
<div data-bind="css: $root.span('name')">{{ _('Name') }}</div>
<div data-bind="css: $root.span('parameter')">{{ _('Parameter') }}</div>
<div data-bind="css: $root.span('default')">{{ _('Default') }}</div>
<!-- ko if: $root.hasSlider -->
<div class="span2">{{ _('Min') }}</div>
<div class="span2">{{ _('Max') }}</div>
<div class="span2">{{ _('Step') }}</div>
<!-- /ko -->
</div>
</div>
<div data-bind="foreach: input">
<div class="row-fluid" style="margin-bottom: 5px">
<div data-bind="css: $root.span('name')"><input class="span12" data-bind="value: name"></input></div>
<div data-bind="css: $root.span('parameter')"><input class="span12" data-bind="value: parameter"></input></div>
<div data-bind="css: $root.span('default')"><input class="span12" data-bind="value: defaultValue"></input></div>
<!-- ko if: $root.hasSlider -->
<div class="span2"><input class="span12" data-bind="value: slide().min"></input></div>
<div class="span2"><input class="span12" data-bind="value: slide().max"></input></div>
<div class="span1"><input class="span12" data-bind="value: slide().step"></input></div>
<!-- /ko -->
<div class="span1"><a title="Remove Input" class="btn btn-danger" data-bind="click: $root.removeInput($data)"><i class="icon-trash"></i></a></div>
</div>
</div>
<div class="row-fluid">
<div class="offset11 span1"><a title="Add Input" class="btn btn-primary" data-bind="click: $root.addInput"><i class="icon-plus"></i></a></div>
</div>
</div>
<!-- /ko -->
<!-- /ko -->
<!-- ko if: $root.type() == "output" -->
<div class="control-group">
<label class="control-label">{{ _('Regex') }}</label>
<div class="controls">
<input data-bind="value: regex"></input>
</div>
</div>
<div class="control-group">
<label class="control-label">{{ _('Template') }}</label>
<div class="controls">
<textarea style="width: 97%; height: auto" data-bind="value: template"></textarea>
</div>
</div>
<!-- /ko -->
<!-- ko if: $data.parent && $data.parent.layout && $data.parent.layout() == 'horizontal_grid' -->
<div class="control-group">
<label class="control-label">{{ _('Width') }}</label>

19
octoprint_customControl/templates/octoprint_customControl_settings.jinja2
View File

@ -7,12 +7,12 @@
<ul id="controlContextMenu" class="dropdown-menu" role="menu" style="display:block;position:fixed !important;margin-bottom:5px;">
<li>
<a href="#" cmd="createContainer">Create Container</a>
<a href="#" cmd="createContainer">{{ _('Create Container') }}</a>
</li>
</ul>
<ul id="commandContextMenu" class="dropdown-menu" role="menu" style="display:block;position:fixed !important;margin-bottom:5px;">
<li><a href="#" cmd="editCommand">Edit Command</a></li>
<li><a href="#" cmd="deleteCommand">Delete Command</a></li>
<li><a href="#" cmd="editElement">{{ _('Edit') }}</a></li>
<li><a href="#" cmd="deleteElement">{{ _('Delete') }}</a></li>
<li class="divider"></li>
<li class="dropdown-submenu">
<a href="#">Style</a>
@ -33,13 +33,14 @@
<li class="dropdown-submenu">
<a href="#">Create Command</a>
<ul class="dropdown-menu">
<li><a href="#" cmd="createContainer">Create Container</a></li>
<li><a href="#" cmd="createCommand">Command</a></li>
<li><a href="#" cmd="createContainer">{{ _('Container') }}</a></li>
<li><a href="#" cmd="createCommand">{{ _('Command') }}</a></li>
<li><a href="#" cmd="createOutput">{{ _('Output') }}</a></li>
</ul>
</li>
<li class="divider"></li>
<li><a href="#" cmd="editContainer">Edit Container</a></li>
<li><a href="#" cmd="deleteContainer">Delete Container</a></li>
<li><a href="#" cmd="editElement">{{ _('Edit') }}</a></li>
<li><a href="#" cmd="deleteElement">{{ _('Delete') }}</a></li>
</ul>
<!-- Templates for custom controls -->
@ -67,7 +68,7 @@
</div>
</script>
<script type="text/html" id="settingsCustomControls_controlTemplate">
<form class="form-inline control-tab custom_control" style="min-height:15px; border:1px solid #000000" data-bind="contextMenu: { menuSelector: '#commandContextMenu', menuSelected: $root.controlContextMenu }, attr: { 'id': id }">
<form class="form-inline control-tab custom_control" style="min-height:15px; border:1px dotted #000000" data-bind="contextMenu: { menuSelector: '#commandContextMenu', menuSelected: $root.controlContextMenu }, attr: { 'id': id }">
<!-- ko template: { name: 'customControls_controlTemplate_input', data: $data, if: $data.hasOwnProperty('input') } --><!-- /ko -->
<!-- ko template: { name: 'customControls_controlTemplate_command', data: $data, if: $data.hasOwnProperty('command') || $data.hasOwnProperty('commands') || $data.hasOwnProperty('script') || $data.hasOwnProperty('javascript') } --><!-- /ko -->
<!-- ko template: { name: 'customControls_controlTemplate_output', data: $data, if: $data.hasOwnProperty('output') } --><!-- /ko -->
@ -88,6 +89,6 @@
<label data-bind="text: output"></label>
</script>
<script type="text/html" id="customControls_controlTemplate_command">
<button class="btn" data-bind="text: name, enable: $root.isCustomEnabled($data), click: function() { $root.clickCustom($data) }"></button>
<button class="btn" data-bind="text: name }"></button>
</script>
<!-- End of templates for custom controls -->