Savant® Apple TV™ Homekit™ Deployment Guide for IP Control and Siri Integration
Total Page:16
File Type:pdf, Size:1020Kb
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