Zoom Rooms Native Room Controls with Q-SYS
Solutions Application Guide for Q-SYS™
Solution Overview
The Q-SYS Platform is jointly tested and supported to work with Zoom Rooms, enabling interoperability for all current and future Q-SYS Products.
This document is an overview of the tools you can use to make Zoom Rooms and Q-SYS work together while adhering to best practices.
Getting Started
Before you get started, please ensure that you have the following physical and software components:
Physical Components:
- Zoom Room Compute and Controller
- Q-SYS Core processor with audio video peripherals
- Q-SYS Core processor with Internet access
Software Components:
- Q-SYS Rooms Designer Software
- Zoom Room Controls Sample Q-SYS Design (available for download in Q-SYS Designer Software with Asset Manager).
Sample System Diagram
The sample system diagram illustrates a typical setup. It includes a Standard Network Switch connecting a Q-SYS Core 8 Flex, an SPA Series amplifier, and a Zoom Rooms Compute. Peripherals shown are a Sennheiser TeamConnect Ceiling 2 microphone, USB accessories, and AcousticDesign Series loudspeakers. Cable types indicated are Standard Ethernet, USB, HDMI, Mic/Line, and Loudspeaker.
Installing Q-SYS Designer Software
On your PC, install the latest version of Q-SYS Designer Software. Navigate to Tools > Show Asset Manager and search for Zoom. Install the Zoom Rooms Sample Design. Then, go to File > Open Sample Design and open the Zoom Rooms Sample Design. Once open, select Tools from the ribbon and choose Show Configurator. This action opens Q-SYS Configurator, displaying your Q-SYS Core processor in the left pane. Select your Q-SYS Core processor and click the Configuration Page link to access Q-SYS Core Manager > Network Settings. Review and configure the Core's network settings. For more information, refer to Initial Discovery and Configuration. Assign a unique name to the Q-SYS Core that suits your requirements. Return to the design file and ensure the Q-SYS Core's name in your design matches the Hostname set in Q-SYS Core Manager. Save the design to the Q-SYS Core and run it (F5). Consult About Designs on the Core for further details.
If the Q-SYS Core's firmware does not match the version of Q-SYS Designer on your configuration laptop, you will be prompted to update the firmware. Refer to Updating Q-SYS Software and Firmware.
Visual representation of the Zoom Rooms interface: A mobile or tablet screen showing a 'Room Controls' icon on the left-hand side, alongside options like 'Home', 'Contacts', 'Settings', 'New Meeting', 'Join', and 'Show Content'.
Configuring the Room Controls in Zoom Web Portal
Before proceeding, ensure your Zoom Rooms compute is connected to the network and configured in the Zoom Rooms Admin portal. Consult your Zoom administrator and the Getting Started with Zoom Rooms guide for setup details.
- Sign into the Zoom web portal using an account with administrative access to the Zoom Room.
- Navigate to the Room Management tab within the admin section and select Zoom Rooms.
- Locate the desired room name in the list. On the right-hand side of the screen, select the 'Edit' button next to the Zoom Room you wish to configure.
- Under the Rooms Profile, select the Devices tab on the left-hand side of the page.
- Scroll down to find the 'Enable Rooms Controls' section.
- Toggle the 'Enable Rooms Control' setting to activate it.
- Select the 'Create Profile' button.
- Copy the JSON script into the 'Create Profile' window in the Zoom web portal and click 'Save'.
Your Zoom Rooms Controller should now display the Room Controls icon on the left-hand side of the screen.
Using the Zoom Rooms Controls Sample Q-SYS Design
This sample Q-SYS design, available for download via the Q-SYS Designer Software Asset Manager, provides a step-by-step guide for correctly connecting Q-SYS with a Zoom Room. It includes sample logic for integrating third-party devices natively into Q-SYS and allows for viewing Zoom Rooms control feedback within Q-SYS.
Within the sample program, an example JSON script is provided. This script can be copied and pasted into the Create Profile window in the Zoom web portal. For the sample JSON script, you must modify line 5, replacing '<CORE IP ADDRESS HERE>' with your Q-SYS Core IP Address, which can be found in Q-SYS Core Manager > Network Settings.
Expanding Third-Party Controls with Q-SYS
Zoom Rooms Native Control utilizes JSON (JavaScript Object Notation) for one-way communication with Q-SYS or any Third-Party devices. For expanding or creating custom Zoom Rooms controls, a working knowledge of JSON is recommended. Further details can be found [here](https://www.json.org/json-en.html).
Control from Zoom Rooms to Q-SYS is facilitated by the External Control Protocol (ECP) API from Q-SYS. To use this API with Zoom Rooms Controls, each third-party device intended for control must have its desired controls exported as a Named Control within Q-SYS Designer Software. Once controls are designated as Named Controls, the External Control Protocol (ECP) API syntax can be applied within the JSON script loaded into the Zoom web portal.
Visual representation of the Q-SYS Designer Software interface: A software window displaying design elements, inventory, user control interfaces, snapshots, and a search bar for named controls. Examples of named controls include 'PDU_power', 'Projector_avmute', 'Projector_power', and various 'Test_' controls.