12
12
![ Monthly Downloads] [ monthly-downloads ]
13
13
<br >
14
14
15
- [ BusyLight for Humans] [ busylight-for-humans ] controls USB LED lights from multiple vendors.
16
- Use the command-line interface or HTTP API to turn lights on/off, change colors, and apply effects.
17
- For Python integration, use [ Busylight Core] [ busylight-core ] directly in your applications.
15
+ [ BusyLight for Humans] [ busylight-for-humans ] controls USB LED lights from
16
+ multiple vendors. Use the command-line interface or HTTP API to turn lights
17
+ on/off, change colors, and apply effects. For Python integration, use
18
+ [ Busylight Core] [ busylight-core ] directly in your applications.
18
19
19
20
![ All Supported Lights] [ DEMO ]
20
21
Flag<sup >1</sup >,
@@ -85,7 +86,8 @@ python3 -m pip install busylight-for-humans[webapi]
85
86
86
87
## Development Install
87
88
88
- This project uses [ uv] [ uv-docs ] for dependency management, virtual environments, and packaging.
89
+ This project uses [ uv] [ uv-docs ] for dependency management, virtual
90
+ environments, and packaging.
89
91
90
92
``` console
91
93
$ python3 -m pip install uv
@@ -97,7 +99,8 @@ $ source .venv/bin/activate
97
99
<venv> $ pytest
98
100
```
99
101
100
- The project installs in editable mode. Source changes are reflected immediately when running in the virtual environment.
102
+ The project installs in editable mode. Source changes are reflected
103
+ immediately when running in the virtual environment.
101
104
102
105
## Linux Post-Install Activities
103
106
@@ -139,7 +142,8 @@ $ busylight off # turn off all LEDs (default)
139
142
140
143
## HTTP API Examples
141
144
142
- First start the ` busylight ` API server using the ` busyserv ` command line interface:
145
+ First start the ` busylight ` API server using the ` busyserv ` command line
146
+ interface:
143
147
``` console
144
148
$ busyserve -D
145
149
INFO: Started server process [40064]
@@ -215,14 +219,16 @@ $ curl -s "http://localhost:8000/light/0/blink?color=blue&led=2&count=5" | jq
215
219
216
220
## LED Parameter Reference
217
221
218
- For devices with multiple LEDs (like Blink1 mk2), use the ` --led ` option (CLI) or ` led ` parameter (API):
222
+ For devices with multiple LEDs (like Blink1 mk2), use the ` --led ` option
223
+ (CLI) or ` led ` parameter (API):
219
224
220
225
- ` led=0 ` : Control all LEDs (default behavior)
221
226
- ` led=1 ` : Control first/top LED
222
227
- ` led=2 ` : Control second/bottom LED
223
228
- ` led=3+ ` : Control additional LEDs (BlinkStick variants)
224
229
225
- Single-LED devices ignore the LED parameter. Device-specific LED indexing varies by manufacturer.
230
+ Single-LED devices ignore the LED parameter. Device-specific LED indexing
231
+ varies by manufacturer.
226
232
227
233
### Authentication
228
234
The API can be secured with a simple username and password through
@@ -231,7 +237,9 @@ for all API requests, set the `BUSYLIGHT_API_USER` and
231
237
` BUSYLIGHT_API_PASS ` environmental variables before running
232
238
` busyserve ` .
233
239
234
- > :warning : ** SECURITY WARNING** : HTTP Basic Auth sends usernames and passwords in * cleartext* (i.e., unencrypted). Use of SSL is highly recommended!
240
+ > :warning : ** SECURITY WARNING** : HTTP Basic Auth sends usernames and
241
+ > passwords in * cleartext* (i.e., unencrypted). Use of SSL is highly
242
+ > recommended!
235
243
236
244
### Gratitude
237
245
0 commit comments