https://github.com/callmenoodles/ambeelight-cli
Cross-platform ambilight for Yeelight (CLI).
https://github.com/callmenoodles/ambeelight-cli
ambient-light ambilight iot yeelight
Last synced: 5 months ago
JSON representation
Cross-platform ambilight for Yeelight (CLI).
- Host: GitHub
- URL: https://github.com/callmenoodles/ambeelight-cli
- Owner: callmenoodles
- License: mit
- Created: 2021-12-06T11:07:41.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-06-04T03:46:46.000Z (about 4 years ago)
- Last Synced: 2023-03-05T14:40:07.933Z (over 3 years ago)
- Topics: ambient-light, ambilight, iot, yeelight
- Language: Rust
- Homepage:
- Size: 136 KB
- Stars: 5
- Watchers: 3
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Ambeelight
A cross-platform ambient lighting solution for Yeelight devices. The program will update Yeelight devices to display the color of your computer's display output creating an amazing atmosphere when watching videos or gaming.
> [!WARNING]
> The Yeelight I used to test is no in use anymore. For this reason I archived the project.
## Table of Contents
- [Platforms](Platforms)
- [Installation](Installation)
- [Build from source](Build-from-source)
- [Download binary](Download-binary)
- [Usage](Usage)
- [CLI](CLI)
- [IP](IP)
- [Host](Host)
- [Contribution](Contribution)
- [License](License)
## Platforms
- [x] Windows
- [x] Linux
- [ ] macOS ([captrs](https://crates.io/crates/captrs) doesn't support macOS)
## Installation
### Build from source
In order to build on *debian-based* distros, make sure you have the build dependency `libxrandr-dev` package installed.
```
sudo apt install -y libxrandr-dev
```
Clone the repo with and install the binary through cargo. The binary will be installed at `~/.cargo/bin` and can be unsinstalled with `cargo uninstall`
```
git clone git@github.com:callmenoodles/ambeelight.git
cargo install --path .
```
### Download Binary
Download and install the binary for your platform from [Releases.](https://github.com/callmenoodles/ambeelight/releases)
## Usage
### CLI
```
USAGE:
ambeelight [OPTIONS] --ip --host
OPTIONS:
-b, --brightness Yeelight brightness between 1-100
-h, --help Print help information
--host IP address of the host [env: AMBEELIGHT_HOST_IP=]
-i, --interval Time between screen reads in milliseconds [default: 250]
--ip IP address of the Yeelight [env: AMBEELIGHT_YEELIGHT_IP=]
-t, --transition Transition duration in milliseconds [default: 250]
-V, --version Print version information
```
### IP
Find your Yeelight's IP address in the Yeelight app under -> Settings -> Device Info
### Host
Usually your local network IP address.
## Contribution
Feel free to contribute by sending pull requests, opening issues for bugs or feature requests or by fixing issues.
## License
[MIT](LICENSE)