alexei.dolgolyov
579553a850
HACS-compatible custom component split out from the main LedGrab repo. Creates light, switch, sensor, number, and select entities for each configured LedGrab device.
65 lines
2.2 KiB
Markdown
65 lines
2.2 KiB
Markdown
# LedGrab Home Assistant Integration
|
|
|
|
Custom Home Assistant integration for [LedGrab](https://git.dolgolyov-family.by/alexei.dolgolyov/ledgrab) — ambient lighting system that captures screen content and drives LED strips in real time.
|
|
|
|
Creates light, switch, sensor, number, and select entities for each configured device, allowing full control and automation from Home Assistant.
|
|
|
|
## Installation
|
|
|
|
### Option 1: HACS (recommended)
|
|
|
|
1. Install [HACS](https://hacs.xyz/docs/setup/download) if you have not already.
|
|
2. Open HACS in Home Assistant.
|
|
3. Click the three-dot menu, then **Custom repositories**.
|
|
4. Add URL: `https://git.dolgolyov-family.by/alexei.dolgolyov/ledgrab-haos-integration`
|
|
5. Set category to **Integration** and click **Add**.
|
|
6. Search for "LedGrab" in HACS and click **Download**.
|
|
7. Restart Home Assistant.
|
|
8. Go to **Settings > Devices & Services > Add Integration** and search for "LedGrab".
|
|
9. Enter your server URL (e.g., `http://192.168.1.100:8080`) and API key.
|
|
|
|
### Option 2: Manual
|
|
|
|
Copy the `custom_components/ledgrab/` folder from this repository into your Home Assistant `config/custom_components/` directory, then restart Home Assistant and add the integration as above.
|
|
|
|
## Automation Example
|
|
|
|
```yaml
|
|
automation:
|
|
- alias: "Start ambient lighting when TV turns on"
|
|
trigger:
|
|
- platform: state
|
|
entity_id: media_player.living_room_tv
|
|
to: "on"
|
|
action:
|
|
- service: switch.turn_on
|
|
target:
|
|
entity_id: switch.living_room_tv_processing
|
|
|
|
- alias: "Stop ambient lighting when TV turns off"
|
|
trigger:
|
|
- platform: state
|
|
entity_id: media_player.living_room_tv
|
|
to: "off"
|
|
action:
|
|
- service: switch.turn_off
|
|
target:
|
|
entity_id: switch.living_room_tv_processing
|
|
```
|
|
|
|
## Requirements
|
|
|
|
- Home Assistant 2023.1.0 or later
|
|
- A running [LedGrab](https://git.dolgolyov-family.by/alexei.dolgolyov/ledgrab) server accessible on your network
|
|
|
|
## Troubleshooting
|
|
|
|
1. Verify the component exists: check that `config/custom_components/ledgrab/` is present.
|
|
2. Clear the browser cache and hard-refresh the HA UI.
|
|
3. Restart Home Assistant.
|
|
4. Check logs at **Settings > System > Logs** and search for `ledgrab`.
|
|
|
|
## License
|
|
|
|
MIT
|