Crestron e-Control Reference Manual
Crestron e-Control Reference Manual

Crestron e-Control Reference Manual

Crestron e-control software: reference guide
Hide thumbs Also See for e-Control:

Advertisement

Crestron e-Control
®
Reference Guide

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the e-Control and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Summary of Contents for Crestron e-Control

  • Page 1 Crestron e-Control ® Reference Guide...
  • Page 2 This document was prepared and written by the Technical Documentation department at: Crestron Electronics, Inc. 15 Volvo Drive Rockleigh, NJ 07647 1-888-CRESTRON All brand names, product names and trademarks are the property of their respective owners. 2002 Crestron Electronics. Inc.
  • Page 3: Table Of Contents

    AUTONEGOT Command ...31 ...31 NTERFACES TO E ONTROL Third-Party Interfaces and the Crestron Gateway ...32 e-Control Web Pages and e-Control 2 ...32 Java-Based Browser Projects...33 XPANEL Projects (e-Control 2)...33 IP Settings (Java and XPANEL)...34 SIMPL Windows Programming (Java and XPANEL) ...35 Uploading HTML Pages to a Web Server ...36...
  • Page 4 E: FAQ IT/MIS ...62 PPENDIX PROFESSIONALS ...64 OFTWARE ICENSE GREEMENT ...66 ETURN AND ARRANTY OLICIES Merchandise Returns / Repair Service ...66 ii • Crestron e-Control® Reference Guide – DOC. 6052...
  • Page 5: Crestron E-Controli

    • Analysis, control, and diagnostics available at any time or place. This document is your reference guide to e-Control. The first half reviews the basic networking principles needed to set up and maintain an e-Control network. This includes an explanation of common networking terminology as well as cabling specifications and concepts such as static and dynamic IP addressing, subnet masks, and port numbers.
  • Page 6: Ethernet Networking

    Ethernet Networking NOTE: This section reviews basic Ethernet and IP networking principles that form the foundation for e-Control. Even if you are familiar with these terms or have prior networking experience, the material contained here will help you better understand how Crestron implements e-Control.
  • Page 7: Network Cards

    TPS touchpanels and CEN devices. The most popular type of Ethernet cabling, and the type that Crestron recommends for use in e-Control, is twisted-pair, which looks like an ordinary telephone cable, except that it has eight wires inside instead of four.
  • Page 8 Ethernet and Fast Ethernet networks. Crestron recommends using UTP Cat 5 cabling for use in e-Control. The most common type of network cable is a straight-through cable, which, as its name indicates, allows data to travel along a straight path through the cable to its destination.
  • Page 9 Hub to Hub (without a switch) Hub to Hub (without a switch) Hub to Switch PC to Hub/Switch Crestron Control System to Hub/Switch (2-Series and X-Series) Crestron Control System to Hub/Switch (2-Series only) Crestron touchpanel to Hub/Switch (TPS-ENET only) Crestron touchpanel to Hub/Switch (TPS-ENET only) Crestron CEN device to Hub/Switch Reference Guide –...
  • Page 10: Internet Routers

    LAN. Here the card’s LAN A port is the public side that is visible to the larger network, while the LAN B port connects to the private, internal LAN of e-Control devices.
  • Page 11: Ip Communication

    CIP, and vice-versa. Both UDP and TCP are transport-layer (layer 3) protocols that run over IP networks. UDP has several characteristics that make it convenient and useful for e-Control. First, UDP is connectionless, meaning that Crestron equipment can transfer data over Ethernet without prior advertising or need to negotiate a connection.
  • Page 12: Network Classes

    Internet. These addresses are considered unregistered. No company or agency can claim ownership of unregistered addresses or use them on public computers. Routers are designed to discard (instead of forward) unregistered addresses. 8 • Crestron e-Control® Crestron e-Control 150.215.017.009 (IP address) 255.255.000.000 (subnet mask) 150.215.000.000 (network address)
  • Page 13: Default Gateway

    IP address until it is changed to a different value. Crestron’s X-Series control systems and CEN devices require static IP addressing for use in e-Control. In contrast, a dynamic IP address is automatically assigned to a device on the network.
  • Page 14: Obtaining Ip Information

    IP addresses available on the LAN side. If you are installing e-Control in a corporate LAN, the network administrator must provide you with static IP addresses if you are configuring X-Series and CEN equipment.
  • Page 15: Port Mapping

    Browser (http://195.164.35.7:918) External Port Most routers allow between 10 and 16 ports to be opened using port mapping; the Crestron NAT that is built into the 2-Series processor allows up to 16. Reference Guide – DOC. 6052 WAN (195.164.35.7) Router LAN (192.168.1.1)
  • Page 16: Secure Sockets Layer

    Software Secure Sockets Layer Crestron 2-Series control systems are the first in the AV industry to provide built-in support for SSL, Secure Sockets Layer, the de facto standard for protecting Web- based communication between clients and servers. SSL is a protocol that provides a secure channel for communication between two machines.
  • Page 17 The CSR can be copied and pasted to the online enrollment form or sent via e-mail to the CA, along with any other pertinent information the CA requires. The CA then issues the certificate, usually via e-mail. The Crestron Viewport provides all the certificate management tools necessary to generate a CSR and upload the certificate to the 2-series processor.
  • Page 18 Web site’s address will begin with https:// rather than the usual http://. The Web server listens for a secure connection on the well-known port 443. 14 • Crestron e-Control® Crestron e-Control Reference Guide – DOC. 6052...
  • Page 19: E-Control Hardware Configuration

    This section describes how to configure X-Series and 2-Series equipment for integration into a LAN. Windows DHCP/DNS Server Configuration Crestron’s 2-Series control systems (minimum CUZ 3.041) and TPS touchpanels support DHCP in the following environments: • Windows 2000 Server with DHCP Server and DNS Server (Dynamic DNS enabled) •...
  • Page 20: Control Systems

    Handle Dynamic Updates (Windows 2000 only) Control Systems Before setting the control system’s IP information for the first time, use the Crestron Viewport to establish a serial connection to the unit, as follows: 1. Use a DB9 straight-through serial cable to connect a COM port on the PC to the COMPUTER port on the control system.
  • Page 21: 2-Series Control Systems

    In the following example, the control system will be set to the IP address 192.168.1.4. The subnet mask is the default for that address class (Class C), 255.255.255.0, and the default router address will be set to 0.0.0.0. Reference Guide – DOC. 6052 Software Crestron e-Control® • 17...
  • Page 22 LAN B is the internal LAN of e-Control devices. In this way, a network administrator would need to provide one static IP address, for the public (LAN A) side.
  • Page 23 2. You have the option to change the CIP and CTP port numbers in rare cases where a network conflict may exist with ports 41794 and 41795. The Web port can be changed for security reasons if no firewall or router is Reference Guide – DOC. 6052 Software Crestron e-Control® • 19...
  • Page 24: 2-Series Ssl Configuration

    To prevent attacks by hackers the port can be moved to another value. Users on the LAN would then have to specify the port number in the URL, i.e., http//www.crestron.com:49153 where the value after the colon indicates the Web port.
  • Page 25 Generate a Certificate Signing Request (CSR) 1. On the Viewport File Transfer menu, point to Generate Certificate Request, and then click Generate Certificate. Reference Guide – DOC. 6052 Software Crestron e-Control® • 21...
  • Page 26 On the Viewport command line, go to the \SYS directory by typing “cd \sys”. To open the directory type “dir”. This will display a list of files in the \SYS directory, including the CSR (request.csr) and the private key (srv_key.der). 22 • Crestron e-Control® Crestron e-Control Reference Guide – DOC. 6052...
  • Page 27 Once the CA validates the CSR, the CA issues the certificate. The certificate is usually sent to the requester via e-mail, in the following format: -----BEGIN CERTIFICATE----- MIIBZzCCARECAQAwgZQxCzAJBgNVBAYTAlVTMRIwEAYDVQQIEwlob3N0c3RhdGUxETAPB gNVBAcTCGhvc3RjaXR5MRUwEwYDVQQKEwxob3N0bmFtZSBpbmMxCjAIBgEAEwNNSVMxG TAXBgNVBAMTEHd3dy5ob3N0bmFtZS5jb20xIDAeBgkqhkiG9w0BCQEWEWhvc3RAaG9zdG5hb WUuY29tMFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBAMxVTzjNPVWjOHUtMzEsOEWRMIQ WvilIYliVNtK7jTbyB8WUmucwz3JGfP1LZ5AvT5OQsz8tDsILYItGGliC2tcCAwEAAaAXMBUGCSq Reference Guide – DOC. 6052 Software Crestron e-Control® • 23...
  • Page 28: Ethernet Touchpanels

    Ethernet Touchpanels The Crestron TPS-ENET card (shown in the figure) is a Network Interface Card for TPS touchpanels. The card can operate at speeds of 10/100BaseT, and provides half and full duplex capabilities.
  • Page 29 252 master control systems. (If you are using the Crestron NAT and the touchpanel is located on LAN B, then you type the LAN B address of the control system, not the LAN A address that is visible to the outside network).
  • Page 30: Ip Table Setup

    Ethernet processor or TPS touchpanel. 5. For Generic Ethernet Modules: The device settings for Generic Ethernet modules such as the ActiveCNX Interface and e-Control PC Interface are the same regardless of the DHCP setting. That is, the IP address should be set to 127.0.0.1 if the internal “hardware”...
  • Page 31 SIMPL Windows program. 1. Open the Crestron Viewport and select Setup IP Table on the Functions menu. 2. In IP Operations, click Add to add the new IP table entry.
  • Page 32 1. Set the IP ID. It must match the IP ID that is listed in the IP Table of the master control system. 2. Enter the IP address or FQDN of the master control system. 3. Select the Set as Master check box. 28 • Crestron e-Control® Crestron e-Control Reference Guide – DOC. 6052...
  • Page 33 In all cases, however, you must use the Crestron Viewport to access the unit’s console. From the console, enter the static IP address, subnet mask and default gateway address. In addition, you must specify the IP ID of the unit, together with the static IP address of the control system(s) that will send it commands.
  • Page 34: Using The Ping Utility To Test An Internet Connection

    ICMP (Internet Control Message Protocol). The purpose of ICMP is to diagnose IP networking issues. Once you have configured the Crestron equipment, you should “ping” each device to verify the network connection. The PING utility is included with Windows, as well as with Crestron’s 2-Series control systems.
  • Page 35: Autonegot Command

    That is, the touchpanel symbol detail is defined as usual, with output and feedback signals connected to the inputs and outputs on the controlled device. When you use a touchpanel as an interface to e-Control (or to any other control method), you design the touch screen pages using Crestron’s VisionTools™ Pro-e software (VT Pro-e).
  • Page 36: Third-Party Interfaces And The Crestron Gateway

    SIMPL Windows. Third-Party Interfaces and the Crestron Gateway In addition to Crestron user interfaces, users can access the control system with PC- based interfaces such as Web browsers or custom software applications. Since Internet and PC communication is based on TCP, and Crestron control systems communicate over CIP, these applications require a mechanism called an e-Control gateway to translate TCP packets into CIP datagrams, and vice-versa.
  • Page 37: Java-Based Browser Projects

    HTML conversion utilities. Crestron e-Control 2 requires that you enable the C2ENET card; you do not have to license VT Pro-e. (Consult the documentation for the C2ENET card for more information on how to enable the card for e-Control 2.) Java-Based Browser Projects When you design a Java-based project, each object that you draw on a page is actually a discrete Java applet.
  • Page 38: Ip Settings (Java And Xpanel)

    When you compile a Java-based project, VT Pro-e generates one HTML file for each page in the project. With e-Control 2, only two HTML files are generated: an initialization file that optimizes the download process and ensures that only the latest components are installed;...
  • Page 39: Simpl Windows Programming (Java And Xpanel)

    To configure the symbol, open the SIMPL Windows Configuration Manager screen: 1. Drag the e-Control PC Interface symbol from the Device Library to the Ethernet slot on the control system. Double-click the symbol to open the Device Settings dialog box.
  • Page 40: Uploading Html Pages To A Web Server

    Uploading HTML Pages to a Web Server Once you have created the e-Control Web pages with either VT Pro-e or the Crestron SDK, you are ready to upload them to a Web server. The procedure differs depending on the location of the Web server.
  • Page 41: Standalone Executables

    This scenario does not require a server to deliver the e-Control 2 pages. All the data can be stored locally on the Windows PC.
  • Page 42: Gateway Configurations

    After you transfer the program files, launch the executable on the user’s machine. This will open the e-Control 2 screen and display the message: “The connection to hardware was not established.” Click Settings on the Options menu and enter the IP address or fully-qualified domain name of the control system.
  • Page 43 Two gateway configurations enable a Web browser to access the control system. In both cases, the e-Control gateway must reside on the same machine as the Web server containing the HTML pages. This applies to both Java-based and e-Control 2 pages.
  • Page 44 40 • Crestron e-Control® Connected to http://192.168.1.200 Web browser 192.168.1.XXX Ethernet Network Control System/Gateway (192.168.1.200) Web server: HTML Pages (IP ID 04) e-Control PC Interface (IP Address: 127.0.0.1, IP ID 04) Controlled Devices Crestron e-Control Web browser Reference Guide – DOC. 6052...
  • Page 45: Activecnx

    Crestron SDK. Like Crestron’s Java components, an ActiveCNX control has the capability to connect to the e-Control gateway; send and receive digital, analog, and serial signals, using the same “join number” scheme as a touchpanel.
  • Page 46 Feedback from the devices is sent to the control system and goes back in real time to the PC application. 42 • Crestron e-Control® PC/CNX Gateway (192.168.1.100) 192.168.1.XXX Ethernet Network Control System (192.168.1.200)
  • Page 47 “hardware” gateway that is built into the Ethernet card on the control system. Here each ActiveCNX control calls the Connect( ) method to start a TCP/IP connection to the control system. The e-Control gateway receives the packets and performs the translation to CIP.
  • Page 48 The ActiveCNX control can also communicate directly with a CEN device. In this configuration, the CNX-EGWY is required, since the CEN device does not provide an internal “hardware” gateway. 44 • Crestron e-Control® PC (192.168.1.3) ActiveCNX Control Connect (IP Address 192.168.1.7, IP ID 06) TCP/IP PC/CNX Gateway (192.168.1.9)
  • Page 49: Intersystem Communication

    Control System A (192.168.1.55) Ethernet ISC Symbol (IP ID 08) 192.168.1.XXX Ethernet Network IP Table Entry: IP Address 192.168.1.55, IP ID 08 Controlled Devices Software Control System B (192.168.1.3) Ethernet ISC Symbol (IP ID 08) (192.168.1.XXX) Crestron e-Control® • 45...
  • Page 50: Appendix A: Glossary

    Internet. Cable modems feature asymmetric transfer rates: around 36 Mbps downstream (from the Internet to the computer), and from 200 Kbps to 2 Mbps upstream (from the computer to the Internet). 46 • Crestron e-Control® Crestron e-Control Reference Guide – DOC. 6052...
  • Page 51 Internet connection at a particular location. It’s especially useful in education and other environments where users change frequently. Using very short leases, DHCP can dynamically reconfigure networks in which there are more Reference Guide – DOC. 6052 Software Crestron e-Control® • 47...
  • Page 52 Download - To receive a file transmitted over a network. In a communications session, download means receive, and upload means transmit. Driver - A workstation or server software module that provides an interface between a network interface card and the upper-layer protocol software running in the computer;...
  • Page 53 The program came to be known as the software. Hub - The device that serves as the central location for attaching wires from workstations.
  • Page 54 NetBIOS computers are identified by a unique 15-character name, and Windows machines (NetBIOS machines) periodically broadcast their names over the network so that Network Neighborhood can catalog them. For TCP/IP networks, NetBIOS names 50 • Crestron e-Control® Crestron e-Control Reference Guide – DOC. 6052...
  • Page 55 Plug-and-Play - The ability of a computer system to configure expansion boards and other devices automatically without requiring the user to turn off the system during installation. Reference Guide – DOC. 6052 Software Crestron e-Control® • 51...
  • Page 56 Storage - The semi-permanent or permanent holding place for digital data. STP (Shielded Twisted Pair) - Telephone wire that is wrapped in a metal sheath to eliminate external interference. 52 • Crestron e-Control® Crestron e-Control Reference Guide – DOC. 6052...
  • Page 57 Server - Any computer whose function in a network is to provide user access to files, printing, communications, and other services. Software - Instructions for the computer. A series of instructions that performs a particular task is called a “program.” The two major categories of software are application software and system software.
  • Page 58 IP addresses. Workgroup - Two or more individuals that share files and databases. Upgrade - To replace existing software or firmware with a newer version. Upload - To send a file transmitted over a network. In a communications session, upload means transmit, and download means receive.
  • Page 59: Appendix B: The Osi Reference Model

    The OSI Reference Model is simply a guideline. Actual protocol stacks often combine one or more of the layers. A protocol stack is a group of protocols that all work together to allow software or hardware to perform a function. For example, the TCP/IP (and UDP/IP) protocol stack...
  • Page 60 Transport - Corresponding to the OSI Transport layer, this is the part of the protocol stack where the Transport Control Protocol (TCP) and User Datagram Protocol (UDP) implemented by e-Control can be found. TCP works by asking another device on the network if it is willing to accept information from the local device.
  • Page 61: Appendix C: Control System Timing Data

    ® Crestron e-Control Software Appendix C: Control System Timing Data X-Series Control Systems Crestron e-Control® • 57 Reference Guide – DOC. 6052...
  • Page 62 Software 58 • Crestron e-Control® Crestron e-Control Reference Guide – DOC. 6052...
  • Page 63 ® Crestron e-Control Software Crestron e-Control® • 59 Reference Guide – DOC. 6052...
  • Page 64: Appendix D: Web Server Console Commands

    Def_router Password Info Restart then LimitWeb 60 • Crestron e-Control® Crestron e-Control Add a “master” entry to IP table. Add a port map to the NAT table. Set port number for CIP. Set port number for CTP (console). Set default router.
  • Page 65: Ssl Console Commands

    CA. The stored certificate file in the host is the format *.CER, which is an ASCII file. The command will convert the file to “\\sys\srv_cert.der”. Reference Guide – DOC. 6052 SSL: OFF,CA Software Crestron e-Control® • 61...
  • Page 66: Appendix E: Faq For It/Mis Professionals

    IP. These devices can be Wintel machines, pocket PCs, or Web tablets. Remote monitoring – Crestron programs can be run on a PC to monitor the status of all Crestron control processors on the network.
  • Page 67 One of the features of the Crestron Control Processor is that it has a built-in Web server. This Web server is used for serving up pages that communicate directly with the processor.
  • Page 68: Software License Agreement

    This Agreement may only be modified by a writing signed by an authorized officer of Crestron. Updates may be licensed to You by Crestron with additional or different terms. This is the entire agreement between Crestron and You relating to the Software and it supersedes any prior representations, discussions, undertakings, communications or advertising relating to the Software.
  • Page 69 “applets” incorporated into the Software), the accompanying media and printed materials, and any copies of the Software are owned by Crestron or its suppliers. The Software is protected by copyright laws and international treaty provisions. Therefore, you must treat the Software like any other copyrighted material, subject to the provisions of this Agreement.
  • Page 70: Return And Warranty Policies

    CRESTRON shall not be liable to honor the terms of this warranty if the product has been used in any application other than that for which it was intended, or if it has been subjected to misuse, accidental damage, modification, or improper installation procedures.
  • Page 71 ® Crestron e-Control Software This page intentionally left blank. Crestron e-Control® • 67 Reference Guide – DOC. 6052...
  • Page 73 ® Crestron e-Control Software This page intentionally left blank. Crestron e-Control® • 69 Reference Guide – DOC. 6052...
  • Page 74 Crestron Electronics, Inc. Reference Guide – DOC. 6052 15 Volvo Drive Rockleigh, NJ 07647 7.03 Tel: 888.CRESTRON Fax: 201.767.7576 Specifications subject to www.crestron.com change without notice.

Table of Contents