Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
* Add note about Windows firewall
* Add note about custom repository until branding icons are accepted into HA
  • Loading branch information
hyperb1iss authored Jul 24, 2024
1 parent 0fa3c08 commit ccd9568
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,19 +32,22 @@ Want more features? Vote for this [SignalRGB feature request!](https://forum.sig
5. Click "Install" and wait for the installation to complete.
6. Restart Home Assistant.

NOTE: This component isn't in the official HACS repository yet. You can add it as a custom
repository for now- go to HACS, click on the 3 dots, click custom repositories, and enter
"hyperb1iss/signalrgb-homeassistant" for the repository and select "Integration" for the
category.

### Manual Installation

1. Download the `signalrgb` folder from this repository.
2. Copy the folder to your `custom_components` directory in your Home Assistant config directory.
- If the `custom_components` directory doesn't exist, you'll need to create it.
3. Restart Home Assistant.

### Enable SignalRGB HTTP API
### Enable SignalRGB API

1. Open SignalRGB on your Windows PC.
2. Go to Settings > App Settings.
3. Enable the "Enable HTTP API" option.
4. Note down the port number (default is 16068).
By default, SignalRGB listens on port 16038. You may need to open this port on the Windows firewall
so that Home Assistant can connect to your PC.

## ⚙️ Configuration

Expand Down

0 comments on commit ccd9568

Please sign in to comment.