Skip to content

agoodshort/homebridge-wled-preset

Repository files navigation

Homebridge WLED Preset Plugin

Description

This Plugin is designed to easily switch presets configured on your WLED appliances through HomeKit.

Development

This is a plugin to easily switch between the different presets you have on your WLED. Development is happening on development branch.

This plugin is based on the template Homebridge platform plugin and the accessory example.

Got some inspiration from Homebridge Simple WLED.

When ready to merge to master and publish to npmjs

  1. npm version patch will run the command git checkout master && git merge development && git push from package.json
  2. The push on master will trigger build.yml and then publish.yml

Installation

With Homebridge Config UI X

  1. Login to the Homebridge UI web interface by going to http://homebridge.local or http://<ip address of your server>:8581
  2. In the Plugin tab, search for Homebridge WLED Preset
  3. Click INSTALL
  4. Once the installation is complete, open the SETTINGS of the plugin and fill out the required fields

Through Command Line/SSH

  1. SSH or open a Terminal on your Homebridge host
  2. Run npm install -g homebridge-wled-preset
  3. Update your configuration file using the sample below.

Configuration

Configuration sample:

"platforms": [
    {
        "wleds": [
            {
                "name": "Office Led Strip",
                "ip": "wled-office.local",
                "presetsNb": 5
            },
            {
                "name": "Bedroom Led Strip",
                "ip": "192.168.1.31",
                "presetsNb": 2
            }
        ],
        "platform": "WledPreset"
    }
]

Issues/Troubleshooting

Open issues

If you face any issues with this plugin, please review the open issues.

Troubleshooting

You might encounter issues with cached accessory or configuration not reloading, being updated properly. Feel free to mention this by opening a new issue.

You can remove cached accessories directly from the Homebirdge UI with the "Remove Single Cached Accessory" feature or by editing/deleting the ~/.homebridge/accessories folder.

Opening a new issue

If the troubleshooting steps above or the open issues did not help you to fix your problem. Please review briefly the closed issues to see if your problem is mentioned of them. If it is, feel free to post a comment on it and I will reopen the issue or create a new one.

Otherwise, feel free to open a new issue providing as much information as possible to reproduce your situation/error message.

To-Do

  • Get verified
  • Auto discovery of accessories
  • Implement node-fetch on in platformAccessory.ts
  • Add more details in the configuration (README, config.schema.json)
  • Can we use the brightness slider?
  • Work on the issues
  • Try to implement such workflow for update