vsslctrl 0.1.2.dev1__tar.gz → 0.1.4.dev1__tar.gz

{vsslctrl-0.1.2.dev1 → vsslctrl-0.1.4.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vsslctrl
-Version: 0.1.2.dev1
+Version: 0.1.4.dev1
 Summary: Package for controlling VSSL amplifiers
 Author-email: vsslctrl <vsslcontrolled@proton.me>
 Classifier: Development Status :: 4 - Beta
@@ -28,37 +28,43 @@ Requires-Dist: zeroconf==0.132.2; extra == "optional"
 
  I am looking for testers with any VSSL amplifier models, please get in touch if you interested in helping.
 
- Only tested on VSSL **A.3x** software version **p15305.016.3701**.
+Important
+-----------
+Only tested on a VSSL **A.3x** software version **p15305.016.3701**.
+
+**Warning:** no *[VSSL Agent](https://vssl.gitbook.io/vssl-rest-api/getting-started/start)* should be running on the same network. If you dont know what this is, then you can probably ignore this notice.
 
 ## TODOs
 
 * Test on other models (hardware needed)
 * Home Assistant integration. In progress, [here](https://github.com/vsslctrl/integration.home-assistant)
-* Function scoping to supported feature / models
+* ~~Function scoping to supported feature / models~~ (needs tests)
 * Better test coverage
 
-Important
------------
-**Warning:** no *[VSSL Agent](https://vssl.gitbook.io/vssl-rest-api/getting-started/start)* should be running on the same network. If you dont know what this is, then you can probably ignore this notice.
-
-
 Basic Usage
 -----------
 `vsslctrl` needs to be running inside a **[asyncio](https://docs.python.org/3/library/asyncio.html)** event loop.
 
 ```python
 import asyncio
-from vsslctrl import Vssl, Zone
+from vsslctrl import Vssl, DeviceModels, Zone, ZoneIDs
 
 async def main():
 	
 	# Represents a physical VSSL amplifier
 	vssl = Vssl()
 
+  """Optional to init Vssl with a device model
+
+    vssl = Vssl(DeviceModels.A3X)
+
+    If no DeviceModels is passed, vsslctrl will default to the feature set of the X series amps
+  """
+
 	# Add each you wish to control
-	zone1 = vssl.add_zone(Zone.IDs.ZONE_1, '192.168.1.10')
-	zone2 = vssl.add_zone(Zone.IDs.ZONE_2, '192.168.1.11')
-	zone3 = vssl.add_zone(Zone.IDs.ZONE_3, '192.168.1.12')
+	zone1 = vssl.add_zone(ZoneIDs.ZONE_1, '192.168.1.10')
+	zone2 = vssl.add_zone(ZoneIDs.ZONE_2, '192.168.1.11')
+	zone3 = vssl.add_zone(ZoneIDs.ZONE_3, '192.168.1.12')
 	#... up to 6 zones
 
 	# Connect and initiate zones.
@@ -110,7 +116,7 @@ print(zone_name)
 | ---------------------- 	| ----------- | ----------- |
 | `sw_version`   			| Software version        |	`str` readonly
 | `serial`   			| Serial number        |	`str` readonly
-| `model_zone_qty`   			| Number of zones the device has        |	`int` readonly
+| `model`   			| Device Model        |	`int` readonly
 | `reboot()`   			| Reboot all zones        |	`func`  |
 
 ```python
@@ -152,7 +158,7 @@ vssl.settings.power.adaptive = True
 
 | Property      	| Description | Type		| Values 		| 
 | ---------------------- 	| ----------- | ----------- |----------- |
-| `id`     			 	| Zone number / ID |	`int` readonly	| `Zone.IDs`
+| `id`     			 	| Zone number / ID |	`int` readonly	| `ZoneIDs`
 | `host`   			| IP address        |	`str` readonly
 | `volume`   			| Volume        |	`int`  | `0...100`
 | `volume_raise([step=1])`   			| Raise volume by `step`       |	`func`  | step: `int` `1...100`
@@ -256,20 +262,20 @@ Working on A.3x but offically unsupported in x series amplifiers.
 
 | Property      	| Description | Type		| Values 		| 
 | ---------------------- 	| ----------- | ----------- |----------- |
-| `source`     			 	| Zone ID of group master / source |	`int` readonly	| `Zone.IDs`
+| `source`     			 	| Zone ID of group master / source |	`int` readonly	| `ZoneIDs`
 | `is_master`   			| This zone is the group master        |	`bool` readonly
-| `add_member()`   			| Add zone to group / create group |	`func`  | `Zone.IDs`
-| `remove_member()`   		| Remove zone from group      |	`func`  | `Zone.IDs`
+| `add_member()`   			| Add zone to group / create group |	`func`  | `ZoneIDs`
+| `remove_member()`   		| Remove zone from group      |	`func`  | `ZoneIDs`
 | `dissolve()`   			| Dissolve group / remove all members       |	`func`  |
 | `leave()`   				| Leave the group if a member       |	`func`  |
 
 ```python
 """Examples"""
 # Add group 2 to a group with zone 1 as master
-zone1.group.add_member(Zone.IDs.ZONE_2)
-# Remove zone 2 from group.
+zone1.group.add_member(ZoneIDs.ZONE_2)
+# Remove zone 2 from group
 zone2.group.leave() # or
-zone1.group.remove_member(Zone.IDs.ZONE_2)
+zone1.group.remove_member(ZoneIDs.ZONE_2)
 # If zone 1 is a master, remove all members
 zone1.group.dissolve()
 ```
@@ -371,6 +377,53 @@ EQ to be set in [decibel](https://en.wikipedia.org/wiki/Decibel) using a range `
 zone1.settings.eq.khz1_db = -2
 ```
 
+## Another (Lite) Way
+
+If you perfer to not run the complete intergration, you can send basic HEX commands to the VSSL device using [Netcat](https://nc110.sourceforge.io/) (or ant network tool) on port `50002`.
+
+| HEX      	| Description |
+| ---------------------- 	| ----------- |
+| `\x10\x05\x03\x0{Zone Number}\xff\x03`   			| Volume Up     
+| `\x10\x05\x03\x0{Zone Number}\xfe\x03`   			| Volume Down    
+| `\x10\x11\x02\x0{Zone Number}\x01`   			| Mute
+| All commands can be found by looking [here](https://github.com/vsslctrl/vsslctrl/blob/2c43c2f2393b94bc0e062d2ab90144343eca16ef/vsslctrl/api_alpha.py)   			| 
+
+
+The `volume up` HEX command for `Zone 2` would be `\x10\x05\x03\x02\xff\x03`
+
+Now send the raw HEX using Netcat to the device using this syntax:
+
+`echo -e "{HEX Command}" | nc {IP Address} 50002`
+
+For example to send `volume up` to `Zone 2`:
+
+`echo -e "\x10\x05\x03\x02\xff\x03" | nc 192.168.1.11 50002`
+
+Home Assistant `Configuration.yaml` example:
+
+```ymal
+...
+
+shell_command:
+  #Zone 1
+  vssl_zone_1_volume_up: 'echo -e "\x10\x05\x03\x01\xff\x03" | nc 192.168.1.10 50002'
+  vssl_zone_1_volume_down: 'echo -e "\x10\x05\x03\x01\xfe\x03" | nc 192.168.1.10 50002'
+  vssl_zone_1_mute: 'echo -e "\x10\x11\x02\x01\x01" | nc 192.168.1.10 50002'
+  vssl_zone_1_unmute: 'echo -e "\x10\x11\x02\x01\x00" | nc 192.168.1.10 50002'
+  #Zone 2
+  vssl_zone_2_volume_up: 'echo -e "\x10\x05\x03\x02\xff\x03" | nc 192.168.1.11 50002'
+  vssl_zone_2_volume_down: 'echo -e "\x10\x05\x03\x02\xfe\x03" | nc 192.168.1.11 50002'
+  vssl_zone_2_mute: 'echo -e "\x10\x11\x02\x02\x01" | nc 192.168.1.11 50002'
+  vssl_zone_2_unmute: 'echo -e "\x10\x11\x02\x02\x00" | nc 192.168.1.11 50002'
+  #Zone 3
+  vssl_zone_3_volume_up: 'echo -e "\x10\x05\x03\x03\xff\x03" | nc 192.168.1.12 50002'
+  vssl_zone_3_volume_down: 'echo -e "\x10\x05\x03\x03\xfe\x03" | nc 192.168.1.12 50002'
+  vssl_zone_3_mute: 'echo -e "\x10\x11\x02\x03\x01" | nc 192.168.1.12 50002'
+  vssl_zone_3_unmute: 'echo -e "\x10\x11\x02\x03\x00" | nc 192.168.1.12 50002'
+
+ ...
+```
+
 ## Credit
 
 The VSSL API was reverse engineered using Wireshark, VSSLs native "legacy" iOS app and their deprecated [vsslagent](https://vssl.gitbook.io/vssl-rest-api/getting-started/start).
@@ -392,4 +445,5 @@ The VSSL API was reverse engineered using Wireshark, VSSLs native "legacy" iOS a
 * REST API / Web App
 * Save and recall EQ
 * A.1(x) coverage i.e Bluetooth
+* IR Control
 

{vsslctrl-0.1.2.dev1 → vsslctrl-0.1.4.dev1}/README.md

@@ -7,37 +7,43 @@
 
  I am looking for testers with any VSSL amplifier models, please get in touch if you interested in helping.
 
- Only tested on VSSL **A.3x** software version **p15305.016.3701**.
+Important
+-----------
+Only tested on a VSSL **A.3x** software version **p15305.016.3701**.
+
+**Warning:** no *[VSSL Agent](https://vssl.gitbook.io/vssl-rest-api/getting-started/start)* should be running on the same network. If you dont know what this is, then you can probably ignore this notice.
 
 ## TODOs
 
 * Test on other models (hardware needed)
 * Home Assistant integration. In progress, [here](https://github.com/vsslctrl/integration.home-assistant)
-* Function scoping to supported feature / models
+* ~~Function scoping to supported feature / models~~ (needs tests)
 * Better test coverage
 
-Important
------------
-**Warning:** no *[VSSL Agent](https://vssl.gitbook.io/vssl-rest-api/getting-started/start)* should be running on the same network. If you dont know what this is, then you can probably ignore this notice.
-
-
 Basic Usage
 -----------
 `vsslctrl` needs to be running inside a **[asyncio](https://docs.python.org/3/library/asyncio.html)** event loop.
 
 ```python
 import asyncio
-from vsslctrl import Vssl, Zone
+from vsslctrl import Vssl, DeviceModels, Zone, ZoneIDs
 
 async def main():
 	
 	# Represents a physical VSSL amplifier
 	vssl = Vssl()
 
+  """Optional to init Vssl with a device model
+
+    vssl = Vssl(DeviceModels.A3X)
+
+    If no DeviceModels is passed, vsslctrl will default to the feature set of the X series amps
+  """
+
 	# Add each you wish to control
-	zone1 = vssl.add_zone(Zone.IDs.ZONE_1, '192.168.1.10')
-	zone2 = vssl.add_zone(Zone.IDs.ZONE_2, '192.168.1.11')
-	zone3 = vssl.add_zone(Zone.IDs.ZONE_3, '192.168.1.12')
+	zone1 = vssl.add_zone(ZoneIDs.ZONE_1, '192.168.1.10')
+	zone2 = vssl.add_zone(ZoneIDs.ZONE_2, '192.168.1.11')
+	zone3 = vssl.add_zone(ZoneIDs.ZONE_3, '192.168.1.12')
 	#... up to 6 zones
 
 	# Connect and initiate zones.
@@ -89,7 +95,7 @@ print(zone_name)
 | ---------------------- 	| ----------- | ----------- |
 | `sw_version`   			| Software version        |	`str` readonly
 | `serial`   			| Serial number        |	`str` readonly
-| `model_zone_qty`   			| Number of zones the device has        |	`int` readonly
+| `model`   			| Device Model        |	`int` readonly
 | `reboot()`   			| Reboot all zones        |	`func`  |
 
 ```python
@@ -131,7 +137,7 @@ vssl.settings.power.adaptive = True
 
 | Property      	| Description | Type		| Values 		| 
 | ---------------------- 	| ----------- | ----------- |----------- |
-| `id`     			 	| Zone number / ID |	`int` readonly	| `Zone.IDs`
+| `id`     			 	| Zone number / ID |	`int` readonly	| `ZoneIDs`
 | `host`   			| IP address        |	`str` readonly
 | `volume`   			| Volume        |	`int`  | `0...100`
 | `volume_raise([step=1])`   			| Raise volume by `step`       |	`func`  | step: `int` `1...100`
@@ -235,20 +241,20 @@ Working on A.3x but offically unsupported in x series amplifiers.
 
 | Property      	| Description | Type		| Values 		| 
 | ---------------------- 	| ----------- | ----------- |----------- |
-| `source`     			 	| Zone ID of group master / source |	`int` readonly	| `Zone.IDs`
+| `source`     			 	| Zone ID of group master / source |	`int` readonly	| `ZoneIDs`
 | `is_master`   			| This zone is the group master        |	`bool` readonly
-| `add_member()`   			| Add zone to group / create group |	`func`  | `Zone.IDs`
-| `remove_member()`   		| Remove zone from group      |	`func`  | `Zone.IDs`
+| `add_member()`   			| Add zone to group / create group |	`func`  | `ZoneIDs`
+| `remove_member()`   		| Remove zone from group      |	`func`  | `ZoneIDs`
 | `dissolve()`   			| Dissolve group / remove all members       |	`func`  |
 | `leave()`   				| Leave the group if a member       |	`func`  |
 
 ```python
 """Examples"""
 # Add group 2 to a group with zone 1 as master
-zone1.group.add_member(Zone.IDs.ZONE_2)
-# Remove zone 2 from group.
+zone1.group.add_member(ZoneIDs.ZONE_2)
+# Remove zone 2 from group
 zone2.group.leave() # or
-zone1.group.remove_member(Zone.IDs.ZONE_2)
+zone1.group.remove_member(ZoneIDs.ZONE_2)
 # If zone 1 is a master, remove all members
 zone1.group.dissolve()
 ```
@@ -350,6 +356,53 @@ EQ to be set in [decibel](https://en.wikipedia.org/wiki/Decibel) using a range `
 zone1.settings.eq.khz1_db = -2
 ```
 
+## Another (Lite) Way
+
+If you perfer to not run the complete intergration, you can send basic HEX commands to the VSSL device using [Netcat](https://nc110.sourceforge.io/) (or ant network tool) on port `50002`.
+
+| HEX      	| Description |
+| ---------------------- 	| ----------- |
+| `\x10\x05\x03\x0{Zone Number}\xff\x03`   			| Volume Up     
+| `\x10\x05\x03\x0{Zone Number}\xfe\x03`   			| Volume Down    
+| `\x10\x11\x02\x0{Zone Number}\x01`   			| Mute
+| All commands can be found by looking [here](https://github.com/vsslctrl/vsslctrl/blob/2c43c2f2393b94bc0e062d2ab90144343eca16ef/vsslctrl/api_alpha.py)   			| 
+
+
+The `volume up` HEX command for `Zone 2` would be `\x10\x05\x03\x02\xff\x03`
+
+Now send the raw HEX using Netcat to the device using this syntax:
+
+`echo -e "{HEX Command}" | nc {IP Address} 50002`
+
+For example to send `volume up` to `Zone 2`:
+
+`echo -e "\x10\x05\x03\x02\xff\x03" | nc 192.168.1.11 50002`
+
+Home Assistant `Configuration.yaml` example:
+
+```ymal
+...
+
+shell_command:
+  #Zone 1
+  vssl_zone_1_volume_up: 'echo -e "\x10\x05\x03\x01\xff\x03" | nc 192.168.1.10 50002'
+  vssl_zone_1_volume_down: 'echo -e "\x10\x05\x03\x01\xfe\x03" | nc 192.168.1.10 50002'
+  vssl_zone_1_mute: 'echo -e "\x10\x11\x02\x01\x01" | nc 192.168.1.10 50002'
+  vssl_zone_1_unmute: 'echo -e "\x10\x11\x02\x01\x00" | nc 192.168.1.10 50002'
+  #Zone 2
+  vssl_zone_2_volume_up: 'echo -e "\x10\x05\x03\x02\xff\x03" | nc 192.168.1.11 50002'
+  vssl_zone_2_volume_down: 'echo -e "\x10\x05\x03\x02\xfe\x03" | nc 192.168.1.11 50002'
+  vssl_zone_2_mute: 'echo -e "\x10\x11\x02\x02\x01" | nc 192.168.1.11 50002'
+  vssl_zone_2_unmute: 'echo -e "\x10\x11\x02\x02\x00" | nc 192.168.1.11 50002'
+  #Zone 3
+  vssl_zone_3_volume_up: 'echo -e "\x10\x05\x03\x03\xff\x03" | nc 192.168.1.12 50002'
+  vssl_zone_3_volume_down: 'echo -e "\x10\x05\x03\x03\xfe\x03" | nc 192.168.1.12 50002'
+  vssl_zone_3_mute: 'echo -e "\x10\x11\x02\x03\x01" | nc 192.168.1.12 50002'
+  vssl_zone_3_unmute: 'echo -e "\x10\x11\x02\x03\x00" | nc 192.168.1.12 50002'
+
+ ...
+```
+
 ## Credit
 
 The VSSL API was reverse engineered using Wireshark, VSSLs native "legacy" iOS app and their deprecated [vsslagent](https://vssl.gitbook.io/vssl-rest-api/getting-started/start).
@@ -371,4 +424,5 @@ The VSSL API was reverse engineered using Wireshark, VSSLs native "legacy" iOS a
 * REST API / Web App
 * Save and recall EQ
 * A.1(x) coverage i.e Bluetooth
+* IR Control
 

{vsslctrl-0.1.2.dev1 → vsslctrl-0.1.4.dev1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "vsslctrl"
-version = "0.1.2.dev1"
+version = "0.1.4.dev1"
 description = "Package for controlling VSSL amplifiers"
 authors = [
   { name="vsslctrl", email="vsslcontrolled@proton.me" },

vsslctrl-0.1.4.dev1/vsslctrl/__init__.py

@@ -0,0 +1,6 @@
+from .core import Vssl
+from .zone import Zone
+from .data_structure import ZoneIDs
+from .device import Models as DeviceModels
+
+VSSL_NAME = "VSSL"

{vsslctrl-0.1.2.dev1 → vsslctrl-0.1.4.dev1}/vsslctrl/api_alpha.py

@@ -558,8 +558,8 @@ class APIAlpha(APIBase):
     def response_action_00_00(self, metadata: list):
         self._log_debug(f"Received 00 Status: {metadata}")
 
-        # Workout how many zones we have
-        self.vssl._infer_model_zone_qty(metadata)
+        # Guess device model
+        self.vssl._infer_device_model(metadata)
 
         # Analog output source
         key = DeviceStatusExtKeys.add_zone_to_bus_key(self.zone.id)

{vsslctrl-0.1.2.dev1 → vsslctrl-0.1.4.dev1}/vsslctrl/core.py

@@ -10,7 +10,8 @@ from .event_bus import EventBus
 from .settings import VsslSettings
 from .decorators import logging_helpers
 from .discovery import check_zeroconf_availability, fetch_zone_id_serial
-from .data_structure import DeviceModels
+from .device import Models
+from .data_structure import ZoneIDs
 
 
 @logging_helpers("VSSL:")
@@ -23,14 +24,13 @@ class Vssl:
     class Events:
         PREFIX = "vssl."
         MODEL_CHANGE = PREFIX + "model_changed"
-        MODEL_ZONE_QTY_CHANGE = PREFIX + "model_zone_qty_changed"
         SW_VERSION_CHANGE = PREFIX + "sw_version_changed"
         SERIAL_CHANGE = PREFIX + "serial_changed"
         ALL = EventBus.WILDCARD
 
     def __init__(
         self,
-        model: DeviceModels = None,
+        model: Models = None,
         zones: Union[str, List[str]] = None,
     ):
         self.event_bus = EventBus()
@@ -38,10 +38,10 @@ class Vssl:
         self._sw_version = None
         self._serial = None
         self._model = None
-        self._model_zone_qty = 0
         self.settings = VsslSettings(self)
 
-        self.model = model
+        if model is not None:
+            self.model = model
 
         # Add zones if any are passed
         if zones:
@@ -62,22 +62,22 @@ class Vssl:
         try:
             key, first_zone = zones_to_init.popitem()
 
-            # If we pass a model to the zone, the zone count will be worked out from that,
-            # otherwise we will try and work it out once we receive some info about he device
-            if not self.model_zone_qty:
-                future_model_zone_qty = self.event_bus.future(
-                    self.Events.MODEL_ZONE_QTY_CHANGE, self.ENTITY_ID
+            # If we dont pass a model we will default to the zone count of the X series amps once we
+            # know some info about the device
+            if not self.model:
+                future_model = self.event_bus.future(
+                    self.Events.MODEL_CHANGE, self.ENTITY_ID
                 )
 
             # Lets make sure the zone is initialised, otherwsie we fail all
             await first_zone.initialise()
 
-            # Only continue after we now how many zones the device supports
+            # Only continue after we have a model
             try:
-                if not self.model_zone_qty:
-                    await asyncio.wait_for(future_model_zone_qty, timeout=init_timeout)
+                if not self.model:
+                    await asyncio.wait_for(future_model, timeout=init_timeout)
 
-                if len(self.zones) > self.model_zone_qty:
+                if len(self.zones) > self.model.zone_count:
                     raise VsslCtrlException("")
 
             except asyncio.TimeoutError:
@@ -87,7 +87,8 @@ class Vssl:
                 raise VsslCtrlException(message)
 
             except VsslCtrlException:
-                message = f"Device model only has {self.model_zone_qty} zones instead of {len(self.zones)}"
+                zone_count = self.model.zone_count
+                message = f"Device model only has {zone_count} zones instead of {len(self.zones)}"
                 self._log_critical(message)
                 await first_zone.disconnect()
                 raise VsslCtrlException(message)
@@ -173,47 +174,32 @@ class Vssl:
         return self._model
 
     @model.setter
-    def model(self, model: str):
-        if self.model != model:
-            if DeviceModels.is_valid(model):
-                self._set_property("model", DeviceModels(model))
-            else:
-                message = f"DeviceModels {model} doesnt exist"
-                self._log_error(message)
-                raise VsslCtrlException(message)
-
-    #
-    # The amount of zones this VSSL has. This is not how many zones have been initialised
-    # but how many zones the model has in total. We can have 1, 3 or 6 zones.
-    #
-    @property
-    def model_zone_qty(self):
-        if not self._model_zone_qty and self.model is not None:
-            self._model_zone_qty = DeviceModels.zone_count(self.model.value)
-
-        return self._model_zone_qty
-
-    @model_zone_qty.setter
-    def model_zone_qty(self, model_zone_qty: int):
-        pass  # read-only
+    def model(self, model):
+        if Models.is_valid(model):
+            self._set_property("model", Models(model).value)
+        elif isinstance(model, str):
+            model = model.upper()
+            if hasattr(Models, model):
+                self._set_property("model", getattr(Models, model).value)
+        else:
+            message = f"Model {model} doesnt exist"
+            self._log_error(message)
+            raise VsslCtrlException(message)
 
     #
-    # Work out the model_zone_qty given device info
+    # Work out the a model given some device info
     #
-    def _infer_model_zone_qty(self, data: Dict[str, int]):
-        if not self.model_zone_qty:
+    def _infer_device_model(self, data: Dict[str, int]):
+        # if we dont have a model, default to x series
+        if not self.model:
             zone_count = sum(
                 1 for key in data if key.startswith("B") and key.endswith("Src")
             )
 
             if zone_count in (1, 3, 6):
-                self._model_zone_qty = zone_count
+                self.model = f"A{zone_count}X"
             else:
-                self._model_zone_qty = 1
-
-            self.event_bus.publish(
-                self.Events.MODEL_ZONE_QTY_CHANGE, self.ENTITY_ID, self.model_zone_qty
-            )
+                self.model = Models.A1X
 
     #
     # Disconnect / Shutdown
@@ -234,9 +220,9 @@ class Vssl:
     #
     # Add a Zone
     #
-    def add_zone(self, zone_index: "Zone.IDs", host: str):
-        if Zone.IDs.is_not_valid(zone_index):
-            error = f"Zone.IDs {zone_index} doesnt exist"
+    def add_zone(self, zone_index: ZoneIDs, host: str):
+        if ZoneIDs.is_not_valid(zone_index):
+            error = f"ZoneIDs {zone_index} doesnt exist"
             self._log_error(error)
             raise ZoneError(error)
             return None
@@ -262,7 +248,7 @@ class Vssl:
     #
     # Get a Zone by ID
     #
-    def get_zone(self, zone_index: "Zone.IDs"):
+    def get_zone(self, zone_index: ZoneIDs):
         if zone_index in self.zones:
             return self.zones[zone_index]
         else:

{vsslctrl-0.1.2.dev1 → vsslctrl-0.1.4.dev1}/vsslctrl/data_structure.py

@@ -29,24 +29,18 @@ class VsslIntEnum(VsslEnum, IntEnum):
     """IntEnum"""
 
 
-class DeviceModels(VsslEnum):
-    A1 = "a1"
-    A3 = "a3"
-    A6 = "a6"
-    A1X = "a1x"
-    A3X = "a3x"
-    A6X = "a6x"
-
-    @staticmethod
-    # Get the amount of zones the model has by pulling out the number in the model
-    def zone_count(model: str):
-        if DeviceModels.is_valid(model.lower()):
-            pattern = r"\d+"
-            match = re.search(pattern, model)
-            if match:
-                number = int(match.group())
-                return number
-        return 1
+#
+# Zones IDs
+#
+# Moved here to help with circular imports
+#
+class ZoneIDs(VsslIntEnum):
+    ZONE_1 = 1
+    ZONE_2 = 2
+    ZONE_3 = 3
+    ZONE_4 = 4
+    ZONE_5 = 5
+    ZONE_6 = 6
 
 
 """ JSON Structure

vsslctrl-0.1.4.dev1/vsslctrl/device.py

@@ -0,0 +1,115 @@
+from .data_structure import VsslEnum, VsslIntEnum, ZoneIDs
+from .io import AnalogOutput, InputRouter
+
+SINGLE_ZONE = [ZoneIDs.ZONE_1]
+THREE_ZONES = [ZoneIDs.ZONE_1, ZoneIDs.ZONE_2, ZoneIDs.ZONE_3]
+SIX_ZONES = list(ZoneIDs)
+
+INPUT_SOURCES_FOR_1_ZONE_DEVICE = [
+    InputRouter.Sources.STREAM,
+    InputRouter.Sources.ANALOG_IN_1,
+    InputRouter.Sources.OPTICAL_IN,
+]
+
+INPUT_SOURCES_FOR_3_ZONE_DEVICE = INPUT_SOURCES_FOR_1_ZONE_DEVICE + [
+    InputRouter.Sources.ANALOG_IN_2,
+    InputRouter.Sources.ANALOG_IN_3,
+]
+
+INPUT_SOURCES_FOR_6_ZONE_DEVICE = list(InputRouter.Sources)
+
+ANALOG_OUTPUT_SOURCES_FOR_1_ZONE_DEVICE = [
+    AnalogOutput.Sources.OFF,
+    AnalogOutput.Sources.ZONE_1,
+    AnalogOutput.Sources.OPTICAL_IN,
+]
+
+ANALOG_OUTPUT_SOURCES_FOR_3_ZONE_DEVICE = ANALOG_OUTPUT_SOURCES_FOR_1_ZONE_DEVICE + [
+    AnalogOutput.Sources.ZONE_2,
+    AnalogOutput.Sources.ZONE_3,
+]
+
+ANALOG_OUTPUT_SOURCES_FOR_6_ZONE_DEVICE = list(AnalogOutput.Sources)
+
+
+class Features(VsslIntEnum):
+    GROUPING = 1000
+    BLUETOOTH = 1001
+    PARTY_MODE = 1002
+
+
+class Model:
+    def __init__(self, model: dict):
+        self.name = model.get("name")
+        self.zones = model.get("zones", [])
+        self.input_sources = model.get("input_sources", [])
+        self.analog_output_sources = model.get("analog_output_sources", [])
+        self.features = model.get("features", [])
+
+    @property
+    def zone_count(self):
+        return len(self.zones)
+
+    @property
+    def is_multizone(self):
+        return self.zone_count > 1
+
+    def supports_feature(self, feature: Features):
+        return feature in self.features
+
+
+class Models(VsslEnum):
+    A1 = Model(
+        {
+            "name": "A1",
+            "zones": SINGLE_ZONE,
+            "input_sources": INPUT_SOURCES_FOR_1_ZONE_DEVICE,
+            "analog_output_sources": ANALOG_OUTPUT_SOURCES_FOR_1_ZONE_DEVICE,
+            "features": [Features.BLUETOOTH],
+        }
+    )
+    A3 = Model(
+        {
+            "name": "A3",
+            "zones": THREE_ZONES,
+            "input_sources": INPUT_SOURCES_FOR_3_ZONE_DEVICE,
+            "analog_output_sources": ANALOG_OUTPUT_SOURCES_FOR_3_ZONE_DEVICE,
+            "features": [Features.GROUPING, Features.PARTY_MODE],
+        }
+    )
+    A6 = Model(
+        {
+            "name": "A6",
+            "zones": SIX_ZONES,
+            "input_sources": INPUT_SOURCES_FOR_6_ZONE_DEVICE,
+            "analog_output_sources": ANALOG_OUTPUT_SOURCES_FOR_6_ZONE_DEVICE,
+            "features": [Features.GROUPING, Features.PARTY_MODE],
+        }
+    )
+    A1X = Model(
+        {
+            "name": "A.1x",
+            "zones": SINGLE_ZONE,
+            "input_sources": INPUT_SOURCES_FOR_1_ZONE_DEVICE,
+            "analog_output_sources": ANALOG_OUTPUT_SOURCES_FOR_1_ZONE_DEVICE,
+            "features": [Features.GROUPING, Features.BLUETOOTH],
+        }
+    )
+    A3X = Model(
+        {
+            "name": "A.3x",
+            "zones": THREE_ZONES,
+            "input_sources": INPUT_SOURCES_FOR_3_ZONE_DEVICE,
+            "analog_output_sources": ANALOG_OUTPUT_SOURCES_FOR_3_ZONE_DEVICE,
+            "features": [Features.GROUPING],
+        }
+    )
+    A6X = Model(
+        {
+            "name": "A.6x",
+            "zones": SIX_ZONES,
+            "input_sources": INPUT_SOURCES_FOR_6_ZONE_DEVICE,
+            "analog_output_sources": ANALOG_OUTPUT_SOURCES_FOR_6_ZONE_DEVICE,
+            "features": [Features.GROUPING],
+        }
+    )

{vsslctrl-0.1.2.dev1 → vsslctrl-0.1.4.dev1}/vsslctrl/group.py

@@ -1,7 +1,8 @@
 import logging
 from . import zone
 from typing import Dict, Union
-from .data_structure import ZoneDataClass
+from .data_structure import ZoneDataClass, ZoneIDs
+from .device import Features as DeviceFeatures
 
 
 """
@@ -58,12 +59,19 @@ class ZoneGroup(ZoneDataClass):
     #
     # Group Add Zone
     #
-    def add_member(self, zone_id: "zone.Zone.IDs"):
+    def add_member(self, zone_id: ZoneIDs):
+        # Check this device is a multizone device
+        if not self.zone.vssl.model.supports_feature(DeviceFeatures.GROUPING):
+            self.zone._log_error(
+                f"VSSL {self.zone.vssl.model.name} doesnt support grouping"
+            )
+            return False
+
         if self.zone.id == zone_id:
             self.zone._log_error(f"Zone {zone_id} cant be parent and member")
             return False
 
-        if zone.Zone.IDs.is_not_valid(zone_id):
+        if ZoneIDs.is_not_valid(zone_id):
             self.zone._log_error(f"Zone {zone_id} doesnt exist")
             return False
 
@@ -84,7 +92,7 @@ class ZoneGroup(ZoneDataClass):
     #
     # Group Remove Child
     #
-    def remove_member(self, zone_id: "zone.Zone.IDs"):
+    def remove_member(self, zone_id: ZoneIDs):
         self.zone.api_alpha.request_action_4B_remove(zone_id)
 
     #
@@ -132,9 +140,7 @@ class ZoneGroup(ZoneDataClass):
         pass  # read-only
 
     def _set_source(self, grs: int):
-        new_source = (
-            zone.Zone.IDs(grs) if grs != 255 and zone.Zone.IDs.is_valid(grs) else None
-        )
+        new_source = ZoneIDs(grs) if grs != 255 and ZoneIDs.is_valid(grs) else None
 
         if self.source != new_source:
             self._source = new_source

{vsslctrl-0.1.2.dev1 → vsslctrl-0.1.4.dev1}/vsslctrl/io.py

@@ -83,10 +83,14 @@ class InputRouter(ZoneDataClass):
 
     @source.setter
     def source(self, src: "InputRouter.Sources"):
-        if self.Sources.is_valid(src):
+        # if self.Sources.is_valid():
+        if src in self.zone.vssl.model.input_sources:
+            # check source is avaialbe on this device
             self.zone.api_alpha.request_action_03(src)
         else:
-            self.zone._log_error(f"InputRouter.Sources {src} doesnt exist")
+            self.zone._log_error(
+                f"InputRouter.Sources {src} doesnt exist in {list(self.zone.vssl.model.input_sources)}"
+            )
 
     def _set_source(self, src: int):
         if self.source != src:
@@ -160,10 +164,13 @@ class AnalogOutput(ZoneDataClass):
 
     @source.setter
     def source(self, src: "AnalogOutput.Sources"):
-        if self.Sources.is_valid(src):
+        # if self.Sources.is_valid(src):
+        if src in self.zone.vssl.model.analog_output_sources:
             self.zone.api_alpha.request_action_1D(src)
         else:
-            self.zone._log_error(f"AnalogOutput.Sources {src} doesnt exist")
+            self.zone._log_error(
+                f"AnalogOutput.Sources {src} doesnt exist in {list(self.zone.vssl.model.analog_output_sources)}"
+            )
 
     def _set_source(self, src: int):
         if self.source != src:

{vsslctrl-0.1.2.dev1 → vsslctrl-0.1.4.dev1}/vsslctrl/settings.py

@@ -162,7 +162,7 @@ class ZoneSettings(ZoneDataClass):
 
         self._disabled = False
         self._name = f"Zone {zone.id}"
-        self._mono = False
+        self._mono = self.StereoMono.Stereo
 
         self.eq = EQSettings(zone)
         self.volume = VolumeSettings(zone)

{vsslctrl-0.1.2.dev1 → vsslctrl-0.1.4.dev1}/vsslctrl/track.py

@@ -299,12 +299,14 @@ class TrackMetadata(ZoneDataClass):
                 default_host += "/"
 
             # Lets add a query string to the coverart.jpg URL so the latest coverart
-            # will always be downloaded if the album changes
-            if url == self.AIRPLAY_COVER_ART and self.album:
-                encoded_album = (
-                    base64.urlsafe_b64encode(self.album.encode()).decode().rstrip("=")
-                )[:6]
-                query = f"?album={encoded_album}"
+            # will always be downloaded if the album + artist changes
+            if url == self.AIRPLAY_COVER_ART and self.artist and self.album:
+                aahash = (
+                    base64.urlsafe_b64encode(self.artist.encode() + self.album.encode())
+                    .decode()
+                    .rstrip("=")
+                )
+                query = f"?aahash={aahash}"
 
             return default_host + url + query
 

{vsslctrl-0.1.2.dev1 → vsslctrl-0.1.4.dev1}/vsslctrl/zone.py

@@ -13,7 +13,7 @@ from . import core
 from .api_alpha import APIAlpha
 from .api_bravo import APIBravo
 from .utils import RepeatTimer, clamp_volume
-from .data_structure import DeviceModels, VsslIntEnum
+from .data_structure import VsslIntEnum, ZoneIDs
 from .track import TrackMetadata
 from .io import AnalogOutput, InputRouter
 from .settings import ZoneSettings
@@ -25,17 +25,6 @@ from .decorators import logging_helpers
 
 @logging_helpers()
 class Zone:
-    #
-    # Zones IDs
-    #
-    class IDs(VsslIntEnum):
-        ZONE_1 = 1
-        ZONE_2 = 2
-        ZONE_3 = 3
-        ZONE_4 = 4
-        ZONE_5 = 5
-        ZONE_6 = 6
-
     #
     # Zone Events
     #
@@ -49,7 +38,7 @@ class Zone:
         VOLUME_CHANGE = PREFIX + "volume_change"
         MUTE_CHANGE = PREFIX + "mute_change"
 
-    def __init__(self, vssl_host: "core.Vssl", zone_id: "Zone.IDs", host: str):
+    def __init__(self, vssl_host: "core.Vssl", zone_id: ZoneIDs, host: str):
         self._log_prefix = f"Zone {zone_id}:"
 
         self.vssl = vssl_host
@@ -57,7 +46,7 @@ class Zone:
 
         # Data / Cache
         self._host = host
-        self._id = self.IDs(zone_id)
+        self._id = ZoneIDs(zone_id)
         self._mac_addr = None
         self._serial = None
         self._volume = 0

{vsslctrl-0.1.2.dev1 → vsslctrl-0.1.4.dev1}/vsslctrl.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vsslctrl
-Version: 0.1.2.dev1
+Version: 0.1.4.dev1
 Summary: Package for controlling VSSL amplifiers
 Author-email: vsslctrl <vsslcontrolled@proton.me>
 Classifier: Development Status :: 4 - Beta
@@ -28,37 +28,43 @@ Requires-Dist: zeroconf==0.132.2; extra == "optional"
 
  I am looking for testers with any VSSL amplifier models, please get in touch if you interested in helping.
 
- Only tested on VSSL **A.3x** software version **p15305.016.3701**.
+Important
+-----------
+Only tested on a VSSL **A.3x** software version **p15305.016.3701**.
+
+**Warning:** no *[VSSL Agent](https://vssl.gitbook.io/vssl-rest-api/getting-started/start)* should be running on the same network. If you dont know what this is, then you can probably ignore this notice.
 
 ## TODOs
 
 * Test on other models (hardware needed)
 * Home Assistant integration. In progress, [here](https://github.com/vsslctrl/integration.home-assistant)
-* Function scoping to supported feature / models
+* ~~Function scoping to supported feature / models~~ (needs tests)
 * Better test coverage
 
-Important
------------
-**Warning:** no *[VSSL Agent](https://vssl.gitbook.io/vssl-rest-api/getting-started/start)* should be running on the same network. If you dont know what this is, then you can probably ignore this notice.
-
-
 Basic Usage
 -----------
 `vsslctrl` needs to be running inside a **[asyncio](https://docs.python.org/3/library/asyncio.html)** event loop.
 
 ```python
 import asyncio
-from vsslctrl import Vssl, Zone
+from vsslctrl import Vssl, DeviceModels, Zone, ZoneIDs
 
 async def main():
 	
 	# Represents a physical VSSL amplifier
 	vssl = Vssl()
 
+  """Optional to init Vssl with a device model
+
+    vssl = Vssl(DeviceModels.A3X)
+
+    If no DeviceModels is passed, vsslctrl will default to the feature set of the X series amps
+  """
+
 	# Add each you wish to control
-	zone1 = vssl.add_zone(Zone.IDs.ZONE_1, '192.168.1.10')
-	zone2 = vssl.add_zone(Zone.IDs.ZONE_2, '192.168.1.11')
-	zone3 = vssl.add_zone(Zone.IDs.ZONE_3, '192.168.1.12')
+	zone1 = vssl.add_zone(ZoneIDs.ZONE_1, '192.168.1.10')
+	zone2 = vssl.add_zone(ZoneIDs.ZONE_2, '192.168.1.11')
+	zone3 = vssl.add_zone(ZoneIDs.ZONE_3, '192.168.1.12')
 	#... up to 6 zones
 
 	# Connect and initiate zones.
@@ -110,7 +116,7 @@ print(zone_name)
 | ---------------------- 	| ----------- | ----------- |
 | `sw_version`   			| Software version        |	`str` readonly
 | `serial`   			| Serial number        |	`str` readonly
-| `model_zone_qty`   			| Number of zones the device has        |	`int` readonly
+| `model`   			| Device Model        |	`int` readonly
 | `reboot()`   			| Reboot all zones        |	`func`  |
 
 ```python
@@ -152,7 +158,7 @@ vssl.settings.power.adaptive = True
 
 | Property      	| Description | Type		| Values 		| 
 | ---------------------- 	| ----------- | ----------- |----------- |
-| `id`     			 	| Zone number / ID |	`int` readonly	| `Zone.IDs`
+| `id`     			 	| Zone number / ID |	`int` readonly	| `ZoneIDs`
 | `host`   			| IP address        |	`str` readonly
 | `volume`   			| Volume        |	`int`  | `0...100`
 | `volume_raise([step=1])`   			| Raise volume by `step`       |	`func`  | step: `int` `1...100`
@@ -256,20 +262,20 @@ Working on A.3x but offically unsupported in x series amplifiers.
 
 | Property      	| Description | Type		| Values 		| 
 | ---------------------- 	| ----------- | ----------- |----------- |
-| `source`     			 	| Zone ID of group master / source |	`int` readonly	| `Zone.IDs`
+| `source`     			 	| Zone ID of group master / source |	`int` readonly	| `ZoneIDs`
 | `is_master`   			| This zone is the group master        |	`bool` readonly
-| `add_member()`   			| Add zone to group / create group |	`func`  | `Zone.IDs`
-| `remove_member()`   		| Remove zone from group      |	`func`  | `Zone.IDs`
+| `add_member()`   			| Add zone to group / create group |	`func`  | `ZoneIDs`
+| `remove_member()`   		| Remove zone from group      |	`func`  | `ZoneIDs`
 | `dissolve()`   			| Dissolve group / remove all members       |	`func`  |
 | `leave()`   				| Leave the group if a member       |	`func`  |
 
 ```python
 """Examples"""
 # Add group 2 to a group with zone 1 as master
-zone1.group.add_member(Zone.IDs.ZONE_2)
-# Remove zone 2 from group.
+zone1.group.add_member(ZoneIDs.ZONE_2)
+# Remove zone 2 from group
 zone2.group.leave() # or
-zone1.group.remove_member(Zone.IDs.ZONE_2)
+zone1.group.remove_member(ZoneIDs.ZONE_2)
 # If zone 1 is a master, remove all members
 zone1.group.dissolve()
 ```
@@ -371,6 +377,53 @@ EQ to be set in [decibel](https://en.wikipedia.org/wiki/Decibel) using a range `
 zone1.settings.eq.khz1_db = -2
 ```
 
+## Another (Lite) Way
+
+If you perfer to not run the complete intergration, you can send basic HEX commands to the VSSL device using [Netcat](https://nc110.sourceforge.io/) (or ant network tool) on port `50002`.
+
+| HEX      	| Description |
+| ---------------------- 	| ----------- |
+| `\x10\x05\x03\x0{Zone Number}\xff\x03`   			| Volume Up     
+| `\x10\x05\x03\x0{Zone Number}\xfe\x03`   			| Volume Down    
+| `\x10\x11\x02\x0{Zone Number}\x01`   			| Mute
+| All commands can be found by looking [here](https://github.com/vsslctrl/vsslctrl/blob/2c43c2f2393b94bc0e062d2ab90144343eca16ef/vsslctrl/api_alpha.py)   			| 
+
+
+The `volume up` HEX command for `Zone 2` would be `\x10\x05\x03\x02\xff\x03`
+
+Now send the raw HEX using Netcat to the device using this syntax:
+
+`echo -e "{HEX Command}" | nc {IP Address} 50002`
+
+For example to send `volume up` to `Zone 2`:
+
+`echo -e "\x10\x05\x03\x02\xff\x03" | nc 192.168.1.11 50002`
+
+Home Assistant `Configuration.yaml` example:
+
+```ymal
+...
+
+shell_command:
+  #Zone 1
+  vssl_zone_1_volume_up: 'echo -e "\x10\x05\x03\x01\xff\x03" | nc 192.168.1.10 50002'
+  vssl_zone_1_volume_down: 'echo -e "\x10\x05\x03\x01\xfe\x03" | nc 192.168.1.10 50002'
+  vssl_zone_1_mute: 'echo -e "\x10\x11\x02\x01\x01" | nc 192.168.1.10 50002'
+  vssl_zone_1_unmute: 'echo -e "\x10\x11\x02\x01\x00" | nc 192.168.1.10 50002'
+  #Zone 2
+  vssl_zone_2_volume_up: 'echo -e "\x10\x05\x03\x02\xff\x03" | nc 192.168.1.11 50002'
+  vssl_zone_2_volume_down: 'echo -e "\x10\x05\x03\x02\xfe\x03" | nc 192.168.1.11 50002'
+  vssl_zone_2_mute: 'echo -e "\x10\x11\x02\x02\x01" | nc 192.168.1.11 50002'
+  vssl_zone_2_unmute: 'echo -e "\x10\x11\x02\x02\x00" | nc 192.168.1.11 50002'
+  #Zone 3
+  vssl_zone_3_volume_up: 'echo -e "\x10\x05\x03\x03\xff\x03" | nc 192.168.1.12 50002'
+  vssl_zone_3_volume_down: 'echo -e "\x10\x05\x03\x03\xfe\x03" | nc 192.168.1.12 50002'
+  vssl_zone_3_mute: 'echo -e "\x10\x11\x02\x03\x01" | nc 192.168.1.12 50002'
+  vssl_zone_3_unmute: 'echo -e "\x10\x11\x02\x03\x00" | nc 192.168.1.12 50002'
+
+ ...
+```
+
 ## Credit
 
 The VSSL API was reverse engineered using Wireshark, VSSLs native "legacy" iOS app and their deprecated [vsslagent](https://vssl.gitbook.io/vssl-rest-api/getting-started/start).
@@ -392,4 +445,5 @@ The VSSL API was reverse engineered using Wireshark, VSSLs native "legacy" iOS a
 * REST API / Web App
 * Save and recall EQ
 * A.1(x) coverage i.e Bluetooth
+* IR Control
 

{vsslctrl-0.1.2.dev1 → vsslctrl-0.1.4.dev1}/vsslctrl.egg-info/SOURCES.txt

@@ -12,6 +12,7 @@ vsslctrl/api_bravo.py
 vsslctrl/core.py
 vsslctrl/data_structure.py
 vsslctrl/decorators.py
+vsslctrl/device.py
 vsslctrl/discovery.py
 vsslctrl/event_bus.py
 vsslctrl/exceptions.py

vsslctrl-0.1.2.dev1/vsslctrl/__init__.py

@@ -1,4 +0,0 @@
-from .core import Vssl
-from .zone import Zone
-
-VSSL_NAME = "VSSL"