vsslctrl 0.1.11.dev1__tar.gz → 0.1.12.dev1__tar.gz

{vsslctrl-0.1.11.dev1 → vsslctrl-0.1.12.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vsslctrl
-Version: 0.1.11.dev1
+Version: 0.1.12.dev1
 Summary: Package for controlling VSSL's range of streaming amplifiers
 Author-email: vsslctrl <vsslcontrolled@proton.me>
 Classifier: Development Status :: 4 - Beta
@@ -21,32 +21,44 @@ Requires-Dist: zeroconf==0.132.2; extra == "optional"
 
 # vsslctrl
 
- Package for controlling [VSSL's](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.**
+## Coverage
 
-## Help
+Tested on:
 
-I am looking for testers with any VSSL amplifier models, please get in touch if you interested in helping. <vsslcontrolled@proton.me>
+| Model       | Software Version | Note |
+| ------------|---------  | -------------
+| A.3x       | p15305.016.3701     | 
 
-Tested on:
-- **A.3x** software version **p15305.016.3701**
 
 Home Assistant [integration](https://github.com/vsslctrl/integration.home-assistant) with basic functionality working on:
-- **A.1** software version **p15265.033.3703** (reported)
-- **A.3** software version **p12013.141.3703** (reported)
-- **A.3x** software version **p15305.016.3701**
-- **A.6x** software version **p15305.017.3701** (reported)
+
+| Model       | Software Version | User Reported |
+| ------------|---------  | -------------
+| A.1       | p15265.033.3703    | ✔️
+| A.3       | p12013.141.3703     | ✔️
+| A.3x       | p15305.016.3701     | 
+| A.6x       | p15305.017.3701     | ✔️
+
+
+## Testers Needed
+
+I am looking for testers with any VSSL amplifier models, please get in touch if you interested in helping. <vsslcontrolled@proton.me>
+
+
 
 ## Important
 
-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.
+There should not be any *[VSSL Agent's](https://vssl.gitbook.io/vssl-rest-api/getting-started/start)* running on the network. If you dont know what this is, then you can ignore this notice.
+
+ **`vsslctrl` is not endorsed or affiliated with [VSSL](https://www.vssl.com/) in any manner.**
 
 ## TODOs
 
-* Correct IO mapping between models and versions
 * Better test coverage
-* A.1(x) testing
+* A.1(x) testing - e.g output settings
+* More controls - e.g IR Control
 
 ## Basic Usage
 
@@ -62,7 +74,7 @@ async def main():
   
   # Represents a physical VSSL amplifier
   vssl = Vssl(DeviceModels.A1)
-  a1 = vssl.add_zone(ZoneIDs.A1, '192.168.1.10')
+  a1 = vssl.add_zone('192.168.1.10')
 
   # Connect and initiate zones.
   await vssl.initialise()
@@ -92,14 +104,13 @@ from vsslctrl import Vssl, DeviceModels, Zone, ZoneIDs
 async def main():
 	
   # Represents a physical VSSL amplifier
-  # If no DeviceModels is passed, vsslctrl will default to the feature set of the X series amps
   vssl = Vssl(DeviceModels.A3X)
 
   # Add each you wish to control
-  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
+  zone1 = vssl.add_zone('192.168.1.10', ZoneIDs.ZONE_1)
+  zone2 = vssl.add_zone('192.168.1.11', ZoneIDs.ZONE_2)
+  zone3 = vssl.add_zone('192.168.1.12', ZoneIDs.ZONE_3)
+  #... up to 6 zones for A.6(x)
 
   # Connect and initiate zones.
   await vssl.initialise()
@@ -123,9 +134,36 @@ async def main():
 asyncio.run(main())
 ```
 
+# `DeviceModels`
+
+A device model has to be passed to VSSL so it knows internally what features are supported by the device.
+This might be removed in the future if we can differentiate different models from the API.
+
+| Property        | Description |
+| ------------|---------  | 
+| `A1X`       | A.1x      | 
+| `A3X`       | A.3x      | 
+| `A6X`       | A.6x      | 
+| `A1`        | A1        | 
+| `A3`        | A3        | 
+| `A6`        | A6        | 
+
+# `ZoneIDs`
+
+| Property        | Description |
+| ------------|---------  | 
+| `A1`        | A.1(x) Only      | 
+| `ZONE_1`    | Zone 1 of A.3(x) and A.6(x)   | 
+| `ZONE_2`    | Zone 2 of A.3(x) and A.6(x)    | 
+| `ZONE_3`    | Zone 3 of A.3(x) and A.6(x)  | 
+| `ZONE_4`    | Zone 4 of A.6(x)     | 
+| `ZONE_5`    | Zone 5 of A.6(x)       | 
+| `ZONE_6`    | Zone 6 of A.6(x)       | 
+
+
 # API
 
-Most functionality is achived via `getters` and `setters` of the two main classes `Vssl`, `Zone`. 
+Most functionality is achieved via `getters` and `setters` of the two main classes `Vssl`, `Zone`. 
 
 The classes will update the physical VSSL device when setting a property and once feedback has been received, the classes internal state will be updated. For example:
 
@@ -142,7 +180,6 @@ print(zone_name)
 
 **Important** in the above example, `zone1.settings.name` wont be set to its new value until after the VSSL device has changed the name and the `Zone` class has received confirmation feedback. If you need to wait for the value change, you can await a `[property_name]_CHANGE` events.
 
-
 # `Vssl`
 
 | Property      	| Description | Type 		| 
@@ -164,7 +201,7 @@ vssl.factory_reset()
 
 ## `Vssl.settings`
 
-| Property      	| Description | Type 		| Notes / Defaults |
+| Property      	| Description | Type 		| Model: Default |
 | ---------------------- 	| ----------- | ----------- | ----------- |
 | `name`     			 	| Device name |	`str` |
 | `bus_1_name`   			| Name of Bus 1        |	`str` | <ul><li>A.1: Optical Input</li><li>A.3x/6x: Not Used</li></ul>
@@ -313,13 +350,13 @@ Input `InputRouter.Priorities` still apply.
 # Change zone 1 to listen to analog input 4
 zone1.input.source = InputRouter.Sources.ANALOG_IN_4
 
-# Change zone 1 to perfer analog input (local) over stream
+# Change zone 1 to perfer local inputs over stream
 zone1.input.priority = InputRouter.Priorities.LOCAL
 ```
 
 ## `Zone.group`
 
-Officially unsupported in X series amplifiers.
+Unsupported on X series amplifiers.
 
 | Property      	| Description | Type		| Values 		| 
 | ---------------------- 	| ----------- | ----------- |----------- |
@@ -458,55 +495,6 @@ zone1.settings.eq.khz1_db = -2
 zone1.settings.subwoofer.crossover = 100
 ```
 
-
-
-## 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 any 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
 
 Thanks to [@dj-jam](https://github.com/dj-jam) for the continued testing.
@@ -520,17 +508,9 @@ Motivation for this project was to integrate VSSLs amplifiers into [Home Assista
 * 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 available.
 * 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. Doesn’t always function this way, depending on stream source
 * Occasionally a zones might stop responding to certain commands, issuing the `reboot` command generally corrects
 
-## Future
-
-* A.1(x) coverage i.e Bluetooth
-* REST API / Web App
-* Save and recall EQ
-* IR Control
-

{vsslctrl-0.1.11.dev1 → vsslctrl-0.1.12.dev1}/README.md

@@ -1,31 +1,43 @@
 # vsslctrl
 
- Package for controlling [VSSL's](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.**
+## Coverage
 
-## Help
+Tested on:
 
-I am looking for testers with any VSSL amplifier models, please get in touch if you interested in helping. <vsslcontrolled@proton.me>
+| Model       | Software Version | Note |
+| ------------|---------  | -------------
+| A.3x       | p15305.016.3701     | 
 
-Tested on:
-- **A.3x** software version **p15305.016.3701**
 
 Home Assistant [integration](https://github.com/vsslctrl/integration.home-assistant) with basic functionality working on:
-- **A.1** software version **p15265.033.3703** (reported)
-- **A.3** software version **p12013.141.3703** (reported)
-- **A.3x** software version **p15305.016.3701**
-- **A.6x** software version **p15305.017.3701** (reported)
+
+| Model       | Software Version | User Reported |
+| ------------|---------  | -------------
+| A.1       | p15265.033.3703    | ✔️
+| A.3       | p12013.141.3703     | ✔️
+| A.3x       | p15305.016.3701     | 
+| A.6x       | p15305.017.3701     | ✔️
+
+
+## Testers Needed
+
+I am looking for testers with any VSSL amplifier models, please get in touch if you interested in helping. <vsslcontrolled@proton.me>
+
+
 
 ## Important
 
-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.
+There should not be any *[VSSL Agent's](https://vssl.gitbook.io/vssl-rest-api/getting-started/start)* running on the network. If you dont know what this is, then you can ignore this notice.
+
+ **`vsslctrl` is not endorsed or affiliated with [VSSL](https://www.vssl.com/) in any manner.**
 
 ## TODOs
 
-* Correct IO mapping between models and versions
 * Better test coverage
-* A.1(x) testing
+* A.1(x) testing - e.g output settings
+* More controls - e.g IR Control
 
 ## Basic Usage
 
@@ -41,7 +53,7 @@ async def main():
   
   # Represents a physical VSSL amplifier
   vssl = Vssl(DeviceModels.A1)
-  a1 = vssl.add_zone(ZoneIDs.A1, '192.168.1.10')
+  a1 = vssl.add_zone('192.168.1.10')
 
   # Connect and initiate zones.
   await vssl.initialise()
@@ -71,14 +83,13 @@ from vsslctrl import Vssl, DeviceModels, Zone, ZoneIDs
 async def main():
 	
   # Represents a physical VSSL amplifier
-  # If no DeviceModels is passed, vsslctrl will default to the feature set of the X series amps
   vssl = Vssl(DeviceModels.A3X)
 
   # Add each you wish to control
-  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
+  zone1 = vssl.add_zone('192.168.1.10', ZoneIDs.ZONE_1)
+  zone2 = vssl.add_zone('192.168.1.11', ZoneIDs.ZONE_2)
+  zone3 = vssl.add_zone('192.168.1.12', ZoneIDs.ZONE_3)
+  #... up to 6 zones for A.6(x)
 
   # Connect and initiate zones.
   await vssl.initialise()
@@ -102,9 +113,36 @@ async def main():
 asyncio.run(main())
 ```
 
+# `DeviceModels`
+
+A device model has to be passed to VSSL so it knows internally what features are supported by the device.
+This might be removed in the future if we can differentiate different models from the API.
+
+| Property        | Description |
+| ------------|---------  | 
+| `A1X`       | A.1x      | 
+| `A3X`       | A.3x      | 
+| `A6X`       | A.6x      | 
+| `A1`        | A1        | 
+| `A3`        | A3        | 
+| `A6`        | A6        | 
+
+# `ZoneIDs`
+
+| Property        | Description |
+| ------------|---------  | 
+| `A1`        | A.1(x) Only      | 
+| `ZONE_1`    | Zone 1 of A.3(x) and A.6(x)   | 
+| `ZONE_2`    | Zone 2 of A.3(x) and A.6(x)    | 
+| `ZONE_3`    | Zone 3 of A.3(x) and A.6(x)  | 
+| `ZONE_4`    | Zone 4 of A.6(x)     | 
+| `ZONE_5`    | Zone 5 of A.6(x)       | 
+| `ZONE_6`    | Zone 6 of A.6(x)       | 
+
+
 # API
 
-Most functionality is achived via `getters` and `setters` of the two main classes `Vssl`, `Zone`. 
+Most functionality is achieved via `getters` and `setters` of the two main classes `Vssl`, `Zone`. 
 
 The classes will update the physical VSSL device when setting a property and once feedback has been received, the classes internal state will be updated. For example:
 
@@ -121,7 +159,6 @@ print(zone_name)
 
 **Important** in the above example, `zone1.settings.name` wont be set to its new value until after the VSSL device has changed the name and the `Zone` class has received confirmation feedback. If you need to wait for the value change, you can await a `[property_name]_CHANGE` events.
 
-
 # `Vssl`
 
 | Property      	| Description | Type 		| 
@@ -143,7 +180,7 @@ vssl.factory_reset()
 
 ## `Vssl.settings`
 
-| Property      	| Description | Type 		| Notes / Defaults |
+| Property      	| Description | Type 		| Model: Default |
 | ---------------------- 	| ----------- | ----------- | ----------- |
 | `name`     			 	| Device name |	`str` |
 | `bus_1_name`   			| Name of Bus 1        |	`str` | <ul><li>A.1: Optical Input</li><li>A.3x/6x: Not Used</li></ul>
@@ -292,13 +329,13 @@ Input `InputRouter.Priorities` still apply.
 # Change zone 1 to listen to analog input 4
 zone1.input.source = InputRouter.Sources.ANALOG_IN_4
 
-# Change zone 1 to perfer analog input (local) over stream
+# Change zone 1 to perfer local inputs over stream
 zone1.input.priority = InputRouter.Priorities.LOCAL
 ```
 
 ## `Zone.group`
 
-Officially unsupported in X series amplifiers.
+Unsupported on X series amplifiers.
 
 | Property      	| Description | Type		| Values 		| 
 | ---------------------- 	| ----------- | ----------- |----------- |
@@ -437,55 +474,6 @@ zone1.settings.eq.khz1_db = -2
 zone1.settings.subwoofer.crossover = 100
 ```
 
-
-
-## 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 any 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
 
 Thanks to [@dj-jam](https://github.com/dj-jam) for the continued testing.
@@ -499,17 +487,9 @@ Motivation for this project was to integrate VSSLs amplifiers into [Home Assista
 * 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 available.
 * 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. Doesn’t always function this way, depending on stream source
 * Occasionally a zones might stop responding to certain commands, issuing the `reboot` command generally corrects
 
-## Future
-
-* A.1(x) coverage i.e Bluetooth
-* REST API / Web App
-* Save and recall EQ
-* IR Control
-

{vsslctrl-0.1.11.dev1 → vsslctrl-0.1.12.dev1}/pyproject.toml

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