Merged branch segments_testing

Author: jath03

openrgb/network.py

@@ -6,7 +6,7 @@
 from openrgb import utils
 from typing import Callable
 
-OPENRGB_PROTOCOL_VERSION = 3
+OPENRGB_PROTOCOL_VERSION = 4
 
 if platform.system() == "Linux":
     NOSIGNAL: int = socket.MSG_NOSIGNAL

openrgb/orgb.py

@@ -42,13 +42,43 @@ def set_color(self, color: utils.RGBColor, fast: bool = False):
             self.update()
 
 
+class Segment(utils.RGBContainer):
+    '''
+    A class to represent a segment
+    '''
+
+    def __init__(self, data: utils.SegmentData, id: int, parent: Zone):
+        self.leds = [None for _ in range(data.leds_count)]
+        self.id = id
+        self.parent_zone = parent
+        self._update(data)
+
+    def _update(self, data: utils.SegmentData):
+        self.name = data.name
+        self.type = data.segment_type
+        self.start_idx = data.start_idx
+        self.leds_count = data.leds_count
+        self.leds = self.parent_zone.leds[data.start_idx:data.start_idx + data.leds_count]
+
+    def set_color(self, color: utils.RGBColor, fast: bool = False):
+        self.set_colors([color] * self.leds_count, fast)
+
+    def set_colors(self, colors: list[utils.RGBColor], fast: bool = False):
+        new_colors = self.parent_zone.colors[:self.start_idx] + colors + self.parent_zone.colors[self.start_idx + self.leds_count:]
+        self.parent_zone.set_colors(new_colors, fast)
+
+
 class Zone(utils.RGBContainer):
     '''
     A class to represent a zone
     '''
 
     def __init__(self, data: utils.ZoneData, zone_id: int, device_id: int, network_client: NetworkClient):
         self.leds = [None for led in data.leds]
+        try:
+            self.segments = [None for _ in data.segments]
+        except TypeError:
+            self.segments = None
         self.device_id = device_id
         self.comms = network_client
         self.id = zone_id
@@ -65,6 +95,12 @@ def _update(self, data: utils.ZoneData):
                                    data.start_idx + x, self.device_id, self.comms)
             else:
                 self.leds[x]._update(data.leds[x], data.colors[x])
+        if self.segments:
+            for x in range(len(data.segments)):
+                if self.segments[x] is None:
+                    self.segments[x] = Segment(data.segments[x], x, self)
+                else:
+                    self.segments[x]._update(data.segments[x])
         self.mat_width = data.mat_width
         self.mat_height = data.mat_height
         self.matrix_map = data.matrix_map

openrgb/utils.py

@@ -219,7 +219,6 @@ def unpack(cls, data: Iterator[int], version: int, *args) -> LEDData:
         Creates a new LEDData object from raw bytes
 
         :param data: the raw bytes from the SDK
-        :param start: what place in the data object to start
         '''
         name = parse_string(data)
         value = parse_var('I', data)
@@ -304,7 +303,6 @@ def unpack(cls, data: Iterator[int], version: int, index: int = 0) -> ModeData:
         Creates a new ModeData object from raw bytes
 
         :param data: the raw bytes from the SDK
-        :param start: what place in the data object to start
         :param index: which mode this is
         '''
         name = parse_string(data)
@@ -369,6 +367,42 @@ def unpack(cls, data: Iterator[int], version: int, index: int = 0) -> ModeData:
         )
 
 
+@dataclass
+class SegmentData:
+    name: str
+    segment_type: ZoneType
+    start_idx: int
+    leds_count: int
+
+    def pack(self, version: int) -> bytes:
+        '''
+        Packs itself into a bytes ready to be sent to the SDK or saved in a profile
+
+        :returns: raw data ready to be sent or saved
+        '''
+        data = pack_string(self.name)
+        data += struct.pack("iII", self.segment_type, self.start_idx, self.leds_count)
+        return data
+
+    @classmethod
+    def unpack(cls, data: Iterator[int], version: int, *args) -> SegmentData:
+        '''
+        Unpacks the raw data into a SegmentData object
+
+        :param data: The raw byte data to unpack
+        '''
+        name = parse_string(data)
+        segment_type = ZoneType(parse_var("i", data))
+        start_idx = parse_var("I", data)
+        leds_count = parse_var("I", data)
+        return cls(
+            name,
+            segment_type,
+            start_idx,
+            leds_count
+        )
+
+
 @dataclass
 class ZoneData:
     name: str
@@ -379,6 +413,7 @@ class ZoneData:
     mat_height: Optional[int]
     mat_width: Optional[int]
     matrix_map: Optional[list[list[Optional[int]]]] = None
+    segments: Optional[list[SegmentData]] = None
     leds: list[LEDData] = field(default_factory=list)
     colors: list[RGBColor] = field(default_factory=list)
     start_idx: int = 0
@@ -411,6 +446,9 @@ def pack(self, version: int) -> bytes:
             )
         else:
             data += struct.pack("H", 0)
+
+        if version >= 4:
+            data += pack_list(self.segments, version)
         return data
 
     @classmethod
@@ -419,7 +457,6 @@ def unpack(cls, data: Iterator[int], version: int, *args) -> ZoneData:
         Unpacks the raw data into a ZoneData object
 
         :param data: The raw byte data to unpack
-        :param start: What place in the data object to start
         '''
         name = parse_string(data)
         zone_type = ZoneType(parse_var('i', data))
@@ -439,6 +476,11 @@ def unpack(cls, data: Iterator[int], version: int, *args) -> ZoneData:
         else:
             height, width = None, None
             matrix = None  # type: ignore
+
+        if version >= 4:
+            segments = parse_list(SegmentData, data, version)
+        else:
+            segments = None
         return cls(
             name,
             zone_type,
@@ -447,7 +489,8 @@ def unpack(cls, data: Iterator[int], version: int, *args) -> ZoneData:
             num_leds,
             height,
             width,
-            matrix
+            matrix,
+            segments
         )
 
 
@@ -481,7 +524,6 @@ def unpack(cls, data: Iterator[int], version: int, *args) -> MetaData:
         Unpacks the raw data into a MetaData object
 
         :param data: The raw byte data to unpack
-        :param start: What place in the data object to start
         '''
         if version >= 1:
             vendor: Optional[str] = parse_string(data)