Table of Contents
Advertisement
Quick Links
Advertisement
Table of Contents
Related Manuals for AMX i!-EquipmentMonitor
Summary of Contents for AMX i!-EquipmentMonitor
-
Page 1: Instruction Manual
! S o l u t i o n s... -
Page 2: Limited Warranty
CUSTOMER REMEDIES. AMX Corporation’s entire liability and your exclusive remedy shall be, at AMX Corporation's option, either (a) return of the price paid, or (b) repair or replacement of the SOFTWARE that does not meet AMX Cor- poration's Limited Warranty and which is returned to AMX Corporation. This Limited Warranty is void if failure of the SOFTWARE or hardware has resulted from accident, abuse, or misapplication. -
Page 3: Table Of Contents
Table of Contents Introduction ...1 Supported Operating Systems ... 1 Minimum PC Requirements ... 1 Installing i!-EquipmentMonitor ... 2 Running i!-EquipmentMonitor ...3 Sending Email ... 3 Receiving Email... 4 Configuring for Timezone ... 6 i!-EquipmentMonitorOut.axi... 7 Constants ... 7 Structures... 8 Variable ... - Page 4 Table of Contents i!-EquipmentMonitor...
-
Page 5: Introduction
™ NetLinx Control System. i!-EquipmentMonitor is primarily used to send and receive NetLinx Control System e-mails, such as sending e-mail notifications for system problems or equipment trouble and receiving e-mails for Control System messaging. i!-EquipmentMonitor consists of the following files: i!-EquipmentMonitorIn.axi is an include file for receiving e-mails using POP3... -
Page 6: Installing I!-Equipmentmonitor
3. The Welcome To i!-EquipmentMonitor Setup dialog appears, reminding you to close all Windows programs before going any further. Click Next to proceed. 4. In the Select i!-EquipmentMonitor Install Location dialog, use the Browse button to navigate to a directory other than the default install directory, if desired. Click Next. -
Page 7: Running I!-Equipmentmonitor
If the SMTP email server allows anonymous access and does not require authentication, you simply comment out the previous SmtpSetUser() function call. Without an SMTP username and password configured, i!-EquipmentMonitor will connect to the SMTP server with anonymous access. i!-EquipmentMonitor // Include to send email section for 0:10:0. -
Page 8: Receiving Email
Running i!-EquipmentMonitor Now, all you need to do is call the function that sends an email. If you want to send an email every time someone presses a button on a touch panel, your code would look like this: BUTTON_EVENT[dvTP,1] PUSH: SmtpQueMessage('fromAddress@mydomain.com',... - Page 9 You can check for the email to arrive by waiting for the offline message from the device. i!-EquipmentMonitor makes the emails available to you in three different variables: sPop3EmailMessage nPop3TotalMail default = 20) and how many emails were on the server when i!-EquipmentMonitor last logged in. Up to POP3_MAX_EMAILS you retrieve them again.
-
Page 10: Configuring For Timezone
'i!-EquipmentMonitorTest with i!-TimeManager.axs' provides an example of using these two applications together. Using i!-TimeManager is recommended for use with i!-EquipmentMonitor since some email clients may improperly display the time when the email or notification was sent. i!-TimeManager provides i!-EquipmentMonitor with a universal time reference, including any Daylight Savings time offsets, and includes this information in the email or notification. -
Page 11: I!-Equipmentmonitorout.axi
Maximum length for e-mail addresses (default = 500). Maximum length for date, subject and attached file (default = 256). Maximum length for number of queued e-mails (default = 10). Maximum length for e-mail message (default = 2000). Running i!-EquipmentMonitor Continued... -
Page 12: Structures
Running i!-EquipmentMonitor Structures The following defines an i!-EquipmentMonitorOut.axi structure: Structure _sSMTPMessage CHAR cDate[SMTP_LINE_MAX]; CHAR cSource[SMTP_USER_MAX]; CHAR cDest[SMTP_USER_MAX]; CHAR cSubject[SMTP_LINE_MAX]; CHAR cMessage[SMTP_MSG_MAX]; CHAR cFile[SMTP_LINE_MAX]; Variable The following is an i!-EquipmentMonitorOut.axi variable: VOLATILE CHAR bSMTPDebug Functions The following are a list of i!-EquipmentMonitorOut.axi functions: i!-EquipmentMonitorOut.axi Functions... - Page 13 Example: SmtpSetTimeOffset ('-0600') Remarks: SmtpSetTimeOffset should be called to configure i!-EquipmentMonitor to send emails with the correct time. Some SPAM detectors may mark an e-mail as spam if the timezone is not correctly reported. i!-EquipmentMonitor is designed to work with i!-TimeManager to obtain timezone information.
- Page 14 SmtpSetUser doe not return any values. Example: SmtpSetUser ('MyUserName','MyPassword') Remarks: SmtpSetUser should be called to configure i!-EquipmentMonitor to send emails to an SMTP server that required authentication. You should not have to call this function directly. To configure SMTP authentication, please see the SmtpSetUser() function.
-
Page 15: I!-Equipmentmonitorin.axi
Maximum size of message body (default = 2000). Maximum number of attachment file names stored (default = 5). Emails retrieved from server Number of message retrieved from server Number of total messages on server Set to 1 to debug Running i!-EquipmentMonitor... -
Page 16: Functions
Running i!-EquipmentMonitor Functions The following table lists i!EmailIn.axi functions. i!-EquipmentMonitorIn.axi Functions Pop3ClearAllEmail Messages Deletes all e-mails from the internally stored email list. Pop3ClearEmail Message Deletes an e-mail from the internally stored e-mail list. Pop3GetEmail Retrieves e-mail from the server. Syntax: Pop3ClearAllEmailMessages() Pop3ClearAllEmailMessages has no arguments. - Page 17 String containing the user name of your e-mail (POP3) account. Pass String containing the user password of your e-mail (POP3) account. Pop3SetUser does not return a value. Example: Pop3SetUser('vmorrison','GoldenAutumnDay') Remarks: Pop3SetUser should be called in DEFINE_START of your application. Running i!-EquipmentMonitor...
- Page 18 AMX reserves the right to alter specifications without notice at any time. brussels • dallas • los angeles • mexico city • philadelphia • shanghai • singapore • tampa • toronto* • york 3000 research drive, richardson, TX 75082 USA • 469.624.8000 • 800.222.0193 • fax 469.624.7153 • technical support 800.932.6993...