vsslctrl 0.1.6.dev1__tar.gz → 0.1.8.dev1__tar.gz

{vsslctrl-0.1.6.dev1 → vsslctrl-0.1.8.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vsslctrl
-Version: 0.1.6.dev1
+Version: 0.1.8.dev1
 Summary: Package for controlling VSSL's range of streaming amplifiers
 Author-email: vsslctrl <vsslcontrolled@proton.me>
 Classifier: Development Status :: 4 - Beta
@@ -247,6 +247,13 @@ zone1.transport.state = ZoneTransport.States.PAUSE
 | `source`     			 	| Change input source |	`int`	| `InputRouter.Sources`
 | `priority`     			| Change input priority. Stream or analog in higher priority  |	`int`	| `InputRouter.Priorities`
 
+### Priority Order:
+
+| `InputRouter.Priorities`       | Priority Order |
+| ----------------------  | ----------- |
+| **`STREAM`**  | <ol><li>Stream</li><li>Party Zone</li><li>Bus 1 In</li><li>Bus 2 In</li><li>Analog Input</li></ol>
+|  **`LOCAL`**  | <ol><li>Bus 1 In</li><li>Bus 2 In</li><li>Analog Input</li><li>Stream</li><li>Party Zone</li></ol>
+
 ```python
 """Example"""
 # Change zone 1 to listen to analog input 4

{vsslctrl-0.1.6.dev1 → vsslctrl-0.1.8.dev1}/README.md

@@ -226,6 +226,13 @@ zone1.transport.state = ZoneTransport.States.PAUSE
 | `source`     			 	| Change input source |	`int`	| `InputRouter.Sources`
 | `priority`     			| Change input priority. Stream or analog in higher priority  |	`int`	| `InputRouter.Priorities`
 
+### Priority Order:
+
+| `InputRouter.Priorities`       | Priority Order |
+| ----------------------  | ----------- |
+| **`STREAM`**  | <ol><li>Stream</li><li>Party Zone</li><li>Bus 1 In</li><li>Bus 2 In</li><li>Analog Input</li></ol>
+|  **`LOCAL`**  | <ol><li>Bus 1 In</li><li>Bus 2 In</li><li>Analog Input</li><li>Stream</li><li>Party Zone</li></ol>
+
 ```python
 """Example"""
 # Change zone 1 to listen to analog input 4

{vsslctrl-0.1.6.dev1 → vsslctrl-0.1.8.dev1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "vsslctrl"
-version = "0.1.6.dev1"
+version = "0.1.8.dev1"
 description = "Package for controlling VSSL's range of streaming amplifiers"
 authors = [
   { name="vsslctrl", email="vsslcontrolled@proton.me" },

{vsslctrl-0.1.6.dev1 → vsslctrl-0.1.8.dev1}/vsslctrl/api_alpha.py

@@ -16,6 +16,7 @@ from .data_structure import (
     ZoneEQStatusExtKeys,
     ZoneRouterStatusExtKeys,
     DeviceStatusExtKeys,
+    DeviceStatusExtendedExtKeys,
 )
 
 
@@ -94,10 +95,10 @@ class APIAlpha(APIBase):
 
     #
     # 00 [0] - 0B [11]
-    # Status BT (Bluetooth)
+    # Status device extended
     #
     def request_action_00_0B(self):
-        self._log_debug("Requesting status bluetooth")
+        self._log_debug("Requesting device status extended")
         self.send(bytearray([16, 0, 1, 11]))  # HEX: 1000010B
 
     #
@@ -549,12 +550,22 @@ class APIAlpha(APIBase):
         except Exception as error:
             self._log_error(f"Couldnt parse JSON: {error} | {hexl}")
 
-    #
-    # 00_00
-    # Device Status 00
-    #
-    # {'B1Src': '3', 'B2Src': '4', 'B3Src': '5', 'B1Nm': '', 'B2Nm': 'Optical In', 'dev': 'Device Name', 'ver': 'p15305.016.3701'}
-    #
+    """ 
+        00_00
+        Device Status 00
+
+        A.3x:
+        {
+            "B1Src": "3",
+            "B2Src": "4",
+            "B3Src": "5",
+            "B1Nm": "",
+            "B2Nm": "Optical In",
+            "dev": "Device Name",
+            "ver": "p15305.016.3701"
+        }
+    """
+
     def response_action_00_00(self, metadata: list):
         self._log_debug(f"Received 00 Status: {metadata}")
 
@@ -588,13 +599,32 @@ class APIAlpha(APIBase):
                 "sw_version", metadata[DeviceStatusExtKeys.SW_VERSION].strip()
             )
 
-    #
-    # 00_08
-    # Zone Status 08
-    #
-    # {'id': '1', 'ac': '0', 'mc': 'XXXXXXXXXXXX', 'vol': '20', 'mt': '0', 'pa': '0', 'rm': '0', 'ts': '14',
-    #  'alex': '14', 'nmd': '0', 'ird': '14', 'lb': '24', 'tp': '13', 'wr': '0', 'as': '0', 'rg': '0'}
-    #
+    """
+        00_08
+        Zone Status 08
+
+        A.3x:
+        {
+            "id": "1",
+            "ac": "0",
+            "mc": "XXXXXXXXXXXX",
+            "vol": "20",
+            "mt": "0",
+            "pa": "0",
+            "rm": "0",
+            "ts": "14",
+            "alex": "14",
+            "nmd": "0",
+            "ird": "14",
+            "lb": "24",
+            "tp": "13",
+            "wr": "0",
+            "as": "0",
+            "rg": "0"
+        }
+
+    """
+
     def response_action_00_08(self, metadata: list):
         self._log_debug(f"Received 08 Status: {metadata}")
 
@@ -652,13 +682,27 @@ class APIAlpha(APIBase):
                 "disabled", bool(int(metadata[ZoneStatusExtKeys.DISABLED]))
             )
 
-    #
-    # 00_09
-    # EQ Status
-    #
-    # {'mono': '0', 'AiNm': 'Analog In 1', 'eq1': '100', 'eq2': '100', 'eq3': '100', 'eq4': '100',
-    #  'eq5': '100', 'eq6': '100', 'eq7': '100', 'voll': '75', 'volr': '75', 'vold': '0'}
-    #
+    """
+        00_09
+        EQ Status
+
+        A.3x:
+        {
+            "mono": "0",
+            "AiNm": "Analog In 1",
+            "eq1": "100",
+            "eq2": "100",
+            "eq3": "100",
+            "eq4": "100",
+            "eq5": "100",
+            "eq6": "100",
+            "eq7": "100",
+            "voll": "75",
+            "volr": "75",
+            "vold": "0"
+        }
+    """
+
     def response_action_00_09(self, metadata: list):
         self._log_debug(f"Received 09 Status: {metadata}")
 
@@ -677,13 +721,28 @@ class APIAlpha(APIBase):
         self.zone.settings.eq._map_response_dict(metadata)
         self.zone.settings.volume._map_response_dict(metadata)
 
-    #
-    # 00_0A
-    # System Status 0A (Output / Amp)
-    #
-    # {'ECO': '0', 'eqsw': '1', 'inSrc': '0', 'SP': '0', 'BF1': '0', 'BF2': '0', 'BF3': '0',
-    #  'GRM': '0', 'GRS': '255', 'Pwr': '0', 'Bvr': '1', 'fxv': '24', 'AtPwr': '1'}
-    #
+    """
+        00_0A
+        System Status 0A (Output / Amp)
+
+        A.3x:
+        {
+            "ECO": "0",
+            "eqsw": "1",
+            "inSrc": "0",
+            "SP": "0",
+            "BF1": "0",
+            "BF2": "0",
+            "BF3": "0",
+            "GRM": "0",
+            "GRS": "255",
+            "Pwr": "0",
+            "Bvr": "1",
+            "fxv": "24",
+            "AtPwr": "1"
+        }
+    """
+
     def response_action_00_0A(self, metadata: list):
         self._log_debug(f"Received 0A Status: {metadata}")
 
@@ -744,30 +803,36 @@ class APIAlpha(APIBase):
                 "adaptive", bool(int(metadata[ZoneRouterStatusExtKeys.ADAPTIVE_POWER]))
             )
 
-    #
-    # 00_0B
-    # System Status 0B (Not Sure)
-    #
-    # {'IRMskL': '241', 'IRMskH': '255', 'BTSta': '0', 'Crs': '0', 'Fes': '0', 'Drk': '0'}
-    #
-    #
-    # IRMskL / IRMskH:
-    # These could potentially be related to Infrared (IR) remote control signals. "IRMskL" and "IRMskH" might represent the low and high values of the modulation frequency or pulse width for an infrared signal.
-    #
-    # BTSta:
-    # This might represent the Bluetooth status, with "0" indicating that Bluetooth is currently not active or disconnected.
-    #
-    # Crs:
-    # It could stand for "Crossfade" and may represent a setting related to crossfading between audio tracks.
-    #
-    # Fes:
-    # This might stand for "Frequency" or "Filter Effect Setting," representing a parameter related to frequency or filtering effects.
-    #
-    # Drk: ?
-    #
+    """
+        00_0B
+        Device Status Extended 0B
+
+        A.3x:
+        {
+            'IRMskL': '241', 
+            'IRMskH': '255', 
+            'BTSta': '0', 
+            'Crs': '0', 
+            'Fes': '0', 
+            'Drk': '0'
+        }
+    """
+
     def response_action_00_0B(self, metadata: list):
         self._log_debug(f"Received 0B Status: {metadata}")
-        pass
+
+        # Bluetooth
+        if DeviceStatusExtendedExtKeys.BLUETOOTH_STATUS in metadata:
+            self.vssl.settings._set_property(
+                "bluetooth", int(metadata[DeviceStatusExtendedExtKeys.BLUETOOTH_STATUS])
+            )
+
+        # Subwoofer Crossover
+        if DeviceStatusExtendedExtKeys.SUBWOOFER_CROSSOVER in metadata:
+            self.zone.settings.subwoofer._set_property(
+                "crossover",
+                int(metadata[DeviceStatusExtendedExtKeys.SUBWOOFER_CROSSOVER]),
+            )
 
     #
     # 2A [42]
@@ -927,7 +992,7 @@ class APIAlpha(APIBase):
     # Keep Alive
     #
     def response_action_17(self, hexl: list, response: bytes):
-        self._log_debug(f"Z{self.zone.id} Alpha - Received keep alive: {response}")
+        self._log_debug(f"Received keep alive: {response}")
         # TODO
         pass
 

{vsslctrl-0.1.6.dev1 → vsslctrl-0.1.8.dev1}/vsslctrl/core.py

@@ -93,6 +93,11 @@ class Vssl:
                 await first_zone.disconnect()
                 raise VsslCtrlException(message)
 
+            # Output a bit of helpful info
+            self._log_info(f"Device Model: {self.model.name}")
+            self._log_info(f"Device SW Version: {self.sw_version}")
+            self._log_info(f"Device Serial: {self.serial}")
+
             # Now we can init the rest of the zones
             initialisations = [zone.initialise() for zone in zones_to_init.values()]
             await asyncio.gather(*initialisations)

{vsslctrl-0.1.6.dev1 → vsslctrl-0.1.8.dev1}/vsslctrl/data_structure.py

@@ -41,6 +41,7 @@ class ZoneIDs(VsslIntEnum):
     ZONE_4 = 4
     ZONE_5 = 5
     ZONE_6 = 6
+    A1 = 7  # A.1 and A.1x
 
 
 """
@@ -48,7 +49,7 @@ JSON Structure
 
 DO NOT CHANGE - VSSL Defined
 
-A3.x
+A.3x
 {
     "B1Src": "3",
     "B2Src": "4",
@@ -59,7 +60,17 @@ A3.x
     "ver": "p15305.016.3701"
 }
 
-A6.x
+A.3
+{
+    'B1Src': '1', 
+    'B2Src': '2', 
+    'B1Nm': '', 
+    'B2Nm': '', 
+    'dev': 'VSSL A.3', 
+    'ver': '12013 .141.3703'
+}
+
+A.6x
 {
     "B1Src": "3",
     "B2Src": "4",
@@ -97,7 +108,68 @@ JSON Structure
 
 DO NOT CHANGE - VSSL Defined
 
-A3.x
+
+ IRMskL / IRMskH:
+ These could potentially be related to Infrared (IR) remote control signals. "IRMskL" and "IRMskH" might represent the low and high values of the modulation frequency or pulse width for an infrared signal.
+
+ BTSta:
+ This might represent the Bluetooth status, with "0" indicating that Bluetooth is currently not active or disconnected.
+
+ Crs:
+ It could stand for "Crossfade" and may represent a setting related to crossfading between audio tracks.
+
+ Fes:
+ This might stand for "Frequency" or "Filter Effect Setting," representing a parameter related to frequency or filtering effects.
+
+ Drk: ?
+
+
+A.3x
+{
+    'IRMskL': '241', 
+    'IRMskH': '255', 
+    'BTSta': '0', 
+    'Crs': '0', 
+    'Fes': '0', 
+    'Drk': '0'
+}
+
+A.3
+{
+    'IRMskL': '255', 
+    'IRMskH': '255', 
+    'BTSta': '0', 
+    'Crs': '0', 
+    'Fes': '0', 
+    'Drk': '0'
+}
+
+A.6x
+{
+    "IRMskL": "255",
+    "IRMskH": "255",
+    "BTSta": "0",
+    "Crs": "0",
+    "Fes": "0",
+    "Drk": "0"
+'
+
+"""
+
+
+class DeviceStatusExtendedExtKeys:
+    IR_HIGH = "IRMskH"  # Guess - To Confirm
+    IR_LOW = "IRMskL"  # Guess - To Confirm
+    BLUETOOTH_STATUS = "BTSta"  # Guess - To Confirm
+    SUBWOOFER_CROSSOVER = "Crs"  # Guess - To Confirm
+
+
+"""
+JSON Structure
+
+DO NOT CHANGE - VSSL Defined
+
+A.3x
 {
     "id": "1",
     "ac": "0",
@@ -117,7 +189,24 @@ A3.x
     "rg": "0"
 }
 
-A6.x
+A.3
+{
+    'id': '3', 
+    'ac': '0', 
+    'mc': 'XXXXXXXXXXXX', 
+    'vol': '27', 
+    'mt': '0', 
+    'pa': '1', 
+    'rm': '0', 
+    'ts': '0', 
+    'lb': '17', 
+    'tp': '3', 
+    'wr': '0', 
+    'as': '0', 
+    'rg': '0'
+}
+
+A.6x
 {
     "id": "1",
     "ac": "0",
@@ -156,7 +245,7 @@ JSON Structure
 
 DO NOT CHANGE - VSSL Defined
 
-A3.x
+A.3x
 {
     "mono": "0",
     "AiNm": "Analog In 1",
@@ -172,7 +261,23 @@ A3.x
     "vold": "0"
 }
 
-A6.x
+A.3
+{
+    'mono': '0', 
+    'AiNm': 'Backup', 
+    'eq1': '106', 
+    'eq2': '102', 
+    'eq3': '100', 
+    'eq4': '100', 
+    'eq5': '100', 
+    'eq6': '101', 
+    'eq7': '105', 
+    'voll': '75', 
+    'volr': '75', 
+    'vold': '27'
+}
+
+A.6x
 {
     "mono": "0",
     "AiNm": "",
@@ -210,7 +315,7 @@ JSON Structure
 
 DO NOT CHANGE - VSSL Defined
 
-A3.x
+A.3x
 {
     "ECO": "0",
     "eqsw": "1",
@@ -227,7 +332,23 @@ A3.x
     "AtPwr": "1"
 }
 
-A6.x
+A.3
+{
+    "ECO": "0", 
+    "eqsw": "1", 
+    "inSrc": "0", 
+    "SP": "0", 
+    "BF1": "0", 
+    "BF2": "0", 
+    "GRM": "0", 
+    "GRS": "255", 
+    "Pwr": "0", 
+    "Bvr": "15", 
+    "fxv": "25", 
+    "AtPwr": "1"
+}
+
+A.6x
 {
     "ECO": "0",
     "eqsw": "1",

vsslctrl-0.1.8.dev1/vsslctrl/device.py

@@ -0,0 +1,261 @@
+from .data_structure import VsslEnum, VsslIntEnum, ZoneIDs
+from .io import AnalogOutput, InputRouter
+
+
+"""
+Model Physical IOs, sourced from the product manuals
+
+A.1x:
+SUB OUT
+ANALOG IN 1
+ANALOG OUT 1
+COAXIAL IN (Are Coxial and Optical inputs linked?)
+COAXIAL OUT
+OPTICAL IN
+OPTICAL OUT
+IR REMOTE
+
+A1:
+SUB OUT
+ANALOG IN 1
+ANALOG OUT 1
+COAXIAL IN (Are Coxial and Optical inputs linked?)
+COAXIAL OUT
+OPTICAL IN
+OPTICAL OUT
+IR REMOTE
+
+
+
+A.3x:
+ANALOG IN 1
+ANALOG IN 2
+ANALOG IN 3
+ANALOG OUT 1
+ANALOG OUT 2
+ANALOG OUT 3
+OPTICAL IN
+IR REMOTE
+
+A3:
+BUS 1 IN
+BUS 1 OUT
+ANALOG IN 1
+ANALOG IN 2
+ANALOG IN 3
+OPTICAL IN
+
+
+
+A.6x:
+ANALOG IN 1
+ANALOG IN 2
+ANALOG IN 3
+ANALOG IN 4
+ANALOG IN 5
+ANALOG IN 6
+ANALOG OUT 1
+ANALOG OUT 2
+ANALOG OUT 3
+ANALOG OUT 4
+ANALOG OUT 5
+ANALOG OUT 6
+OPTICAL IN
+IR REMOTE
+
+A6:
+BUS 1 IN
+BUS 1 OUT
+BUS 2 IN
+BUS 2 OUT
+ANALOG IN 1
+ANALOG IN 2
+ANALOG IN 3
+ANALOG IN 4
+ANALOG IN 5
+ANALOG IN 6
+
+---------------------------------
+
+Analog Input Source legend: input: inputs specific to model (e.g. A3 does not have zones 4-6 or bus input 2, only A3 has optical input, ...) 
+
+
+0 - none 
+1 - bus input 1 
+2 - bus input 2 
+3 - zone 1 local input 
+4 - zone 2 local input 
+5 - zone 3 local input 
+6 - zone 4 local input 
+7 - zone 5 local input 
+8 - zone 6 local input 
+16 - optical input
+
+
+Source: https://vssl.gitbook.io/vssl-rest-api/zone-control/set-analog-input-source
+
+
+"""
+
+
+""" 
+    Zones 
+
+
+"""
+SINGLE_ZONE = [ZoneIDs.A1]
+THREE_ZONES = [ZoneIDs.ZONE_1, ZoneIDs.ZONE_2, ZoneIDs.ZONE_3]
+SIX_ZONES = THREE_ZONES + [ZoneIDs.ZONE_4, ZoneIDs.ZONE_5, ZoneIDs.ZONE_6]
+
+""" 
+    Input Sources
+
+
+"""
+
+# A.1 & A.1x
+INPUT_SOURCES_FOR_1_ZONE_DEVICE = [
+    InputRouter.Sources.STREAM,
+    InputRouter.Sources.ANALOG_IN_1,
+    InputRouter.Sources.OPTICAL_IN,
+]
+
+# A.3x
+INPUT_SOURCES_FOR_3_ZONE_DEVICE = INPUT_SOURCES_FOR_1_ZONE_DEVICE + [
+    InputRouter.Sources.ANALOG_IN_2,
+    InputRouter.Sources.ANALOG_IN_3,
+]
+
+# A.3
+INPUT_SOURCES_FOR_A3 = INPUT_SOURCES_FOR_3_ZONE_DEVICE + [InputRouter.Sources.BUS_IN_1]
+
+# A.6x
+INPUT_SOURCES_FOR_6_ZONE_DEVICE = INPUT_SOURCES_FOR_3_ZONE_DEVICE + [
+    InputRouter.Sources.ANALOG_IN_4,
+    InputRouter.Sources.ANALOG_IN_5,
+    InputRouter.Sources.ANALOG_IN_6,
+]
+
+# A.6
+INPUT_SOURCES_FOR_A6 = [
+    source for source in InputRouter.Sources if source != InputRouter.Sources.OPTICAL_IN
+]
+
+
+""" 
+    Analog Output Sources
+
+
+"""
+
+# A.1 & A.1x
+ANALOG_OUTPUT_SOURCES_FOR_1_ZONE_DEVICE = [
+    AnalogOutput.Sources.OFF,
+    AnalogOutput.Sources.ZONE_1,
+    AnalogOutput.Sources.OPTICAL_IN,
+]
+
+# A.3x
+ANALOG_OUTPUT_SOURCES_FOR_3_ZONE_DEVICE = ANALOG_OUTPUT_SOURCES_FOR_1_ZONE_DEVICE + [
+    AnalogOutput.Sources.ZONE_2,
+    AnalogOutput.Sources.ZONE_3,
+]
+
+# A.3
+ANALOG_OUTPUT_SOURCES_FOR_A3 = ANALOG_OUTPUT_SOURCES_FOR_3_ZONE_DEVICE + [
+    AnalogOutput.Sources.BUS_IN_1
+]
+
+# A.6x
+ANALOG_OUTPUT_SOURCES_FOR_6_ZONE_DEVICE = ANALOG_OUTPUT_SOURCES_FOR_3_ZONE_DEVICE + [
+    AnalogOutput.Sources.ZONE_4,
+    AnalogOutput.Sources.ZONE_5,
+    AnalogOutput.Sources.ZONE_6,
+]
+
+# A.6
+ANALOG_OUTPUT_SOURCES_FOR_A6 = list(AnalogOutput.Sources)
+
+
+class Features(VsslIntEnum):
+    GROUPING = 1000
+    BLUETOOTH = 1001
+    PARTY_MODE = 1002
+    SUBWOOFER_CROSSOVER = 1003
+
+
+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": "A.1",
+            "zones": SINGLE_ZONE,
+            "input_sources": INPUT_SOURCES_FOR_1_ZONE_DEVICE,
+            "analog_output_sources": ANALOG_OUTPUT_SOURCES_FOR_1_ZONE_DEVICE,
+            "features": [Features.BLUETOOTH, Features.SUBWOOFER_CROSSOVER],
+        }
+    )
+    A3 = Model(
+        {
+            "name": "A.3",
+            "zones": THREE_ZONES,
+            "input_sources": INPUT_SOURCES_FOR_A3,
+            "analog_output_sources": ANALOG_OUTPUT_SOURCES_FOR_A3,
+            "features": [Features.GROUPING, Features.PARTY_MODE],
+        }
+    )
+    A6 = Model(
+        {
+            "name": "A.6",
+            "zones": SIX_ZONES,
+            "input_sources": INPUT_SOURCES_FOR_A6,
+            "analog_output_sources": ANALOG_OUTPUT_SOURCES_FOR_A6,
+            "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.BLUETOOTH, Features.SUBWOOFER_CROSSOVER],
+        }
+    )
+    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.6.dev1 → vsslctrl-0.1.8.dev1}/vsslctrl/discovery.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 
-""" Scan for apple devices. """
+""" UNTESTED AND IN DEV """
 
 import json
 import asyncio

{vsslctrl-0.1.6.dev1 → vsslctrl-0.1.8.dev1}/vsslctrl/io.py

@@ -9,8 +9,8 @@ class InputRouter(ZoneDataClass):
     #
     # Input Priority
     #
-    # 0: Stream -> Analog Input
-    # 1: Analog Input -> Stream (Local first)
+    # 0: Stream -> Party Zone -> Bus 1 In -> Bus 2 In -> Analog Input (Stream First)
+    # 1: Bus 1 In -> Bus 2 In -> Analog Input -> Stream -> Party Zone (Local First)
     #
     # DO NOT CHANGE - VSSL Defined
     #
@@ -25,6 +25,8 @@ class InputRouter(ZoneDataClass):
     #
     class Sources(VsslIntEnum):
         STREAM = 0
+        BUS_IN_1 = 1  # TODO bus or party mode of original A series
+        BUS_IN_2 = 2  # TODO bus or party mode of original A series
         ANALOG_IN_1 = 3
         ANALOG_IN_2 = 4
         ANALOG_IN_3 = 5
@@ -49,8 +51,8 @@ class InputRouter(ZoneDataClass):
     def __init__(self, zone: "zone.Zone"):
         self.zone = zone
 
-        self._priority = self.Priorities.STREAM
-        self._source = self.Sources.STREAM
+        self._priority = self.DEFAULTS["priority"]
+        self._source = self.DEFAULTS["source"]
 
     #
     # Input Priority
@@ -103,8 +105,14 @@ class InputRouter(ZoneDataClass):
 
 class AnalogOutput(ZoneDataClass):
     """
+
+    Analog output is the source which will play out the corrosponding analog output
+
+
     Should this be on the VSSL or Zone? For now its on the zone, because the zone will
     receive feedback for the corrosponding analog output id
+
+    Zones will be determined by source Input Priority
     """
 
     #
@@ -114,6 +122,8 @@ class AnalogOutput(ZoneDataClass):
     #
     class Sources(VsslIntEnum):
         OFF = 0  # Disconnected / Off / No Output
+        BUS_IN_1 = 1  # TODO bus or party mode of original A series
+        BUS_IN_2 = 2  # TODO bus or party mode of original A series
         ZONE_1 = 3
         ZONE_2 = 4
         ZONE_3 = 5
@@ -138,7 +148,7 @@ class AnalogOutput(ZoneDataClass):
     def __init__(self, zone: "zone.Zone"):
         self.zone = zone
 
-        self._is_fixed_volume = False
+        self._is_fixed_volume = self.DEFAULTS["is_fixed_volume"]
         self._source = self.Sources(zone.id + 2)
 
     #
@@ -158,6 +168,8 @@ class AnalogOutput(ZoneDataClass):
     #
     # Analog Output Source
     #
+    # As in what audio is going to be sent to the analog output.
+    #
     @property
     def source(self):
         return self._source
@@ -199,7 +211,7 @@ class AnalogInput(ZoneDataClass):
         self.zone = zone
 
         self._name = f"Analog In {self.zone.id}"
-        self._fixed_gain = 0
+        self._fixed_gain = self.DEFAULTS["fixed_gain"]
 
     #
     # Analog Input Name

{vsslctrl-0.1.6.dev1 → vsslctrl-0.1.8.dev1}/vsslctrl/settings.py

@@ -2,6 +2,7 @@ import logging
 from typing import Dict, Union
 from .utils import clamp_volume
 from .io import AnalogInput
+from .device import Features as DeviceFeatures
 from .data_structure import (
     VsslIntEnum,
     VsslDataClass,
@@ -16,6 +17,7 @@ class VsslSettings(VsslDataClass):
     class Keys:
         NAME = "name"
         OPTICAL_INPUT_NAME = "optical_input_name"
+        BLUETOOTH = "bluetooth"
 
     #
     # VSSL Events
@@ -24,17 +26,23 @@ class VsslSettings(VsslDataClass):
         PREFIX = VSSL_SETTINGS_EVENT_PREFIX
         NAME_CHANGE = PREFIX + "name_changed"
         OPTICAL_INPUT_NAME_CHANGE = PREFIX + "optical_input_name_changed"
+        BLUETOOTH_CHANGE = PREFIX + "bluetooth_changed"
 
     #
     # Defaults
     #
-    DEFAULTS = {Keys.NAME: None, Keys.OPTICAL_INPUT_NAME: "Optical In"}
+    DEFAULTS = {
+        Keys.NAME: None,
+        Keys.OPTICAL_INPUT_NAME: "Optical In",
+        Keys.BLUETOOTH: 0,
+    }
 
     def __init__(self, vssl: "vsslctrl.Vssl"):
         self._vssl = vssl
 
         self._name = None  # device name
         self._optical_input_name = self.DEFAULTS[self.Keys.OPTICAL_INPUT_NAME]
+        self._bluetooth = self.DEFAULTS[self.Keys.BLUETOOTH]
         self.power = VsslPowerSettings(vssl)
 
     #
@@ -63,6 +71,30 @@ class VsslSettings(VsslDataClass):
         if zone:
             zone.api_alpha.request_action_15_12(name)
 
+    #
+    # Bluetooth
+    #
+    @property
+    def bluetooth(self):
+        return bool(self._bluetooth)
+
+    @bluetooth.setter
+    def bluetooth(self, enabled: bool):
+        if not self._vssl.model.supports_feature(DeviceFeatures.BLUETOOTH):
+            self._vssl._log_error(
+                f"VSSL {self._vssl.model.name} does not support Bluetooth"
+            )
+            return
+
+        zone = self._vssl.get_connected_zone()
+        if zone:
+            # TODO
+            # zone.api_alpha.request_action_bluetooth(not not enabled)
+            self._vssl._log_info(f"TODO - bluetooth set function")
+
+    def bluetooth_toggle(self):
+        self.bluetooth = False if self.bluetooth else True
+
 
 class VsslPowerSettings(VsslDataClass):
     #
@@ -86,13 +118,13 @@ class VsslPowerSettings(VsslDataClass):
     #
     # Defaults
     #
-    DEFAULTS = {"state": States.ON, "adaptive": False}
+    DEFAULTS = {"state": States.ON, "adaptive": True}
 
     def __init__(self, vssl: "vsslctrl.Vssl"):
         self._vssl = vssl
 
-        self._state = self.States.ON
-        self._adaptive = True  # 1 = auto, 0 = always on
+        self._state = self.DEFAULTS["state"]
+        self._adaptive = self.DEFAULTS["adaptive"]  # 1 = auto, 0 = always on
 
     #
     # Power State
@@ -165,6 +197,7 @@ class ZoneSettings(ZoneDataClass):
         self._mono = self.StereoMono.Stereo
 
         self.eq = EQSettings(zone)
+        self.subwoofer = SubwooferSettings(zone)
         self.volume = VolumeSettings(zone)
         self.analog_input = AnalogInput(zone)
 
@@ -653,3 +686,60 @@ class EQSettings(ZoneDataClass):
     @khz15_db.setter
     def khz15_db(self, val: int):
         self._set_frequency_on_device_db(self.Freqs.KHZ15, val)
+
+
+# Not in io.py to prevent circ import in device.py
+class SubwooferSettings(ZoneDataClass):
+    MIN_VALUE = 0
+    MAX_VALUE = 1000
+
+    #
+    # Subwoofer events
+    #
+    class Events:
+        PREFIX = "zone.subwoofer."
+        CROSSOVER_CHANGE = PREFIX + "crossover_change"
+
+    #
+    # Defaults
+    #
+    DEFAULTS = {"crossover": 0}
+
+    def __init__(self, zone: "zone.Zone"):
+        self.zone = zone
+
+        self._crossover = self.DEFAULTS["crossover"]
+
+    #
+    # Clamp between min and max
+    #
+    def _clamp_crossover(self, value: int = 100):
+        return int(max(self.MIN_VALUE, min(value, self.MAX_VALUE)))
+
+    #
+    # Crossover freq
+    #
+    @property
+    def crossover(self):
+        return self._crossover
+
+    @crossover.setter
+    def crossover(self, freq: int):
+        if not self.zone.vssl.model.supports_feature(
+            DeviceFeatures.SUBWOOFER_CROSSOVER
+        ):
+            self.zone._log_error(
+                f"VSSL {self.zone.vssl.model.name} does not have a subwoofer output"
+            )
+            return
+        #
+        # TODO
+        #
+        self.zone._log_info(f"TODO - crossover set function")
+        # self.zone.api_alpha.request_action_crossover(freq)
+
+    def _set_crossover(self, freq: int):
+        freq = self._clamp_crossover(freq)
+        if self.crossover != freq:
+            self._crossover = freq
+            return True

{vsslctrl-0.1.6.dev1 → vsslctrl-0.1.8.dev1}/vsslctrl/zone.py

@@ -74,7 +74,7 @@ class Zone:
                 self._request_eq_status,
                 self._request_track,
                 self._request_name,
-                self._request_bt_status,
+                self._request_status_extended,
             ],
         )
 
@@ -128,6 +128,8 @@ class Zone:
         self.initialisation.set()
         self.vssl.event_bus.publish(self.Events.INITIALISED, self.id, self)
 
+        self._log_info(f"Zone {self.id} initialised")
+
         return self
 
     @property
@@ -406,7 +408,7 @@ class Zone:
         self.api_alpha.request_action_00_0A()
         return self
 
-    def _request_bt_status(self):
+    def _request_status_extended(self):
         self.api_alpha.request_action_00_0B()
         return self
 

{vsslctrl-0.1.6.dev1 → vsslctrl-0.1.8.dev1}/vsslctrl.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vsslctrl
-Version: 0.1.6.dev1
+Version: 0.1.8.dev1
 Summary: Package for controlling VSSL's range of streaming amplifiers
 Author-email: vsslctrl <vsslcontrolled@proton.me>
 Classifier: Development Status :: 4 - Beta
@@ -247,6 +247,13 @@ zone1.transport.state = ZoneTransport.States.PAUSE
 | `source`     			 	| Change input source |	`int`	| `InputRouter.Sources`
 | `priority`     			| Change input priority. Stream or analog in higher priority  |	`int`	| `InputRouter.Priorities`
 
+### Priority Order:
+
+| `InputRouter.Priorities`       | Priority Order |
+| ----------------------  | ----------- |
+| **`STREAM`**  | <ol><li>Stream</li><li>Party Zone</li><li>Bus 1 In</li><li>Bus 2 In</li><li>Analog Input</li></ol>
+|  **`LOCAL`**  | <ol><li>Bus 1 In</li><li>Bus 2 In</li><li>Analog Input</li><li>Stream</li><li>Party Zone</li></ol>
+
 ```python
 """Example"""
 # Change zone 1 to listen to analog input 4

vsslctrl-0.1.6.dev1/vsslctrl/device.py

@@ -1,115 +0,0 @@
-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],
-        }
-    )