OpenRGB

The OpenRGB integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] is used to integrate the RGB lighting devices from computers running OpenRGB. OpenRGB provides a unified interface for controlling various RGB lighting hardware from different manufacturers.

Prerequisites

To use this integration, you need the OpenRGB application installed on your computer with the SDK Server running.

To enable the OpenRGB SDK server:

1. In the OpenRGB application, go to SDK Server tab.
2. Select Start Server.
3. Optionally, go to the Settings tab and check Start at Login, Start Minimized, and Start Server for convenience.

Note: if you opted to Install System Service in the OpenRGB Windows installer, the SDK server is probably already running. You can check this in the Services application in Windows, looking for the OpenRGB service.

Configuration

To add the OpenRGB hub to your Home Assistant instance, use this My button:

Supported devices

This integration supports any RGB device that is compatible with OpenRGB. Refer to the OpenRGB Supported Devices list.

Supported functionality

The OpenRGB integration provides the following entities:

Lights

For each RGB device connected to OpenRGB, the integration creates a light entity to control all the LEDs on that device as a single unit.

Data updates

The OpenRGB integration pollsData polling is the process of querying a device or service at regular intervals to check for updates or retrieve data. By defining a custom polling interval, you can control how frequently your system checks for new data, which can help optimize performance and reduce unnecessary network traffic. [Learn more] data from the OpenRGB SDK server every 15 seconds.

Reconfiguration

If you need to update your OpenRGB SDK server connection details, you can reconfigure the integration:

1. Go to Settings > Devices & Services.
2. Select OpenRGB. Select the three dots menu and then select Reconfigure.
3. Update the hostname/IP address and port number as needed.
4. Select Submit.

The integration will then reconnect to the OpenRGB SDK server with the new settings.

Known limitations

• Changes made directly in the OpenRGB application may not be immediately reflected in Home Assistant (the integration polls for updates every 15 seconds).
• Some OpenRGB features like per-zone and per-LED control are not yet supported through Home Assistant

Troubleshooting

Connection errors

If you encounter connection errors:

• Verify that the OpenRGB SDK server is running in the OpenRGB application.
• Verify that the SDK Server > Server Host is set to 0.0.0.0 in the OpenRGB application.
• Confirm that the IP address of the computer running the OpenRGB SDK server matches the Host configured in the OpenRGB integration.
• Confirm that the SDK Server > Server Port matches the port configured in the OpenRGB integration.
• Check for firewall rules that may block the connection from Home Assistant to the OpenRGB SDK server.

Devices not appearing

If your RGB devices don’t appear in Home Assistant:

• Verify the devices are detected and working in the OpenRGB application first.

Light effects not working

If lighting effects are not working:

• Verify the effect/mode can be applied in the OpenRGB application first.

Removing the integration

This integration follows standard integration removal. No extra steps are required.

To remove an integration instance from Home Assistant

1. Go to Settings > Devices & services and select the integration card.
2. From the list of devices, select the integration instance you want to remove.
3. Next to the entry, select the three dots menu. Then, select Delete.