vsslctrl 0.1.9.dev1__tar.gz → 0.1.11.dev1__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vsslctrl
-Version: 0.1.9.dev1
+Version: 0.1.11.dev1
 Summary: Package for controlling VSSL's range of streaming amplifiers
 Author-email: vsslctrl <vsslcontrolled@proton.me>
 Classifier: Development Status :: 4 - Beta
@@ -30,8 +30,13 @@ 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. <vsslcontrolled@proton.me>
 
 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**
+- **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)
 
 ## Important
 
@@ -39,52 +44,80 @@ There should not be any *[VSSL Agent's](https://vssl.gitbook.io/vssl-rest-api/ge
 
 ## TODOs
 
-* **A.1(x)** specific control e.g sub crossover, bluetooth
+* Correct IO mapping between models and versions
 * Better test coverage
+* A.1(x) testing
 
 ## Basic Usage
 
 `vsslctrl` needs to be running inside a **[asyncio](https://docs.python.org/3/library/asyncio.html)** event loop.
 
+### A.1 Example
+
 ```python
 import asyncio
 from vsslctrl import Vssl, DeviceModels, Zone, ZoneIDs
 
 async def main():
-	
-	# Represents a physical VSSL amplifier
-	vssl = Vssl()
+  
+  # Represents a physical VSSL amplifier
+  vssl = Vssl(DeviceModels.A1)
+  a1 = vssl.add_zone(ZoneIDs.A1, '192.168.1.10')
+
+  # Connect and initiate zones.
+  await vssl.initialise()
+
+  """Control Examples"""
+  # Print device name
+  print(a1.settings.name)
+  # Set volume to 25%
+  a1.volume = 25
+  # Pause
+  a1.pause()
+  # Print track name
+  print(a1.track.name)
+
+  # Shutdown and disconnect all zones
+  await vssl.shutdown()
 
-  """Optional to init Vssl with a device model
+asyncio.run(main())
+```
 
-    vssl = Vssl(DeviceModels.A3X)
+### A.3x Example
 
-    If no DeviceModels is passed, vsslctrl will default to the feature set of the X series amps
-  """
+```python
+import asyncio
+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
+  # 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
 
-	# Connect and initiate zones.
-   	await vssl.initialise()
+  # Connect and initiate zones.
+  await vssl.initialise()
 
-   	"""Control Examples"""
-   	# Print zone1 name
-   	print(zone1.settings.name)
-   	# Set zone2 volume to 25%
-   	zone2.volume = 25
-   	# Pause zone3
-   	zone3.pause()
-   	# or zone3.transport.pause()
-   	# Print zone1 track name
-   	print(zone1.track.name)
+  """Control Examples"""
+  # Print zone1 name
+  print(zone1.settings.name)
+  # Set zone2 volume to 25%
+  zone2.volume = 25
+  # Pause zone3
+  zone3.pause()
+  # or zone3.transport.pause()
+  # Print zone1 track name
+  print(zone1.track.name)
 
 
-   	# Shutdown and disconnect all zones
-   	await vssl.shutdown()
+  # Shutdown and disconnect all zones
+  await vssl.shutdown()
 
 
 asyncio.run(main())
@@ -107,7 +140,7 @@ print(zone_name)
 >>> 'Living Room'
 ```
 
-**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 confimation feedback. If you need to wait for the value change, you can await a `[property_name]_CHANGE` events.
+**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`
@@ -118,26 +151,37 @@ print(zone_name)
 | `serial`   			| Serial number        |	`str` readonly
 | `model`   			| Device Model        |	`int` readonly
 | `reboot()`   			| Reboot all zones        |	`func`  |
+| `factory_reset()`        | Factory reset device        | `func`  |
+
 
 ```python
 """Example"""
 # Reboot all zones
 vssl.reboot()
+# Do a factory reset (reset all settings)
+vssl.factory_reset()
 ```
 
 ## `Vssl.settings`
 
-| Property      	| Description | Type 		| 
-| ---------------------- 	| ----------- | ----------- |
-| `name`     			 	| Device name |	`str`
-| `optical_input_name`   			| Name of the optical input        |	`str`
+| Property      	| Description | Type 		| Notes / Defaults |
+| ---------------------- 	| ----------- | ----------- | ----------- |
+| `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>
+| `bus_2_name`        | Name of Bus 2        |  `str` | <ul><li>A.1: Coax Input</li><li>A.3x/6x: Optical Input</li></ul>
+| `bluetooth`        | Bluetooth enabled / disabled        |  `bool` |
+| `bluetooth_toggle()`        | Toggle Bluetooth        | `func`  |
 
 ```python
 """Example"""
 # Setting device name
 vssl.settings.name = 'My House'
-# Setting optical input name
-vssl.settings.optical_input_name = 'Optical Input 1'
+# Setting bus 2 name
+vssl.settings.bus_2_name = 'Optical Input'
+# Enable Bluetooth
+vssl.settings.bluetooth = True
+# Toggle Bluetooth
+vssl.settings.bluetooth_toggle()
 ```
 
 ## `Vssl.settings.power`
@@ -225,7 +269,7 @@ zone1.transport.state = ZoneTransport.States.PAUSE
 ## `Zone.track`
 
 * Not all sources have complete metadata - missing value will be set to defaults.
-* Airplay track `progress` is not avaiable.
+* Airplay track `progress` is not available.
 
 | Property      	| Description | Type		| Values 		| 
 | ---------------------- | ----------- | ----------- |----------- |
@@ -244,15 +288,25 @@ zone1.transport.state = ZoneTransport.States.PAUSE
 
 | Property      	| Description | Type		| Values 		| 
 | ---------------------- 	| ----------- | ----------- |----------- |
-| `source`     			 	| Change input source |	`int`	| `InputRouter.Sources`
-| `priority`     			| Change input priority. Stream or analog in higher priority  |	`int`	| `InputRouter.Priorities`
+| `source`     			 	| Change input source.<br/>Source to be played out the zones speakers |	`int`	| `InputRouter.Sources`
+| `priority`     			| Change input priority.<br/>Stream or local to have precedence  |	`int`	| `InputRouter.Priorities`
+
 
-### Priority Order:
+### A.1(x) Source Routing Order
+A.1 and A.1x don't support manually changing the input source. Instead a fixed source routing order is used:
+  
+  1. Optical Input
+  2. Coaxial Input
+  3. Analog Input
+  
+Input `InputRouter.Priorities` still apply.
+
+### Input Priority / Precedence
 
 | `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>
+| **`STREAM`**  | <ol><li>Stream</li><li>Party Zone</li><li>Bus 1</li><li>Bus 2</li><li>Optical</li><li>Coaxial</li><li>Analog</li></ol>
+|  **`LOCAL`**  | <ol><li>Bus 1</li><li>Bus 2</li><li>Optical</li><li>Coaxial</li><li>Analog</li><li>Stream</li><li>Party Zone</li></ol>
 
 ```python
 """Example"""
@@ -265,7 +319,7 @@ zone1.input.priority = InputRouter.Priorities.LOCAL
 
 ## `Zone.group`
 
-Working on A.3x but offically unsupported in x series amplifiers.
+Officially unsupported in X series amplifiers.
 
 | Property      	| Description | Type		| Values 		| 
 | ---------------------- 	| ----------- | ----------- |----------- |
@@ -275,6 +329,7 @@ Working on A.3x but offically unsupported in x series amplifiers.
 | `remove_member()`   		| Remove zone from group      |	`func`  | `ZoneIDs`
 | `dissolve()`   			| Dissolve group / remove all members       |	`func`  |
 | `leave()`   				| Leave the group if a member       |	`func`  |
+| `is_party_zone_member`  | Member of Party Zone |  `bool`  |
 
 ```python
 """Examples"""
@@ -285,13 +340,17 @@ zone2.group.leave() # or
 zone1.group.remove_member(ZoneIDs.ZONE_2)
 # If zone 1 is a master, remove all members
 zone1.group.dissolve()
+# Add zone to the party zone group
+zone1.group.is_party_zone_member = True
+# Toggle Party Zone Membership
+zone1.group.is_party_zone_member_toggle()
 ```
 
 ## `Zone.analog_output`
 
 | Property      	| Description | Type		| Values 		| Default |
 | ---------------------- 	| ----------- | ----------- |----------- |----------- |
-| `source`     			 	| Where the AO is routed from. i.e a zone, optical input or off |	`int`	| `AnalogOutput.Sources` | `Off`
+| `source`     			 	| Where the AO is routed from. i.e stream, 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`  |
 
@@ -384,6 +443,23 @@ EQ to be set in [decibel](https://en.wikipedia.org/wiki/Decibel) using a range `
 zone1.settings.eq.khz1_db = -2
 ```
 
+## `Zone.settings.subwoofer`
+
+* **A.1 and A.1x only**
+* Set `0` for full frequency range
+
+| Property        | Description | Type    | Values    | Default |
+| ----------------------  | ----------- | ----------- |----------- |----------- |
+| `crossover`             | Set "sub out" crossover frequency from 50-200Hz.       |  `int` | `0` or `50...200` | `0`
+
+```python
+"""Examples"""
+# Set subwoofer ouput crossover to 100hz
+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`.
@@ -433,9 +509,11 @@ shell_command:
 
 ## Credit
 
+Thanks to [@dj-jam](https://github.com/dj-jam) for the continued testing.
+
 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)
+Motivation for this project was to integrate VSSLs amplifiers into [Home Assistant](https://www.home-assistant.io/) and have control over different subnets (not mDNS dependant)
 
 ## Known Issues & Limitiations
 
@@ -443,15 +521,15 @@ Motovation for this project was to intergrate VSSLs amplifiers into [Home Assist
 * 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.
+* 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. Doesnt always function this way, depending on stream source
+* `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 and subwoofer control
+* A.1(x) coverage i.e Bluetooth
 * REST API / Web App
 * Save and recall EQ
 * IR Control

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

@@ -9,8 +9,13 @@
 I am looking for testers with any VSSL amplifier models, please get in touch if you interested in helping. <vsslcontrolled@proton.me>
 
 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**
+- **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)
 
 ## Important
 
@@ -18,52 +23,80 @@ There should not be any *[VSSL Agent's](https://vssl.gitbook.io/vssl-rest-api/ge
 
 ## TODOs
 
-* **A.1(x)** specific control e.g sub crossover, bluetooth
+* Correct IO mapping between models and versions
 * Better test coverage
+* A.1(x) testing
 
 ## Basic Usage
 
 `vsslctrl` needs to be running inside a **[asyncio](https://docs.python.org/3/library/asyncio.html)** event loop.
 
+### A.1 Example
+
 ```python
 import asyncio
 from vsslctrl import Vssl, DeviceModels, Zone, ZoneIDs
 
 async def main():
-	
-	# Represents a physical VSSL amplifier
-	vssl = Vssl()
+  
+  # Represents a physical VSSL amplifier
+  vssl = Vssl(DeviceModels.A1)
+  a1 = vssl.add_zone(ZoneIDs.A1, '192.168.1.10')
+
+  # Connect and initiate zones.
+  await vssl.initialise()
+
+  """Control Examples"""
+  # Print device name
+  print(a1.settings.name)
+  # Set volume to 25%
+  a1.volume = 25
+  # Pause
+  a1.pause()
+  # Print track name
+  print(a1.track.name)
+
+  # Shutdown and disconnect all zones
+  await vssl.shutdown()
 
-  """Optional to init Vssl with a device model
+asyncio.run(main())
+```
 
-    vssl = Vssl(DeviceModels.A3X)
+### A.3x Example
 
-    If no DeviceModels is passed, vsslctrl will default to the feature set of the X series amps
-  """
+```python
+import asyncio
+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
+  # 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
 
-	# Connect and initiate zones.
-   	await vssl.initialise()
+  # Connect and initiate zones.
+  await vssl.initialise()
 
-   	"""Control Examples"""
-   	# Print zone1 name
-   	print(zone1.settings.name)
-   	# Set zone2 volume to 25%
-   	zone2.volume = 25
-   	# Pause zone3
-   	zone3.pause()
-   	# or zone3.transport.pause()
-   	# Print zone1 track name
-   	print(zone1.track.name)
+  """Control Examples"""
+  # Print zone1 name
+  print(zone1.settings.name)
+  # Set zone2 volume to 25%
+  zone2.volume = 25
+  # Pause zone3
+  zone3.pause()
+  # or zone3.transport.pause()
+  # Print zone1 track name
+  print(zone1.track.name)
 
 
-   	# Shutdown and disconnect all zones
-   	await vssl.shutdown()
+  # Shutdown and disconnect all zones
+  await vssl.shutdown()
 
 
 asyncio.run(main())
@@ -86,7 +119,7 @@ print(zone_name)
 >>> 'Living Room'
 ```
 
-**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 confimation feedback. If you need to wait for the value change, you can await a `[property_name]_CHANGE` events.
+**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`
@@ -97,26 +130,37 @@ print(zone_name)
 | `serial`   			| Serial number        |	`str` readonly
 | `model`   			| Device Model        |	`int` readonly
 | `reboot()`   			| Reboot all zones        |	`func`  |
+| `factory_reset()`        | Factory reset device        | `func`  |
+
 
 ```python
 """Example"""
 # Reboot all zones
 vssl.reboot()
+# Do a factory reset (reset all settings)
+vssl.factory_reset()
 ```
 
 ## `Vssl.settings`
 
-| Property      	| Description | Type 		| 
-| ---------------------- 	| ----------- | ----------- |
-| `name`     			 	| Device name |	`str`
-| `optical_input_name`   			| Name of the optical input        |	`str`
+| Property      	| Description | Type 		| Notes / Defaults |
+| ---------------------- 	| ----------- | ----------- | ----------- |
+| `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>
+| `bus_2_name`        | Name of Bus 2        |  `str` | <ul><li>A.1: Coax Input</li><li>A.3x/6x: Optical Input</li></ul>
+| `bluetooth`        | Bluetooth enabled / disabled        |  `bool` |
+| `bluetooth_toggle()`        | Toggle Bluetooth        | `func`  |
 
 ```python
 """Example"""
 # Setting device name
 vssl.settings.name = 'My House'
-# Setting optical input name
-vssl.settings.optical_input_name = 'Optical Input 1'
+# Setting bus 2 name
+vssl.settings.bus_2_name = 'Optical Input'
+# Enable Bluetooth
+vssl.settings.bluetooth = True
+# Toggle Bluetooth
+vssl.settings.bluetooth_toggle()
 ```
 
 ## `Vssl.settings.power`
@@ -204,7 +248,7 @@ zone1.transport.state = ZoneTransport.States.PAUSE
 ## `Zone.track`
 
 * Not all sources have complete metadata - missing value will be set to defaults.
-* Airplay track `progress` is not avaiable.
+* Airplay track `progress` is not available.
 
 | Property      	| Description | Type		| Values 		| 
 | ---------------------- | ----------- | ----------- |----------- |
@@ -223,15 +267,25 @@ zone1.transport.state = ZoneTransport.States.PAUSE
 
 | Property      	| Description | Type		| Values 		| 
 | ---------------------- 	| ----------- | ----------- |----------- |
-| `source`     			 	| Change input source |	`int`	| `InputRouter.Sources`
-| `priority`     			| Change input priority. Stream or analog in higher priority  |	`int`	| `InputRouter.Priorities`
+| `source`     			 	| Change input source.<br/>Source to be played out the zones speakers |	`int`	| `InputRouter.Sources`
+| `priority`     			| Change input priority.<br/>Stream or local to have precedence  |	`int`	| `InputRouter.Priorities`
+
 
-### Priority Order:
+### A.1(x) Source Routing Order
+A.1 and A.1x don't support manually changing the input source. Instead a fixed source routing order is used:
+  
+  1. Optical Input
+  2. Coaxial Input
+  3. Analog Input
+  
+Input `InputRouter.Priorities` still apply.
+
+### Input Priority / Precedence
 
 | `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>
+| **`STREAM`**  | <ol><li>Stream</li><li>Party Zone</li><li>Bus 1</li><li>Bus 2</li><li>Optical</li><li>Coaxial</li><li>Analog</li></ol>
+|  **`LOCAL`**  | <ol><li>Bus 1</li><li>Bus 2</li><li>Optical</li><li>Coaxial</li><li>Analog</li><li>Stream</li><li>Party Zone</li></ol>
 
 ```python
 """Example"""
@@ -244,7 +298,7 @@ zone1.input.priority = InputRouter.Priorities.LOCAL
 
 ## `Zone.group`
 
-Working on A.3x but offically unsupported in x series amplifiers.
+Officially unsupported in X series amplifiers.
 
 | Property      	| Description | Type		| Values 		| 
 | ---------------------- 	| ----------- | ----------- |----------- |
@@ -254,6 +308,7 @@ Working on A.3x but offically unsupported in x series amplifiers.
 | `remove_member()`   		| Remove zone from group      |	`func`  | `ZoneIDs`
 | `dissolve()`   			| Dissolve group / remove all members       |	`func`  |
 | `leave()`   				| Leave the group if a member       |	`func`  |
+| `is_party_zone_member`  | Member of Party Zone |  `bool`  |
 
 ```python
 """Examples"""
@@ -264,13 +319,17 @@ zone2.group.leave() # or
 zone1.group.remove_member(ZoneIDs.ZONE_2)
 # If zone 1 is a master, remove all members
 zone1.group.dissolve()
+# Add zone to the party zone group
+zone1.group.is_party_zone_member = True
+# Toggle Party Zone Membership
+zone1.group.is_party_zone_member_toggle()
 ```
 
 ## `Zone.analog_output`
 
 | Property      	| Description | Type		| Values 		| Default |
 | ---------------------- 	| ----------- | ----------- |----------- |----------- |
-| `source`     			 	| Where the AO is routed from. i.e a zone, optical input or off |	`int`	| `AnalogOutput.Sources` | `Off`
+| `source`     			 	| Where the AO is routed from. i.e stream, 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`  |
 
@@ -363,6 +422,23 @@ EQ to be set in [decibel](https://en.wikipedia.org/wiki/Decibel) using a range `
 zone1.settings.eq.khz1_db = -2
 ```
 
+## `Zone.settings.subwoofer`
+
+* **A.1 and A.1x only**
+* Set `0` for full frequency range
+
+| Property        | Description | Type    | Values    | Default |
+| ----------------------  | ----------- | ----------- |----------- |----------- |
+| `crossover`             | Set "sub out" crossover frequency from 50-200Hz.       |  `int` | `0` or `50...200` | `0`
+
+```python
+"""Examples"""
+# Set subwoofer ouput crossover to 100hz
+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`.
@@ -412,9 +488,11 @@ shell_command:
 
 ## Credit
 
+Thanks to [@dj-jam](https://github.com/dj-jam) for the continued testing.
+
 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)
+Motivation for this project was to integrate VSSLs amplifiers into [Home Assistant](https://www.home-assistant.io/) and have control over different subnets (not mDNS dependant)
 
 ## Known Issues & Limitiations
 
@@ -422,15 +500,15 @@ Motovation for this project was to intergrate VSSLs amplifiers into [Home Assist
 * 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.
+* 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. Doesnt always function this way, depending on stream source
+* `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 and subwoofer control
+* A.1(x) coverage i.e Bluetooth
 * REST API / Web App
 * Save and recall EQ
 * IR Control

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

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