SOP Micrologix Email

From PTAGISWiki

	Standard Operating Procedure
Subject:	SOP Micrologix Email
Author:	Troy Humphrey
Approved by:	S.Livingston 12/22/08

Objective

The objective of this SOP is to lay out the basic steps required to program a Micrologix PLC to send email.

Scope

The Micrologix PLC will email individuals or in the case of PTAGIS it will email the pit event for the sight that it is installed at. The emails will be event driven. For example if the Micrologix PLC is monitoring a ladder level and the level crosses a threshold an email will be sent to the pit event for that site.

This procedure assumes the reader is familiar with Allen Bradley PLCs and Allen Bradley programming software.

Responsibilities

PSMFC is responsible for programming the Micrologix to send a email.

Procedure

Overview of how a ML1100 produces an email

The ML1100 requires a MSG Instruction and two string elements in order to send an email. As you follow the steps laid out below keep in mind that you will have to create a MSG instruction for every state change you want an email for. The ML1100 works differently than conventional email servers. The ML1100 sends a MSG instruction to it's self which invokes the email. The MSG instruction should contain two elements, each of the ST or String data format. The first element is the SUBJECT of the email and the second element is the BODY of the email.

Software and Firmware Requirements

The Micrologix 1100 PLC is configured using RSLogix 500. Your RSLogix 500 version must be 7.20.00 or higher in order to program the unit to send email.
- If your version of RSLogix 500 is not 7.20.00 then upgrade your software.
The Micrologix 1100 must be at FRN 5.0 or higher in order to send email.
- If your Micrologix 1100's firmware is not at FRN 5.0 then upgrade your firmware.
  - The Micrologix 1100's firmware is upgraded via Ethernet using the ControlFLASH program. This will require you to first establish communication with the ML1100 via RS232, configure CH1 (give it a IP address, sub net mask, etc) and then re-establish communications using a Ethernet driver.

Change the Controller Properties

If your ML1100 was not already at FRN 5.0 you had to upgrade the firmware. Once the firmware and software are updated you need to change the controller properties. From the Controller folder under the Project tree in RSLogix 500:

Double click on Controller Properties.
On the General tab change the Processor Type: parameter to a MicroLogix 1100 Series B.
Fill in the Processor Name: parameter with the site code followed by MICRO.

Controller Properties General Tab

Configuring CH1

From the Controller folder under the Project tree in RSLogix 500:

Double click on the Channel Configuration.
Click on the Channel 1 tab and ensure that the following are configured.
- IP Address: IP address of the ML1100.
- Sub net Mask: Sub net Mask of the Sub net the ML1100 will reside on.
- Gateway Address: IP address of the Gateway the ML1100 will use.
- HTTP Server Enable: box is checked.
- Auto Negotiate: box is checked.
- SMTP Client Enable: box is checked.
When you are done the Channel 1 tab should look similar to the graphic below. Note that a fourth tab should appear when you check the SMTP Client Enable box.

Channel Configuration Channel 1 Tab

Configuring the Chan. 1 - SMTP tab

From the Chan. 1 - SMTP tab

Configure the following parameters:
- Email Server: Use the IP address of the SMTP server.
- From Address: Use a email address that will be recognized by site scape.
- TO Address[0]: Set this to pitevent@psmfc.org.
When you are done the Chan.1 - SMTP tab should look similar to the following graphic.

Chan. 1 - SMTP Tab

Set up the Data tables

You will need to add 3 new data files.

A Message or MG file.

MG Data File

A String or ST file.

ST Data File

A Routing Information or RI file.

RI Data File

You must configure the number of elements that you want for the ST file. For every email state you wish to report you will need 2 elements. If you are reporting a Low Level, you will most likely want to report a Normal Level which will require 2 additional elements. The size in Elements is not critical for the MG and RI files as RSLogix 500 will automatically add them.
The ML1100 uses a Message Instruction to send a message to it's self which in turn invokes the email. The MSG Instruction sends two elements. The first element being the 'Subject' of the email and the second element being the 'Body' of the email. To send an email to the pit event of a site you must have the subject as the 'Site Code'.
Once you have the ST file created you will need to edit it. Use the following graphic as and example.

Configured ST Data File

Program the Message Instruction

As mentioned earlier in the SOP the ML1100 sends an message to it's self to invoke a email. Notice the graphic below has a 'One-Shot' in the rung for the MSG instruction. This is required to avoid multiple emails.

MSG Rung

MSG Instruction Set Up General Tab

Double Click on the 'Setup Screen'
From the 'General' tab, enter the following parameters
- Channel: 1
- Communication Command: 485CIF Write
- Data Table Address: The starting address in the ST file that contains the message related to the state change that triggers the MSG instruction. In the example below ST10:0 content is ICH for Ice Harbor. ST10:1 is RIGHT LADDER WATER LEVEL LOW.
- Size in Elements: 2
  - This means the MSG instruction will send elements ST10:0 and ST10:1. (The subject and body of the email)
- Data Table Offset: Typically this will be 100 and refers to the address entered in as the TO Address[0] in the Chan. 1 - SMTP tab (pitevent@psmfc.org).
- Local / Remote: Local
- Routing Information File(RI): Enter the next available RI address.

MSG Setup General Tab

MSG Instruction Set Up MultiHop Tab

Enter the IP address of the ML1100 you are programming in the To Address.

MSG Setup MultiHop Tab

Repeat this process for each state that you require an email for.

References

Contact PSMFC at (509) 735-2773

Name	Extension
Don Warf	1
Scott Livingston	2
Darren Chase	3
Alan Brower	4
Troy Humphrey	5