Treat extensions like standard plugins, add read_args.

Author: jburhenn

myDevices/devices/analog/helper.py

@@ -36,7 +36,7 @@ def setADCInstance(self):
         if not self.adc:
             self.adc = instance.deviceInstance(self.adcname)
             if not self.adc:
-                self.adc = self.pluginManager.get_extension(self.adcname)
+                self.adc = self.pluginManager.get_plugin_by_id(self.adcname)
 
     @response("%d")
     def read(self):

myDevices/plugins/analog.py

@@ -0,0 +1,42 @@
+"""
+This module provides classes for interfacing with analog plugins.
+"""
+import json
+from myDevices.plugins.manager import PluginManager
+from myDevices.utils.logger import info
+
+
+class AnalogInput():
+    """Reads data from an analog input."""
+
+    def __init__(self, adc_name):
+        """Initializes the analog input.
+        
+        Arguments:
+            adc_name: Name of analog-to-digital converter plugin in the format 'plugin_name:section'
+        """
+        self.adc_name = adc_name
+        self.adc = None
+        self.read_args = {}
+        self.pluginManager = PluginManager()
+        self.set_adc()
+    
+    def set_adc(self):
+        """Sets the ADC plugin."""
+        if not self.adc:
+            self.adc = self.pluginManager.get_plugin_by_id(self.adc_name)
+            self.read_args = json.loads(self.adc['read_args'])
+
+    def read_value(self, channel, data_type=None):
+        """Read the data value on the specified channel."""
+        self.set_adc()
+        value = getattr(self.adc['instance'], self.adc['read'])(channel, data_type=data_type, **self.read_args)
+        return value
+       
+    def read_float(self, channel):
+        """Read the float value on the specified channel."""
+        return self.read_value(channel, 'float')
+    
+    def read_volt(self, channel):
+        """Read the voltage on the specified channel."""
+        return self.read_value(channel, 'volt')

myDevices/plugins/manager.py

@@ -6,6 +6,7 @@
 import json
 import os
 import sys
+from configparser import NoOptionError
 
 import myDevices.cloud.cayennemqtt as cayennemqtt
 from myDevices.utils.config import Config
@@ -24,7 +25,6 @@ def __init__(self, callback=None):
         self.plugin_folder = PLUGIN_FOLDER
         self.callback = callback
         self.plugins = {}
-        self.extensions = {}
 
     def load_plugin_from_file(self, filename):
         """Loads a plugin from a specified plugin config file and adds it to the plugin list."""
@@ -43,18 +43,17 @@ def load_plugin_from_file(self, filename):
                 try:
                     enabled = config.get(section, 'enabled', 'true').lower() == 'true'
                     inherit = config.get(section, 'inherit', None)
-                    extension = config.get(section, 'extension', 'false').lower() == 'true'
                     if enabled or section in inherited_from:
                         plugin = {
                             'enabled': enabled,
                             'filename': filename,
                             'section': section,
                             'name': config.get(section, 'name', section),
                         }
-                        if not extension:
+                        try:
                             plugin['channel'] = config.get(section, 'channel')
                             plugin['id'] = plugin_name + ':' + plugin['channel']
-                        else:
+                        except NoOptionError:
                             plugin['id'] = plugin_name + ':' + section
                         inherit_items = {}
                         if inherit in config.sections():
@@ -79,6 +78,9 @@ def load_plugin_from_file(self, filename):
                             device_class = getattr(imported_module, plugin['class'])
                             plugin['instance'] = device_class(**json.loads(plugin['init_args']))
                         self.override_plugin_value(config, section, 'read', plugin)
+                        if 'read_args' not in plugin:
+                            plugin['read_args'] = '{}'
+                        self.override_plugin_value(config, section, 'read_args', plugin)
                         try:
                             self.override_plugin_value(config, section, 'write', plugin)
                         except:
@@ -92,10 +94,7 @@ def load_plugin_from_file(self, filename):
                             self.override_plugin_value(config, section, 'unregister_callback', plugin)
                         except:
                             pass
-                        if not extension:                                                
-                            self.plugins[plugin['id']] = plugin
-                        else:
-                            self.extensions[plugin['id']] = plugin
+                        self.plugins[plugin['id']] = plugin
                         loaded.append(section)
                 except Exception as e:
                     error(e)
@@ -111,20 +110,19 @@ def load_plugins(self):
             #Remove any disabled plugins that were only loaded because they are inherited from.
             self.plugins = {key:value for key, value in self.plugins.items() if value['enabled']}
         info('Enabled plugins: {}'.format(self.plugins.keys()))
-        info('Enabled extensions: {}'.format(self.extensions.keys()))
 
     def get_plugin(self, filename, section):
         """Return the plugin for the corresponding filename and section."""
         return next(plugin for plugin in self.plugins.values() if plugin['filename'] == filename and plugin['section'] == section)
 
-    def get_extension(self, id):
-        """Return the extension with the corresponding id."""
-        extension = None
+    def get_plugin_by_id(self, id):
+        """Return the plugin with the corresponding id."""
+        plugin = None
         try:
-            extension = self.extensions[id]
+            plugin = self.plugins[id]
         except:
             pass
-        return extension
+        return plugin
 
     def override_plugin_value(self, config, section, key, plugin):
         """Override the plugin value for the specified key if it exists in the config file"""
@@ -138,10 +136,11 @@ def get_plugin_readings(self):
         readings = []
         for key, plugin in self.plugins.items():
             try:
-                value = getattr(plugin['instance'], plugin['read'])()
-                value_dict = self.convert_to_dict(value)
-                if value_dict:
-                    cayennemqtt.DataChannel.add(readings, cayennemqtt.DEV_SENSOR, key, name=plugin['name'], **value_dict)
+                if 'channel' in plugin:
+                    value = getattr(plugin['instance'], plugin['read'])(**json.loads(plugin['read_args']))
+                    value_dict = self.convert_to_dict(value)
+                    if value_dict:
+                        cayennemqtt.DataChannel.add(readings, cayennemqtt.DEV_SENSOR, key, name=plugin['name'], **value_dict)
             except KeyError as e:
                 debug('Missing key {} in plugin \'{}\''.format(e, plugin['name']))
             except: