!

Smart Host with Control SHC-2000-xx

Deployment Guide Document Number: 009-1332-03 Document Date: November 2016 Document Supports: da Vinci 8.1

Smart Host with Control Deployment Guide Copyright © 2016 Systems, LLC 009-1332-03 | 161107 1 of 33

Contents To access the link to the topics in this document, click the topic page.

Important Safety Information - Read First ...... 3 7. Smart Host Configuration ...... 20 1. Introduction ...... 4 Querying and Configuring IP Address and DNS Server ...... 20 Change the Host User Password ...... 21 2. Deployment Steps ...... 5 Setting Up Remote Access ...... 22 Setting Up Mail (Gmail Only) for Notifications ...... 22 3. SHC-2000 Overview ...... 6 Box Contents and Specifications ...... 6 8. Running Scripts ...... 23 Rear Panel ...... 6 Dimensions ...... 7 9. Troubleshooting ...... 25 System Diagram ...... 8 Additional Information ...... 29

4. Installation ...... 9 Appendix A: Network Requirements ...... 30 Rack Installation ...... 9 Wall Bracket Installation ...... 9 Appendix B: Document Revision History ...... 31 Ethernet Connection ...... 9 Audio Output Connection ...... 9 Important Notice ...... 32 Control Connections ...... 10 AC Power Connection ...... 13 5. Rules for Deploying Smart Hosts ...... 14 6. Blueprint Configuration ...... 15 Basic Blueprint Layout ...... 15 Replacing a Host in a Configuration ...... 16 Adding a Smart Host to a Configuration ...... 17 Adding Connections for Relays and GPIOs ...... 17 Adding a Doorbell or Door Station ...... 18 Savant Music ...... 18

Smart Host with Control Deployment Guide Copyright © 2016 Savant Systems, LLC 009-1332-03 | 161107 2 of 33

Important Safety Information - Read First Safety Statements Before installing, configuring, and operating Savant equipment and Follow all of the safety instructions listed below and apply where other vendor equipment, Savant recommends that each dealer, installer, applicable. Additional safety information will be included where etc. access and read all the required technical documentation. Savant applicable. technical documentation can be located by visiting Savant.com. Vendor documentation is supplied with the equipment. 1. Read these instructions. Read and understand all safety instructions, cautions, and warnings in 2. Keep these instructions. this document and the labels on the equipment. 3. Heed all warnings. 4. Follow all instructions. Safety Classifications In this Document 5. Do not use this apparatus near water. Provides special information for installing, configuring, 6. Clean only with dry cloth. Note: and operating the equipment. 7. Do not block any ventilation openings. Install in accordance with the Provides special information that is critical to manufacturer's instructions. IMPORTANT! installing, configuring, and operating the equipment. 8. Do not install near any heat sources such as radiators, heat Provides special information for avoiding situations registers, stoves, or other apparatus (including amplifiers) that CAUTION! that may cause damage to equipment. produce heat. Provides special information for avoiding situations 9. Do not defeat the safety purpose of the polarized or grounding- WARNING! that may cause physical danger to the installer, end type plug. A polarized plug has two blades with one wider than the user, etc. other. A grounding type plug has two blades and a third grounding prong. The wide blade or the third prong is provided for your safety. If the provided plug does not fit into your outlet, consult an electrician for replacement of the obsolete outlet. Electric Shock Prevention 10. Protect the power cord from being walked on or pinched ELECTRIC SHOCK! The source power poses an electric shock hazard particularly at plugs, convenience receptacles, and the point where that has the potential to cause serious injury to installers and end they exit from the apparatus. users. 11. Only use attachments/accessories specified by the manufacturer. ELECTRICAL DISCONNECT: The source power outlet and power 12. Use only with the cart, stand, tripod, bracket, or table specified by supply input power sockets should be easily accessible to the manufacturer, or sold with the apparatus. When a cart is used, disconnect power in the event of an electrical hazard or use caution when moving the cart/apparatus combination to avoid malfunction. injury from tip over. 13. Unplug this apparatus during lightning storms or when unused for Weight Injury Prevention long periods of time. 14. Refer all servicing to qualified service personnel. Servicing is WEIGHT INJURY! Installing some of the Savant equipment requires required when the apparatus has been damaged in any way, such as two installers to ensure safe handling during installation. Failure to power supply cord or plug is damaged, liquid has been spilled or use two installers may result in injury. objects have fallen into the apparatus, the apparatus has been exposed to rain or moisture, does not operate normally, or has been dropped. 15. To completely disconnect this equipment from the AC mains, disconnect the power supply cord plug from the AC receptacle.

Smart Host with Control Deployment Guide Copyright © 2016 Savant Systems, LLC 009-1332-03 | 161107 3 of 33

1. Introduction This Deployment Guide will guide the installer through the process of installing, configuring, and adding a Savant Smart Host with Control to a RacePoint Blueprint® configuration.

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

Savant Smart Host with Control (SHC-2000-xx) ......

da Vinci 7.2 or higher Runtime for host upgrade ......

Smart Standard License 7.1 or higher ......

Unique ID (UID) and MAC Address of the Smart Host ......

Savant Development Environment (SDE/MacBook®) ...... RacePoint Blueprint da Vinci 7.2 or higher

Ethernet network meeting Savant requirements ...... See Appendix A: Network Requirements

Smart Host with Control Deployment Guide Copyright © 2016 Savant Systems, LLC 009-1332-03 | 161107 4 of 33

2. Deployment Steps Follow these steps to successfully deploy a Savant Smart Host. This page can be used as a checklist to record which steps have been completed.

1. Review product specifications and connection details ...... See SHC-2000 Overview

2. Install the Smart Host ...... See Installation

3. Update the Smart Host to the latest version of da Vinci ...... Follow the instructions contained in the da Vinci Installation and Upgrade Deployment Guide located on the Savant Customer Community to upgrade the Smart Host.

4. Add the host into a RacePoint Blueprint® configuration ...... See Blueprint Configuration

5. Install an OS Runtime License on the host ...... Refer to the Savant Runtime Operating System Licensing Application Note located on the Savant Customer Community.

Smart Host with Control Deployment Guide Copyright © 2016 Savant Systems, LLC 009-1332-03 | 161107 5 of 33

3. SHC-2000 Overview

Box Contents and Specifications Refer to the Quick Reference Guide for this product located on the Savant Customer Community for Box Contents and Specifications.

Rear Panel

Press and hold for 5 seconds while powered On to clear Ethernet settings. Status LED will Reset blink rapidly when reset is complete. (hole) NOTE: This will reset the network settings to factory defaults. Any static IP Addresses will be lost.

Power Input 5V DC 3A - Connect to included power supply.

Off: Disconnected from power supply. Amber: Controller is booting/rebooting and is disconnected from the network. Status LED Amber Flashing: Smart Host is not connected to a Ethernet network. Green: Connected to Ethernet.

Digital Audio TOSLink (Optical) digital audio output. Output Connect to digital optical audio input on switcher for using the Audio Interrupt Service (AIS) and Savant Music.

8-pin RJ-45 female. Ethernet 10/100/1000 Base-T auto-negotiating port.

8-pin RJ-45 female. Used to transmit and receive serial binary data to and from serial controllable devices. RS-232 Ports 1-2 RS-232 - CTS/RTS handshaking. CTS/RTS Handshaking availability based on component profile. See RS-232 Wiring for pinouts.

6-pin Screw Down Plug-in Connector. IR Used to send IR signals to control devices with an IR input or IR receiver via an IR flasher (5V tolerant only) See IR Wiring for important precautions regarding IR functionality before making any connections.

Smart Host with Control Deployment Guide Copyright © 2016 Savant Systems, LLC 009-1332-03 | 161107 6 of 33

3-pin Screw Down Plug-in Connector. See Relay Wiring for pinouts. Relay Normally Open (NO) Normally Closed (NC) to control devices requiring basic On/Off operation. DC Voltage Max: 30V DC 1A.

3-pin Screw Down Plug-in Connector. See GPIO Wiring for pinouts. GPIO Input: When configured as an input, the processor will look for a low (<0.8V DC) or a high (>2.4V DC ) state. Minimum 0V DC / Maximum 12V DC. GPIO NOTE: Amperage of the connected device will not affect the GPIO input as long as the incoming voltage does not exceed 12V DC. GPIO Output: When configured as an output, the port provides a binary output of 0-12V DC 150mA max.

Dimensions

Smart Host with Control Deployment Guide Copyright © 2016 Savant Systems, LLC 009-1332-03 | 161107 7 of 33

System Diagram The SHC-2000 Smart Host with control combines the User Interface (UI) interpretations, system administration, and monitoring of a Savant Host with the control functions of a Savant Controller. This allows for the SHC-2000 to perform all the functions that create Savant’s high-level automation and control with a single device.

Smart Host with Control Deployment Guide Copyright © 2016 Savant Systems, LLC 009-1332-03 | 161107 8 of 33

4. Installation The Smart Host can be installed on a solid, flat, level surface such as a table, cabinet or shelf, or wall mounted using the included 2 piece bracket. The location should be dry, well ventilated, and out of direct sunlight. When placing the Smart Host on a shelf, the wall bracket must not be installed to allow for a flat, level installation.

Rack Installation The optional RCK-3000-xx provides a ventilated shelf for mounting up to 2 Smart Hosts. When rack mounting the Smart Host, the wall bracket must not be installed to allow for a flat, level installation.

Wall Bracket Installation A 2 piece wall bracket is included that can be used to mount the Smart Host to a wall or back of a cabinet. 1. Attach the host bracket to the rear of the host using the included M3x6 mm flat head Phillips screws. 2. Attach the wall bracket to the wall. Screws to attach are not included. 3. Position the host over the wall bracket and gently slide into place.

Ethernet Connection The Smart Host communicates with other devices on the network via a Ethernet connection. For more information on using Ethernet, refer to Appendix A: Network Requirements.

Audio Output Connection The audio output on the host is used for Savant Music and Audio Interrupt Service (AIS). Connection to this output varies based on the Savant Audio Matrix or 3rd party switcher being used. Refer to the following sections within this document and documents located on the Savant Customer Community for more information on using the Audio Output connections. • Section Savant Music • Audio Interrupt Service (AIS) Configuration for Doorbell Application Note Smart Host with Control Deployment Guide Copyright © 2016 Savant Systems, LLC 009-1332-03 | 161107 9 of 33

Control Connections The Smart Host control connections send data to control a device and receive data to display current status on the user interfaces or trigger a system action. Each port type may support multiple protocols that are determined by the logical connection within Blueprint.

TIPS: • Savant recommends planning control connections and protocols to be used prior to building any cables and connecting equipment. This will ensure that devices will respond to commands and will not be damaged by an incorrect cable configuration. • When installing wire in screw down terminals, strip a 1/4 inch of insulation from the each wire and twist the strands together. This will allow for the exposed wire to be inserted into the terminal up to the insulation eliminating stray strands that may cause shorting.

RS-232 Wiring

RS-232 Pinout

NOTE: CTS/RTS handshaking is supported for flow control based on the profile used in the configuration. RJ-45 to DB9 Serial Control Adapters Refer to the RS-232 Conversion to DB9 and RS-422/485 Pinout Application Note located on the Savant Customer Community for more information on RJ-45 to DB9 adapters. Note: The SHC-2000 does not support RS-422/485.

IMPORTANT! If you are using RJ-45 to DB9 adapters not supplied by Savant: • Ensure that any wires required for communication/control are terminated within the adapter. • Ensure that all wires NOT required for communication/control are NOT terminated in the connector. • Ensure that the unused wires in the connector are cut to prevent them from shorting out, as they are still terminated in the RJ-45 connector on the controller side. Smart Host with Control Deployment Guide Copyright © 2016 Savant Systems, LLC 009-1332-03 | 161107 10 of 33

IR Wiring IR connections are made using 6-pin Screw Down Plug-in Connectors supplied with the Smart Host. The wire slips into the hole and locks with a screw located at the top of the connector.

IMPORTANT! IR Wiring Precautions • Ensure that all IR emitters are within 15 feet (4.6 meters) from the controller’s location. • Use of 3rd party flashing IR emitters with Talk Back is not recommended. These types of emitters can draw voltage away from the IR signal that can degrade IR performance. IR Pinout

NOTE: While not shown in the diagram above, IR connections 4 to 6 follow the same wiring as 1 to 3.

Smart Host with Control Deployment Guide Copyright © 2016 Savant Systems, LLC 009-1332-03 | 161107 11 of 33

Relay Wiring Relay ports are used when a device is controlled via a normally open (NO) or normally closed (NC) relay.

Relay Pinout

Smart Host with Control Deployment Guide Copyright © 2016 Savant Systems, LLC 009-1332-03 | 161107 12 of 33

GPIO Wiring General Purpose Input/Outputs (GPIO) are binary I/O ports used on Savant controllers to trigger an action within the system. Events can control a device, such as turning on an amplifier (output) or detecting a state change for a device (input) to perform a workflow. Pin 1 is used for input or output depending on configuration. See item I under Rear Panel for GPIO voltage ratings.

GPIO Pinout

GPIO Pull Down Resistor (PD) Usage GPIO pins configured as inputs are pulled high to 12V while the host is booting up. To make the GPIO signal low (< 0.8V) during a host reboot and/or a power cycle, attach the GPIO 1 pin to the PD pin. The PD pin is a 1K ohm pull down resistor (to signal ground) which keeps the GPIO output below 0.8V during processor boot times. See item I under Rear Panel for GPIO voltage ratings.

AC Power Connection SURGE PROTECTION! Use a surge-protected circuit for all components and power supplies requiring 100-240V AC 50/60 Hz source power.

ELECTRICAL DISCONNECT! The source power outlet and power supply input power sockets should be easily accessible to disconnect power in the event of an electrical hazard or malfunction.

Power Management Recommendations Savant recommends a pure sine wave uninterruptible power supply (UPS) with the ability to shut down the Savant Host before the battery runs out of power. Never remove power from the Savant Host before shutting it down.

Smart Host with Control Deployment Guide Copyright © 2016 Savant Systems, LLC 009-1332-03 | 161107 13 of 33

5. Rules for Deploying Smart Hosts While Blueprint will enforce various restrictions for placing a Smart Host onto a configuration, rules listed below will not contain warning messages within Blueprint. Read through this section carefully before starting or updating a configuration to ensure that the system will function once the configuration is uploaded.

Device Features and Zones Supported by Smart Hosts • Refer to the Savant Host Comparison Guide located on the Savant Customer Community for a list of the available features before starting Blueprint configuration.

Use of Custom Automator Workflows and Applescripting • Only Savant Automator actions, Apple's Pause, or Run Shell Script actions can be used. All other actions will be ignored. NOTE: Functions such as email can be programmed using the Run Shell Script action. See Setting Up Mail (Gmail Only) for Notifications for more information. • Applescripting is not supported on Smart Hosts. Another scripting language and the Savant Command Line Interface Bridge (sclibridge) must be used. See Running Scripts for more details.

Smart Host Used as a Master Host • There can only be a Smart Host as a master host. • Smart Hosts cannot be used elsewhere in the system.

Smart Host Replacing a Master Pro Host • There can only be a Smart Host as a master host. • Smart Hosts cannot be used elsewhere in the system.

Pro Host Used as the Master Host • Smart Hosts cannot be used elsewhere in the system.

Pro Host Replacing a Master Smart Host • Smart Hosts cannot be used elsewhere in the system.

Smart Host with Control Deployment Guide Copyright © 2016 Savant Systems, LLC 009-1332-03 | 161107 14 of 33

6. Blueprint Configuration When a Blueprint configuration is created, a host is automatically added to the Zone Component List, however it is not added to the Layout view. The host for configuration must be placed in the Layout view in order for services to be generated. NOTE: If the host at the top of the Zone Component List is not an SHC-2000, follow the steps outlined in Replacing a Host in a Configuration before adding the host to the Layout view. Required Devices • Smart Host with Control (SHC-2000) Optional Devices • IR Controllable Devices • Serial (RS-232) Controllable Devices • Contact Closure (Relay) Controllable Devices • Voltage Trigger (GPIO) Controllable Devices • IP (Ethernet) Controllable Devices - Not shown in diagram.

Basic Blueprint Layout

Smart Host with Control Deployment Guide Copyright © 2016 Savant Systems, LLC 009-1332-03 | 161107 15 of 33

NOTE: This section only shows the placement of the host in a configuration. Refer to the Deployment Guide for the appropriate Savant chassis for details on connecting the Smart Host with Control within Blueprint.

Replacing a Host in a Configuration Starting with da Vinci 6.0, the type of host that is used when a new configuration is created can be set to either a Pro Host or a Smart Host. If a Pro Host or a different model Smart Host exists in the configuration, follow these steps to replace the existing master host with an Savant Smart Host with Control. 1. In an open Blueprint configuration, open the Component Library by navigating to: View > Show Component Library 2. Enter SHC into the Search field. 3. Select the Savant Host with Control in the list and drag it onto the host at the top of the Zone Component List.

4. Select Replace when prompted. 5. At the top of the Zone Component List, select the host and drag it onto the Layout view. 6. Enter the unique Device Name and the Savant ID for the the host. The Savant ID is used to identify the host on the network so that a configuration may be uploaded to the host. A. Select the host in the Layout view and open the Inspector by navigating to: View > Show Inspector B. Enter a Device Name that is unique to the system.

Tip: Savant recommends using the customer’s last name and a number unique to the customer followed by Savant Host. Example: Jones45 Savant Host

C. Enter the Savant ID for the host.

Smart Host with Control Deployment Guide Copyright © 2016 Savant Systems, LLC 009-1332-03 | 161107 16 of 33

Adding a Smart Host to a Configuration Configurations containing a host other than an SHC-2000 will need to have the host replaced prior to placing it in the Layout view. If the host at the top of the Zone Component List is not an SHC-2000, follow the steps outlined in Replacing a Host in a Configuration before proceeding with the following steps. 1. In an open Blueprint configuration, select the host at the top of the Zone Component List and drag it onto the Layout view.

2. Enter a unique Device Name and the Savant ID for the host. The Savant ID is used to identify the host on the network so that a configuration may be uploaded to the host. A. Select the host in the Layout view and open the Inspector by navigating to: View > Show Inspector B. Enter a Device Name that is unique to the system.

TIP: Savant recommends using the customer’s last name and a number unique to the customer followed by Savant Host. Example: Jones45 Savant Host

C. Enter the Savant ID for the host.

Adding Connections for Relays and GPIOs Relays and GPIOs can be connected to a device directly when the profile for the device contains an appropriate connection. In some cases, Relay and GPIO profiles are needed, these profiles can be found in the Blueprint component library. Refer to the Relay and General Purpose Input/Output Profiles Application Note located on the Savant Customer Community for details on using these profiles.

Smart Host with Control Deployment Guide Copyright © 2016 Savant Systems, LLC 009-1332-03 | 161107 17 of 33

Adding a Doorbell or Door Station The Smart Host supports the Audio Interrupt Service (AIS) which is used to interrupt the currently playing audio with a doorbell chime alerting the user that a doorbell has been pressed. This service requires a connection between the Smart Host and a Savant Audio Matrix or 3rd party audio matrix. Refer to the Audio Interrupt Service (AIS) Configuration for Doorbell Application Note located on the Savant Customer Community for information on using AIS.

Savant Music The SHC-2000 has a built in single stream media player. This allows the use of popular music streaming services like Pandora or Spotify (streaming music service fee may apply). For a full list supported services, see the product page in the store at Savant.com. This feature is only available in 8.0 or higher. To enable the Savant Music service all that is needed is an audio connection from the host with a complete service path. The resource is enabled by default.

Savant Music License There is a required Music license to activate the service. The Music License is applied in System Monitor, shown below.

For more information on Licenses, see the Savant Host Runtime License: Application Note on the Savant Customer Community.

Smart Host with Control Deployment Guide Copyright © 2016 Savant Systems, LLC 009-1332-03 | 161107 18 of 33

Once the license has been applied there is an additional screen in System Monitor. The streaming services are managed in the Savant Pro App. Streaming services can be disabled from System Monitor.

Smart Host with Control Deployment Guide Copyright © 2016 Savant Systems, LLC 009-1332-03 | 161107 19 of 33

7. Smart Host Configuration The Smart Host does not contain a Graphical User Interface (GUI). Terminal is used to enter Secure Shell (SSH) commands. This section explains the commands and how they are used within Terminal. NOTE: This section contains commands to enter into Terminal and other applications. Copying this content from this document may change the formatting required by the application. Verify the command after copying to ensure that the command will function as required.

Querying and Configuring IP Address and DNS Server By default, the Smart Host is set to DHCP. Changing this to static requires accessing the Smart Host via Terminal. NOTE: DNS Server addresses can only be added to Smart Hosts with static IP Addresses. DHCP will override any custom DNS Addresses. 1. Launch the Savant Application Manager (SAM). 2. Select the appropriate da Vinci release for the host and click Activate. 3. Open System Monitor by selecting it in the right side menu. 4. In an open System Scanner window, select the Savant Smart Host. 5. Click Terminal in the menu bar to open a session to the selected host.

6. When prompted, enter the password for the host. Default: RPM 7. In the open Terminal window enter a command to perform from the list below: For help on the setIPAddress --help commands: Query the Current setIPAddress Address and Mode: Example of Terminal Window: setIPAddress eth0: setup for DHCP eth0 Link encap:Ethernet HWaddr ec:a8:6b:f6:8b:df inet addr:10.5.200.155 Bcast:10.5.200.255 Mask:255.255.255.0 UP BROADCAST RUNNING MULTICAST MTU:1500 Metric:1 RX packets:314715 errors:0 dropped:0 overruns:0 frame:0 TX packets:33460 errors:0 dropped:0 overruns:0 carrier:0 collisions:0 txqueuelen:1000 RX bytes:113254559 (108.0 MiB) TX bytes:5705141 (5.4 MiB) Interrupt:20 Memory:f7c00000-f7c20000

Smart Host with Control Deployment Guide Copyright © 2016 Savant Systems, LLC 009-1332-03 | 161107 20 of 33

Set to Static IP: setIPAddress -static -address x.x.x.x -netmask x.x.x.x -gateway x.x.x.x Substitute x.x.x.x with the appropriate addresses. A message will appear to confirm the requested change. After confirming (y), the connection to the host will be lost as the IP Address has changed. Close the Terminal window after confirming and entering password for host RPM user. Set to DHCP: setIPAddress –DHCP A message will appear to confirm the requested change. After confirming (y), the connection to the host will be lost as the IP Address has changed. Close the Terminal window after confirming and entering password for host RPM user. Add a DNS Server setDNSServer -add -address x.x.x.x Address to the list Remove a DNS Server setDNSServer -remove -address x.x.x.x Address from the list: Query Current DNS setDNSServer Server Information: Example of Terminal Window: servername 8.8.8.8 servername 8.8.4.4

Change the Host User Password For security purposes, especially with remote access for dealers, Savant is providing a command line utility to easily change the password of the Smart Host. NOTE: Passwords should be at least 10 characters long and include numbers, symbols, and capital letters. 1. Launch the Savant Application Manager (SAM). 2. Select the appropriate da Vinci release for the host and click Activate. 3. Open System Monitor by selecting it in the right side menu. 4. In an open System Scanner window, select Savant Smart Host. 5. Click Terminal in the menu bar to open a session on the selected host. 6. In the open Terminal window type: savantSetPassword 7. When prompted, enter the current password 8. When prompted, enter the new password 9. Once the password has been changed, reboot the Smart Host to ensure the security changes are applied to all processes.

Smart Host with Control Deployment Guide Copyright © 2016 Savant Systems, LLC 009-1332-03 | 161107 21 of 33

Setting Up Remote Access By enabling remote access, the host can be accessed remotely from outside the local network. This can come in handy to troubleshoot or upgrade a system from a remote location.

IMPORTANT! Savant strongly recommends that the host’s password is changed from the default when enabling Remote Access. Once enabled, the host will be on the Internet and accessible from outside the local network. 1. Change the user password. Follow the steps in section Change the Host User Password. 2. Setup firewall to forward TCP port 22 to the host.

IMPORTANT! Savant very strongly recommends the public port on the firewall is not set to port 22 as it is used by the host. Instead, map a non-standard public port (for example, any number between 2000-10000) to port 22. This will result in better network security. Once remote access is enabled and the ports forwarded in the firewall, the host can be accessed using Secure Communication Mode within System Monitor.

Secure Communication Mode selected in System Monitor Enter in the IP Address or Internet DNS name of the home system. When using a non-standard SSH port, append the port to the host name as : (colon, then port number). So if you use public port 2149 on the firewall, then the host would be Host:2149 When prompted, enter the username (RPM) and password of the host.

Setting Up Mail (Gmail Only) for Notifications The Smart Host may be setup to send notifications via email or text using workflows. Refer to the How to Configure a Host to Send an Email/SMS Text Notification from a Triggered Workflow located on the Savant Customer Community for more information.

Smart Host with Control Deployment Guide Copyright © 2016 Savant Systems, LLC 009-1332-03 | 161107 22 of 33

8. Running Scripts Custom workflows and scripts created within Blueprint are copied to the host when the configuration is uploaded. However, scripts that are created outside of Blueprint using Automator or will need to be copied to the host for the system to access them. These items will need to be placed on the Smart Host by using SSH commands. NOTE: This section contains commands to enter into Terminal and other applications. Copying this content from this document may change the formatting required by the application. Verify the command after copying to ensure that the command will function as required.

IMPORTANT! Smart Hosts can only run scripts containing Savant Commands located under Actions > Other within Automator. Do not copy scripts containing MAC commands as they will not function on a Smart Host and may render the system unresponsive.

Recalling Script Files If you are currently running scripts added by using the Customer Files folder in the Tools > Customer and Provider Info dialog, the location of these files is different on a Smart Host. Refer to Tools Menu - Channel Listings Editor, Customer and Provider Information: RacePoint Blueprint Programming Guide located on the Savant Customer Community for details on adding Customer Files.

Files that have been added to Customer Files are located under the following path on a Smart Host: /home/RPM/GNUstep/Library/ApplicationSupport/RacePointMedia/userConfig.rpmConfig/CustomerFiles

Smart Host with Control Deployment Guide Copyright © 2016 Savant Systems, LLC 009-1332-03 | 161107 23 of 33

Executing Scripts on the Master sclibridge is a command line program on the host used to interact with the Savant control system for advanced customization.

Smart Host (Linux OS) Location: /usr/local/bin/sclibridge Custom scripts and workflows need to be aware of this difference. You can use a common UNIX utility called 'uname' to determine which platform your script is running on and adjust accordingly. #!/usr/bin/perl -w

$osType = `uname`; chomp($osType);

$sclibridge = undef;

if($osType eq "Linux OS") { print "Running on Linux\n"; $sclibridge = "/usr/local/bin/sclibridge"; } elsif($osType eq "Mac OS") { print "Running on Darwin\n"; $sclibridge = "/Users/RPM/Applications/RacePointMedia/sclibridge"; } else { print "Running on Unknown: $sclibridge\n"; }

Smart Host with Control Deployment Guide Copyright © 2016 Savant Systems, LLC 009-1332-03 | 161107 24 of 33

9. Troubleshooting When a problem with the operation of a host is discovered, logs can be pulled that contain information about the host and what action was being performed when the problem occurred. These logs are used by Savant Support to help locate the problem and provide a solution quickly.

Retrieving Logs 1. Launch the Savant Application Manager (SAM) on the SDE, and click Activate next to the desired release if necessary. 2. Open System Monitor by selecting it in the right side menu. 3. Select the Savant Smart Host in the list. 4. Click Get Logs on the top menu bar.

5. A dialog window will open to save the report that provides the following options:

A. Save As: Select a name that identifies the file. Example: LinuxHost_2014-01-27-102552_DiagnosticReports B. Where: Location to Save the report. C. Clear Reports: When checked, all reports on the host will be cleared after saving the log file. D. Download: Click to download the report.

Smart Host with Control Deployment Guide Copyright © 2016 Savant Systems, LLC 009-1332-03 | 161107 25 of 33

Stop/Start the host During troubleshooting, stopping the host by stopping the OS may be required. Stopping the Host via System Monitor Processes Tab NOTE: Before stopping the host using this method, write down the IP Address so that it can be restarted using the Command Line method below. 1. Launch the Savant Application Manager (SAM). 2. Select the appropriate da Vinci release for the host and click Activate. 3. Open System Monitor by selecting it in the right side menu. 4. In an open System Scanner window, select the Savant Smart Host. 5. Click Connect, or double-click the selected host. 6. In an open System Dashboard window, select the Processes tab on the left. 7. In the Remote Management section, select System Stop to stop the host.

Stopping and Starting via Command Line 1. Launch the Savant Application Manager (SAM). 2. Select the appropriate da Vinci release for the host and click Activate. 3. Open System Monitor by selecting it in the right side menu. 4. In an open System Scanner window, select the Savant Smart Host. 5. Click Terminal in the menu bar to open a session on the selected host. 6. At the command prompt, type one of the following commands: • stopSavantSystem

• startSavantSystem

Smart Host with Control Deployment Guide Copyright © 2016 Savant Systems, LLC 009-1332-03 | 161107 26 of 33

Uploading Configuration to the Host The preferred method for uploading configurations to the host is using the Up Load to Master button in Blueprint or the Upload button in System Monitor. When a connection to the host in Blueprint or System Monitor is not available, Terminal may be used as an alternative. 1. Launch the Savant Application Manager (SAM). 2. Select the appropriate da Vinci release for the host and click Activate. 3. Open System Monitor by selecting it in the right side menu. 4. In an open System Scanner window, select the Savant Smart Host. 5. Click Upload to start the upload process. 6. Click Browse and then navigate to the SDE folder containing the configuration file to upload. 7. Select the configuration file in the folder and click Open. 8. In the open dialog showing the selected file, click Upload.

Smart Host with Control Deployment Guide Copyright © 2016 Savant Systems, LLC 009-1332-03 | 161107 27 of 33

Copying the Configuration File to the SDE The preferred method for downloading configurations to the SDE is using the Get Config button in System Monitor. 1. Launch the Savant Application Manager (SAM) on the SDE, and click Activate next to the desired release if necessary. 2. Open System Monitor by selecting it in the right side menu. 3. Select the Savant Smart Host in the list. 4. Click Get Config on the top menu bar.

5. A dialog window will open to save the report that provides the following options:

A. Save As: Select a name that identifies the file. Example: SmartHost_2016-03-22-102552_config.tgz B. Where: Location to Save the configuration. C. Download: Click to download the configuration.

Testing Profiles Without Automator Profiles may be tested directly from the host without using Automator by running a command. Refer to the Testing Component Actions Without Automator Application Note located on the Savant Customer Community for details.

Smart Host with Control Deployment Guide Copyright © 2016 Savant Systems, LLC 009-1332-03 | 161107 28 of 33

Additional Information Refer to the following documents located on the Savant Customer Community for additional information. • Savant Smart Host (SHC-2000) Quick Reference Guide • Audio Interrupt Service (AIS) Configuration for Doorbell Application Note • Relay and General Purpose Input/Output Profiles Application Note • Retrieving and Setting IP Addresses for Savant Devices Application Note

Smart Host with Control Deployment Guide Copyright © 2016 Savant Systems, LLC 009-1332-03 | 161107 29 of 33

Appendix A: Network Requirements Savant requires the use of business class/commercial grade network equipment throughout the network to ensure the reliability of communication between devices. These higher quality components also allow for more accurate troubleshooting when needed.

Device Network Connections Connect all Savant devices to the same local area network (LAN) or subnet as the host. Savant recommends not implementing any type of traffic or packet shaping in your network topology for the Savant devices as this may interfere with performance.

Managing IP Addresses To ensure that the IP Address will not change due to a power outage, a static IP Address or DHCP reservation should be configured. Savant recommends using DHCP reservation within the router. By using this method, static IP Addresses for all devices can be managed from a single UI avoiding the need to access devices individually. Setting a Static IP Address Refer to Querying and Configuring IP Address for details on how to set a static IP Address. Setting DHCP Reservation Setting DHCP reservation varies from router to router. Refer to the documentation for the router to configure DHCP reservation.

Network Changes Savant recommends performing one of the following steps to refresh the IP connection after connecting to a new network, changing routers, or if the IP Address range is changed in the current router. This will reset any IP connection and ensure that the host is communicating with the network correctly. • Cycle Power 1. Disconnect the Smart Host from the DC power source. 2. Wait 15 seconds and then reconnect.

• Hot Plug the Ethernet (LAN) Connection 1. Disconnect the Ethernet (LAN) connection from the controller. 2. Wait 15 seconds and then reconnect.

Smart Host with Control Deployment Guide Copyright © 2016 Savant Systems, LLC 009-1332-03 | 161107 30 of 33

Appendix B: Document Revision History

009-1332-03 – November 2016 Section Update

All section Format update.

Savant Music Removed outdated information.

009-1332-02 – April 2016 Section Update

Savant Music Section added for the new built in Savant Music Media Server.

Deployment Steps, SHC-2000 Overview, Removed Wi-Fi because it’s unsupported. Wi-Fi Configuration, Troubleshooting

Stop/Start the host Removed redundant information on stopping the host.

009-1332-01 - June 2015 Section Update

Added new commands to setDNSServer addresses using terminal for Smart Host Querying and Configuring IP with static IP Addresses. Section name is new to accommodate the additional Address and DNS Server material.

009-1332-00 - May 2015 Section Update

All Initial releases of this Deployment Guide

Smart Host with Control Deployment Guide Copyright © 2016 Savant Systems, LLC 009-1332-03 | 161107 31 of 33

Important Notice

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 © 2015 Savant Systems, LLC. All rights reserved. Savant, Savant App, 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. Autonomic® and TuneBridge® are registered trademarks of Autonomic Controls, Inc. MOTU® is a registered trademark of Mark of the Unicorn, Inc. Luxul is a registered trademark of Luxul Wireless. 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.

Smart Host with Control Deployment Guide Copyright © 2016 Savant Systems, LLC 009-1332-03 | 161107 32 of 33

Regulatory The following statements are applicable to the Smart Host SHC-2000.

FCC Regulations 15.19. This device complies with part 15 of the FCC Rules. Operation is subject to the following two conditions: (1) This device may not cause harmful interference, and (2) these devices must accept any interference received, including interferences that may cause undesired operation. 15.21. The changes or modifications not expressly approved by the party responsible for compliance could void the user's authority to operate the equipment. 15.105. This equipment has been tested and found to comply with the limits for CLASS B digital device, pursuant to Part 15 of FCC Rules. These limits are designed to provide reasonable protection against harmful interference when the equipment is operated in a residential environment. This equipment generates, uses and can radiate radio frequency energy and, if not installed and used in accordance with the instructions, may cause harmful interference to radio communications, However there is no guarantee that interference will not occur in a particular installation, If this equipment does cause harmful interference to radio or television reception, which can be determined by turning the equipment off and on, the user is encouraged to try to correct the interference by one or more of the following measures: - Reorient or relocate the receiving circuit different from that to which receiver is connected. - Increase the separation between the equipment and the receiver. - Consult the dealer or experienced radio/TV technician for help.

IC Regulations RSS-Gen 7.1.3. This device complies with Industry Canada license-exempt RSS standard(s). Operation is subject to the following two conditions: (1) These devices may not cause interference, and (2) These devices must accept any interference, including interference that may cause undesired operation of the device. RSS-21- Annexe 9: A 9.4. Le présent appareil est conforme aux CNR d'Industrie Canada applicables aux appareils radio exempts de licence. L'exploitation est autorisée aux deux conditions suivantes: (1) l'appareil ne doit pas produire de brouillage, et (2) l'utilisateur de l'appareil doit accepter tout brouillage radioélectrique subi, même si le brouillage est susceptible d'en compromettre le fonctionnement.

Smart Host with Control Deployment Guide Copyright © 2016 Savant Systems, LLC 009-1332-03 | 161107 33 of 33