# Ray CLI
Command line utility for generating and broadcast DMX over sACN.
[![GitHub Release](https://img.shields.io/github/v/release/nobbmaestro/ray-cli)](github-release)
[![GitHub last commit](https://img.shields.io/github/last-commit/nobbmaestro/ray-cli/development)](github-last-commit)
[![GitHub commits since](https://img.shields.io/github/commits-since/nobbmaestro/ray-cli/v0.2.1/development)](githut-commits-since)
![Tests](https://github.com/nobbmaestro/ray-cli/actions/workflows/tests.yml/badge.svg)
## Installation
### Pip
```sh
pip install ray-cli
```
### GitHub
```sh
git clone git@github.com:nobbmaestro/ray-cli.git
cd ray-cli
make install
```
## Usage
```console
$ ray-cli --help
usage: ray-cli [-m {chase,ramp,ramp-down,ramp-up,sine,square,static}] [-d DURATION]
[-u UNIVERSES [UNIVERSES ...]] [-c CHANNELS] [-i INTENSITY]
[-f FREQUENCY] [--fps FPS] [--dst DST] [-v] [-q] [--dry] [-h]
[--version] IP_ADDRESS
Command line utility for generating and broadcast DMX over sACN.
positional arguments:
IP_ADDRESS ip address of the dmx source
optional arguments:
-m {chase,ramp,ramp-down,ramp-up,sine,square,static},
--mode {chase,ramp,ramp-down,ramp-up,sine,square,static}
broadcast mode, defaults to ramp
-d DURATION, --duration DURATION
broadcast duration in seconds, defaults to INDEFINITE
-u UNIVERSES [UNIVERSES ...], --universes UNIVERSES [UNIVERSES ...]
sACN universe(s) to send to
-c CHANNELS, --channels CHANNELS
DMX channels at universe to send to, (1, ...512)
-i INTENSITY, --intensity INTENSITY
DMX channels output intensity, (1, ...255)
-f FREQUENCY, --frequency FREQUENCY
signal frequency
--fps FPS frames per second per universe
--dst DST ip address of the dmx destination, defaults to MULTICAST
display options:
-v, --verbose run in verbose mode
-q, --quiet run in quiet mode
operational options:
--dry simulate outputs without broadcasting (dry run mode), assumes
verbose mode
query options:
-h, --help print help and exit
--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/ba/9d/0d2b6a9d4274634799c152358af346cc334bac9736668de5aafccf5b1eb9/ray_cli-0.2.1.tar.gz",
"platform": null,
"description": "# Ray CLI\n\nCommand line utility for generating and broadcast DMX over sACN.\n\n[![GitHub Release](https://img.shields.io/github/v/release/nobbmaestro/ray-cli)](github-release)\n[![GitHub last commit](https://img.shields.io/github/last-commit/nobbmaestro/ray-cli/development)](github-last-commit)\n[![GitHub commits since](https://img.shields.io/github/commits-since/nobbmaestro/ray-cli/v0.2.1/development)](githut-commits-since)\n![Tests](https://github.com/nobbmaestro/ray-cli/actions/workflows/tests.yml/badge.svg)\n\n## Installation\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```console\n$ ray-cli --help\nusage: ray-cli [-m {chase,ramp,ramp-down,ramp-up,sine,square,static}] [-d DURATION]\n [-u UNIVERSES [UNIVERSES ...]] [-c CHANNELS] [-i INTENSITY]\n [-f FREQUENCY] [--fps FPS] [--dst DST] [-v] [-q] [--dry] [-h]\n [--version] IP_ADDRESS\n\nCommand line utility for generating and broadcast DMX over sACN.\n\npositional arguments:\n IP_ADDRESS ip address of the dmx source\n\noptional arguments:\n -m {chase,ramp,ramp-down,ramp-up,sine,square,static},\n --mode {chase,ramp,ramp-down,ramp-up,sine,square,static}\n broadcast mode, defaults to ramp\n -d DURATION, --duration DURATION\n broadcast duration in seconds, defaults to INDEFINITE\n -u UNIVERSES [UNIVERSES ...], --universes UNIVERSES [UNIVERSES ...]\n sACN universe(s) to send to\n -c CHANNELS, --channels CHANNELS\n DMX channels at universe to send to, (1, ...512)\n -i INTENSITY, --intensity INTENSITY\n DMX channels output intensity, (1, ...255)\n -f FREQUENCY, --frequency FREQUENCY\n signal frequency\n --fps FPS frames per second per universe\n --dst DST ip address of the dmx destination, defaults to 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 broadcasting (dry run mode), assumes\n verbose mode\n\nquery options:\n -h, --help print help and exit\n --version show program's version number and exit\n\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Command line utility for generating and broadcast DMX over sACN",
"version": "0.2.1",
"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": "2c4aad032e7907549cf6c5ea0f312348f6fbaee7bb23cae9da04ab56aafb6ff3",
"md5": "df1e1f2f5fd658a68b0f74b382b29e8a",
"sha256": "2815ba7a6ca4c26804a29fc893b158b66d073bb28eeb209243e9d29db65a83b2"
},
"downloads": -1,
"filename": "ray_cli-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "df1e1f2f5fd658a68b0f74b382b29e8a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 11431,
"upload_time": "2024-08-09T07:22:58",
"upload_time_iso_8601": "2024-08-09T07:22:58.812762Z",
"url": "https://files.pythonhosted.org/packages/2c/4a/ad032e7907549cf6c5ea0f312348f6fbaee7bb23cae9da04ab56aafb6ff3/ray_cli-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ba9d0d2b6a9d4274634799c152358af346cc334bac9736668de5aafccf5b1eb9",
"md5": "6ab4576a3153ea0fef1653831726f5aa",
"sha256": "43dff44895ef3602204fa67606c0d43a3ab9f8444ecbc1326f83ba320461850d"
},
"downloads": -1,
"filename": "ray_cli-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "6ab4576a3153ea0fef1653831726f5aa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 8632,
"upload_time": "2024-08-09T07:23:00",
"upload_time_iso_8601": "2024-08-09T07:23:00.221593Z",
"url": "https://files.pythonhosted.org/packages/ba/9d/0d2b6a9d4274634799c152358af346cc334bac9736668de5aafccf5b1eb9/ray_cli-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-09 07:23:00",
"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"
}