added loading and saving profiles, .pack to dataclasses, updated example

Author: jath03

.gitignore

@@ -7,3 +7,4 @@ dist
 _build
 _static
 _templates
+_test.py

README.md

@@ -15,7 +15,9 @@ SDK Feature Support:
   - [x] Setting color by led
   - [x] Setting mode
   - [x] Setting custom mode
-  - [ ] resizing zones
+  - [ ] Resizing zones
+  - [x] Loading profiles
+  - [x] Saving profiles
 
 # Installation
 
@@ -45,6 +47,7 @@ motherboard.set_color(RGBColor(0, 255, 0))
 motherboard.zones[0].set_color(RGBColor(255, 0, 0))
 motherboard.zones[1].leds[0].set_color(RGBColor.fromHSV(0, 100, 100))
 motherboard.set_mode("breathing")
+client.save_profile("profile1")
 ```
 
 # API docs

docs/intro.md

@@ -15,6 +15,8 @@ SDK Feature Support:
   - [x] Setting mode
   - [x] Setting custom mode
   - [ ] resizing zones
+  - [x] Loading profiles
+  - [x] Saving profiles
 
 # Installation
 
@@ -44,6 +46,7 @@ motherboard.set_color(RGBColor(0, 255, 0))
 motherboard.zones[0].set_color(RGBColor(255, 0, 0))
 motherboard.zones[1].leds[0].set_color(RGBColor.fromHSV(0, 100, 100))
 motherboard.set_mode("breathing")
+client.save_profile("profile1")
 ```
 
 

examples/temperature/requirements.txt

@@ -1,3 +1,3 @@
 pysensors
-nvidia-ml-py3
+py3nvml
 psutil

examples/temperature/temperature.py

@@ -3,7 +3,7 @@
 from openrgb.utils import RGBColor, DeviceType
 import sensors
 from time import sleep
-from pynvml import nvmlInit, nvmlDeviceGetHandleByIndex, nvmlDeviceGetTemperature, NVML_TEMPERATURE_GPU
+from py3nvml.py3nvml import nvmlInit, nvmlDeviceGetHandleByIndex, nvmlDeviceGetTemperature, NVML_TEMPERATURE_GPU
 # import psutil
 
 

openrgb/network.py

@@ -13,6 +13,12 @@ class NetworkClient(object):
     '''
 
     def __init__(self, update_callback: Callable, address: str = "127.0.0.1", port: int = 1337, name: str = "openrgb-python"):
+        '''
+        :param update_callback: the function to call when data is received
+        :param address: the ip address of the SDK server
+        :param port: the port of the SDK server
+        :param name: the string that will be displayed on the OpenRGB SDK tab's list of clients
+        '''
         self.sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
         for x in range(5):
             try:

openrgb/orgb.py

@@ -5,6 +5,7 @@
 from openrgb.network import NetworkClient
 # from dataclasses import dataclass
 from time import sleep
+from os import environ
 
 
 class LED(utils.RGBObject):
@@ -60,6 +61,7 @@ def set_color(self, color: utils.RGBColor, start: int = 0, end: int = 0):
         buff = struct.pack("IH", self.id, end - start) + (color.pack())*(end - start)
         buff = struct.pack("I", len(buff)) + buff
         self.comms.sock.send(buff)
+        self.comms.requestDeviceData(self.device_id)
 
     def set_colors(self, colors: List[utils.RGBColor], start: int = 0, end: int = 0):
         '''
@@ -77,6 +79,10 @@ def set_colors(self, colors: List[utils.RGBColor], start: int = 0, end: int = 0)
         buff = struct.pack("IH", self.id, end - start) + b''.join((color.pack() for color in colors))
         buff = struct.pack("I", len(buff)) + buff
         self.comms.sock.send(buff)
+        self.comms.requestDeviceData(self.device_id)
+
+    def update_device_colors(self):
+        pass
 
 
 class Device(utils.RGBObject):
@@ -93,6 +99,7 @@ def __init__(self, data: utils.ControllerData, device_id: int, network_client: N
         self.modes = data.modes
         self.colors = data.colors
         self.active_mode = data.active_mode
+        self.data = data
         self.id = device_id
         self.comms = network_client
 
@@ -114,6 +121,7 @@ def set_color(self, color: utils.RGBColor, start: int = 0, end: int = 0):
         buff = struct.pack("H", end - start) + (color.pack())*(end - start)
         buff = struct.pack("I", len(buff)) + buff
         self.comms.sock.send(buff)
+        self.comms.requestDeviceData(self.id)
 
     def set_colors(self, colors: List[utils.RGBColor], start: int = 0, end: int = 0):
         '''
@@ -135,6 +143,7 @@ def set_colors(self, colors: List[utils.RGBColor], start: int = 0, end: int = 0)
         buff = struct.pack("H", end - start) + b''.join((color.pack() for color in colors))
         buff = struct.pack("I", len(buff)) + buff
         self.comms.sock.send(buff)
+        self.comms.requestDeviceData(self.id)
 
     def set_mode(self, mode: Union[int, str, utils.ModeData]):
         '''
@@ -148,14 +157,16 @@ def set_mode(self, mode: Union[int, str, utils.ModeData]):
             mode = self.modes[mode]
         elif type(mode) == str:
             mode = next((m for m in self.modes if m.name.lower() == mode.lower()))
-        # print(mode)
-        size, data = mode.pack()
+        data = mode.pack()
         self.comms.send_header(
             self.id,
             utils.PacketType.NET_PACKET_ID_RGBCONTROLLER_UPDATEMODE,
-            size
+            len(data)
         )
         self.comms.sock.send(data)
+        self.active_mode = mode.id
+        if len(mode.colors) == len(self.colors):
+            self.colors = mode.colors
 
     def set_custom_mode(self):
         self.comms.send_header(
@@ -187,8 +198,7 @@ def __init__(self, address: str = "127.0.0.1", port: int = 1337, name: str = "op
         while self.device_num == 0:
             sleep(.2)
         self.devices = [None for x in range(self.device_num)]
-        for x in range(self.device_num):
-            self.comms.requestDeviceData(x)
+        self.get_device_info()
         while any((dev is None for dev in self.devices)):
             sleep(.2)
         if custom:
@@ -205,7 +215,7 @@ def _callback(self, device: int, type: int, data):
             if self.devices[device] is None:
                 self.devices[device] = Device(data, device, self.comms)
             else:
-                self.devices[device].data = data
+                self.devices[device].__init__(data, device, self.comms)
 
     def set_color(self, color: utils.RGBColor):
         '''
@@ -223,3 +233,70 @@ def get_devices_by_type(self, type: utils.DeviceType) -> List[Device]:
         :param type: what type of device you want to get
         '''
         return [device for device in self.devices if device.type == type]
+
+    def load_profile(self, name: str, directory: str):
+        '''
+        Loads an OpenRGB profile file
+
+        :param name: the name of the profile
+        :param directory: what directory the profile is in.  Defaults to HOME/.config/OpenRGB
+        '''
+        if directory == None:
+            directory = environ['HOME'].rstrip("/") + "/.config/OpenRGB"
+        with open(f'{directory}/{name}.orp', 'rb') as f:
+            header = f.read(16 + struct.calcsize("I"))
+            if struct.unpack("16s", header[:16])[0] != b"OPENRGB_PROFILE\x00":
+                raise ValueError("The file is not an OpenRGB profile")
+            version = struct.unpack("I", header[16:])[0]
+            if version == 1:
+                controllers = []
+                while True:
+                    d = f.read(struct.calcsize("I"))
+                    if len(d) < struct.calcsize("I"):
+                        break
+                    size = struct.unpack("I", d)[0]
+                    f.seek(f.tell() - struct.calcsize("I"))
+                    new_data = utils.ControllerData.unpack(f.read(size))
+                    controllers.append(new_data)
+                pairs = []
+                for device in self.devices:
+                    for new_controller in controllers:
+                        if new_controller.name == device.name \
+                                and new_controller.device_type == device.type \
+                                and new_controller.metadata.description == device.metadata.description:
+                            controllers.remove(new_controller)
+                            pairs.append((new_controller, device))
+                # print("Pairs:")
+                for new_controller, device in pairs:
+                    # print(device.name, new_controller.name)
+                    if new_controller.colors != device.colors:
+                        device.set_colors(new_controller.colors)
+                    # print(new_controller.active_mode)
+                    if new_controller.active_mode != device.active_mode:
+                        device.set_mode(new_controller.active_mode)
+
+    def save_profile(self, name: str, directory: str):
+        '''
+        Saves the current state of all of your devices to an OpenRGB profile
+        file
+
+        :param name: the name of the profile to save
+        :param directory: what directory to save the profile in.  Defaults to HOME/.config/OpenRGB
+        '''
+        if directory == None:
+            directory = environ['HOME'].rstrip("/") + "/.config/OpenRGB"
+        with open(f'{directory.rstrip("/")}/{name}.orp', 'wb') as f:
+            data = bytearray()
+            data += struct.pack("16sI", b'OPENRGB_PROFILE\x00', 1)
+            for dev in self.devices:
+                data += dev.data.pack()
+            f.write(data)
+
+    def get_device_info(self):
+        '''
+        Gets the current state of your devices from the SDK server.  Useful if
+        you change something from the gui or another SDK client and need to
+        sync up the changes.
+        '''
+        for x in range(self.device_num):
+            self.comms.requestDeviceData(x)