Zoom Rooms Native Room Controls
The Room Controls feature allows you to control third-party, IP-capable equipment so that the equipment can be controlled by the user through the Zoom Room controller. Admins can create a configuration profile to add outgoing IP control messages from Zoom Room.
This article covers:
- How to enable Room Controls
- How to write a Room Controls profile
- How to use Room Controls
Prerequisites for using Room Controls
- Zoom Rooms for macOS or Windows or Zoom Rooms Appliances, version 5.1 or higher
- Third-party devices controllable by LAN or WLAN
- iTach network adapter (IP2SL/IP2CC or wifi equivalent), if the device does not have native LAN or WLAN access
How to enable Room Controls
Before you can upload a JSON configuration profile, the setting will need to be enabled for a Zoom Room.
- Sign in to the Zoom web portal.
- Click Room Management, then select Zoom Rooms.
- Click Edit to the right of the Zoom Room name.
- Under Devices, toggle Enable Room Controls to on (blue).
- Click Create Profile.
- Enter the JSON configuration for this room.
How to write a Room Controls profile
Before writing a Room Controls Profile, some working knowledge of JSON is needed. The key items to note are that JSON is a key:value pair-based system and that syntax is important to correctly lay out the file. For additional information on the basics of JSON, consult an online intro course.
In any coding language, some courtesy should be extended to the next person that handles your file. While there is no specific requirement around this for Zoom Rooms Native Room Controls, it is recommended. To leave a record of the author, version, or other history, the 'about' object can be used and placed above 'adapters'. This is not parsed by Room Controls, but will persist in the portal. An example of how this could be leveraged is below.
"type": "Medium Conference A",
"created": "Mon, 21 Oct 2020 16:35:52 GMT"
Setting up the adapters connects Room Controls to devices. This section is the primary section for configuration. Individual devices inside the nested JSON format should follow a similar format (this example is nested to parallel the code example below):
- Adapters: Adapters defined the individual device connections
- Model: Models can be "GenericNetworkAdapter", "IP2CC", and "IP2SL". More details below.
- IP: This is the IP Address + Port of the network device
- NOTE: Room Controls now also supports hostname rather than IP address in current software versions
- UUID: This is only required with Global Caché devices and would follow "GlobalCache_[MAC]"
- Ports: Ports define the device attached to the connection
- ID: This is the name of the device in code. Should follow JSON variable formatting
- Name: This is the friendly name that your users will see on the Interface
- Methods: Methods define the individual UI section
- ID: This is the control type ID that is called in code (specific to the control type)
- Name: This is the user-accessible name shown on the Zoom Rooms Interface
- Command: This is either the full command or the shared parts of the command string depending on the action type
- NOTE: When the action type is 'actions' a % should be placed in the command string as a placeholder for the inserted elements inside of 'params'
- Params: This section is only used with 'actions' type and contains the elements that can roll up to the parent command.
- ID: This is the programming ID that is called in code
- Name: This will be the user-accessible text on the Room Controls Button
- Value: This is the command section that is inserted in the parent command. An example of this would be using 'POWR000%\\x0D' as the parent command, '0' for Off or '1' for On could be inserted for some Sharp Displays
"name": "Sharp Display",
Below 'methods', an additional section can be used: "response_filter". The Response Filter is a beacon that allows the Response Filters defined below to understand which connection to listen for. There are no functions defined in this area. How a Response Filter fits into other sections will be covered inside of those sections.
Styles control the visual styling of your interface elements. The adjustments aren't extremely extensive, so it isn't very hard to learn.
There are many icons available in the interface. They span everything from air conditioners to speakerphones. The icons below are the current list, but this list is regularly expanding.
There are three primary modifiers within styles: icons (as we discussed above), Main Methods, and Visibility.
Icons are the visualizations of the system. You can use them either to mark a device or to replace the text tied to a button. In the below example, we've defined a device called 'example'.
"name": "Example Device",
Once 'example' is defined as a device, we can use this ID inside of styles. For example, setting the main icon for our example device to be a light is easily done.
You may also notice that within a single line, we've also defined the Main Method for the device. The Main Method pulls the referenced command that you've defined into the title bar of the device giving it a prominent billing like so:
We've defined the power command as the main method, and so it is shown in the upper bar separate from the other commands.
The third style type is Visibility. Visibility allows the programmer to define a function, but hide that function from the User's Interface completely. It can be defined just as easily:
Following the format of "device.command.invisible=true" allows this command to be completely hidden from the Rooms User.
Rules are the automation engine of Room Controls. This is the area where things that happen on their own are defined. For example, if I wanted my display to only be active when a meeting is active, I could leverage "meeting_started" and "meeting_ended" (stock Zoom events) to make this occur.
This example can be used to reduce power consumption for your system.
If one command per rule isn't enough, these commands can easily be stacked. While they technically fire sequentially, they process quickly enough that we'll consider these events simultaneous. In my above example "camera.power.wake" is added beneath "display.power.on" to activate my camera when my display wakes.
Note: The available stock Zoom commands inside of rules have been expanded as of Zoom Rooms version 5.13.0. Meeting start/end events also now apply to 3rd-party interop meetings, including Microsoft Teams Direct Guest Join Meetings. Other events do not apply to 3rd-party interop meetings in this release.
|Meeting||Incoming Meeting Invite Start||zr_meeting_ring_started|
|Meeting||Incoming Meeting Invite End||zr_meeting_ring_ended|
|Phone||Incoming Phone Call Start||zr_phone_ring_started||
Any type of phone interaction (Zoom Phone, Audio Plan, 3rd Party PBX) will trigger this command
|Phone||Incoming Phone Call End||zr_phone_ring_ended||
All phone ring types must be inactive to trigger this event
|Phone||Phone Call Started||zr_phone_call_started||
PSTN Invites within an active meeting will not trigger this event
|Phone||Phone Call Ended||zr_phone_call_ended||
|In-Meeting - Video||Video On (Camera Mute Off)||video_started|
|In-Meeting - Video||Video Off (Camera Mute On)||video_stopped|
|In-Meeting - Audio||Mic On
|In-Meeting - Audio||Mic Off
|In-Meeting - Content||Wireless Sharing Started||zr_share_started||Applies to direct share, whiteboard camera share, camera share, zoom apps sharing, and Apple Airplay (for multiple simultaneous shares, only the first command is sent). Digital Signage will not trigger these events.|
|In-Meeting - Content||Wireless Sharing Ended||zr_share_ended||This command is sent when the last of multiple shares ends. Digital Signage will not trigger these events.|
|In-Meeting - Content||HDMI Sharing Started||zr_hdmi_share_started||Digital Signage will not trigger these events.|
|In-Meeting - Content||HDMI Sharing Stopped||zr_hdmi_share_ended||Digital Signage will not trigger these events.|
|In-Meeting - Recording||Recording Started||zr_recording_started|
|In-Meeting - Recording||Recording Stopped||zr_recording_ended|
|Elevation||Meeting elevation||zr_elevate_to_meeting||This event triggers when a Zoom Room engaged in a telephony or screen-sharing session elevates the session to a video meeting.|
|Pairing||User Paired to ZR||zr_user_paired||Each user will trigger a generalized pairing event.|
|Pairing||User Unpaired from ZR||zr_user_unpaired||Each user will trigger a generalized unpairing event.|
|Digital Signage||Digital Signage Begins||zr_digital_signage_started|
|Digital Signage||Digital Signage is dismissed||zr_digital_signage_ended|
|Whiteboard||Whiteboarding opened||zr_whiteboard_started||Applies to Classic Whiteboard, New Whiteboard, and in-meeting whiteboards|
|Whiteboard||Whiteboarding closed||zr_whiteboard_ended||Applies to Classic Whiteboard, New Whiteboard, and in-meeting whiteboards|
|Operation Time||Operation Time Begins||operation_time_started|
|Operation Time||Operation Time Ends||operation_time_ended|
|People Detection||People Detected||zr_people_detected||Only applicable to hardware layer people detection|
|People Detection||No People Detected||zr_people_not_detected||Only applicable to hardware layer people detection|
|Voice Commands||Voice Commands are enabled||zr_voice_command_on|
|Voice Commands||Voice Commands are disabled||zr_voice_command_off|
|Zoom Apps||Zoom App is opened||zr_zoom_app_opened||Opening any app will trigger this event, even if an app is already open in the meeting.|
|Zoom Apps||Zoom App is closed||zr_zoom_app_closed||Closing any app will trigger this event, even if another app is still active in the meeting.|
Note: Operating Hours for Operation Time events are set in the Zoom Rooms settings page.
It is also simple to add your own for Response Filters. Within the rules section, you can also use the Trigger Events discussed below to drive your own automation with outside inputs.
In this example, our "user_customized_event1" is turning our controlled light off. This could be driven by an input from a button or maybe a motion sensor going inactive or maybe even a third-party system like a booking system sending the room an update that no users checked in for the meeting. How you can use this feature is primarily limited by your imagination.
New in Zoom Rooms 5.13.0, the Scenes function allows Native Room Controls devotees to finally add Macros (multiple stacked commands on a single button) to their user experiences. This can be helpful for scene recall or dependant devices such as lowering a projector screen as well as powering the projector on.
Like Rules or Adapters, Scenes is a top-tier section in the JSON file. Today, a maximum of 20 scenes can be configured. Within those scenes, a maximum of 50 independent commands are supported.
Once configured, these new scene buttons are available at the top of the room controls window.
To configure scenes, you can reference the code sample below.
Before copying this content, please be aware that '//text' sections are notes for your reference and cannot be included in the final JSON file.
"name":"Turn on all lights", //optional, shown if name and icon are empty
"icon":"icon_light", //optional, see icon list
"commands": [ //required
"name":"Turn off all lights"
Response Filters are a powerful advancement in Zoom Rooms Native Room Controls functionality. These filters read messages coming back from defined devices and instantaneously scan for a phrase to match. When this phrase (or expression) is identified on that connection, the Rules Trigger Event (described above) fires.
Each Response Filter is comprised of three elements:
- "name": The name is used in the "ports" section of "methods". When the response filter matches this name in the "ports" area, this begins to span the defined connection
- "filter_regex": The regex (or Regular Expression) is the set of characters that the Response Filter is attempting to match. When the match occurs, the "trigger_event" will activate
- "trigger_event": The Trigger Event is used within the rules section. When the "filter_regex" activates, the automation defined within this Trigger Event in Rules will occur
How to use Room Controls
On the Zoom Rooms controller, simply tap the Room Controls icon to access these added functions.
When not in a meeting, the Room Controls icon can be found in the main menus.
During a meeting, tapping the icon at the top right of the controller window will display the same Room Controls.
Troubleshooting is an important part in any custom configuration. While Room Controls can be simple, it is also flexible enough to be complex when needed. The below sections should help to resolve possible roadblocks.
Room Control Errors
|No_Config_Error||JSON Profile is not loaded in web portal|
|Json_Syntax_Error||JSON Profile contains a syntax error|
|Json_Config_Error||JSON Profile contains a configuration error|
|IP_Error||There is an issue connecting to a specified IP|
|IP_Is_Public||Public IPs are not allowed at this time|
|DeviceID_Error||One or more Device IDs are incorrectly set|
|MethodID_Error||One or more methods are incorrectly defined|
|ParamID_Error||One or more parameters are incorrectly defined|
|IP2SL_Settings_Error||Serial Port incorrectly configured on GC IP2SL|
|Empty_Device_Error||One or more devices are called without being defined in the JSON Profile|
|Unknown||An unknown error has occurred|
These files have been compiled from various sources and should be used as a starting point only. Some modification is likely required to fit your application.
Join the 100K+ other members in the Zoom Community! Login with your Zoom account credentials and start collaborating.