Add StripInfo

Author: maxnz

animatedledstrip/__init__.py

@@ -7,3 +7,4 @@
 from .global_vars import ANIMATION_DATA_PREFIX, ANIMATION_INFO_PREFIX, DELIMITER, \
     END_ANIMATION_PREFIX, SECTION_PREFIX, STRICT_TYPE_CHECKING, STRIP_INFO_PREFIX
 from .param_usage import ParamUsage
+from .strip_info import StripInfo

animatedledstrip/animation_info.py

@@ -46,7 +46,7 @@ def __init__(self):
         self.spacing_default: int = 3
 
     @classmethod
-    def from_json(cls, input_str: AnyStr):
+    def from_json(cls, input_str: AnyStr) -> 'AnimationInfo':
         """Create an AnimationInfo instance from a JSON representation"""
         # Parse the JSON
         input_json = json.loads(input_str[5:])

animatedledstrip/animation_sender.py

@@ -27,27 +27,27 @@
 from .animation_info import AnimationInfo
 from .end_animation import EndAnimation
 from .global_vars import *
+from .strip_info import StripInfo
 
 
 class AnimationSender(object):
     """Handles communications with the server"""
 
-    address: str
-    port: int
-    connection: 'socket.socket' = socket.socket()
-    connected: bool = False
-    recv_thread: Optional['Thread'] = None
-    running_animations: Dict[str, 'AnimationData'] = {}
-    supported_animations: List['AnimationInfo'] = []
-
-    receiveCallback: Optional[Callable[[bytes], Any]] = None
-    newAnimationDataCallback: Optional[Callable[['AnimationData'], Any]] = None
-    newAnimationInfoCallback: Optional[Callable[['AnimationInfo'], Any]] = None
-    newEndAnimationCallback: Optional[Callable[['EndAnimation'], Any]] = None
-
     def __init__(self, ip_address: str, port_num: int):
         self.address: str = ip_address
         self.port: int = port_num
+        self.connection: 'socket.socket' = socket.socket()
+        self.connected: bool = False
+        self.recv_thread: Optional['Thread'] = None
+        self.running_animations: Dict[str, 'AnimationData'] = {}
+        self.stripInfo: Optional['StripInfo'] = None
+        self.supported_animations: List['AnimationInfo'] = []
+
+        self.receiveCallback: Optional[Callable[[bytes], Any]] = None
+        self.newAnimationDataCallback: Optional[Callable[['AnimationData'], Any]] = None
+        self.newAnimationInfoCallback: Optional[Callable[['AnimationInfo'], Any]] = None
+        self.newEndAnimationCallback: Optional[Callable[['EndAnimation'], Any]] = None
+        self.newStripInfoCallback: Optional[Callable[['StripInfo'], Any]] = None
 
     def start(self) -> 'AnimationSender':
         """Connect to the server"""
@@ -71,6 +71,8 @@ def end(self) -> 'AnimationSender':
         # Connection has been closed, so set connected = False
         self.connected = False
 
+        self.stripInfo = None
+
         # If the separate thread for receiving animations was started, join it with the main thread.
         # The loop should stop because the connection is closed and connected is False,
         #  allowing it to return
@@ -142,7 +144,14 @@ def parse_data(self):
                     pass  # TODO
 
                 elif split_input.startswith(STRIP_INFO_PREFIX):
-                    pass  # TODO
+                    # Create the StripInfo instance
+                    info = StripInfo.from_json(split_input)
+
+                    self.stripInfo = info
+
+                    # Call callback
+                    if self.newStripInfoCallback:
+                        self.newStripInfoCallback(info)
 
                 else:
                     logging.warning('Unrecognized data type: {} ({})'.format(split_input[:4], split_input))

animatedledstrip/strip_info.py

@@ -0,0 +1,71 @@
+#   Copyright (c) 2019-2020 AnimatedLEDStrip
+#
+#   Permission is hereby granted, free of charge, to any person obtaining a copy
+#   of this software and associated documentation files (the "Software"), to deal
+#   in the Software without restriction, including without limitation the rights
+#   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+#   copies of the Software, and to permit persons to whom the Software is
+#   furnished to do so, subject to the following conditions:
+#
+#   The above copyright notice and this permission notice shall be included in
+#   all copies or substantial portions of the Software.
+#
+#   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+#   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+#   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+#   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+#   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+#   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+#   THE SOFTWARE.
+
+import json
+from typing import AnyStr, Optional
+
+from .utils import check_data_type
+
+
+class StripInfo(object):
+    """Stores information about a LED strip"""
+
+    def __init__(self):
+        self.num_leds: int = 0
+        self.pin: Optional[int] = None
+        self.image_debugging: bool = False
+        self.file_name: Optional[str] = None
+        self.renders_before_save: Optional[int] = None
+        self.thread_count: int = 100
+
+    @classmethod
+    def from_json(cls, input_str: AnyStr) -> 'StripInfo':
+        """Create an StripInfo instance from a JSON representation"""
+        # Parse the JSON
+        input_json = json.loads(input_str[5:])
+
+        # Create a new StripInfo instance
+        new_instance = cls()
+
+        # Get each property from the JSON, reverting to defaults if it can't be found
+        new_instance.num_leds = input_json.get('numLEDs', new_instance.num_leds)
+        new_instance.pin = input_json.get('pin', new_instance.pin)
+        new_instance.image_debugging = input_json.get('imageDebugging', new_instance.image_debugging)
+        new_instance.file_name = input_json.get('fileName', new_instance.file_name)
+        new_instance.renders_before_save = input_json.get('rendersBeforeSave', new_instance.renders_before_save)
+        new_instance.thread_count = input_json.get('threadCount', new_instance.thread_count)
+
+        # Double check that everything has the right data type
+        new_instance.check_data_types()
+
+        return new_instance
+
+    def check_data_types(self) -> bool:
+        """Check that all parameter types are correct"""
+        good_types = True
+
+        good_types = good_types and check_data_type('num_leds', self.num_leds, int)
+        good_types = good_types and check_data_type('pin', self.pin, int, allow_none=True)
+        good_types = good_types and check_data_type('image_debugging', self.image_debugging, bool)
+        good_types = good_types and check_data_type('file_name', self.file_name, str, allow_none=True)
+        good_types = good_types and check_data_type('renders_before_save', self.renders_before_save, int, allow_none=True)
+        good_types = good_types and check_data_type('thread_count', self.thread_count, int)
+
+        return good_types

get_raw.py

@@ -1,4 +1,4 @@
-from led_client import AnimationSender
+from animatedledstrip import AnimationSender
 
 
 sender = AnimationSender("10.0.0.55", 6)