How it Works
Crestron
Loading...
SW-MAIL
User Manual
109 pgs644.84 Kb0

Crestron SW-MAIL User Manual

CRESTRON
e-control™ Mail
(SW-MAIL)
version 1.4
© 1999 Crestron Electronics, Inc.
Crestron e-control Mail SW-MAIL
Contents
A Note on Printing This Document................................................................................................... 4
Quick Start ........................................................................................................................................ 4
Section Summary .............................................................................................................................. 4
What is Crestron e-control Mail? ...................................................................................................... 8
System Terminology and Topology .................................................................................................. 8
Leading Specifications .................................................................................................................... 11
Requirements................................................................................................................................... 11
Installation....................................................................................................................................... 12
Licensing......................................................................................................................................... 12
Communications Setup.................................................................................................................... 15
Test Communications...................................................................................................................... 19
Additional Server Side Setup .......................................................................................................... 19
Specifying a Configuration File ...................................................................................................... 20
Password Access ............................................................................................................................. 21
e-Mail Options................................................................................................................................. 22
COM Settings Definition................................................................................................................. 24
Signal Block Definition................................................................................................................... 26
Server Windows and Menus............................................................................................................ 37
Table design .................................................................................................................................... 42
Editing the Existing Database.......................................................................................................... 46
Recipient Lookup............................................................................................................................ 47
Message Lookup ............................................................................................................................. 47
Implicit Recipient Name & Address................................................................................................ 47
Manual Selection of Recipient and/or Message............................................................................... 48
Text Substitution Directives............................................................................................................ 48
Text File Inclusion .......................................................................................................................... 49
Rescanning...................................................................................................................................... 49
Identification ................................................................................................................................... 50
Message types ................................................................................................................................. 50
Syntax.............................................................................................................................................. 50
Example........................................................................................................................................... 51
Demo 1: The Shortcut Signals......................................................................................................... 52
Demo 2: The LookupMsg and LookupRcpt Signals ....................................................................... 53
Demo 3: Interactive Scrollers.......................................................................................................... 55
Demo 4: Receiving e-Mail .............................................................................................................. 56
ii •• Table of Contents Installation & Reference Guide — Doc. 5798
Crestron e-control Mail SW-MAIL
Server Protocol................................................................................................................................59
Signal Block Definition / Activation............................................................................................... 59
Signal Block Enable / Disable......................................................................................................... 59
Signal Block Error Reporting.......................................................................................................... 59
System Connections........................................................................................................................ 61
Definition of Terms......................................................................................................................... 65
String Proxies.................................................................................................................................. 65
Bit Patterns...................................................................................................................................... 65
Standard e-mail Address Format..................................................................................................... 66
Error Reporting ............................................................................................................................... 67
Signal Summary.............................................................................................................................. 67
Signal Reference.............................................................................................................................. 68
Serial Transmissions...................................................................................................................... 107
Signal Definitions.......................................................................................................................... 107
iii •• Table of Contents Installation & Reference Guide — Doc. 5798
Crestron e-control Mail SW-MAIL
Crestron e-control Mail
How to Use This Manual
A Note on Printing This Document
Adobe and Acrobat are trademarks of Adobe Systems Incorporated.
This Portable Document File (PDF) can be printed with Adobe Acrobat Reader. Printing from a Windows 95 platform, version 4.0 or later, is strongly recommended because the figures print poorly with earlier versions. The latest version is freely available from Adobe at http://www.adobe.com/acrobat/.
Quick Start
To see an “out-of-the-box” demonstration of Crestron e-control Mail as quickly as possible, turn to the Quick Start Guide(s) beginning on the next page.
You will need:
• A Crestron CNMSX-PRO control system
• A touchscreen (LC-3000, CT-3000, CT-3500, or VT-3500); and
• A null-modem cable
Follow the instructions in the guides precisely in the order given and you should be up and running in a matter of minutes.
NOTE: The demos included with this package are all compiled to two versions, a COM version for use with an RS-232 serial connection, and a TCP version for use with an Ethernet connection (the latter case requiring the CNX Gateway). The Quick Start Guides refer only to the COM versions of these programs because setting up a serial connection is far simpler. We strongly recommend getting at least one demo to work first using a serial connection. Once that works, try the TCP versions. Instructions for setting up TCP/IP communications are provided under “Communications Setup, Control System Side, TCP/IP,” on page 17).
You do not need to license the software to try the demos provided you are still within the 15-day free trial period.
Section Summary
For more information, start with “Introduction” on page 8. Detailed setup and configuration instructions follow “Introduction”.
4 •• How to Use This Manual Installation & Reference Guide — Doc. 5798
Crestron e-control Mail SW-MAIL
Then comes information about the e-Mail database file, including information about text substitution and file inclusion directives.
After that, the examples (demos) are described and illustrated in detail. Appendices include Theory of Operation, along with a complete Signal Reference.
5 •• How to Use This Manual Installation & Reference Guide — Doc. 5798
Crestron e-control Mail SW-MAIL
Quick Start Guide 1: Sending e-Mail (demo3)
1 Install this package on your PC
Presumably, since you are reading this PDF file, you have already done this.
2 Connect a CNMSX-PRO (with touchscreen)
Connect a programming cable (a standard modem cable) from any COM port on your PC to the COMPUTER port on the front or back of the CNMSX-PRO control system. Connect a touchscreen to the control system set up for CRESNET ID 03.
3 Upload all control system software
The demo files can be found in the demos folder (also accessible through the Start Menu shortcut e-control Mail Demos)
Open the Crestron Viewport and establish communications with your control system. Use the FileTransfer | Send Touchpanel… command to upload demomail.hex to the touchscreen at ID 03. Use the FileTransfer | Send Program… command to upload the compiled SIMPL windows file demo3COM.bin to the CNMSX-PRO.
4 Connect the null modem cable
Make sure pins 4, 5, and 6 are not connected.
Connect a null-modem cable from COM1 on the PC to COM A on the CNMSX-PRO.
The installer sets the server to use the Configuration Settings file demomail.ini.
The initial configuration password is: crestron2
Depress the down-arrow key to leave the row, and click Yes to the “Commit Changes?” dialog.
5 Run the “server”
Select shortcut e-control Mail Server from the Crestron folder in the Windows Start Menu. If the title bar of the window does not read “e-control Mail Demos,” use the File | Configuration file… command to select the file demomail.ini.
6 Specify an SMTP (outgoing mail) server address
Give command Server | Configure…, select the e-Mail tab, and enter an SMTP server’s IP address or domain name. Close the window.
7 Enter your e-mail address
For testing purposes, you must provide an e-mail address which you can check for incoming mail. Give command e-Mail | Tables… to bring up the e-Mail Tables window. Enter your address in the addr field (column) of the first record (row) (GEORGE WASHINGTON) of the eMail_Addr table. Save the change by either repositioning the cursor to a different record or by closing the window.
8 Start server protocol
Give the command Server | Start Server w/Signal Analyzer. (The Signal Analyzer is good for demos because it shows you the various signals going back and forth.)
9 Start the demo
On the touchscreen, navigate through the setup instructions to the demo screen. This final page-flip to the demo screen starts the demo.
10 Send an e-Mail message!
From the SILLY MESSAGES list, select the message called, INVITE. Notice that the default recipient for this message is “George Washington” (you). Or, select another message, then select GEORGE WASHINGTON from the U.S. PRESIDENTS list to override the default. Press the Send Now button. When the button feedback goes low, the message has been sent. (You should now check your incoming mail for a message from the control system.)
6 •• Quick Start Guide 1: Sending e-Mail (demo3) Installation & Reference Guide — Doc. 5798
Crestron e-control Mail SW-MAIL
Quick Start Guide 2: Receiving e-Mail (demo4)
1 Install this package on your PC
Presumably, since you are reading this PDF file, you have already done this.
2 Connect a CNMSX-PRO (with touchscreen)
Connect a programming cable (a standard modem cable) from any COM port on your PC to the COMPUTER port on the front or back of the CNMSX-PRO control system. Connect a touchscreen to the control system set up for CRESNET ID 03.
3 Upload all control system software
The demo files can be found in the demos folder (also accessible through the Start Menu shortcut e-control Mail Demos)
Open the Crestron Viewport and establish communications with your control system. If you have not already done so, use the FileTransfer | Send Touchpanel… command to upload demomail.hex to the touchscreen at ID 03. Use the FileTransfer | Send Program… command to upload the compiled SIMPL windows file demo4COM.bin to the CNMSX-PRO. You may now close the Viewport.
4 Connect the null modem cable
Make sure pins 4, 5, and 6 are not connected.
Connect a null-modem cable from COM1 on the PC to COM A on the CNMSX-PRO.
The installer sets the server to use the Configuration Settings file demomail.ini.
The initial configuration password is: crestron2
5 Run the “server”
Select shortcut e-control Mail Server from the Crestron folder in the Windows Start Menu. If the title bar of the window does not read “e-control Mail Demos,” use the File | Configuration file… command to select the file demomail.ini.
6 Specify a POP3 (incoming mail) server address
Give command Server | Configure…. In the resulting Configuration Options window, select the e-Mail tab and enter a POP3 server’s IP address or domain name.
7 Enter your e-mail address
Select the Signal Blocks tab. Select the signal block called “DEMO4” and click the Modify… button. In the resulting e-Mailbox Signal Block Definition Window, provide an e-mail account name and password. In each window, click OK to close.
8 Start the “server protocol”
Give the command Server | Start Server w/Signal Analyzer. (The Signal Analyzer is good for demos because it shows you the various signals going back and forth.)
9 Start the demo
On the touchscreen, navigate through the setup instructions to the demo screen. This final page-flip to the demo screen starts the demo.
10 Download new mail
Touch the button Touch here to check manually for NEW MAIL. The button feedback stays active while the server contacts the e-mail host. All new messages are displayed. Scroll the listing to see all the messages.
11 Read a message!
Touch the listing to select a message to read.
7 •• Quick Start Guide 2: Receiving e-Mail (demo4) Installation & Reference Guide — Doc. 5798
Crestron e-control Mail SW-MAIL
Introduction
What is Crestron e-control Mail?
Crestron e-control Mail (SW-MAIL) empowers any Crestron control system with the ability to construct and transmit, and receive and view e-mail messages.
Simply by asserting specific signals, your control systems can send arbitrary text, whole text files, canned messages, alerts, status updates, etc., to any e-mail address. Messages can be sent to a control system for display and to assert specific signals.
The term “server” does not imply a need for specialized hardware. Any PC meeting the minimum requirements on page 11 will suffice to run swserver.exe.
The actual e-mailing is not carried out by the control systems themselves, but by a remote e-e-mail host. The control system relies on intermediaries to translate communications protocols and supply other services. One of these intermediaries is the freely distributed Crestron e-control Software Server. SW-MAIL is a licensable component of this “server” application (swserver.exe) which is hosted on a standard PC running Windows® 95/98/NT and provides the following core technologies:
• Signal-level communications with the control system
• Access to database tables
• Access to external services (such as e-e-mail hosts) through the PC’s network
connection.
The server is connected to the control system via either a serial cable through an RS-232 port or an Ethernet network through a LAN port. To effect the latter type of connection, the control system relies on an intermediary, the Crestron CNX Gateway, to translate communications protocols.
To aid in making all this clear, the following illustrated discussion of system terminology and topology should prove useful at this point.
System Terminology and Topology
This manual simultaneously discusses several different inter-connected computer systems. To reduce confusion, throughout the manual, these systems are referred to using the terms in the following table. (Also refer to the diagrams on the next page.)
Term Explanation
The system
or the control system
The server
or the software server
The gateway
or the CNX Gateway
The host
or the e-mail host
The control system(s) are connected to the server via direct RS-232 serial connection or via TCP/IP to the gateway and thence via TCP/IP to the server.
One of a number of Crestron control system(s), which may include any combination of the following models: CNMS, CNRACK,
CNMSX-PRO, CNMSX-AV, and CNRACKX.
The Crestron Software Server, swserver.exe, which runs on a PC under Microsoft® Windows® 95 or Windows NT®.
A communications conduit that sits between the server and the control system(s).
An e-mail host used for exchanging mail with the system and other e-mail clients.
8 •• Introduction Installation & Reference Guide — Doc. 5798
Crestron e-control Mail SW-MAIL
NOTE: “Connected via TCP/IP” means any node (computer) visible on the Local Area Network (LAN). If the LAN is connected to the Internet, this could include any node visible anywhere on the Internet. Since a node can also see itself, this implies that multiple services can run on the same machine. For example, the gateway and the server can be “self-hosted” in this way.
The server is also connected to the e-mail host via TCP/IP (which can also be self­hosted on the same machine, although this is not normally the case).
The e-mail host is actually comprised of two separate pieces of software, one for incoming mail (a POP3 server ) and one for outgoing mail (an SMTP server). While these software generally reside on the same physical computer (host), this is not always the case. Whatever the case, we generally use the term host herein to refer to both of them as a single entity. (Nevertheless, it should be pointed out that if your application requires only sending mail or only receiving mail, you only need to be connected to one server or the other.)
In the illustrations that follow, the communication pathways are represented by the arrows. The physical network is not represented, however.
System block diagram, showing communication pathways (all connections using TCP/IP)
Crestron
control system
VT-3500 VT-3500 VT-3500
Crestron
CNX
Gateway
Crestron Software
Server
e-Mail
Host
Crestron
control system
VT-3500 VT-3500 VT-3500
Internet
9 •• Introduction Installation & Reference Guide — Doc. 5798
Crestron e-control Mail SW-MAIL
System block diagram, showing communication pathways (curved arrows are RS-232 serial connections; straight arrows are TCP/IP)
Crestron
control system
Crestron
control system
Crestron
VT-3500 VT-3500 VT-3500
Software
VT-3500 VT-3500 VT-3500
Server
e-Mail
Host
NOTE: The CNX Gateway is not necessary when using RS-232 serial communications.
Internet
TCP/IP connections between the server and the control systems require that each side of the connection be provided with the IP address of the other. This kind of connection also requires the use of the CNX Gateway which is separately licensed software that facilitates communication between the server and the control system. The CNX Gateway is typically installed on the server (when sufficient TCP/IP sockets are available) or it can be installed on any computer visible (i.e., pingable) on the TCP/IP network. There only needs to be one Gateway running on one computer to service the needs of all the computers and CNX control systems on the network. However, multiple Gateways are perfectly permissible as long as they are run on different computers.
10 •• Introduction Installation & Reference Guide — Doc. 5798
Crestron e-control Mail SW-MAIL
Leading Specifications
Specifications Table
SPECIFICATIONS DETAILS
SWSERVER.EXE
(included with this package)
CNMS/RACK Operating System Version 3.18.12 or later CNMSX/RACKX Operating System Version 5.09.25 or later CNMSX/RACKX Monitor Version 5.09.25 or later CNMSX/RACKX TCP/IP Stack Version 5.09.10 or later CNX Gateway Version 2.08.04 or later SIMPL™ Windows® Version 1.4 or later; or
VisionTools™ Pro (VT Pro-e) Version 2.0.8.2 or later
Version 1.4
Version 1.3 with Symbol Library Update 067 or later
Requirements
The server should meet these minimum system requirements.
Windows 95/98/NT Operating System hardware requirements
32 MB RAM 100 MB hard drive space 133 MHz or faster Pentium processor
A faster processor is recommended for serving multiple connections
simultaneously
800 x 600 or higher screen resolution COM ports
Network Interface Card
Dial-up connection
TCP/IP sockets
(These are software constructs provided by your operating system. The maximum number of sockets is operating system dependent.)
Server requires one socket per server–control system connection
CNX Gateway (see below) requires one socket + one additional socket per
Required to make serial (RS-232) connections to control systems (one port per control system). (See Cable requirements below.)
Required to make EtherNet connections to control systems. Also required in order to contact an e-mail host server via EtherNet connection.
Alternate means of contacting an e-mail host server via TCP/IP. (See Appendix F for configuration information.)
Required for EtherNet control system connections only.
server–control system connection
11 •• Introduction Installation & Reference Guide — Doc. 5798
Crestron e-control Mail SW-MAIL
Cables
Precise CNSP-532 specs are available in the Crestron Cable Database.
Null modem cable, Crestron model CNSP-532 or equivalent
Required for serial control system connections only. Warning: Do not use a generic null modem cable.
Auxiliary software
CNX Gateway
Required for TCP/IP (EtherNet) connections between the server and the control systems. Not required for serial connections.
E-mail hosts
An SMTP server for sending mail
To send e-mail, this server must be running on a host visible to your system, either locally (on your LAN) or remotely (via an Internet connection).
A POP3 server for receiving mail
To receive e-mail, this server must be running on a host visible to your system, either locally (on your LAN) or remotely (via an Internet connection).
Installation
As of this writing, the Crestron Downloads page can be found at:
http://ftp.crestron.com/library/
A 15-day free trial follows initial installation. If you are still within the 15-day period, you have the option to postpone licensing and skip to the next section.
Server components are separately licensed. A license for the e-mail component must be obtained from Crestron even if other components are already in use.
To install the Software Server, first download the installer package from the Crestron FTP site. To do this, first go to the Crestron website and select the Downloads page. New users must register. Proceed to the ECONTROL Library. Simply click on SW-MAIL.EXE to start the download.
Once the install package arrives on your PC, double-click the icon to initiate the install. Directions for the install are provided. The package is typically installed in C:\Crestron\econtrol. During the install, the package reminds the user that a CNX Gateway is required. (This is actually only true for TCP/IP connections. Direct RS-232 connections do not require the CNX Gateway.)
Licensing
Both the Software Server and the CNX Gateway are a licensed products, which means that although both software packages may be freely downloaded from the Crestron FTP site, use of the software requires purchase of licenses from Crestron. Each server running the Software Server must be individually licensed. In addition, to use Ethernet, you must acquire a CNX Gateway license with sufficient connections to accommodate all servers and control systems on your network.
Each package, once installed, generates a “Site Code” specific to the server on which it is running. Upon being provided with these Site Codes, Crestron can issue the appropriate “Site Keys,” which, once entered into each package’s licensing window, enables the full functionality of the software.
12 •• Introduction Installation & Reference Guide — Doc. 5798
Crestron e-control Mail SW-MAIL
Obtaining a License
e-control Software Server – Upgrade/Transfer License window showing an “unlimited” e-mail license — shown activated (checked)
You must use the Copy button to copy the SITE CODE to the clipboard. (Copying with Ctrl+C does not work from this field.)
Open the server application. Select Server | License to open the e-control Software Server – Upgrade/Transfer License window, shown above. The license can be
obtained over the phone or via e-mail. Call Crestron Customer Support with the “Site Code” shown in the Site Code field. However, it is easier and far more reliable to copy the “Site Code” into an e-mail message addressed to license@crestron.com. Once received, Crestron Customer Support issues a “Site Key” which must either by typed or pasted into the Site Key field of the window. Once entered, click on the Update License button. If the key is valid, the licensed components appear in the list above. Before closing the License Window, be sure to activate the components you plan to use. In the above example, the user has checked the box next to SW-MAIL.
It is permissible to exit the program while waiting for a “Site Key” to be issued. The application can be restarted and the “Site Key” entered at a later time. The “Site Key” issued is only valid on the same computer. It does not work on a different computer.
The License Window of the CNX Gateway is almost identical to the above. See the documentation that comes with the Gateway package for specific instructions.
Transferring an Existing License to Another Computer
As mentioned, a license is only valid on the computer for which it was obtained. However, a license can be transferred from one computer to another without the need to contact Crestron first. There are several reasons to transfer a license. The application developer may set up the system off-site, then transfer the license to the actual computer on-site when ready. Alternatively, if the hardware or operating system on the computer where the server is licensed is upgraded, the license may cease to be valid, but could be transferred to another computer before the upgrade and then back to the original machine after the upgrade.
On both the source computer (where the license is currently valid) and the destination computer (where the license is to be transferred), open the server application. Select Server | License to open the e-control Software Server –
13 •• Introduction Installation & Reference Guide — Doc. 5798
Crestron e-control Mail SW-MAIL
Upgrade/Transfer License window (shown above). Make sure this window is active on both computers.
Step 1. On the destination computer, create a preparation file on a diskette in the A: drive by inserting a blank, formatted diskette and selecting Prepare Diskette. This creates a file on the diskette which indicates who is receiving the license. A second, backup copy of the file is also created. Alternatively, these files can be created on another portable media (e.g. Zip disc) or a network drive by simply browsing for a new file location in the save file window. If you plan to transfer via a network drive,
first make sure that both computers have the appropriate read/write access to the drive and folder being used.
Step 2. After the above step has completed, remove the diskette from the drive and insert it into the source computer’s floppy drive. Do not flip the write-protect tab; the diskette must remain write-enabled. Click on the Transfer License button. The source computer reads the preparation file to see which computer wants the license. It encodes the license for the destination and writes it back to the same file on the floppy diskette (or network drive). The source computer has now passed the license to the file. Only the designated computer can use the license, so the server is no longer licensed on the source computer.
NOTE: At this point in the transfer procedure the server license resides on a file on the diskette or network drive, and not on the computer. If this file should become lost or damaged, the license is lost as well. Because of this, please use the utmost care while performing this transfer.
Step 3. Bring the diskette back to the destination computer. Click on the Transfer License button. The computer reads the license information off the diskette and
transfers the license to itself. The server is now licensed on this machine.
Basic Server Setup
This product requires a proper physical connection between both “sides” of the system — the server and the control system. Furthermore, the software on both sides must be properly configured. As previously discussed, the connection can be either serial via RS-232 cable or Ethernet via Local Area Network (LAN). Choose your mode of communication and refer to the following sections to make the proper physical connections and to configure the software.
The following sections include specific notes in italics for setting up the server and the control system to run the included demo programs. Although the focus is therefore on the demos, the same basic procedures would be followed to ready the system for any other programming as well.
NOTE: If you are setting up the system for the demos, note that the contents of the following sections are also contained in brief in the touchpanel pages for demos 2 and 3. If you are already familiar with system setup procedures, and you are willing to start with demo 2 or 3, you might want to load of the touchpanel as a first step, and follow the on-screen instructions instead. Choose setup instructions for Serial or TCP/IP. Note that both sets of instructions lead to the same demo screen.
The files for all four demos are in a folder called demos which can be located through the following Start Menu shortcut:
Start Menu
| Programs
| Crestron
| e-control Mail
| e-control Mail Demos
14 •• Basic Server Setup Installation & Reference Guide — Doc. 5798
Crestron e-control Mail SW-MAIL
Inside this folder you will find the four demos, with support files:
demo1 demo2 demo3 demo4
demomail.vtp VisionTools touchscreen project file with pages for all four demos demomail.hex (compiled version of above)) demomail.ini Server’s Configuration Settings file which accommodates all four demos Maildemo.mdb Sample database file for use with all four demos
The installer registers demomail.ini as the currently selected Configuration Settings file. (If the server’s title bar does not read “e-control Mail Demos,” use the File | Configuration file… command to reset it.) This file configures the server for all four demos.
Each of the four demo folders contain the following files:
Demo?COM.smw SIMPL Windows project file (RS-232 version) Demo?TCP.smw SIMPL Windows project file (TCP/IP version) demo?COM.bin compiled SIMPL program code (RS-232 version) demo?TCP.bin compiled SIMPL program code (TCP/IP version)
RS-232 is featured in the Quick Setup Guide because it is easy to set up. Because we anticipate strong interest in TCP/IP, we have pre-built both versions for your convenience.
In the above, ? stands for the demo number. The two versions of the SIMPL program for each demo, (COM and TCP) are almost identical, both being configured for a CNMSX-PRO, using the front panel device and a touchpanel with
CRESNET ID = 03. Both versions have ports defined for both serial (RS-232) communications via the CNMSX-PRO’s built-in COM A port (slot 4, port A), and Ethernet (TCP/IP) communications via the LAN port on a CNXENET card installed in the CNMSX-PRO’s DPA slot. In the COM versions, the TCP/IP port is commented off while in the TCP versions, the RS-232 port is commented off. This
is the only difference between the two versions.
The following sections separately describe the setup procedures for connecting multiple control systems via either RS-232 or TCP/IP connections. Actually, a mixture of connections is permitted. For example, two control system might be connected via RS-232 (using the COM1 and COM2 ports) while two more might be simultaneously connected via the TCP/IP network connection.
In the following, the indented, italicized paragraphs contain advice on setting up the server and a control system specifically to run the supplied demo files. You will find that most of the steps have already been accomplished because they are specified by the supplied demo configurations.
Communications Setup
Server Side
1. Run server application by selecting Database Manager from the Crestron
folder of your Start menu.
2. Select config file. Specify a Configuration Settings file (.ini file) by selecting
File | Configuration File…. Refer to “Specifying a Configuration File,” page
20.
The server is installed with a demomail.ini pre-selected as the default configuration file. (This is intended to simplify the Quick Start Guides.)
3. Set communications mode. Select Server | Configure and enter a password to
open the Configuration Options window. (Refer to “Password Access” on page 21). Select the COM Settings tab. The settings for each connection to a control system must match those on the other end (the control system side) of the actual connections. Click on each connection in turn, click the Modify…
15 •• Basic Server Setup Installation & Reference Guide — Doc. 5798
Crestron e-control Mail SW-MAIL
button, and choose either RS-232 (and select the port and speed) or TCP/IP (and set the IP address and IP ID). Click OK to make the changes for each connection.
The demos are pre-configured to use RS-232.
Control System Side, RS-232
Serial communication requires wiring the server directly to the control system.
NOTE: Serial communications requires neither the CNX Gateway software nor the use of an Ethernet network.
1. Connect PC for programming purposes. For each control system to be
connected to the server, temporarily connect the PC containing the control system and touchscreen project files to the control system via a serial cable between any available COM port of the server and the COMPUTER port of the CNX control system. (This could be — but need not be — the same physical machine that runs the Software Server.) Refer to the CNMSX manual (latest revision of Doc. 8118) for instructions. This connection can be removed once the control system is programmed.
2. Install control system program. Upload the compiled SIMPL Windows
program file (.bin file) to each control system.
As supplied, the demo programs are configured for a CNMSX-PRO control system. For other models, using SIMPL Windows, convert the program as described below and recompile.
3. Install touchpanel pages. Upload the compiled VT Pro-e project file (.hex
file) to each control system.
As supplied, the demo touchpanel file, which contains pages for all the demos, is configured for a CT-3000 touchpanel; and the accompanying .hex file is compiled for same. This file however also works fine with an LC-3000, CT-3500, and a VT-3500. If you have one of these models, go ahead and upload the .HEX file as is. If you are working with another panel, convert the file to your target panel and recompile.
4. Connect to server. Connect null-modem cables (Crestron model CNSP-532)
from each control system to the server. Each connection requires its on COM port on the server side. The port to use on the control system depends on the specific model:
CNMSX-PRO. Use one of the built-in COM ports.
The demo files are all configured for a CNMSX-PRO using COM A (slot 4, port A).
CNMSX-AV. Use one of the built-in COM ports.
Use SIMPL Windows to convert the demo files. In the Configuration Manager, drag & drop a CNMSX-AV system onto the CNMSX-PRO. The converted system does not have a front panel, so compile “notices” appear — which can be ignored.
CNRACKX. Install a CNXCOM-2.
Use SIMPL Windows to convert the demo files. In the Configuration Manager, drag & drop a CNRACKX system onto the CNMSX-PRO. The converted system has a CNXCOM-2 card in slot 4; use Port A. The converted system does not have a front panel, so compile “notices” appear — which can be ignored.
CNMS. Install a CNCOMH-2 card. Use of the built-in COM ports for the present
purpose is not recommended.
Use SIMPL Windows to convert the demo files. In the Configuration Manager, drag & drop a CNMS system onto the CNMSX-PRO. The converted system has a CNCOMH-2 card in slot 5; use Port A. The converted system does not have a front panel, so compile “notices” appear — which can be ignored.
CNRACK. Install a CNCOMH-2.
16 •• Basic Server Setup Installation & Reference Guide — Doc. 5798
Crestron e-control Mail SW-MAIL
Use SIMPL Windows to convert the demo files. In the Configuration Manager, drag & drop a CNRACK system onto the CNMSX-PRO. The converted system has a CNCOMH-2 card in slot 4; use Port A. The converted system does not have a front panel, so compile “notices” appear — which can be ignored.
Control System Side, TCP/IP
For more information on control system TCP/IP setup, consult the e-control Overview document, overview.pdf, installed with the CNX Gateway software; or the SIMPL Windows release notes, installed with SIMPL Windows.
TCP/IP communications requires a control system with a LAN/Internet port. Therefore, a CNX generation control system is required (CNMSX-AV, CNMSX-PRO, CNRACKX, or CNRACKX-DP). The CNX control system and the server are both connected to the same network. This connection, once properly configured, can then be used both for system communications (uploading, Test Manager support, Viewport functions) and run-time server/client (server/control system) communications as well. (The latter function however requires the addition of the CNX Gateway software.)
1. Install Ethernet card. Install the CNXENET card into the Direct Processor
Access (DPA) slot of each CNMSX. Refer to the CNXENET manual (latest revision of Doc. 8129) for instructions.
2. Connect server. Connect the CNX control system(s) to the server using one of
the following two methods:
• Connect the control system into the same LAN as the server. Use a commercially
available Ethernet hub to expand the number of connections available by plugging in the LAN, the server, and the control system into the same hub.
• Alternatively, make a two-device private network by connecting an Ethernet
“crossover” cable between the Ethernet port of the server’s Network Interface Card and the LAN port of the CNX control system’s CNXENET card. Do not attempt this with a regular Ethernet cable.
3. Connect PC for programming purposes. For each control system to be
connected to the server, temporarily connect the PC containing the control system and touchscreen project files to the control system via a serial cable between any available COM port of the server and the COMPUTER port of the CNX control system. (This need not be the same machine that runs the oftware Server.) Refer to the CNMSX manual (latest revision of Doc. 8118) for instructions. This connection can be removed once the control system is programmed. Open the Viewport and issue the Setup | Communications Settings… command to reconfigure communications for RS-232.
4. Check firmware versions. Before proceeding, however, verify that the CNX
control system has been loaded with the proper versions of firmware. Still in the Viewport, select File Transfer | Update Control System to bring up a window box containing the current versions of monitor, operating system, and TCP/IP stack. Verify the versions per the “Leading Specifications” (page 11).
In early versions of the CNMSX, it may be necessary to upgrade to an intermediate version of the monitor first and then to the required version of the monitor. (The Viewport issues a notice if this is necessary.)
To upgrade any of these files, retrieve a copy of the latest upgrade package from the Crestron website (OPSYS Library). These files have an extension of .upz which contains all three system components in one compacted file. Once downloaded, browse for the appropriate file in the Update Control System window. Click Send to upload the files to the control system. (When upgrading the system in this manner, always send all three components to avoid incompatibilities.)
5. Define control system IP address. Still in the Viewport, select Functions | Set
Control System IP Information. The Set Control System IP Address window opens. Assign an IP address for the CNX control system. The address should be obtained from the MIS department. The IP address has four fields separated by periods (e.g. 192.168.2.3) and must be unique. Click OK.
17 •• Basic Server Setup Installation & Reference Guide — Doc. 5798
Crestron e-control Mail SW-MAIL
6. Enter gateway address. Still in the Viewport, select Functions | Setup IP
Table to open the IP Table window. Click on the Retrieve Current IP Table
from Control System button to display the current listing. Verify that the IP address for the PC running the CNX Gateway (often but not necessarily the server itself) appears with an IP ID of 03. If it does not appear, use the Add… button to add an entry for IP ID 03. Then click the Send IP Table to Control System button.
7. Switch to TCP/IP. Now that TCP/IP is properly configured, the Ethernet
connection can be used for all subsequent system communications (from SIMPL Windows, Test Manager, Vision Tools Pro-e, and all Viewport functions). See the section below titled “Test Communications” on page 19. Open the Viewport and issue the Setup | Communications Settings… command to reconfigure communications for TCP/IP. The serial cable can now be removed.
8. Install control system program. Upload the compiled SIMPL Windows
program file (.bin file) to each control system.
As supplied, the demo programs are configured for a single CNMSX-PRO control system. For other models, use SIMPL Windows to convert the program as follows and recompile:
CNMSX-AV.
In the Configuration Manager, drag & drop a CNMSX-AV system onto the CNMSX-PRO. The converted system does not have a front panel, so compile “notices” appear — which can be ignored.
CNRACKX. Install a CNXCOM-2 card in slot 4 and use Port A.
In the Configuration Manager, drag & drop a CNRACKX system onto the CNMSX-PRO. The converted system has a CNXCOM-2 card in slot 4; use Port A. The converted system does not have a front panel, so compile “notices” appear — which can be ignored.
9. Install touchpanel pages. Upload the compiled VT Pro project file (.hex
file) to each control system.
As supplied, the demo touchpanel file, demomail.vtp (which contains pages for all four demos), is configured for a LC-3000 touchpanel; and the accompanying .hex file is compiled for same. This file however also works fine with an CT-3000, CT-3500, and a VT-3500. If you have one of these models, go ahead and upload the .hex file as is. If you are working with another panel, convert the file to your target panel and recompile.
18 •• Basic Server Setup Installation & Reference Guide — Doc. 5798
Crestron e-control Mail SW-MAIL
Test Communications
At this point, test your connections.
RS-232 Control Systems
Use the Viewport to verify communications between the server and the CNX control system. Select Diagnostics | Establish Communications. If properly connected, the PC responds with the COM port and baud rate.
TCP/IP Control Systems
First test the IP address of the CNX control system by “pinging” it. From a networked PC bring up an MS-DOS prompt (Windows 95/98) or “Command Prompt” (Windows NT) and type “ping <IP ADDRESS>”, as shown below. The control system responds with several lines “Reply from address < IP ADDRESS >…”. If no response is received from the “ping” to the IP address of the CNX control system, repeat the procedure in “Control System Side, TCP/IP,” page 17.
C:\WINDOWS>ping 132.149.2.2
Pinging 132.149.2.2 with 32 bytes of data:
Reply from 132.149.2.2: bytes=32 time=8ms TTL=60 Reply from 132.149.2.2: bytes=32 time=5ms TTL=60 Reply from 132.149.2.2: bytes=32 time=5ms TTL=60 Reply from 132.149.2.2: bytes=32 time=5ms TTL=60
Once a reliable connection is established, test that the CNX control system is listening and responding properly. Reconfigure Viewport communications to use TCP/IP by selecting Setup | Communications Settings. Once the Port Settings window opens, select TCP/IP as the Connection Type. For IP Address, Click on Fixed and enter the CNX control system IP address in the active field. Test the new connection by issuing the Diagnostics | Check Operating System Version command.
Additional Server Side Setup
In addition to properly setting up and testing communications with each connected system, the following steps are also required to make the server operational:
1. Select database file. Supply the full pathname to the database under the
COM Settings tab. This file is the sole source of all database tables accessed by all signal blocks. See “The e-Mail Database Tables,” page 42, for more information.
The demos are pre-configured to point to the file maildemo.mdb in the demos folder.
2. Set e-mail host IP addresses. Select the e-Mail tab. The SMTP server’s
domain name or IP address must be supplied for sending e-mail (demo1, demo2, and demo3); and the POP3 server’s domain name or IP address must be supplied for receiving e-mail (demo4). These are often the same. Refer to “Options for Sending e-mail” on page 23 and “Options for Receiving e-mail” on page 24.
3. Set sender e-mail address. Optional. Still in the e-Mail tab, fill in the Static
From: Addr field. Any address is usually acceptable; it does not have to be a
19 •• Basic Server Setup Installation & Reference Guide — Doc. 5798
Crestron e-control Mail SW-MAIL
real address. If you leave this field blank, all mail sent will appear to be from anonymous@unknown.net.
4. Set recipient e-mail address. The database file must contain a valid e-mail
address for testing purposes.
The demo database file, maildemo.mdb, does not ship with this data. You must enter at least one such address in order to confirm that the demos 1, 2, and 3 are actually sending mail.
To do this, close the Configuration Options window and select Tables | e-Mail to open the e-Mail Tables window. Enter an e-mail address for some record in the eMail_Addr table (such as record ID=1, “George Washington”). (Use an address to which you have access so that you can confirm that the system sent the mail successfully.)
5. Set mailbox e-mail address. Each e-mailbox signal block must contain a valid
e-mail account name and password. See “Mailbox Name and Password” on page 34.
The demo configuration does not ship with this data; you must fill in the blank fields in the DEMO4 signal block to run demo4 and test receiving e-mail.
6. Indicate control system connection. Point each active signal block to a
COM Settings definition. (If you have not yet defined the connection through which this signal block will communicate, you can leave this blank for the now. However, the signal block cannot be activated until it references a COM Settings definition.) See “COM Settings” on page 29 for a description of how to point a signal block to a COM Settings definition.
All the signal blocks in the demo configuration already point to a COM Settings definition.
The Signal Analyzer is intended for debugging and demo purposes only. It should not normally be left opened because it does place additional processing demands on the server, creating a perceptible delay on slower systems.
7. Start server protocol. Select Server | Start to start the server protocol, or
Server | Start w/ Signal Analyzer to start the server protocol with the Signal
Analyzer window opened. This window can be freely opened and closed while the server is active. While opened, the Signal Analyzer monitors signals going back and forth between the server and the control systems. Incoming and outgoing signals can also be simulated from here; and all signal block signal lists can be printed from here.
Server Configuration In Depth
This section is a reference to all the options available in the Configuration Options window. Changes to options in this window are saved to the current Configuration Settings file when the OK or the Apply buttons are actuated. Therefore, it is important to make sure you are operating on the appropriate Configuration Settings file before opening the window.
Specifying a Configuration File
The installer registers the file demos\demomail.ini as the current Configuration Settings file. This file pre-configures the server for all four demos; and particularly for use with the Quick Start Guides — which instruct you to load demo3 and demo4.
You can use the File | Configuration file… command to select a Configuration Settings file of your choice. The file pathname so specified is stored in the Windows registry on your machine. In addition to specifying the configuration filename, this command also instantly reconfigures the server based on the named file. This is a very useful feature for the developer working on multiple projects.
20 •• Server Configuration In Depth Installation & Reference Guide — Doc. 5798
Crestron e-control Mail SW-MAIL
NOTE: If the server cannot open a specified configuration file, the server uses default values for all options. If any changes are made, a new config file is created (using the specified pathname).
The installer registers the file demos\demomail.ini as the current Configuration Settings file. This file pre-configures the server for all four demos. The Quick Start Guides — which instruct you to upload demo3 or demo4 – depend on this file being set as the current config file. If you have changed the config file and wish to run the demos again, you must first change it back.
Password Access
Access to the server’s Configuration Options window is password-protected. This is to prevent end-user meddling with the configuration options, which can very possibly disable the server’s proper operation.
Select Server | Configure. The server prompts the user for a password.
The configuration password dialog — controls access to the Configuration Options window
Enter crestron2 which displays all tabs. Entering anything else displays the
General tab only.
The Configuration options window, General tab, showing all tabs (correct password entered).
21 •• Server Configuration In Depth Installation & Reference Guide — Doc. 5798
Crestron e-control Mail SW-MAIL
Level 1 and 2 passwords may be changed from the General tab. Click on the Change Password button to open the Change Password window. Enter the old password and the new password twice. Click OK to complete the change.
Resetting the Configuration Password
In the event the password is misplaced, be aware that it is not stored in readable form. Rather, values derived from the password are stored in the configuration files. The password can effectively be reset by locating the configuration file and then either deleting or editing it.
Use the File | Configuration file... command to note the pathname of the currently selected configuration file. Exit the server.
Deleting the file means that all configuration variables revert to their default values the next time the server is run. The problem with this approach, of course, is that you lose any settings already made.
To reset the password only (without affecting the rest of the configuration), edit the
.ini file using the Notepad application (Start | Programs | Accessories | Notepad). Locate and delete the following key in the [GENERAL]section (the value
may differ):
privilegeLevel_2=180350152
Exit the Notepad application, saving the file. The password is now reset to its default — which is “crestron2.” Run the server again. Issue the Server | Options... command. Enter the default
password. You can now change the password to whatever you want by clicking the Change Password button.
e-Mail Options
The information under this tab in the “Options” window is applied to every message sent by all e-mailer signal blocks and received by all e-mailbox signal blocks.
The Configuration Options window showing the e-Mail tab with fictitious mail host URLs.
22 •• Server Configuration In Depth Installation & Reference Guide — Doc. 5798
Crestron e-control Mail SW-MAIL
Options for Sending e-mail
These options affect the behavior of all e-mailer signal blocks.
SMTP Server URL Field
Supply an SMTP server domain name. Typically, this is the organization’s domain name with the sub-domain smtp prefixed, as in smtp.organization.com, but quite often it could be something else. It may or may not be the same as the POP3 server URL. If in doubt, check how the e-mail client is set up at any PC on site or check with the organization’s MIS department or Internet Service Provider.
NOTES:
1 This field must be completed before the server protocol can be started. 2 Avoid “raw” IP addresses; they can change. Use fully qualified domain names instead. 3 Avoid fictitious IP addresses or domain names; they cause excessively long DNS lookups with
each attempted mailing. This is a real problem when not using SMTP Express, because the server cannot process any other signals while waiting for the SMTP server to “come back.”
(This is only a problem for the SMTP server name; it is not a problem for fictitious domain names in the addresses of outgoing e-mail.)
cc: Field and Checkbox
This field accepts a comma-separated list of e-mail addresses (without real names). The purpose of this field is to assist system managers who are monitoring outgoing e-mail. If a high volume of mail is expected, we recommend setting up a separate e-mail account name for this purpose.
For more information about text substitution, see “Text Substitution Directives” on page
48.
SMTP Express is a third-party product which can be obtained from the following web page:
http://www.quiksoft.com/ea symail/smtpexpress/
A check in the checkbox indicates that this information is sent with every e-mail.
Lookup Substitution Defaults Checkbox
Text substitution directives are normally replaced with the contents of text substitution registers. The contents of the registers are defined at run-time. If a directive invokes an undefined register, it is replaced with a null string (essentially removing the directive — and substituting it with nothing).
Checking Substitution defaults, however, directs the server to use the directive’s parameter number to lookup a record with matching ID field in the eMail_Subst table and to use substitution text found therein. If the register in question has a
defined value, that value is used, as usual; only when a register is undefined does this default action take place.
For example, if register 3 is undefined and Substitution defaults is unchecked, then a directive that invokes this register (e.g., “Room C{3}” in a message's subject header or body text), is removed (replaced by nothing), yielding the result “Room C.” If on the other hand, Substitution defaults is checked, the directive is replaced by the value of the substitution field in the record in the eMail_Subst table whose ID field contains the value 3. If that record exists and its substitution field contains “525” then the resulting string would read “Room C525” — and this is what would be sent in the e-mail.
Queue Messages Checkbox
Since the server cannot respond to incoming signals while waiting for an e-mail message to finish sending, it is preferred to send messages in the background. A check in this checkbox permits such an option by queuing messages to the SMTP Express application which does the actual sending.
23 •• Server Configuration In Depth Installation & Reference Guide — Doc. 5798
Crestron e-control Mail SW-MAIL
Options for Receiving e-mail
These options affect the behavior of all e-mailbox signal blocks.
POP3 Server URL Field
Supply a POP3 server domain URL. Typically, this is the organization’s domain name with the sub-domain pop, mailbox or postoffice prefixed, as in mailbox.organization.com, but quite often it could be something else. It may or may not be the same as the SMTP server URL. If in doubt, check how the e-mail client is set up at any PC on site or check with the organization’s MIS department or Internet Service Provider.
NOTE: The same notes under “SMTP Server URL Field” on page 23 apply to the POP3 server URL as well.
Check mail every minutes
A value in this field causes all enabled e-mailbox signal blocks to periodically check for new mail. The initial value for this field is 0 (no automatic checks).
COM Settings Definition
A data structure called a “system” must be created for each connection you intend to make to your control system.
All active signal blocks (Signal Blocks tab) must reference such a structure. See “Interface Definition” on page 29 for instructions on defining such a reference for your signal blocks.
The COM Settings tab
The COM Settings tab of the Configuration Options window contains a list of data structures called “COM Settings definitions” which represent connections to control systems. From this tab, you can activate and deactivate such definitions, and define additional ones.
NOTE: Connections may be defined before or after signal blocks are defined. However, signal blocks cannot be activated until they reference a defined connection.
Refer to the figure below. To remove a COM Settings definition, select it and click the Remove button. To duplicate an existing definition, select it and click the Duplicate button. The new
definition differs from the original in that it is given a unique name which is derived from the name of the original, incremented by one. (If the original did not end in a number, the name of the duplicate is the name of the original with a “1” suffixed to it.)
Click the Add… button to define an new connection; or select one of the definitions already listed and click Modify… to modify it. The COM Settings window opens:
24 •• Server Configuration In Depth Installation & Reference Guide — Doc. 5798
Crestron e-control Mail SW-MAIL
The Configuration Options window, COM Settings tab, showing the only connection defined in the demo configuration (selected).
COM Settings definitions (connections) can be active or inactive. A check in the box next to the definition name indicates that the connection is activated. If not activated, it is ignored when the server protocol is started.
The COM Settings window
The COM Settings window for the connection defined in the demo configuration showing RS-232 communications selected …
25 •• Server Configuration In Depth Installation & Reference Guide — Doc. 5798
Crestron e-control Mail SW-MAIL
… and if TCP/IP communications were selected, it would look like this (fictitious IP address shown):
Definition name
Each COM Settings definition requires a unique name. A field for this data can be found at the top left of the COM Settings window. We recommend choosing a name that reflects either the location of the control system (such as SUITE3) or its function (such as PHONEBOOK).
This name is used in the server’s user interface to identify the system data structure. It is also sent along with error messages to the actual control system to identify the source of an error resulting from processing one of the system-level signals defined herein.
Control system generation
Here you specify the type of control system. The server uses this information to take into account minor differences in the way the older generation of Crestron control systems functioned in terms of timing and data capacity.
Communications mode
In this frame you choose RS-232 or TCP/IP connections. The details are described in the Server Side configuration sections for RS-232 (page 16) and TCP/IP (page 17).
System-level signal definitions
In this window you can also define optional system-level signals by checking the appropriate boxes. Doing so defines a special signal block which communicates with its own Intersystem Communications symbol in your SIMPL Windows program. In this case, you should also fill in the Signals field, as follows:
Signals
This is the offset of the Intersystem Communications symbol in your SIMPL Windows program. The connection’s signal block must not overlap any other signal block (channel 1 of) these COM Settings or else the server protocol will not be able to be started.
Refer to the “Appendix C: ” on page 65 for more information on each of the signals listed in the window.
Signal Block Definition
Data structures called a “signal blocks” are created on the server, each communicating with its own Intersystem Communications symbol on a control system. Each active signal block must reference a “COM Settings” data structure which defines a connection to a control system. See “COM Settings Definition,” above.
26 •• Server Configuration In Depth Installation & Reference Guide — Doc. 5798
Crestron e-control Mail SW-MAIL
A “signal block” is a software construct defined in the server which communicates with special symbols in the SIMPL program running in your control system.
e-Mailer signal blocks communicate with Send e-Mail symbols.
e-Mailer signal blocks communicate with plain
Intersystem Communications
(XSIG) symbol. Each Standard Scroller signal
block communicates with a particular DBMScroller macro.
The Signal Blocks tab (see below) displays a list of defined signal blocks. Three types of signal blocks are available with an SW-MAIL license:
e-Mailer prepare and send outgoing e-mail messages e-Mailbox download, select, and read incoming e-mail messages or
download and scan for control signal syntax and send such signals if found.
Standard Scroller for interactive display of database tables in support of the
above.
The Standard Scroller signal block is a constrained form of the more robust Custom Scroller signal block — which is only available if you are also licensed for e-control Database Manager (SW-DBM). The Standard Scroller signal block has a static configuration designed to interface with the included DBMScroller SIMPL Windows macro. (If you use a Custom Scroller, you cannot use the macro.)
Without an SW-DBM license, Standard Scroller signal blocks cannot be directly enabled via a signal from a control system. In that case, they are only useful when attached to another type of signal block designed to control scrollers, in this case e-Mailer and e-Mailbox signal blocks — which use them in support of their primary functions, as follows:
• An e-Mailer signal block can use scrollers to display an address book and
prepared messages.
• An e-Mailbox signal block can use scrollers to display an IN box and a message.
When attached to a controlling signal block, a scroller (either type) is enabled automatically when the controller is enabled. When not attached to a controlling signal block, Standard Scrollers can only be enabled directly with an SW-DBM license.
Specific differences between the two types of scroller signal blocks are summarized in “Appendix E: Standard Scroller / Custom Scroller Feature Comparison” on page
108.
The Signal Blocks tab
The signal blocks tab contains a list of the currently defined signal blocks. Refer to the next figure.
To remove a signal block definition, select it and click the Remove button. To duplicate an existing definition, select it and click the Duplicate button. The new
definition differs from the original in that it is given a unique name which is derived from the name of the original, incremented by one. (If the original did not end in a number, the name of the duplicate is the name of the original with a “1” suffixed to it.)
New signal blocks can be added by selecting a signal block type from the New signal block type list box and clicking the Add… button. Existing signal blocks can be modified by highlighting the signal block in the Defined signal blocks list and clicking the Modify… button.
27 •• Server Configuration In Depth Installation & Reference Guide — Doc. 5798
Crestron e-control Mail SW-MAIL
The Configuration Options window, Signal Blocks tab, showing all the signal blocks defined in the demo configuration. As shown, all seven signal blocks are active (checked); and the e-mailer signal block for demo3 is selected.
Signal Blocks, once defined, can be active or inactive. A check in the box next to the signal block name indicates that the signal block is activated. If a signal block definition is not checked, it is ignored when the server protocol is started, neither accepting nor responding to incoming signals in its range. Inactive signal blocks are not considered for signal space conflicts with other signal blocks when the server protocol is started.
NOTE: Signal Blocks may be defined before or after the COM Settings to which they need to refer are defined. If the signal block is defined first, you will not be able to specify the COM Settings yet. This is permitted. However, such signal blocks cannot be activated until they reference defined COM Settings.
The server can have any number of signal blocks defined and active simultaneously. Selecting a signal block from the list in the Signal Blocks tab and clicking the
Modify… button — or defining a new signal block with the Add… button — opens a signal block definition window.
Such a window shows a particular signal block definition. The definition includes:
• Interface definition. The options across the top of the Signal Block Definition
window are common to all types of signal blocks and include the signal block’s name, system connection, and signal offset. (The term interface refers to the server-signal block interface; i.e., information that all signal blocks must have to be handled by the server as signal blocks.)
• Optional signal definitions. Words shown in the Signal Block Definition window
in bold case are names of optional signals implemented by the signal block. These are included in the signal block definition (they are "defined") either by checking the adjacent checkbox, or (in the case of a set of enumerated signals) by supplying a non-zero number in the adjacent text field. Undefined signals do not appear in the signal list and must not appear in the matching Intersystem Communications symbol on the control system side. Be aware that there may also be a number of non-optional signals which are not shown in the window.
28 •• Server Configuration In Depth Installation & Reference Guide — Doc. 5798
Crestron e-control Mail SW-MAIL
• Behavior options. These have specific effects on signal block behavior when the
server protocol is running.
The highest numbered signal in the signal block’s input or output signal lists is shown in the box in the upper-right corner. This is based on the signal offset entered in the adjacent box and the current signal block definition. This value is updated synchronously as the user interacts with the window. This box turns red when the highest analog or serial signal number on either the input or the output lists exceed 1023; or should the highest digital signal number exceed 4095.
Interface Definition
All signal blocks require the following basic information. Fields for these data are shown across the top of all Signal Block Definition windows.
Name
A unique signal block name is required here. This name is used in the server’s user interface to identify the signal block. It is also sent along with error messages to the control system to identify the source of the error. We recommend choosing a name that reflects either the location of the control system (such as BOOTH3) or its function (such as PHONEBOOK).
COM Settings
The COM Settings list box contains the names of all the COM Settings definitions from the COM Settings tab. Point the signal block to a particular COM Settings definition by selecting it from the list.
Each signal block must be associated with a control system. Control systems are defined separately under the COM Settings tab. You may define the signal blocks first if you like, then define the systems, and come back and make the associations later. Note, however, that signal blocks cannot be activated without first associating a system, through its COM Settings connection, with the signal block.
Channel
For systems with multiple Virtual COM Port channels defined, select a channel here.
Signal Offset
When a signal block shares a signal space (a channel) with another signal block, they both cannot begin numbering their signals at 0. In such a case, supply values space the signal blocks’ signals properly — such that they do not overlap with each other. If any signal blocks’ signal spaces overlap, attempting to start the server protocol results in an error.
Auto-enable
If this box is checked, the signal block is automatically enabled when the server protocol is started.
e-Mailer Signal Block Options
Selecting DEMO3 and clicking the Modify… button opens the e-Mailer Signal Block Definition window.
29 •• Server Configuration In Depth Installation & Reference Guide — Doc. 5798
Crestron e-control Mail SW-MAIL
The e-Mailer Signal Block Definition window, showing the definition of the DEMO3 e-mailer. A fictitious e-mail address has been entered into the Static “From:” Addr field.
This window allows the user to assign a default “To:” name and a default “To:” address (for all recipients) as well as a default “From:” name and a static “From:” address (for the sender). These options (and others) are set separately for each e-mailer signal block.
Sender Header
The sender header in an e-mail message is the line beginning with “From:” at the top of the message; it contains the name (optional) and e-mail address (required) of the entity sending the message.
NOTE: The sender address while required does not necessarily have to be an address known to your E-mail host. Different servers have different rules regarding this point. Some require just the top­level domain (e.g., “.com”) to be known, while others only send mail for known URLs. Still others may require that the entire address represent a known e-mail account.
Two fields appear in the Sender Header frame of the e-Mailer Signal Block Definition window.
The Default “From” Name field contains a default sender name. As a default, this information is only used when not otherwise specified (via control system signals). The should describe the sender. We recommend using a name that describes the location and/or function of the system originating the mail. For example, a specific system could be located in a room (e.g., “Video Suite 3”) or in a building (e.g., “Bldg 4 HVAC”). If the control system does not specify a name and this field is left blank, the originating e-mail address appears without an accompanying sender name.
The Static “From:” Addr field contains a typical e-mail address, such as:
accountname@domainname
Unlike the name field, the value in this field is not a default; the control system cannot override this value; it is always used on all outgoing mail originating from this e-mailer signal block. We recommend using an address that describes the originating control system such as:
30 •• Server Configuration In Depth Installation & Reference Guide — Doc. 5798
Loading...
+ 79 hidden pages
Buy Points How it Works FAQ Contact Us Questions and Suggestions Privacy Policy Cookie Policy Terms of Use