Merge pull request #38 from Cosik/feature/armbian-support

[Feature] Support for platforms compatible with Armbian

Author: imrahil

README.md

@@ -8,3 +8,13 @@ For Raspberry Pi users it's possible to display internal temperature (configurab
 ## Setup
 
 Install the plugin using Plugin Manager from Settings
+
+## Need new platform support?
+If you need support for additional platform, please inform us and add such information:
+* How to read temperature
+* How to define platform type
+
+And be ready for testing.
+
+## Change notes:
+v 1.0 - added support for all platforms running under Armbian

octoprint_navbartemp/__init__.py

@@ -10,83 +10,56 @@
 import sys
 import re
 
+from .libs.sbc import SBCFactory
+
+
 class NavBarPlugin(octoprint.plugin.StartupPlugin,
                    octoprint.plugin.TemplatePlugin,
                    octoprint.plugin.AssetPlugin,
                    octoprint.plugin.SettingsPlugin):
 
     def __init__(self):
-        self.isRaspi = False
-        self.debugMode = False      # to simulate temp on Win/Mac
+        self.piSocTypes = (["BCM2708", "BCM2709",
+                            "BCM2835"])  # Array of raspberry pi SoC's to check against, saves having a large if/then statement later
+        self.debugMode = False  # to simulate temp on Win/Mac
         self.displayRaspiTemp = True
         self._checkTempTimer = None
+        self.sbc = None
 
     def on_after_startup(self):
         self.displayRaspiTemp = self._settings.get(["displayRaspiTemp"])
+        self.piSocTypes = self._settings.get(["piSocTypes"])
         self._logger.debug("displayRaspiTemp: %s" % self.displayRaspiTemp)
 
         if sys.platform == "linux2":
-            with open('/proc/cpuinfo', 'r') as infile:
-                    cpuinfo = infile.read()
-            # Match a line like 'Hardware   : BCM2709'
-            match = re.search('^Hardware\s+:\s+(\w+)$', cpuinfo, flags=re.MULTILINE | re.IGNORECASE)
-
-            if match is None:
-                # Couldn't find the hardware, assume it isn't a pi.
-                self.isRaspi = False
-            elif match.group(1) == 'BCM2708':
-                self._logger.debug("Pi 1")
-                self.isRaspi = True
-            elif match.group(1) == 'BCM2709':
-                self._logger.debug("Pi 2")
-                self.isRaspi = True
-	    elif match.group(1) == 'BCM2835':
-		self._logger.debug("Pi 3")
-		self.isRaspi = True
-
-            if self.isRaspi and self.displayRaspiTemp:
+            self.sbc = SBCFactory().factory(self._logger)
+
+            if self.sbc.is_supported and self.displayRaspiTemp:
                 self._logger.debug("Let's start RepeatedTimer!")
                 self.startTimer(30.0)
+        # debug mode doesn't work if the OS is linux on a regular pc
         elif self.debugMode:
-            self.isRaspi = True
+            self.sbc.is_supported = True
             if self.displayRaspiTemp:
                 self.startTimer(5.0)
 
-        self._logger.debug("is Raspberry Pi? - %s" % self.isRaspi)
+        self._logger.debug("is supported? - %s" % self.sbc.is_supported)
 
     def startTimer(self, interval):
-        self._checkTempTimer = RepeatedTimer(interval, self.checkRaspiTemp, None, None, True)
+        self._checkTempTimer = RepeatedTimer(interval, self.updateSoCTemp, None, None, True)
         self._checkTempTimer.start()
 
-    def checkRaspiTemp(self):
-        from sarge import run, Capture
-
-        self._logger.debug("Checking Raspberry Pi internal temperature")
-
-        if sys.platform == "linux2":
-            p = run("/opt/vc/bin/vcgencmd measure_temp", stdout=Capture())
-            p = p.stdout.text
-
-        elif self.debugMode:
-            import random
-            def randrange_float(start, stop, step):
-                return random.randint(0, int((stop - start) / step)) * step + start
-            p = "temp=%s'C" % randrange_float(5, 60, 0.1)
+    def updateSoCTemp(self):
+        temp = self.sbc.checkSoCTemp()
+        self._logger.debug("match: %s" % temp)
+        self._plugin_manager.send_plugin_message(self._identifier,
+                                                 dict(isSupported=self.sbc.is_supported,
+                                                      soctemp=temp))
 
-        self._logger.debug("response from sarge: %s" % p)
-
-        match = re.search('=(.*)\'', p)
-        if not match:
-            self.isRaspi = False
-        else:
-            temp = match.group(1)
-            self._logger.debug("match: %s" % temp)
-            self._plugin_manager.send_plugin_message(self._identifier, dict(israspi=self.isRaspi, raspitemp=temp))
-
-
-	##~~ SettingsPlugin
+    ##~~ SettingsPlugin
     def get_settings_defaults(self):
-        return dict(displayRaspiTemp = self.displayRaspiTemp)
+        return dict(displayRaspiTemp=self.displayRaspiTemp,
+                    piSocTypes=self.piSocTypes)
 
     def on_settings_save(self, data):
         octoprint.plugin.SettingsPlugin.on_settings_save(self, data)
@@ -104,9 +77,9 @@ def on_settings_save(self, data):
                     pass
             self._plugin_manager.send_plugin_message(self._identifier, dict())
 
-	##~~ TemplatePlugin API
+    ##~~ TemplatePlugin API
     def get_template_configs(self):
-        if self.isRaspi:
+        if self.sbc.is_supported:
             return [
                 dict(type="settings", template="navbartemp_settings_raspi.jinja2")
             ]
@@ -119,9 +92,10 @@ def get_assets(self):
             "js": ["js/navbartemp.js"],
             "css": ["css/navbartemp.css"],
             "less": ["less/navbartemp.less"]
-        } 
+        }
+
+        ##~~ Softwareupdate hook
 
-    ##~~ Softwareupdate hook
     def get_update_information(self):
         return dict(
             navbartemp=dict(
@@ -130,22 +104,26 @@ def get_update_information(self):
 
                 # version check: github repository
                 type="github_release",
-                user="imrahil",
+                user="ntoff",
                 repo="OctoPrint-NavbarTemp",
                 current=self._plugin_version,
 
                 # update method: pip w/ dependency links
-                pip="https://github.com/imrahil/OctoPrint-NavbarTemp/archive/{target_version}.zip"
+                pip="https://github.com/ntoff/OctoPrint-NavbarTemp/archive/{target_version}.zip"
             )
         )
 
-__plugin_name__ = "Navbar Temperature Plugin"
+
+__plugin_name__ = "Navbar Temperature Plugin (ntoff mod)"
+__plugin_author__ = "Jarek Szczepanski (modified by ntoff)"
+__plugin_url__ = "https://github.com/ntoff/OctoPrint-NavbarTemp"
+
 
 def __plugin_load__():
-	global __plugin_implementation__
-	__plugin_implementation__ = NavBarPlugin()
+    global __plugin_implementation__
+    __plugin_implementation__ = NavBarPlugin()
 
-	global __plugin_hooks__
-	__plugin_hooks__ = {
-		"octoprint.plugin.softwareupdate.check_config": __plugin_implementation__.get_update_information
-	}
+    global __plugin_hooks__
+    __plugin_hooks__ = {
+        "octoprint.plugin.softwareupdate.check_config": __plugin_implementation__.get_update_information
+    }

octoprint_navbartemp/libs/__init__.py

@@ -0,0 +1,133 @@
+'''
+
+This module contain factory patter for different hardware platforms. Adding new platform is simple, first you need
+add class with inheriting from SBC. Inside you have to define differences between parent class and child. You can easily
+overwrite methods and parameters. For reference please look at Armbiand and RPi classes.
+
+Last step is to define way of detecting platform type. It could be very different depending on OS.
+
+'''
+
+import os
+import re
+
+
+class SBCFactory(object):
+
+    piSocTypes = (["BCM2708", "BCM2709",
+                        "BCM2835"])  # Array of raspberry pi SoC's to check against, saves having a large if/then statement later
+
+    # Create based on class name:
+    def factory(self, logger):
+        """
+        Method is returning handler to object based on defined criteria
+        :param logger: global logger
+        :return: handler to proper object
+        """
+        if self._is_armbian():
+            return Armbian(logger)
+        elif self._is_rpi(logger):
+            return RPi(logger)
+
+        return SBC()
+
+    def _is_rpi(self, logger):
+        """
+        Detecting if is RPi - based on original code
+        :param logger:
+        :return:
+        """
+        with open('/proc/cpuinfo', 'r') as infile:
+            cpuinfo = infile.read()
+        # Match a line like 'Hardware   : BCM2709'
+        match = re.search('Hardware\s+:\s+(\w+)', cpuinfo, flags=re.MULTILINE | re.IGNORECASE)
+
+        if match.group(1) in self.piSocTypes:
+            logger.info("Broadcom detected")
+            return True
+
+    def _is_armbian(self):
+        """
+        Detecting armbian - checking if armbian monitor exist
+        :return:
+        """
+        return os.path.exists("/etc/armbianmonitor")
+
+
+class SBC(object):
+
+    temp_cmd = ''
+    is_supported = False
+    debugMode = False
+    parse_pattern = ''
+
+
+    def checkSoCTemp(self):
+        if self.is_supported:
+            from sarge import run, Capture
+
+            self._logger.info("Checking SoC internal temperature")
+            p = run(self.temp_cmd, stdout=Capture())
+            if p.returncode == 1:
+                self.is_supported = False
+                self._logger.info("SoC temperature not found.")
+            else:
+                p = p.stdout.text
+
+            # elif self.debugMode:  # doesn't work on linux
+            #     import random
+            #     def randrange_float(start, stop, step):
+            #         return random.randint(0, int((stop - start) / step)) * step + start
+            #
+            #     p = "temp=%s'C" % randrange_float(5, 60, 0.1)
+
+            self._logger.debug("response from sarge: %s" % p)
+            self._logger.debug("used pattern: %r" % self.parse_pattern)
+            match = re.search(self.parse_pattern, p)
+            temp = 0
+            if not match:
+                self._logger.debug("match: not found")
+                self.is_supported = False
+            else:
+                temp = self.parse_tepmerature(match)
+                self._logger.debug("match: %s" % str(temp))
+
+            return temp
+        return 0
+
+    def parse_tepmerature(self, re_output):
+        return re_output.group(1)
+
+
+class RPi(SBC):
+
+    def __init__(self, logger):
+        self.is_supported = True
+        self.temp_cmd = '/opt/vc/bin/vcgencmd measure_temp'
+        self.parse_pattern = '=(.*)\''
+        self._logger = logger
+
+
+class Armbian(SBC):
+
+    def __init__(self, logger):
+        self.is_supported = True
+        self.temp_cmd = 'cat /etc/armbianmonitor/datasources/soctemp'
+        self.parse_pattern = '(\d+)'
+        self._logger = logger
+
+    def parse_tepmerature(self, re_output):
+        """
+        We are expecting that temp of SoC will be no more that 3 digit int. Armbian on Odroid is returning ex 44000 but
+        on orangePi 26
+        :param re_output:
+        :return:
+        """
+        # TODO: depending on situation in the future maybe it will be necessary to split it.
+        temp = re_output.group(1)
+        if len(temp) == 2 or len(temp) == 3:
+            return float(temp)
+        elif len(temp) >= 4:
+            return float(re_output.group(1)) / 1000
+
+        return float(re_output.group(1))

octoprint_navbartemp/libs/sbc.py

@@ -1 +1,40 @@
-#navbar .navbar-inner .nav>li>div>p,#navbar .navbar-inner .nav>li>p{color:#333}#navbar .navbar-inner.orange .nav>li>div>p,#navbar .navbar-inner.orange .nav>li>p,#navbar .navbar-inner.red .nav>li>div>p,#navbar .navbar-inner.red .nav>li>p{color:#f2f2f2}#navbar .navbar-inner.green .nav>li>div>p,#navbar .navbar-inner.green .nav>li>p,#navbar .navbar-inner.yellow .nav>li>div>p,#navbar .navbar-inner.yellow .nav>li>p{color:#333}#navbar .navbar-inner.black .nav>li>div>p,#navbar .navbar-inner.black .nav>li>p,#navbar .navbar-inner.blue .nav>li>div>p,#navbar .navbar-inner.blue .nav>li>p,#navbar .navbar-inner.violet .nav>li>div>p,#navbar .navbar-inner.violet .nav>li>p{color:#f2f2f2}
+.navbar-inner .navbar-text {
+  color: #333;
+  text-shadow: 0 1px 0 #c8c8c8;
+  cursor: default;
+}
+.navbar-inner.blue .navbar-text,
+.navbar-inner.red .navbar-text,
+.navbar-inner.orange .navbar-text,
+.navbar-inner.yellow .navbar-text,
+.navbar-inner.violet .navbar-text,
+.navbar-inner.black .navbar-text {
+  color: #f2f2f2;
+}
+.navbar-inner.white .navbar-text {
+  color: #333;
+}
+.navbar-inner.black .navbar-text {
+  text-shadow: 0 1px 0 #5e5e5e;
+}
+.navbar-inner.white .navbar-text {
+  text-shadow: 0 1px 0 #c8c8c8;
+}
+.navbar-inner.red .navbar-text {
+  text-shadow: 0 1px 0 #d86761;
+}
+.navbar-inner.blue .navbar-text {
+  text-shadow: 0 1px 0 #1a66ff;
+}
+.navbar-inner.green .navbar-text {
+  text-shadow: 0 1px 0 #50da00;
+}
+.navbar-inner.yellow .navbar-text {
+  text-shadow: 0 1px 0 #c2b00c;
+}
+.navbar-inner.orange .navbar-text {
+  text-shadow: 0 1px 0 #f6a570;
+}
+.navbar-inner.violet .navbar-text {
+  text-shadow: 0 1px 0 #a774ff;
+}