uwscli 0.3.0__tar.gz → 0.4.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. {uwscli-0.3.0/src/uwscli.egg-info → uwscli-0.4.0}/PKG-INFO +30 -15
  2. {uwscli-0.3.0 → uwscli-0.4.0}/README.md +26 -11
  3. {uwscli-0.3.0 → uwscli-0.4.0}/pyproject.toml +4 -4
  4. {uwscli-0.3.0 → uwscli-0.4.0}/src/uwscli/__init__.py +1 -1
  5. {uwscli-0.3.0 → uwscli-0.4.0}/src/uwscli/cli.py +254 -55
  6. {uwscli-0.3.0 → uwscli-0.4.0}/src/uwscli/lcd.py +2 -2
  7. {uwscli-0.3.0 → uwscli-0.4.0}/src/uwscli/tlcontroller.py +1 -1
  8. {uwscli-0.3.0 → uwscli-0.4.0}/src/uwscli/wireless.py +25 -0
  9. {uwscli-0.3.0 → uwscli-0.4.0/src/uwscli.egg-info}/PKG-INFO +30 -15
  10. uwscli-0.4.0/tests/test_cli_errors.py +101 -0
  11. {uwscli-0.3.0 → uwscli-0.4.0}/tests/test_cli_output.py +454 -3
  12. uwscli-0.3.0/tests/test_cli_errors.py +0 -49
  13. {uwscli-0.3.0 → uwscli-0.4.0}/LICENSE +0 -0
  14. {uwscli-0.3.0 → uwscli-0.4.0}/setup.cfg +0 -0
  15. {uwscli-0.3.0 → uwscli-0.4.0}/src/uwscli/data/__init__.py +0 -0
  16. {uwscli-0.3.0 → uwscli-0.4.0}/src/uwscli/data/twinkle.bin +0 -0
  17. {uwscli-0.3.0 → uwscli-0.4.0}/src/uwscli/led.py +0 -0
  18. {uwscli-0.3.0 → uwscli-0.4.0}/src/uwscli/logging_utils.py +0 -0
  19. {uwscli-0.3.0 → uwscli-0.4.0}/src/uwscli/structs.py +0 -0
  20. {uwscli-0.3.0 → uwscli-0.4.0}/src/uwscli/system_usb.py +0 -0
  21. {uwscli-0.3.0 → uwscli-0.4.0}/src/uwscli/tinyuz.py +0 -0
  22. {uwscli-0.3.0 → uwscli-0.4.0}/src/uwscli/tl_effects.py +0 -0
  23. {uwscli-0.3.0 → uwscli-0.4.0}/src/uwscli/usbutil.py +0 -0
  24. {uwscli-0.3.0 → uwscli-0.4.0}/src/uwscli.egg-info/SOURCES.txt +0 -0
  25. {uwscli-0.3.0 → uwscli-0.4.0}/src/uwscli.egg-info/dependency_links.txt +0 -0
  26. {uwscli-0.3.0 → uwscli-0.4.0}/src/uwscli.egg-info/entry_points.txt +0 -0
  27. {uwscli-0.3.0 → uwscli-0.4.0}/src/uwscli.egg-info/requires.txt +0 -0
  28. {uwscli-0.3.0 → uwscli-0.4.0}/src/uwscli.egg-info/top_level.txt +0 -0
  29. {uwscli-0.3.0 → uwscli-0.4.0}/tests/test_led_compression.py +0 -0
  30. {uwscli-0.3.0 → uwscli-0.4.0}/tests/test_usbutil.py +0 -0
  31. {uwscli-0.3.0 → uwscli-0.4.0}/tests/test_wireless_integration.py +0 -0
  32. {uwscli-0.3.0 → uwscli-0.4.0}/tests/test_wireless_led_packets.py +0 -0
@@ -1,7 +1,7 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: uwscli
3
- Version: 0.3.0
4
- Summary: Uni-Wireless-Sync: wireless control toolkit for TL LCD fan hubs
3
+ Version: 0.4.0
4
+ Summary: Uni-Wireless-Sync: wireless control toolkit for TL fan receivers
5
5
  Author: Study Hsueh
6
6
  License: MIT License
7
7
 
@@ -24,8 +24,8 @@ License: MIT License
24
24
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25
25
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26
26
  SOFTWARE.
27
- Project-URL: Homepage, https://github.com/phstudy/tlv2-lcd
28
- Project-URL: Issues, https://github.com/phstudy/tlv2-lcd/issues
27
+ Project-URL: Homepage, https://github.com/phstudy/uni-wireless-sync
28
+ Project-URL: Issues, https://github.com/phstudy/uni-wireless-sync/issues
29
29
  Keywords: lian-li,uni-fan,wireless,lcd
30
30
  Classifier: Development Status :: 3 - Alpha
31
31
  Classifier: Environment :: Console
@@ -66,7 +66,7 @@ Uni Wireless Sync (UWS) CLI provides command-line utilities for managing Uni Fan
66
66
  ## Supported Hardware
67
67
 
68
68
  - UNI FAN TL wireless LCD panels
69
- - UNI FAN TL wireless fan hubs (non-LCD)
69
+ - UNI FAN TL wireless fans (non-LCD)
70
70
 
71
71
  Other Uni Fan series are currently not supported.
72
72
 
@@ -76,11 +76,23 @@ Other Uni Fan series are currently not supported.
76
76
  - Query LCD firmware and handshake data.
77
77
  - Send JPEG frames or apply control settings (mode, brightness, rotation) to the LCD.
78
78
  - Keep the wireless TL LCD awake by emitting periodic handshakes.
79
- - List wireless fan hubs with metadata (MAC, master MAC, channel, device type, fan speeds, PWM targets).
79
+ - List wireless fan receivers with metadata (MAC, master MAC, channel, device type, fan speeds, PWM targets).
80
+ - List detected master controller MAC addresses to simplify binding workflows.
80
81
  - Send one-shot PWM commands to TL wireless fans over the 2.4 GHz dongle.
81
- - Bind or unbind wireless hubs against the active master controller.
82
- - Toggle motherboard PWM sync mode for one hub or every bound hub.
83
- - Broadcast static RGB payloads to wireless hubs (experimental).
82
+ - Bind or unbind wireless receivers against the active master controller.
83
+ - Toggle motherboard PWM sync mode for one receiver or every bound receiver.
84
+ - Broadcast static RGB payloads to wireless receivers (experimental).
85
+
86
+ ### Fan wiring modes
87
+
88
+ - **USB + PWM header (controller mode):** leave the receiver's PWM lead unplugged; control every fan via `uws fan set-fan` (any PWM value 0-255). The reported `fan_pwm` reflects your last command.
89
+ - **USB-only (receiver mode, PWM lead connected to motherboard):** the CLI writes a PWM of 6 (e.g. `uws fan pwm-sync --mode receiver --all`) so the receiver keeps syncing to the motherboard header. Sending another `set-fan` value at any time overrides the sync immediately; writing 6 (or re-running the sync helper) hands control back to the motherboard.
90
+
91
+ ## FAQ
92
+
93
+ - **How do I mount the L-Wireless Controller (v1)?** The thicker dongle supports two options: (1) plug into a USB Type-A port—this wiring is equivalent to `pwm-sync` receiver mode; (2) plug the header into a 9-pin USB port on the motherboard—this matches `pwm-sync` controller mode, but 2.4 GHz signal strength drops because the dongle lives inside the chassis.
94
+ - **How do I mount the L-Wireless Controller (v2)?** The slimmer dongle only supports option (1): plug into a USB Type-A port (`pwm-sync` receiver mode).
95
+ - **What is the difference between L-Wireless Receiver (v1) and (v2)?** Receiver v1 exposes both USB and a 2-pin PWM lead only on the LCD bundle (USB powers the LCD, the 2-pin lead powers fans); non-LCD receiver v1 units ship with just the 2-pin power lead. Receiver v2 adds a dedicated 4-pin PWM header; plug it into the motherboard when you want it to mirror the motherboard duty cycle via `pwm-sync --mode receiver`, or leave it disconnected and the controller will keep driving fan PWM directly.
84
96
 
85
97
  ## Installation
86
98
 
@@ -108,8 +120,9 @@ uws lcd info --serial <usb-serial>
108
120
  uws lcd send-jpg --serial <usb-serial> --file assets/sample_lcd.jpg
109
121
  uws lcd keep-alive --serial <usb-serial> --interval 5
110
122
 
111
- # Fan hub operations
112
- uws fan set-fan --mac aa:bb:cc:dd:ee:ff --pwm 120
123
+ # Fan receiver operations
124
+ uws fan set-fan --mac aa:bb:cc:dd:ee:ff --pwm 120 # direct PWM control
125
+ uws fan pwm-sync --mode receiver --all # receiver mode receivers (sets PWM=6)
113
126
  uws fan bind --mac aa:bb:cc:dd:ee:ff
114
127
  uws fan unbind --mac aa:bb:cc:dd:ee:ff
115
128
  uws fan pwm-sync --all
@@ -125,8 +138,10 @@ uws fan pwm-sync --mac aa:bb:cc:dd:ee:ff --once
125
138
  - `uws lcd send-jpg --serial <usb-serial> --file <image.jpg>` – stream a JPEG asset.
126
139
  - `uws lcd keep-alive --serial <usb-serial> [--interval seconds]` – emit periodic handshakes to prevent the wireless panel from dimming.
127
140
  - `uws lcd control --serial <usb-serial> [--mode show-jpg|show-app-sync|lcd-test] [--jpg-index N] [--brightness 0-100] [--fps N] [--rotation 0|90|180|270] [--test-color R,G,B]` – send an `LCDControlSetting` payload.
128
- - `uws fan list` – fetch a snapshot of bound wireless devices via the RF receiver.
129
- - `uws fan set-fan --mac <aa:bb:..> --pwm <0-255>` – send a single shot PWM update to the matching wireless hub using the RF sender.
141
+ - `uws fan list` – fetch a snapshot of bound wireless receivers via the RF receiver.
142
+ - `uws fan list-masters` – enumerate master controllers and associated wireless receivers.
143
+ - `uws fan set-fan --mac <aa:bb:..> --pwm <0-255> [--sequence-index N]` – send a single shot PWM update to one receiver; `--all` broadcasts to every bound receiver.
144
+ - `uws fan pwm-sync --mac|--all [--mode controller|receiver] [--interval seconds] [--once] [--sequence-index N]` – synchronize receiver speeds. `controller` polls motherboard PWM and replays the value via RF (`--interval` / `--once` apply here); `receiver` sets PWM=6 so the receiver tracks the motherboard header directly (`--sequence-index` applies here).
130
145
  - `uws fan set-led --mac <aa:bb:..> --mode static|rainbow|frames|effect|random-effect` – apply wireless LED effects (**experimental**).
131
146
 
132
147
  ### `uws fan set-led` modes
@@ -150,13 +165,13 @@ uws fan pwm-sync --mac aa:bb:cc:dd:ee:ff --once
150
165
  ```
151
166
  uws fan set-led --mac aa:bb:cc:dd:ee:ff --mode random-effect --effect-brightness 200 --effect-direction 1
152
167
  ```
153
- - `uws fan pwm-sync --all|--mac [--once]` – mirror motherboard PWM output to bound hubs (looping by default, single iteration with `--once`).
168
+ - `uws fan pwm-sync --all|--mac [--mode controller|receiver] [--interval seconds] [--once] [--sequence-index N]` – default `receiver` mode writes PWM=6 so fans follow the motherboard; `controller` mode polls and replays PWM from the motherboard (supports `--interval`/`--once` for polling loops; `--sequence-index` applies to receiver broadcasts).
154
169
 
155
170
  ## Dependencies
156
171
 
157
172
  - `hidapi` (via `hid`) for TL LCD HID access.
158
173
  - `pyusb` for the RF sender/receiver WinUSB endpoints.
159
- - `pycryptodomex` for the DES-CBC transport used by the wireless LCD hub.
174
+ - `pycryptodomex` for the DES-CBC transport used by the wireless LCD receiver.
160
175
  - `Pillow` is optional for JPEG frame validation.
161
176
 
162
177
  Each command expects the TL LCD USB display (vendor 0x04FC or 0x1CBE) and the wireless transmitter/receiver pair (vendor 0x0416) to be attached when the command executes.
@@ -9,7 +9,7 @@ Uni Wireless Sync (UWS) CLI provides command-line utilities for managing Uni Fan
9
9
  ## Supported Hardware
10
10
 
11
11
  - UNI FAN TL wireless LCD panels
12
- - UNI FAN TL wireless fan hubs (non-LCD)
12
+ - UNI FAN TL wireless fans (non-LCD)
13
13
 
14
14
  Other Uni Fan series are currently not supported.
15
15
 
@@ -19,11 +19,23 @@ Other Uni Fan series are currently not supported.
19
19
  - Query LCD firmware and handshake data.
20
20
  - Send JPEG frames or apply control settings (mode, brightness, rotation) to the LCD.
21
21
  - Keep the wireless TL LCD awake by emitting periodic handshakes.
22
- - List wireless fan hubs with metadata (MAC, master MAC, channel, device type, fan speeds, PWM targets).
22
+ - List wireless fan receivers with metadata (MAC, master MAC, channel, device type, fan speeds, PWM targets).
23
+ - List detected master controller MAC addresses to simplify binding workflows.
23
24
  - Send one-shot PWM commands to TL wireless fans over the 2.4 GHz dongle.
24
- - Bind or unbind wireless hubs against the active master controller.
25
- - Toggle motherboard PWM sync mode for one hub or every bound hub.
26
- - Broadcast static RGB payloads to wireless hubs (experimental).
25
+ - Bind or unbind wireless receivers against the active master controller.
26
+ - Toggle motherboard PWM sync mode for one receiver or every bound receiver.
27
+ - Broadcast static RGB payloads to wireless receivers (experimental).
28
+
29
+ ### Fan wiring modes
30
+
31
+ - **USB + PWM header (controller mode):** leave the receiver's PWM lead unplugged; control every fan via `uws fan set-fan` (any PWM value 0-255). The reported `fan_pwm` reflects your last command.
32
+ - **USB-only (receiver mode, PWM lead connected to motherboard):** the CLI writes a PWM of 6 (e.g. `uws fan pwm-sync --mode receiver --all`) so the receiver keeps syncing to the motherboard header. Sending another `set-fan` value at any time overrides the sync immediately; writing 6 (or re-running the sync helper) hands control back to the motherboard.
33
+
34
+ ## FAQ
35
+
36
+ - **How do I mount the L-Wireless Controller (v1)?** The thicker dongle supports two options: (1) plug into a USB Type-A port—this wiring is equivalent to `pwm-sync` receiver mode; (2) plug the header into a 9-pin USB port on the motherboard—this matches `pwm-sync` controller mode, but 2.4 GHz signal strength drops because the dongle lives inside the chassis.
37
+ - **How do I mount the L-Wireless Controller (v2)?** The slimmer dongle only supports option (1): plug into a USB Type-A port (`pwm-sync` receiver mode).
38
+ - **What is the difference between L-Wireless Receiver (v1) and (v2)?** Receiver v1 exposes both USB and a 2-pin PWM lead only on the LCD bundle (USB powers the LCD, the 2-pin lead powers fans); non-LCD receiver v1 units ship with just the 2-pin power lead. Receiver v2 adds a dedicated 4-pin PWM header; plug it into the motherboard when you want it to mirror the motherboard duty cycle via `pwm-sync --mode receiver`, or leave it disconnected and the controller will keep driving fan PWM directly.
27
39
 
28
40
  ## Installation
29
41
 
@@ -51,8 +63,9 @@ uws lcd info --serial <usb-serial>
51
63
  uws lcd send-jpg --serial <usb-serial> --file assets/sample_lcd.jpg
52
64
  uws lcd keep-alive --serial <usb-serial> --interval 5
53
65
 
54
- # Fan hub operations
55
- uws fan set-fan --mac aa:bb:cc:dd:ee:ff --pwm 120
66
+ # Fan receiver operations
67
+ uws fan set-fan --mac aa:bb:cc:dd:ee:ff --pwm 120 # direct PWM control
68
+ uws fan pwm-sync --mode receiver --all # receiver mode receivers (sets PWM=6)
56
69
  uws fan bind --mac aa:bb:cc:dd:ee:ff
57
70
  uws fan unbind --mac aa:bb:cc:dd:ee:ff
58
71
  uws fan pwm-sync --all
@@ -68,8 +81,10 @@ uws fan pwm-sync --mac aa:bb:cc:dd:ee:ff --once
68
81
  - `uws lcd send-jpg --serial <usb-serial> --file <image.jpg>` – stream a JPEG asset.
69
82
  - `uws lcd keep-alive --serial <usb-serial> [--interval seconds]` – emit periodic handshakes to prevent the wireless panel from dimming.
70
83
  - `uws lcd control --serial <usb-serial> [--mode show-jpg|show-app-sync|lcd-test] [--jpg-index N] [--brightness 0-100] [--fps N] [--rotation 0|90|180|270] [--test-color R,G,B]` – send an `LCDControlSetting` payload.
71
- - `uws fan list` – fetch a snapshot of bound wireless devices via the RF receiver.
72
- - `uws fan set-fan --mac <aa:bb:..> --pwm <0-255>` – send a single shot PWM update to the matching wireless hub using the RF sender.
84
+ - `uws fan list` – fetch a snapshot of bound wireless receivers via the RF receiver.
85
+ - `uws fan list-masters` – enumerate master controllers and associated wireless receivers.
86
+ - `uws fan set-fan --mac <aa:bb:..> --pwm <0-255> [--sequence-index N]` – send a single shot PWM update to one receiver; `--all` broadcasts to every bound receiver.
87
+ - `uws fan pwm-sync --mac|--all [--mode controller|receiver] [--interval seconds] [--once] [--sequence-index N]` – synchronize receiver speeds. `controller` polls motherboard PWM and replays the value via RF (`--interval` / `--once` apply here); `receiver` sets PWM=6 so the receiver tracks the motherboard header directly (`--sequence-index` applies here).
73
88
  - `uws fan set-led --mac <aa:bb:..> --mode static|rainbow|frames|effect|random-effect` – apply wireless LED effects (**experimental**).
74
89
 
75
90
  ### `uws fan set-led` modes
@@ -93,13 +108,13 @@ uws fan pwm-sync --mac aa:bb:cc:dd:ee:ff --once
93
108
  ```
94
109
  uws fan set-led --mac aa:bb:cc:dd:ee:ff --mode random-effect --effect-brightness 200 --effect-direction 1
95
110
  ```
96
- - `uws fan pwm-sync --all|--mac [--once]` – mirror motherboard PWM output to bound hubs (looping by default, single iteration with `--once`).
111
+ - `uws fan pwm-sync --all|--mac [--mode controller|receiver] [--interval seconds] [--once] [--sequence-index N]` – default `receiver` mode writes PWM=6 so fans follow the motherboard; `controller` mode polls and replays PWM from the motherboard (supports `--interval`/`--once` for polling loops; `--sequence-index` applies to receiver broadcasts).
97
112
 
98
113
  ## Dependencies
99
114
 
100
115
  - `hidapi` (via `hid`) for TL LCD HID access.
101
116
  - `pyusb` for the RF sender/receiver WinUSB endpoints.
102
- - `pycryptodomex` for the DES-CBC transport used by the wireless LCD hub.
117
+ - `pycryptodomex` for the DES-CBC transport used by the wireless LCD receiver.
103
118
  - `Pillow` is optional for JPEG frame validation.
104
119
 
105
120
  Each command expects the TL LCD USB display (vendor 0x04FC or 0x1CBE) and the wireless transmitter/receiver pair (vendor 0x0416) to be attached when the command executes.
@@ -1,7 +1,7 @@
1
1
  [project]
2
2
  name = "uwscli"
3
- version = "0.3.0"
4
- description = "Uni-Wireless-Sync: wireless control toolkit for TL LCD fan hubs"
3
+ version = "0.4.0"
4
+ description = "Uni-Wireless-Sync: wireless control toolkit for TL fan receivers"
5
5
  readme = "README.md"
6
6
  requires-python = ">=3.10"
7
7
  license = {file = "LICENSE"}
@@ -38,8 +38,8 @@ dev = [
38
38
  images = ["Pillow>=10.0"]
39
39
 
40
40
  [project.urls]
41
- Homepage = "https://github.com/phstudy/tlv2-lcd"
42
- Issues = "https://github.com/phstudy/tlv2-lcd/issues"
41
+ Homepage = "https://github.com/phstudy/uni-wireless-sync"
42
+ Issues = "https://github.com/phstudy/uni-wireless-sync/issues"
43
43
 
44
44
  [project.scripts]
45
45
  uws = "uwscli.cli:main"
@@ -1,6 +1,6 @@
1
1
  """UWS CLI package."""
2
2
 
3
- __version__ = "0.3.0"
3
+ __version__ = "0.4.0"
4
4
 
5
5
  __all__ = [
6
6
  "cli",