CRESTRON e-control™ Mail (SW-MAIL) version 1.4 © 1999 Crestron Electronics, Inc.
Crestron e-control Mail SW-MAIL Contents How to Use This Manual 4 A Note on Printing This Document ................................................................................................... 4 Quick Start ........................................................................................................................................ 4 Section Summary ..............................................................................................................................
Crestron e-control Mail SW-MAIL Appendix A: Theory of Operation 59 Server Protocol................................................................................................................................ 59 Signal Block Definition / Activation ............................................................................................... 59 Signal Block Enable / Disable .........................................................................................................
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/.
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.
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.
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.
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.
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.
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 VT-3500 VT-3500 Crestron control system VT-3500 Crestron Software Server e-Mail Host VT-3500 VT-3500 VT-3500 Internet NOTE: The CNX Gateway is not necessary when using RS-232 serial communications.
Crestron e-control Mail SW-MAIL Leading Specifications Specifications Table SPECIFICATIONS DETAILS SWSERVER.EXE (included with this package) Version 1.4 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 Version 1.
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.
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.
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.
Crestron e-control Mail SW-MAIL Inside this folder you will find the four demos, with support files: demo1 demo2 demo3 demo4 demomail.vtp demomail.hex demomail.ini Maildemo.mdb VisionTools touchscreen project file with pages for all four demos (compiled version of above)) Server’s Configuration Settings file which accommodates all four demos Sample database file for use with all four demos The installer registers demomail.ini as the currently selected Configuration Settings file.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Crestron e-control 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. 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 signal blocks communicate with Send e-Mail symbols. e-Mailer signal blocks communicate with plain Intersystem Communications (XSIG) symbol.
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.
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.
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.
Crestron e-control Mail SW-MAIL system5@myclient.com If the control system does not specify an address and this field has been left blank, the specific address anonymous@unknown.net is sent instead (subject to the following rules): 1. If neither the name nor the address is specified, both these values are used. 2. If a name is provided, but no address, the default address is used along with the provided name. 3.
Crestron e-control Mail SW-MAIL messages table, eMail_Msg, and the canned recipients table, eMail_Addr.
Crestron e-control Mail SW-MAIL SMTP.signal block> In the above, signal block is replaced with the actual name of the e-mailer signal block carrying on the conversation. This option should normally remain off (unchecked). Optional signal definitions This frame lists optional signals which can be excluded from the signal block (and from the congruent Intersystem Communications symbol on the control system side).
Crestron e-control Mail SW-MAIL The e-Mailbox Signal Block Definition window, showing the definition of DEMO4, the e-mailbox signal block used in demo4, with the e-Mail account information frame filled in, and the Process control messages option checked. NOTE: The domain name part of the Mailbox name is set for all e-mailbox signal blocks under the e-Mail tab in the Configuration Options window (see “POP3 Server URL Field” on page 24).
Crestron e-control Mail SW-MAIL Intersystem Communications symbol).
Crestron e-control Mail SW-MAIL • The subject field of the new message is set to the subject field of the present message. "Re:" is suffixed to this string if it does not already begin with same. Use the SetBody and SendNow signals to complete the reply. Behavior The following options affect behavior of the e-mailbox signal block while it is running. Delete from Mail Server as downloaded Check this option to delete each message from the e-mail host after downloading.
Crestron e-control Mail SW-MAIL Server Windows and Menus This section contains descriptions of the server’s two main windows, the Server Monitor window and the Signal Analyzer window. The Server Monitor Window The Server Monitor window is the server’s main window. It appears upon starting up the server application, and remains open until the server application terminates. The Server Monitor window. The server protocol has been started with a single system connected via TCP/IP.
Crestron e-control Mail SW-MAIL this command to select the appropriate configuration file for each demo before running it. The following command is always available: • Exit terminates the server application. If the server protocol is running, a warning message appears.
Crestron e-control Mail SW-MAIL “Editing the Queries table” in the SW-DBM manual (Doc. 5823) for more information. The Signal Analyzer Window While the server protocol is running, the Server | Start w/Signal Analyzer command from the Server Monitor window opens the Signal Analyzer window. (If the server is already running, toggling Server | Signal Analyzer does the same thing.) The Signal Analyzer window, showing the all the active signal blocks defined in the demo configuration.
Crestron e-control Mail SW-MAIL Signal lists There are two lists which are displayed for all signal blocks (including system signal blocks for systems with signals defined), an incoming list on the left labeled CS to PC signals which contains all of the signals that go from the control system (CS) to the server (PC); and an outgoing list on the right labeled PC to CS signals which contains all the signals that go from the server to the control system.
Crestron e-control Mail SW-MAIL SIMPL Windows. To this end, the lists contain signal labels identical to the labels used in that symbol. The Simulate Menu This menu contains the following commands for simulating signals. Simulated signals are added to the Signal Log on the bottom portion of the window, just like real signals. • Simulate | Incoming simulates receipt of the signal currently selected in the incoming (“CS-to-PC”) signal list.
Crestron e-control Mail SW-MAIL Signal log search window. Searches can be performed with and without case sensitivity by checking the Match Case option. When the window opens this option is unchecked — meaning that the search algorithm disregards the upper- and lower-case status of the characters in the search key. Also when the window opens, the search direction is set to Forward to end meaning that the search will begin with the signal on the highlighted line and will continue to the end of the log.
Crestron e-control Mail SW-MAIL The Queries table The Queries table is used by scroller signal blocks to form queries which provide access to the data in the other tables. Using the Database | Queries Table… command, you can view this table’s data. As supplied, the Queries table in the sample database file is already set up for accessing the other tables. For more information on the structure and use of the Queries table, refer to the SW-DBM manual, Doc. 5823.
Crestron e-control Mail SW-MAIL The eMail_Addr Table Each record in the eMail_Addr table must contain at least the following fields: ID, first, last, and addr. An entry with null addr field contents is still useful as a way of labeling an outgoing message which will be sent to the default recipient as described by the e-mailer signal block defaults. The eMail_Subst Table For more information about text substitution, see “Text Substitution Directives,” 48.
Crestron e-control Mail SW-MAIL Field Description available) or the address (but not both) for each recipient, separated by carriage-returns. msgBody Verbatim text of message. msgNew Indicates if message has been read yet or not. Used by server to produce the new and old “mail views.” msgDel Indicates if the message has been marked for deletion (i.e., the Delete signal was received following a Pickn signal that opened this message).
Crestron e-control Mail SW-MAIL Editing the Existing Database It is not necessary to have Microsoft Access to view or edit the e-mail tables; they can be edited directly from within the server application. Open the server and select e-Mail | Tables. The e-Mail Tables window opens to display the contents of the eMail_Msg, eMail_Addr, and eMail_Subst tables of the database file named in the COM Settings tab of the Configuration Options window.
Crestron e-control Mail SW-MAIL record from the interactive message scroller (see below). These values are replaced continually until the SendNow signal is issued. Note that the name and address are actually added to the list only when the SetAddr signal is issued. At that moment, the name most recently sent via SetRcptName is paired with the address and added to the recipient list.
Crestron e-control Mail The contents of the first and last fields are concatenated together when echoed by the EchoRecp signal. SW-MAIL If the Echo Lookups option is in effect, these data are echoed back to the control system as well (using the EchoRecp and EchoRcptAddr signals). If the Show Indirection option is also checked, a > character is prefixed to the echoed strings to indicate the indirection.
Crestron e-control Mail An e-mailer signal block is enabled by assertion of its Enable signal from the control system. SW-MAIL All registers are undefined when the e-Mailer signal block is enabled. A register is defined by receipt of a SetParm and LookupParm signal. Register definitions are "sticky" — which means that they persist and can be referenced in successive e-Mail messages. The registers remain defined until the server protocol is halted.
Crestron e-control Mail SW-MAIL Identification For the server to recognize control messages, the Process control messages option must be checked in the e-Mailbox Signal Block Definition window. Otherwise, none of the following applies, and messages which might have been interpreted as control messages are instead interpreted as normal messages. NOTE: e-Mailbox signal blocks must either have an IN box (i.e.
Crestron e-control Mail SW-MAIL $FFFF. See “Base 16 used for notational purposes” on page 66 for more information about hexadecimal. Embedded spaces are ignored. Digital To assert the signal, specify one of: Assert, True, On, 1, Yes, Set, Ok, or Okay To de-assert the signal, specify one of: Deassert, Deassert, False, Off, 0, No, Reset, or Cancel Case is not significant and embedded spaces are ignored. Serial Up to 83 characters.
Crestron e-control Mail SW-MAIL -- end of file -- Demos Four demonstrations on the use of e-control Mail are included with the package. Each demo is described along with an accompanying “bird’s eye view” diagram of its SIMPL program. All demos use the following three files: • A VT Pro-e source file (demomail.vtp file), containing pages for all four demos, ready to be compiled LC-3000 touchpanel. • A compiled touchscreen file (demomail.
Crestron e-control Mail SW-MAIL table (using the first record with ID = the value of the message record’s defaultAddr field). Demo 1 Block Diagram NOTE: This block diagram shows the use of a virtual COM port for TCP/IP communications with the server. For serial communications using RS-232, the virtual COM port is simply replaced with a real COM port. Demo 1 SIMPL Windows Program Building this simplest example is trivial.
Crestron e-control Mail SW-MAIL example. Note that the Send e-Mail symbol’s rx and tx streams are connected to the (virtual) COM port symbol. Demo 2 Block Diagram NOTE: This block diagram shows the use of a virtual COM port for TCP/IP communications with the server. For serial communications using RS-232, the virtual COM port is simply replaced with a real COM port.
Crestron e-control Mail SW-MAIL • Choosing the “Invite” message (ID=1 in the eMail_Msg table) provides the default address for Thomas Jefferson (ID=2 in the eMail_Addr table). • Choosing the “Century” message (ID=2 in the eMail_Msg table) provides no default address. • Choosing any other message from the eMail_Msg table provides the default address for the system manager (ID=0 in the eMail_Addr table).
Crestron e-control Mail SW-MAIL It is also worth noting that there is no direct connection between the DBMScoller macro and the Send e-Mail symbol. Interpretation of scroller picks as e-mail composition actions occurs within the server as the scroller signal blocks make calls on the e-mailer signal block. Demo 3 Block Diagram [ Figure unavailable ] NOTE: This block diagram shows the use of a virtual COM port for TCP/IP communications with the server.
Crestron e-control Mail SW-MAIL It is also worth noting that there is no direct connection between the DBMScoller macros and the Receive e-Mail symbol. Interpretation of scroller picks as IN box message selection occurs within the server as the IN box scroller signal block makes calls on the e-mailbox signal block. Demo 4 Block Diagram [ Figure unavailable ] NOTE: This block diagram shows the use of a virtual COM port for TCP/IP communications with the server.
Crestron e-control Mail SW-MAIL (join=NONE). Only after the desired data has been sent, the server issues the PageFlip signal. 58 • Demos Installation & Reference Guide — Doc.
Crestron e-control Mail SW-MAIL Appendix A: Theory of Operation This section describes the operation of the e-mailer signal block as it processes signals from the control system. Signal names are shown as conjoined words with initial caps set in bold type, such as SendNow. Refer to the “Signal Reference” on page 68 for in-depth information on these signals. Server Protocol Run the Crestron Software Server application, swserver.
Crestron e-control Mail SW-MAIL COM Settings definition which contains a similar set of error reporting signals.. These signals include ErrNumber, ErrString, and ErrTrigger. See the “Signal Reference” on page 68 for details. 60 • Appendices Installation & Reference Guide — Doc.
Crestron e-control Mail SW-MAIL Appendix B: Intersystem Communications and Signal Space Considerations The Send e-Mail SIMPL Windows symbol is available from the Crestron FTP site. Under SIMPLWIN, look for “Library update” (version equal to or greater than that specified in “Leading Specifications” on page 11). The DBMScroller SIMPL macro is installed with SIMPL Windows 1.4. It is also installed into the Modules folder. For use with 1.3, move the file to your currently set user macros folder.
Crestron e-control Mail SW-MAIL Encoding and Decoding the Serial Data Stream Analog, serial, and digital signals to be sent from the control to the server are fed into the input (left) side of an Intersystem Communications symbol which encodes the signals into a serial data stream, available as an output labeled tx$ (for transmitter). This data stream is connected to the input side of the serial driver symbol, also labeled tx$, and is sent out the COM port to the server.
Crestron e-control Mail SW-MAIL to the control system. All the symbols’ rx$ and tx$ streams are tied to the same serial driver symbol. The set of signals intended for a particular Intersystem Communications symbol are distinguished from the other sets by their offset and/or their channel number. Normally, the signals in an Intersystem Communication symbol’s input list and its output list are internally enumerated starting at the top of each list with zero (0).
Crestron e-control Mail SW-MAIL 1. Always suffix a d (for decimal) to values typed into the Offset textbox. 2. Always enter 1d into the Option textbox for all Intersystem Communications symbols. Multiple channels Multiple channels apply to connections made through Virtual COM Ports only (i.e., TCP/IP connections only). Each Virtual COM Port can have up to 128 channels, where each channel can be thought of as a separate COM port.
Crestron e-control Mail SW-MAIL Appendix C: Signal Reference Definition of Terms Address The e-mail address, for example, “jdoe@company.com,” or the account name part thereof (in this case, “jdoe”). Connection A connection to a system which can be either serial (RS-232) or EtherNet (TCP/IP). Data fields The indirect text fields which receive the data that is echoed when a record is opened (“picked”). List fields The indirect text fields in scrollers.
Crestron e-control Mail SW-MAIL also true of base 2: The lowest order “bit,” (binary digit), on the far right, and are numbered starting from 0. Thus, when sixteen bits are available, they are numbered 0 to 15 from right to left — because each bit on its own represents the quantities 20 through 215. Bit patterns as used here do not represent quantities. Rather, the values of the individual bits (0 or 1) turn features off and on (respectively).
Crestron e-control Mail The sender’s “real” name is specified by the SetFromName signal, or by the default specified in the e-Mailer signal block definition. SW-MAIL While most mail (SMTP) servers accept any account name (such as “anonymous”) for outgoing mail, some servers only accept outgoing mail from a known account. In these rare cases, the sender’s real name may be ignored by the SMTP server and replaced with the name on record for that account.
Crestron e-control Mail SW-MAIL Signal Block(s) e-mailer Signal Name EchoRcptAddr Direction Type system-to-server S e-mailer EchoRcptName server-to-system S e-mailer, e-mailbox EchoSubj server-to-system S e-mailer, e-mailbox Enable system-to-server D e-mailer, e-mailbox Enabled server-to-system D All ErrNumber server-to-system A All ErrString server-to-system S ErrTrigger server-to-system D e-mailbox All KeepAsNew system-to-server D e-mailer LookupMsg system-to-serve
Crestron e-control Mail Applies to Description Direction Type Value Expected Reply Comments SW-MAIL e-Mailbox signal blocks Checks the e-mail host for waiting mail. system-to-server Digital Pulse (actually, leading edge is the trigger; trailing edge is ignored) Done pulse The server logs onto the POP3 (incoming e-mail ) host and retrieves waiting mail.
Crestron e-control Mail SW-MAIL ClearNames Applies to Description Direction Type Value Expected Reply Comments e-Mailer signal blocks Clears the recipient list. system-to-server Digital Pulse (actually, leading edge is the trigger; trailing edge is ignored) Done pulse Also clears any To: name which may have been previously sent with SetRcptName but has not yet actually been added to the recipient list with SetAddr.
Crestron e-control Mail SW-MAIL Delete Applies to Description Direction e-Mailbox signal blocks Signals server to delete the message most recently picked from the IN box. server-to-system Type Digital Value Pulse Expected Reply None Comments The message is deleted from both the e-mail host and the IN box database table — but not until the next time the host is contacted. Also deleting the message from the host ensures the same message is not downloaded again.
Crestron e-control Mail SW-MAIL Done Applies to Description Direction System signal blocks e-Mailer signal blocks e-Mailbox signal blocks scroller signal blocks (“standard” or “custom”) Indicates requested operation completed successfully server-to-system Type Digital Value Pulse Expected Reply None Comments Sent to control system in response to most system-to-server signals, indicating that the requested operation has been successfully completed.
Crestron e-control Mail SW-MAIL EchoBody Applies to Description Direction Type Value Expected Reply Comments e-mailer signal blocks String sent as feedback in response to setting a new subject header Server-to-system Serial New body text None Definition of this signal is optional. This signal is generated in response to lookups only. Signals that might precipitate this are LookupMsg, ClearNames, NewMail, and manually picking a message from a bound message scroller.
Crestron e-control Mail SW-MAIL EchoDate Applies to Description Direction Type Value Expected Reply Comments e-mailbox signal blocks String sent as feedback in response to opening an e-mail message Server-to-system Serial Verbatim text from the message’s date header None Definition of this signal is optional.
Crestron e-control Mail SW-MAIL EchoFrom Applies to Description Direction Type Value Expected Reply Comments e-mailbox signal blocks String sent as feedback in response to opening an e-mail message Server-to-system Serial Name or address from the message’s sender (“From:”) header None Definition of this signal is optional. This signal is generated in response to opening an e-mail message. The server “opens” e-Mail messages by sending a Pick signal through the referenced IN box scroller.
Crestron e-control Mail SW-MAIL EchoRcpt Applies to Description Direction Type Value Expected Reply Comments e-Mailbox signal blocks String sent as feedback in response to opening an e-mail message Server-to-system Serial List of recipient names or addresses from the message’s recipient (“To:”) header None Definition of this signal is optional. This signal is generated in response to opening an e-mail message.
Crestron e-control Mail SW-MAIL EchoRcptAddr Applies to Description Direction Type Value Expected Reply Comments e-Mailer signal blocks String sent as feedback in response to setting a new recipient address Server-to-system Serial New recipient address None Definition of this signal is optional. This signal is generated in response to lookups only. Signals that might precipitate this are LookupRcpt, LookupMsg, ClearNames, NewMail, and manually picking an item from a bound data scroller.
Crestron e-control Mail SW-MAIL EchoRcptName Applies to Description Direction Type Value Expected Reply Comments e-Mailer signal blocks String sent as feedback in response to setting a new recipient name Server-to-system Serial New recipient name None Definition of this signal is optional. This signal is generated in response to lookups only. Signals that might precipitate this are LookupRcpt, LookupMsg, ClearNames, NewMail, and manually picking an item from a bound data scroller.
Crestron e-control Mail SW-MAIL EchoSubj Applies to Description Direction Type Value Expected Reply Comments e-Mailer signal blocks e-Mailbox signal blocks String sent as feedback in response to setting a new subject header Server-to-system Serial Text of subject header from selected message None Definition of this signal is optional. e-Mailer signal block: This signal is generated in response to lookups only.
Crestron e-control Mail SW-MAIL Enable Applies to e-Mailer signal blocks e-Mailbox signal blocks scroller signal blocks (“standard” or “custom”) Description This signal enables/disables the signal block. Direction Type Value system-to-server Digital Assert to enable the signal block De-assert to disable the signal block Expected Reply Comments None Assert: Allocates server resources so server can respond to signals from the signal block.
Crestron e-control Mail SW-MAIL Enabled Applies to Description Direction Type Value e-Mailer signal blocks e-Mailbox signal blocks scroller signal blocks (“standard” or “custom”) “Handshake” response to the Enable signal. server-to-system Digital Asserted in response to assert of Enable signal. De-asserted in response to de-assertion of Enable signal.
Crestron e-control Mail SW-MAIL ErrNumber Applies to Description Direction Type Value Expected Reply Comments System signal blocks e-Mailer signal blocks e-Mailbox signal blocks scroller signal blocks (“standard” or “custom”) When the server encounters an error, it uses this signal to send an error number to the control system. Server-to-system Analog New error number None This signal works in conjunction with the ErrString and ErrTrigger signals which always follow immediately.
Crestron e-control Mail SW-MAIL ErrString Applies to Description Direction Type Value Expected Reply Comments System signal blocks e-Mailer signal blocks e-Mailbox signal blocks scroller signal blocks (“standard” or “custom”) Description of error Server-to-system Serial Error message for display None Although this signal can be safely ignored, it is easily hooked to indirect text fields on a touchscreen and/or on the CNMSX-PRO front panel, etc.
Crestron e-control Mail SW-MAIL ErrTrigger Applies to Description Direction System signal blocks e-Mailer signal blocks e-Mailbox signal blocks scroller signal blocks (“standard” or “custom”) Trigger for ErrNumber and ErrString Server-to-system Type Digital Value Pulse Expected Reply None Comments This signal is sent after the ErrNumber and ErrString to indicate that an error condition has occurred. See additional notes under ErrNumber.
Crestron e-control Mail SW-MAIL KeepAsNew Applies to Description Direction Marks the opened e-mail message as new system-to-server Type Digital Value Pulse Expected Reply Comments See Also 85 • Appendices e-Mailbox signal blocks Pulse of Done signal Mail is immediately transferred to the IN box’s “old mail view” the first time it is opened. This signal moves the message back to the “new mail view.
Crestron e-control Mail SW-MAIL LookupMsg Applies to Description Direction Type Value Expected Reply Comments e-Mailer signal blocks Performs a lookup on a message in the database, and sets subj and body accordingly system-to-server Analog A number matching the contents of the ID field of a record in the eMail_Msg table of the database file. Both the subj and body fields from the matching record are added to the recipient list. None Use of this signal is optional.
Crestron e-control Mail SW-MAIL LookupParmn Applies to Description Direction Type Value Expected Reply Comments e-Mailer signal blocks Sets a particular text substitution register system-to-server Analog A number matching the contents of the ID field of a record in the eMail_Msg table of the database file specified in the e-Mailer signal block definition. The substitution field from the matching record is set as the value for substitution parameter n. None Definition of these signals is optional.
Crestron e-control Mail SW-MAIL LookupRcpt Applies to Description Direction Type Value Expected Reply Comments e-Mailer signal blocks Performs a lookup on a recipient in the database, and adds it to the recipient list system-to-server Analog A number matching the contents of the ID field of a record in the eMail_Addr table of the database file. The name and address from the matching record are added to the recipient list. None Use of this signal is optional.
Crestron e-control Mail SW-MAIL NewCount Applies to Description Direction Type Value Expected Reply Comments e-Mailbox signal blocks Number of messages in the “new mail view” of the IN box. system-to-server Analog Quantity intended for a digital gauge object Pulse of Done signal Definition of this signal is optional.
Crestron e-control Mail SW-MAIL NewMail Applies to e-Mailer signal blocks Description Resets all e-Mail data Direction Type Value System-to-server Digital Pulse (actually, leading edge is the trigger; trailing edge is ignored) Expected Reply Done pulse Comments Specifically: Clears the From: name back to the default specified in the e-Mailer signal block definition. Clears Subj: header and body text. Clears recipient list (see ClearNames).
Crestron e-control Mail SW-MAIL OldCount Applies to Description Direction Type Value Expected Reply Comments e-Mailbox signal blocks Number of messages in the “old mail view” of the IN box. system-to-server Analog Quantity intended for a digital gauge object Pulse of Done signal Definition of this signal is optional.
Crestron e-control Mail SW-MAIL PageFlip Applies to Description Direction e-Mailbox signal blocks A message has been “opened” server-to-system Type Digital Value Pulse Expected Reply None Comments Definition of this signal is optional. A message is opened by a valid pick from the IN box scroller, i.e., a Pick signal on a non-null row of the scroller. See Also 92 • Appendices Installation & Reference Guide — Doc.
Crestron e-control Mail SW-MAIL Reply Applies to Description Direction e-Mailbox signal blocks Prepares a reply message based on the currently opened message system-to-server Type Digital Value Pulse Expected Reply Comments Pulse of Done signal If there is a bound e-mailer signal block, issues the following signals to same: NewMail In case a message is in progress (it is discarded) SetRcptName Using the from name of the opened message (but only when known) SetRcptAddr Using the from name of th
Crestron e-control Mail SW-MAIL SendNow Applies to Description Direction Type Value Expected Reply Comments e-Mailer signal blocks Sends the e-Mail message. system-to-server Digital Pulse (actually, leading edge is the trigger; trailing edge is ignored) Done pulse You must select a name and a message before sending.
Crestron e-control Mail SW-MAIL SetBody Applies to Description Direction Type Value Expected Reply Comments e-Mailer signal blocks Sets the body text of the message. System-to-server Serial (string) New value for the actual body of the e-Mail message. None Optional. The string specified for the body text is subject to text substitution at the time the message is actually sent. For more information, refer to “Text Substitution and File Inclusion” on page 48. Note that SetBody does not send any mail.
Crestron e-control Mail SW-MAIL SetFromName Applies to Description Direction Type Value Expected Reply Comments e-Mailer signal blocks Sets the sender’s real name. This name is included in quotes in the “From:” header of the e-Mail message, in front of the sender’s e-Mail address. It is not considered part of the address and may be set to anything — or excluded entirely. system-to-server Serial (string) New sender name. May contain spaces and punctuation. None This signal is not required to send e-mail.
Crestron e-control Mail SW-MAIL SetParmn Applies to Description Direction Type Value Expected Reply Comments e-Mailer signal blocks Sets a particular text substitution register system-to-server Serial (string) New value for register n. Can contain additional text substitution directives, or parts thereof. None Definition of these signals is optional. These signals provide new values for the same substitution parameters affected by the LookupParm signals (which see).
Crestron e-control Mail SW-MAIL SetRcptAddr Applies to Description Direction Type Value Expected Reply Comments e-Mailer signal blocks Sets the recipient’s e-mail address. system-to-server Serial (string) New recipient address None This signal is not required to send e-mail. This signal is one of several methods of setting the recipient address.
Crestron e-control Mail SW-MAIL SetRcptName Applies to Description Direction Type Value Expected Reply Comments e-Mailer signal blocks Sets the recipient’s real name. This is included in quotes in the “To:” header of the e-Mail message, in front of the recipient’s e-Mail address. It is not considered part of the address and may be set to anything — or excluded entirely. system-to-server Serial (string) New recipient name. May contain spaces and punctuation.
Crestron e-control Mail SW-MAIL SetSubj Applies to Description Direction Type Value Expected Reply Comments e-Mailer signal blocks Sets the e-Mail message’s Subj: header. system-to-server Serial (string) New value for the Subj: header of the next e-Mail message to be sent. None Required. The e-Mail message is considered incomplete if no subject is provided. (This is the only piece of information required to send a message. The body is not required; and all other headers have default values.
Crestron e-control Mail SW-MAIL Shortcutn Applies to Description Direction Type Value Expected Reply Comments e-Mailer signal blocks Sends message n to its default recipient system-to-server Digital Pulse (actually, leading edge is the trigger; trailing edge is ignored) Done pulse Definition of these signals is optional. When the number of shortcut signals given in the e-Mailer Signal Block Definition window is 0, no such signals are defined.
Crestron e-control Mail SW-MAIL SignalAn Applies to Description Direction Type Value Expected Reply Comments e-mailbox signal block Analog signal received in an e-mail “control” message Server to System Analog Arbitrary 16-bit value None Definition of these signals is optional. The number of signals defined is controlled by the value in the A textbox, Control messages frame, e-Mailbox Signal Block Definition window. A zero (0) in this box means that no SignalA signals are defined at all.
Crestron e-control Mail SW-MAIL SignalDn Applies to Description Direction Type Value Expected Reply Comments e-mailbox signal block Analog signal received in an e-mail “control” message Server to System Digital Arbitrary digital state None Definition of these signals is optional. The number of signals defined is controlled by the value in the A textbox in the e-Mail control message signals frame of the e-Mailbox Signal Block Definition window.
Crestron e-control Mail SW-MAIL SignalSn Applies to Description Direction Type Value Expected Reply Comments e-mailbox signal block Analog signal received in an e-mail “control” message Server to System Serial Arbitrary serial data None Definition of these signals is optional. The number of signals defined is controlled by the value in the A textbox in the e-Mail control message signals frame of the e-Mailbox Signal Block Definition window.
Crestron e-control Mail SW-MAIL Status Applies to Description Direction Type Value Expected Reply Comments e-mailbox signal block Analog signal received in an e-mail “control” message Server to System Analog Progression of values representing check mail progress None Definition of this signal is optional. The Status signal is sent multiple times during the check mail process.
Crestron e-control Mail SW-MAIL ViewOldMail Applies to Description Direction e-mailbox signal block Switches IN box scroller between the “new mail view” and the “old mail view.
Crestron e-control Mail SW-MAIL Appendix D: System limitations Serial Transmissions The length of the value of all serial signals (all the Set— signals) is limited to 83 characters. Furthermore, the total length of all signals (including header bytes) to be transmitted in a single logic “wave” must not exceed 255 characters.
Crestron e-control Mail SW-MAIL Appendix E: Standard Scroller / Custom Scroller Feature Comparison Standard scroller options Custom scroller options no license required SW-DBM license required Enable signal non-functional except in simulation (from Signal Analyzer window). Enabled signal sent by server as usual (but not available through DBMScroller macro).
Crestron e-control Mail SW-MAIL Appendix F: Dial-up TCP/IP configuration You should install the Windows Dial-up Networking software. Configure it to connect using Point-to-Point Protocol (PPP) without user confirmation and to disconnect after idle for 1 minute. Our experience is that the initial settings upon a fresh installation of Dial-Up Networking are usually already set to allow for dialing without user confirmation.
