clean readme

This commit is contained in:
zi 2024-08-07 18:25:40 +05:30
parent 5b5ae65ca8
commit ca58a0e31b

View File

@ -1,41 +1,50 @@
Play LED light sequences from csv. Control LED lights using PyDMXControl Play LED light sequences from csv. Control LED lights using PyDMXControl
Install... Install:
https://github.com/MattIPv4/PyDMXControl/tree/master https://github.com/MattIPv4/PyDMXControl/tree/master
Calc fields / Variables: Calc fields / Variables:
# seq -> "sequence" = position (seconds) on 'timeline' starting 0 - seq -> "sequence" = position (seconds) on 'timeline' starting 0
# fadein / fadeout (milliseconds) [optional/default] - fadein / fadeout (milliseconds) [optional/default]
# duration (seconds) - duration (seconds)
# brightness -> 0-255 (optional, else default) [optional/default] - brightness -> 0-255 (optional, else default) [optional/default]
# "channel" --> LED/channel identifier, order as connected to DMX decoder - "channel" --> LED/channel identifier, order as connected to DMX decoder
(channel = name | opendmxcontroller calls fixtures "by_name") (channel = name | opendmxcontroller calls fixtures "by_name")
- channels are sequential and fixed - channels are sequential and fixed
- blank channels also must be added to dmx..() - blank channels also must be added to dmx..()
## Map channels: - Map channels (play one at a time, wait for input):
(play one at a time, wait for input) ```
$ python3 mapchannels.py $ python3 mapchannels.py
```
# run sequence: - run sequence:
- $ python3 sequence.py ```
$ python3 sequence.py
```
# run sequence from START cell (not from t=0): - run sequence from START cell (not from t=0):
- $ python3 zztest_sequence.py ```
$ python3 zztest_sequence.py
```
## debug: - debug:
(play single channel only and exit) - (play single channel only and exit)
$ python3 playsingle.py <channel/name> ```
$ python3 playsingle.py <channel/name>
```
_____ _____
*** EDIT ("seq", "duration", optional "brightness") and play sequence: *** EDIT ("seq", "duration", optional "brightness") and play sequence:
- edit local or online calc/csv - edit local or online calc/csv
# get csv -> sequence.json - get csv -> sequence.json
- $ python3 getspread.py ```
$ python3 getspread.py
```
- restart service - restart service
@ -43,26 +52,29 @@ _____
_____ _____
# check script output: - check script output:
$ tmux a ```
or
$ tmux a -t light $ tmux a -t light
```
--- ---
lights.service runs sequence.py in a tmux session called "light" lights.service runs sequence.py in a tmux session called "light"
(Run outside tmux) (Run outside tmux)
[ start/stop/restart service now ]
# start/stop/restart service now ```
sudo systemctl <start/stop/restart> lights.service sudo systemctl <start/stop/restart> lights.service
```
# enable/disable service on boot enable/disable service on boot
```
sudo systemctl <enable/disable> lights.service sudo systemctl <enable/disable> lights.service
```
# check status check status
```
systemctl status lights.service systemctl status lights.service
```
--- ---
*dev* service script: *dev* service script: