Crestron Ethernet, Operator'S Manual

Page 1: ......

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 ...

Page 3: ...plied with the dealer kit to connect the PC COM port to the COM IN port on the eServer Refer to eServer Ports on page 3 for COM IN port pinout details 3 Assign IP Address Start the Crestron Viewport software Verify the PC communications parameters Alt D in the Viewport No handshaking is required and the default baud rate is 57600 Click on OK and depress ENTER on the keyboard The prompt should appe...

Page 4: ...lement the Chosen Configuration 7 Setup Menus 11 Programming with SIMPL Windows 20 CEN OEM Symbol 20 SIMPL Interface 20 Web Page Demos 25 Problem Solving 27 Troubleshooting 27 Further Inquiries 28 Software License Agreement 29 Return and Warranty Policies 31 Merchandise Returns Repair Service 31 CRESTRON Limited Warranty 31 Appendix A IP Table Setup 32 Appendix B Uploading Web Pages 33 Appendix C ...

Page 5: ...tant control no computer server is required Graphical User Interface GUI is stored on board so a controlled device carries its own interface An onboard SIMPL control engine provides the power of a full blown Crestron system for programming macros and automated functions Use Crestron VT Pro e to generate HTML GUIs to load into the eServer or use with a third party HTML software package such as Micr...

Page 6: ...enerated Provides character pacing in units of milliseconds for all of the data specified The range of the pacing is from 1 to 31 milliseconds Pacing greater than 31 millisecond defaults to the maximum 31 ms Due to the built in SIMPL logic engine the eServer is a very powerful one port control system with Ethernet and web server built in The web server with 2Mb of flash memory can store custom web...

Page 7: ...aragraph AC Power Pack Specifications CRESTRON POWER PACK INPUT SPECS OUTPUT SPECS PW 1205 120V 60Hz 12VDC 5 A PWI 1210 230V 50Hz 12VDC 1A AC Power Pack Polarity DEVICE This 9 pin connector DB9F connects to serial equipment that is to be controlled This bidirectional serial port is used for RS 232 communication NOTE The pinout of each 9 pin port is non standard refer to table after this note This ...

Page 8: ...ommunication type should be connected eServer Pinout COM IN PIN DIRECTION DESCRIPTION 1 To eServer Carrier Detect CD 2 From eServer TXD RS 232 Transmit Data 3 To eServer RXD RS 232 Receive Data 4 From eServer DTR 5 RS 232 Signal Common 6 No Connect 7 To eServer CTS RS 232 Clear to Send 8 From eServer RTS RS 232 Request to Send 9 No Connect ETHERNET This RJ45 modular connector provides Ethernet con...

Page 9: ...receives Ethernet data TXD Ethernet This LED illuminates when the Ethernet port on the eServer transmits Ethernet data LNK Ethernet This LED illuminates when there are attachments to the Ethernet port on the eServer ERR Ethernet This LED illuminates when any error is detected It flashes when permanent ROM is reprogrammed RXD Device This LED illuminates when the eServer receives data on the DEVICE ...

Page 10: ...om New users are required to register in order to obtain access to the FTP site 2 CNX upgrade files are required for either CNMSX AV PRO or CNRACKX DP Filenames for CNX upgrade files have a UPZ extension and SmarTouch files are in one EXE All can be obtained from the Downloads page OPSYS Library of the Crestron website 3 Crestron recommends the use of Microsoft Internet Explorer As of the date of ...

Page 11: ...rol of a Device Through the eServer on page 8 of the five configurations presented does not apply Choose the Configuration The second question to answer when deciding to incorporate an eServer into a development project is which configuration should be used The configuration depends on the application Any combination of the configurations listed below are permissible with the eServer Although most...

Page 12: ...eServer is concerned is that these documents are binary files Therefore it is up to the browser to do most of the work of displaying these media rich files in a useful way 2 Crestron Control System Control of a Device Through the eServer Manufacturers have requested that Crestron support a Cresnet port on non Crestron devices However Crestron believes in an open platform approach allowing our part...

Page 13: ...X Gateway Software Compared to the two previously mentioned configurations this one is less common This configuration allows the customer s device to interface to a web server and GUI web pages stored and running on a local PC Although there are many reasons a designer may choose this configuration the primary cause is for security For example if the objective is to control a projector through the...

Page 14: ...heir existing tools that communicate via standard RS 232 with the eServer With relatively little work such a configuration effectively makes their tools Internet ready The ActiveCNX control a free download component of the Crestron e control SDK permits implementation of this configuration fairly easily Refer to the Active CNX Software Introduction Tutorial manual latest revision of Doc 5777 for a...

Page 15: ... data sent to this socket is sent out the DEVICE port This type of advanced interface is only recommended for programmers with TCP IP socket programming experience The eServer listens on a predefined port number The port number is assigned using the setup menus First verify that the LISTEN TCP option is ON port device listen tcp on Then assign the predefined port number For example assume the pred...

Page 16: ...d before applying power to it open the communications package that resides on the PC Viewport from either SIMPL Windows or VisionTools Pro e is used in the illustrations that follow Be sure to set the PC communication parameters Alt D as shown after this paragraph No handshaking is required do not check the XON XOFF or RTS CTS check boxes Port Settings Dialog Box as viewed after entering Alt D NOT...

Page 17: ...raph NOTE Use the default font for the return message to appear correctly The Viewport default font is Terminal Regular 9 Main Menu in Viewport Window Commands are listed in the left most column with a brief description in the right most column Notice that DOS type commands are prevalent e g dir jpg Operations Guide DOC 8148 Ethernet OEM Module eServer 13 ...

Page 18: ...ic IP addresses which are not permanently stored and can therefore be lost after a power cycle Sample Response to the add_master Command NOTE The Add_master command only applies if a CNX control system is communicating to the eServer This command is not necessary for accessing the eServer via a web browser Each row of the master list contains an index number enclosed in brackets the IP ID of the d...

Page 19: ... To change the IP mask enter the new IP mask after the ip_mask command For example to change the IP mask of the connected eServer to 255 255 255 0 enter the following ip_mask 255 255 255 0 def_router The default router is the address of the router the eServer uses to communicate with devices that are not connected directly on that subnet To change the default router enter the default router addres...

Page 20: ...port Sample Response to the port Command Options for the port command are listed in the left most column Possible settings for each of the options are listed in the right most column Only the options for the DEVICE port can be changed For example to turn on hardware handshaking for the DEVICE port enter the following command port device h w on Sample Response to the port device h w on Command Once...

Page 21: ...OMMAND DESCRIPTION port CR Shows specs for COM IN and DEVICE ports port device 9600 N81 CR Sets DEVICE port to 9600 no parity no handshake no pacing and mode is NONE port device disable CR Disables DEVICE port reboot Entering the reboot command permits the user to perform the software equivalent of cycling power to the connected eServer This is used to allow changes in the settings to take effect ...

Page 22: ...mmand 4 From the Open window browse and highlight the upload file Click on OK 5 The Transfer In Progress window appears while the transfer is in progress Transfer In Progress Window 6 When the transfer is complete the eServer reboots Depress ENTER to re establish communications with the eServer prepare The prepare command must be issued before the system command It prepares the system prior to a f...

Page 23: ...mmand A Saved and Current column is displayed Saved is the setting after power up Current defines the true setting as detected by the system For example notice in the previous illustration that SIMPL is Saved ON and Current OFF This indicates that even though SIMPL has been enabled after power up it is impossible to support this setting because SIMPL is not running Enter the appropriate options co...

Page 24: ...s controlled via Ethernet from a Crestron control system gets an IP ID and an entry in the IP Table of the control system Refer to ip_adr on page 15 for setting the CEN OEM IP ID For details about the IP Table refer to Add_master on page 14 Use of the CEN OEM symbol is necessary to incorporate the eServer functionality in a Crestron CNX control system The SIMPL program or module that complements t...

Page 25: ...dows is really a DIGITAL_INPUT to the CEN OEM in SIMPL The join numbers for each I O list start at join 1 The first DIGITAL_INPUT in SIMPL maps to dig o1 in SIMPL Windows the second DIGITAL_INPUT in SIMPL maps to dig o2 in SIMPL Windows etc The first ANALOG_OUTPUT in SIMPL maps to an_i1 in SIMPL Windows the second ANALOG_OUTPUT in SIMPL maps to an_i2 in SIMPL Windows etc Example Program For exampl...

Page 26: ...ITAL_INPUT power_off goes high in the SIMPL module When power off goes low the DIGITAL_INPUT power_off goes low Notice that the signal names do NOT have to correspond in any way to the variable names used in the SIMPL module The important thing is the order in which they are defined Sometimes for the sake of organization it is useful to space the signals out on the gate In order to leave gaps in t...

Page 27: ..._INPUT_JOIN treats STRING_INPUT and BUFFER_INPUT types the same way Consult the latest revision of the SIMPL Language Reference Guide Doc 5797 for detailed information on using these declarations Renumbering the Example Program The following example demonstrates how the ranges can be renumbered SIMPL Example Renumbered Ranges Operations Guide DOC 8148 Ethernet OEM Module eServer 23 ...

Page 28: ... Analog I O Definition Renumbered Ranges CEN OEM Serial I O Definition Renumbered Ranges NOTE When saving the SIMPL module it should be saved as an OEM file type select FILE SAVE AS and choose the new file type from the drop down Save As 24 Ethernet OEM Module eServer Operations Guide DOC 8148 ...

Page 29: ...b page is defined when web pages are uploaded to the device refer to Appendix B Uploading Web Pages on page 33 Default Web Page The default web allows the user to select either a switcher or a projector as a demonstration device In a real implementation only one device would be controlled by the eServer Two devices are included only to demonstrate various configurations The default page also conta...

Page 30: ...e The text fields can provide information from the device such as the part number software version or an error message The input and output lists under the switcher details are example of controls using the analog signal type Analog values can range from 0 to 65535 and can be displayed as a percent or a value The SIMPL module in the OEM device can translate serial commands from the device into ana...

Page 31: ...Solving Troubleshooting The table after this paragraph provides corrective action for possible trouble situations If further assistance is required please contact a Crestron technical support representative Operations Guide DOC 8148 Ethernet OEM Module eServer 27 ...

Page 32: ...ng valid setup commands Handshaking selected as a communication parameter Uncheck XON XOFF and RTS CTS check boxes from the Port Settings dialog box Crestron e control web page is not communicating to a control system Various causes Refer to the Troubleshooting section in the latest version of the Software Development Kit CNX Gateway Operations Guide Doc 5778 The IP address for a specific IP ID in...

Page 33: ...mands data or instructions from or to another computer b for local campus or wide area network internet or web hosting services or c pursuant to any rental sharing or service bureau arrangement The Software is designed as a software development and customization tool As such Crestron cannot and does not guarantee any results of use of the Software or that the Software will operate error free and Y...

Page 34: ...ninety 90 days from the date of receipt and b that any hardware accompanying the Software will be subject to its own limited warranty as stated in its accompanying written material Crestron shall at its option repair or replace or refund the license fee for any Software found defective by Crestron if notified by you within the warranty period The foregoing remedy shall be your exclusive remedy for...

Page 35: ...vered This warranty extends to products purchased directly from CRESTRON or an authorized CRESTRON dealer Purchasers should inquire of the dealer regarding the nature and extent of the dealer s warranty if any 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 misu...

Page 36: ... IP addresses Three of these IP addresses are not stored in non volatile ROM and can therefore be lost after a power cycle Commands from the setup menus show the current IP table and implement changes to the list Refer to Add_master on page 14 for details 32 Ethernet OEM Module eServer Operations Guide DOC 8148 ...

Page 37: ...Project option transfers the selected web page and all files and subdirectories in the same folder as the selected web page The Only Transfer Files that have Changed option transfers those files in the selected file directory that have different dates from the last time the web page was transferred The Transfer Single File option transfers the selected web page only Choose the appropriate option a...

Page 38: ... the appropriate web page and click OK to initiate transfer The Transfer In Progress dialog box appears to reveal the status of the transfer The user has the option to cancel the transfer at any time Otherwise the transfer of web pages to the eServer should conclude successfully Transfer In Progress Dialog Box 34 Ethernet OEM Module eServer Operations Guide DOC 8148 ...

Page 39: ...eters and be sure the eServer power pack is connected and supplying power to the device Depress ENTER on the keyboard If the Viewport responds with communications is verified From Viewport select File Transport Send SIMPL Program to the CEN OEM Crestron Viewport The Open dialog box appears Browse for the desired csz file and select OK The file is transferred to the eServer Operations Guide DOC 814...

Page 40: ... include e control web pages or applications written using the Crestron ActiveCNX control Default Router Default router is the address of the router the device uses to communicate with devices that are not connected directly to the local network Graphical User Interface Allows users to navigate and interact with information on their computer screen by using a mouse to point click and drag icons an...

Page 41: ... the given device Furthermore the IP ID in the given device s static master table must be set to the IP address of the control system IP Mask Internet protocol IP mask is a number that is used in conjunction with the IP address to determine whether or not a particular IP address is on the local network If it is on the local network communicate directly Otherwise use a router attached to the IP net...

Page 42: ...ormation to their proper destinations Software routers are sometimes referred to as gateways Server A server is a computer that handles requests for data e mail file transfers and other network services from other computers i e clients SIMPL Module A file containing a program written in Crestron s SIMPL control system programming language Standard TCP IP Sockets Describes a standard way for progra...

Page 43: ...n as a website HTML documents that reside somewhere on the Internet or on the local hard drive can be read with a web browser Web browsers read HTML documents and display them as formatted presentations with any associated graphics sound and video on a computer screen Web pages can contain hypertext links to other places within the same document to other documents at the same website or to documen...

Page 44: ......