vsslctrl 0.2.0__tar.gz → 0.2.2__tar.gz

{vsslctrl-0.2.0 → vsslctrl-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vsslctrl
-Version: 0.2.0
+Version: 0.2.2
 Summary: Package for controlling VSSL's range of streaming amplifiers
 Author-email: vsslctrl <vsslcontrolled@proton.me>
 Classifier: Development Status :: 4 - Beta
@@ -188,7 +188,7 @@ print(zone1.settings.name)
 ```python
 from vsslctrl.settings import ZoneSettings
 # Setting the zone name and wait for feedback
-future_name = vssl.event_bus.future(ZoneSettings.Events.NAME_CHANGE, zone1.id)
+future_name = vssl.event_bus.future(ZoneSettings.Events.NAME_CHANGE, zone1.host)
 zone1.settings.name = 'Bathroom' 
 # Helper to await a future with timeout
 new_name = await vssl.event_bus.wait_future(future_name)
@@ -230,8 +230,7 @@ vssl.factory_reset()
 | `name`     			 	| Device name |	`str` | 
 | `bus_1_name`   			| Name of Bus 1        |	`str` | <ul><li>`A.1`: Optical Input</li><li>`A.3x`/`A.6x`: Not Used</li></ul>
 | `bus_2_name`        | Name of Bus 2        |  `str` | <ul><li>`A.1`: Coax Input</li><li>`A.3x`/`A.6x`: Optical Input</li></ul>
-| `bluetooth`        | Bluetooth enabled / disabled        |  `bool` |
-| `bluetooth_toggle()`        | Toggle Bluetooth        | `func`  |
+| `status_light_mode`        | Status lights - Normal or Dark Mode        |  `str` | [`VsslSettings.StatusLightModes`](https://github.com/vsslctrl/vsslctrl/blob/644586fa183def1f23f0bfd239454fa8422e3dbe/vsslctrl/settings.py#L17)
 
 ```python
 """Example"""
@@ -239,17 +238,35 @@ vssl.factory_reset()
 vssl.settings.name = 'My House'
 # Setting bus 2 name
 vssl.settings.bus_2_name = 'Optical Input'
+```
+
+## `Vssl.settings.bluetooth`
+
+`A.1(x)` only.
+
+| Property        | Description | Type    | Values    | 
+| ----------------------  | ----------- | ----------- |----------- |
+| `state`             | Bluetooth state | `int` readonly  | [`BluetoothSettings.States`](https://github.com/vsslctrl/vsslctrl/blob/644586fa183def1f23f0bfd239454fa8422e3dbe/vsslctrl/settings.py#L130)
+| `on()`        | Enable Bluetooth        | `func`
+| `off()`        | Disable Bluetooth        | `func`
+| `clear_pairs()`        | Clear pairings        | `func`
+| `enter_pairing()`        | Enter pairing        | `func`
+| `exit_pairing()`        | Exit pairing        | `func`
+| `toggle()`        | Toggle Bluetooth        | `func`  |
+
+```python
+"""Example"""
 # Enable Bluetooth
-vssl.settings.bluetooth = True
+vssl.settings.bluetooth.on()
 # Toggle Bluetooth
-vssl.settings.bluetooth_toggle()
+vssl.settings.bluetooth.toggle()
 ```
 
 ## `Vssl.settings.power`
 
 | Property      	| Description | Type		| Values 		| 
 | ---------------------- 	| ----------- | ----------- |----------- |
-| `state`     			 	| Power state |	`int` readonly	| `VsslPowerSettings.States`
+| `state`     			 	| Power state |	`int` readonly	| [`VsslPowerSettings.States`](https://github.com/vsslctrl/vsslctrl/blob/644586fa183def1f23f0bfd239454fa8422e3dbe/vsslctrl/settings.py#L243)
 | `adaptive`   			| Power adaptive        |	`bool`
 
 ```python
@@ -263,7 +280,7 @@ vssl.settings.power.adaptive = True
 
 | Property      	| Description | Type		| Values 		| 
 | ---------------------- 	| ----------- | ----------- |----------- |
-| `id`     			 	| Zone number / ID |	`int` readonly	| `ZoneIDs`
+| `id`     			 	| Zone number / ID |	`int` readonly	| [`ZoneIDs`](https://github.com/vsslctrl/vsslctrl/blob/644586fa183def1f23f0bfd239454fa8422e3dbe/vsslctrl/data_structure.py#L75)
 | `host`   			| IP address        |	`str` readonly
 | `volume`   			| Volume        |	`int`  | `0...100`
 | `volume_raise([step=1])`   			| Raise volume by `step`       |	`func`  | step: `int` `1...100`
@@ -276,8 +293,9 @@ vssl.settings.power.adaptive = True
 | `next()`   			| Next track       |	`func`  |
 | `prev()`   			| Begining of track or previous track        |	`func`  |
 | `reboot()`   			| Reboot zone        |	`func`  |
-| `play_url([url], [all_zones])`   			| Play a URL       |	`func`  | url: `str`, all_zones: `bool`
+| `play_url([url], [all_zones], [volume])`   			| Play a URL       |	`func`  | url: `str`<br/>all_zones: `bool`<br/>volume: `int` `1...100`
 
+**Note:** `play_url()` is intended as a PA system. The zone will stop repsonding to commands (e.g transport, volume etc.)  until the requested file has finished playing.
 
 ```python
 """Examples"""
@@ -293,19 +311,19 @@ zone1.mute_toggle()
 zone1.pause()
 # Next track
 zone1.next()
-# Play a URL on this zone1
-zone1.play_url('http://soundbible.com/grab.php?id=2217&type=mp3')
-# Play a URL on all zones
+# Play a URL on this zone1 at 15% volume
+zone1.play_url('http://soundbible.com/grab.php?id=2217&type=mp3', volume=15)
+# Play a URL on all zones at current volume level
 zone1.play_url('http://soundbible.com/grab.php?id=2217&type=mp3', True)
 ```
 
 ## `Zone.transport`
 
-A VSSL amplifier can not start a stream except for playing a URL directly. This is a limitation of the hardware itself.
+A VSSL amplifier can not start a stream except for when using `zone.play_url()`. This is a limitation of the hardware itself.
 
 | Property      	| Description | Type		| Values 		| 
 | ---------------------- | ----------- | ----------- |----------- |
-| `state`     			 | Transport state. i.e Play, Stop, Pause | `int`	| `ZoneTransport.States`
+| `state`     			 | Transport state. i.e Play, Stop, Pause | `int`	| [`ZoneTransport.States`](https://github.com/vsslctrl/vsslctrl/blob/644586fa183def1f23f0bfd239454fa8422e3dbe/vsslctrl/transport.py#L9)
 | `play()`   		 | Play   |	`func`  |
 | `stop()`   		 | Stop     |	`func`  |
 | `pause()`   		 | Pause     |	`func`  |
@@ -314,7 +332,7 @@ A VSSL amplifier can not start a stream except for playing a URL directly. This
 | `is_playing`   			| Is the zone playing        |	`bool` readonly
 | `is_stopped`   			| Is the zone stopped        |	`bool` readonly
 | `is_pasued`   			| Is the zone pasued        |	`bool` readonly
-| `is_repeat`     			 | Repeat state. i.e all, one, off | `int` readonly	| `ZoneTransport.Repeat`
+| `is_repeat`     			 | Repeat state. i.e all, one, off | `int` readonly	| [`ZoneTransport.Repeat`](https://github.com/vsslctrl/vsslctrl/blob/644586fa183def1f23f0bfd239454fa8422e3dbe/vsslctrl/transport.py#L19)
 | `is_shuffle`   			| Is shuffle enabled       |	`bool` readonly
 | `has_next`   			| Is the next button enabled       |	`bool` readonly
 | `has_prev`   			| Is the prev button enabled       |	`bool` readonly
@@ -341,7 +359,7 @@ zone1.transport.state = ZoneTransport.States.PAUSE
 | `duration`     		| Length in miliseconds (ms) | `int` readonly	| 
 | `progress`     		| Current position in miliseconds (ms) | `int` readonly	|
 | `cover_art_url`     	| URL to cover art | `str` readonly	| 
-| `source`     			| Track source e.g Spotify |	`int` readonly	| `TrackMetadata.Sources`
+| `source`     			| Track source e.g Spotify |	`int` readonly	| [`TrackMetadata.Sources`](https://github.com/vsslctrl/vsslctrl/blob/644586fa183def1f23f0bfd239454fa8422e3dbe/vsslctrl/track.py#L28)
 | `url`     	| URL of file or track | `str` readonly	| 
 
 
@@ -349,8 +367,8 @@ zone1.transport.state = ZoneTransport.States.PAUSE
 
 | Property      	| Description | Type		| Values 		| 
 | ---------------------- 	| ----------- | ----------- |----------- |
-| `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`
+| `source`     			 	| Change input source.<br/>Source to be played out the zones speakers |	`int`	| [`InputRouter.Sources`](https://github.com/vsslctrl/vsslctrl/blob/644586fa183def1f23f0bfd239454fa8422e3dbe/vsslctrl/io.py#L35)
+| `priority`     			| Change input priority.<br/>Stream or local to have precedence  |	`int`	| [`InputRouter.Priorities`](https://github.com/vsslctrl/vsslctrl/blob/644586fa183def1f23f0bfd239454fa8422e3dbe/vsslctrl/io.py#L23)
 
 
 ### `A.1(x)` Source Routing Order
@@ -380,14 +398,12 @@ zone1.input.priority = InputRouter.Priorities.LOCAL
 
 ## `Zone.group`
 
-Unsupported on X series amplifiers.
-
 | Property      	| Description | Type		| Values 		| 
 | ---------------------- 	| ----------- | ----------- |----------- |
-| `source`     			 	| Zone ID of group master / source |	`int` readonly	| `ZoneIDs`
+| `source`     			 	| Zone ID of group master / source |	`int` readonly	| [`ZoneIDs`](https://github.com/vsslctrl/vsslctrl/blob/644586fa183def1f23f0bfd239454fa8422e3dbe/vsslctrl/data_structure.py#L75)
 | `is_master`   			| This zone is the group master        |	`bool` readonly
-| `add_member()`   			| Add zone to group / create group |	`func`  | `ZoneIDs`
-| `remove_member()`   		| Remove zone from group      |	`func`  | `ZoneIDs`
+| `add_member()`   			| Add zone to group / create group |	`func`  | [`ZoneIDs`](https://github.com/vsslctrl/vsslctrl/blob/644586fa183def1f23f0bfd239454fa8422e3dbe/vsslctrl/data_structure.py#L75)
+| `remove_member()`   		| Remove zone from group      |	`func`  | [`ZoneIDs`](https://github.com/vsslctrl/vsslctrl/blob/644586fa183def1f23f0bfd239454fa8422e3dbe/vsslctrl/data_structure.py#L75)
 | `dissolve()`   			| Dissolve group / remove all members       |	`func`  |
 | `leave()`   				| Leave the group if a member       |	`func`  |
 | `is_party_zone_member`  | Member of Party Zone |  `bool`  |
@@ -411,7 +427,7 @@ zone1.group.is_party_zone_member_toggle()
 
 | Property      	| Description | Type		| Values 		| Default |
 | ---------------------- 	| ----------- | ----------- |----------- |----------- |
-| `source`     			 	| Where the AO is routed from. i.e stream, 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`](https://github.com/vsslctrl/vsslctrl/blob/644586fa183def1f23f0bfd239454fa8422e3dbe/vsslctrl/io.py#L150) | `Off`
 | `is_fixed_volume`   			| Fix the output volume. Output wont respond to volume control        |	`bool` | |`False`
 | `is_fixed_volume_toggle()`   			| Toggle fixed volume      |	`func`  |
 
@@ -434,7 +450,7 @@ zone1.analog_output.is_fixed_volume = True
 | `name`     			 	| Name |	`str`	| 
 | `disabled`   			| Disable the zone        |	`bool` || `False`
 | `disabled_toggle()`   			| disable / enable        |	`func`  |
-| `mono`   			| Set output to mono or stereo        |	`int`  | `ZoneSettings.StereoMono` | `STEREO`
+| `mono`   			| Set output to mono or stereo        |	`int`  | [`ZoneSettings.StereoMono`](https://github.com/vsslctrl/vsslctrl/blob/644586fa183def1f23f0bfd239454fa8422e3dbe/vsslctrl/settings.py#L310) | `STEREO`
 | `mono_toggle()`   			| Toggle mono or stereo        |	`func`  |
 
 ```python
@@ -506,7 +522,7 @@ zone1.settings.eq.khz1_db = -2
 
 ## `Zone.settings.subwoofer`
 
-* **A.1 and A.1x only**
+* **`A.1` and `A.1x` only**
 * Set `0` for full frequency range
 
 | Property        | Description | Type    | Values    | Default |

{vsslctrl-0.2.0 → vsslctrl-0.2.2}/README.md

@@ -166,7 +166,7 @@ print(zone1.settings.name)
 ```python
 from vsslctrl.settings import ZoneSettings
 # Setting the zone name and wait for feedback
-future_name = vssl.event_bus.future(ZoneSettings.Events.NAME_CHANGE, zone1.id)
+future_name = vssl.event_bus.future(ZoneSettings.Events.NAME_CHANGE, zone1.host)
 zone1.settings.name = 'Bathroom' 
 # Helper to await a future with timeout
 new_name = await vssl.event_bus.wait_future(future_name)
@@ -208,8 +208,7 @@ vssl.factory_reset()
 | `name`     			 	| Device name |	`str` | 
 | `bus_1_name`   			| Name of Bus 1        |	`str` | <ul><li>`A.1`: Optical Input</li><li>`A.3x`/`A.6x`: Not Used</li></ul>
 | `bus_2_name`        | Name of Bus 2        |  `str` | <ul><li>`A.1`: Coax Input</li><li>`A.3x`/`A.6x`: Optical Input</li></ul>
-| `bluetooth`        | Bluetooth enabled / disabled        |  `bool` |
-| `bluetooth_toggle()`        | Toggle Bluetooth        | `func`  |
+| `status_light_mode`        | Status lights - Normal or Dark Mode        |  `str` | [`VsslSettings.StatusLightModes`](https://github.com/vsslctrl/vsslctrl/blob/644586fa183def1f23f0bfd239454fa8422e3dbe/vsslctrl/settings.py#L17)
 
 ```python
 """Example"""
@@ -217,17 +216,35 @@ vssl.factory_reset()
 vssl.settings.name = 'My House'
 # Setting bus 2 name
 vssl.settings.bus_2_name = 'Optical Input'
+```
+
+## `Vssl.settings.bluetooth`
+
+`A.1(x)` only.
+
+| Property        | Description | Type    | Values    | 
+| ----------------------  | ----------- | ----------- |----------- |
+| `state`             | Bluetooth state | `int` readonly  | [`BluetoothSettings.States`](https://github.com/vsslctrl/vsslctrl/blob/644586fa183def1f23f0bfd239454fa8422e3dbe/vsslctrl/settings.py#L130)
+| `on()`        | Enable Bluetooth        | `func`
+| `off()`        | Disable Bluetooth        | `func`
+| `clear_pairs()`        | Clear pairings        | `func`
+| `enter_pairing()`        | Enter pairing        | `func`
+| `exit_pairing()`        | Exit pairing        | `func`
+| `toggle()`        | Toggle Bluetooth        | `func`  |
+
+```python
+"""Example"""
 # Enable Bluetooth
-vssl.settings.bluetooth = True
+vssl.settings.bluetooth.on()
 # Toggle Bluetooth
-vssl.settings.bluetooth_toggle()
+vssl.settings.bluetooth.toggle()
 ```
 
 ## `Vssl.settings.power`
 
 | Property      	| Description | Type		| Values 		| 
 | ---------------------- 	| ----------- | ----------- |----------- |
-| `state`     			 	| Power state |	`int` readonly	| `VsslPowerSettings.States`
+| `state`     			 	| Power state |	`int` readonly	| [`VsslPowerSettings.States`](https://github.com/vsslctrl/vsslctrl/blob/644586fa183def1f23f0bfd239454fa8422e3dbe/vsslctrl/settings.py#L243)
 | `adaptive`   			| Power adaptive        |	`bool`
 
 ```python
@@ -241,7 +258,7 @@ vssl.settings.power.adaptive = True
 
 | Property      	| Description | Type		| Values 		| 
 | ---------------------- 	| ----------- | ----------- |----------- |
-| `id`     			 	| Zone number / ID |	`int` readonly	| `ZoneIDs`
+| `id`     			 	| Zone number / ID |	`int` readonly	| [`ZoneIDs`](https://github.com/vsslctrl/vsslctrl/blob/644586fa183def1f23f0bfd239454fa8422e3dbe/vsslctrl/data_structure.py#L75)
 | `host`   			| IP address        |	`str` readonly
 | `volume`   			| Volume        |	`int`  | `0...100`
 | `volume_raise([step=1])`   			| Raise volume by `step`       |	`func`  | step: `int` `1...100`
@@ -254,8 +271,9 @@ vssl.settings.power.adaptive = True
 | `next()`   			| Next track       |	`func`  |
 | `prev()`   			| Begining of track or previous track        |	`func`  |
 | `reboot()`   			| Reboot zone        |	`func`  |
-| `play_url([url], [all_zones])`   			| Play a URL       |	`func`  | url: `str`, all_zones: `bool`
+| `play_url([url], [all_zones], [volume])`   			| Play a URL       |	`func`  | url: `str`<br/>all_zones: `bool`<br/>volume: `int` `1...100`
 
+**Note:** `play_url()` is intended as a PA system. The zone will stop repsonding to commands (e.g transport, volume etc.)  until the requested file has finished playing.
 
 ```python
 """Examples"""
@@ -271,19 +289,19 @@ zone1.mute_toggle()
 zone1.pause()
 # Next track
 zone1.next()
-# Play a URL on this zone1
-zone1.play_url('http://soundbible.com/grab.php?id=2217&type=mp3')
-# Play a URL on all zones
+# Play a URL on this zone1 at 15% volume
+zone1.play_url('http://soundbible.com/grab.php?id=2217&type=mp3', volume=15)
+# Play a URL on all zones at current volume level
 zone1.play_url('http://soundbible.com/grab.php?id=2217&type=mp3', True)
 ```
 
 ## `Zone.transport`
 
-A VSSL amplifier can not start a stream except for playing a URL directly. This is a limitation of the hardware itself.
+A VSSL amplifier can not start a stream except for when using `zone.play_url()`. This is a limitation of the hardware itself.
 
 | Property      	| Description | Type		| Values 		| 
 | ---------------------- | ----------- | ----------- |----------- |
-| `state`     			 | Transport state. i.e Play, Stop, Pause | `int`	| `ZoneTransport.States`
+| `state`     			 | Transport state. i.e Play, Stop, Pause | `int`	| [`ZoneTransport.States`](https://github.com/vsslctrl/vsslctrl/blob/644586fa183def1f23f0bfd239454fa8422e3dbe/vsslctrl/transport.py#L9)
 | `play()`   		 | Play   |	`func`  |
 | `stop()`   		 | Stop     |	`func`  |
 | `pause()`   		 | Pause     |	`func`  |
@@ -292,7 +310,7 @@ A VSSL amplifier can not start a stream except for playing a URL directly. This
 | `is_playing`   			| Is the zone playing        |	`bool` readonly
 | `is_stopped`   			| Is the zone stopped        |	`bool` readonly
 | `is_pasued`   			| Is the zone pasued        |	`bool` readonly
-| `is_repeat`     			 | Repeat state. i.e all, one, off | `int` readonly	| `ZoneTransport.Repeat`
+| `is_repeat`     			 | Repeat state. i.e all, one, off | `int` readonly	| [`ZoneTransport.Repeat`](https://github.com/vsslctrl/vsslctrl/blob/644586fa183def1f23f0bfd239454fa8422e3dbe/vsslctrl/transport.py#L19)
 | `is_shuffle`   			| Is shuffle enabled       |	`bool` readonly
 | `has_next`   			| Is the next button enabled       |	`bool` readonly
 | `has_prev`   			| Is the prev button enabled       |	`bool` readonly
@@ -319,7 +337,7 @@ zone1.transport.state = ZoneTransport.States.PAUSE
 | `duration`     		| Length in miliseconds (ms) | `int` readonly	| 
 | `progress`     		| Current position in miliseconds (ms) | `int` readonly	|
 | `cover_art_url`     	| URL to cover art | `str` readonly	| 
-| `source`     			| Track source e.g Spotify |	`int` readonly	| `TrackMetadata.Sources`
+| `source`     			| Track source e.g Spotify |	`int` readonly	| [`TrackMetadata.Sources`](https://github.com/vsslctrl/vsslctrl/blob/644586fa183def1f23f0bfd239454fa8422e3dbe/vsslctrl/track.py#L28)
 | `url`     	| URL of file or track | `str` readonly	| 
 
 
@@ -327,8 +345,8 @@ zone1.transport.state = ZoneTransport.States.PAUSE
 
 | Property      	| Description | Type		| Values 		| 
 | ---------------------- 	| ----------- | ----------- |----------- |
-| `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`
+| `source`     			 	| Change input source.<br/>Source to be played out the zones speakers |	`int`	| [`InputRouter.Sources`](https://github.com/vsslctrl/vsslctrl/blob/644586fa183def1f23f0bfd239454fa8422e3dbe/vsslctrl/io.py#L35)
+| `priority`     			| Change input priority.<br/>Stream or local to have precedence  |	`int`	| [`InputRouter.Priorities`](https://github.com/vsslctrl/vsslctrl/blob/644586fa183def1f23f0bfd239454fa8422e3dbe/vsslctrl/io.py#L23)
 
 
 ### `A.1(x)` Source Routing Order
@@ -358,14 +376,12 @@ zone1.input.priority = InputRouter.Priorities.LOCAL
 
 ## `Zone.group`
 
-Unsupported on X series amplifiers.
-
 | Property      	| Description | Type		| Values 		| 
 | ---------------------- 	| ----------- | ----------- |----------- |
-| `source`     			 	| Zone ID of group master / source |	`int` readonly	| `ZoneIDs`
+| `source`     			 	| Zone ID of group master / source |	`int` readonly	| [`ZoneIDs`](https://github.com/vsslctrl/vsslctrl/blob/644586fa183def1f23f0bfd239454fa8422e3dbe/vsslctrl/data_structure.py#L75)
 | `is_master`   			| This zone is the group master        |	`bool` readonly
-| `add_member()`   			| Add zone to group / create group |	`func`  | `ZoneIDs`
-| `remove_member()`   		| Remove zone from group      |	`func`  | `ZoneIDs`
+| `add_member()`   			| Add zone to group / create group |	`func`  | [`ZoneIDs`](https://github.com/vsslctrl/vsslctrl/blob/644586fa183def1f23f0bfd239454fa8422e3dbe/vsslctrl/data_structure.py#L75)
+| `remove_member()`   		| Remove zone from group      |	`func`  | [`ZoneIDs`](https://github.com/vsslctrl/vsslctrl/blob/644586fa183def1f23f0bfd239454fa8422e3dbe/vsslctrl/data_structure.py#L75)
 | `dissolve()`   			| Dissolve group / remove all members       |	`func`  |
 | `leave()`   				| Leave the group if a member       |	`func`  |
 | `is_party_zone_member`  | Member of Party Zone |  `bool`  |
@@ -389,7 +405,7 @@ zone1.group.is_party_zone_member_toggle()
 
 | Property      	| Description | Type		| Values 		| Default |
 | ---------------------- 	| ----------- | ----------- |----------- |----------- |
-| `source`     			 	| Where the AO is routed from. i.e stream, 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`](https://github.com/vsslctrl/vsslctrl/blob/644586fa183def1f23f0bfd239454fa8422e3dbe/vsslctrl/io.py#L150) | `Off`
 | `is_fixed_volume`   			| Fix the output volume. Output wont respond to volume control        |	`bool` | |`False`
 | `is_fixed_volume_toggle()`   			| Toggle fixed volume      |	`func`  |
 
@@ -412,7 +428,7 @@ zone1.analog_output.is_fixed_volume = True
 | `name`     			 	| Name |	`str`	| 
 | `disabled`   			| Disable the zone        |	`bool` || `False`
 | `disabled_toggle()`   			| disable / enable        |	`func`  |
-| `mono`   			| Set output to mono or stereo        |	`int`  | `ZoneSettings.StereoMono` | `STEREO`
+| `mono`   			| Set output to mono or stereo        |	`int`  | [`ZoneSettings.StereoMono`](https://github.com/vsslctrl/vsslctrl/blob/644586fa183def1f23f0bfd239454fa8422e3dbe/vsslctrl/settings.py#L310) | `STEREO`
 | `mono_toggle()`   			| Toggle mono or stereo        |	`func`  |
 
 ```python
@@ -484,7 +500,7 @@ zone1.settings.eq.khz1_db = -2
 
 ## `Zone.settings.subwoofer`
 
-* **A.1 and A.1x only**
+* **`A.1` and `A.1x` only**
 * Set `0` for full frequency range
 
 | Property        | Description | Type    | Values    | Default |

{vsslctrl-0.2.0 → vsslctrl-0.2.2}/pyproject.toml

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

{vsslctrl-0.2.0 → vsslctrl-0.2.2}/vsslctrl/__init__.py

@@ -1,4 +1,4 @@
-VSSL_VERSION = "0.2.0"
+VSSL_VERSION = "0.2.2"
 VSSL_NAME = "VSSL"
 
 LOG_DIVIDER = "------------------------------------------------------"

{vsslctrl-0.2.0 → vsslctrl-0.2.2}/vsslctrl/api_alpha.py

@@ -1773,13 +1773,19 @@ class APIAlpha(APIBase):
         command = bytearray([16, 85])
         command.extend(struct.pack(">B", len(string) + 2))
 
-        # Zone 0 will play on all zones
-        channel = 0 if all_zones else self.zone.id
+        # Channel: 0 = all zones, 1 = this (the connected) zone. Each Zone has its
+        # own TCP connection (zone.host), so the target is always channel 1 from
+        # that connection's perspective. Previously this sent self.zone.id, which
+        # produced no playback on multi-zone units for zones with id > 1 (verified
+        # on an A.6x: zone 4 never played with channel byte 4; channel 1 works).
+        channel = 0 if all_zones else 1
         command.extend([channel])
 
-        # Volume
+        # Volume — the announcement plays at `volume` (0-100), falling back to the
+        # zone's current volume when not supplied. Previously this sent
+        # self.zone.volume unconditionally, so the `volume` argument was ignored.
         vol = self.zone.volume if volume == None else clamp_volume(volume)
-        command.extend([self.zone.volume])
+        command.extend([vol])
 
         # Add URL to request
         command.extend(self._encode_frame_data(string))

{vsslctrl-0.2.0 → vsslctrl-0.2.2}/vsslctrl/event_bus.py

@@ -18,19 +18,35 @@ class EventBus:
         self.event_queue = asyncio.Queue()
 
         self.running = False
+        self.process = None
 
-        self.process = asyncio.create_task(self.process_events())
+        self.start()
 
     # Helper for wildcard matching, so we can use partial wildcards. e.g zone.api.connected
     def _matches_pattern(self, event_type, pattern):
         return fnmatch.fnmatch(event_type, pattern)
 
+    # Check we are actually processing
+    @property
+    def _is_alive(self):
+        return isinstance(self.process, asyncio.Task) and not self.process.done()
+
+    #
+    # Start
+    #
+    def start(self):
+        if self._is_alive:
+            return
+
+        self.process = asyncio.create_task(self.process_events())
+
     #
     # Stop
     #
     def stop(self):
         self.running = False
-        self.process.cancel()
+        if isinstance(self.process, asyncio.Task):
+            self.process.cancel()
         self._log_debug(f"stopped event processing")
 
     #
@@ -115,6 +131,8 @@ class EventBus:
     # Publish Async (Use when inside events loop)
     #
     async def publish_async(self, event_type, entity=None, data=None):
+        # Start if we have been stopped
+        self.start()
         event_type = event_type.lower()
         await self.event_queue.put((event_type, entity, data))
 

{vsslctrl-0.2.0 → vsslctrl-0.2.2}/vsslctrl/settings.py

@@ -523,6 +523,14 @@ class VolumeSettings(ZoneDataClass):
 
 
 class EQSettings(ZoneDataClass):
+    """
+    Simple EQ (as per VSSL apps):
+        Treble = 8khz + 15khz
+        Mid = 500hz + 1khz + 4khz
+        Bass = 60hz + 200hz
+
+    """
+
     MIN_VALUE = 90
     MAX_VALUE = 110
     MIN_VALUE_DB = -10
@@ -622,7 +630,7 @@ class EQSettings(ZoneDataClass):
         return int(max(self.MIN_VALUE, min(value, self.MAX_VALUE)))
 
     #
-    # Map between -10 and +10
+    # Map between -10-+10 and 90-110
     #
     # 90 = -10db
     # 100 = 0db

{vsslctrl-0.2.0 → vsslctrl-0.2.2}/vsslctrl.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vsslctrl
-Version: 0.2.0
+Version: 0.2.2
 Summary: Package for controlling VSSL's range of streaming amplifiers
 Author-email: vsslctrl <vsslcontrolled@proton.me>
 Classifier: Development Status :: 4 - Beta
@@ -188,7 +188,7 @@ print(zone1.settings.name)
 ```python
 from vsslctrl.settings import ZoneSettings
 # Setting the zone name and wait for feedback
-future_name = vssl.event_bus.future(ZoneSettings.Events.NAME_CHANGE, zone1.id)
+future_name = vssl.event_bus.future(ZoneSettings.Events.NAME_CHANGE, zone1.host)
 zone1.settings.name = 'Bathroom' 
 # Helper to await a future with timeout
 new_name = await vssl.event_bus.wait_future(future_name)
@@ -230,8 +230,7 @@ vssl.factory_reset()
 | `name`     			 	| Device name |	`str` | 
 | `bus_1_name`   			| Name of Bus 1        |	`str` | <ul><li>`A.1`: Optical Input</li><li>`A.3x`/`A.6x`: Not Used</li></ul>
 | `bus_2_name`        | Name of Bus 2        |  `str` | <ul><li>`A.1`: Coax Input</li><li>`A.3x`/`A.6x`: Optical Input</li></ul>
-| `bluetooth`        | Bluetooth enabled / disabled        |  `bool` |
-| `bluetooth_toggle()`        | Toggle Bluetooth        | `func`  |
+| `status_light_mode`        | Status lights - Normal or Dark Mode        |  `str` | [`VsslSettings.StatusLightModes`](https://github.com/vsslctrl/vsslctrl/blob/644586fa183def1f23f0bfd239454fa8422e3dbe/vsslctrl/settings.py#L17)
 
 ```python
 """Example"""
@@ -239,17 +238,35 @@ vssl.factory_reset()
 vssl.settings.name = 'My House'
 # Setting bus 2 name
 vssl.settings.bus_2_name = 'Optical Input'
+```
+
+## `Vssl.settings.bluetooth`
+
+`A.1(x)` only.
+
+| Property        | Description | Type    | Values    | 
+| ----------------------  | ----------- | ----------- |----------- |
+| `state`             | Bluetooth state | `int` readonly  | [`BluetoothSettings.States`](https://github.com/vsslctrl/vsslctrl/blob/644586fa183def1f23f0bfd239454fa8422e3dbe/vsslctrl/settings.py#L130)
+| `on()`        | Enable Bluetooth        | `func`
+| `off()`        | Disable Bluetooth        | `func`
+| `clear_pairs()`        | Clear pairings        | `func`
+| `enter_pairing()`        | Enter pairing        | `func`
+| `exit_pairing()`        | Exit pairing        | `func`
+| `toggle()`        | Toggle Bluetooth        | `func`  |
+
+```python
+"""Example"""
 # Enable Bluetooth
-vssl.settings.bluetooth = True
+vssl.settings.bluetooth.on()
 # Toggle Bluetooth
-vssl.settings.bluetooth_toggle()
+vssl.settings.bluetooth.toggle()
 ```
 
 ## `Vssl.settings.power`
 
 | Property      	| Description | Type		| Values 		| 
 | ---------------------- 	| ----------- | ----------- |----------- |
-| `state`     			 	| Power state |	`int` readonly	| `VsslPowerSettings.States`
+| `state`     			 	| Power state |	`int` readonly	| [`VsslPowerSettings.States`](https://github.com/vsslctrl/vsslctrl/blob/644586fa183def1f23f0bfd239454fa8422e3dbe/vsslctrl/settings.py#L243)
 | `adaptive`   			| Power adaptive        |	`bool`
 
 ```python
@@ -263,7 +280,7 @@ vssl.settings.power.adaptive = True
 
 | Property      	| Description | Type		| Values 		| 
 | ---------------------- 	| ----------- | ----------- |----------- |
-| `id`     			 	| Zone number / ID |	`int` readonly	| `ZoneIDs`
+| `id`     			 	| Zone number / ID |	`int` readonly	| [`ZoneIDs`](https://github.com/vsslctrl/vsslctrl/blob/644586fa183def1f23f0bfd239454fa8422e3dbe/vsslctrl/data_structure.py#L75)
 | `host`   			| IP address        |	`str` readonly
 | `volume`   			| Volume        |	`int`  | `0...100`
 | `volume_raise([step=1])`   			| Raise volume by `step`       |	`func`  | step: `int` `1...100`
@@ -276,8 +293,9 @@ vssl.settings.power.adaptive = True
 | `next()`   			| Next track       |	`func`  |
 | `prev()`   			| Begining of track or previous track        |	`func`  |
 | `reboot()`   			| Reboot zone        |	`func`  |
-| `play_url([url], [all_zones])`   			| Play a URL       |	`func`  | url: `str`, all_zones: `bool`
+| `play_url([url], [all_zones], [volume])`   			| Play a URL       |	`func`  | url: `str`<br/>all_zones: `bool`<br/>volume: `int` `1...100`
 
+**Note:** `play_url()` is intended as a PA system. The zone will stop repsonding to commands (e.g transport, volume etc.)  until the requested file has finished playing.
 
 ```python
 """Examples"""
@@ -293,19 +311,19 @@ zone1.mute_toggle()
 zone1.pause()
 # Next track
 zone1.next()
-# Play a URL on this zone1
-zone1.play_url('http://soundbible.com/grab.php?id=2217&type=mp3')
-# Play a URL on all zones
+# Play a URL on this zone1 at 15% volume
+zone1.play_url('http://soundbible.com/grab.php?id=2217&type=mp3', volume=15)
+# Play a URL on all zones at current volume level
 zone1.play_url('http://soundbible.com/grab.php?id=2217&type=mp3', True)
 ```
 
 ## `Zone.transport`
 
-A VSSL amplifier can not start a stream except for playing a URL directly. This is a limitation of the hardware itself.
+A VSSL amplifier can not start a stream except for when using `zone.play_url()`. This is a limitation of the hardware itself.
 
 | Property      	| Description | Type		| Values 		| 
 | ---------------------- | ----------- | ----------- |----------- |
-| `state`     			 | Transport state. i.e Play, Stop, Pause | `int`	| `ZoneTransport.States`
+| `state`     			 | Transport state. i.e Play, Stop, Pause | `int`	| [`ZoneTransport.States`](https://github.com/vsslctrl/vsslctrl/blob/644586fa183def1f23f0bfd239454fa8422e3dbe/vsslctrl/transport.py#L9)
 | `play()`   		 | Play   |	`func`  |
 | `stop()`   		 | Stop     |	`func`  |
 | `pause()`   		 | Pause     |	`func`  |
@@ -314,7 +332,7 @@ A VSSL amplifier can not start a stream except for playing a URL directly. This
 | `is_playing`   			| Is the zone playing        |	`bool` readonly
 | `is_stopped`   			| Is the zone stopped        |	`bool` readonly
 | `is_pasued`   			| Is the zone pasued        |	`bool` readonly
-| `is_repeat`     			 | Repeat state. i.e all, one, off | `int` readonly	| `ZoneTransport.Repeat`
+| `is_repeat`     			 | Repeat state. i.e all, one, off | `int` readonly	| [`ZoneTransport.Repeat`](https://github.com/vsslctrl/vsslctrl/blob/644586fa183def1f23f0bfd239454fa8422e3dbe/vsslctrl/transport.py#L19)
 | `is_shuffle`   			| Is shuffle enabled       |	`bool` readonly
 | `has_next`   			| Is the next button enabled       |	`bool` readonly
 | `has_prev`   			| Is the prev button enabled       |	`bool` readonly
@@ -341,7 +359,7 @@ zone1.transport.state = ZoneTransport.States.PAUSE
 | `duration`     		| Length in miliseconds (ms) | `int` readonly	| 
 | `progress`     		| Current position in miliseconds (ms) | `int` readonly	|
 | `cover_art_url`     	| URL to cover art | `str` readonly	| 
-| `source`     			| Track source e.g Spotify |	`int` readonly	| `TrackMetadata.Sources`
+| `source`     			| Track source e.g Spotify |	`int` readonly	| [`TrackMetadata.Sources`](https://github.com/vsslctrl/vsslctrl/blob/644586fa183def1f23f0bfd239454fa8422e3dbe/vsslctrl/track.py#L28)
 | `url`     	| URL of file or track | `str` readonly	| 
 
 
@@ -349,8 +367,8 @@ zone1.transport.state = ZoneTransport.States.PAUSE
 
 | Property      	| Description | Type		| Values 		| 
 | ---------------------- 	| ----------- | ----------- |----------- |
-| `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`
+| `source`     			 	| Change input source.<br/>Source to be played out the zones speakers |	`int`	| [`InputRouter.Sources`](https://github.com/vsslctrl/vsslctrl/blob/644586fa183def1f23f0bfd239454fa8422e3dbe/vsslctrl/io.py#L35)
+| `priority`     			| Change input priority.<br/>Stream or local to have precedence  |	`int`	| [`InputRouter.Priorities`](https://github.com/vsslctrl/vsslctrl/blob/644586fa183def1f23f0bfd239454fa8422e3dbe/vsslctrl/io.py#L23)
 
 
 ### `A.1(x)` Source Routing Order
@@ -380,14 +398,12 @@ zone1.input.priority = InputRouter.Priorities.LOCAL
 
 ## `Zone.group`
 
-Unsupported on X series amplifiers.
-
 | Property      	| Description | Type		| Values 		| 
 | ---------------------- 	| ----------- | ----------- |----------- |
-| `source`     			 	| Zone ID of group master / source |	`int` readonly	| `ZoneIDs`
+| `source`     			 	| Zone ID of group master / source |	`int` readonly	| [`ZoneIDs`](https://github.com/vsslctrl/vsslctrl/blob/644586fa183def1f23f0bfd239454fa8422e3dbe/vsslctrl/data_structure.py#L75)
 | `is_master`   			| This zone is the group master        |	`bool` readonly
-| `add_member()`   			| Add zone to group / create group |	`func`  | `ZoneIDs`
-| `remove_member()`   		| Remove zone from group      |	`func`  | `ZoneIDs`
+| `add_member()`   			| Add zone to group / create group |	`func`  | [`ZoneIDs`](https://github.com/vsslctrl/vsslctrl/blob/644586fa183def1f23f0bfd239454fa8422e3dbe/vsslctrl/data_structure.py#L75)
+| `remove_member()`   		| Remove zone from group      |	`func`  | [`ZoneIDs`](https://github.com/vsslctrl/vsslctrl/blob/644586fa183def1f23f0bfd239454fa8422e3dbe/vsslctrl/data_structure.py#L75)
 | `dissolve()`   			| Dissolve group / remove all members       |	`func`  |
 | `leave()`   				| Leave the group if a member       |	`func`  |
 | `is_party_zone_member`  | Member of Party Zone |  `bool`  |
@@ -411,7 +427,7 @@ zone1.group.is_party_zone_member_toggle()
 
 | Property      	| Description | Type		| Values 		| Default |
 | ---------------------- 	| ----------- | ----------- |----------- |----------- |
-| `source`     			 	| Where the AO is routed from. i.e stream, 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`](https://github.com/vsslctrl/vsslctrl/blob/644586fa183def1f23f0bfd239454fa8422e3dbe/vsslctrl/io.py#L150) | `Off`
 | `is_fixed_volume`   			| Fix the output volume. Output wont respond to volume control        |	`bool` | |`False`
 | `is_fixed_volume_toggle()`   			| Toggle fixed volume      |	`func`  |
 
@@ -434,7 +450,7 @@ zone1.analog_output.is_fixed_volume = True
 | `name`     			 	| Name |	`str`	| 
 | `disabled`   			| Disable the zone        |	`bool` || `False`
 | `disabled_toggle()`   			| disable / enable        |	`func`  |
-| `mono`   			| Set output to mono or stereo        |	`int`  | `ZoneSettings.StereoMono` | `STEREO`
+| `mono`   			| Set output to mono or stereo        |	`int`  | [`ZoneSettings.StereoMono`](https://github.com/vsslctrl/vsslctrl/blob/644586fa183def1f23f0bfd239454fa8422e3dbe/vsslctrl/settings.py#L310) | `STEREO`
 | `mono_toggle()`   			| Toggle mono or stereo        |	`func`  |
 
 ```python
@@ -506,7 +522,7 @@ zone1.settings.eq.khz1_db = -2
 
 ## `Zone.settings.subwoofer`
 
-* **A.1 and A.1x only**
+* **`A.1` and `A.1x` only**
 * Set `0` for full frequency range
 
 | Property        | Description | Type    | Values    | Default |