Merge pull request #83 from borisbu/develop

🚀 Releasing 2.0.0

CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## Version 2
+
+### 2.0.0
+
+- **Breaking changes**
+  - Minimal Python version required: `3.7`.
+  - Minimal JavaScript version support required: `ES6` (aka ES2015).
+    - Minimal browser versions supporting ES6 are listed [here](https://caniuse.com/?search=es6).
+  - The distributed PNG icons are replaced with SVG ones.
+    - In case you've been using them in your configuration (`Icon ON/OFF`), you need to change their filenames:
+      - `3d-printer.png` –> `3d-printer.svg`,
+      - `fan-24.png` –> `fan.svg`,
+      - `webcam.png` –> `webcam.svg`.
+    - `refresh.png` icon is removed from the distribution.
+
 ## Version 1
 
 ### 1.4.2

octoprint_octorelay/__init__.py

@@ -50,8 +50,8 @@ def get_settings_defaults(self):
                 initial_value=False,
                 cmdON="",
                 cmdOFF="",
-                iconOn="""<img src="/plugin/octorelay/static/img/3d-printer.png" height="24" width="24">""",
-                iconOff="""<img src="/plugin/octorelay/static/img/3d-printer.png" height="24" width="24" style="filter: opacity(20%)">""",
+                iconOn="""<img width="24" height="24" src="/plugin/octorelay/static/img/3d-printer.svg">""",
+                iconOff="""<img width="24" height="24" src="/plugin/octorelay/static/img/3d-printer.svg" style="filter: opacity(20%)">""",
                 labelText="Printer",
                 confirmOff=True,
                 autoONforPrint=False,
@@ -65,8 +65,8 @@ def get_settings_defaults(self):
                 initial_value=False,
                 cmdON="",
                 cmdOFF="",
-                iconOn="""<img height="24" width="24" src="/plugin/octorelay/static/img/fan-24.png" >""",
-                iconOff="""<img height="24" width="24" src="/plugin/octorelay/static/img/fan-24.png" style="filter: opacity(20%)">""",
+                iconOn="""<img width="24" height="24" src="/plugin/octorelay/static/img/fan.svg" >""",
+                iconOff="""<img width="24" height="24" src="/plugin/octorelay/static/img/fan.svg" style="filter: opacity(20%)">""",
                 labelText="Fan",
                 confirmOff=False,
                 autoONforPrint=True,
@@ -80,8 +80,8 @@ def get_settings_defaults(self):
                 initial_value=True,
                 cmdON="sudo service webcamd start",
                 cmdOFF="sudo service webcamd stop",
-                iconOn="""<img height="24" width="24" src="/plugin/octorelay/static/img/webcam.png" >""",
-                iconOff="""<img height="24" width="24" src="/plugin/octorelay/static/img/webcam.png" style="filter: opacity(20%)">""",
+                iconOn="""<img width="24" height="24" src="/plugin/octorelay/static/img/webcam.svg" >""",
+                iconOff="""<img width="24" height="24" src="/plugin/octorelay/static/img/webcam.svg" style="filter: opacity(20%)">""",
                 labelText="Webcam",
                 confirmOff=False,
                 autoONforPrint=True,
@@ -415,7 +415,7 @@ def input_polling(self):
                 self.update_ui()
                 break
 
-__plugin_pythoncompat__ = ">=2.7,<4"
+__plugin_pythoncompat__ = ">=3.7,<4"
 __plugin_implementation__ = OctoRelayPlugin()
 
 __plugin_hooks__ = {

octoprint_octorelay/static/js/octorelay.js

@@ -1,57 +1,50 @@
 "use strict";
-$(function () {
-    var OctoRelayViewModel = function (_a) {
-        var settingsViewModel = _a[0], loginStateViewModel = _a[1];
-        var ownCode = "octorelay";
-        var self = this;
+$(() => {
+    const OctoRelayViewModel = function ([settingsViewModel, loginStateViewModel]) {
+        const ownCode = "octorelay";
+        const self = this;
         self.settingsViewModel = settingsViewModel;
         self.loginState = loginStateViewModel;
-        self.onDataUpdaterPluginMessage = function (plugin, data) {
+        self.onDataUpdaterPluginMessage = (plugin, data) => {
             if (plugin !== ownCode) {
                 return;
             }
-            var handleClick = function (key, value) {
-                var command = function () {
-                    return OctoPrint.simpleApiCommand(ownCode, "update", { pin: key });
-                };
+            const handleClick = (key, value) => {
+                const command = () => OctoPrint.simpleApiCommand(ownCode, "update", { pin: key });
                 if (!value.confirmOff) {
                     return command();
                 }
-                var dialog = $("#octorelay-confirmation-dialog");
+                const dialog = $("#octorelay-confirmation-dialog");
                 dialog.find(".modal-title").text("Turning " + value.labelText + " off");
                 dialog
                     .find("#octorelay-confirmation-text")
                     .text("Are you sure you want to turn the " + value.labelText + " off?");
                 dialog
                     .find(".btn-cancel")
                     .off("click")
-                    .on("click", function () { return dialog.modal("hide"); });
+                    .on("click", () => dialog.modal("hide"));
                 dialog
                     .find(".btn-confirm")
                     .off("click")
-                    .on("click", function () {
+                    .on("click", () => {
                     command();
                     dialog.modal("hide");
                 });
                 dialog.modal("show");
             };
-            var _loop_1 = function (key, value) {
-                var btn = $("#relais" + key);
+            for (const [key, value] of Object.entries(data)) {
+                const btn = $("#relais" + key);
                 if (value.active !== undefined) {
                     btn.toggle(value.active === 1);
                 }
-                var icon = $("#ralayIcon" + key);
+                const icon = $("#ralayIcon" + key);
                 if (value.iconText !== undefined) {
                     icon.html(value.iconText);
                 }
                 if (value.labelText !== undefined) {
                     icon.attr("title", value.labelText);
                 }
-                icon.off("click").on("click", function () { return handleClick(key, value); });
-            };
-            for (var _i = 0, _a = Object.entries(data); _i < _a.length; _i++) {
-                var _b = _a[_i], key = _b[0], value = _b[1];
-                _loop_1(key, value);
+                icon.off("click").on("click", () => handleClick(key, value));
             }
         };
     };

setup.py

@@ -15,7 +15,7 @@
 plugin_name = "OctoRelay"
 
 # The plugin's version. Can be overwritten within OctoPrint's internal data via __plugin_version__ in the plugin module
-plugin_version = "1.4.2"
+plugin_version = "2.0.0"
 
 # The plugin's description. Can be overwritten within OctoPrint's internal data via __plugin_description__ in the plugin
 # module

ts/tsconfig.json

@@ -1,7 +1,7 @@
 {
   "extends": "@tsconfig/node18/tsconfig.json",
   "compilerOptions": {
-    "target": "ES5",
+    "target": "ES6",
     "module": "CommonJS",
     "moduleResolution": "Node",
     "removeComments": true,