Savant® Apple TV™ Homekit™ Deployment Guide for IP Control and Siri Integration

Savant® Apple TV™ HomeKit™ Deployment Guide For IP Control and Siri Integration

Document Number: 009-1842-01 Document Date: January 2020 Document Supports: da Vinci 9.1 and Higher

This document will guide the installer through the deployment and configuration process for IP controlled Apple TV and HomeKit integration with Savant. Details covered in this Deployment Guide include but are not limited to:

• Pairing an iOS device with an Apple TV, • Creation of a HomeKit Home and customization of the Apple Home Hub, • RacePoint Blueprint configuration using the Apple TV HomeKit Component Profile, • Siri integration setup for voice control of the Apple TV via the Savant Pro Remote

Copyright © 2020 Savant Systems, LLC 45 Perseverance Way, Hyannis, MA 02601 - 1 - Savant.com | 508.683.2500 Contents To access links to the topics within this document, click the corresponding entry in the table below.

1. Requirements ...... 3

2. Apple TV Pairing Process ...... 4 2.1. Two-factor Authentication for iOS...... 4 2.2. iCloud Keychain...... 4 2.3. Apple TV iCloud Settings...... 5 2.4. Airplay 2 setup...... 5 2.5. Home Creation and Customization...... 6 2.6. Apple TV Name and tvOS Version...... 6

3. RacePoint Blueprint setup...... 7 3.1. Apple TV Profile...... 7 3.2. Siri Service Generation...... 8

4. Apple TV and HomeKit Bridge Link...... 9

5. Siri Activation...... 10

Appendix A: Unlinking the Savant Host...... 11

Appendix B: System Monitor...... 12

Appendix C: Additional Control Notes ...... 14

Appendix D: Network Topology ...... 15

Apple TV and HomeKit Deployment Guide Copyright © 2020 Savant Systems, LLC 009-1842-01 | 200103 2 of 16 1. Requirements This page lists the requirements for integration of IP controlled Apple TV and HomeKit services with existing Savant systems.

Before Beginning Read this document in its entirety and ensure that the following required items are available:

4th Generation Apple TV or later......

Apple TV running tvOS 12.0 or later......

iOS Device running iOS 12.0 or later......

An Apple ID User Account......

Two-factor authentication enabled for the Apple ID Account on the Apple TV and iOS devices......

Savant iOS Pro App Version: 9.1 or later......

HomeKit Enabled Runtime Build: da Vinci 9.1 or later......

Profile: Apple Apple TV (HomeKit)......

Remote: Savant REM-1100 / REM-2000 (required for Siri Control)......

NOTE: This document assumes that the Apple TV is already functional and uses the same Apple ID as the configuring iOS device. Other installation notes relevant to this document include:

• Savant Host Redundancy is not supported for Apple TV HomeKit deployments. • Savant Host and HomeKit Bridge linking is only supported via the Savant Pro App for iOS (version 9.1 and higher). • All devices involved in the setup process must be used on the network local to the Savant Host. • All Apple TV HomeKit Hubs must be on the same VLAN/subnet as the corresponding Savant Host HomeKit Bridge. • A valid Savant Cloud User Account with access permissions for the Savant Host must be logged in to the Savant Pro App prior to deployment.

Apple TV and HomeKit Deployment Guide Copyright © 2020 Savant Systems, LLC 009-1842-01 | 200103 3 of 16 2. Apple TV Pairing Process The following subsections detail the process for adding the Apple TV as a HomeKit Hub, and are required by Apple for successful integration with Savant.

2.1. Two-factor Authentication for iOS Apple requires that two-factor authentication be configured on the iOS device before use of any HomeKit features. Follow the steps listed below to enable 2-factor authentication

1. Navigate to the Settings menu on the iOS Device being used for configuration. 2. Select the Apple ID (user name) at the top of the Settings screen. 3. Select Password & Security, located under the Name, Phone Numbers, and Email section. 4. Add the phone number of the iOS device used to pair the Apple TV and select Done. This step determines which iOS device receives the two-factor authentication prompts, required by Apple to set up Airplay 2 as detailed in Section 2.5.

2.2. iCloud Keychain Apple requires that iCloud keychain be enabled on the Apple ID account used for setup.

1. Navigate to Settings on the iOS device being used for configuration. 2. Select the Apple ID (user name) at the top of the Settings screen. 3. Tap iCloud, located under the Subscriptions section. 4. Locate Keychain settings within the list of apps using iCloud. 5. Ensure that iCloud Keychain is enabled, displaying a green toggle button as shown in the example image. If not enabled, tap the toggle once.

Apple TV and HomeKit Deployment Guide Copyright © 2020 Savant Systems, LLC 009-1842-01 | 200103 4 of 16 2.3. Apple TV iCloud Settings The iCloud account logged in on the iOS device used for configuration and the account used on the Apple TV must be the same account.

1. Navigate to and select Settings on the Apple TV. 2. Choose Users and Accounts. 3. Ensure that the iCloud Accounts used for the Apple TV and iOS device match; displaying the same Apple ID.

2.4. Airplay 2 setup To activate Airplay on the Apple TV, go to Settings > AirPlay and HomeKit. Bluetooth must be active on the iOS device before Airplay setup on the Apple TV begins.

1. Navigate to and select Room on the Apple TV. A Start using Airplay 2 screen will populate, as shown in the image to the right. 2. In order to continue, follow the Apple TV directions in the on-screen prompt.

IMPORTANT! The configuring device must be held within 6 inches of the Apple TV once Bluetooth is enabled, or authentication may fail. 3. Unlock the iOS device used for Apple TV setup. When the device is within range of the Apple TV, a Connect prompt will appear on the iOS device. Select Connect to start the Airplay authentication process. 4. An authentication field will display on the Apple TV with a generated code. This code must be entered into the configuring iOS device’s authentication field. This is a uniquely generated code and cannot be used more than once. 5. Once the Apple TV verifies the authentication, aDone button will replace the authentication screen. Select Done to confirm that Airplay 2 is ready. NOTE: If the iOS device is not within range of the Apple TV during the authentication process setup, authentication may fail. 6. After authentication is complete, the Apple TV will display a Select Room screen. Select a room to represent the location of the Apple TV accessory in the HomeKit configuration. The example image to the right represents the Apple TV in the Living Room, but there are no limitations on the Room name or location.

Apple TV and HomeKit Deployment Guide Copyright © 2020 Savant Systems, LLC 009-1842-01 | 200103 5 of 16 2.5. Home Creation and Customization Open the Apple/HomeKit Home app on the iOS device. The Home app can be found on the Apple App Store, but comes pre-installed on all iOS devices running iOS 13.x or higher.

1. Open the Apple Home app by tapping the icon on the iOS device. 2. Select Continue from the Welcome screen. NOTE: A prompt may appear with an option labeled Add Me to Apple TV. This can be used to automatically add the Apple TV as the HomeKit Hub, pair the Apple ID with the HomeKit Home, and add the Apple TV to Favorite Accessories. However, this document will describe the process for manual pairing, as the feature may not be available in all cases.

3. Select the Home Menu button in the top left corner of the Home screen to access Home customization options. 4. Tap the Name field to enter or edit the HomeKit Home name. NOTE: “Savant” was used to represent the Home name in the example image to the right, but any name may be selected. 5. Select Take Photo... or Choose from Existing to customize the Home background. 6. When all HomeKit Home customizations are complete, select Done. 7. The Apple TV should now appear in the under Favorite Accessories.

NOTE: The iOS device may need to be power cycled after adding additional Apple TVs to the Home.

2.6. Apple TV Name and tvOS Version The Apple TV’s name in the following About page must match the Profile name in Blueprint or setup may fail.

1. Navigate to Settings > General > About to check the Apple TV and tvOS versions. 2. If the tvOS version is not tvOS 12 or later, please update it via Settings > System > Software Update.

Apple TV and HomeKit Deployment Guide Copyright © 2020 Savant Systems, LLC 009-1842-01 | 200103 6 of 16 Additional Information: When the Apple TV has been added as the HomeKit Hub, Home creation and connection is complete. If the Apple TV fails to respond to control commands from Savant following Blueprint configuration, go toSettings > Users and Accounts > iCloud > Airplay and HomeKit to verify successful HomeKit communication. For further assistance, refer to the Apple TV and HomeKit Troubleshooting Guide, available on the Savant Customer Community.

3. RacePoint Blueprint setup The following sections outline the process for integrating the Apple TV HomeKit Profile within RacePoint Blueprint.

3.1. Apple TV Profile 1. Open Savant Application Manager (SAM) on the Savant Development Environment (SDE/MacBook). 2. Launch the RacePoint Blueprint Application from SAM, and open the configuration file for the site.

3. Select the Show Library icon from the Blueprint tool bar to open the component window and search for Profiles. 4. Search for Apple TV in the component search bar. 5. Click to highlight the Apple TV (HomeKit) Profile, and drag it into the Layout frame of the configuration. A component placement window prompting Zone and Name selection will appear. 6. Click to highlight the Zone (room) in which the Apple TV will be located. 7. Under Component Name, enter the Apple TV name created in Section 2.6. The Component Profile name is used by the Host to communicate with the Apple TV, and MUST match the Apple TV name exactly. 8. Right-click the output connection of the Apple TV profile to show a list of available inputs. Select the appropriate input on the display or switcher to match the physical configuration on site. 9. Once the HDMI connection has been configured, right-click the Ethernet connection on the Profile, and choose a valid network switch port.

NOTES: Do not enter an IP address on the Apple TV Ethernet connection. Connected port on the network device in Blueprint does not need to match the physical port.

10. With all connections complete, select Generate Services from the main Blueprint toolbar.

Apple TV and HomeKit Deployment Guide Copyright © 2020 Savant Systems, LLC 009-1842-01 | 200103 7 of 16 3.2. Siri Service Generation Savant’s Pro Remotes (REM-1100 and REM-2000) support Siri integration for control via voice commands with integrated Apple TV and HomeKit services. Follow the steps below to confirm successful generation of a Siri-enabled Apple TV service.

1. With the steps in the previous section completed and services generated, the View Services window will open automatically. 2. In the Services for: drop-down, select the zone where the Apple TV has been placed. 3. Locate the AppleTV Service within the Realized Services list. If the Apple TV configuration has been completed successfully,siri will populate under the UI Mapping column for the service. 4. Save and Upload the configuration to the Savant Host.

Apple TV and HomeKit Deployment Guide Copyright © 2020 Savant Systems, LLC 009-1842-01 | 200103 8 of 16 4. Apple TV and HomeKit Bridge Link The following sections assume all prior steps have been taken and will describe how to link the Savant Host as the HomeKit Bridge from the Savant Pro App. 1. Open the Savant Pro App on the iOS device used for setup and log in using any SCS User credentials with Admin permissions for the Host. 2. From the Savant Pro App’s Home screen, select Settings in the top left corner. 3. From the Settings screen, select Device Settings > HomeKit Homes > My Home. 4. If this is the first time using HomeKit with the Savant Pro App, a prompt requesting permission to access HomeKit data will appear. Select Allow. 5. Next, an Add Accessory screen will be displayed. Select the button labeled Add to Home. 6. When the Savant Host has been located successfully, select Next in the top right corner of the Accessory screen to add the Savant Host as the HomeKit Bridge. 7. Once the Savant Host has been linked, any further accessories such as Savant Pro Remotes or Touch Panels can be added in the same way as needed. When complete, select Done at the top right corner of the Accessory screen. 8. The linked HomeKit Home will now be displayed on the Device Settings screen, as shown in the example image.

HELPFUL INFO: Savant Pro Hosts will audibly indicate “Identifying the Savant Host” during the identification process. For Savant Smart Hosts, the status light will blink amber.

Apple TV and HomeKit Deployment Guide Copyright © 2020 Savant Systems, LLC 009-1842-01 | 200103 9 of 16 5. Siri Activation Siri must be enabled in the Apple TV settings prior to using voice control on the Pro Remote. 1. On the Apple TV, ensure that Siri has been enabled by navigating to Settings > General > Siri > On. 2. Power on the Apple TV and HomeKit controlled service via the Pro Remote. 3. When the desired service populates on the screen, hold down the microphone button on the Pro remote. 4. To issue a Siri voice command, speak clearly into the microphone located on top of the Pro remote.

Apple TV and HomeKit Deployment Guide Copyright © 2020 Savant Systems, LLC 009-1842-01 | 200103 10 of 16 Appendix A: Unlinking the Savant Host To unlink the Savant Host as the HomeKit Bridge, open the Savant Pro App and navigate to Settings > Device Settings to display the currently linked HomeKit Homes. 1. Once in the Device Settings page, select the options icon (ellipsis “...”) next to HomeKit Homes. 2. Select Unlink to display a list of linked HomeKit Homes. 3. Select the HomeKit Home linked to the local Host. A confirmation window will appear. 4. Choose Unlink again to complete the process. NOTE: The unlink process should only be utilized when the Savant Host is being replaced or in cases where IP control of the Apple TVs is no longer necessary.

Apple TV and HomeKit Deployment Guide Copyright © 2020 Savant Systems, LLC 009-1842-01 | 200103 11 of 16 Appendix B: System Monitor With all deployment steps completed, System Monitor can be used to confirm successful HomeKit pairing. 1. Open SAM from the SDE. 2. Select the System Monitor application from SAM and double-click the local Host to open the System Dashboard window. 3. Select System State from the left side Dashboard. 4. Use the search bar in the top right corner of the tab and type “homekit.” 5. The state labeled “global.homekit.paired” will have a value of: 1 if deployment was successful. NOTE: System Monitor’s System State Center global.homekit. targets will populate the actual Apple TV’s name in the HomeKit Home. This name should match the Apple TV’s name assigned in Blueprint (Section 3).

Removing HomeKit Accessories When replacing HomeKit accessories, navigate to SAM > System Monitor and follow the steps listed below: 1. Power down or disconnect the accessory device before removing it from HomeKit. 2. From the System Monitor scanner window, double-click the local Host to open System Dashboard. 3. Select the Control tab within System Dashboard. The Control tab offers a Device UID search bar. 4. Enter the HomeKit accessory device’s UID and select Remove from HomeKit then confirm the selection to remove the accessory.

Factory Reset HomeKit Settings Navigate to SAM > System Monitor to use the HomeKit Accessory reset tool. This process is a hard reset, and forces the Savant Host to unpair from the HomeKit Home. 1. Within System Monitor - Scanner right-click the local Host paired to HomeKit to display the Reset HomeKit Settings option. 2. Select the Reset HomeKIt Settings to prompt a confirmation window. If this option is confirmed, HomeKit settings and accessories will need to be re-deployed and paired using the Savant Pro App.

Apple TV and HomeKit Deployment Guide Copyright © 2020 Savant Systems, LLC 009-1842-01 | 200103 12 of 16 Manually Removing Bridge from Home This method is recommended when the HomeKit Bridge (Savant Host) cannot be removed from the (Apple/HomeKit) Home using the Unlink or HomeKit Settings reset feature. 1. Open the HomeKit Home app on the iOS device, using the same Apple ID account logged in on the Apple TV. 2. Select the room (within the Home app environment) that the Host was added to through the Menu icon at the top left of the screen (in the example image to the right, a default room has been selected). 3. Tap and hold on the Host (HomeKit Bridge) until options list appears. 4. Select the Settings option at the bottom of the screen. 5. Scroll down and select the button labeled Remove Bridge from Home.

Apple TV and HomeKit Deployment Guide Copyright © 2020 Savant Systems, LLC 009-1842-01 | 200103 13 of 16 Appendix C: Additional Control Notes Additional control features of the Savant Pro App in conjunction with IP controlled Apple TV:

• The DVR and Guide buttons on the Savant Pro Remote will bring the user to the Apple TV home page.

• Double Pressing the TV icon in the top right corner of the Apple TV remote will launch the app switcher, which allows the selection of other open applications, or the termination of running applications.

• Double press/swipe the directional pad buttons (up, down, right, left) to send a swipe gesture. For example, to quit an app, double press the home button to populate the Apple TV app switcher, then double press/swipe the UP button to quit the running application.

• The Apple TV service must be active for Siri voice control to be available. If there is no Siri-enabled Apple TV service active, voice control will default to the Savant Pro Remote’s embedded voice engine.

• Savant Scenes are not supported for integrated use within HomeKit, due to a limitation of Apple support for 3rd party feature integration.

Internet Firewall Router

Wireless Access Points

Savant Host Main Switch Wireless Access HomeKit Bridge Controller

Apple TV Wiﬁ Remote HomeKit Hub HomeKit Bridge Accessory

TERMINOLOGY NOTES: Some brief descriptions of Apple® HomeKit™ related terminology: – The HomeKit Hub (Apple TV in the example above) allows for HomeKit communication outside the local network. – The HomeKit Bridge (the Savant Host in the example above) allows communication between HomeKit, the HomeKit Hub, and accessory devices which may not be supported for direct HomeKit integration, such as the Savant Pro Remote shown as an example of a HomeKit Bridge Accessory above.

Disclaimer Savant Systems, LLC. reserves the right to change product specifications without notice, therefore, the information presented herein shall not be construed as a commitment or warranty. Savant Systems, LLC. shall not be liable for any technical or editorial errors or omissions contained herein or for incidental or consequential damages resulting from the performance, furnishing, reliance on, or use of this material.

Patents Certain equipment and software described in this document is protected by issued and pending U.S. and foreign patents. All products and services are trademarks or registered trademarks of their respective manufacturer.

Copyright This document contains confidential and proprietary information protected by copyright. All rights reserved. Copying or other reproduction of all or parts of this document is prohibited without the permission of Savant Systems.

Trademarks © 2020 Savant Systems, LLC. All rights reserved. Savant, Savant App, TrueImage, Savant Host, Now You Can, RacePoint Blueprint, Single App Home, TrueCommand, TrueControl, and the Savant logo are trademarks of Savant Systems, LLC. AirPlay, Apple, AirPort Express, AirPort Extreme, Apple TV, Apple Remote Desktop, FireWire, iMac, iTunes, iPad, iPad mini, iPad Air, iPhone, MacBook, Mac and OS X are trademarks or trade names of Apple Inc. iOS is a trademark of Cisco®. Android, Google, Google Play, and other Google marks are trademarks of Google, Inc. Wi-Fi is a registered trademark of the Wi-Fi Alliance®. HDMI® is a trademark of HDMI Licensing, LLC. MOTU® is a registered trademark of Mark of the Unicorn, Inc. Luxul is a registered trademark of Luxul Wireless. NETGEAR®, the NETGEAR Logo and ProSAFE are trademarks of NETGEAR, Inc. Extreme™ is a trademark of Extreme Networks, Inc. All other brand names, product names, and trademarks are the property of their respective owners.

Technical and Sales Support Savant Systems, LLC is dedicated to providing prompt and effective support in a timely and efficient manner. – To contact Savant Support, access the Savant Customer Community and enter a support Case ticket. – To contact Savant Sales, visit Savant.com and select Contact Us to locate a local sales representative in your area.