{"id":21384620,"url":"https://github.com/zzampax/elgato-control-center-api","last_synced_at":"2025-06-25T02:03:12.455Z","repository":{"id":264148553,"uuid":"875401242","full_name":"zzampax/elgato-control-center-api","owner":"zzampax","description":"Lightweight API written in RUST that enables interaction with Elgato devices such as Elgato Light Strips or Elgato Keylights. It provides a baseline interface that can be invoked by other scripts.","archived":false,"fork":false,"pushed_at":"2024-11-22T09:05:42.000Z","size":24,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-16T11:42:12.558Z","etag":null,"topics":["api","clap-rs","cli-api","elgato","elgato-key-light","elgato-light-strip","rust","rust-api"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zzampax.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-19T21:53:14.000Z","updated_at":"2025-01-13T15:10:02.000Z","dependencies_parsed_at":"2024-11-22T09:40:48.337Z","dependency_job_id":null,"html_url":"https://github.com/zzampax/elgato-control-center-api","commit_stats":null,"previous_names":["zzampax/elgato-control-center-api"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/zzampax/elgato-control-center-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zzampax%2Felgato-control-center-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zzampax%2Felgato-control-center-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zzampax%2Felgato-control-center-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zzampax%2Felgato-control-center-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zzampax","download_url":"https://codeload.github.com/zzampax/elgato-control-center-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zzampax%2Felgato-control-center-api/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261789229,"owners_count":23209774,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","clap-rs","cli-api","elgato","elgato-key-light","elgato-light-strip","rust","rust-api"],"created_at":"2024-11-22T11:42:15.945Z","updated_at":"2025-06-25T02:03:12.434Z","avatar_url":"https://github.com/zzampax.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Elgato-Control-Center-API\n\n\u003cbr\u003e\n\u003cdiv align=\"center\"\u003e\n\n![Language](https://img.shields.io/github/languages/top/zzampax/ecc-api.svg?style=for-the-badge\u0026labelColor=black\u0026logo=rust\u0026logoColor=red\u0026label=Rust)\n![Linux](https://img.shields.io/badge/Linux-FCC624?style=for-the-badge\u0026logo=linux\u0026logoColor=black)\n![Github](https://img.shields.io/badge/GitHub-000000?style=for-the-badge\u0026logo=github\u0026logoColor=white)\n![WAM](https://img.shields.io/badge/APIs-RULE%20THE%20WORLD-CD3713?style=for-the-badge\u0026labelColor=black)\n\n\u003cimg src=\"https://rust-book.cs.brown.edu/img/ferris/does_not_compile.svg\" alt=\"ECC\" height=\"300px\"\u003e\n\u003c/div\u003e\n\u003cbr\u003e\n\nThis project is a lightweight API written in RUST that enables interaction with Elgato devices such as [Elgato LightStrips](https://www.elgato.com/us/en/p/light-strip-pro) or [Elgato KeyLights](https://www.elgato.com/us/en/p/key-light).\n## Inspiration\nThis script is heavly inspired by the [Elgato-Control-Center](https://github.com/DanielHe4rt/elgato-control-center.git) project, also written in Rust, this although aims at providing a straightforward CLI API free of any GUI.\n## Usage\nThe script provides arguments description via `ecc-api --help`:\n```bash\nElgato Control CLI\n\nUsage: ecc-api [OPTIONS]\n\nOptions:\n      --ip \u003cip\u003e                    Elgato KeyLight/LightStrip IP address\n  -p, --port \u003cport\u003e                Elgato KeyLight/LightStrip port\n  -c, --config \u003cconfig\u003e            Config file providing ip and port, default path ~/.config/elgato-control-center/config.toml\n      --toggle                     Turn on/off the Elgato KeyLight/LightStrip\n      --hue \u003chue\u003e                  Set the hue of the Elgato LightStrip\n      --saturation \u003csaturation\u003e    Set the saturation of the Elgato LightStrip\n      --temperature \u003ctemperature\u003e  Set the temperature of the Elgato KeyLight\n      --brightness \u003cbrightness\u003e    Set the brightness of the Elgato KeyLight/LightStrip\n  -h, --help                       Print help\n  -V, --version                    Print version\n```\n\u003e Tip\n\u003e Pipe the output of `ecc-api` using `jq` for prettier syntax:\n\u003e ```bash\n\u003e ecc-api | jq\n\u003e ```\n### Config File\nThe IP and Port of the device can be provided using a `config.toml` file using the following format:\n```toml\n[device]\nip = \"192.168.X.X\"\nport = 9123 # Default Elgato port\n```\nThe default path is `~/.config/elgato-control-center`, the user can manually pass the path with the `-c/--config` flag\n```bash\necc-api -c path/to/config.toml\n```\nOr avoid using the `config.toml` file at all:\n```bash\necc-api --ip 192.168.X.X -p 9123\n```\n## Payload Examples\nThe whole comunication is via HTTP using JSON.\n### Elgato LightStrip\n```json\n{\n  \"numberOfLights\": 1,\n  \"lights\": [\n    {\n      \"on\": 1,\n      \"hue\": 332.000000,\n      \"saturation\": 81.000000,\n      \"brightness\": 99\n    }\n  ]\n}\n```\n### Elgato Keylight\n```json\n{\n  \"numberOfLights\": 1,\n  \"lights\": [\n    {\n      \"on\": 1,\n      \"brightness\": 12,\n      \"temperature\": 143\n    }\n  ]\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzzampax%2Felgato-control-center-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzzampax%2Felgato-control-center-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzzampax%2Felgato-control-center-api/lists"}