Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dallashoff/homebridge-openrgb
Control the RGB lighting of your PC components and peripherals with HomeKit.
https://github.com/dallashoff/homebridge-openrgb
homebridge homebridge-plugin homekit openrgb rgb
Last synced: about 2 months ago
JSON representation
Control the RGB lighting of your PC components and peripherals with HomeKit.
- Host: GitHub
- URL: https://github.com/dallashoff/homebridge-openrgb
- Owner: DallasHoff
- License: apache-2.0
- Created: 2021-06-30T21:50:04.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-06-17T00:19:59.000Z (8 months ago)
- Last Synced: 2024-11-13T12:08:41.384Z (3 months ago)
- Topics: homebridge, homebridge-plugin, homekit, openrgb, rgb
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/homebridge-openrgb
- Size: 340 KB
- Stars: 13
- Watchers: 2
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OpenRGB Homebridge Plugin
[](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)
[](https://www.npmjs.com/package/homebridge-openrgb)
[](https://www.paypal.com/biz/fund?id=U3ZNM2Q26WJY8)
This plugin allows you to integrate [Homebridge](https://homebridge.io/) with the [OpenRGB](https://openrgb.org/index.html) lighting control software on your PC so that you can control the lighting of your PC's components and peripherals with HomeKit. Each RGB device is added to HomeKit as an RGB lightbulb that you can control with Siri, the Home app, scenes, automations, or however else you interact with your HomeKit smart home.
This solution works with PC hardware from the most popular brands like ASUS, Gigabyte, MSI, Corsair, Razer, Logitech, NZXT, and [many more](https://openrgb.org/devices.html).
# Installation
## Install OpenRGB on your PC
OpenRGB is a software project that aims to replace the need to use several different RGB lighting control software programs from multiple vendors, allowing you to control all of your PC components' and peripherals' lighting with just one piece of software.
Follow [OpenRGB's instructions for installing the software](https://gitlab.com/OpenRGBDevelopers/OpenRGB-Wiki/-/blob/stable/User-Documentation/OpenRGB-Windows-Setup-and-Usage.md) on your PC. Then, follow [these instructions](https://gitlab.com/OpenRGBDevelopers/OpenRGB-Wiki/-/blob/stable/User-Documentation/Frequently-Asked-Questions.md#can-i-have-openrgb-start-automatically-when-i-log-in) to configure OpenRGB to start automatically when you turn on your PC. Be sure to make use of the `--server` flag so that the OpenRGB SDK server starts on boot too. This plugin interacts with your PC's lighting through that server.
## Install this Plugin on Homebridge
If you do not already have a Homebridge setup, follow [Homebridge's setup guide](https://github.com/homebridge/homebridge/wiki) to get up and running.
Now, you can install the `homebridge-openrgb` plugin through the Homebridge UI which will help you install and configure the plugin. Alternatively, install the plugin through NPM with:
npm install -g homebridge-openrgb
# Configuration
Configure the plugin so that it knows where to connect to your PC(s) running the OpenRGB SDK server. You can do this through the Homebridge UI or add the configuration to the `platforms` array in the configuration file at `~/.homebridge/config.json`
**Configuration Fields:**
* `platform` (string) - Tells Homebridge to use this plugin. Must be set to `OpenRgbPlatform`
* `name` (string) - A name to label this plugin
* `servers` (array) - Each object represents a computer running the OpenRGB SDK server that this plugin should attempt to connect to
* `name` (string) - A name for this server
* `host` (string) - The IP address (e.g. 10.0.0.2) or hostname (e.g. my-computer.local) that the OpenRGB SDK Server is running on
* `port` (integer) - The port number that the OpenRGB SDK Server is set to run on. OpenRGB defaults to using port 6742
* `discoveryInterval` (integer) - How often (in seconds) to check if new devices are available to connect to. Defaults to 60 seconds
* `preserveDisconnected` (boolean) - Set this to `true` to have the plugin keep devices that are disconnected from their server. By default, devices that are not connected when their server is queried are removed from HomeKit, which may mess up your scenes if you have devices such as peripherals which are not always connected to your PC
* `suppressConnectionErrors` (boolean) - Set this to `true` to hide log messages about errors connecting to your PC
Typically, a computer's IP address will change periodically, so I recommend using your PC's hostname to configure this plugin's `host` field. On Windows, you can run the `hostname` command from the command line to view your PC's name. Your hostname will then be that name, lowercase, with `.local` appended to the end. Alternatively, you could configure your router to reserve a specific IP address for your PC and use that in the `host` field.
**Example Configuration:**
{
"platforms": [
{
"platform": "OpenRgbPlatform",
"name": "OpenRGB",
"servers": [
{
"name": "John's Computer",
"host": "johns-computer.local",
"port": 6742
},
{
"name": "Jane's Computer",
"host": "janes-computer.local",
"port": 6742
}
],
"discoveryInterval": 60,
"preserveDisconnected": false,
"suppressConnectionErrors": false
}
]
}