Crestron CP4, CP4N Product Manual

Page 1
CP4 and CP4N
4-Series™ ControlSystems
Product Manual
Crestron Electronics, Inc.
Page 2
Contents
Overview 1
Features 2
CP4 Features 3 CP4NFeatures 6
Physical Description 10
Specifications 12
CP4 Specifications 13
Product Specifications 13 Dimension Drawings 16
CP4NSpecifications 17
Product Specifications 17 Dimension Drawings 20
Installation 21
Install the Control System 21
Rack Mounting 21
Surface Placement 21 Connect the Control System 22 Connect the Control Subnet (CP4NOnly) 23 Configure the Control System 23
Configuration via IPAddress 23
Configuration via XiOCloud 23 Create an Admin Account 24 Set the Time Zone 25 Pair with Apple HomeKit 25 Configure .AVFrameworkSoftware 25
Configuration 27
Actions Menu 28
Save Changes 28
Revert 28
Reboot 28
Restore 29
Update Firmware 29
DownloadLogs 29
Manage Certificates 30 Status 30
Device 30
Network 31
Program 32
Product Manual— Doc. 9214A Contents • iii
Page 3
AVFramework 33 Settings 34
System Setup 34
Programs 42
Projects 46
Services 48
Cloud Settings 49
Auto Update 50
AVFramework 52 Security 53
Current User 54
Users 55
Groups 59
802.1x Configuration 62 Connect to XiO Cloud Service 65
Programming 66 Resources 67
Crestron Support and Training 67 Programmer and Developer Resources 67 Product Certificates 67 Related Documentation 67
iv • Contents ProductManual —Doc. 9214A
Page 4
Configuration
Prior to configuration, ensure the device isrunningthelatestfirmware.Toupdatethefirmware, refer to Update Firmware (on page29).
The control system may bemonitoredandconfiguredusingtheincludedwebconfiguration interface. The configuration interface is accessible from a webbrowserifthecontrolsystemIP address is known.
The web configuration interface is also accessible through theXiOCloud®service.Formore information, refer to Connect to XiO CloudService(onpage65).
To access the configuration interface:
1. Use the Device Discovery tool inCrestronToolbox™softwaretodiscoverthecontrol system and its IP addressonthenetwork.
2. Open a web browser.
3. Enter the control system IP address intothebrowserURLfield.Aloginpageisdisplayed.
4. Enter the administrator username and password intheappropriatetextfieldsandclick Sign In. The configuration interface is displayed.
NOTE: For more information on creating anadministratoraccount,refertoCreatean
Admin Account (on page24).Formoreinformationonmanaginguseraccountsonthe
control system, refer to Security (onpage53).
Web ConfigurationInterface
The configuration interface provides the following tabs:
l
Status:Usedtomonitorcontrolsystemstatus
l
Settings:Usedtoconfigurecontrolsystemsettings
Product Manual — Doc. 9214A CP4and CP4N• 27
Page 5
l
Security:Usedtoenableauthenticationandothersecuritysettings
l
802.1x Configuration:UsedtoconfigureIEEE802.1xnetworkauthenticationforcontrol system security
The Status tab isthedefaulttabthatisdisplayed,asshowninthepreviousimage.
Actions Menu
The configuration interface provides an Actions drop-down menu on thetoprightofthepage. The Actions menu may beaccessedatanytime.
Actions Menu
Once any changes have been made tothecontrolsystemconfiguration,theActionsbutton changes to a Save Changes button. ClickSaveChangestosavechangestotheconfiguration settings.
If a reboot isrequiredafterchangeshavebeensaved,adialogboxisdisplayedaskingwhether the reboot should be performed. Select YestorebootthedeviceorNotocancelthereboot.
The Actions menu provides the following selections.
Save Changes
Click Save Changes to saveanychangesmadetotheconfigurationsettings.
Revert
Click Revert to revert thecontrolsystembacktothelastsavedconfigurationsettings.
Reboot
Click Reboot to reboot thecontrolsystem.
28 • CP4 and CP4N Product Manual — Doc. 9214A
Page 6
After Reboot is selected, a dialogboxisdisplayedaskingwhetherthecontrolsystemshouldbe rebooted. Select Yes to reboot the deviceorNotocancelthereboot.
Restore
Click Restore to restore the control systemconfiguration settings totheirdefaultvalues. After Restore is selected a dialogboxisdisplayedaskingwhetherthedevicesettingsshouldbe
restored. Select Yes to restore the settings orNotocanceltherestore.
Update Firmware
Click Update Firmware toupgradethecontrolsystemfirmwaremanuallywithadownloaded PUF (package update file). The FirmwareUpgradedialogboxopens.
Firmware UpgradeDialog Box
To upload a firmwarePUFthroughthewebconfigurationinterface:
NOTE: Visit the appropriate device productpageorwww.crestron.com/Support/Resource-
Library to download the latestfirmwarePUF.
1. Click Browse, and then navigate tothefirmwarePUFonthehostcomputer.
2. Select the firmware PUF, andthenclickOpen.
3. Click Load to loadthePUFtothecontrolsystem.Theuploadprogressisshowninthe dialog box.
4. Once the control system has completed thefirmwareupgrade,clickOK.
Click the x buttontoclosetheFirmwareUpgradedialogboxatanytimeduringtheupgrade process. Clicking the x button before thePUFisuploadedtothecontrolsystemcancelsthe upgrade.
DownloadLogs
Click Download Logs to download thecontrolsystemmessagelogsfordiagnosticpurposes.The message files download as a compressed .tgz file.Oncethecompressedfileisdownloaded, extract the message log files to viewthem.
Product Manual — Doc. 9214A CP4 andCP4N •29
Page 7
Manage Certificates
Click Manage Certificates to manage anycertificates thatareinstalledonthecontrolsystem. For more information on certificate management, refer to802.1xConfiguration (onpage62).
Status
Click the Status tabonthetopleftoftheconfigurationinterfacetodisplayselectionsfor viewing the status of device, network, andUSB,and.AVFramework™softwaresettings.
Click on a selection nametoexpandtheselection.Iftheselectionisexpanded,clicktheselection name again to collapse thesection.
Status TabSelections
Device
Click Device to viewgeneraldeviceinformation.
Status Tab- Device
The following Device information is displayed:
l
Model: The control system model name
l
Serial Number: The control system serialnumber
l
Firmware Version: The firmware version loaded onto thecontrolsystem
Click + More detailsatthebottomoftheDevicetabtodisplayanexpandedsectionthatshows additional control system information. If + More Detailsisselected,click-Lessdetailstocollapse the section.
30 • CP4 and CP4N Product Manual — Doc. 9214A
Page 8
Network
Click Network to viewthestatusofthenetworksettingsforthecontrolsystem.
Status Tab- Network
The following Network information is displayed:
l
Host Name: The control system hostname
l
Domain Name:Thecontrolsystemdomainname
l
NIC 1 DNS Servers: TheDNS(domainnameserver)addressesusedtoresolvethecontrol system domain to an IPaddress
Click the + (plus)iconnexttoAdapter1todisplaythefollowing Ethernet settings:
l
DHCP: Reports whether the IP address isdynamic(Yes)orstatic(No)
l
IP Address: The control system IPaddress,shownonlyifanEthernetconnectionisenabled
l
Subnet Mask: The control system subnet maskaddress,shownonlyifanEthernet connection is enabled
l
Default Gateway: The gateway router address, shown onlyifanEthernetconnectionis enabled
Product Manual — Doc. 9214A CP4 and CP4N • 31
Page 9
l
Link Active: Reports the status oftheEthernetconnection(Atruemessageindicatesthat the Ethernet connection is active, while afalsemessageindicatesthattheEthernet connection is inactive.)
l
MAC Address: The unique MAC (mediaaccesscontrol)addressfortheEthernetadapter
Click the + (plus)iconnexttoControlSubnettodisplaythefollowingControlSubnetsettings (CP4Nonly):
l
Auto Network Addressing: Reports whether the network address for theControlSubnetis configured automatically (true)ormanually(false)
l
Network: The Control Subnet network address, shown onlyifaControlSubnetconnection is enabled
l
Subnet Mask: The Control Subnet maskaddress,shownonlyifanEthernetconnectionis enabled
l
Link Active: Reports the status oftheControlSubnetconnection(Atruemessage indicates that the Control Subnet connection is active,whileafalsemessageindicates that the Control Subnet connection is inactive.)
l
Isolation Mode:ReportsthestatusoftheControlSubnetisolationmode(Atruemessage indicates that isolation mode is enabled, whileafalsemessageindicatesthatisolation mode is disabled.)
l
MAC Address: The unique MAC (mediaaccesscontrol)addressfortheControlSubnet adapter
Program
Click Program to viewthestatusoftheprogramandslavemodesettingsforthecontrolsystem.
Status Tab- Program
The following Program information is displayed:
l
Number of Licensed Programs: The number of licensedprogramssupportedbythecontrol system
l
Slave Mode:Reportswhetherthecontrolsystemisrunninginsubordinatemode(Enabled) or not (Disabled)
l
Master IP/Hostname: The IPaddressorhostnameoftheprimarycontrolsystem,shown only if subordinate mode isenabled
l
Master IPID:TheIPIDof the primary control system connection, shown onlyif subordinate mode is enabled
32 • CP4 and CP4N Product Manual — Doc. 9214A
Page 10
l
Slave Mode Status:Indicatestheconnectionstatustoaprimarycontrolsystemwhilein subordinate mode, shown only if subordinate mode isenabled
If one or more programs havebeenloadedtothecontrolsystem,expandablesubsectionsare shown that correspond with the program slot. Expandthesubsectionforagivenprogramslotto display details about the loadedprogram.
AVFramework
Click AVFrameworktoviewthestatusofthenative.AVFrameworksoftware program running on the control system
Status Tab- AVFramework
The following AVFrameworkinformationisdisplayed:
l
AVFramework:Reportswhetherthenative.AVFrameworksoftwareprogramhasbeen enabled (Enabled)ornot(Disabled)
l
AVFrameworkVersion:Reportstheversionofthenative.AVFrameworksoftware program running on the control system, shown onlyifthenative.AVFrameworksoftware program is enabled
If the native .AVFrameworksoftwareprogramisenabled,anOpenAVFrameworkSetup button is provided to launch the.AVFrameworkwebconfigurationutility.Formoreinformationon configuring .AVFrameworkforthecontrolsystem,refertothe.AVFrameworkSoftware for 4-
Series Control Systems Operations Guide.
Product Manual — Doc. 9214A CP4 and CP4N • 33
Page 11
Settings
Click the Settings tab onthetopleftoftheconfigurationinterfacetodisplayselectionsfor configuring various control system settings.
Settings Selections
Each selection is described in thesectionsthatfollow.
NOTE: If an invalid valueisenteredforasetting,thewebinterfacewillnotallowchangesto be saved until avalidvalueisentered.Redtextisdisplayednextasettingtoindicatean invalid value.
System Setup
Click System Settings to configure general network andcontrolsystemsettings.
34 • CP4 and CP4N Product Manual— Doc.9214A
Page 12
Settings Tab- System Setup
Time/Date
Click the + (plus)iconnexttoTime/Datetodisplaythefollowingtimeanddate settings.
Settings Tab- System Setup (Time/Date)
Product Manual — Doc. 9214A CP4 andCP4N •35
Page 13
l
Time Synchronization: Turn on the toggle tousetimesynchronizationviaNTP(Network Time Protocol).
l
Synchronize Now: With Time Synchronization turned on, clickSynchronize Nowto synchronize the control system with the NTPserver(s) enteredintheNTPTimeServers table.
l
NTPTimeServers:WithTimeSynchronizationturnedon,usetheprovidedtabletoenter information regarding the NTP server(s) used to synchronize the dateandtimeforthe control system.
o
Click Add to addanewNTPserverentryintothetable.
o
Enter the following information for each entry:
n
Enter the NTPserveraddressintotheAddresstextfield.
n
Enter the NTPserverportintothePorttextfield.
n
Use the Authentication Method drop-down menu to select theauthentication method used to access the NTPserver(ifoneexists).
n
If an authentication method is selected, enter thekeyusedtoauthenticate against the NTPserverintotheAuthenticationKeytextfield.
n
If an authentication method is selected, enter theIDforthekeyusedto authenticate against the NTPserverintotheKeyIDtextfield.
o
To remove an entry, fillthecheckboxtotheleftofthetableentry,andthenclick Delete.
NOTE:NTPserversareconfiguredintoaparticularslot.The server configured for the first table row willbetheprimaryserverusedfortimesynchronization.Theservers configured into additional table rows willbeusedassecondaryservers.
l
Time Zone: Select a timezoneforthecontrolsystemusingthedrop-downmenu.
l
Date: Select the date forthecontrolsystemusingthepop-upcalendarthatisdisplayed.
l
Time: Select the time forthecontrolsystem(in24-hourformat)usingthepop-upmenu that is displayed.
36 • CP4 and CP4N Product Manual— Doc.9214A
Page 14
Network
Click the + (plus)iconnexttoNetworktodisplaythefollowingnetworksettings.
Settings Tab- System Setup (Network)
l
Host Name: Enter the control system hostname.
l
Domain: Enter the fully qualified domainnameonthenetwork.
l
Primary Static DNS: EntertheprimaryDNSaddress.
l
Secondary Static DNS: Enter thesecondaryDNSaddress.
l
DHCP: Turn on the toggle touseDHCPfortheEthernetconnection.
NOTE: If DHCP is enabled,IPdoesnotfunctionuntilareplyhasbeenreceivedfrom the server. The control system broadcasts requests for anIPaddressperiodically.
l
IP Address: If DHCPisturnedoff,enterthecontrolsystemIPaddressonthenetwork.
l
Subnet Mask: If DHCPisturnedoff,enterthecontrolsystemsubnetmaskaddressonthe network.
l
Default Gateway: If DHCPisturnedoff,enterthegatewayrouteraddressonthenetwork.
Product Manual — Doc. 9214A CP4 and CP4N • 37
Page 15
Control Subnet (CP4NOnly)
Click the + (plus)iconnexttoControlSubnettodisplaythefollowingControlSubnetsettings.
Settings Tab- System Setup (ControlSubnet)
NOTE:FormoreinformationontheControlSubnet,refertothe"ControlSubnet"topicin the 4-Series Control Systems Reference Guide.
l
Turn on the Auto NetworkAddressing toggle toassignanetworkaddressfortheControl Subnet automatically. If this toggle isturnedoff,astaticaddressmustbeenteredinthe Network text field below.
l
If Auto Network Addressing is turned off,enterastaticControlSubnetnetworkaddressin the Network text field. The networkaddressmustbeinCIDR(ClasslessInter-Domain Routing)formatthatincludesthebitmaskcountaftertheaddress(suchas "192.168.0.0/24").
l
Turn on the Isolation Mode toggle toruntheControlSubnetinisolationmode.Whenin isolation mode, the firewall is configured sothatnocommunicationcanoccurbetweenthe LAN and devices on theControlSubnet.Usingthismechanism,customerscanprotect their corporate LAN from devices on theControlSubnet.Formoreinformation,referto the "Control Subnet"topicinthe4-SeriesControlSystemsReferenceGuide.
l
Turn on the StartProgramAfterRouterisOnlinetoggletostartcontrolsystemprograms only after the internal Control Subnet routerisreportingonline.
l
Use the Port Map tabletocreateportmappingrulestousewiththeControlSubnet.
NOTE:NoportmapscanbeaddedifIsolationModeisturnedon.
38 • CP4 and CP4N Product Manual — Doc. 9214A
Page 16
o
Click Add to addanewportmappingruleintothetable.
o
Enter the following information for each entry:
n
Enter the external port intheExternalPorttextfield.Thisistheportnumber that users outside the LAN mustspecifytoconnecttotheserviceonthe internal network.
n
Enter the internal port intheInternalPorttextfield.Thisistheportnumber for the specified service on theinternalnetwork.
n
Enter the IP address orhostnameofthetargetcontrolsysteminthe IPAddress/Hostnametextfield.
n
Use the Protocol drop-down menu tospecifytheconnectiontypethatwillbe accepted from machines outside the LAN.
o
To remove an entry, fillthecheckboxtotheleftofthetableentry,andthenclick Remove.
Web Server
Click the + (plus)iconnexttoWebServertodisplaythefollowingcontrolsystem web server settings.
Settings Tab- System Setup (WebServer)
l
Turn on the Web ServerEnabledtoggletoenablethewebserverforthecontrolsystem. The control system web server allowsforuserstouploadwebpagesandmobilityprojects to a control system.
l
If Web Server Enabled isturnedon,enteranHTTPporttousefor the web server inthe HTTPPorttextfield.Port80isusedbydefault.
l
If Web Server Enabled isturnedon,enteranHTTPSporttousefor the web server in the HTTPSPorttextfield.Port443isusedbydefault.
Product Manual — Doc. 9214A CP4 andCP4N •39
Page 17
Crestron Internet Protocol
Click the + (plus)iconnexttoCrestronInternetProtocoltodisplaythefollowingCrestron Internet Protocol (CIP)portsettings.
Settings Tab- System Setup (CrestronInternet Protocol)
l
Enter theCrestronInternetProtocolportusedbythecontrolsystemintheCIPPorttext field. Port 41794 is usedbydefault.
l
Enter the Secure Crestron Internet Protocol port usedbythecontrolsysteminthe SCIPPorttextfield.Port41796isusedbydefault.
SSH
Click the + (plus)iconnexttoSSHtodisplaythefollowingSSH(Secure Shell)settings.
Settings Tab- System Setup (SSH)
l
Turn on the SSHEnabledtoggletoenableSSHforthecontrolsystem.
l
If SSHEnabledisturnedon,enteraporttouseforthe SSHprotocolintheSSHPorttext field. Port 22 isusedbydefault.
Web XPanel
Click the + (plus)iconnexttoWebXPaneltodisplaythefollowingcontrolsystemWebXPanel settings.
Settings Tab- System Setup (WebXPanel)
40 • CP4 and CP4N ProductManual —Doc. 9214A
Page 18
l
Turn on the Web XPanelEnabledtoggletoenabletheWebXPanelfunctionalityforthe control system.
l
Turn on the Secure WebXPanelEnabledtoggletoenableasecureWebXPanelconnection for the control system. If thistoggleisturnedon,theWebXPanelcanonlyconnecttothe control system over encrypted TLS/SSL.
l
Enter a domain name fortheWebXPanelintheDomaintextfield.
l
Enter one or more portsfortheWebXPanelinthePort(s)textfield.Port41794isusedby default.
NOTE:Enter"*"toopenallportsforthe Web XPanel. A range of ports can also be specified.
Product Manual — Doc. 9214A CP4 and CP4N • 41
Page 19
Programs
Click Programs to manage control systemprogramsandtoconfiguresubordinatemodesettings for the control system.
Settings Tab- Programs
Slave Mode
NOTE:Formoreinformationonusingsubordinatemodefora4-Seriescontrolsystem,refer to the "Master-SlaveMode"topicinthe4-SeriesControlSystems Reference Guide.
Click the + (plus)iconnexttoSlaveModetodisplaythefollowing subordinate mode settings.
l
Turn the Slave Mode toggleontorunthecontrolsysteminsubordinatemode.Ifthis toggle is turned on, the controlsystemwillfollowaprogramrunningontheprimary control system and will makeitsportsavailabletothatcontrolsystem.
42 • CP4 and CP4N Product Manual— Doc.9214A
Page 20
l
If Slave Mode isturnedon,entertheIPaddressorhostnameoftheprimarycontrolsystem in the Master IP/Hostname text field.
l
If Slave Mode isturnedon,entertheIPIDforthe connection to the primary control system in the IPIDtextfield.
Program Slot Management
NOTE:Formoreinformationonmanagingprogramsona4-Seriescontrolsystem,referto the "Program Management"topicinthe4-SeriesControlSystemsReferenceGuide.
Click the + (plus)iconnexttoProgramSlotManagementtodisplaythefollowingprogram management settings.
Each program slot is represented inatablethatprovidesthefollowinginformationandcontrols:
l
Slot:Theprogramslotnumber(1-10)
l
Program Name:Thenameforthecontrolsystemprogram
l
Registration:Theregistrationstatusoftheprogram
l
Execution:Theexecutionstatusoftheprogram
l
Program Editing: Provides the following program editing controls:
o
Click the Upload Program button toloadanewprogramtothecontrolsystem. Instructions for loading a new program tothecontrolsystemareprovidedbelow.
o
Click the Edit Programbutton toeditinformationabouttheprogram(if available).
o
If the program is unregistered, clicktheRegisterProgrambutton toregisterthe program with the control system.
o
If the program is registered, clicktheUnregisterProgrambutton tounregister the program from the control system.
l
Program Execution:Providesthefollowingprogramexecutioncontrols:
o
If the program is stopped,clicktheStartProgrambutton tostarttheprogram.
o
If the program is running, clicktheStopProgrambutton tostoptheprogram.
o
Click the Restart Program button torestarttheprogram.
Product Manual — Doc. 9214A CP4 andCP4N •43
Page 21
Load a New Program
To load a newprogramtothecontrolsystem:
1.
Click the Upload Program button in an available program slot.TheAddProgramdialog box is displayed.
Add ProgramDialog Box
2. If desired, fill the DonotcopyIPTablecheckboxtoprevent the program IPtablefrom being copied to the control systemfollowing theupload.
3. Click the Program File button. TheFileUploaddialogboxisdisplayed.
File UploadDialog Box
4. Click Browse, and then navigate totheprogramfile(LPZorCPZ)on the host computer.
5. Select the program file, and thenclickOpen.
6. Click Load to loadtheprogramfiletothecontrolsystem.Theuploadprogressisshownin the dialog box.
7. Once the control system has completed the programupload,clickOK.Theprogramwill appear in the Program SlotManagementtableandwillautomaticallyattempttoregister and start itself on thecontrolsystem.
44 • CP4 and CP4N Product Manual— Doc.9214A
Page 22
Edit a Program
To edit the IPtableforacontrolsystemprogram(ifpermittedbythe program):
1.
Click the Edit Programbutton in the desired program slot. TheEditProgramdialog box is displayed.
Edit ProgramDialog Box
NOTE: If IPtableentrieshavealreadybeendefinedintheprogram,theseentrieswill populate the table in theEditProgramdialogboxunlesstheDonotcopyIPTable check box was filled whenloadingtheprogramtothecontrolsystem.
2. Click Add to addanewIPtableentryfortheprogram(ifnecessary).
3. Enter or modify the following information ineachcolumnfortheIPtableentry:
l
IPID:EnteranIPIDthatwill be used for communication between a device and the control system.
l
IPAddress/Hostname:EntertheIPaddressor hostname for the device that will connect to the control system overIP.
l
Device Id:EnterauniqueIDfortheconnectingdevice.Bydefault,thisvalueisthe same as the provided IPID.
l
Port #:Entertheportusedforcommunicationbetweendeviceandcontrolsystem.
l
Room Id:EntertheCrestronVirtualControl(VC-4)roomID that is associated with theIPtableentry.ThissettingisapplicableonlyforVC-4connections.
4. Click Save Changes to saveanychangestotheIPtable.
Product Manual — Doc. 9214A CP4 andCP4N •45
Page 23
Projects
Click Projects to manage webandmobilityprojectsforthecontrolsystem.
Settings Tab- Programs
Each loaded project is represented inatablethatprovidesthefollowinginformationand controls:
l
Projects:Theprojectnumberonthecontrolsystem
l
Name:Thenameforthewebormobilityproject
l
Mobility:Displaysagreencheckiconiftheprojectisamobilityproject
l
Web Project:Displaysagreencheckiconiftheprojectisawebproject
l
Actions:Clickthetrashcanbutton todeletetheprojectfromthecontrol system
To load a newwebormobilityprojecttothecontrolsystem:
1. Click the Add Project button.TheAddProjectdialogboxisdisplayed.
Add ProjectDialog Box
2. Turn on the Web ProjectorMobilityProjecttogglestodefinewhethertheloadedprojectis a web or amobilityproject.
NOTE:Iftheprojectisbothawebandamobilityproject,both toggles can be selected.
46 • CP4 and CP4N Product Manual— Doc.9214A
Page 24
3. Click the Project File button. TheFileUploaddialogboxisdisplayed.
File UploadDialog Box
4. Click Browse, and then navigate totheprojectfileonthehostcomputer.
5. Select the projectfile,andthenclickOpen.
6. Click Load to loadtheprojectfiletothecontrolsystem.Theuploadprogressisshown in the dialog box.
7. Once the control system has completed the projectupload,clickOK.Theprogramwill appear in the Project Management table.
Product Manual — Doc. 9214A CP4 andCP4N •47
Page 25
Services
Click Services to manage various external servicesthatintegratewiththecontrolsystem.
Settings Tab- Services
Crestron Fusion Cloud
NOTE: If connecting to a Crestron Fusionsoftwareon-premises server,connections are made using either traditional (outbound) or inbound communications. For moreinformation, refer to the Crestron Fusion 10On-Premises SoftwareGettingStartedGuide.
l
Turn on the Crestron Fusion CloudtoggletoallowaconnectiontoaCrestronFusionCloud server.
l
If Crestron Fusion Cloud is turnedon,entertheURLusedtoconnectthecontrolsystemto the desired Crestron Fusion Cloud server intheCrestronFusionCloudURLtextfield.
VC-4 Server
NOTE: For more information on connecting the control systemtoCrestronVirtualControl (VC-4), refer to the helpfileintheCrestronVirtualControlwebconfigurationinterface.To
access the help file, clickthequestionmarkbutton on the top left of the page.
Enter a VC-4serverURLintotheVC-4 Server Address text field to establish a connection between the control system and aVC-4server.
48 • CP4 and CP4N Product Manual— Doc.9214A
Page 26
AppleHomeKit
NOTE:FormoreinformationonpairingthedevicewithanApple®HomeKit®system,referto
support.apple.com/en-us/HT204893.
Turn on the Apple HomeKittoggletoenabletheHomeKitfeatureonthecontrolsystem.
Cloud Settings
Click Cloud Settings to enable ordisableaconnectionbetweenthecontrolsystemandanXiO Cloud® service account.
Settings Tab- Cloud Settings
Turn on the Cloud Configuration Service Connection toallowaconnectionbetweencontrol system and an XiO Cloudaccount.Thissettingisturnedonbydefault.
For more information on connecting to the XiOCloudservice,refertoConnecttoXiOCloud
Service.
Product Manual — Doc. 9214A CP4 andCP4N •49
Page 27
Auto Update
Click Auto Update toconfigure automaticfirmwareupdatesforthecontrolsystemand connected devices.
Settings Tab- Auto Update
NOTE:Formoreinformationonconfiguringautomaticupdatesforthecontrolsystem,refer to the "Auto Update Mechanism"topicinthe4-SeriesControlSystemsReferenceGuide.
General
l
Turn on the Auto Updatetoggletouseautomaticupdatesforthecontrolsystemand connected devices.
l
If Auto Update is turnedon,enteracustomupdateserverFTPaddressinthe Custom URL text field.
Server
The following settings can be configured for theautoupdateserverifAutoUpdateisturnedon:
50 • CP4 and CP4N ProductManual —Doc. 9214A
Page 28
l
Enter a username for accessing the autoupdateserverintheUsernametextfield.
l
Enter a password for accessing the autoupdateserverinthePasswordtextfield.
Crestron Devices
The following settings can be configured for updating connected Crestron devicesifAuto Update is turned on:
l
Enter a username for pushing automatic updatestocontrolledCrestrondevicesinthe Username text field.
l
Enter a password for pushing automatic updatestocontrolledCrestrondevicesinthe Password text field.
Schedule
The following settings can be configured for scheduling automatic updatesifAutoUpdateis turned on:
l
Use the Day ofWeekdrop-downmenutoselectadayoftheweektocheckforand perform automatic updates.
o
Select Daily to checkfornewupdateseveryday.
o
Select None to only checkfornewupdatesmanually.
l
If a value isprovidedforDayofWeekotherthan"None,"enteratimeofday(in24-hour format) when the control system willcheckupdatesonthescheduledday.
l
If "None" is selected for DayofWeek,enterthepollinginterval(inhours)forwhenthe control system will poll theserverforupdates.
l
Click Update Now tochecktheupdateserverfornewfirmwareandtoupdatethecontrol system immediately if new firmware isavailable.
Product Manual — Doc. 9214A CP4 and CP4N •51
Page 29
AVFramework
Click AVFrameworktoconfigurethenative.AVFrameworksoftware program running on the control system.
Settings Tab- AVFramework
NOTE:Ifanolderversionofthe.AVFrameworkprogramisdetectedintheProgram01 slot (6.13 and prior), the program isloadedtotheProgram00slotbutisnotenabledwithinthe control system. The older .AV Frameworkprogrammustberemovedmanuallybeforethe newer version can be enabled. Formoreinformation,refertothe.AVFrameworkSoftware
for 4-Series Control Systems Operations Guide.
l
Turn on the AVFrameworktoggletoturnonthenative.AVFrameworksoftware program on the control system.
l
If AVFrameworkisturnedon,theversionofthenative.AVFrameworksoftware program is reported next to AVFrameworkVersion.
l
If AVFrameworkisturnedon,clickOpenAVFrameworkSetup to launch the .AVFrameworkwebconfigurationutility.Formoreinformationonconfiguring .AVFrameworkforthecontrolsystem,refertothe.AVFrameworkSoftware for 4-Series
Control Systems Operations Guide.
52 • CP4 and CP4N Product Manual— Doc.9214A
Page 30
Security
Click the Security tabonthetopleftoftheconfigurationinterfacetodisplayselectionsfor configuring security and authentication settings for the control system.
Security TabSelections
Expand the Security accordion to configure thefollowingsettings:
NOTE:Formoreinformationaboutconfiguringauthenticationsettingsona4-Seriescontrol system, refer to the "Authentication"topicinthe4-SeriesControlSystemsReferenceGuide.
l
SSLMode:SelectanSSL(SecureSockets Layer) mode to use for establishing a secure connection to the control system:
o
Encrypt and Validation:Thecontrolsystemwillrequireausernameandpasswordto validate an encrypted SSLconnection.Enterausernameandpasswordinthe appropriate fields that are displayed.
o
Encrypt: The control system will useanencryptedSSLconnection.
l
Enable User Page Authentication:Turnonthetoggletouseuserpageauthenticationfor web pages and mobility projects. Ifthistoggleisturnedon,auserwillbepromptedfor login credentials as they load theproject.
Product Manual — Doc. 9214A CP4 andCP4N •53
Page 31
Control system users and groups can beviewedandmodifiedwithinthetableprovidedatthe bottom of the accordion. Use thefollowing settings toadd,delete,andeditcontrolsystemusers and groups.
Current User
Click the Current User tabtoviewandeditinformationforthecurrentcontrolsystemuser.
Current UserTab
The following settings are displayed for thecurrentuser:
l
Name: The chosen username
l
Access Level: The access level granted totheuser(Administrator,Programmer,Operator, User, or Connect)
l
Active Directory User: Reports whether the current useris(Yes)orisnot(No) authenticated through Active Directory® software
NOTE: A user must beaddedtoanActiveDirectorygroupbeforetheusermaybe selected as an active directory user.Formoreinformation,refertoGroups(on
page59).
l
Groups: Any groups of which thecurrentuserisamember
Click Change Current User Password tochangethepasswordforthecurrentuser.TheChange Password dialog box is displayed.
54 • CP4 and CP4N Product Manual— Doc.9214A
Page 32
Change PasswordDialog Box
Enter the existing password in theCurrentPasswordfield.Then,enteranewpasswordinthe Password field, and reenter the password intheConfirmPasswordfield.
Click OK to savethenewpassword,orclickCanceltocancelthechange.
Users
Click the Users tabtoviewandeditinformationforthecontrolsystemusers.
Users Tab
Enter text into the SearchUsersfieldtofindanddisplayusersthatmatchthesearchterm(s). Control system users are listed intableformat.Thefollowinginformationisdisplayedforeach
control system user:
l
Username: The chosen username
l
AD User: Reports whether the user is(Yes)orisnot(No)authenticatedthroughActive Directory
Product Manual — Doc. 9214A CP4 andCP4N •55
Page 33
NOTE: A user must beaddedtoanActiveDirectorygroupbeforetheusermaybe selected as an active directory user.Formoreinformation,refertoGroups(on
page59).
If the control system users span multiplepages,usethenavigationarrowsonthebottomofthe page to move forward orbackwardthroughthepages,orselectapagenumbertonavigateto that page. Additionally, the number ofusersdisplayedoneachpagemaybesetto5,10,or20 users.
An Actions column is also providedforeachuserthatallowsvariousactionstobeperformed. The following selections may be selected from theActionscolumn.
User Details
Click the information button in the Actions column to view information for the selected user. The User Details pop-up dialogboxisdisplayed.
User DetailsDialog Box
The following settings are displayed for thecurrentuser:
l
Name: The chosen username
l
Active Directory User: Reports whether the user is(Yes)orisnot(No)authenticated through Active Directory
l
Groups: Lists any groups that contain theuser
Click OK to returntotheAuthenticationManagement>Userspage.
Update User
Click the editing button in the Actions column to edit settings for the selected user. The Update User dialog box isdisplayed.
56 • CP4 and CP4N Product Manual— Doc.9214A
Page 34
Update UserDialog Box
The following Update User settings may beviewedorconfigured:
l
Name: The chosen username
l
Active Directory User: Turn on thetoggletouseauthenticationviaActiveDirectoryforthe selected user.
l
Password: Enter a new password fortheselecteduser.
l
Confirm Password: Reenter the password provided in thePasswordfield.
l
Groups: Add the user tooneormoregroups.Formoreinformation,refertoGroups(on
page59).
NOTE: A user must beaddedtoanActiveDirectorygrouptobeselectedasanActive Directory user.
Click OK to saveanychangesandtoreturntotheUsersselections.ClickCanceltocancelany changes.
Delete User
Click the trashcan icon in the Actions column to delete the user. A pop-up dialog box isdisplayedaskingwhethertheusershouldbedeleted.ClickYestodelete
the user or No tocancel.
Create User
Click Create User atthebottomofthepagetocreateanewcontrolsystemuser.TheCreate User dialog box is displayed.
Product Manual — Doc. 9214A CP4 andCP4N •57
Page 35
Create UserDialog Box
Use the following settings to create anewuser:
l
Name: Enter a username.
l
Active Directory User: Turn on thetoggletouseauthenticationviaActiveDirectoryforthe user.
l
Password: Enter a password for theuser.
l
Confirm Password: Reenter the password provided in thePasswordfield.
l
Groups: Add the user tooneormoregroups.Formoreinformation,refertoGroups(on
the facing page).
NOTE: A user must beaddedtoanActiveDirectorygrouptobeselectedasanActive Directory user.
Click OK to saveanychangesandtoreturntotheUsersselections.ClickCanceltocancel creating a new user.
58 • CP4 and CP4N Product Manual— Doc.9214A
Page 36
Groups
Click the Groups tabtoviewandeditsettingsforcontrolsystemgroups.Controlsystemgroups are used to group usersbyaccesslevelandActiveDirectoryauthenticationsettings.
Groups Tab
Enter text in totheSearchGroupsfieldtofindanddisplaygroupsthatmatchthesearchterm (s).
Control system groups are listed intableformat.Thefollowinginformationisdisplayedforeach control system group:
l
Group Name: The chosen group name
l
AD Group: Reports whether the group is(Yes)orisnot(No)authenticatedthroughActive Directory
NOTE: Active Directory provides an additional layerofauthenticationforcontrol system groups and users. Active directory group andusernamesarestoredinthe control system console along with a uniqueSID(securityidentifier).WhenanActive Directory user attempts to authenticate against the console, theconsolefirstchecks the user credentials. If the Active Directoryauthentication issuccessful,Active Directory queries the console for the userorgroup'sSID.Theuserisgrantedaccessto the control system only if atleastoneSIDmatchisfound.
l
Access Level: The access level for theselectedgroup(Administrator,Programmer, Operator, User, or Connect)
If the control system groups span multiplepages,usethenavigationarrowsonthebottomof the page to move forwardorbackwardthroughthepages,orselectapagenumbertonavigate to that page. Additionally, the numberofgroupsdisplayedoneachpagemaybesetto5,10,or 20 users.
Product Manual — Doc. 9214A CP4 andCP4N •59
Page 37
An Actions column is also providedforeachgroupthatallowsvariousactionstobeperformed. The following selections may be selected from theActionscolumn.
Group Details
Click the information button in the Actions column to view information for the selected group. The Group Details dialog boxisdisplayed.
Group DetailsDialog Box
The following settings are displayed for thecurrentgroup:
l
Name: The chosen group name
NOTE:IfauthenticatingwithActiveDirectory,donotenterthedomainnameforthe Active Directory group in theNamefield.Ifthisinformationisbeingenteredvia console commands, omit domain\local from the command (forexample,
adddomaing -n:crestron -L:A instead of adddomaing ­n:domain.local\crestron -L:A).
l
Access Level: The access level of thegroupanditsusers
l
Active Directory User: Reports whether the group is(Yes)orisnot(No)authenticated through Active Directory
Click OK to returntotheGroupsselections.
Delete Group
Click the trashcan icon in the Actions column to delete the group. A pop-up dialog box isdisplayedaskingwhetherthegroupshouldbedeleted.ClickYestodelete
the group or No tocancel.
Create Group
Click Create Group atthebottomofthepagetocreateanewcontrolsystemgroup.TheCreate Group dialog box is displayed.
60 • CP4 and CP4N ProductManual —Doc. 9214A
Page 38
Create GroupDialog Box
Use the following settings to create anewgroup:
l
Name: Enter a group name.
l
Access Level: Select an access level forthegroupanditsusersfromthedrop-downmenu.
l
Active Directory Group: Turn on thetoggletouseauthenticationviaActiveDirectoryfor the group.
Click OK to saveanychangesandtoreturntotheGroupsselections.ClickCanceltocancel creating a new group.
Product Manual — Doc. 9214A CP4 andCP4N •61
Page 39
802.1x Configuration
Click the 802.1x Configuration tab on thetopleftoftheconfigurationinterfacetodisplay selections for configuring IEEE 802.1x network authentication for control system security.
802.1x ConfigurationTab Selections
Expand the 802.1x Configuration accordion to configure the following settings:
NOTE:Formoreinformationaboutconfiguring802.1xnetworkauthenticationona4-Series control system, refer to the "802.1X"topicinthe4-SeriesControlSystemsReferenceGuide.
l
IEEE 802.1x Authentication: Turn on the toggle touse802.1xauthenticationforthecontrol system.
62 • CP4 and CP4N Product Manual— Doc.9214A
Page 40
l
Authentication Method: Select an 802.1x authentication method (EAP-TLS Certificate or EAP MSCHAP V2- password) from thedrop-downmenu.
o
Domain: If EAP MSCHAP V2-passwordisselectedforAuthenticationMethod,enter a domain name that isrequiredforauthentication.
o
Username: If EAP MSCHAP V2- password isselectedforAuthenticationMethod, enter a username that isrequiredforauthentication.
o
Password: If EAP MSCHAP V2-passwordisselectedforAuthenticationMethod, enter a password that isrequiredforauthentication.
l
Enable Authentication Server Validation: Turn on thetoggletouseservervalidationfor increased security.
l
Select Trusted Certificate Authorities: Select trusted CAs (Certificate Authorities) from the provided CAs to beusedforservervalidation:
o
Click the check box totheleftofaCAtoselectitasatrustedCA.
o
Enter a search term intothetextfieldatthetopoftheCAmenutosearchforand display CAs that match thesearchterm.
o
Click the check box totheleftofthesearchfieldatthetopoftheCAmenuto select all CAs as trusted CAs.
Select Manage Certificates from the Action menu toaddorremoveCAsfromthelist.The Manage Certificates dialog box is displayed withtheRoottabselected.
Manage CertificatesDialog Box - RootTab
Click the tabs near thetopofthepagetoswitchbetweenthedifferenttypesofCAs(Root, Intermediate, Machine, or Web Server). The same settings areprovidedforeachtypeofCA.
Product Manual — Doc. 9214A CP4 andCP4N •63
Page 41
Type a search termintotheSearch…textfieldtosearchforanddisplayCAsthatmatchthe search term.
The following information is provided for each typeofCA:
l
Name: The CA name
l
Expiry Date: The dateandtimethattheCAissettoexpire
If the CAs span multiplepages,usethenavigationarrowsonthebottomofthepagetomove forward or backward through the pages,orselectapagenumbertonavigatetothatpage.
Click the trashcan button in the Actions column for a CA to delete it. A pop-up dialog box is displayed asking if the CAshouldbedeleted.ClickYestodeletethecertificateorNotocancel.
Click Add [Type] Certificate toaddaCAofoneofthefouravailabletypes(Root,Intermediate, Machine, or Web Server) tothelistofCAs.TheAddCertificatepop-updialogboxisdisplayed.
Add CertificateDialog Box
To add anewcertificate:
1. Click Browse.
2. Navigate to the CA fileonthehostcomputer.
3. Select the CA file, andthenclickOpen.
4. Click Load to loadtheCAfiletothecontrolsystem.Theuploadprogressisshowninthe dialog box.
5. Once the control system has completed the upload,clickOK.
Click the x buttontoclosetheAddCertificatedialogboxatanytimeduringtheuploadprocess. Clicking the x button before theCAfileisuploadedtothecontrolsystemcancelstheupload.
Click the x buttontoclosetheManageCertificatesdialogboxandtoreturntothe802.1x Authentication page.
64 • CP4 and CP4N Product Manual— Doc.9214A
Page 42
Connect to XiO Cloud Service
The XiOCloud®serviceallowssupporteddevicesacrossanenterprisetobe managed and configured from one central and secure location inthecloud.SupportedCrestron®devicesare configured to connect to the service outofthebox.
Use of the service requires aregisteredXiOCloudaccount.ToregisterforanXiOCloudaccount, refer to www.crestron.com/Support/Tools/Licensing-Registration/XiO-Cloud-Registration-
Room-Licenses.
NOTE:ThedevicemaybedisconnectedfromtheXiOCloudservice by navigating to the Cloud Services tab in CrestronToolbox™software(Functions>DeviceInfo> Cloud Services). For details, refer to theCrestronToolboxhelpfile.
To connect the device totheXiOCloudservice:
1. Record the MAC address andserialnumberthatarelabeledontheshippingboxorthe device. The MAC address and serialnumberarerequiredtoaddthedevicetothe XiOCloudservice.
NOTE:IfthedevicehasmultipleMACaddresses,usetheMACaddressthatis providing the primary connection back tothenetwork.Formostdevices,theEthernet MAC address should be used. However, ifyourdeviceisconnectingtothenetworkover a different protocol (such as Wi-Fi®communications), use theMACaddressforthat protocol instead.
2. Log in to yourXiOCloudaccountatportal.crestron.io.
3. Claim the device to theXiOCloudserviceasdescribedintheXiOCloudUserGuide.
Select the device from thecloudinterfacetoviewitsstatusandsettings.Thedevicemaynow also be managed and assigned toagrouporroom.Formoreinformation,refertothe
XiOCloudUserGuide.
NOTE:ForXiOCloudaccountswithroom-basedlicenses,thedevicemustbe added to a licensed room before its status andsettings canbeviewed.
Product Manual — Doc. 9214A CP4 andCP4N •65
Page 43
Programming
4-Series control systems support an open development environment that enables programmers to use standard tools tocreateC#programs.ProgrammerscanalsouseCrestrontoolssuchas
SIMPL, SIMPL#Pro,andVTPro-e®softwaretocreatecontrolsystemprogramsandprojects.
l
For more information on programming for a4-seriescontrolsystemusingC#,referto
online help answer ID1000637.
l
For more information on programming for a4-seriescontrolsystemusingthePython programming language, refer to the Python Programming Language on 4-Series Control
Systems Developer Microsite.
66 • CP4 and CP4N Product Manual— Doc.9214A
Page 44
Resources
The following resources are provided for theCP4andCP4N.
NOTE:YoumayneedtoprovideyourCrestron.comwebaccountcredentialswhenprompted to access some of the following resources.
Crestron Support and Training
l
Crestron True Blue Support
l
Crestron Resource Library
l
Crestron Online Help (OLH)
l
Crestron Training Institute (CTI)Portal
Programmer and Developer Resources
l
help.crestron.com:Provides helpfilesforCrestronprogrammingtoolssuchasSIMPL,
SIMPL#, and Crestron Toolbox™ software
l
developer.crestron.com:Provides developer documentation for Crestron APIs, SDKs,and
other development tools
Product Certificates
To search for product certificates, refer tosupport.crestron.com/app/certificates.
Related Documentation
l
4-Series Control Systems Reference Guide
l
4-Series Control Systems Security Reference Guide
l
.AVFrameworkSoftwarefor4-SeriesControlSystemsReferenceGuide
l
Crestron Fusion® Software Help File
l
Crestron Programming Design Guide
l
XiOCloudUserGuide
Product Manual — Doc. 9214A CP4 andCP4N •67
Page 45
Crestron Electronics,Inc. 15 VolvoDrive, Rockleigh, NJ 07647 Tel: 888.CRESTRON Fax: 201.767.7656 www.crestron.com
Product Manual— Doc. 9214A
01/14/22
Specifications subjectto
change withoutnotice.
Loading...