Compare commits
6 Commits
Author | SHA1 | Date |
---|---|---|
DrMaxNix | 6c22bf0441 | |
DrMaxNix | 1e331ec053 | |
DrMaxNix | bca1d759a0 | |
DrMaxNix | a9b8da7129 | |
DrMaxNix | 78b8294f30 | |
DrMaxNix | 15126ae211 |
34
README.md
34
README.md
|
@ -1,4 +1,8 @@
|
|||
# olaDMXctl
|
||||
[![Release](https://img.shields.io/badge/release-v1.0.2-orange)](https://git.tjdev.de/DrMaxNix/oladmxctl/releases/tag/v1.0.2)
|
||||
[![License](https://img.shields.io/badge/license-MIT-green)](https://git.tjdev.de/DrMaxNix/oladmxctl/src/branch/main/LICENSE)
|
||||
[![Maintaner](https://img.shields.io/badge/maintainer-DrMaxNix-blue)](https://www.drmaxnix.de)
|
||||
|
||||
Command-line tool for controlling individual dmx channels with olad
|
||||
|
||||
|
||||
|
@ -9,29 +13,29 @@ Command-line tool for controlling individual dmx channels with olad
|
|||
### php and curl
|
||||
This tool is coded in php and uses curl for http-requests so you need to have that installed
|
||||
|
||||
```bash
|
||||
sudo apt update
|
||||
sudo apt install php curl
|
||||
```console
|
||||
# apt update
|
||||
# apt install php curl
|
||||
```
|
||||
|
||||
|
||||
### download
|
||||
Download the script from github
|
||||
```bash
|
||||
wget https://github.com/DrMaxNix/oladmxctl/releases/download/1.0.1/oladmxctl
|
||||
Download the script from git.tjdev.de
|
||||
```console
|
||||
$ wget -O oladmxctl https://git.tjdev.de/attachments/fc075f16-2923-4856-a4bf-621c5162bee4
|
||||
```
|
||||
|
||||
Make it executable
|
||||
```bash
|
||||
chmod +x oladmxctl
|
||||
```console
|
||||
$ 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.
|
||||
|
||||
```bash
|
||||
sudo mv oladmxctl /usr/bin
|
||||
```console
|
||||
# mv oladmxctl /usr/local/bin
|
||||
```
|
||||
|
||||
|
||||
|
@ -52,7 +56,7 @@ oladmxctl --universe <universe> [--write <json>] [--read <json>]
|
|||
|
||||
-1 --ch-offset First channel has number 1
|
||||
|
||||
-a --address Address of the olad instance (default 127.0.01)
|
||||
-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
|
||||
|
||||
|
@ -66,14 +70,14 @@ oladmxctl --universe <universe> [--write <json>] [--read <json>]
|
|||
|
||||
## examples
|
||||
### Set channel 13 and 14 to 255 in universe 1
|
||||
```bash
|
||||
oladmxctl --universe 1 --write '{"13":255, "14":255}'
|
||||
```console
|
||||
$ oladmxctl --universe 1 --write '{"13":255, "14":255}'
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Read channels 13 and 14 in universe 1
|
||||
```bash
|
||||
oladmxctl --universe 1 --read '[13, 14]'
|
||||
```console
|
||||
$ oladmxctl --universe 1 --read '[13, 14]'
|
||||
```
|
||||
Returns `{"13":255, "14":255}`
|
||||
|
|
|
@ -38,7 +38,7 @@
|
|||
|
||||
-1 --ch-offset First channel has number 1
|
||||
|
||||
-a --address Address of the olad instance (default 127.0.01)
|
||||
-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
|
||||
|
||||
|
@ -53,7 +53,7 @@ Examples:
|
|||
$ oladmxctl --universe 1 --read '[13, 14]'
|
||||
Returns {\"13\":255, \"14\":255}";
|
||||
|
||||
$conf["version_msg"] = "oladmxctl v1.0.1 | (c) DrMaxNix 2021 | www.drmaxnix.de/oladmxctl";
|
||||
$conf["version_msg"] = "oladmxctl v1.0.2 | (c) DrMaxNix 2021 | www.drmaxnix.de/oladmxctl";
|
||||
|
||||
|
||||
// COLLECT ARGS //
|
||||
|
|
Loading…
Reference in New Issue