koying / openrgb_ha

OpenRGB integration for Home Assistant
110 stars 18 forks source link
custom-component hacs home-assistant homeassistant light openrgb

OpenRGB integration for Home Assistant

Changelog

2.3

2.2 [Breaking]

2.1

2.0

1.0

Pre-requistes

  1. OpenRGB installed
  2. Its "SDK Server" component enabled

Installation

HACS

  1. Launch HACS
  2. Navigate to the Integrations section
  3. "+ Explore & Add Repositories" button in the bottom-right
  4. Search for "OpenRGB"
  5. Select "Install this repository"
  6. Restart Home Assistant

Home Assistant

  1. Go to the integrations page
  2. Click on the "Add Integration" button at the bottom-right
  3. Search for the "OpenRGB" integration
  4. Select the OpenRGB integration

Configuration

Options

This integration can only be configuration through the UI (Configuration->Integrations), and the options below can be configured when the integration is added.

key default required description
host localhost yes The host where OpenRGB is running
port 6742 yes The port on which the Server SDK is listening
client_id Home Assistant no the Client ID that will be displayed in OpenRGB

Credits