Merge pull request #12 from OctoPrint/fix/issue11

🐛 Properly honor disabled check

Fixes #11

Author: foosel

octoprint_pi_support/__init__.py

@@ -277,7 +277,17 @@ def __init__(self):
         self._throttle_check = None
         self._throttle_undervoltage = False
         self._throttle_overheat = False
-        self._throttle_functional = True
+        self._throttle_check_enabled = True
+        self._throttle_check_functional = True
+
+    def initialize(self):
+        self._throttle_check_enabled = self._settings.get_boolean(
+            ["vcgencmd_throttle_check_enabled"]
+        )
+        if not self._throttle_check_enabled:
+            self._logger.warning(
+                "Throttle check via vcgencmd disabled by user. Potential undervoltage or overheating issues will not be detected."
+            )
 
     # Additional permissions hook
 
@@ -311,7 +321,9 @@ def get_additional_environment(self):
         result = {"model": get_proc_dt_model()}
 
         self._check_throttled_state()
-        if self._throttle_functional:
+        result["throttle_check_enabled"] = self._throttle_check_enabled
+        result["throttle_check_functional"] = self._throttle_check_functional
+        if self._throttle_check_enabled and self._throttle_check_functional:
             result["throttle_state"] = self._throttle_state.raw_value_hex
 
         if is_octopi():
@@ -331,8 +343,9 @@ def on_api_get(self, request):
         result = self.get_additional_environment()
         result.update(
             {
+                "throttle_enabled": self._throttle_check_enabled,
+                "throttle_functional": self._throttle_check_functional,
                 "throttle_state": self._throttle_state.as_dict(),
-                "throttle_functional": self._throttle_functional,
                 "model_unrecommended": is_model_any_of(
                     result.get("model"), *_UNRECOMMENDED_MODELS
                 ),
@@ -445,19 +458,22 @@ def _check_throttled_state_interval(self):
             return _CHECK_INTERVAL_OK
 
     def _check_throttled_state_condition(self):
-        return self._throttle_functional
+        return self._throttle_check_enabled and self._throttle_check_functional
 
     def get_throttle_state(self, run_now=False):
         """Exposed as public helper."""
         if run_now:
             self._check_throttled_state()
 
-        if not self._throttle_functional:
+        if not self._throttle_check_enabled or not self._throttle_check_functional:
             return False
 
         return self._throttle_state.as_dict()
 
     def _check_throttled_state(self):
+        if not self._throttle_check_enabled:
+            return
+
         command = self._settings.get(["vcgencmd_throttle_check_command"])
 
         self._logger.debug('Retrieving throttle state via "{}"'.format(command))
@@ -472,7 +488,7 @@ def _check_throttled_state(self):
                         getuser()
                     )
                 )
-            self._throttle_functional = False
+            self._throttle_check_functional = False
             return
 
         if self._throttle_state == state:

octoprint_pi_support/templates/pi_support_settings.jinja2

@@ -37,7 +37,7 @@
             <label class="checkbox">
                 <input type="checkbox" data-bind="checked: settings.plugins.pi_support.vcgencmd_throttle_check_enabled"> {{ _('Enable under voltage and overheat detection via <code>vcgencmd get_throttled</code>') }}
             </label>
-            <span class="help-block">{{ _('This will regularly check with the Pi if something is amiss either with power regulation or CPU/GPU temperature.') }}</span>
+            <span class="help-block">{{ _('This will regularly check with the Pi if something is amiss either with power regulation or CPU/GPU temperature. Disable at your own risk. You will have to re-enable this when getting assistance on the forums or Discord. Changes require a restart of OctoPrint.') }}</span>
         </div>
     </div>