# Ray CLI
[](github-release)
[](github-last-commit)
[](githut-commits-since)
Ray CLI is a command-line utility designed for generating and broadcasting DMX data over sACN.
## Installation
### Prerequisites
- Python 3.7+ is required.
- **_Optional_** For Pipx, ensure it is installed by running `pip install pipx`
### Pipx (Recommended)
```sh
pipx install ray-cli
```
### Pip
```sh
pip install ray-cli
```
### GitHub
```sh
git clone git@github.com:nobbmaestro/ray-cli.git
cd ray-cli
make install
```
## Usage
### Basic Example
To broadcast a ramp DMX signal to a specific IP address:
```sh
ray-cli 192.168.86.198 \
--dst 192.168.86.67 \
--mode chase \
--universes 1 2 \
--channels 24 \
--fps 50 \
--duration 60
```
### Complete List of Command-Line Options
```sh
usage: ray-cli [-m {chase,ramp,ramp-down,ramp-up,sine,square,static}] [-d DURATION]
[-u UNIVERSES [UNIVERSES ...]] [-c CHANNELS] [-i INTENSITY]
[-I INTENSITY_MIN] [-f FREQUENCY] [--fps FPS] [--dst DST] [-v] [-q]
[--dry] [--purge] [-h] [-V]
[IP_ADDRESS]
Command-line utility for generating and broadcasting DMX over sACN
positional arguments:
IP_ADDRESS IP address of the DMX source (default:
192.168.86.204)
optional arguments:
-m, --mode {chase,ramp,ramp-down,ramp-up,sine,square,static}
DMX signal shape mode (default: ramp)
-d, --duration DURATION broadcast duration in seconds (default:
INDEFINITE)
-u, --universes UNIVERSES [UNIVERSES ...] sACN universe(s) to send to (range:
1-63999, default: 1)
-c, --channels CHANNELS DMX channels at universe to send to (range:
1-512, default: 24)
-i, --intensity INTENSITY DMX channels output intensity (range:
1-255, default: 10)
-I, --intensity-min INTENSITY_MIN DMX channels minimum output intensity
(range: 0-255, default: 0)
-f, --frequency FREQUENCY frequency of the generated signal (default:
1.0)
--fps FPS frames per second per universe (default:
10)
--dst DST IP address of the dmx destination (default:
MULTICAST)
display options:
-v, --verbose run in verbose mode
-q, --quiet run in quiet mode
operational options:
--dry simulate outputs without broadcast
--purge send zero-data on all channels and exit
query options:
-h, --help print help and exit
-V, --version show program's version number and exit
```
Raw data
{
"_id": null,
"home_page": "https://github.com/nobbmaestro/ray-cli",
"name": "ray-cli",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "dmx, sacn, cli, utility, python",
"author": "Norbert Batiuk",
"author_email": "norbert@batiuk.se",
"download_url": "https://files.pythonhosted.org/packages/4c/5a/64bc711e6653370620981812a8834326c559524685d02bad14dee1bb4951/ray_cli-0.4.3.tar.gz",
"platform": null,
"description": "# Ray CLI\n\n[](github-release)\n[](github-last-commit)\n[](githut-commits-since)\n\n\n\nRay CLI is a command-line utility designed for generating and broadcasting DMX data over sACN.\n\n## Installation\n\n### Prerequisites\n\n- Python 3.7+ is required.\n- **_Optional_** For Pipx, ensure it is installed by running `pip install pipx`\n\n### Pipx (Recommended)\n\n```sh\npipx install ray-cli\n```\n\n### Pip\n\n```sh\npip install ray-cli\n```\n\n### GitHub\n\n```sh\ngit clone git@github.com:nobbmaestro/ray-cli.git\ncd ray-cli\nmake install\n```\n\n## Usage\n\n### Basic Example\n\nTo broadcast a ramp DMX signal to a specific IP address:\n\n```sh\nray-cli 192.168.86.198 \\\n --dst 192.168.86.67 \\\n --mode chase \\\n --universes 1 2 \\\n --channels 24 \\\n --fps 50 \\\n --duration 60\n```\n\n### Complete List of Command-Line Options\n\n```sh\nusage: ray-cli [-m {chase,ramp,ramp-down,ramp-up,sine,square,static}] [-d DURATION]\n [-u UNIVERSES [UNIVERSES ...]] [-c CHANNELS] [-i INTENSITY]\n [-I INTENSITY_MIN] [-f FREQUENCY] [--fps FPS] [--dst DST] [-v] [-q]\n [--dry] [--purge] [-h] [-V]\n [IP_ADDRESS]\n\nCommand-line utility for generating and broadcasting DMX over sACN\n\npositional arguments:\n IP_ADDRESS IP address of the DMX source (default:\n 192.168.86.204)\n\noptional arguments:\n -m, --mode {chase,ramp,ramp-down,ramp-up,sine,square,static}\n DMX signal shape mode (default: ramp)\n -d, --duration DURATION broadcast duration in seconds (default:\n INDEFINITE)\n -u, --universes UNIVERSES [UNIVERSES ...] sACN universe(s) to send to (range:\n 1-63999, default: 1)\n -c, --channels CHANNELS DMX channels at universe to send to (range:\n 1-512, default: 24)\n -i, --intensity INTENSITY DMX channels output intensity (range:\n 1-255, default: 10)\n -I, --intensity-min INTENSITY_MIN DMX channels minimum output intensity\n (range: 0-255, default: 0)\n -f, --frequency FREQUENCY frequency of the generated signal (default:\n 1.0)\n --fps FPS frames per second per universe (default:\n 10)\n --dst DST IP address of the dmx destination (default:\n MULTICAST)\n\ndisplay options:\n -v, --verbose run in verbose mode\n -q, --quiet run in quiet mode\n\noperational options:\n --dry simulate outputs without broadcast\n --purge send zero-data on all channels and exit\n\nquery options:\n -h, --help print help and exit\n -V, --version show program's version number and exit\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Command-line utility for generating and broadcasting DMX over sACN",
"version": "0.4.3",
"project_urls": {
"Homepage": "https://github.com/nobbmaestro/ray-cli",
"Repository": "https://github.com/nobbmaestro/ray-cli"
},
"split_keywords": [
"dmx",
" sacn",
" cli",
" utility",
" python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f699792d435593ff67529ec5baf78df9fbb6ef0c065ef125f5fa7c2976967df7",
"md5": "37067003a185a75ff0bbc1599f87db60",
"sha256": "b8525daec8e91f533854575fd27fc752b07f93f0a9c0f4b21f37c78afb15d1a2"
},
"downloads": -1,
"filename": "ray_cli-0.4.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "37067003a185a75ff0bbc1599f87db60",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 13107,
"upload_time": "2025-02-11T21:05:33",
"upload_time_iso_8601": "2025-02-11T21:05:33.718092Z",
"url": "https://files.pythonhosted.org/packages/f6/99/792d435593ff67529ec5baf78df9fbb6ef0c065ef125f5fa7c2976967df7/ray_cli-0.4.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4c5a64bc711e6653370620981812a8834326c559524685d02bad14dee1bb4951",
"md5": "13303cd53ec13f10c55840aeaf7c7729",
"sha256": "50fdb2accaa9ad6ae959989150d71a76d29833d0ecf0887c980e084cf5ebfd6e"
},
"downloads": -1,
"filename": "ray_cli-0.4.3.tar.gz",
"has_sig": false,
"md5_digest": "13303cd53ec13f10c55840aeaf7c7729",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 10394,
"upload_time": "2025-02-11T21:05:35",
"upload_time_iso_8601": "2025-02-11T21:05:35.516196Z",
"url": "https://files.pythonhosted.org/packages/4c/5a/64bc711e6653370620981812a8834326c559524685d02bad14dee1bb4951/ray_cli-0.4.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-11 21:05:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nobbmaestro",
"github_project": "ray-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "ray-cli"
}
JSON
