Merge pull request #78 from raetha/devel

Various fixes from HclX and nabahr

Author: raetha

.github/workflows/build.yml

@@ -3,6 +3,12 @@ name: Publish to container registries
 on:
   release:
     types: [ "published" ]
+  push:
+    branches:
+      - devel
+  pull_request:
+    branches:
+      - devel
 
 jobs:
   ghcr-io:

.github/workflows/pull_request_description.yml

@@ -0,0 +1,25 @@
+on:
+  pull_request:
+
+jobs:
+  update_pr_description:
+    name: Update Pull Request Description
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    
+    # https://github.com/octue/generate-pull-request-description
+    # Use the lines below in the PR description to trigger
+    # <!--- START AUTOGENERATED NOTES --->
+    # <!--- END AUTOGENERATED NOTES ---
+    - uses: octue/generate-pull-request-description@1.0.0.beta-2
+      id: pr-description
+      with:
+        pull_request_url: ${{ github.event.pull_request.url }}
+        api_token: ${{ secrets.GITHUB_TOKEN }}
+    
+    - name: Update pull request body
+      uses: riskledger/update-pr-description@v2
+      with:
+        body: ${{ steps.pr-description.outputs.pull_request_description }}
+        token: ${{ secrets.GITHUB_TOKEN }}

readme.md

@@ -9,6 +9,8 @@
 
 Configurable WyzeSense to MQTT Gateway intended for use with Home Assistant or other platforms that use MQTT discovery mechanisms. The gateway allows direct local access to [Wyze Sense](https://wyze.com/wyze-sense.html) products without the need for a Wyze Cam or cloud services. This project and its dependencies have no relation to Wyze Labs Inc.
 
+Please submit pull requests against the devel branch.
+
 ## Special Thanks
 * [HcLX](https://hclxing.wordpress.com) for [WyzeSensePy](https://github.com/HclX/WyzeSensePy), the core library this project uses.
 * [Kevin Vincent](http://kevinvincent.me) for [HA-WyzeSense](https://github.com/kevinvincent/ha-wyzesense), the reference code I used to get things working right with the calls to WyzeSensePy.

wyzesense2mqtt/wyzesense.py

@@ -282,17 +282,20 @@ def _OnSensorAlarm(self, pkt):
                 sensor_type = sensor[type]
                 sensor_state = sensor["states"][state2]
             else:
-                sensor_type = "unknown (" + type + ")"
-                sensor_state = "unknown (" + state2 + ")"
+                sensor_type = f"unknown({type:02X})"
+                sensor_state = f"unknown({state2:02X})"
             e = SensorEvent(mac, timestamp, ("alarm" if event == 0xA2 else "status"), (sensor_type, sensor_state, battery, signal))
         elif event == 0xE8:
             type, b1, battery, b2, state1, state2, counter, signal = struct.unpack_from(">BBBBBBHB", data)
             if type == 0x03:
                 sensor_type = "leak:temperature"
                 sensor_state = "%d.%d" % (state1, state2)
-            e = SensorEvent(mac, timestamp, "state", (sensor_type, sensor_state, battery, signal))
+            else:
+                sensor_type = f"unknown({type:02X})"
+                sensor_state = f"unknown({state2:02X})"
+            e = SensorEvent(mac, timestamp, "status", (sensor_type, sensor_state, battery, signal))
         else:
-            e = SensorEvent(mac, timestamp, "%02X" % event, data)
+            e = SensorEvent(mac, timestamp, f"{event:02X}", data)
 
         self.__on_event(self, e)
 
@@ -322,6 +325,7 @@ def __init__(self, device, event_handler):
         self.__exit_event = threading.Event()
         self.__thread = threading.Thread(target=self._Worker)
         self.__on_event = event_handler
+        self.__last_exception = None
 
         self.__handlers = {
             Packet.NOTIFY_SYNC_TIME: self._OnSyncTime,
@@ -377,42 +381,46 @@ def _HandlePacket(self, pkt):
         handler(pkt)
 
     def _Worker(self):
-        s = b""
-        while True:
-            if self.__exit_event.isSet():
-                break
-
-            s += self._ReadRawHID()
-            # if s:
-            #     LOGGER.info("Incoming buffer: %s", bytes_to_hex(s))
-
-            # Look for the start of the next message, indicated by the magic bytes 0x55AA
-            start = s.find(b"\x55\xAA")
-            if start == -1:
-                time.sleep(0.1)
-                continue
-
-            # Found the start of the next message, ideally this would be at the beginning of the buffer
-            # but we could be tossing some bad data if a previous parse failed
-            s = s[start:]
-            LOGGER.debug("Trying to parse: %s", bytes_to_hex(s))
-            try:
-                pkt = Packet.Parse(s)
-                if not pkt:
-                    # Packet was invalid and couldn't be processed, remove the magic bytes and continue
-                    # looking for another start of message. This essentially tosses the bad message.
-                    LOGGER.error("Unable to parse message")
-                    s = s[2:]
+        try:
+            s = b""
+            while True:
+                if self.__exit_event.isSet():
+                    break
+
+                s += self._ReadRawHID()
+                # if s:
+                #     LOGGER.info("Incoming buffer: %s", bytes_to_hex(s))
+
+                # Look for the start of the next message, indicated by the magic bytes 0x55AA
+                start = s.find(b"\x55\xAA")
+                if start == -1:
+                    time.sleep(0.1)
+                    continue
+
+                # Found the start of the next message, ideally this would be at the beginning of the buffer
+                # but we could be tossing some bad data if a previous parse failed
+                s = s[start:]
+                LOGGER.debug("Trying to parse: %s", bytes_to_hex(s))
+                try:
+                    pkt = Packet.Parse(s)
+                    if not pkt:
+                        # Packet was invalid and couldn't be processed, remove the magic bytes and continue
+                        # looking for another start of message. This essentially tosses the bad message.
+                        LOGGER.error("Unable to parse message")
+                        s = s[2:]
+                        time.sleep(0.1)
+                        continue
+                except EOFError:
+                    # Not enough data to parse a packet, keep the partial packet for now
                     time.sleep(0.1)
                     continue
-            except EOFError:
-                # Not enough data to parse a packet, keep the partial packet for now
-                time.sleep(0.1)
-                continue
 
-            LOGGER.debug("Received: %s", bytes_to_hex(s[:pkt.Length]))
-            s = s[pkt.Length:]
-            self._HandlePacket(pkt)
+                LOGGER.debug("Received: %s", bytes_to_hex(s[:pkt.Length]))
+                s = s[pkt.Length:]
+                self._HandlePacket(pkt)
+        except Exception as e:
+            LOGGER.error("Error occured in dongle worker thread", exc_info=True)
+            self.__last_exception = e
 
     def _DoCommand(self, pkt, handler, timeout=_CMD_TIMEOUT):
         e = threading.Event()
@@ -547,6 +555,10 @@ def _Start(self):
     def List(self):
         sensors = self._GetSensors()
         return sensors
+    
+    def CheckError(self):
+        if self.__last_exception:
+            raise self.__last_exception
 
     def Stop(self, timeout=_CMD_TIMEOUT):
         self.__exit_event.set()

wyzesense2mqtt/wyzesense2mqtt.py

@@ -117,6 +117,7 @@ def init_config():
         CONFIG = read_yaml_file(os.path.join(SAMPLES_PATH, MAIN_CONFIG_FILE))
 
     # load user config over base
+    user_config = None
     if (os.path.isfile(os.path.join(CONFIG_PATH, MAIN_CONFIG_FILE))):
         user_config = read_yaml_file(os.path.join(CONFIG_PATH, MAIN_CONFIG_FILE))
         CONFIG.update(user_config)
@@ -127,7 +128,7 @@ def init_config():
         exit(1)
 
     # write updated config file if needed
-    if (CONFIG != user_config):
+    if (user_config is None or CONFIG != user_config):
         LOGGER.info("Writing updated config file")
         write_yaml_file(os.path.join(CONFIG_PATH, MAIN_CONFIG_FILE), CONFIG)
 
@@ -344,9 +345,11 @@ def delete_sensor_from_config(sensor_mac):
 # Publish MQTT topic
 def mqtt_publish(mqtt_topic, mqtt_payload, is_json=True, wait=True):
     global MQTT_CLIENT, CONFIG
+    payload = json.dumps(mqtt_payload) if is_json else mqtt_payload
+    LOGGER.debug(f"Publishing, {mqtt_topic=}, {payload=}")
     mqtt_message_info = MQTT_CLIENT.publish(
         mqtt_topic,
-        payload=(json.dumps(mqtt_payload) if is_json else mqtt_payload),
+        payload=payload,
         qos=CONFIG['mqtt_qos'],
         retain=CONFIG['mqtt_retain']
     )
@@ -670,6 +673,8 @@ def Stop():
         loop_counter = 0
         while True:
             time.sleep(5)
+            # Check if there is any exceptions in the dongle thread
+            WYZESENSE_DONGLE.CheckError()
 
             # Skip everything while dongle is offline, service needs to be restarted
             if dongle_offline:
@@ -715,6 +720,8 @@ def Stop():
                         LOGGER.warning(f"{mac} has gone offline!")
                         SENSORS_STATE[mac]['online'] = False
     except KeyboardInterrupt:
-        pass
+        LOGGER.warning("User interrupted")
+    except Exception as e:
+        LOGGER.error("An error occurred", exc_info=True)
     finally:
         Stop()