Skip to content

Commit

Permalink
ADD: hacs
Browse files Browse the repository at this point in the history
  • Loading branch information
koying committed Apr 23, 2021
1 parent d973524 commit 60a6422
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 1 deletion.
42 changes: 41 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,41 @@
This custom component is a follow up to https://github.com/home-assistant/core/pull/38309 by @bahorn, which didn't make it to HA Core.
# OpenRGB integration for Home Assistant

## Pre-requistes

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

## Installation

### HACS

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

### Home Assistant

1. Go to the integrations page
1. Click on the éAdd Integration" button at the bottom-right
1. Search for the "OpenRGB" integration
1. 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

- This custom component is a follow-up to https://github.com/home-assistant/core/pull/38309 by @bahorn, which didn't make it to HA Core.
- This integration uses openrgb-python, by @jath03
6 changes: 6 additions & 0 deletions hacs.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"name": "OpenRGB",
"domains": ["light"],
"iot_class": ["Assumed State", "Local Polling"],
"render_readme": true
}

0 comments on commit 60a6422

Please sign in to comment.