Skip to content

agoodshort/homebridge-simple-wled

 
 

Repository files navigation

Homebridge Simple WLED

Hombridge Plugin for WLED Strip (WLED-Project by Aircoookie)

⚙️ Installation / NPM Package

For downloading and installing the Plugin NPM is used in Homebridge: Link to NPM Package

🔨 Adding the Accessory to the config.json

To make the accessory visible in your HomeKIT App you have to add the Platform-Accessory to the config.json to the platforms section:

    "platforms": [
        {
            "platform": "WLED",
            "wleds": [
                {
                    "name": "LED-Tisch",
                    "host": "10.0.0.52",
                    "effects": ["Rainbow Runner", "Circus"],
                    "log": true
                },
                {
                    "name": "LED-Kasten",
                    "host": ["10.0.0.53", "10.0.0.54"],
                    "effects": ["Rainbow Runner", "Circus"],
                }
            ]
        }
    ]

After editing the config, restart your HomeBridge Server and add the accessory manually from the Home App. If you encounter some issues when adding the accessory to the homekit app, open an issue in GitHub...

💡 Configure own Effect-Switch

To use your own effects you have an option "effects" you can add to your config.json and add as value a comma-seperated list of supported effects of your choice. All effects are found under Effects-List - WLED (Just use Names from the Effects and not from the palettes!!)

sample additional option:

    "platforms": [
                {
            "platform": "WLED",
            "wleds": [
                {
                    "name": "LED-Tisch",
                    "host": "10.0.0.52",
                    "effects": ["Rainbow Runner", "Circus", "Merry Christmas", "Fireworks"],
                    "log": false
                }
            ]
        }
    ]

If you want to turn off the WLED when turning off the WLED-Effect-Switch then you can add the option "turnOffWledWithEffect", (default: false)

    "platforms": [
                {
            "platform": "WLED",
            "wleds": [
                {
                    "name": "LED-Tisch",
                    "host": "10.0.0.52",
                    "effects": ["Rainbow Runner", "Circus", "Merry Christmas", "Fireworks"],
                    "turnOffWledWithEffect": true
                }
            ]
        }
    ]

If you want to disable the Effect-Switch to just use the normal "LightBulb" function. You can just remove the "effects" option in the config.json.

💡💡💡 Adding multiple WLED-hosts to a single accessory

If you want to control multiple WLED-hosts with a single accessory, you have to set the "host" option to a list/array as below: Note: The first WLED-host will act like a main-WLED, so for example, you change the color of the first WLED (10.0.0.52) via the WEB-Panel of the WLED it also changes for the following WLEDS (10.0.0.53, 10.0.0.54,...).

    "platforms": [
                {
            "platform": "WLED",
            "wleds": [
                {
                    "name": "LED-Tisch",
                    "host": ["10.0.0.52", "10.0.0.53", "10.0.0.54"],
                    "effects": ["Rainbow Runner", "Circus", "Merry Christmas", "Fireworks"],
                }
            ]
        }
    ]

Contributing

If you have any idea, feel free to fork it and submit your changes back to me.

Donation

You can also support me developing this plugin by buying me a coffee and giving me motivation to keep this plugin up to date and continue developing.

Thanks to everyone who is donating to me.

MoneyPool for new Graphics-Card (or other PC-Hardware):

About

Homebridge Plugin to control WLED LED-Strips

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 100.0%