- Fixed bug where custom Y axis tick marks and locations were sometimes not plotted properly.

DaveL17 · DaveL17 · commit 5dd8dc25363f · 2023-02-04T12:37:35.000-06:00
- Fixed bug where `rcParamsDevice` devices were not skipped when user elects to redraw all charts from the plugin menu.
- Adds module filename to chart error tracebacks to make it easier to find the error.
- Adds new module `validate` and moves validation code to that module.
- Code refinements.
- Minor UI refinements.
diff --git a/_changelog.md b/_changelog.md
@@ -1,3 +1,11 @@
+#### v2022.1.6
+- Fixed bug where custom Y axis tick marks and locations were sometimes not plotted properly.
+- Fixed bug where `rcParamsDevice` devices were not skipped when user elects to redraw all charts from the plugin menu.
+- Adds module filename to chart error tracebacks to make it easier to find the error.
+- Adds new module `validate` and moves validation code to that module.
+- Code refinements.
+- Minor UI refinements.
+ 
 #### v2022.1.5
 - Charts
   - Annotation value precision controls added to Area, Bar Flow Vertical, Bar Stock Horizontal, Bar Stock Vertical, 
diff --git a/_to_do_list.md b/_to_do_list.md
@@ -1,5 +1,5 @@
 ### TODO 
-- x
+- 
 
 #### NEW
 - Combination device (line/bar to replicate weather devices).
@@ -11,6 +11,7 @@
   [See example](https://matplotlib.org/3.1.1/gallery/ticks_and_spines/multiple_yaxis_with_spines.html)
 - Create new STEP chart type as step is no longer a supported line style. 
   [See example](https://matplotlib.org/3.5.1/api/_as_gen/matplotlib.axes.Axes.step.html?highlight=steps%20post)
+
 #### Refinements
 - Try to address annotation collisions.
 - Allow scripting control or a tool to repopulate color controls so that you can change all bars/lines/scatter etc. in 
diff --git a/matplotlib.indigoPlugin/Contents/Info.plist b/matplotlib.indigoPlugin/Contents/Info.plist
@@ -3,7 +3,7 @@
 <plist version="1.0">
 <dict>
 	<key>PluginVersion</key>
-	<string>2022.1.5</string>
+	<string>2022.1.6</string>
 	<key>ServerApiVersion</key>
 	<string>3.0</string>
 	<key>IwsApiVersion</key>
diff --git a/matplotlib.indigoPlugin/Contents/Server Plugin/Devices.xml b/matplotlib.indigoPlugin/Contents/Server Plugin/Devices.xml
@@ -2896,7 +2896,7 @@
 
             <Field id="filterAnomalies" type="textfield" defaultValue="0"
                    visibleBindingId="settingsGroup" visibleBindingValue="ch"
-                   tooltip="If checked, the plugin will hide anomalous data when plotting charts.">
+                   tooltip="The number of standard deviations to contain anomalous data. Set to zero (the default) to display all data.">
                 <Label>Hide Anomalies:</Label>
             </Field>
 
@@ -4279,7 +4279,7 @@
             <!-- Filter Anomalies -->
             <Field id="filterAnomalies" type="textfield" defaultValue="0"
                    visibleBindingId="settingsGroup" visibleBindingValue="ch"
-                   tooltip="If checked, the plugin will hide anomalous data when plotting charts.">
+                   tooltip="The number of standard deviations to contain anomalous data. Set to zero (the default) to display all data.">
                 <Label>Hide Anomalies:</Label>
                 <CallbackMethod>dummyCallback</CallbackMethod>
                 <Description/>
diff --git a/matplotlib.indigoPlugin/Contents/Server Plugin/chart_area.py b/matplotlib.indigoPlugin/Contents/Server Plugin/chart_area.py
@@ -336,6 +336,6 @@ def __init__():
     tb = traceback.format_exc()
     tb_type = sys.exc_info()[1]
     LOG['Debug'].append(f"[{CHART_NAME}] {tb}")
-    LOG['Critical'].append(f"[{CHART_NAME}] Error type: {tb_type}")
+    LOG['Critical'].append(f"[{CHART_NAME}] Error type: {tb_type} in {__file__.split('/')[-1]}")
 
 json.dump(LOG, sys.stdout, indent=4)
diff --git a/matplotlib.indigoPlugin/Contents/Server Plugin/chart_bar_flow.py b/matplotlib.indigoPlugin/Contents/Server Plugin/chart_bar_flow.py
@@ -257,6 +257,6 @@ def __init__():
     tb = traceback.format_exc()
     tb_type = sys.exc_info()[1]
     LOG['Debug'].append(f"[{CHART_NAME}] {tb}")
-    LOG['Critical'].append(f"[{CHART_NAME}] Error type: {tb_type}")
+    LOG['Critical'].append(f"[{CHART_NAME}] Error type: {tb_type} in {__file__.split('/')[-1]}")
 
 json.dump(LOG, sys.stdout, indent=4)
diff --git a/matplotlib.indigoPlugin/Contents/Server Plugin/chart_bar_radial.py b/matplotlib.indigoPlugin/Contents/Server Plugin/chart_bar_radial.py
@@ -103,6 +103,6 @@ def __init__():
     tb = traceback.format_exc()
     tb_type = sys.exc_info()[1]
     LOG['Debug'].append(f"[{CHART_NAME}] {tb}")
-    LOG['Critical'].append(f"[{CHART_NAME}] Error type: {tb_type}")
+    LOG['Critical'].append(f"[{CHART_NAME}] Error type: {tb_type} in {__file__.split('/')[-1]}")
 
 json.dump(LOG, sys.stdout, indent=4)
diff --git a/matplotlib.indigoPlugin/Contents/Server Plugin/chart_bar_stock.py b/matplotlib.indigoPlugin/Contents/Server Plugin/chart_bar_stock.py
@@ -225,6 +225,6 @@ def __init__():
     tb = traceback.format_exc()
     tb_type = sys.exc_info()[1]
     LOG['Debug'].append(f"[{CHART_NAME}] {tb}")
-    LOG['Critical'].append(f"[{CHART_NAME}] Error type: {tb_type}")
+    LOG['Critical'].append(f"[{CHART_NAME}] Error type: {tb_type} in {__file__.split('/')[-1]}")
 
 json.dump(LOG, sys.stdout, indent=4)
diff --git a/matplotlib.indigoPlugin/Contents/Server Plugin/chart_bar_stock_horizontal.py b/matplotlib.indigoPlugin/Contents/Server Plugin/chart_bar_stock_horizontal.py
@@ -221,6 +221,6 @@ def __init__():
     tb = traceback.format_exc()
     tb_type = sys.exc_info()[1]
     LOG['Debug'].append(f"[{CHART_NAME}] {tb}")
-    LOG['Critical'].append(f"[{CHART_NAME}] Error type: {tb_type}")
+    LOG['Critical'].append(f"[{CHART_NAME}] Error type: {tb_type} in {__file__.split('/')[-1]}")
 
 json.dump(LOG, sys.stdout, indent=4)
diff --git a/matplotlib.indigoPlugin/Contents/Server Plugin/chart_batteryhealth.py b/matplotlib.indigoPlugin/Contents/Server Plugin/chart_batteryhealth.py
@@ -209,6 +209,6 @@
     tb = traceback.format_exc()
     tb_type = sys.exc_info()[1]
     LOG['Debug'].append(f"[{CHART_NAME}] {tb}")
-    LOG['Critical'].append(f"[{CHART_NAME}] Error type: {tb_type}")
+    LOG['Critical'].append(f"[{CHART_NAME}] Error type: {tb_type} in {__file__.split('/')[-1]}")
 
 json.dump(LOG, sys.stdout, indent=4)
diff --git a/matplotlib.indigoPlugin/Contents/Server Plugin/chart_calendar.py b/matplotlib.indigoPlugin/Contents/Server Plugin/chart_calendar.py
@@ -122,6 +122,6 @@ def __init__():
     tb = traceback.format_exc()
     tb_type = sys.exc_info()[1]
     LOG['Debug'].append(f"[{CHART_NAME}] {tb}")
-    LOG['Critical'].append(f"[{CHART_NAME}] Error type: {tb_type}")
+    LOG['Critical'].append(f"[{CHART_NAME}] Error type: {tb_type} in {__file__.split('/')[-1]}")
 
 json.dump(LOG, sys.stdout, indent=4)
diff --git a/matplotlib.indigoPlugin/Contents/Server Plugin/chart_line.py b/matplotlib.indigoPlugin/Contents/Server Plugin/chart_line.py
@@ -302,6 +302,6 @@ def __init__():
     tb = traceback.format_exc()
     tb_type = sys.exc_info()[1]
     LOG['Debug'].append(f"[{CHART_NAME}] {tb}")
-    LOG['Critical'].append(f"[{CHART_NAME}] Error type: {tb_type}")
+    LOG['Critical'].append(f"[{CHART_NAME}] Error type: {tb_type} in {__file__.split('/')[-1]}")
 
 json.dump(LOG, sys.stdout, indent=4)
diff --git a/matplotlib.indigoPlugin/Contents/Server Plugin/chart_multiline.py b/matplotlib.indigoPlugin/Contents/Server Plugin/chart_multiline.py
@@ -155,6 +155,6 @@ def clean_string(val):
     tb = traceback.format_exc()
     tb_type = sys.exc_info()[1]
     LOG['Debug'].append(f"[{CHART_NAME}] {tb}")
-    LOG['Critical'].append(f"[{CHART_NAME}] Error type: {tb_type}")
+    LOG['Critical'].append(f"[{CHART_NAME}] Error type: {tb_type} in {__file__.split('/')[-1]}")
 
 json.dump(LOG, sys.stdout, indent=4)
diff --git a/matplotlib.indigoPlugin/Contents/Server Plugin/chart_polar.py b/matplotlib.indigoPlugin/Contents/Server Plugin/chart_polar.py
@@ -282,6 +282,6 @@ def __init__():
     tb = traceback.format_exc()
     tb_type = sys.exc_info()[1]
     LOG['Debug'].append(f"[{CHART_NAME}] {tb}")
-    LOG['Critical'].append(f"[{CHART_NAME}] Error type: {tb_type}")
+    LOG['Critical'].append(f"[{CHART_NAME}] Error type: {tb_type} in {__file__.split('/')[-1]}")
 
 json.dump(LOG, sys.stdout, indent=4)
diff --git a/matplotlib.indigoPlugin/Contents/Server Plugin/chart_scatter.py b/matplotlib.indigoPlugin/Contents/Server Plugin/chart_scatter.py
@@ -276,6 +276,6 @@ def __init__():
     tb = traceback.format_exc()
     tb_type = sys.exc_info()[1]
     LOG['Debug'].append(f"[{CHART_NAME}] {tb}")
-    LOG['Critical'].append(f"[{CHART_NAME}] Error type: {tb_type}")
+    LOG['Critical'].append(f"[{CHART_NAME}] Error type: {tb_type} in {__file__.split('/')[-1]}")
 
 json.dump(LOG, sys.stdout, indent=4)
diff --git a/matplotlib.indigoPlugin/Contents/Server Plugin/chart_tools.py b/matplotlib.indigoPlugin/Contents/Server Plugin/chart_tools.py
@@ -446,12 +446,9 @@ def format_axis_y_ticks(p_dict, k_dict, logger):
     :param dict logger:
     """
 
-    # custom_ticks_marks = p_dict['customTicksY'].strip()
-    # custom_ticks_labels = p_dict['customTicksLabelY'].strip()
-    custom_ticks_marks = [_.strip() for _ in p_dict['customTicksY']]
-    custom_ticks_labels = [_.strip() for _ in p_dict['customTicksLabelY']]
-
     try:
+        custom_ticks_marks = [float(_) for _ in p_dict['customTicksY'].split(',')]
+        custom_ticks_labels = [_ for _ in p_dict['customTicksLabelY'].split(',')]
         # Get the default tick values and labels (which we'll replace as needed.)
         marks, labels = plt.yticks()
 
@@ -464,14 +461,12 @@ def format_axis_y_ticks(p_dict, k_dict, logger):
             custom_ticks_labels = custom_ticks_marks
 
         # Replace default Y tick values with the custom ones.
-        # if custom_ticks_marks.lower() not in ('none', '') \
-        #         and not custom_ticks_marks.isspace():
-        #     marks = [float(_) for _ in custom_ticks_marks.split(",")]
+        if custom_ticks_marks not in ('none', ''):
+            marks = custom_ticks_marks
 
         # Replace the default Y tick labels with the custom ones.
-        # if custom_ticks_labels.lower() not in ('none', '') \
-        #         and not custom_ticks_labels.isspace():
-        #     labels = [f"{_.strip()}" for _ in custom_ticks_labels.split(",")]
+        if custom_ticks_labels not in ('none', ''):
+            labels = custom_ticks_labels
 
         plt.yticks(marks, labels)
 
diff --git a/matplotlib.indigoPlugin/Contents/Server Plugin/chart_weather_composite.py b/matplotlib.indigoPlugin/Contents/Server Plugin/chart_weather_composite.py
@@ -359,6 +359,6 @@ def transparent_chart_fill(s):
     tb = traceback.format_exc()
     tb_type = sys.exc_info()[1]
     LOG['Debug'].append(f"[{CHART_NAME}] {tb}")
-    LOG['Critical'].append(f"[{CHART_NAME}] Error type: {tb_type}")
+    LOG['Critical'].append(f"[{CHART_NAME}] Error type: {tb_type} in {__file__.split('/')[-1]}")
 
 json.dump(LOG, sys.stdout, indent=4)
diff --git a/matplotlib.indigoPlugin/Contents/Server Plugin/chart_weather_forecast.py b/matplotlib.indigoPlugin/Contents/Server Plugin/chart_weather_forecast.py
@@ -475,6 +475,6 @@ def __init__():
     tb = traceback.format_exc()
     tb_type = sys.exc_info()[1]
     LOG['Debug'].append(f"[{CHART_NAME}] {tb}")
-    LOG['Critical'].append(f"[{CHART_NAME}] Error type: {tb_type}")
+    LOG['Critical'].append(f"[{CHART_NAME}] Error type: {tb_type} in {__file__.split('/')[-1]}")
 
 json.dump(LOG, sys.stdout, indent=4)
diff --git a/matplotlib.indigoPlugin/Contents/Server Plugin/maintenance.py b/matplotlib.indigoPlugin/Contents/Server Plugin/maintenance.py
@@ -24,7 +24,6 @@
 __title__     = "maintenance"
 __version__   = "0.1.02"
 
-
 class Maintain:
     """
     Title Placeholder
@@ -41,14 +40,13 @@ def __init__(self, plugin):
         """
         self.plugin = plugin
         self.pluginPrefs = plugin.pluginPrefs
+        self.my_logger = logging.getLogger("Plugin.Maintain")
 
-        fmt = '%(asctime)s.%(msecs)03d\t%(levelname)-10s\t%(name)s.%(funcName)-28s %(msg)s'
-        self.plugin.plugin_file_handler.setFormatter(logging.Formatter(fmt,
-                                                                       datefmt='%Y-%m-%d %H:%M:%S'
-                                                                       )
-                                                     )
+        # fmt = '%(asctime)s.%(msecs)03d\t%(levelname)-10s\t%(name)s.%(funcName)-28s %(msg)s'
+        # self.plugin.plugin_file_handler.setFormatter(logging.Formatter(fmt,datefmt='%Y-%m-%d %H:%M:%S'))
 
-        self.plugin.logger.threaddebug("Initializing maintenance framework.")
+        # my_logger.threaddebug("Initializing maintenance framework.")
+        self.my_logger.debug("Initializing maintenance framework.x")
 
     def clean_prefs(self, dev_name, prefs):
         """
@@ -361,9 +359,9 @@ def clean_prefs(self, dev_name, prefs):
 
         # Log list of removed keys
         if list_of_removed_keys:
-            self.plugin.logger.debug(
-                f"[{dev_name}] Performing maintenance - removing unneeded  keys: "
-                f"{list_of_removed_keys}")
+            self.my_logger.debug(
+                f"[{dev_name}] Performing maintenance - removing unneeded  keys: {list_of_removed_keys}"
+            )
 
         return prefs
 
@@ -375,7 +373,6 @@ def clean_props(self, dev):
 
         :return:
         """
-
         props = dev.pluginProps
 
         # ================================ All Devices ================================
@@ -423,9 +420,7 @@ def clean_props(self, dev):
                     ui_value = 'Manual'
                 else:
                     ui_value = " "
-                dev.updateStatesOnServer(
-                    [{'key': 'onOffState', 'value': True, 'uiValue': ui_value}]
-                )
+                dev.updateStatesOnServer([{'key': 'onOffState', 'value': True, 'uiValue': ui_value}])
 
             # ============================= Non-chart Devices =============================
             if dev.deviceTypeId in ('csvEngine', 'rcParamsDevice'):
@@ -437,7 +432,7 @@ def clean_props(self, dev):
             # If chartLastUpdated is empty, set it to the epoch
             if dev.deviceTypeId != 'csvEngine' and dev.states['chartLastUpdated'] == "":
                 dev.updateStateOnServer(key='chartLastUpdated', value='1970-01-01 00:00:00.000000')
-                self.plugin.logger.threaddebug("CSV last update unknown. Coercing update.")
+                self.my_logger.threaddebug("CSV last update unknown. Coercing update.")
 
             # =============================== Chart Devices ===============================
             elif dev.deviceTypeId not in ('csvEngine', 'rcParamsDevice'):
@@ -457,9 +452,7 @@ def clean_props(self, dev):
                     # For all chart device types
                     # Update legacy color values from hex to raw (#FFFFFF --> FF FF FF)
                     if re.search(r'^#(?:[0-9a-fA-F]{3}){1,2}$', str(props[prop])):
-                        self.plugin.logger.debug(
-                            f"[{dev.name}] Refactoring color property: ({prop})"
-                        )
+                        self.my_logger.debug(f"[{dev.name}] Refactoring color property: ({prop})")
                         props[prop] = f"{prop[0:3]} {prop[3:5]} {prop[5:7]}".replace('#', '')
 
                     # ============================== Fix Line Styles ==============================
@@ -470,9 +463,8 @@ def clean_props(self, dev):
                     # If unsupported style in dev props
                     if props[prop] in ('steps', 'steps-mid', 'steps-post'):
                         # Change style to `solid`
-                        self.plugin.logger.warning(
-                            f"Converting deprecated line style setting to solid line style for "
-                            f"device [{dev.name}]."
+                        self.my_logger.warning(
+                            f"Converting deprecated line style setting to solid line style for device [{dev.name}]."
                         )
                         props[prop] = '-'
 
@@ -486,7 +478,7 @@ def clean_props(self, dev):
                         if 'color' in prop.lower():
                             if props[prop] in ('#custom', 'custom'):
 
-                                self.plugin.logger.debug(
+                                self.my_logger.debug(
                                     "Resetting legacy device preferences for custom colors to new "
                                     "color picker.")
 
@@ -559,17 +551,15 @@ def clean_props(self, dev):
                 # =============== Establish Refresh Interval for Legacy Devices ===============
                 # Establish refresh interval for legacy devices. If the prop isn't present, we set it equal to the
                 # user's current global refresh rate.
-                # if 'refreshInterval' not in props.keys():
                 if 'refreshInterval' not in props:
-                    self.plugin.logger.debug(
-                        "Adding refresh interval to legacy device. Set to 900 seconds.")
+                    self.my_logger.debug("Adding refresh interval to legacy device. Set to 900 seconds.")
                     props['refreshInterval'] = self.pluginPrefs.get('refreshInterval', 900)
 
             # ============================= Update the Server =============================
             dev.replacePluginPropsOnServer(props)
 
             if self.plugin.pluginPrefs['verboseLogging']:
-                self.plugin.logger.threaddebug(f"[{dev.name}] prefs cleaned.")
+                self.my_logger.threaddebug(f"[{dev.name}] prefs cleaned.")
 
         except Exception as err:
             indigo.server.log(str(err), isError=True)
diff --git a/matplotlib.indigoPlugin/Contents/Server Plugin/plugin.py b/matplotlib.indigoPlugin/Contents/Server Plugin/plugin.py
diff --git a/matplotlib.indigoPlugin/Contents/Server Plugin/validate.py b/matplotlib.indigoPlugin/Contents/Server Plugin/validate.py
