Continue OVOS migration

skill_mm_wakeword/__init__.py

@@ -1,3 +1,5 @@
+"""Open Voice OS and MagicMirror skill integration"""
+
 import json
 import requests
 
@@ -7,25 +9,48 @@
 
 
 class MagicMirrorWakeWord(OVOSSkill):
+    """This is the place where all the magic happens for the MagicMirror
+    wake word skill.
+    """
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
 
-        self.configured = False
+        # Initialize variables with empty or None values.
         self.headers = {}
+
+        # Make sure skill is configured when loaded.
         self.setup()
 
+    def http_endpoint(self, payload):
+        """Handle HTTP request to the MagicMirror endpoint."""
+        try:
+            requests.post(
+                url=self.settings.get("url") + "/ovos",
+                data=json.dumps(payload),
+                headers=self.headers,
+                verify=self.settings.get("verify", False),
+                timeout=self.settings.get("timeout", 10),
+            )
+        except requests.exceptions.RequestException as err:
+            LOG.error(err)
+
     def setup(self):
+        """Check for settings requirements and prepare HTTP headers once
+        configured."""
+
         if not self.settings.get("url") or not self.settings.get("key"):
             self.speak_dialog("error_setup", data={"fields": "address or key"})
             LOG.warning("MagicMirror address or API key not defined")
         else:
-            self.configured = True
             self.headers["Content-Type"] = "application/json"
             self.headers["X-Api-Key"] = self.settings.get("key")
             LOG.info("MagicMirror address: %s", self.settings.get("url"))
 
     def initialize(self):
+        """The initialize method is called after the Skill is fully
+        constructed and registered with the system.
+        """
         self.add_event("recognizer_loop:record_begin", self.handle_listener_started)
         self.add_event("recognizer_loop:record_end", self.handle_listener_ended)
 
@@ -34,29 +59,11 @@ def handle_listener_started(
     ):  # pylint: disable=unused-argument
         """Handle the record_begin event detection."""
         payload = {"notification": "OVOS_SEND_MESSAGE", "payload": "Listening"}
-        try:
-            requests.post(
-                url=self.settings.get("url") + "/ovos",
-                data=json.dumps(payload),
-                headers=self.headers,
-                verify=self.settings.get("verify", False),
-                timeout=self.settings.get("timeout", 10),
-            )
-        except requests.exceptions.RequestException as err:
-            LOG.error(err)
+        self.http_endpoint(payload)
 
     def handle_listener_ended(
         self, message: Message
     ):  # pylint: disable=unused-argument
         """Handle the record_end event detection."""
         payload = {"notification": "OVOS_DELETE_MESSAGE", "payload": "delete"}
-        try:
-            requests.post(
-                url=self.settings.get("url") + "/ovos",
-                data=json.dumps(payload),
-                headers=self.headers,
-                verify=self.settings.get("verify", False),
-                timeout=self.settings.get("timeout", 10),
-            )
-        except requests.exceptions.RequestException as err:
-            LOG.error(err)
+        self.http_endpoint(payload)