From 87fd4b42f5bccc6c53b4183bb4740c9e5ae8ed3d Mon Sep 17 00:00:00 2001
From: zvecr <git@zvecr.com>
Date: Tue, 29 Aug 2023 02:36:21 +0100
Subject: [PATCH] Tidy up broadcast in python client

---
 data/templates/xap/client/python/types.py.j2 |  1 +
 data/xap/xap_0.1.0.hjson                     |  2 +-
 lib/python/xap_client/device.py              |  6 +++---
 lib/python/xap_client/types.py               | 14 ++++++++++++++
 4 files changed, 19 insertions(+), 4 deletions(-)

diff --git a/data/templates/xap/client/python/types.py.j2 b/data/templates/xap/client/python/types.py.j2
index 76f9614e4e3..477121981ef 100644
--- a/data/templates/xap/client/python/types.py.j2
+++ b/data/templates/xap/client/python/types.py.j2
@@ -25,6 +25,7 @@ class {{ name }}(namedtuple('{{ name }}', '{{ members }}')):
 {% set type_definitions = [
   {'name':'XAPRequest', 'members': 'token length data', 'fmt':'<HB61s'},
   {'name':'XAPResponse', 'members': 'token flags length data', 'fmt':'<HBB60s'},
+  {'name':'XAPBroadcast', 'members': 'token event length data', 'fmt':'<HBB60s'},
   {'name':'XAPConfigBacklight', 'members': 'enable mode val', 'fmt':'<BBB'},
   {'name':'XAPConfigRgblight', 'members': 'enable mode hue sat val speed', 'fmt':'<BBBBBB'},
   {'name':'XAPConfigRgbMatrix', 'members': 'enable mode hue sat val speed flags', 'fmt':'<BBBBBBB'}
diff --git a/data/xap/xap_0.1.0.hjson b/data/xap/xap_0.1.0.hjson
index 749b9ccc414..45402c48614 100755
--- a/data/xap/xap_0.1.0.hjson
+++ b/data/xap/xap_0.1.0.hjson
@@ -40,7 +40,7 @@
     type_docs: {
         bool:
             '''
-            Data type that contains values 0 and 1. Implementaed as an alias of `u8`.
+            Data type that contains values 0 and 1. Implemented as an alias of `u8`.
             '''
         u64:
             '''
diff --git a/lib/python/xap_client/device.py b/lib/python/xap_client/device.py
index 19936cbfd30..c1ce9f477ca 100644
--- a/lib/python/xap_client/device.py
+++ b/lib/python/xap_client/device.py
@@ -10,7 +10,7 @@ from typing import Optional
 from struct import pack, unpack
 from platform import platform
 
-from .types import XAPSecureStatus, XAPFlags, XAPRequest, XAPResponse
+from .types import XAPSecureStatus, XAPFlags, XAPRequest, XAPResponse, XAPBroadcast
 from .routes import XAPRoutes, XAPRouteError
 
 
@@ -116,8 +116,8 @@ class XAPDeviceBase:
         while not hasattr(event, '_ret'):
             event.wait(timeout=0.25)
 
-        r = XAPResponse.from_bytes(event._ret)
-        return (r.flags, r.data[:r.length])
+        r = XAPBroadcast.from_bytes(event._ret)
+        return (r.event, r.data[:r.length])
 
 
 class XAPDevice(XAPDeviceBase):
diff --git a/lib/python/xap_client/types.py b/lib/python/xap_client/types.py
index ce75cebab9f..43b80e38a8a 100644
--- a/lib/python/xap_client/types.py
+++ b/lib/python/xap_client/types.py
@@ -59,6 +59,20 @@ class XAPResponse(namedtuple('XAPResponse', 'token flags length data')):
         return self.fmt.pack(*list(self))
 
 
+class XAPBroadcast(namedtuple('XAPBroadcast', 'token event length data')):
+    fmt = Struct('<HBB60s')
+
+    def __new__(cls, *args):
+        return super().__new__(cls, *args)
+
+    @classmethod
+    def from_bytes(cls, data):
+        return cls._make(cls.fmt.unpack(data))
+
+    def to_bytes(self):
+        return self.fmt.pack(*list(self))
+
+
 class XAPConfigBacklight(namedtuple('XAPConfigBacklight', 'enable mode val')):
     fmt = Struct('<BBB')