REST API features

Feature Requests
1

I’m working on a Home Assistant integration for SignalRGB using a Python client I’ve created for the REST API (GitHub - hyperb1iss/signalrgb-python: Python library for SignalRGB). I’d love to see a few additional features in the REST API to make the integration more powerful:

  1. Control global layout brightness
  2. Apply effects with parameters
  3. Apply effects with presets
  4. Change parameters of current effect
  5. Query presets
  6. Filter the effects list similar to how the new UI can do it (favorites, visualizers, etc)
  7. Some kind of authentication (API keys?) since the API is currently wide open across the network.

It would also be amazing if SignalRGB were discoverable via Zeroconf so these kinds of integrations are trivial to configure!

Thanks for consideration!!

2

Additional API feature requests:

  1. Get thumbnail for an effect
  2. Callback when effects are changed in the UI
3

Looks like you beat me to the punch after I updated the Local API docs. Well done!

Layout Brightness isn’t something I can reasonably expose to the API (as it shouldn’t be able to overwrite saved Layout settings), but I did add Global Brightness specifically for this as something that can be more dynamic.

The API has ways to get the available effect presets and apply those already. I’ll add a way to change specific effect settings too.

Authentication is something I’m planning on adding in the short term to it, but I haven’t decided on specifics yet. Users will need to generate a token in-app and provide that via copy-paste or a QR code to clients for sure though.

You can get the image URL from the API’s Effect info endpoint currently. I’m likely going to replace with an image endpoint so it’s fetched from the local network though at some point.

4

Thanks for all the great API updates!

Would it be possible to add a flag to know whether an effect is marked as a favorite? I’d love to be able to use this to filter the list, because I have every effect installed (because why not!) and have just a few marked as favorites.

5

The newest beta has this added (2.4.6-beta)

6

Request: Able to select a single colour and it automatically picks the “Solid Color” effect and then apply that colour.

i.e, I say to my Google Hub “Turn PC lights red”; it’ll turn my PC led strip to Solid Color and apply the colour red.