#16 Codereview Octoprint Plugin Repo

- Beschreibungen angepasst

README.md

@@ -2,4 +2,31 @@
 
 This OctoPrint plugin enables the system to control the myStrom switch and read the current Powerconsumption of your system
 
+Settings Tab
 
+![settings](settings_page.png)
+
+Mainscreen
+You can see the Plugin on the bottom right
+
+![Mainscreen](fullscreen.png)
+
+Switch is off
+
+![Switch off](sidebar_off.png)
+
+Switch is on
+
+![Switch on](sidebar_on.png)
+
+With toggle Button enabled
+
+![toggle on](sidebar_on_button.png)
+![toggle off](sidebar_off_button.png)
+
+## Setup
+
+Install via the bundled [Plugin Manager](https://github.com/foosel/OctoPrint/wiki/Plugin:-Plugin-Manager)
+or manually using this URL:
+
+    https://github.com/da4id/OctoPrint-MyStromSwitch/archive/master.zip

octoprint_mystromswitch/__init__.py

@@ -2,6 +2,7 @@
 from __future__ import absolute_import
 
 import ssl
+import time
 
 import octoprint.plugin
 import requests
@@ -12,13 +13,22 @@ class MyStromSwitchPlugin(octoprint.plugin.SettingsPlugin,
                           octoprint.plugin.AssetPlugin,
                           octoprint.plugin.TemplatePlugin,
                           octoprint.plugin.StartupPlugin,
+                          octoprint.plugin.SimpleApiPlugin,
                           octoprint.plugin.ShutdownPlugin):
 
     def __init__(self):
         self.ip = None
         self.intervall = 1
+        self.onOffButtonEnabled = False
+        self.powerOnOnStart = False
+        self.powerOffOnShutdown = False
+        self.powerOffDelay = 0
+
         self._timer = None
 
+        self.energy = 0
+        self.lastTimeStamp = 0
+
         self.ctx = ssl.create_default_context()
         self.ctx.check_hostname = False
         self.ctx.verify_mode = ssl.CERT_NONE
@@ -29,6 +39,19 @@ class MyStromSwitchPlugin(octoprint.plugin.SettingsPlugin,
 
         self.intervall = self._settings.get_int(["intervall"])
         self._logger.debug("intervall: %s" % self.intervall)
+
+        self.onOffButtonEnabled = self._settings.get_boolean(["onOffButtonEnabled"])
+        self._logger.debug("onOffButtonEnabled: %s" % self.onOffButtonEnabled)
+
+        self.powerOnOnStart = self._settings.get_boolean(["powerOnOnStart"])
+        self._logger.debug("powerOnOnStart: %s" % self.powerOnOnStart)
+
+        self.powerOffOnShutdown = self._settings.get_boolean(["powerOffOnShutdown"])
+        self._logger.debug("powerOffOnShutdown: %s" % self.powerOffOnShutdown)
+
+        self.powerOffDelay = self._settings.get_int(["powerOffDelay"])
+        self._logger.debug("powerOffDelay: %s" % self.powerOffDelay)
+
         self._timer_start()
 
     def get_assets(self):
@@ -56,31 +79,134 @@ class MyStromSwitchPlugin(octoprint.plugin.SettingsPlugin,
             try:
                 request = requests.get(
                     'http://{}/report'.format(self.ip), timeout=1)
-                self._plugin_manager.send_plugin_message(self._identifier,
+                if request.status_code == 200:
-                                                         request.json())
+                    timestamp = time.time()
+                    data = request.json()
+                    if not self.lastTimeStamp == 0:
+                        intervall = timestamp - self.lastTimeStamp
+                        # Energy in Wh
+                        self.energy = self.energy + (intervall * data["power"] / 3600)
+                    self.lastTimeStamp = timestamp
+                    data["energy"] = self.energy
+                    data["onOffButtonEnabled"] = self.onOffButtonEnabled
+                    self._plugin_manager.send_plugin_message(self._identifier, data)
             except (requests.exceptions.ConnectionError, ValueError):
                 self._logger.info('Connection Error Host: {}'.format(self.ip))
         else:
             self._logger.info("Ip is None")
 
+    def _setRelaisState(self, newState):
+        nbRetry = 0
+        value = '0'
+        if (newState == True):
+            value = '1'
+        while nbRetry < 3:
+            try:
+                request = requests.get(
+                    'http://{}/relay'.format(self.ip), params={'state': value}, timeout=1)
+                if request.status_code == 200:
+                    return
+                else:
+                    self._logger.info(
+                        "Could not set new Relais State, Http Status Code: {}".format(request.status_code))
+            except requests.exceptions.ConnectionError:
+                self._logger.info("Error during set Relais state")
+            nbRetry = nbRetry + 1
+
+    # Sets the switch to a specific inverse newState,
+    # waits for a specified amount of time (max 3h),
+    # then sets the the switch to the newState.
+    def _powerCycleRelais(self, newState, time):
+        nbRetry = 0
+        value = 'on'
+        if newState:
+            value = 'off'
+        while nbRetry < 3:
+            try:
+                request = requests.post(
+                    'http://{}/timer'.format(self.ip), params={'mode': value, 'time': time}, timeout=1)
+                if request.status_code == 200:
+                    return
+                else:
+                    self._logger.info("Could not powerCycle Relais, Http Status Code: {}".format(request.status_code))
+            except requests.exceptions.ConnectionError:
+                self._logger.info("Error during powerCycle Relais")
+            nbRetry = nbRetry + 1
+
+    def _toggleRelay(self):
+        nbRetry = 0
+        while nbRetry < 3:
+            try:
+                request = requests.get(
+                    'http://{}/toggle'.format(self.ip), timeout=1)
+                if request.status_code == 200:
+                    return
+                else:
+                    self._logger.info("Could not toggle Relay State, Http Status Code: {}".format(request.status_code))
+            except requests.exceptions.ConnectionError:
+                self._logger.info("Error during toggle Relais state")
+            nbRetry = nbRetry + 1
+
+    def on_api_command(self, command, data):
+        if command == "enableRelais":
+            self._logger.info("enableRelais")
+            self._setRelaisState(True)
+        elif command == "disableRelais":
+            self._logger.info("disableRelais")
+            self._setRelaisState(False)
+        elif command == "toggleRelais":
+            self._logger.info("toggleRelais")
+            self._toggleRelay()
+
+    def get_api_commands(self):
+        return dict(
+            enableRelais=[],
+            disableRelais=[],
+            toggleRelais=[]
+        )
+
     def on_after_startup(self):
-        pass
+        if self.powerOnOnStart:
+            self._logger.info("Turn on Relais on Start")
+            self._setRelaisState(True)
 
     def on_shutdown(self):
-        pass
+        if self.powerOffOnShutdown:
+            if self.powerOffDelay <= 0:
+                self._logger.info("Turn on Relais off Shutdown")
+                self._setRelaisState(False)
+            else:
+                self._logger.info("Turn off Relais on Shutdown Delayed")
+                self._powerCycleRelais(False, self.powerOffDelay)
 
     def on_settings_migrate(self, target, current):
+        if target > current:
+            if current <= 1:
+                self.onOffButtonEnabled = False
                 pass
+            if current <= 2:
+                self.powerOnOnStart = False,
+                self.powerOffOnShutdown = False,
+                self.powerOffDelay = 0
 
     def get_settings_version(self):
-        return 1
+        return 3
 
     def get_settings_defaults(self):
         return dict(
             ip=None,
-            intervall=1
+            intervall=1,
+            onOffButtonEnabled=False,
+            powerOnOnStart=False,
+            powerOffOnShutdown=False,
+            powerOffDelay=0
         )
 
+    def get_settings_restricted_paths(self):
+        return dict(admin=[
+            ['ip']
+        ])
+
     def on_settings_save(self, data):
         self._logger.info("on_settings_save")
         octoprint.plugin.SettingsPlugin.on_settings_save(self, data)

octoprint_mystromswitch/static/js/mystromswitch.js

@@ -6,44 +6,38 @@ $(function() {
         self.settings = parameters[1];
         self.printer = parameters[2];
 
-        self.mystromswitchEnabled = ko.observable();
+        self.onOffButtonEnabled = ko.observable();
         self.mystromswitchPowerValue = document.getElementById("mystromswitchPowerValue")
+        self.mystromswitchEnergyValue = document.getElementById("mystromswitchEnergyValue")
+
+        self.onToggleRelayEvent = function(){
+            $.ajax({
+                url: API_BASEURL + "plugin/mystromswitch",
+                type: "POST",
+                dataType: "json",
+                data: JSON.stringify({
+                    command: "toggleRelais",
+                }),
+                contentType: "application/json; charset=UTF-8"
+            })
+        }
 
         self.onmystromswitchEvent = function() {
-            if (self.mystromswitchEnabled()) {
+
-                $.ajax({
-                    url: API_BASEURL + "plugin/mystromswitch",
-                    type: "POST",
-                    dataType: "json",
-                    data: JSON.stringify({
-                        command: "enable",
-						eventView : false
-                    }),
-                    contentType: "application/json; charset=UTF-8"
-                })
-            } else {
-                $.ajax({
-                    url: API_BASEURL + "plugin/mystromswitch",
-                    type: "POST",
-                    dataType: "json",
-                    data: JSON.stringify({
-                        command: "disable",
-						eventView : false
-                    }),
-                    contentType: "application/json; charset=UTF-8"
-                })
-            }
         }
 
-        self.mystromswitchEnabled.subscribe(self.onmystromswitchEvent, self);
+        self.onOffButtonEnabled.subscribe(self.onmystromswitchEvent, self);
 
         self.onDataUpdaterPluginMessage = function(plugin, data) {
             if (plugin != "mystromswitch" && plugin != "octoprint_mystromswitch") {
                 return;
             }
-			self.mystromswitchEnabled(data.mystromswitchEnabled);
+			self.onOffButtonEnabled(data.onOffButtonEnabled);
-                if (data.power != null) {
+			self.mystromswitchEnergyValue.innerHTML = "Energy: "+data.energy.toFixed(1)+"Wh"
-                    self.mystromswitchPowerValue.innerHTML = "Power Consumption "+data.power.toFixed(2)+"W"
+			if(data.relay == false){
+			    self.mystromswitchPowerValue.innerHTML = "Relay is off";
+			} else if (data.power != null) {
+                self.mystromswitchPowerValue.innerHTML = "Power Consumption "+data.power.toFixed(1)+"W";
             }
         }
     }

octoprint_mystromswitch/templates/mystromswitch_settings.jinja2

@@ -1,8 +1,7 @@
 <form class="form-horizontal">
 	<h4>General</h4>
-	<hr>
 	<div class="control-group">
-        <label class="control-label">{{ _('IP-Address') }}</label>
+        <label class="control-label">{{ _('URL or IP-Address of your switch') }}</label>
         <div class="controls">
             <input type="text" class="input-block-level" data-bind="value: settings.plugins.mystromswitch.ip">
         </div>
@@ -13,8 +12,53 @@
         <div class="controls">
             <div class="input-append">
                 <input type="number" class="input-mini text-right" data-bind="value: settings.plugins.mystromswitch.intervall">
-                <span class="add-on">sec</span>
+                <span class="add-on">seconds</span>
             </div>
+            <span class="help-block"><small>{{ _('Intervall in seconds where relays state, power and energy consumption are refreshed') }}</small></span>
+        </div>
+    </div>
+
+    <hr>
+    <h4>Octoprint Hardware (Raspberry Pi) is not switched on/off by the relais</h4>
+
+    <div class="control-group">
+	    <div class="controls">
+			<label class="checkbox">
+		    	<input type="checkbox" data-bind="checked: settings.plugins.mystromswitch.onOffButtonEnabled">Toggle Button Enabled
+			</label>
+			<span class="help-block"><small>{{ _('Shows an on/off Button on the left side to switch the relays on or off. This setting is only recommended if only your printer is switched on/off') }}</small></span>
+		</div>
+	</div>
+
+	<div class="control-group">
+	    <div class="controls">
+			<label class="checkbox">
+		    	<input type="checkbox" data-bind="checked: settings.plugins.mystromswitch.powerOnOnStart">Turn relais ON on Octoprint start
+			</label>
+		    <span class="help-block"><small>{{ _('This setting switches your mySwitch on if Octoprint is starting up. Turn relays OFF on Octoprint shutdown could also be interesting for you') }}</small></span>
+		</div>
+	</div>
+
+    <hr>
+    <h4>Octoprint Hardware (Raspberry Pi) is switched on/off by the relais</h4>
+
+	<div class="control-group">
+	    <div class="controls">
+			<label class="checkbox">
+		    	<input type="checkbox" data-bind="checked: settings.plugins.mystromswitch.powerOffOnShutdown">Turn relais OFF on Octoprint shutdown
+			</label>
+		    <span class="help-block"><small>{{ _('This setting switches your mySwitch off if Octoprint is shutting down. If your Raspberry Pi is also switched by the relays its recommended to use an turn relay off delay of 60 seconds or more. Keep in mind this switches also off if you restart Octoprint service!') }}</small></span>
+		</div>
+	</div>
+
+	<div class="control-group">
+        <label class="control-label">{{ _('Turn Relais Off Delay') }}</label>
+        <div class="controls">
+            <div class="input-append">
+                <input type="number" class="input-block-level" data-bind="value: settings.plugins.mystromswitch.powerOffDelay">
+                <span class="add-on">seconds</span>
+            </div>
+            <span class="help-block"><small>{{ _('Delay in seconds after octoprint is shutted down to switch off relays. This settings is recommended to make sure that Raspberry Pi is completely shutted down when you switch power off. Switching off when your Raspberry Pi is running could lead to unrepairable damage to your SD Card!') }}</small></span>
         </div>
     </div>
 </form>

octoprint_mystromswitch/templates/mystromswitch_sidebar.jinja2

@@ -1,3 +1,5 @@
 <div class="sidebar_plugin_mystromswitch">
     <label class="control-label" id="mystromswitchPowerValue">Powerconsumption 0.0W</label>
+    <label class="control-label" id="mystromswitchEnergyValue">Energy 0.0Wh</label>
+    <button class="btn btn-primary" data-bind="click: onToggleRelayEvent, visible : onOffButtonEnabled">{{ _('Toggle Relais') }}</button>
 </div>

setup.py

@@ -14,7 +14,7 @@ plugin_package = "octoprint_mystromswitch"
 plugin_name = "OctoPrint-MyStromSwitch"
 
 # The plugin's version. Can be overwritten within OctoPrint's internal data via __plugin_version__ in the plugin module
-plugin_version = "0.1.0"
+plugin_version = "1.0.1"
 
 # The plugin's description. Can be overwritten within OctoPrint's internal data via __plugin_description__ in the plugin
 # module