Download
Share
Print this page
  1. Manuals
  2. Brands
  3. Aveo Systems Manuals
  4. Keypad
  5. KD-WP8-2
  6. How to use manual

Aveo Systems KD-WP8-2 How To Use Manual

Mira connect and keydigital
Hide thumbs

Advertisement

Quick Links

Download this manual
Mira Connect and KeyDigital KD‑WP8‑2
S Y S T E M S
How to use the Mira Connect Room Control API with KeyDigital KD‑WP8‑2
Introduction
Mira Connect is an award‑winning AV control system that makes it easy to build professional AV control systems. Mira Connect
supports thousands of devices, making it easy to use in many different applications. Mira Connect also includes built‑in
equipment emulators, making it possible to create and experience, a full system before purchasing any AV equipment.
Mira Connect is configured through
Mira
Portal, the secure cloud management platform for Mira Connect that enables remote
management for AV/IT teams.
In this guide we'll show how to use Mira Connect software, Mira Portal, and a
KeyDigital KD‑WP8‑2
8‑button keypad as the user
interface to control a room using Mira Connect's room control API.
This guide shows you how to configure the keypad for volume and mute control, source selection, and a room power‑off
feature, as shown below. KeyDigital keypads include multiple sets of informative button labels and clear key caps that cover
the button and labels to help users understand what each button does.
Figure 1:
The button layout for the KeyDigital keypad design.
Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068
1
Phone: +1.678.653.7090 • Email: sales@aveosystems.com •
aveosystems.com

Advertisement

loading
Need help?

Need help?

Do you have a question about the KD-WP8-2 and is the answer not in the manual?

Questions and answers

Summary of Contents for Aveo Systems KD-WP8-2

  • Page 1 Figure 1: The button layout for the KeyDigital keypad design. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com • aveosystems.com...
  • Page 2 UDP, HTTP, HTTPS, SSH, and perform advanced features that aren’t easy (or even possible) to configure on simple user interface devices, including sending Wake‑on‑LAN packets to displays, scheduling room power‑off, or simply Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com •...
  • Page 3 A single press will increase the volume by 1dB. Holding the button will continue to increase the volume. The button will illuminate blue when pressed. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com • aveosystems.com...
  • Page 4 NOTE: As we go through this example, you can follow along using simulated equipment and confirm the operation with our Mira Connect Remote Control user interface in your browser. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com •...
  • Page 5 Mira Connect software is a software‑only version of the Mira Connect AV control system that can be installed on any Windows® 10 or newer computer. Mira Connect software can be downloaded from AveoSystems.com. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com •...
  • Page 6 Pairing Code to get a pairing code that will let us associate Mira Connect with the desired room in Mira Portal. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com •...
  • Page 7 Mira Connect software will connect to Mira Portal and get a unique pairing code. Note the pairing code will expire after an hour, after which a new pairing code can be requested. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com •...
  • Page 8 A pairing code will be used with Mira Portal to associate the Mira Connect with the room. Enter the pairing code into Mira Portal by clicking the PAIR button on the Mira Connect tab. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com •...
  • Page 9 Once paired to the room, Mira Portal will show the updated status, as shown in the following figure. Figure 8: Once paired to the room, Mira Portal shows information about the Mira Connect software. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com • aveosystems.com...
  • Page 10 Select the organization name and then the licensing menu to buy a license. Once a room license has been purchased, the Licenses menu will show the new license information. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com •...
  • Page 11 This makes it easy to use your favorite equipment without having to worry about the specific API commands needed to control that equipment. Mira Connect takes care of that for you. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com •...
  • Page 12 As mentioned earlier, if you don’t have the equipment or a room license yet, you can choose Simulate Equipment to build the user interface and control system around Mira Connect’s built‑in equipment emulators. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com •...
  • Page 13 The AVPro video switcher is configured with four inputs that we’ll label as INPUT 1, INPUT 2, INPUT 3, and INPUT 4. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com •...
  • Page 14 NOTE: We used the ‘Use sources connected to…’ option on the display menu to access the output from the video switcher. See our training videos for more information about adding equipment and using video switchers with displays. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com • aveosystems.com...
  • Page 15 Off Setting’ feature, as shown below. While you don’t need this to use the set roomOff API command, we enable it so that we can see the ‘Room power off’ function in the remote control UI. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com •...
  • Page 16 AV and IT teams to manage rooms remotely from any location since they get access to the full user interface in the room and can remotely control the system. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com •...
  • Page 17 Once the room is paired to Mira Connect software, navigate to the API menu and click ADD API KEY. If you are going to be using different API keys for different applications, you can give each API key a different, appropriately‑named label. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com •...
  • Page 18 Mira Connect. Creating separate API keys for each application is a good practice and makes it easier for you to control access in the future. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com •...
  • Page 19 Before using the API key, we must first ensure that TCP is enabled for the room in Mira Portal. Enabling TCP allows TCP communications to be created over port 52838 to the Mira Connect software. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com •...
  • Page 20 Routes the specified source on a display set roomOff Powers off the room and resets the audio levels and mute Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com • aveosystems.com...
  • Page 21 In this example, the Mira Connect software is running on a PC that has an IP address of 192.168.100.194. After downloading and installing PuTTY, run the application and click Open to create the connection. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com •...
  • Page 22 Create a Telnet session to Mira Connect using port 52838. Once the connection is established, Mira Connect will automatically report back that the room is paired. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com •...
  • Page 23 Sending the subscribe command (shown below with the pink outline) will cause a response (shown below in the blue outline) to be returned by Mira Connect software with the current room capabilities. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com •...
  • Page 24 We can copy the response and format the JSON response with a JSON formatter to make the response more readable, and we can also annotate the response as shown below. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com • aveosystems.com...
  • Page 25 • The unique display ID for the display in the room is: ‑Nq395UIZPzYf29AVhAL • The unique source IDs that will be used for selecting those sources are: – Input 1: ‑Nq392rU18SLG_kX47NW Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com • aveosystems.com...
  • Page 26 Once you have found the IP address of the keypad, browse to the keypad’s IP address (192.168.100.197 in our example), enter the default password of 12345678, and click LOG IN. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com •...
  • Page 27 Once logged in, the device info page will be shown. Here you can configure additional features of the keypad, including LED brightness and passwords. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com •...
  • Page 28 • Configure the Button Press LED to be Red, and • Configure the hold for repeat with a 0.5 second hold time Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com •...
  • Page 29 • Configure the Button Press LED to be Blue, and • Configure the hold for repeat with a 0.5 second hold time Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com •...
  • Page 30 • Select button type as Normal, • Configure the Button Press LED to be Blue, and • Set the release event to ON. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com • aveosystems.com...
  • Page 31 • Select button type as Normal, • Configure the Button Press LED to be Blue, and • Set the release event to ON Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com • aveosystems.com...
  • Page 32 • Select button type as Normal, • Configure the Button Press LED to be Blue, and • Set the release event to ON Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com • aveosystems.com...
  • Page 33 • Select button type as Normal, • Configure the Button Press LED to be Blue, and • Set the release event to ON Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com • aveosystems.com...
  • Page 34 • Configure the second button press LED to be Off to indicate the system is unmuted. We’ll configure the Toggle functions in the events section. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com •...
  • Page 35 • Configure a hold event as Hold for Send • Set the hold time to 2 seconds for our example. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com •...
  • Page 36 – Label the event as Volume Down. – Select the event type to IP Command. – Set the IP Type to TCP. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com • aveosystems.com...
  • Page 37 Button 2 will be configured to increment the volume of the room. As shown in the following figure, we’ll configure the events as follows: • For Event 1: Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com • aveosystems.com...
  • Page 38 Events for Button 3: Video Input 1 Button 3 will be configured to route Input 1 of the video switcher to the display. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com •...
  • Page 39 – Set the Delay After Send value to 0.1 seconds. • The remaining events are left empty. Figure 38: Configure the events for Button 3 of the keypad. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com • aveosystems.com...
  • Page 40 – Set the Event Type to: LED Addition. – Set the Button Number to Button 6. – Set the LED Color to Off. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com • aveosystems.com...
  • Page 41 As shown in the following figure, we’ll configure the events as follows: • For Event 1: – Set the button Action to Press. – Label the event as Src 2. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com • aveosystems.com...
  • Page 42 In addition, as shown in the following figure, configure a Release event to illuminate Button 4 and to turn off the LEDs on buttons 3, 5, and 6 as follows: • Set the button Action to Release. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com • aveosystems.com...
  • Page 43 – Set the Event Type to: LED Addition. – Set the Button Number to Button 6. – Set the LED Color to Off. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com • aveosystems.com...
  • Page 44 As shown in the following figure, we’ll configure the events as follows: • For Event 1: – Set the button Action to Press. – Label the event as Src 3. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com • aveosystems.com...
  • Page 45 In addition, as shown in the following figure, configure a Release event to illuminate Button 5 and to turn off the LEDs on buttons 3, 4, and 6 as follows: • Set the button Action to Release. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com • aveosystems.com...
  • Page 46 – Set the Event Type to: LED Addition. – Set the Button Number to Button 6. – Set the LED Color to Off. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com • aveosystems.com...
  • Page 47 As shown in the following figure, we’ll configure the events as follows: • For Event 1: – Set the button Action to Press. – Label the event as Src 4. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com • aveosystems.com...
  • Page 48 In addition, as shown in the following figure, configure a Release event to illuminate Button 6 and to turn off the LEDs on buttons 3, 4, and 5 as follows: • Set the button Action to Release. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com • aveosystems.com...
  • Page 49 – Set the Event Type to: LED Addition. – Set the Button Number to Button 5. – Set the LED Color to Off.configure Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com • aveosystems.com...
  • Page 50 • Set the button Action to First Press. • Label the event as MuteOn. • Select the event type to IP Command. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com • aveosystems.com...
  • Page 51 • Set the IP Type to TCP. • Set the IP address to the IP address of the Mira Connect PC: 192.168.100.194 in this example. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com •...
  • Page 52 Finally, we’ll send the microphone mute command and set button 7 LED color to red to indicate the room is muted. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com •...
  • Page 53 • For Event 8: – Set the Event Type to LED Addition. – Set the button number to Button 8. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com • aveosystems.com...
  • Page 54 – Set the button number to Button 7. – Set the LED Color to Red to indicate the system is muted. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com •...
  • Page 55 First, we must load the configuration into the keypad. To load the configuration, navigate to the EXPORT / LOAD option and click the Load to Keypad button to load the configuration into the keypad. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com •...
  • Page 56 When presented with a confirmation regarding firmware updates after clicking Load To Keypad, click Continue. While this seems like an odd message, click Continue to load the configuration file into the keypad. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com •...
  • Page 57 Each room will have different display and source IDs and a unique API Key. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com •...

  • Page 58: Step 9 - Testing The Keypad

    For each command sent, the keypad creates a TCP connection to Mira Connect software at port 52838, sends the command, and then closes the network connection. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com •...
  • Page 59 If the display is powered off when a source is selected, Mira Connect will automatically power on the display and then choose the desired source. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com •...
  • Page 60 The KeyDigital Virtual Keypad page allows you to press buttons on the KeyDigital web interface and see the results of button presses on the physical keypad — as well as on Mira Connect’s remote control user interface. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com •...
  • Page 61 • Ensure the port for each command is set to 52838 and that TCP is enabled on the room in Mira Portal, as described in Create a Mira Connect API Key section. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com • aveosystems.com...
  • Page 62 We showed how to use different features of the KeyDigital keypad, including Press and Toggle features, Hold functions, and more. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com •...
  • Page 63 TCP connection to Mira Connect, allowing your application to easily control devices that it never could before. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com •...
  • Page 64 Mira Connect and would like to get more information. To learn how to use the Mira Connect Room Control API, see our detailed Room Control API guide. Aveo Systems, Inc. • 4455 Lower Roswell Road • #681593 • Marietta, GA 30068 Phone: +1.678.653.7090 • Email: sales@aveosystems.com • aveosystems.com...