Fix/20 subnets

.github/workflows/run tests.yml

@@ -0,0 +1,16 @@
+name: Run tests
+on: [pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@master
+    - name: Set up Python 3.6
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.6
+
+    - name: Run test
+      run: python -m unittest discover --v

setup.py

@@ -5,7 +5,7 @@
 
 setup(name='stupidArtnet',
       author='cpvalente',
-      version='1.1.2',
+      version='1.2.0',
       license='MIT',
       description='(Very) Simple implementation of the Art-Net protocol',
       long_description=long_description,

stupidArtnet/ArtnetUtils.py

@@ -16,8 +16,37 @@ def shift_this(number, high_first=True):
     return((low, high))
 
 
+def clamp(number, min_val, max_val):
+    """Utility method: sets number in defined range.
+
+    Args:
+    number - number to use
+    range_min - lowest possible number
+    range_max - highest possible number
+
+    Returns:
+    number - number in correct range
+    """
+    return max(min_val, min(number, max_val))
+
+
+def set_even(number):
+    """Utility method: ensures number is even by adding.
+
+    Args:
+    number - number to make even
+
+    Returns:
+    number - even number
+    """
+    if number % 2 != 0:
+        number += 1
+    return number
+
+
 def put_in_range(number, range_min, range_max, make_even=True):
     """Utility method: sets number in defined range.
+    DEPRECATED: this will be removed from the library
 
     Args:
     number - number to use
@@ -29,9 +58,9 @@ def put_in_range(number, range_min, range_max, make_even=True):
     number - number in correct range
 
     """
-    number = max(range_min, min(number, range_max))
-    if (make_even and number % 2 != 0):
-        number += 1
+    number = clamp(number, range_min, range_max)
+    if make_even:
+        number = set_even(number)
     return number
 
 
@@ -53,17 +82,17 @@ def make_address_mask(universe, sub=0, net=0, is_simplified=True):
 
     if is_simplified:
         # Ensure data is in right range
-        universe = max(0, min(universe, 15))
+        universe = clamp(universe, 0, 32767)
 
         # Make mask
-        a = shift_this(universe)  # convert to MSB / LSB
-        address_mask.append(a[1])
-        address_mask.append(a[0])
+        msb, lsb = shift_this(universe)  # convert to MSB / LSB
+        address_mask.append(lsb)
+        address_mask.append(msb)
     else:
         # Ensure data is in right range
-        universe = max(0, min(universe, 15))
-        sub = max(0, min(sub, 15))
-        net = max(0, min(sub, 127))
+        universe = clamp(universe, 0, 15)
+        sub = clamp(sub, 0, 15)
+        net = clamp(net, 0, 127)
 
         # Make mask
         address_mask.append(sub << 4 | universe)

stupidArtnet/StupidArtnetServer.py

@@ -127,6 +127,8 @@ def get_buffer(self, listener_id):
         for listener in self.listeners:
             if listener.get('id') == listener_id:
                 return listener.get('buffer')
+        print("Buffer object not found")
+        return []
 
     def clear_buffer(self, listener_id):
         """Clear buffer in listener."""

tests/test_utils.py

@@ -47,18 +47,51 @@ def test_range(self):
         return True
 
     def test_mask(self):
-        """Test mask."""
-        # send universe 8, simplified
+        """Test mask and assert simplified mode."""
         self.assertEqual(make_address_mask(8), b'\x08\x00')
+        self.assertEqual(make_address_mask(8, 0, 0, False), b'\x08\x00')
 
-        # send universe 8, simplified
-        self.assertEqual(make_address_mask(8), b'\x08\x00')
+        self.assertEqual(make_address_mask(15), b'\x0f\x00')
+        self.assertEqual(make_address_mask(15, 0, 0, False),  b'\x0f\x00')
+
+        self.assertEqual(make_address_mask(16), b'\x10\x00')
+        self.assertEqual(make_address_mask(0, 1, 0, False),  b'\x10\x00')
+
+        self.assertEqual(make_address_mask(17), b'\x11\x00')
+        self.assertEqual(make_address_mask(1, 1, 0, False),  b'\x11\x00')
+
+        self.assertEqual(make_address_mask(18), b'\x12\x00')
+        self.assertEqual(make_address_mask(2, 1, 0, False),  b'\x12\x00')
+        self.assertEqual(2 + 1 * 16, 18)
+
+        self.assertEqual(make_address_mask(99), b'c\x00')
+        self.assertEqual(make_address_mask(3, 6, 0, False),  b'c\x00')
+        self.assertEqual(3 + 6 * 16, 99)
+
+        self.assertEqual(make_address_mask(255), b'\xff\x00')
+        self.assertEqual(make_address_mask(15, 15, 0, False),  b'\xff\x00')
+        self.assertEqual(15 + 15 * 16, 255)
+
+        self.assertEqual(make_address_mask(256), b'\x00\x01')
+        self.assertEqual(make_address_mask(0, 0, 1, False), b'\x00\x01')
+
+        self.assertEqual(make_address_mask(257), b'\x01\x01')
+        self.assertEqual(make_address_mask(1, 0, 1, False), b'\x01\x01')
+
+        # with nets, it becomes difficult
+        # to use the straight universe number
+        self.assertEqual(make_address_mask(25736), b'\x88d')
+        self.assertEqual(make_address_mask(8, 8, 100, False), b'\x88d')
 
-        # send universe 17, simplified
-        self.assertEqual(make_address_mask(17), b'\x0f\x00')
+        # Test clamp min
+        self.assertEqual(make_address_mask(0), b'\x00\x00')
+        self.assertEqual(make_address_mask(-15), b'\x00\x00')
 
-        # send universe 8, sub 8, net 100
-        self.assertEqual(make_address_mask(8, 8, 100, False), b'\x88\x08')
+        # Test clamp max
+        self.assertEqual(make_address_mask(32767), b'\xff\x7f')
+        self.assertEqual(make_address_mask(15, 15, 256, False), b'\xff\x7f')
+        self.assertEqual(make_address_mask(999999), b'\xff\x7f')
+        self.assertEqual(make_address_mask(99, 99, 300, False), b'\xff\x7f')
 
         return True