https://github.com/yeonv/ledfxrm
Custom Integration for Home Assistant to control a any (local/remote) LedFX-server - State: beta
https://github.com/yeonv/ledfxrm
config-flow custom-component hacs hass homeassistant homeassistant-integration ledfx
Last synced: about 1 month ago
JSON representation
Custom Integration for Home Assistant to control a any (local/remote) LedFX-server - State: beta
- Host: GitHub
- URL: https://github.com/yeonv/ledfxrm
- Owner: YeonV
- License: mit
- Created: 2020-11-04T20:45:02.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-08-09T07:55:58.000Z (almost 4 years ago)
- Last Synced: 2025-04-17T12:31:16.724Z (about 2 months ago)
- Topics: config-flow, custom-component, hacs, hass, homeassistant, homeassistant-integration, ledfx
- Language: Python
- Homepage:
- Size: 499 KB
- Stars: 32
- Watchers: 3
- Forks: 6
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DEPRECATED!
I joined main LedFx development. The core changed too much and this integration is not compatible anymore...
Don't worry, a LedFx-Integration is coming to auto-detect & configure LedFx inside Home-Asssistant via MQTT.
(nothing else than MQTT is required on HomeAssistant-Side)
# LedFx ReMote for Home Assistant
[](https://github.com/custom-components/hacs) [](https://github.com/custom-components/hacs)   [](https://github.com/YeonV/ledfxrm/blob/main/LICENSE) [](https://github.com/YeonV) [](https://github.com/YeonV)
---
[Custom Integration](https://github.com/hacs/integration) for [Home Assistant](https://github.com/home-assistant) to control any (local/remote) [LedFx-server](https://github.com/LedFx/LedFx)
---
## Main Features
### LedFx Remote
- Select your LedFx scene from inside Home Assistant!
- Display the number of scenes/devices/pixels connected to LedFx
- Start and stop the LedFx server (custom Endpoint required!)
### LedFx Device Remote
- Toggle the power for devices configured in LedFx
- Display number of pixels per device
- Display IP per device
- Display current running effect-name
| Default | With Devices |
|:-------:|:------------:|
|  |  |
## Requirements:
- [LedFx](https://github.com/LedFx/LedFx/tree/dev)
- minimum version: v0.9.0 (so atm you need the dev-branch)
- with at least one scene setup
- the ledfx config.yaml file defines your host as 127.0.0.1 by default. The host needs to be changed to 0.0.0.0 in order for this integration to function properly.
- [LedFx Docs](https://ledfx.readthedocs.io/en/latest/)
- [hass](https://github.com/home-assistant) - (HomeAssistant)
- [HACS](https://hacs.xyz/) - (HomeAssistantCommunityStore)
## QuickStart
- Add Repo to HACS:
- Navigate to HACS in Home Assistant
- Select "Integrations"
- Select the menu hamburger in the upper right of the screen
- Select "Custsom repositories"
- Add the url for this repository and select integration as the cattegory
- Install integration via HACS:
- The integration should now be visible, select "Install"
- Restart Home Assistant for the changes to take effect
- Add integration to Home Assistant:
- In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "LedFx Remote"
- Configuration is done in the UI
- Add the IP of the machine running LedFx to the "Host" field
- Leave the default port of 8888 or change it to match your configuration
- (LedFx Server needs to be online and running)
- no changes are needed in configuration.yaml
- all Settings are handled via UI
- Open the light entity and change your scenes :)
**[Step by Step Installation - Images-Guide](https://github.com/YeonV/ledfxrm/wiki/Step-by-Step-Images)**
## Detailed Features
- Everything configurable via UI :)
- AutoCreate Entities with `GET` Informations from all LedFx-API-Endpoints:
- Binary Sensor (Is LedFx online?)
- Devices Sensor (Number of Devices inside LedFx)
- Scenes Sensor (Number of Scenes inside LedFx)
- Pixels Sensor (Number of Pixels inside LedFx)
- Switch (if start/stop is set in config - custom `GET`-call)
- Light
- EffectList (Filled with scenes from LedFx)
- Off->On - just toggles a manual sync (double click the switch)
- EffectList-Change will fire LedFx via `PUT`
- Scan_intervall in seconds via UI:
- Note: This also defines how long you can interact with it (start server), after a disconnect (kill server)
- Recommendation: set to a high number. Polling is only to get changes made inside LedFx.
- SubDevices: (config via UI)
- Get the Devices running inside LedFx including their states
- ON / OFF Button
- OFF Button saves the current effect running on the current device
- ON Button will use that state if available otherwise sends "Gradient"
- Start/Stop Server:
- Set custom Endpoints for Start and Stop
- Configurable methods: `GET`, `DELETE`, `PUT`, `POST`
- Configurable body: json (untested)
- NEW: Add Blade-Light: 1 effect throught multiple devices
## Upcoming Features
- Make also use of the after setup config flow (options)
- Allow editing of setup-settings
- Allow disable poll (If you have everything setup in ledfx, there is no need to poll for new infos all the time)
- Make fallback "gradient" somehow editable for the user
## Screens
show
Default:
With Subdevices:
## Credits
[](https://github.com/LedFx/LedFx/tree/dev/ledfx) [](https://discord.gg/wJ755dY) [](https://github.com/Aircoookie/WLED) [](https://discord.gg/KuqP7NE)
[](https://github.com/home-assistant) [](https://github.com/hacs/) [](https://github.com/custom-components/blueprint)
## Special Thanks
[](https://github.com/frenck) [](https://github.com/THATDONFC) [](https://github.com/OnFreund) [](https://github.com/DubhAd)