vsslctrl 0.1.4.dev1__tar.gz → 0.1.6.dev1__tar.gz

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

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: vsslctrl
-Version: 0.1.4.dev1
-Summary: Package for controlling VSSL amplifiers
+Version: 0.1.6.dev1
+Summary: Package for controlling VSSL's range of streaming amplifiers
 Author-email: vsslctrl <vsslcontrolled@proton.me>
 Classifier: Development Status :: 4 - Beta
 Classifier: Programming Language :: Python :: 3
@@ -20,29 +20,30 @@ Provides-Extra: optional
 Requires-Dist: zeroconf==0.132.2; extra == "optional"
 
 # vsslctrl
- Package for controlling [VSSL](https://www.vssl.com/) range of streaming amplifiers.
+
+ Package for controlling [VSSL's](https://www.vssl.com/) range of streaming amplifiers.
 
  **`vsslctrl` is not endorsed or affiliated with [VSSL](https://www.vssl.com/) in any manner.**
 
- Motovation for this project was to intergrate VSSLs amplifiers into [Home Assistant](https://www.home-assistant.io/) and have control over different subnets (not mDNS dependant)
+## Help
+
+I am looking for testers with any VSSL amplifier models, please get in touch if you interested in helping. <vsslcontrolled@proton.me>
 
- I am looking for testers with any VSSL amplifier models, please get in touch if you interested in helping.
+Tested on:
+- Test suite run on a VSSL **A.3x** software version **p15305.016.3701**
+- The Home Assistant [integration](https://github.com/vsslctrl/integration.home-assistant) is reported working on a **A.6x** software version **p15305.017.3701**
 
-Important
------------
-Only tested on a VSSL **A.3x** software version **p15305.016.3701**.
+## 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.
+There should not be any *[VSSL Agent's](https://vssl.gitbook.io/vssl-rest-api/getting-started/start)* running on the same network. If you dont know what this is, then you can 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~~ (needs tests)
+* **A1(.x)** specific control e.g sub crossover, bluetooth
 * Better test coverage
 
-Basic Usage
------------
+## Basic Usage
+
 `vsslctrl` needs to be running inside a **[asyncio](https://docs.python.org/3/library/asyncio.html)** event loop.
 
 ```python
@@ -89,8 +90,7 @@ async def main():
 asyncio.run(main())
 ```
 
-API
------------
+# API
 
 Most functionality is achived via `getters` and `setters` of the two main classes `Vssl`, `Zone`. 
 
@@ -225,7 +225,7 @@ zone1.transport.state = ZoneTransport.States.PAUSE
 ## `Zone.track`
 
 * Not all sources have complete metadata - missing value will be set to defaults.
-* Airplay track position is not avaiable.
+* Airplay track `progress` is not avaiable.
 
 | Property      	| Description | Type		| Values 		| 
 | ---------------------- | ----------- | ----------- |----------- |
@@ -282,10 +282,10 @@ zone1.group.dissolve()
 
 ## `Zone.analog_output`
 
-| Property      	| Description | Type		| Values 		| 
-| ---------------------- 	| ----------- | ----------- |----------- |
-| `source`     			 	| Where the AO is routed from. i.e a zone, optical input or off |	`int`	| `AnalogOutput.Sources`
-| `is_fixed_volume`   			| Fix the output volume. Output wont respond to volume control        |	`bool` readonly
+| Property      	| Description | Type		| Values 		| Default |
+| ---------------------- 	| ----------- | ----------- |----------- |----------- |
+| `source`     			 	| Where the AO is routed from. i.e a zone, optical input or off |	`int`	| `AnalogOutput.Sources` | `Off`
+| `is_fixed_volume`   			| Fix the output volume. Output wont respond to volume control        |	`bool` | |`False`
 | `is_fixed_volume_toggle()`   			| Toggle fixed volume      |	`func`  |
 
 ```python
@@ -302,12 +302,12 @@ zone1.analog_output.is_fixed_volume = True
 
 ## `Zone.settings`
 
-| Property      	| Description | Type		| Values 		| 
-| ---------------------- 	| ----------- | ----------- |----------- |
+| Property      	| Description | Type		| Values 		| Default |
+| ---------------------- 	| ----------- | ----------- |----------- |----------- |
 | `name`     			 	| Name |	`str`	| 
-| `disabled`   			| Disable the zone        |	`bool`
+| `disabled`   			| Disable the zone        |	`bool` || `False`
 | `disabled_toggle()`   			| disable / enable        |	`func`  |
-| `mono`   			| Set output to mono or stereo        |	`int`  | `ZoneSettings.StereoMono`
+| `mono`   			| Set output to mono or stereo        |	`int`  | `ZoneSettings.StereoMono` | `Stereo`
 | `mono_toggle()`   			| Toggle mono or stereo        |	`func`  |
 
 ```python
@@ -322,10 +322,10 @@ zone1.mono_toggle()
 
 ## `Zone.settings.analog_input`
 
-| Property      	| Description | Type		| Values 		| 
-| ---------------------- 	| ----------- | ----------- |----------- |
+| Property      	| Description | Type		| Values 		| Default |
+| ---------------------- 	| ----------- | ----------- |----------- |----------- |
 | `name`     			 	| Name |	`str`	| 
-| `fixed_gain`   		| Fix the input gain to a specific value       |`int` | `0...100`
+| `fixed_gain`   		| Fix the input gain to a specific value       |`int` | `0...100` | `0` is disabled or variable gain
 
 ```python
 """Examples"""
@@ -339,11 +339,11 @@ zone1.settings.analog_input.fixed_gain = 50
 
 ## `Zone.settings.volume`
 
-| Property      	| Description | Type		| Values 		| 
-| ---------------------- 	| ----------- | ----------- |----------- |
-| `default_on`     			 	| Default on volume  |	`int`  | `0...100` 
-| `max_left`     			 	| Max volume left channel  |	`int`  | `0...100` 
-| `max_right`     			 	| Max volume right channel  |	`int`  | `0...100` 
+| Property      	| Description | Type		| Values 		| Default |
+| ---------------------- 	| ----------- | ----------- |----------- |----------- |
+| `default_on`     			 	| Default on volume  |	`int`  | `0...100` | `0` is disabled
+| `max_left`     			 	| Max volume left channel  |	`int`  | `0...100` | `75`
+| `max_right`     			 	| Max volume right channel  |	`int`  | `0...100` | `75`
 
 ```python
 """Examples"""
@@ -355,21 +355,21 @@ zone1.settings.volume.default_on = 75
 
 ## `Zone.settings.eq`
 
-| Property      	| Description | Type		| Values 		| 
-| ---------------------- 	| ----------- | ----------- |----------- |
-| `enabled`     			 	| Enable / disable EQ        |	`bool` 
+| Property      	| Description | Type		| Values 		| Default |
+| ---------------------- 	| ----------- | ----------- |----------- |----------- |
+| `enabled`     			 	| Enable / disable EQ        |	`bool` | | `False`
 
 EQ to be set in [decibel](https://en.wikipedia.org/wiki/Decibel) using a range `-10`dB to `+10`dB
 
-| Property      	| Description | Type		| Values 		| 
-| ---------------------- 	| ----------- | ----------- |----------- | 
-| `hz60_db`     			 	| 60Hz |	`int`  | `-10...10`
-| `hz200_db`     			 	| 200Hz |	`int`  | `-10...10`
-| `hz500_db`     			 	| 500Hz |	`int`  | `-10...10`
-| `khz1_db`     			 	| 1kHz |	`int`  | `-10...10`
-| `khz4_db`     			 	| 4kHz |	`int`  | `-10...10`
-| `khz8_db`     			 	| 8kHz |	`int`  | `-10...10`
-| `khz15_db`     			 	| 15kHz |	`int`  | `-10...10`
+| Property      	| Description | Type		| Values 		| Default |
+| ---------------------- 	| ----------- | ----------- |----------- | ----------- |
+| `hz60_db`     			 	| 60Hz |	`int`  | `-10...10` | `0`
+| `hz200_db`     			 	| 200Hz |	`int`  | `-10...10` | `0`
+| `hz500_db`     			 	| 500Hz |	`int`  | `-10...10` | `0`
+| `khz1_db`     			 	| 1kHz |	`int`  | `-10...10` | `0`
+| `khz4_db`     			 	| 4kHz |	`int`  | `-10...10` | `0`
+| `khz8_db`     			 	| 8kHz |	`int`  | `-10...10` | `0`
+| `khz15_db`     			 	| 15kHz |	`int`  | `-10...10` | `0`
 
 ```python
 """Examples"""
@@ -379,7 +379,7 @@ 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`.
+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 any network tool) on port `50002`.
 
 | HEX      	| Description |
 | ---------------------- 	| ----------- |
@@ -428,13 +428,15 @@ shell_command:
 
 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).
 
+Motovation for this project was to intergrate VSSLs amplifiers into [Home Assistant](https://www.home-assistant.io/) and have control over different subnets (not mDNS dependant)
+
 ## Known Issues & Limitiations
 
-* Tested on VSSL **A.3x** software version **p15305.016.3701**
-* Not tested on A.1x, A.6.x or original A series range of amplifiers (testers welcome)
+* Not tested on A.1x or original A series range of amplifiers (testers welcome)
 * VSSL can not start a stream except for playing a URL directly. This is a limitation of the hardware itself.
 * Not all sources set the volume to 0 when the zone is muted
 * Grouping feedback is flaky on the X series amplifiers
+* Airplay `Zone.track.progress` is not avaiable.
 * Cant stop a URL playback, feedback is worng at least
 * VSSL likes to cache old track metadata. For example when playing a URL after Spotify, often the device will respond with the previous (Spotify) tracks metadata
 * `stop()` is intended to disconnect the client and pause the stream. Doesnt always function this way, depending on stream source
@@ -442,8 +444,8 @@ The VSSL API was reverse engineered using Wireshark, VSSLs native "legacy" iOS a
 
 ## Future
 
+* A.1(x) coverage i.e Bluetooth and subwoofer control
 * REST API / Web App
 * Save and recall EQ
-* A.1(x) coverage i.e Bluetooth
 * IR Control
 

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

@@ -1,27 +1,28 @@
 # vsslctrl
- Package for controlling [VSSL](https://www.vssl.com/) range of streaming amplifiers.
+
+ Package for controlling [VSSL's](https://www.vssl.com/) range of streaming amplifiers.
 
  **`vsslctrl` is not endorsed or affiliated with [VSSL](https://www.vssl.com/) in any manner.**
 
- Motovation for this project was to intergrate VSSLs amplifiers into [Home Assistant](https://www.home-assistant.io/) and have control over different subnets (not mDNS dependant)
+## Help
+
+I am looking for testers with any VSSL amplifier models, please get in touch if you interested in helping. <vsslcontrolled@proton.me>
 
- I am looking for testers with any VSSL amplifier models, please get in touch if you interested in helping.
+Tested on:
+- Test suite run on a VSSL **A.3x** software version **p15305.016.3701**
+- The Home Assistant [integration](https://github.com/vsslctrl/integration.home-assistant) is reported working on a **A.6x** software version **p15305.017.3701**
 
-Important
------------
-Only tested on a VSSL **A.3x** software version **p15305.016.3701**.
+## 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.
+There should not be any *[VSSL Agent's](https://vssl.gitbook.io/vssl-rest-api/getting-started/start)* running on the same network. If you dont know what this is, then you can 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~~ (needs tests)
+* **A1(.x)** specific control e.g sub crossover, bluetooth
 * Better test coverage
 
-Basic Usage
------------
+## Basic Usage
+
 `vsslctrl` needs to be running inside a **[asyncio](https://docs.python.org/3/library/asyncio.html)** event loop.
 
 ```python
@@ -68,8 +69,7 @@ async def main():
 asyncio.run(main())
 ```
 
-API
------------
+# API
 
 Most functionality is achived via `getters` and `setters` of the two main classes `Vssl`, `Zone`. 
 
@@ -204,7 +204,7 @@ zone1.transport.state = ZoneTransport.States.PAUSE
 ## `Zone.track`
 
 * Not all sources have complete metadata - missing value will be set to defaults.
-* Airplay track position is not avaiable.
+* Airplay track `progress` is not avaiable.
 
 | Property      	| Description | Type		| Values 		| 
 | ---------------------- | ----------- | ----------- |----------- |
@@ -261,10 +261,10 @@ zone1.group.dissolve()
 
 ## `Zone.analog_output`
 
-| Property      	| Description | Type		| Values 		| 
-| ---------------------- 	| ----------- | ----------- |----------- |
-| `source`     			 	| Where the AO is routed from. i.e a zone, optical input or off |	`int`	| `AnalogOutput.Sources`
-| `is_fixed_volume`   			| Fix the output volume. Output wont respond to volume control        |	`bool` readonly
+| Property      	| Description | Type		| Values 		| Default |
+| ---------------------- 	| ----------- | ----------- |----------- |----------- |
+| `source`     			 	| Where the AO is routed from. i.e a zone, optical input or off |	`int`	| `AnalogOutput.Sources` | `Off`
+| `is_fixed_volume`   			| Fix the output volume. Output wont respond to volume control        |	`bool` | |`False`
 | `is_fixed_volume_toggle()`   			| Toggle fixed volume      |	`func`  |
 
 ```python
@@ -281,12 +281,12 @@ zone1.analog_output.is_fixed_volume = True
 
 ## `Zone.settings`
 
-| Property      	| Description | Type		| Values 		| 
-| ---------------------- 	| ----------- | ----------- |----------- |
+| Property      	| Description | Type		| Values 		| Default |
+| ---------------------- 	| ----------- | ----------- |----------- |----------- |
 | `name`     			 	| Name |	`str`	| 
-| `disabled`   			| Disable the zone        |	`bool`
+| `disabled`   			| Disable the zone        |	`bool` || `False`
 | `disabled_toggle()`   			| disable / enable        |	`func`  |
-| `mono`   			| Set output to mono or stereo        |	`int`  | `ZoneSettings.StereoMono`
+| `mono`   			| Set output to mono or stereo        |	`int`  | `ZoneSettings.StereoMono` | `Stereo`
 | `mono_toggle()`   			| Toggle mono or stereo        |	`func`  |
 
 ```python
@@ -301,10 +301,10 @@ zone1.mono_toggle()
 
 ## `Zone.settings.analog_input`
 
-| Property      	| Description | Type		| Values 		| 
-| ---------------------- 	| ----------- | ----------- |----------- |
+| Property      	| Description | Type		| Values 		| Default |
+| ---------------------- 	| ----------- | ----------- |----------- |----------- |
 | `name`     			 	| Name |	`str`	| 
-| `fixed_gain`   		| Fix the input gain to a specific value       |`int` | `0...100`
+| `fixed_gain`   		| Fix the input gain to a specific value       |`int` | `0...100` | `0` is disabled or variable gain
 
 ```python
 """Examples"""
@@ -318,11 +318,11 @@ zone1.settings.analog_input.fixed_gain = 50
 
 ## `Zone.settings.volume`
 
-| Property      	| Description | Type		| Values 		| 
-| ---------------------- 	| ----------- | ----------- |----------- |
-| `default_on`     			 	| Default on volume  |	`int`  | `0...100` 
-| `max_left`     			 	| Max volume left channel  |	`int`  | `0...100` 
-| `max_right`     			 	| Max volume right channel  |	`int`  | `0...100` 
+| Property      	| Description | Type		| Values 		| Default |
+| ---------------------- 	| ----------- | ----------- |----------- |----------- |
+| `default_on`     			 	| Default on volume  |	`int`  | `0...100` | `0` is disabled
+| `max_left`     			 	| Max volume left channel  |	`int`  | `0...100` | `75`
+| `max_right`     			 	| Max volume right channel  |	`int`  | `0...100` | `75`
 
 ```python
 """Examples"""
@@ -334,21 +334,21 @@ zone1.settings.volume.default_on = 75
 
 ## `Zone.settings.eq`
 
-| Property      	| Description | Type		| Values 		| 
-| ---------------------- 	| ----------- | ----------- |----------- |
-| `enabled`     			 	| Enable / disable EQ        |	`bool` 
+| Property      	| Description | Type		| Values 		| Default |
+| ---------------------- 	| ----------- | ----------- |----------- |----------- |
+| `enabled`     			 	| Enable / disable EQ        |	`bool` | | `False`
 
 EQ to be set in [decibel](https://en.wikipedia.org/wiki/Decibel) using a range `-10`dB to `+10`dB
 
-| Property      	| Description | Type		| Values 		| 
-| ---------------------- 	| ----------- | ----------- |----------- | 
-| `hz60_db`     			 	| 60Hz |	`int`  | `-10...10`
-| `hz200_db`     			 	| 200Hz |	`int`  | `-10...10`
-| `hz500_db`     			 	| 500Hz |	`int`  | `-10...10`
-| `khz1_db`     			 	| 1kHz |	`int`  | `-10...10`
-| `khz4_db`     			 	| 4kHz |	`int`  | `-10...10`
-| `khz8_db`     			 	| 8kHz |	`int`  | `-10...10`
-| `khz15_db`     			 	| 15kHz |	`int`  | `-10...10`
+| Property      	| Description | Type		| Values 		| Default |
+| ---------------------- 	| ----------- | ----------- |----------- | ----------- |
+| `hz60_db`     			 	| 60Hz |	`int`  | `-10...10` | `0`
+| `hz200_db`     			 	| 200Hz |	`int`  | `-10...10` | `0`
+| `hz500_db`     			 	| 500Hz |	`int`  | `-10...10` | `0`
+| `khz1_db`     			 	| 1kHz |	`int`  | `-10...10` | `0`
+| `khz4_db`     			 	| 4kHz |	`int`  | `-10...10` | `0`
+| `khz8_db`     			 	| 8kHz |	`int`  | `-10...10` | `0`
+| `khz15_db`     			 	| 15kHz |	`int`  | `-10...10` | `0`
 
 ```python
 """Examples"""
@@ -358,7 +358,7 @@ 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`.
+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 any network tool) on port `50002`.
 
 | HEX      	| Description |
 | ---------------------- 	| ----------- |
@@ -407,13 +407,15 @@ shell_command:
 
 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).
 
+Motovation for this project was to intergrate VSSLs amplifiers into [Home Assistant](https://www.home-assistant.io/) and have control over different subnets (not mDNS dependant)
+
 ## Known Issues & Limitiations
 
-* Tested on VSSL **A.3x** software version **p15305.016.3701**
-* Not tested on A.1x, A.6.x or original A series range of amplifiers (testers welcome)
+* Not tested on A.1x or original A series range of amplifiers (testers welcome)
 * VSSL can not start a stream except for playing a URL directly. This is a limitation of the hardware itself.
 * Not all sources set the volume to 0 when the zone is muted
 * Grouping feedback is flaky on the X series amplifiers
+* Airplay `Zone.track.progress` is not avaiable.
 * Cant stop a URL playback, feedback is worng at least
 * VSSL likes to cache old track metadata. For example when playing a URL after Spotify, often the device will respond with the previous (Spotify) tracks metadata
 * `stop()` is intended to disconnect the client and pause the stream. Doesnt always function this way, depending on stream source
@@ -421,8 +423,8 @@ The VSSL API was reverse engineered using Wireshark, VSSLs native "legacy" iOS a
 
 ## Future
 
+* A.1(x) coverage i.e Bluetooth and subwoofer control
 * REST API / Web App
 * Save and recall EQ
-* A.1(x) coverage i.e Bluetooth
 * IR Control
 

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

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

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

@@ -9,7 +9,7 @@ from .api_base import APIBase
 from .transport import ZoneTransport
 from .settings import EQSettings
 
-from .utils import hex_to_int, clamp_volume
+from .utils import hex_to_int, clamp_volume, hex_to_bytearray_string
 from .decorators import logging_helpers
 from .data_structure import (
     ZoneStatusExtKeys,
@@ -199,7 +199,7 @@ class APIAlpha(APIBase):
     # EQ
     #
     def request_action_0D(self, freq: "EQSettings.Freqs", value: int = 0):
-        clamped = max(90, min(value, 110))
+        clamped = max(EQSettings.MIN_VALUE, min(value, EQSettings.MAX_VALUE))
         self._log_debug(
             f"Requesting to set EQ: {freq.name[1:]} ({freq.value}) to {clamped}"
         )
@@ -924,9 +924,9 @@ class APIAlpha(APIBase):
 
     #
     # 17 [23]
-    # Received Keep Alive
+    # Keep Alive
     #
-    def response_action_17(self, response: bytes):
+    def response_action_17(self, hexl: list, response: bytes):
         self._log_debug(f"Z{self.zone.id} Alpha - Received keep alive: {response}")
         # TODO
         pass
@@ -1026,8 +1026,9 @@ class APIAlpha(APIBase):
     # Command confimation
     #
     def response_action_confimation(self, response: bytes):
+        cmd = response.hex()
         self._log_debug(
-            f"Received command confimation: {response[1]}. Hex: {response.hex()}"
+            f"Received command confimation: {hex_to_bytearray_string(cmd)} Hex: {cmd}"
         )
 
     #
@@ -1035,6 +1036,7 @@ class APIAlpha(APIBase):
     # Default Action
     #
     def response_action_default(self, hexl: list, response: bytes):
+        cmd = response.hex()
         self._log_debug(
-            f"Received unknown command {hexl[1].upper()}. Hex: {response.hex()}"
+            f"Received unknown command: {hex_to_bytearray_string(cmd)} Hex: {cmd}"
         )

{vsslctrl-0.1.4.dev1 → vsslctrl-0.1.6.dev1}/vsslctrl/api_base.py

@@ -158,6 +158,19 @@ class APIBase(ABC):
 
             except asyncio.CancelledError:
                 self._log_debug(f"writer close timeout")
+            except asyncio.TimeoutError as e:
+                self._log_error(f"Timeout while closing connection: {e}")
+                # Handle the timeout: log, retry, or take other actions
+            except ConnectionResetError as e:
+                self._log_error(f"Connection reset by peer: {e}")
+                # Handle the error: log, retry, or take other actions
+            except Exception as e:
+                self._log_error(f"Unexpected error occurred while disconnecting: {e}")
+                # Handle unexpected errors
+            finally:
+                self._writer = None
+
+        self._reader = None
 
         self._log_info(f"{self.host}:{self.port}: disconnected")
 

{vsslctrl-0.1.4.dev1 → vsslctrl-0.1.6.dev1}/vsslctrl/api_bravo.py

@@ -5,7 +5,7 @@ import struct
 import logging
 
 from .api_base import APIBase
-from .utils import hex_to_int
+from .utils import hex_to_int, hex_to_bytearray_string
 from .decorators import logging_helpers
 from .data_structure import TrackMetadataExtKeys
 
@@ -407,8 +407,10 @@ class APIBravo(APIBase):
     #
     def response_action_70(self, hexl: list, response: bytes):
         length = 4 if hexl[0] == 16 else 10
-        cmd = hexl[length:]
-        self._log_debug(f"Command confirmation: {response[length:]}")
+        cmd = response[length:].hex()
+        self._log_debug(
+            f"Received command confimation: {hex_to_bytearray_string(cmd)} Hex: {cmd}"
+        )
 
     #
     # Default

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

@@ -69,7 +69,7 @@ class Vssl:
                     self.Events.MODEL_CHANGE, self.ENTITY_ID
                 )
 
-            # Lets make sure the zone is initialised, otherwsie we fail all
+            # Lets make sure the zone is initialised, otherwsie we fail for all zones
             await first_zone.initialise()
 
             # Only continue after we have a model

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

@@ -43,12 +43,35 @@ class ZoneIDs(VsslIntEnum):
     ZONE_6 = 6
 
 
-""" JSON Structure
-
- DO NOT CHANGE - VSSL Defined
-
- {'B1Src': '3', 'B2Src': '4', 'B3Src': '5', 'B1Nm': '', 'B2Nm': 'Optical In', 'dev': 'Device Name', 'ver': 'p15305.016.3701'}
-
+"""
+JSON Structure
+
+DO NOT CHANGE - VSSL Defined
+
+A3.x
+{
+    "B1Src": "3",
+    "B2Src": "4",
+    "B3Src": "5",
+    "B1Nm": "",
+    "B2Nm": "Optical In",
+    "dev": "Device Name",
+    "ver": "p15305.016.3701"
+}
+
+A6.x
+{
+    "B1Src": "3",
+    "B2Src": "4",
+    "B3Src": "5",
+    "B4Src": "6",
+    "B5Src": "7",
+    "B6Src": "8",
+    "B1Nm": "",
+    "B2Nm": "",
+    "dev": "VSSL A.6x",
+    "ver": "p15305.017.3701"
+}
 """
 
 
@@ -69,13 +92,50 @@ class DeviceStatusExtKeys:
         return f"B{zone_id}Src"
 
 
-""" JSON Structure
-
- DO NOT CHANGE - VSSL Defined
-
- {'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'}
-
+"""
+JSON Structure
+
+DO NOT CHANGE - VSSL Defined
+
+A3.x
+{
+    "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"
+}
+
+A6.x
+{
+    "id": "1",
+    "ac": "0",
+    "mc": "XXXXXXXXXXXX",
+    "vol": "50",
+    "mt": "0",
+    "pa": "0",
+    "rm": "0",
+    "ts": "0",
+    "alex": "126",
+    "nmd": "0",
+    "ird": "255",
+    "lb": "17",
+    "tp": "16",
+    "wr": "0",
+    "as": "0",
+    "rg": "0"
+}
 """
 
 
@@ -91,13 +151,42 @@ class ZoneStatusExtKeys:
     DISABLED = "wr"
 
 
-""" JSON Structure
-
- DO NOT CHANGE - VSSL Defined
-
- {'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'}
-
+"""
+JSON Structure
+
+DO NOT CHANGE - VSSL Defined
+
+A3.x
+{
+    "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"
+}
+
+A6.x
+{
+    "mono": "0",
+    "AiNm": "",
+    "eq1": "100",
+    "eq2": "100",
+    "eq3": "100",
+    "eq4": "100",
+    "eq5": "100",
+    "eq6": "100",
+    "eq7": "100",
+    "voll": "75",
+    "volr": "75",
+    "vold": "0"
+}
 """
 
 
@@ -116,13 +205,47 @@ class ZoneEQStatusExtKeys:
     VOL_DEFAULT_ON = "vold"
 
 
-""" JSON Structure
-
- DO NOT CHANGE - VSSL Defined
-
- {'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'}
-
+"""
+JSON Structure
+
+DO NOT CHANGE - VSSL Defined
+
+A3.x
+{
+    "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"
+}
+
+A6.x
+{
+    "ECO": "0",
+    "eqsw": "1",
+    "inSrc": "0",
+    "SP": "0",
+    "BF1": "0",
+    "BF2": "0",
+    "BF3": "0",
+    "BF4": "0",
+    "BF5": "0",
+    "BF6": "0",
+    "GRM": "0",
+    "GRS": "255",
+    "Pwr": "0",
+    "Bvr": "2",
+    "fxv": "25",
+    "AtPwr": "1"
+}
 """
 
 
@@ -130,7 +253,12 @@ class ZoneRouterStatusExtKeys:
     EQ_ENABLED = "eqsw"
     INPUT_SOURCE = "inSrc"
     SOURCE_PRIORITY = "SP"
-    ANALOG_OUTPUT_FIXED_VOLUME_PREFIX = "BF"
+    ANALOG_OUTPUT_1_FIXED_VOLUME = "BF1"
+    ANALOG_OUTPUT_2_FIXED_VOLUME = "BF2"
+    ANALOG_OUTPUT_3_FIXED_VOLUME = "BF3"
+    ANALOG_OUTPUT_4_FIXED_VOLUME = "BF4"
+    ANALOG_OUTPUT_5_FIXED_VOLUME = "BF5"
+    ANALOG_OUTPUT_6_FIXED_VOLUME = "BF6"
     GROUP_SOURCE = "GRS"
     GROUP_MASTER = "GRM"
     POWER_STATE = "Pwr"
@@ -142,17 +270,37 @@ class ZoneRouterStatusExtKeys:
         return f"BF{zone_id}"
 
 
-""" JSON Structure
-
- DO NOT CHANGE - VSSL Defined
-
- {'Album': 'International Skankers', 'Artist': 'Ashkabad', 'BitDepth': 16,
-    'BitRate': '320000', 'CoverArtUrl': 'https://i.scdn.co/image/ab67616d0000b2730cbb03a339c6ffd18d10eab2',
-    'Current Source': 4, 'Current_time': -1, 'DSDType': '', 'Fav': False, 'FileSize': 0, 'Genre': '',
-    'Index': 0, 'Mime': 'Ogg', 'Next': False, 'PlayState': 0, 'PlayUrl': 'spotify:track:0IHTiLO5qBYhf7Hmn0UDBN',
-    'Prev': False, 'Repeat': 0, 'SampleRate': '44100', 'Seek': False, 'Shuffle': 0, 'SinglePlay': False,
-    'TotalTime': 203087, 'TrackName': 'Beijing'}
-
+"""
+JSON Structure
+
+DO NOT CHANGE - VSSL Defined
+
+{
+    "Album": "International Skankers",
+    "Artist": "Ashkabad",
+    "BitDepth": 16,
+    "BitRate": "320000",
+    "CoverArtUrl": "https://i.scdn.co/image/ab67616d0000b2730cbb03a339c6ffd18d10eab2",
+    "Current Source": 4,
+    "Current_time": -1,
+    "DSDType": "",
+    "Fav": False,
+    "FileSize": 0,
+    "Genre": "",
+    "Index": 0,
+    "Mime": "Ogg",
+    "Next": False,
+    "PlayState": 0,
+    "PlayUrl": "spotify:track:0IHTiLO5qBYhf7Hmn0UDBN",
+    "Prev": False,
+    "Repeat": 0,
+    "SampleRate": "44100",
+    "Seek": False,
+    "Shuffle": 0,
+    "SinglePlay": False,
+    "TotalTime": 203087,
+    "TrackName": "Beijing"
+}
 """
 
 

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

@@ -139,7 +139,7 @@ class AnalogOutput(ZoneDataClass):
         self.zone = zone
 
         self._is_fixed_volume = False
-        self._source = self.Sources(zone.id + 3)
+        self._source = self.Sources(zone.id + 2)
 
     #
     # Analog Output Fix Volume. Output wont respond to volume control

{vsslctrl-0.1.4.dev1 → vsslctrl-0.1.6.dev1}/vsslctrl/utils.py

@@ -38,6 +38,19 @@ def group_list_by_property(input_list, property_key):
     return grouped_dict
 
 
+#
+# Logging Helper to show a command in bytearray([]) syntax
+#
+def hex_to_bytearray_string(hex_string):
+    # Convert the hex string to a bytearray
+    byte_array = bytearray.fromhex(hex_string)
+
+    # Create the bytearray string representation
+    bytearray_str = f'bytearray([{", ".join(map(str, byte_array))}])'
+
+    return bytearray_str
+
+
 #
 # Repeat Timer
 #

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

@@ -267,6 +267,11 @@ class Zone:
     def _set_mac_addr(self, mac: str):
         mac = mac.strip()
         if mac != self.mac_addr:
+            # Strip Wlan0: from beginging of string
+            # Original A series amps had this prefix
+            if mac.startswith("Wlan0:"):
+                mac = mac[len("Wlan0:") :]
+
             # Define the regular expression pattern for a MAC address
             mac_pattern = re.compile(r"^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$")
 

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

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: vsslctrl
-Version: 0.1.4.dev1
-Summary: Package for controlling VSSL amplifiers
+Version: 0.1.6.dev1
+Summary: Package for controlling VSSL's range of streaming amplifiers
 Author-email: vsslctrl <vsslcontrolled@proton.me>
 Classifier: Development Status :: 4 - Beta
 Classifier: Programming Language :: Python :: 3
@@ -20,29 +20,30 @@ Provides-Extra: optional
 Requires-Dist: zeroconf==0.132.2; extra == "optional"
 
 # vsslctrl
- Package for controlling [VSSL](https://www.vssl.com/) range of streaming amplifiers.
+
+ Package for controlling [VSSL's](https://www.vssl.com/) range of streaming amplifiers.
 
  **`vsslctrl` is not endorsed or affiliated with [VSSL](https://www.vssl.com/) in any manner.**
 
- Motovation for this project was to intergrate VSSLs amplifiers into [Home Assistant](https://www.home-assistant.io/) and have control over different subnets (not mDNS dependant)
+## Help
+
+I am looking for testers with any VSSL amplifier models, please get in touch if you interested in helping. <vsslcontrolled@proton.me>
 
- I am looking for testers with any VSSL amplifier models, please get in touch if you interested in helping.
+Tested on:
+- Test suite run on a VSSL **A.3x** software version **p15305.016.3701**
+- The Home Assistant [integration](https://github.com/vsslctrl/integration.home-assistant) is reported working on a **A.6x** software version **p15305.017.3701**
 
-Important
------------
-Only tested on a VSSL **A.3x** software version **p15305.016.3701**.
+## 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.
+There should not be any *[VSSL Agent's](https://vssl.gitbook.io/vssl-rest-api/getting-started/start)* running on the same network. If you dont know what this is, then you can 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~~ (needs tests)
+* **A1(.x)** specific control e.g sub crossover, bluetooth
 * Better test coverage
 
-Basic Usage
------------
+## Basic Usage
+
 `vsslctrl` needs to be running inside a **[asyncio](https://docs.python.org/3/library/asyncio.html)** event loop.
 
 ```python
@@ -89,8 +90,7 @@ async def main():
 asyncio.run(main())
 ```
 
-API
------------
+# API
 
 Most functionality is achived via `getters` and `setters` of the two main classes `Vssl`, `Zone`. 
 
@@ -225,7 +225,7 @@ zone1.transport.state = ZoneTransport.States.PAUSE
 ## `Zone.track`
 
 * Not all sources have complete metadata - missing value will be set to defaults.
-* Airplay track position is not avaiable.
+* Airplay track `progress` is not avaiable.
 
 | Property      	| Description | Type		| Values 		| 
 | ---------------------- | ----------- | ----------- |----------- |
@@ -282,10 +282,10 @@ zone1.group.dissolve()
 
 ## `Zone.analog_output`
 
-| Property      	| Description | Type		| Values 		| 
-| ---------------------- 	| ----------- | ----------- |----------- |
-| `source`     			 	| Where the AO is routed from. i.e a zone, optical input or off |	`int`	| `AnalogOutput.Sources`
-| `is_fixed_volume`   			| Fix the output volume. Output wont respond to volume control        |	`bool` readonly
+| Property      	| Description | Type		| Values 		| Default |
+| ---------------------- 	| ----------- | ----------- |----------- |----------- |
+| `source`     			 	| Where the AO is routed from. i.e a zone, optical input or off |	`int`	| `AnalogOutput.Sources` | `Off`
+| `is_fixed_volume`   			| Fix the output volume. Output wont respond to volume control        |	`bool` | |`False`
 | `is_fixed_volume_toggle()`   			| Toggle fixed volume      |	`func`  |
 
 ```python
@@ -302,12 +302,12 @@ zone1.analog_output.is_fixed_volume = True
 
 ## `Zone.settings`
 
-| Property      	| Description | Type		| Values 		| 
-| ---------------------- 	| ----------- | ----------- |----------- |
+| Property      	| Description | Type		| Values 		| Default |
+| ---------------------- 	| ----------- | ----------- |----------- |----------- |
 | `name`     			 	| Name |	`str`	| 
-| `disabled`   			| Disable the zone        |	`bool`
+| `disabled`   			| Disable the zone        |	`bool` || `False`
 | `disabled_toggle()`   			| disable / enable        |	`func`  |
-| `mono`   			| Set output to mono or stereo        |	`int`  | `ZoneSettings.StereoMono`
+| `mono`   			| Set output to mono or stereo        |	`int`  | `ZoneSettings.StereoMono` | `Stereo`
 | `mono_toggle()`   			| Toggle mono or stereo        |	`func`  |
 
 ```python
@@ -322,10 +322,10 @@ zone1.mono_toggle()
 
 ## `Zone.settings.analog_input`
 
-| Property      	| Description | Type		| Values 		| 
-| ---------------------- 	| ----------- | ----------- |----------- |
+| Property      	| Description | Type		| Values 		| Default |
+| ---------------------- 	| ----------- | ----------- |----------- |----------- |
 | `name`     			 	| Name |	`str`	| 
-| `fixed_gain`   		| Fix the input gain to a specific value       |`int` | `0...100`
+| `fixed_gain`   		| Fix the input gain to a specific value       |`int` | `0...100` | `0` is disabled or variable gain
 
 ```python
 """Examples"""
@@ -339,11 +339,11 @@ zone1.settings.analog_input.fixed_gain = 50
 
 ## `Zone.settings.volume`
 
-| Property      	| Description | Type		| Values 		| 
-| ---------------------- 	| ----------- | ----------- |----------- |
-| `default_on`     			 	| Default on volume  |	`int`  | `0...100` 
-| `max_left`     			 	| Max volume left channel  |	`int`  | `0...100` 
-| `max_right`     			 	| Max volume right channel  |	`int`  | `0...100` 
+| Property      	| Description | Type		| Values 		| Default |
+| ---------------------- 	| ----------- | ----------- |----------- |----------- |
+| `default_on`     			 	| Default on volume  |	`int`  | `0...100` | `0` is disabled
+| `max_left`     			 	| Max volume left channel  |	`int`  | `0...100` | `75`
+| `max_right`     			 	| Max volume right channel  |	`int`  | `0...100` | `75`
 
 ```python
 """Examples"""
@@ -355,21 +355,21 @@ zone1.settings.volume.default_on = 75
 
 ## `Zone.settings.eq`
 
-| Property      	| Description | Type		| Values 		| 
-| ---------------------- 	| ----------- | ----------- |----------- |
-| `enabled`     			 	| Enable / disable EQ        |	`bool` 
+| Property      	| Description | Type		| Values 		| Default |
+| ---------------------- 	| ----------- | ----------- |----------- |----------- |
+| `enabled`     			 	| Enable / disable EQ        |	`bool` | | `False`
 
 EQ to be set in [decibel](https://en.wikipedia.org/wiki/Decibel) using a range `-10`dB to `+10`dB
 
-| Property      	| Description | Type		| Values 		| 
-| ---------------------- 	| ----------- | ----------- |----------- | 
-| `hz60_db`     			 	| 60Hz |	`int`  | `-10...10`
-| `hz200_db`     			 	| 200Hz |	`int`  | `-10...10`
-| `hz500_db`     			 	| 500Hz |	`int`  | `-10...10`
-| `khz1_db`     			 	| 1kHz |	`int`  | `-10...10`
-| `khz4_db`     			 	| 4kHz |	`int`  | `-10...10`
-| `khz8_db`     			 	| 8kHz |	`int`  | `-10...10`
-| `khz15_db`     			 	| 15kHz |	`int`  | `-10...10`
+| Property      	| Description | Type		| Values 		| Default |
+| ---------------------- 	| ----------- | ----------- |----------- | ----------- |
+| `hz60_db`     			 	| 60Hz |	`int`  | `-10...10` | `0`
+| `hz200_db`     			 	| 200Hz |	`int`  | `-10...10` | `0`
+| `hz500_db`     			 	| 500Hz |	`int`  | `-10...10` | `0`
+| `khz1_db`     			 	| 1kHz |	`int`  | `-10...10` | `0`
+| `khz4_db`     			 	| 4kHz |	`int`  | `-10...10` | `0`
+| `khz8_db`     			 	| 8kHz |	`int`  | `-10...10` | `0`
+| `khz15_db`     			 	| 15kHz |	`int`  | `-10...10` | `0`
 
 ```python
 """Examples"""
@@ -379,7 +379,7 @@ 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`.
+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 any network tool) on port `50002`.
 
 | HEX      	| Description |
 | ---------------------- 	| ----------- |
@@ -428,13 +428,15 @@ shell_command:
 
 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).
 
+Motovation for this project was to intergrate VSSLs amplifiers into [Home Assistant](https://www.home-assistant.io/) and have control over different subnets (not mDNS dependant)
+
 ## Known Issues & Limitiations
 
-* Tested on VSSL **A.3x** software version **p15305.016.3701**
-* Not tested on A.1x, A.6.x or original A series range of amplifiers (testers welcome)
+* Not tested on A.1x or original A series range of amplifiers (testers welcome)
 * VSSL can not start a stream except for playing a URL directly. This is a limitation of the hardware itself.
 * Not all sources set the volume to 0 when the zone is muted
 * Grouping feedback is flaky on the X series amplifiers
+* Airplay `Zone.track.progress` is not avaiable.
 * Cant stop a URL playback, feedback is worng at least
 * VSSL likes to cache old track metadata. For example when playing a URL after Spotify, often the device will respond with the previous (Spotify) tracks metadata
 * `stop()` is intended to disconnect the client and pause the stream. Doesnt always function this way, depending on stream source
@@ -442,8 +444,8 @@ The VSSL API was reverse engineered using Wireshark, VSSLs native "legacy" iOS a
 
 ## Future
 
+* A.1(x) coverage i.e Bluetooth and subwoofer control
 * REST API / Web App
 * Save and recall EQ
-* A.1(x) coverage i.e Bluetooth
 * IR Control