Crestron e-control Mail User Manual Download Page 1

Page: 1 / 109

CRESTRON

e-control™ Mail

(SW-MAIL)

version 1.4

Summary of Contents for e-control Mail

Page 1: ...CRESTRON e control Mail SW MAIL version 1 4 1999 Crestron Electronics Inc...

Page 2: ...erver Configuration In Depth 20 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 The e Mail Dat...

Page 3: ...Intersystem Communications and Signal Space Considerations 61 System Connections 61 Appendix C Signal Reference 65 Definition of Terms 65 String Proxies 65 Bit Patterns 65 Standard e mail Address Form...

Page 4: ...l 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 t...

Page 5: ...Doc 5798 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 i...

Page 6: ...ntrol Mail Demos use the File Configuration file command to select the file demomail ini 6 Specify an SMTP outgoing mail server address The initial configuration password is crestron2 Give command Ser...

Page 7: ...the server to use the Configuration Settings file demomail ini 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...

Page 8: ...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 e...

Page 9: ...ces 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 Whatev...

Page 10: ...tems 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 f...

Page 11: ...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 Required to make serial RS...

Page 12: ...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 packag...

Page 13: ...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 va...

Page 14: ...me 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 Transfe...

Page 15: ...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 i...

Page 16: ...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 on...

Page 17: ...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...

Page 18: ...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...

Page 19: ...operly 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 Fix...

Page 20: ...oint 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...

Page 21: ...4 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 Conf...

Page 22: ...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 on...

Page 23: ...ckbox For more information about text substitution see Text Substitution Directives on page 48 Text substitution directives are normally replaced with the contents of text substitution registers The c...

Page 24: ...trol 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...

Page 25: ...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 activate...

Page 26: ...mmunications 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 de...

Page 27: ...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...

Page 28: ...mber 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 butto...

Page 29: ...l 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...

Page 30: ...nown 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 Bl...

Page 31: ...ddress required of the entity to whom the message is being sent Two fields appear in the Recipient Header frame of the e Mailer Signal Block Definition window As defaults the information provided ther...

Page 32: ...om the tables via the two Lookup signals or verbatim using the various Set signals see Appendix C on page 65 Run time properties Three checkboxes appear in the Properties portion of the e Mailer Signa...

Page 33: ...nal block either uncheck its checkbox or enter a zero or blank into its textbox Using Send e Mail SIMPL symbol This option is a convenience feature Checking it forces the selection of optional signals...

Page 34: ...started 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 Fo...

Page 35: ...end up in the IN box If an IN box scroller is not specified non control messages are ignored and possibly deleted from the server see Delete from Mail Server as downloaded below If the Process contro...

Page 36: ...ably routinely checks when he is on line as well NOTE Control messages are always deleted as soon as they are processed regardless of the setting of this option Therefore this option only applies to m...

Page 37: ...tangles representing each of the defined systems The color of a control system s rectangle indicates its connection status according to the legend When the server protocol is not running all systems s...

Page 38: ...er protocol starts whereupon the following signals normally disabled become enabled Server Stop halts the server protocol Server Signal Analyzer opens or closes the Signal Analyzer window When this it...

Page 39: ...l Analyzer window showing the all the active signal blocks defined in the demo configuration The DEMO3 signal block is selected Therefore the DEMO3 signals are displayed in the lists to the left and r...

Page 40: ...blocks to and from all control systems Each signal logged consists of the following An optional timestamp see below followed by an incoming signifier or an outgoing signifier followed by one of the le...

Page 41: ...ystem signal blocks The intent would be to keep the log uncluttered when a control system has been programmed to ping to server on a periodic basis Log Clear clears the signal log Log Timestamps Selec...

Page 42: ...hes the entire log starting with the signal on the highlighted line The e Mail Database Tables The supplied sample e Mail Database file maildemo mdb contains 22 tables Table Viewable from Server Descr...

Page 43: ...dow represent required fields which must not be eliminated Using other software such as Microsoft Access you may insert additional fields into the tables for your own purposes Such fields will be acce...

Page 44: ...lts Checkbox page 23 can reverse this statement Tables for receiving e mail The following subsections discuss the tables available to an e mailbox signal block There are two such tables InBoxn and msg...

Page 45: ...tabase file will be compatible with tomorrow s upgrade Supplied Empty Tables Creating new IN box and message tables is not possible from the server To create a new IN box table use Microsoft Access to...

Page 46: ...cords can be deleted by selecting the entire row by clicking in the row margin and depressing the DEL key The information in each cell can be replaced by simply highlighting the cell and typing over i...

Page 47: ...n is the signal value As described above these values either add to build a recipient list or are replaced by subsequent sets lookups picks until the SendNow signal is issued depending on the state of...

Page 48: ...e database tables as interactive scrolling lists Picking touching elements in these lists depending on the list either add a recipient to the recipient list or set up a message in exactly the same way...

Page 49: ...ution does not take place until the mail is actually sent upon receipt of the SendNow signal or a Shortcut signal the registers invoked by the text only need to be defined prior to that time which cou...

Page 50: ...a control message as such it must conform to the definition of a control message which is any message with the string CTRL at the start of the subject header Once the server decides that a message is...

Page 51: ...re to neutralize any formatting that may come along with the paste action Test script Any lines that do not begin with CTRL are ignored and can be used for comments such as this line 1 Turn on first a...

Page 52: ...ploading if your target touchpanel is not one of those mentioned above Conversion is a simple matter using VT Pro e Before attempting to run the demos use the File Configuration File command to make s...

Page 53: ...ivers General folder or add a Virtual Communication Port from the Ethernet Control Modules folder and a driver as above In the Programming Manager the other two blocks are added to the system from the...

Page 54: ...value represents a key a record ID number which is used to look up a name and address from an address book table LookupMsg is used similarly to look up a subject and a message body from a table of me...

Page 55: ...choice from first page These instructions are detailed in Communications Setup beginning on page 15 herein Either path leads to the same demo page NOTE Before proceeding to the actual demo page start...

Page 56: ...cted from the e Mail Database sub folder The DBMScoller macros can be found in the Crestron Modules folder e Mail Database sub folder Demo 3 VT Pro e Program The structure of the demo 3 touchscreen pa...

Page 57: ...information about the demo and a button labeled Go to demo screen NOTE Before proceeding to the actual demo page start the server protocol by issuing the Server Start command Page 4 1 New mail view T...

Page 58: ...Crestron e control Mail SW MAIL 58 Demos Installation Reference Guide Doc 5798 join NONE Only after the desired data has been sent the server issues the PageFlip signal...

Page 59: ...cannot exceed the respective limits of your license Should this happen a warning appears on the Signal Blocks tab and the server protocol does not start There is no theoretical limit to the total num...

Page 60: ...Appendices Installation Reference Guide Doc 5798 COM Settings definition which contains a similar set of error reporting signals These signals include ErrNumber ErrString and ErrTrigger See the Signa...

Page 61: ...strains the definition to ensure compatibility with this symbol Likewise Standard Scroller signal blocks can use the DBMScroller SIMPL Windows macro Each active signal block exchanges data with a part...

Page 62: ...ignals available However while the first 1024 signals may be of any type Analog serial or digital the remaining 3072 signals can only be used for digital signals An additional constraint imposed by th...

Page 63: ...system Communications symbols using the same connection must specify a value to offset their signal numbers by a constant amount The top signals in such an Intersystem Communications symbol do not beg...

Page 64: ...channel connections Do not use multiple channels if there is any possibility of needing to revert to an RS 232 connection Multiple Connections Usually all Intersystem Communications symbols from a sin...

Page 65: ...ervices such a construct Sender The e mail account referred to by the address that appears in the From header Server The Crestron Software Server That is swserver exe running on a Windows PC Signal Bl...

Page 66: ...nations of the four bits For example the sixteen bit base 2 pattern 0 0 0 0 0 0 0 1 1 1 0 1 0 1 0 1 can be broken into the four four bit sets 0000 0001 1101 0101 which get assigned to them the four he...

Page 67: ...items are preceded with either a per cent sign or a dollar sign Items preceded with are informational Items preceded with are errors reflecting unanticipated situations Signal Summary The Signal Refer...

Page 68: ...em to server D e mailbox OldCount server to system A e mailbox PageFlip server to system D COM Settings PingSvr system to server D COM Settings PingSys server to system D COM Settings PongSvr system t...

Page 69: ...ox See Control Messages on page 34 When Delete messages as downloaded is checked in the e Mailbox Signal Block Configuration window messages are always deleted from the host immediately after download...

Page 70: ...ailing edge is ignored Expected Reply Done pulse Comments 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 Se...

Page 71: ...ted Also deleting the message from the host ensures the same message is not downloaded again If the message is no longer on the e mail host presumably because it was deleted by the host in the meantim...

Page 72: ...d Done is only sent if the operation was successful If it was unsuccessful the Err signals are sent instead Typically there is a 0 2 sec delay between the leading and trailing edge of the pulse Signal...

Page 73: ...onal 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 Specifically...

Page 74: ...is signal is optional If the date header is somehow null the following string is substituted rec d mm dd yy hh mm ss AM The actual format of the date and time is determined by your system settings see...

Page 75: ...s 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 Only the name or address of the sender i...

Page 76: ...mited to 83 characters If the recipient list exceeds this length the transmitted string is truncated and an ellipsis is substituted for the remaining characters To make the most of the 83 characters o...

Page 77: ...il and manually picking an item from a bound data scroller Specifically excluded are Shortcut signals and the SetSubj signal Echoing the recipient address does not necessarily imply that the address h...

Page 78: ...t might precipitate this are LookupRcpt LookupMsg ClearNames NewMail and manually picking an item from a bound data scroller Specifically excluded are Shortcut signals and the SetRcpt signal Default n...

Page 79: ...ght precipitate this are LookupMsg ClearNames NewMail and manually picking a message from a bound message scroller Specifically excluded are Shortcut signals and the SetSubj signal e Mailbox signal bl...

Page 80: ...led after the signal is processed otherwise it is disabled Demo 1 depends on this feature Two special situations are noted below 1 Referenced scrollers are auto enabled When a scroller signal block is...

Page 81: ...ments Although this signal is often ignored in a proper implementation the control system should 1 Wait for assertion of Enabled before issuing any other e mail signals 2 Indicate an error condition i...

Page 82: ...box in the System Definition window For signal blocks they are defined for a custom scroller by the Local Errors checkbox in the Signal Block Definition window The Err signals cannot be defined in a S...

Page 83: ...ed Reply None Comments 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 This signal is used by the server...

Page 84: ...nal blocks scroller signal blocks standard or custom Description Trigger for ErrNumber and ErrString Direction Server to system Type Digital Value Pulse Expected Reply None Comments This signal is sen...

Page 85: ...Comments 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 This is useful when more than one person is u...

Page 86: ...is acceptable The message record also contains a reference to a record in the recipient name and address table That record is used to provide an implicit recipient name and address but only when no r...

Page 87: ...le 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 Expected Reply None Comments...

Page 88: ...method the following error message is sent back to the control system No recipient specified mail cannot be sent If the record is found but contains a null addr field the default recipient address sp...

Page 89: ...e object Expected Reply Pulse of Done signal Comments Definition of this signal is optional Updated whenever it changes When the signal block is enabled via Enable As new mail is received into the IN...

Page 90: ...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 The Done pulse s...

Page 91: ...iew of the IN box Direction system to server Type Analog Value Quantity intended for a digital gauge object Expected Reply Pulse of Done signal Comments Definition of this signal is optional Sent When...

Page 92: ...e Mailbox signal blocks Description A message has been opened Direction server to system Type Digital Value Pulse Expected Reply None Comments Definition of this signal is optional A message is opene...

Page 93: ...is discarded SetRcptName Using the from name of the opened message but only when known SetRcptAddr Using the from name of the opened message which is always known SetSubj Using the subject header of...

Page 94: ...seconds it could take longer especially when the domain name of the SMTP server is unknown to the local DNS server In such a case it is possible that the Database Manager app s input buffers could ove...

Page 95: ...nal 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 t...

Page 96: ...e mail The sender name may be any string It normally does not have to match the name on record for the sender s e Mail account and can vary from message to message It may be set to null blank by sendi...

Page 97: ...are lost when the server protocol is halted It is not necessary to set them up for every message unless there is a change obviously The specified text substitution register can contain additional tex...

Page 98: ...nt in reverse order the results will be completely erroneous The first address has no SetRcptName signal associated with it and uses the default name each subsequent address is associated with the nam...

Page 99: ...until the SetAddr signal is issued that signal acting as a trigger Therefore this signal may be sent and then resent repeatedly with different values the most recently sent value is eventually used S...

Page 100: ...ult values If the SendNow signal is issued but the subject header has not been set by any method the following error message is sent back to the control system No message specified mail cannot be sent...

Page 101: ...x D System limitations on page 107 for a discussion of these limits The number of Shortcut signals defined should be set to 16 to accommodate all sixteen possible signals which may be issued from the...

Page 102: ...ssages frame e Mailbox Signal Block Definition window A zero 0 in this box means that no SignalA signals are defined at all A message with the following control equate syntactical construct in the sub...

Page 103: ...this box means that no SignalA signals are defined at all A message with the following control equate syntactical construct in the subject header or in any line of the body text causes the server to...

Page 104: ...window A zero 0 in this box means that no SignalA signals will be defined at all A message with the following control equate syntactical construct in the subject header or in any line of the body text...

Page 105: ...during the check mail process The series of unsigned 16 bit values are intended as input to an analog gauge display which might be on a touchscreen page or on a control system s front panel The signa...

Page 106: ...x scroller recordset and display only old mail De assert Requery IN box scroller recordset and display only new mail Expected Reply Possible new data to IN box scroller s List and Scrollbar signals Co...

Page 107: ...ers If the total length of all signals required to specify the strings for an e Mail message exceeds 255 characters you must ensure that transmission occurs in several waves by installing sufficient d...

Page 108: ...usual but not available through DBMScroller macro Fully functional Enable and Enabled signals Maximum of 8 rows x 2 columns Any number of rows columns in displayed list e Mail data echoed through e Ma...

Page 109: ...cessories Dial Up Networking or possibly Start Programs Accessories Communications Dial Up Networking 2 In the resulting window click More to reveal a pop up menu from which select User Preferences 3...

Search results

Summary of Contents for e-control Mail

Reviews:

Related manuals for e-control Mail

Brands by name

Popular brands

Crestron e-control Mail, User Manual

Search results

Summary of Contents for e-control Mail

Reviews:

Related manuals for e-control Mail

Brands by name

Popular brands