Note: This is a work in progress, but should work. If it doesn't, please open an issue.
A custom component that integrates Q-Sys Core Devices with Home Assistant via QRC. This is useful to expose elements such as gain controls, mute buttons and different media players to HA.
-
media_player
platform:- Media Stream Receivers/ URL Receivers
- On/Off (Enable/Disable)
- Mute control
- Volume control (stereo channels)
- Browse media
- Play media
- Audio Player / Audio File Player
- On/Off (Enable/Disable)
- Mute control
- Volume control
- Browse media (files on the Core)
- Play media (files on the Core)
- Seek
- Loop on/off
- Media Stream Receivers/ URL Receivers
-
number
platform:Value
controls (e.g gains)- Direct control (setting Value directly)
- Position control (0.0 to 1.0)
- Custom mapping via templated changes/values.
-
sensor
platform:EngineStatus
exposed to HA- Any component control
-
switch
platform:- Any float/int/bool where 1.0/1/True is considered on respectively
- Toggling.
-
text
platform:String
controls.
-
services
:- Invoking methods on the device via QRC (see
Services
section below)
- Invoking methods on the device via QRC (see
Add the custom component via your custom_components
folder or via HACS (untested).
- Install HACS
- Open HACS in the sidebar and go to "Integrations".
- Press the three dots in the top right corner and select "Custom repositories"
- Fill in the form with
Repository: https://github.com/nkvoll/home-assistant-qsys-qrc
,Category: Integration
and click "Add". - Once it's added, you can search for
q-sys qrc
, click the integration and select "Download". - Restart Home Assistant ("Settings" -> three dots top right corner -> "Restart Home Assistant")
- In the HA UI go to "Configuration" -> "Devices & Services" click "+ Add Integration" (bottom right corner) and search for "Q-Sys QRC Integration"
- Using the tool of choice open the directory (folder) for your HA configuration (where you find
configuration.yaml
). - If you do not have a
custom_components
directory (folder) there, you need to create it. - In the
custom_components
directory (folder) create a new folder calledqsys_qrc
. - Download all the files from the
custom_components/qsys_qrc/
directory (folder) in this repository. - Place the files you downloaded in the new directory (folder) you created.
- Restart Home Assistant ("Settings" -> three dots top right corner -> "Restart Home Assistant")
- In the HA UI go to "Configuration" -> "Devices & Services" click "+ Add Integration" (bottom right corner) and search for "Q-Sys QRC Integration"
First, set up the integration through the UI to configure the core name and credentials.
To expose component controls to HA, configure them via the configuration file (configuration.yaml
).
See the example configuration for an example of what can be configured.
In order to find the right component and control names, use the Q-Sys Designer. To find the right control name, open the design file and use “Tools → View Component Controls Info” then select your component. See example screenshot.
Used to call any method via QRC Commands:
service: qsys_qrc.call_method
data:
method: Component.Set
params:
Name: bathroom_f2_gain
Controls:
- Name: gain
Position: 0.5
Ramp: 2
target:
device_id: 7b7be23f1d37293589c28bee4dbb5b4d
service: qsys_qrc.call_method
data:
method: Component.Set
params:
Name: bathroom_f2_gain
Controls:
- Name: mute
Value: true
target:
device_id: 7b7be23f1d37293589c28bee4dbb5b4d
- Add (more) tests, especially around the code that integrates with home-assistant itself, see
pytest-homeassistant-custom-component
to get started. - Share the integration on the Home Assistant Forum.
- Anything else?
If you want to contribute to this please read the Contribution guidelines
This Home Assistant custom integration is not endorsed or affiliated with QSC, LLC.
- QSC and the QSC logo are registered trademarks of QSC, LLC in the U.S. Patent and Trademark Office and other countries.
- QSC, the QSC logo and (Name) are registered trademarks of QSC, LLC in the U.S. Patent and Trademark Office and other countries.
- Q-SYS is a trademark of QSC, LLC.