Command-line tool for controlling individual dmx channels with olad
Go to file
DrMaxNix 6c22bf0441 📝 migrate to git.tjdev.de 2023-03-22 21:09:54 +01:00
LICENSE Initial commit 2021-09-09 22:15:51 +02:00
README.md 📝 migrate to git.tjdev.de 2023-03-22 21:09:54 +01:00
oladmxctl 🔖 bump version to v1.0.2 2021-09-10 12:05:37 +02:00

README.md

olaDMXctl

Release License Maintaner

Command-line tool for controlling individual dmx channels with olad

installation

php and curl

This tool is coded in php and uses curl for http-requests so you need to have that installed

# apt update
# apt install php curl

download

Download the script from git.tjdev.de

$ wget -O oladmxctl https://git.tjdev.de/attachments/fc075f16-2923-4856-a4bf-621c5162bee4

Make it executable

$ chmod +x oladmxctl

move into /usr/bin (optional)

You can skip this step. This will only make it so you can call the script from everywhere using oladmxctl. If you skip this step you will have to use ./oladmxctl or /path/to/oladmxctl to run the script.

# mv oladmxctl /usr/local/bin

usage

oladmxctl --universe <universe> [--write <json>] [--read <json>]

-s --silent           No error/warning/info output

-u --universe         Universe number to control
-w --write            JSON-encoded string with channel-value pairs to write
-r --read             JSON-encoded string with channels to read from and output
                      to stdout as JSON-encoded string with channel-value pairs
-f --force-rewrite    Force write request to olad even if no data has changed

-1 --ch-offset        First channel has number 1

-a --address          Address of the olad instance (default 127.0.0.1)
-p --port             Port of the olad instance (default 9090)
-3 --ssl              Use https instead of http

-h --help             Show this help and exit
-v --version          Print version and exit

examples

Set channel 13 and 14 to 255 in universe 1

$ oladmxctl --universe 1 --write '{"13":255, "14":255}'

Read channels 13 and 14 in universe 1

$ oladmxctl --universe 1 --read '[13, 14]'

Returns {"13":255, "14":255}