EIM Overview: Difference between revisions

From EMIT Controls
No edit summary
No edit summary
Line 13: Line 13:
=== Display Contents And Operation ===
=== Display Contents And Operation ===


===== Header =====
==== Header ====
* “Home” button – Navigates to home screen of currently viewed module
* “Home” button – Navigates to home screen of currently viewed module
* “Eng” label – Indicates if valid run signal from the engine is present (“Eng: Run”) or not present (“Eng: Off”)
* “Eng” label – Indicates if valid run signal from the engine is present (“Eng: Run”) or not present (“Eng: Off”)
Line 20: Line 20:
* “Back” button – Navigates to the previous screen
* “Back” button – Navigates to the previous screen


===== Footer =====
==== Footer ====
* “System Menu” button – Navigates to System Menu screen (Pg. 0)
* “System Menu” button – Navigates to System Menu screen (Pg. 0)
* “Access:” button – Displays current security access level and navigates to Security Access screen (Pg. 1) to change security level
* “Access:” button – Displays current security access level and navigates to Security Access screen (Pg. 1) to change security level
Line 27: Line 27:
* Date/Time button – Navigates to the Date/Time screen (Pg. 2) to modify the date and time
* Date/Time button – Navigates to the Date/Time screen (Pg. 2) to modify the date and time


===== Display Active Area =====
==== Display Active Area ====
Displays content for the specific screen being viewed
Displays content for the specific screen being viewed


Line 69: Line 69:


<nowiki>*</nowiki>Insert Image*
<nowiki>*</nowiki>Insert Image*
=== VIEWING TIMERS ===
A list of the general purpose and automatically-generated timers can be quickly viewed on the Timer Management screen (Pg. 20). The columns within the screen include:
* “Timer” – Name of the timer.
* “Remaining” – Time remaining in hours and minutes.
* “Status” – Displays the current status of the timer.
* “Running” – The timer is currently counting down.
* “Engine Off” – The count type of the timer is “Run Hours”, the engine is off, and the timer is not counting down.
* “Past Due” – The timer has expired and is no longer operational.
* “Annual” – Displays date and time of the annual expiration of the timer. If no annual option was enabled, “(Not Used)” will be displayed.
Select the “View” button to view additional details or edit the timer.
If an EMD is present and Management Practices are available, the Timer screen (Pg. 20) will display two separate sets of timers: “Compliance Timers” and “General Timers”.
=== VIEWING SINGLE TIMER ===
To view existing timers, navigate to the Timer View screen (Pg.23) by selecting the “View” button of the timer to be modified from the Timer Management screen (Pg. 20). The following timer options are available:
* “Delete” – Deletes timer.
* “Edit” – Navigates to Timer Add/Edit screen (Pg. 23) to change the timer configuration.
* “Restart” – Restarts the timer
== Alarms Overview ==
The EIM and associated modules are capable of identifying a wide range possible alarm conditions. Depending on the module there are a set of custom and fixed alarms in the system to generate an alarm event for the error condition. See the “ALARMS” section of any of the modules for details on how to configure an alarm. As discussed in the module alarm sections, most alarms can be set up to close the error relay and shutdown the engine on critical alarms (other than annunciator, which shuts down the engine directly).
Active alarms will cause the “Alarms” button in footer of the display to show the number of current alarms and flash the text. Selecting this button will navigate to the Alarms screen (Pg. 40) that displays the current alarms with their associated date/time stamp, alarm code, description, and action taken.
<nowiki>*</nowiki>Insert Image*
Selecting the “View” button of the associated active alarm navigates to the View Alarm screen (Pg. 41). This screen displays the alarm in additional detail and provides the option to clear the alarm by pressing the “Reset Alarm” button or examine the configuration of the alarm by selecting the “Go To Setup” button. This screen also has a “Sensor Snapshot” button to see a snapshot of the sensors for the given module at the time the alarm occurred.
If an alarm covers a single sensor value high or low trigger, selecting "View" will go to a graph showing the value of that sensor for the minute before the alarm.
Note: Most alarms are only active if the run signal is in the “Run” condition and the alarm timer on the home page has expired. If the Run Signal Trigger is not properly configured an alarm condition could be missed.
=== ALARM HISTORY ===
The alarms screen has a button “Alarm History” which brings up the Alarm History screen (Pg. 42) a list of all past alarms that have been acknowledged (cleared). The “< Prev” and “Next >” buttons at the bottom of the screen can be used to scroll through the list of past alarms. Clicking on “View” on an alarm will show the details for the given past alarm.
=== SENSOR SNAPSHOT ===
For active alarms, a sensor log is saved for 60 seconds of data during the time leading up to the alarm. This log can be downloaded by inserting a USB drive and selecting 'Download'.
For past alarms, a button is present to view the sensor snapshot at the time of the alarm (shown below). This list shows only the sensors at the time of the alarm (not the full 60 seconds).
<nowiki>*</nowiki>Insert Image*
If an alarm pulls up the alarm graph display instead, the sensor snapshot can still be downloaded by inserting a USB drive.
Note that the Alarm History page will show all past alarms that occurred on the EIM. The Alarm Snapshot data will only be saved on EIM versions 1.58 or newer, so some past alarms may not have sensor snapshot information. The one minute of snapshot data will only be available for active alarms. Once an alarm is reset, the history page will only show the snapshot for the moment the alarm occurred.
== Engine Information Page ==
The Engine Info screen (Pg. 7) configures and displays engine specific data. The information is available for view in Operator security mode. To edit or modify any of the data, Setup or Engineering security mode is required. Engineering mode is required to modify the engine configuration.
* Engine Status – Displays the engine run signal status as either ‘Running’ or ‘Run Signal Not Detected’ based on the run signal auto-detect
* Engine Hours – Displays the current cumulative hours of the engine
* This value can be modified to match an existing engine hour meter in Engineering security access mode
* Engine Uptime – Displays the current uptime of the engine based on the run signal.
* Engine Make – Selects the engine manufacturer from a drop-down list
* Engine Model – Displays engine model
* Press button to add or edit model
* Engine Serial Number – Displays engine serial number
* Press button to add or edit engine serial number
* Engine Arrangement Number – Displays Caterpillar arrangement number
* Press button to add or edit arrangement number
* Combustion – Adjusts rich burn or lean burn setting for AFRC
* Banks – Adjusts number of banks for the AFRC Advanced
* AFRC Lite is fixed to single bank configuration
* O2 Sensor Type – Adjusts the AFRC configuration between wideband O2 sensors (6-wire) or narrowband O2 sensors (4-wire)
* Lean burn configuration must use a wideband O2 sensor (6-wire)
* Control Type – Adjusts control method for AFRC Advanced between Setpoint mode and AutoControl mode (no adjustable setpoint)
* AFRC Lite is fixed to Setpoint mode
<nowiki>*</nowiki>Insert Image*
== Modbus RTU ==
=== Introduction ===
This document describes an overview of Modbus and how it is used in the ETS system. Modbus (RTU) can be used to read a variety of data from the ETS system to some sort of Modbus master device, to be used remotely or on-site. A proper understanding of how the items are addressed and scaled in ETS will help ensure your system setup works correctly.
=== Brief Modbus Overview ===
Modbus is a serial communication protocol that is designed for reading and writing individual data items from a set of devices on the serial network. The device sending the commands is called the Modbus Master, and each other device on the network is called a Modbus Slave. Each slave will have a unique address, called the “Slave Address”, “Station Address”, or “Slave ID”. This address can run from 1 – 247.
Each slave ID will have a set of “Modbus Registers” that link to certain data items. The registers are broken into four sets, each numbered in a different range:
* (1-9999) Discrete Output Coils
* (10001-19999) Discrete Input Contacts
* (30001-39999) Analog Input Registers
* (40001-49999) Analog Output Holding Registers
While the register numbers, as referenced in documentation, will be numbered as they are above, it is important to note that in an actual Modbus command the data address (not to be confused with station address above) is always numbered 0-9999, and the register set that is actually read is based on the function code.
A command will contain a specific “Function code”, which indicates whether it is a read or write, whether it covers one or multiple registers, and which of the four register sets is used. There are 8 function codes in standard Modbus.
A Modbus Master command will contain:
# The slave ID for which the command is intended
# The function code
# The data address of the register
# The number of registers requested (for some function codes)
# The “CRC”, which is an error-checking number
As an example, we might want to read register 40002. The Modbus will send a command to the slave ID in question with function 4 (read input registers) from data address 1. Since the function code links to analog input registers, then the slave will know that the data address “1” is referring to register 40002, because analog input registers are register set 40001-49999, and address 1 is the second register (the first being address 0).
=== MODBUS in ETS ===
==== Wiring / Port Setup ====
The primary modbus port is the RS-485 connection on the back of the EIM (screen). This port is configured on the Modbus setup page, shown below. Select the correct option in the 'communications' dropdown to match the SCADA system. The most common two port settings used in the field are "9600,N,8,1" or "19200,E,8,1". Wire the SCADA RS-485 A/B connection to the EIM RS-485 A/B connection. If the EIM is in an EMIT panel, this connection may have already be ran to empty terminal blocks for convenience, and the SCADA RS-485 connection can be wired there instead (check the panel schematic).
Some panels will have an EDT present, which also has a duplicate slave 485 port in case there are two SCADA systems. This port is set up separately: under the "EDT Setup" -> "Slave modbus port settings".
Separately, the ethernet port can be used with Modbus/TCP, and it set up on the 'ethernet' setup page under 'system settings'.
Any or all of the three connection options above can be used, but in all cases the register numbers and IDs being read (discussed below) are the same.
<nowiki>*</nowiki>Insert Image*
=== Slave IDs ===
In ETS, each module in the system will have its own slave ID. However, all Modbus responses will come from the EIM only, which has the Modbus connection. The slave ID can be changed on the EIM on the Modbus screen.
For example, the EIM might have an ID of 10 and the AFRC Lite might be connected and have an ID of 11. If a Modbus master command arrives addressed to either ID 10 or 11, the EIM will respond. For any other address, the EIM will not respond.
<nowiki>*</nowiki>Insert Image*
Modbus Screen showing slave ID setups
If a Modbus request arrives matching a module ID, but that module is not actually attached currently, the EIM will not respond.
=== Register Scaling ===
Each module in ETS has its own Modbus table showing the data at different registers. An example section of the AFRC Lite Modbus table is shown below.
<nowiki>*</nowiki>Insert Image*
For many registers, the value is scaled to go from a decimal number to an integer. To decode from a Modbus register value to the real value, use the equation below<blockquote>[real value] = [register value]*[Resolution/Bit] + [Offset]</blockquote>The last two items in the above equation are in the Modbus tables. As an example, perhaps the register 30001 (Pre-Cat Exhaust Temp) was read and the value was 37,077. Using the values from the above table:<blockquote>[real value] = 37077*0.03125 + (-273) = 885.6 degrees</blockquote>
=== Register Addressing ===
Note also in the table above that there is a separate column for “Register” and “Address”. The difference between the two has been previously discussed, and both are listed for convenience. Different Modbus and SCADA systems use various methods for specifying the register that is read. The register itself might be entered in a high-level program, and it will determine the data address on its own by using the last 4 digits. Alternately, a program might need the data address specified directly. The ETS uses “PLC Addressing” which is base 0 addressing. If this is not an option in a Modbus Master program, the address that is requested might have to be decremented by 1.
==== Example ====
In the program “Modbus Poll”, the following setup was used for Read/Write definition:
* Slave ID: 20 (which was the AFRC Lite configured slave ID)
* Function 04 Read Input registers (This uses the table above, registers 30001-39999)
* Address: 1
* Quantity: 3 (Address 1 and quantity 3 should read registers 30001-30003)
* PLC Addresses (Base 1) checked
The response was the three temperatures (Precat, Postcat, and Diff temp) as desired. Modbus Poll sent a “0” as the data address since the PLC Addresses was checked. If the program did not have this option, the same result could be obtained by using the address “0” to refer to address 1.
=== Table types ===
The convention for table types generally used in ETS is the following:
==== (1-9999) Discrete Output Coils ====
Discrete output coils are for settings that can be represented as binary (0/1 or off/on). For example, valve auto or manual mode.
==== (10001-19999) Discrete Input Contacts ====
Discrete input contacts are for board inputs that can be represented as binary (0/1 or off/on). For example, the state of the oil pressure switch.
==== (30001-39999) Analog Input Registers ====
Analog input registers are for almost all other values that are not binary. E.g. temperatures, pressures, etc.
==== (40001-49999) Analog Output Holding Registers ====
Analog output holding registers are for settings that can be read and written over Modbus. For example, annunciator alarm limits fall into this category.
=== Custom Modbus Map ===
The EIM has the capability to re-map the register numbers to a custom map. This custom map is stored in a csv file, and can be used to create a block of registers with data from various modules. This allows a single read to the EIM Slave ID to pick up all the desired data across multiple modules. This file can be downloaded / uploaded by going to the EIM Modbus screen and choosing “Custom Map…”. More detail can be found on this article: <nowiki>http://forum.emittechnologies.com/knowledgebase/articles/1156870-eim-custom-modbus-map</nowiki>
=== Modbus Table ===
The modbus table(s) can be downloaded here: <nowiki>https://drive.google.com/open?id=0BzOiNHLPWdg1UGQzLUktcTZfTVU</nowiki>
Note that the Dynamic Control Touchscreen (12" model) has a different modbus table, available here: <nowiki>https://drive.google.com/open?id=1uZHGhsb_jMc-kCS1jnT7NDkBjcN0WOxf</nowiki>
=== Modbus TCP/IP ===
For versions 1.89 and later, Modbus TCP/IP is supported if the EIM and kernel have ethernet enabled. The register maps and slave IDs are the same whether using Modbus serial or Modbus TCP/IP. Both connections (TCP/IP and serial) can be used at the same time. Additionally, multiple simultaneous Modbus TCP/IP connections are supported.
=== Annunciator Modbus ===
The annunciator modbus table is a section in the document linked in the above section "Modbus Table". The annunciator modbus table refers to sensors by the annunciator input name instead of the sensor name, since the actual sensor name is configurable.
Note: If desired, EMIT can generate a table automatically with sensor names added if the annunciator config file is available.
==== Example ====
If SUCTION sensor is attached to AI-1 (analog input 1), In the annunciator modbus table, register 35150 is "Analog In 1 Reading". Since suction is attached to this input, reading 35150 will get the suction pressure. Note that the "Annunciator ID" has to be used during the read, as mentioned in "Slave IDs" above.
The returned value for analog inputs will be scaled to the user value. If one input is 0-250 PSI and another is 0-1000 PSI, the actual range doesn't need to be known because the modbus response will always be in PSI.
==== Annunciator Shutdowns ====
On shutdown, the shutdown code can be read using a variety of registers. There are several options, which are just arranged different ways. The tables decoding these registers can be found here:
Annunciator Reg 35015 and 35017: https://drive.google.com/open?id=1GyCeOG0lYrgj97tP3rrb8Hv76WeVYChp
Annunciator Register 35016: https://drive.google.com/open?id=1de1KlMhbg3ZsiZHVexJuSIFBHFOrKVJ_
Note that in the "Unified Data Table", Register 32042 pulls the same value as Annunciator Register 35015 above.
==== CAT Shutdowns ====
If the CAT ECM triggers the shutdown, the annunciator shutdown code mentioned above will simply be the "CAT Run Status" digital in contact. In this case, the CAT shutdown code can be read from EDT register 30125, which is also on the unified data table at register 32020. This value can be decoded from this list: https://drive.google.com/open?id=1zGHh2RmHCGNMZBgyr9QDblb_LLB5ipP3
== Custom Modbus Map ==
=== Background ===
The EIM contains the sole modbus (RS-485) connection for the entire system. However, each module's data is requested with a unique ID. Additionally, each module has a large number of registers, and for a given application only a small number are actually needed.
The EIM contains the feature where a custom modbus map can be uploaded which contains a list of target registers that are reassigned a new register number, and are moved to the EIM's modbus ID. This allows for a single request to pull the exact group of data that is needed.
=== Downloading the old Modbus Map File ===
On the EIM, navigate to "System Settings/Utilities" followed by "MODBUS".
<nowiki>*</nowiki>Insert Image*
On this page, select the button "Choose..." after "Custom map".
Insert a USB drive into the back of the EIM. Click the button "Download Current Map". Wait 10-20 seconds or until after the status says "Complete". A file customModbusMap.csv should now appear on the USB drive.
=== Editing the Modbus Map File ===
The Modbus map file, now on the USB, can be opened in Excel for editing. This file starts with one example row.
<nowiki>*</nowiki>Insert Image*
Start filling in the sheet with the registers that are needed. For each row, the columns will contain:
* Column A, "New Target Register": This column contains the new register that will be used by the external SCADA system to fetch this data value. In general, this column will start at 30001 and each subsequent row will be the next value.
* Column B, "Source Module": Put the source module number in this column, using the key in the first row.
* Column C, "Source Register": Put the source register for the data required
* Column D, "Comment": This column is ignored by the software. Any text can go here
An example table filled in might look like this:
==== Example ====
<nowiki>*</nowiki>Insert Image*
In the above example, a SCADA request to the EIM ID for register 30001, qty10, would return the above 10 registers in a row.
=== Uploading the new map ===
Once the above step is complete, save the file (keeping the format as csv). Put the USB drive back in the EIM and return to the custom modbus map screen. Now, click "Upload New Map From USB". After the upload is complete, restart the EIM and test out the new map.
== Datalogging ==
All of the sensors on a given module are logged at all times at 1 minute intervals. These logs can be viewed from the Datalog View page (Pg. 75) and downloaded or deleted from the Datalog Files page (Pg. 75). The files automatically roll over, and store around 1 month of data.
Note: for long-term compliance logs, which are stored and downloaded elsewhere, see the article "EMD Compliance Log".
=== DATALOG VIEWING ===
The Datalog View page (Pg. 75) can be used to look at the logged sensors of different modules. This page is accessed from the EIM Home page by clicking on “Data Logging”.
<nowiki>*</nowiki>Insert Image*
''Datalog View Page''
The datalog viewing page can show up to two datalog items at once. To pick a sensor to graph, click on one of the two “Item” buttons. On the Sensor Selection page (Pg. 76) choose a module from the dropdown list then a sensor to graph.
The graph can be expanded/retracted in time using the buttons below the graph. The graph can show from 1 hour of data up to one month. This can be used to recent operation and general trends over time.
Selecting a spot on the graph will put a vertical cursor on the graph that will show the exact value of the one or two sensors displayed at the time of the cursor.
=== DATALOG FILE MANAGEMENT ===
The Datalog Files page (Pg. 9) can be used to download or delete data logs. To access this page, click “Datalog Settings / Download Datalogs“ from the Datalog View page, or from the system home screen click “System Settings / Utilities” then “Datalog Files”.
The sensor will be recorded to a file labeled  “Datalog_[EIM serial number]_[module].csv”.
==== DOWNLOADING THE LOGS ====
Datalogs are accessible via USB and are downloaded according to the following procedure:
Insert a USB flash drive into the port labeled, “USB A” on the reverse side of the EIM displayWhen the EIM recognizes a valid USB drive is ready, the button labeled, “Download All Logs”  will be enabledSelect the “Download all Logs” button to download the files to the USB flash drive
* The USB Status will first change the text to “Downloading” and then “Complete” when the file is downloaded successfully
* The download operation will copy currently logging files and any old zipped log files.
After the button reverts back to "Save to USB", the USB flash drive can be removed
The datalog files will remain on the EIM and continue to be logged to after downloading
===== DELETING LOGS =====
Selecting “Delete All Logs” will delete all logs on the system. This might be desireable when a unit is moved or restarted after a long period of downtime to start with fresh data.
== System Settings / Utilities Pages ==
The "System Settings / Utilities" Page, accessed from the EIM home screen, contains several back pages for system settings. A description of each is below, or a reference to another article if it exists.
<nowiki>*</nowiki>Insert Image*
=== About ===
The About screen (Pg. 4) displays the serial number, hardware version, and software version of the EIM and each module connected to the EIM.
==== Touchscreen Calibration ====
The touch screen can be re-calibrated if it is determined that button selection appears to be offset from what is displayed on the screen. To calibrate the touch screen:
* Enter Engineering security access mode
* Navigate to the About screen (Pg. 4)
* Select the “Calibrate Touch Screen” button to start the calibration application
* Very carefully, use quick motions to touch each crosshair as they appear on the screen
* After the calibration, the screen will return to the About screen (Pg. 4) and display a confirmation box that must be accepted
* If the confirmation box is not accepted, the touch screen will omit the new calibration data
For accuracy when selecting the crosshairs, it is recommended that you use a stylus, such as the blunt end of a pen, rather than using your finger.
Use caution not to double tap or select each crosshair as it will result in a bad calibration. The best method to not double tap is to select the crosshair in one quick motion.
=== Go To Page ===
The "Go To Page" screen can be used to navigate to a page by the page number
=== Software Update ===
The "Software Update" page is used to update the software on the EIM. To use, insert a USB drive with the software update into the EIM, and click "Start Update".
=== Clean Screen ===
The "Clean Screen" page shows a blank screen so that the touch screen can be cleaned with a cloth without pressing any buttons.
=== Main Help ===
The main help button goes to the help module of the EIM. This is the same as the "Help" button on the EIM home screen.
=== MODBUS ===
The "Modbus" page is for setting up the Modbus connection. It is discussed more in-depth in the article "ETS Modbus RTU"
=== Config Files ===
The "Config Files" page can be used to save or load settings from one EIM to another. To use, insert a USB drive and click "Write" for a module or all modules. Then take the USB drive to another unit and use the same screen "Read" button to read the settings and use them on the new unit. This can speed up setup times.
=== Reset ===
In Engineering security mode, the system can be reset to the factory default values within the Reset screen (Pg. 5) of the EIM. Press the “Reset AFRC, EMD, EIM” button to reset those modules to factory defaults. Press the “Reset ICM” button to reset the Ignition to factory defaults. After reset the Ignition will be in “Configuration Required” state until ignition setup is completed.
=== Datalog Files ===
This page can be used to download or delete the datalog files. For more information, see the article "EIM Datalogging".
=== Home Background ===
This page can be used to add a background watermark to the EIM home page.
=== Troubleshooting File ===
The EIM can accept a custom troubleshooting file for showing troubleshooting trees for certain shutdown conditions. This file will usually be supplied by EMIT and uploaded on this page.
=== Change Setup Password ===
This page is used to change the setup password.
== Software Update ==
Video available for this topic: https://www.youtube.com/watch?v=o9Mf76GIxBA
* Using a Windows-based computer, transfer the EMIT-provided EIM software update file to a FAT-formatted USB thumb drive
* The file name should be “EIM_update.tar”
* Plug the USB thumb drive into the USB A port on the opposite side of the EIM
* Within the EIM’s user interface, enter the appropriate password to for either Setup or Engineering security access
* From the System Menu screen (Pg. 0), navigate to the Software Update screen (Pg. 3) by selecting "System Settings / Utilities" then “Software Update”
* If the USB drive is plugged in and detected, the screen will be displayed as shown below
* Select the “Start Update“ button to begin the update
* The update will take 20-30 seconds and then will restart the EIM, when complete
* After the update, the EIM will restart
* Remove the USB drive when completed
<nowiki>*</nowiki>Insert Image*
Note: If after the update the EIM application closes but doesn't restart within 30 seconds, it is because the application handler was updated. Turn power on the EIM off and on to finish the update in this case.
== Notes Page ==
Notes allows manual text documentation for periodic maintenance, emissions testing, catalyst maintenance, part replacement, status records, or any other event.
Reach the notes page by selecting "Notes" from the EIM Home Screen.
To enter a note, press the “Add” button and type in the note using the on screen keyboard. This function is available in all access levels. After the note is added, the first several words of the note can be viewed directly on the screen. The full note can be viewed by selecting the associated “View” button.
To download the notes, plug in a USB drive into the “USB A” port on the EIM. In ''Setup'' or ''Engineering'' access, a button labelled “Download all to USB” will appear in the lower right corner of the display. Select the button to download. After the button displays “Complete”, the USB drive can be safely removed.
Notes can be removed or deleted while in ''Engineering'' access mode.
<nowiki>*</nowiki>Insert Image*
== Open Source Software Notice ==
The software included in this product contains proprietary and confidential copyrighted software developed and owned by EMIT Technologies, Inc. which is distributed subject to the Software License Agreement located in "APPENDIX H. SOFTWARE LICENSE AGREEMENT" of the user manual.
This product, and any connected EMIT modules, also include copyrighted open source software that is licensed under the GPL, including FreeRTOS v7.0.1, copies of which are located in "APPENDIX I. GNU GENERAL PUBLIC LICENSE" of the user manual, and available here. You may obtain copies of each open source license, the copyright notice, and the complete source code for any open source software program utilized in this product for a period of three years after the last shipment of this product by sending a money order or check for $10.00 to the following address:
EMIT Technologies, Inc.
GPL Compliance Division
PO Box 6785
Sheridan, WY 82801
Please include a note asking for the “source for ETS” which identifies your shipping address and preferred method of shipment. EMIT Technologies will ship a CD containing the open source license, the copyright notice, and the complete source code for any open source software program utilized in the product.
This offer is available to anyone in receipt of this information.
== SD Or Boot Issues ==
For addressing and preventing EIM Boot issues, see this document:
https://drive.google.com/open?id=0BzOiNHLPWdg1WktkRnNsWmNQdGM
== Ethernet ==
=== Overview ===
Some EIMs have an ethernet port on the back that can be connected to a customer network. The following serial number ranges have an ethernet port:
* 1000 - 1899
* 3203 and newer
The following functions are currently supported by the ethernet port:
* Modbus TCP (EIM Versions 1.89 and later)
Other functions, such as file transfers and remote web access, may be supported in the future.
This page covers the setup of the ethernet port.
=== Ethernet Setup Page ===
If the EIM has an ethernet port, and if the kernel version has been updated to support ethernet, a page will be available to setup the IP Address. This page will be found from the System Menu at "System Settings" -> "Ethernet Port". The button will only show up if the kernel and software support ethernet.
This page appears as follows:
<nowiki>*</nowiki>Insert Image*
There are two IP address setup options:
* DHCP: This option will cause the port to request an automatic address. The current address can be seen under "Port Status"
* Manual: This option causes buttons to pop up allowing manual entry of the IP Address, Gateway, and Subnet Mask. If an address is entered in this way, the address must be properly covered by the gateway for "Submit" to accept the settings.
Separately, there is a setting for the Modbus/TCP port. If a different port is needed than the default port, it can be entered here.
After choosing the settings, select "Submit". If the page validates, the network port should update. Sometimes a power cycle may be required.
== Security Key ==
=== Background ===
For EIM versions 1.98 and above, a special USB security key can be optionally used to lock out the "Engineering" password level of the EIM. The also DCT has very similar functionality with the same key.
The key part number is 20221-0001 -- USB SECURITY KEY F/ ETS, and can be ordered from EMIT.
The functionality is as follows:
Security Key Not Enabled
''-''EIM Security operates normally with passwords
''Security Key Enabled''
-With the security key not inserted, the user can only use 'Operator' or 'Setup' (with setup password) levels of the EIM
-With the security key inserted, the user can get to all three password levels
The security key itself can be used as a normal usb flash drive for storing files if desired- it can even be re-formatted. The security information is in un-partitioned space.
=== Enabling the Security Key Mode ===
A special USB security key (or keys) are obtained from EMIT. The key is the same for all EIMs. After inserting the key, the following dialog will automatically popup about 10 seconds later.
<nowiki>*</nowiki>Insert Image*
If "Change EIM to 'Key Required'" is selected, the EIM will change to 'Key Required' mode. Once in this mode, the key will be required to enter Engineering.
If the EIM is configured to 'Key Required' mode, the dialog will look like this when the key is inserted.
<nowiki>*</nowiki>Insert Image*
If 'Close Window' is selected, the access level can still be changed between operator, setup, and engineering if the different passwords are entered, as long as the key is in. As soon as the key is removed, the access level will return to operator, and 'engineering' level will be inaccessible. As seen in the above dialog, the 'Key Required' mode can also be turned back off with the key in.
If they EIM is in the 'Key Required' mode and the key is not inserted, the following error appears if the 'Engineering' password is entered.
<nowiki>*</nowiki>Insert Image*
== Shutdown Logs ==
Beginning with EIM version 1.94, the EIM will save a log of sensor data for the previous 10 shutdowns, whether the shutdown was a fault or not. As new shutdowns occur, the oldest logs will be deleted so that there are never more than 10 logs.
These logs can be viewed, graphed, and downloaded (to view in Excel (R) ) just the same as the normal alarm logs are. However, there are two benefits of these logs over normal alarm logs:
* Sometimes a unit will be reset (and the alarm log cleared/deleted) before the shutdown is more thoroughly investigated. Since the last 10 shutdowns are saved, they can be still later viewed even after the alarm is cleared.
* Sometimes a unit will have a normal stop, in which case there is no alarm or alarm log, but a user may still want the shutdown data
The shutdown logs are found by selecting "Recent Shutdown Logs" on the EIM Alarms page.
<nowiki>*</nowiki>Insert Image*
''EIM Alarms page- Button in lower-right shown to access recent shutdown logs''
After selecting the button, a list of the last 10 shutdowns is shown.
<nowiki>*</nowiki>Insert Image*
''Previous 10 shutdowns''
Selecting one of the shutdowns from this list will bring up the shutdown event.
<nowiki>*</nowiki>Insert Image*
''Individual shutdown event''
Similar to normal alarm logs, a USB drive can be inserted on this screen to download the one minute datalog of the sensors before this shutdown. Selecting the graph allows for graphing of other sensors during the logged period.
== Modbus Temporary Disable ==
Starting with EIM software version 2.00, the modbus can be temporary disabled during a PM to prevent inaccurate callouts during the maintenance. The system will automatically re-enable itself after a time period in case the user does not remember that modbus has been disabled.
=== Using Modbus Temporary Disable ===
To use, go to the MODBUS screen under "System Settings". If in "Engineering" password level, the disable button will be shown on the right.
<nowiki>*</nowiki>Insert Image*
After clicking 'Disable...' a confirmation dialog will come up. If 'Yes' is selected to disable, the number of hours will be asked.
<nowiki>*</nowiki>Insert Image*
The system will not respond to any modbus requests (either over serial 485 or TCP/Ethernet) until the timer expires, or the user manually re-enables the port, whichever comes first.
<nowiki>*</nowiki>Insert Image*
If the port is disabled, and the 'Disabled' button is selected, a dialog will ask the user if Modbus should be re-enabled immediately. Otherwise the timer will run out normally and re-enable automatically. The enable time is saved to disk, so the system can be power cycled multiple times and it will not affect the enabling.
Note: If the clock is changed during the disable period, it may clear the disable timer.

Revision as of 21:11, 20 July 2022

Overview

Video available for this topic: https://www.youtube.com/watch?v=GLwC7T6rGMQ

The EMIT Interface Module (EIM) provides an 8” touchscreen display and communication hub for any one module, or multiple modules, connected to the Controller Area Network (CAN) of the EIM. Modules connected to the EIM will automatically populate as buttons on the System Menu screen (Pg. 0) of the display. Selecting any of the module buttons allows for direct interaction with the respective module.

Other functions not directly related to module interaction include the system run signal trigger, security passwords and access, timer management, alarms, date and time, sensor data logging, and MODBUS communications.

The enclosure of the EIM was designed to be installed either externally using the faceplate and the base or within a panel using only the faceplate. If mounting externally, the EIM can accommodate the mounting of any one module within the base of the enclosure.

User Interface

*Need to display visual*

Display Contents And Operation

Header

  • “Home” button – Navigates to home screen of currently viewed module
  • “Eng” label – Indicates if valid run signal from the engine is present (“Eng: Run”) or not present (“Eng: Off”)
  • Current module label – Displays the module associated with the currently viewed screen
  • “Pg.” label – Displays page number associated with currently viewed screen
  • “Back” button – Navigates to the previous screen

Footer

  • “System Menu” button – Navigates to System Menu screen (Pg. 0)
  • “Access:” button – Displays current security access level and navigates to Security Access screen (Pg. 1) to change security level
  • “Timers” button – Navigates to Timer Management screen (Pg. 20) and flashes when any timer(s) require attention
  • “Alarms” button – Navigates to Alarms screen (Pg. 40) and flashes when there is an active alarm
  • Date/Time button – Navigates to the Date/Time screen (Pg. 2) to modify the date and time

Display Active Area

Displays content for the specific screen being viewed

Security Access

The active security access is displayed in the “Access:” button in the footer of the display. To change the security access mode, select the “Access:” button and input the password of the desired security using the keypad. Available security levels include:

Operator – Limited access to system features. No adjustments can be made.

Setup – Access to most system features and settings.

Engineering – Access to all system features including advanced adjustments.

Passwords are laser marked on the USB covers included with each system, or on a paper card. Please contact EMIT Technologies if you have lost or forgotten the passwords.

Changing Setup Password

To change the Setup password from the factory default (serial number + 10), do the following:

While in the Engineering security access mode, go to "System Settings / Utilities", and select "Change Setup Password".

Enter in the desired Setup password

Press the “Submit” button

Timers

The EIM is capable of running eight (8) general purpose timers and three (3) EMD compliance timers simultaneously. Timers can be viewed, updated, or created from the Timer Management screen (Pg. 20) of the EIM. The screen can be accessed by selecting the “Timers” button in the footer of the display. A security level of Setup or Engineering is required to update or create timers.

CREATING A TIMER

To create a timer, select the any of the available “Add” buttons on the right side of the Timer Management screen (Pg. 20) while in Setup or Engineering security mode. The button will navigate to the Timer Add/Edit screen (Pg. 21).

  • “Timer” Button – Defines the name of the timer.
  • “Count Time” Button – Defines the length of the timer in weeks, days, or hours. Count times are always converted to hours after entry.
  • Only used for count down timers
  • Description “Edit” Button – Add or edits a description of the timer.
  • “Count Type” Buttons – Selects the countdown type
  • “Real Time” counts down the timer regardless of the engine running status.
  • “Engine Runtime” only counts down the timer when the engine is running.
  • "Count up/Down" Buttons - Selects if the timer counts up (hourmeter), or counts down and expires
  • “Annual” Buttons – Enable an “or annual” condition to the timer so that it will also expire after one year, regardless of the timer count remaining.

After choosing the desired options, select the “Submit” button to confirm and start the timer.

*Insert Image*

VIEWING TIMERS

A list of the general purpose and automatically-generated timers can be quickly viewed on the Timer Management screen (Pg. 20). The columns within the screen include:

  • “Timer” – Name of the timer.
  • “Remaining” – Time remaining in hours and minutes.
  • “Status” – Displays the current status of the timer.
  • “Running” – The timer is currently counting down.
  • “Engine Off” – The count type of the timer is “Run Hours”, the engine is off, and the timer is not counting down.
  • “Past Due” – The timer has expired and is no longer operational.
  • “Annual” – Displays date and time of the annual expiration of the timer. If no annual option was enabled, “(Not Used)” will be displayed.

Select the “View” button to view additional details or edit the timer.

If an EMD is present and Management Practices are available, the Timer screen (Pg. 20) will display two separate sets of timers: “Compliance Timers” and “General Timers”.

VIEWING SINGLE TIMER

To view existing timers, navigate to the Timer View screen (Pg.23) by selecting the “View” button of the timer to be modified from the Timer Management screen (Pg. 20). The following timer options are available:

  • “Delete” – Deletes timer.
  • “Edit” – Navigates to Timer Add/Edit screen (Pg. 23) to change the timer configuration.
  • “Restart” – Restarts the timer

Alarms Overview

The EIM and associated modules are capable of identifying a wide range possible alarm conditions. Depending on the module there are a set of custom and fixed alarms in the system to generate an alarm event for the error condition. See the “ALARMS” section of any of the modules for details on how to configure an alarm. As discussed in the module alarm sections, most alarms can be set up to close the error relay and shutdown the engine on critical alarms (other than annunciator, which shuts down the engine directly).

Active alarms will cause the “Alarms” button in footer of the display to show the number of current alarms and flash the text. Selecting this button will navigate to the Alarms screen (Pg. 40) that displays the current alarms with their associated date/time stamp, alarm code, description, and action taken.

*Insert Image*

Selecting the “View” button of the associated active alarm navigates to the View Alarm screen (Pg. 41). This screen displays the alarm in additional detail and provides the option to clear the alarm by pressing the “Reset Alarm” button or examine the configuration of the alarm by selecting the “Go To Setup” button. This screen also has a “Sensor Snapshot” button to see a snapshot of the sensors for the given module at the time the alarm occurred.

If an alarm covers a single sensor value high or low trigger, selecting "View" will go to a graph showing the value of that sensor for the minute before the alarm.

Note: Most alarms are only active if the run signal is in the “Run” condition and the alarm timer on the home page has expired. If the Run Signal Trigger is not properly configured an alarm condition could be missed.

ALARM HISTORY

The alarms screen has a button “Alarm History” which brings up the Alarm History screen (Pg. 42) a list of all past alarms that have been acknowledged (cleared). The “< Prev” and “Next >” buttons at the bottom of the screen can be used to scroll through the list of past alarms. Clicking on “View” on an alarm will show the details for the given past alarm.

SENSOR SNAPSHOT

For active alarms, a sensor log is saved for 60 seconds of data during the time leading up to the alarm. This log can be downloaded by inserting a USB drive and selecting 'Download'.

For past alarms, a button is present to view the sensor snapshot at the time of the alarm (shown below). This list shows only the sensors at the time of the alarm (not the full 60 seconds).

*Insert Image*

If an alarm pulls up the alarm graph display instead, the sensor snapshot can still be downloaded by inserting a USB drive.

Note that the Alarm History page will show all past alarms that occurred on the EIM. The Alarm Snapshot data will only be saved on EIM versions 1.58 or newer, so some past alarms may not have sensor snapshot information. The one minute of snapshot data will only be available for active alarms. Once an alarm is reset, the history page will only show the snapshot for the moment the alarm occurred.

Engine Information Page

The Engine Info screen (Pg. 7) configures and displays engine specific data. The information is available for view in Operator security mode. To edit or modify any of the data, Setup or Engineering security mode is required. Engineering mode is required to modify the engine configuration.

  • Engine Status – Displays the engine run signal status as either ‘Running’ or ‘Run Signal Not Detected’ based on the run signal auto-detect
  • Engine Hours – Displays the current cumulative hours of the engine
  • This value can be modified to match an existing engine hour meter in Engineering security access mode
  • Engine Uptime – Displays the current uptime of the engine based on the run signal.
  • Engine Make – Selects the engine manufacturer from a drop-down list
  • Engine Model – Displays engine model
  • Press button to add or edit model
  • Engine Serial Number – Displays engine serial number
  • Press button to add or edit engine serial number
  • Engine Arrangement Number – Displays Caterpillar arrangement number
  • Press button to add or edit arrangement number
  • Combustion – Adjusts rich burn or lean burn setting for AFRC
  • Banks – Adjusts number of banks for the AFRC Advanced
  • AFRC Lite is fixed to single bank configuration
  • O2 Sensor Type – Adjusts the AFRC configuration between wideband O2 sensors (6-wire) or narrowband O2 sensors (4-wire)
  • Lean burn configuration must use a wideband O2 sensor (6-wire)
  • Control Type – Adjusts control method for AFRC Advanced between Setpoint mode and AutoControl mode (no adjustable setpoint)
  • AFRC Lite is fixed to Setpoint mode

*Insert Image*

Modbus RTU

Introduction

This document describes an overview of Modbus and how it is used in the ETS system. Modbus (RTU) can be used to read a variety of data from the ETS system to some sort of Modbus master device, to be used remotely or on-site. A proper understanding of how the items are addressed and scaled in ETS will help ensure your system setup works correctly.

Brief Modbus Overview

Modbus is a serial communication protocol that is designed for reading and writing individual data items from a set of devices on the serial network. The device sending the commands is called the Modbus Master, and each other device on the network is called a Modbus Slave. Each slave will have a unique address, called the “Slave Address”, “Station Address”, or “Slave ID”. This address can run from 1 – 247.

Each slave ID will have a set of “Modbus Registers” that link to certain data items. The registers are broken into four sets, each numbered in a different range:

  • (1-9999) Discrete Output Coils
  • (10001-19999) Discrete Input Contacts
  • (30001-39999) Analog Input Registers
  • (40001-49999) Analog Output Holding Registers

While the register numbers, as referenced in documentation, will be numbered as they are above, it is important to note that in an actual Modbus command the data address (not to be confused with station address above) is always numbered 0-9999, and the register set that is actually read is based on the function code.

A command will contain a specific “Function code”, which indicates whether it is a read or write, whether it covers one or multiple registers, and which of the four register sets is used. There are 8 function codes in standard Modbus.

A Modbus Master command will contain:

  1. The slave ID for which the command is intended
  2. The function code
  3. The data address of the register
  4. The number of registers requested (for some function codes)
  5. The “CRC”, which is an error-checking number

As an example, we might want to read register 40002. The Modbus will send a command to the slave ID in question with function 4 (read input registers) from data address 1. Since the function code links to analog input registers, then the slave will know that the data address “1” is referring to register 40002, because analog input registers are register set 40001-49999, and address 1 is the second register (the first being address 0).

MODBUS in ETS

Wiring / Port Setup

The primary modbus port is the RS-485 connection on the back of the EIM (screen). This port is configured on the Modbus setup page, shown below. Select the correct option in the 'communications' dropdown to match the SCADA system. The most common two port settings used in the field are "9600,N,8,1" or "19200,E,8,1". Wire the SCADA RS-485 A/B connection to the EIM RS-485 A/B connection. If the EIM is in an EMIT panel, this connection may have already be ran to empty terminal blocks for convenience, and the SCADA RS-485 connection can be wired there instead (check the panel schematic).

Some panels will have an EDT present, which also has a duplicate slave 485 port in case there are two SCADA systems. This port is set up separately: under the "EDT Setup" -> "Slave modbus port settings".

Separately, the ethernet port can be used with Modbus/TCP, and it set up on the 'ethernet' setup page under 'system settings'.

Any or all of the three connection options above can be used, but in all cases the register numbers and IDs being read (discussed below) are the same.

*Insert Image*

Slave IDs

In ETS, each module in the system will have its own slave ID. However, all Modbus responses will come from the EIM only, which has the Modbus connection. The slave ID can be changed on the EIM on the Modbus screen.

For example, the EIM might have an ID of 10 and the AFRC Lite might be connected and have an ID of 11. If a Modbus master command arrives addressed to either ID 10 or 11, the EIM will respond. For any other address, the EIM will not respond.

*Insert Image*

Modbus Screen showing slave ID setups

If a Modbus request arrives matching a module ID, but that module is not actually attached currently, the EIM will not respond.

Register Scaling

Each module in ETS has its own Modbus table showing the data at different registers. An example section of the AFRC Lite Modbus table is shown below.

*Insert Image*

For many registers, the value is scaled to go from a decimal number to an integer. To decode from a Modbus register value to the real value, use the equation below

[real value] = [register value]*[Resolution/Bit] + [Offset]

The last two items in the above equation are in the Modbus tables. As an example, perhaps the register 30001 (Pre-Cat Exhaust Temp) was read and the value was 37,077. Using the values from the above table:

[real value] = 37077*0.03125 + (-273) = 885.6 degrees

Register Addressing

Note also in the table above that there is a separate column for “Register” and “Address”. The difference between the two has been previously discussed, and both are listed for convenience. Different Modbus and SCADA systems use various methods for specifying the register that is read. The register itself might be entered in a high-level program, and it will determine the data address on its own by using the last 4 digits. Alternately, a program might need the data address specified directly. The ETS uses “PLC Addressing” which is base 0 addressing. If this is not an option in a Modbus Master program, the address that is requested might have to be decremented by 1.

Example

In the program “Modbus Poll”, the following setup was used for Read/Write definition:

  • Slave ID: 20 (which was the AFRC Lite configured slave ID)
  • Function 04 Read Input registers (This uses the table above, registers 30001-39999)
  • Address: 1
  • Quantity: 3 (Address 1 and quantity 3 should read registers 30001-30003)
  • PLC Addresses (Base 1) checked

The response was the three temperatures (Precat, Postcat, and Diff temp) as desired. Modbus Poll sent a “0” as the data address since the PLC Addresses was checked. If the program did not have this option, the same result could be obtained by using the address “0” to refer to address 1.

Table types

The convention for table types generally used in ETS is the following:

(1-9999) Discrete Output Coils

Discrete output coils are for settings that can be represented as binary (0/1 or off/on). For example, valve auto or manual mode.

(10001-19999) Discrete Input Contacts

Discrete input contacts are for board inputs that can be represented as binary (0/1 or off/on). For example, the state of the oil pressure switch.

(30001-39999) Analog Input Registers

Analog input registers are for almost all other values that are not binary. E.g. temperatures, pressures, etc.

(40001-49999) Analog Output Holding Registers

Analog output holding registers are for settings that can be read and written over Modbus. For example, annunciator alarm limits fall into this category.

Custom Modbus Map

The EIM has the capability to re-map the register numbers to a custom map. This custom map is stored in a csv file, and can be used to create a block of registers with data from various modules. This allows a single read to the EIM Slave ID to pick up all the desired data across multiple modules. This file can be downloaded / uploaded by going to the EIM Modbus screen and choosing “Custom Map…”. More detail can be found on this article: http://forum.emittechnologies.com/knowledgebase/articles/1156870-eim-custom-modbus-map

Modbus Table

The modbus table(s) can be downloaded here: https://drive.google.com/open?id=0BzOiNHLPWdg1UGQzLUktcTZfTVU

Note that the Dynamic Control Touchscreen (12" model) has a different modbus table, available here: https://drive.google.com/open?id=1uZHGhsb_jMc-kCS1jnT7NDkBjcN0WOxf

Modbus TCP/IP

For versions 1.89 and later, Modbus TCP/IP is supported if the EIM and kernel have ethernet enabled. The register maps and slave IDs are the same whether using Modbus serial or Modbus TCP/IP. Both connections (TCP/IP and serial) can be used at the same time. Additionally, multiple simultaneous Modbus TCP/IP connections are supported.

Annunciator Modbus

The annunciator modbus table is a section in the document linked in the above section "Modbus Table". The annunciator modbus table refers to sensors by the annunciator input name instead of the sensor name, since the actual sensor name is configurable.

Note: If desired, EMIT can generate a table automatically with sensor names added if the annunciator config file is available.

Example

If SUCTION sensor is attached to AI-1 (analog input 1), In the annunciator modbus table, register 35150 is "Analog In 1 Reading". Since suction is attached to this input, reading 35150 will get the suction pressure. Note that the "Annunciator ID" has to be used during the read, as mentioned in "Slave IDs" above.

The returned value for analog inputs will be scaled to the user value. If one input is 0-250 PSI and another is 0-1000 PSI, the actual range doesn't need to be known because the modbus response will always be in PSI.

Annunciator Shutdowns

On shutdown, the shutdown code can be read using a variety of registers. There are several options, which are just arranged different ways. The tables decoding these registers can be found here:

Annunciator Reg 35015 and 35017: https://drive.google.com/open?id=1GyCeOG0lYrgj97tP3rrb8Hv76WeVYChp

Annunciator Register 35016: https://drive.google.com/open?id=1de1KlMhbg3ZsiZHVexJuSIFBHFOrKVJ_

Note that in the "Unified Data Table", Register 32042 pulls the same value as Annunciator Register 35015 above.

CAT Shutdowns

If the CAT ECM triggers the shutdown, the annunciator shutdown code mentioned above will simply be the "CAT Run Status" digital in contact. In this case, the CAT shutdown code can be read from EDT register 30125, which is also on the unified data table at register 32020. This value can be decoded from this list: https://drive.google.com/open?id=1zGHh2RmHCGNMZBgyr9QDblb_LLB5ipP3

Custom Modbus Map

Background

The EIM contains the sole modbus (RS-485) connection for the entire system. However, each module's data is requested with a unique ID. Additionally, each module has a large number of registers, and for a given application only a small number are actually needed.

The EIM contains the feature where a custom modbus map can be uploaded which contains a list of target registers that are reassigned a new register number, and are moved to the EIM's modbus ID. This allows for a single request to pull the exact group of data that is needed.

Downloading the old Modbus Map File

On the EIM, navigate to "System Settings/Utilities" followed by "MODBUS".

*Insert Image*

On this page, select the button "Choose..." after "Custom map".

Insert a USB drive into the back of the EIM. Click the button "Download Current Map". Wait 10-20 seconds or until after the status says "Complete". A file customModbusMap.csv should now appear on the USB drive.

Editing the Modbus Map File

The Modbus map file, now on the USB, can be opened in Excel for editing. This file starts with one example row.

*Insert Image* Start filling in the sheet with the registers that are needed. For each row, the columns will contain:

  • Column A, "New Target Register": This column contains the new register that will be used by the external SCADA system to fetch this data value. In general, this column will start at 30001 and each subsequent row will be the next value.
  • Column B, "Source Module": Put the source module number in this column, using the key in the first row.
  • Column C, "Source Register": Put the source register for the data required
  • Column D, "Comment": This column is ignored by the software. Any text can go here

An example table filled in might look like this:

Example

*Insert Image*

In the above example, a SCADA request to the EIM ID for register 30001, qty10, would return the above 10 registers in a row.

Uploading the new map

Once the above step is complete, save the file (keeping the format as csv). Put the USB drive back in the EIM and return to the custom modbus map screen. Now, click "Upload New Map From USB". After the upload is complete, restart the EIM and test out the new map.

Datalogging

All of the sensors on a given module are logged at all times at 1 minute intervals. These logs can be viewed from the Datalog View page (Pg. 75) and downloaded or deleted from the Datalog Files page (Pg. 75). The files automatically roll over, and store around 1 month of data.

Note: for long-term compliance logs, which are stored and downloaded elsewhere, see the article "EMD Compliance Log".

DATALOG VIEWING

The Datalog View page (Pg. 75) can be used to look at the logged sensors of different modules. This page is accessed from the EIM Home page by clicking on “Data Logging”.

*Insert Image*

Datalog View Page

The datalog viewing page can show up to two datalog items at once. To pick a sensor to graph, click on one of the two “Item” buttons. On the Sensor Selection page (Pg. 76) choose a module from the dropdown list then a sensor to graph.

The graph can be expanded/retracted in time using the buttons below the graph. The graph can show from 1 hour of data up to one month. This can be used to recent operation and general trends over time.

Selecting a spot on the graph will put a vertical cursor on the graph that will show the exact value of the one or two sensors displayed at the time of the cursor.

DATALOG FILE MANAGEMENT

The Datalog Files page (Pg. 9) can be used to download or delete data logs. To access this page, click “Datalog Settings / Download Datalogs“ from the Datalog View page, or from the system home screen click “System Settings / Utilities” then “Datalog Files”.

The sensor will be recorded to a file labeled  “Datalog_[EIM serial number]_[module].csv”.

DOWNLOADING THE LOGS

Datalogs are accessible via USB and are downloaded according to the following procedure:

Insert a USB flash drive into the port labeled, “USB A” on the reverse side of the EIM displayWhen the EIM recognizes a valid USB drive is ready, the button labeled, “Download All Logs”  will be enabledSelect the “Download all Logs” button to download the files to the USB flash drive

  • The USB Status will first change the text to “Downloading” and then “Complete” when the file is downloaded successfully
  • The download operation will copy currently logging files and any old zipped log files.

After the button reverts back to "Save to USB", the USB flash drive can be removed

The datalog files will remain on the EIM and continue to be logged to after downloading

DELETING LOGS

Selecting “Delete All Logs” will delete all logs on the system. This might be desireable when a unit is moved or restarted after a long period of downtime to start with fresh data.

System Settings / Utilities Pages

The "System Settings / Utilities" Page, accessed from the EIM home screen, contains several back pages for system settings. A description of each is below, or a reference to another article if it exists.

*Insert Image*

About

The About screen (Pg. 4) displays the serial number, hardware version, and software version of the EIM and each module connected to the EIM.

Touchscreen Calibration

The touch screen can be re-calibrated if it is determined that button selection appears to be offset from what is displayed on the screen. To calibrate the touch screen:

  • Enter Engineering security access mode
  • Navigate to the About screen (Pg. 4)
  • Select the “Calibrate Touch Screen” button to start the calibration application
  • Very carefully, use quick motions to touch each crosshair as they appear on the screen
  • After the calibration, the screen will return to the About screen (Pg. 4) and display a confirmation box that must be accepted
  • If the confirmation box is not accepted, the touch screen will omit the new calibration data

For accuracy when selecting the crosshairs, it is recommended that you use a stylus, such as the blunt end of a pen, rather than using your finger.

Use caution not to double tap or select each crosshair as it will result in a bad calibration. The best method to not double tap is to select the crosshair in one quick motion.

Go To Page

The "Go To Page" screen can be used to navigate to a page by the page number

Software Update

The "Software Update" page is used to update the software on the EIM. To use, insert a USB drive with the software update into the EIM, and click "Start Update".

Clean Screen

The "Clean Screen" page shows a blank screen so that the touch screen can be cleaned with a cloth without pressing any buttons.

Main Help

The main help button goes to the help module of the EIM. This is the same as the "Help" button on the EIM home screen.

MODBUS

The "Modbus" page is for setting up the Modbus connection. It is discussed more in-depth in the article "ETS Modbus RTU"

Config Files

The "Config Files" page can be used to save or load settings from one EIM to another. To use, insert a USB drive and click "Write" for a module or all modules. Then take the USB drive to another unit and use the same screen "Read" button to read the settings and use them on the new unit. This can speed up setup times.

Reset

In Engineering security mode, the system can be reset to the factory default values within the Reset screen (Pg. 5) of the EIM. Press the “Reset AFRC, EMD, EIM” button to reset those modules to factory defaults. Press the “Reset ICM” button to reset the Ignition to factory defaults. After reset the Ignition will be in “Configuration Required” state until ignition setup is completed.

Datalog Files

This page can be used to download or delete the datalog files. For more information, see the article "EIM Datalogging".

Home Background

This page can be used to add a background watermark to the EIM home page.

Troubleshooting File

The EIM can accept a custom troubleshooting file for showing troubleshooting trees for certain shutdown conditions. This file will usually be supplied by EMIT and uploaded on this page.

Change Setup Password

This page is used to change the setup password.

Software Update

Video available for this topic: https://www.youtube.com/watch?v=o9Mf76GIxBA

  • Using a Windows-based computer, transfer the EMIT-provided EIM software update file to a FAT-formatted USB thumb drive
  • The file name should be “EIM_update.tar”
  • Plug the USB thumb drive into the USB A port on the opposite side of the EIM
  • Within the EIM’s user interface, enter the appropriate password to for either Setup or Engineering security access
  • From the System Menu screen (Pg. 0), navigate to the Software Update screen (Pg. 3) by selecting "System Settings / Utilities" then “Software Update”
  • If the USB drive is plugged in and detected, the screen will be displayed as shown below
  • Select the “Start Update“ button to begin the update
  • The update will take 20-30 seconds and then will restart the EIM, when complete
  • After the update, the EIM will restart
  • Remove the USB drive when completed

*Insert Image*

Note: If after the update the EIM application closes but doesn't restart within 30 seconds, it is because the application handler was updated. Turn power on the EIM off and on to finish the update in this case.

Notes Page

Notes allows manual text documentation for periodic maintenance, emissions testing, catalyst maintenance, part replacement, status records, or any other event.

Reach the notes page by selecting "Notes" from the EIM Home Screen.

To enter a note, press the “Add” button and type in the note using the on screen keyboard. This function is available in all access levels. After the note is added, the first several words of the note can be viewed directly on the screen. The full note can be viewed by selecting the associated “View” button.

To download the notes, plug in a USB drive into the “USB A” port on the EIM. In Setup or Engineering access, a button labelled “Download all to USB” will appear in the lower right corner of the display. Select the button to download. After the button displays “Complete”, the USB drive can be safely removed.

Notes can be removed or deleted while in Engineering access mode.

*Insert Image*

Open Source Software Notice

The software included in this product contains proprietary and confidential copyrighted software developed and owned by EMIT Technologies, Inc. which is distributed subject to the Software License Agreement located in "APPENDIX H. SOFTWARE LICENSE AGREEMENT" of the user manual.

This product, and any connected EMIT modules, also include copyrighted open source software that is licensed under the GPL, including FreeRTOS v7.0.1, copies of which are located in "APPENDIX I. GNU GENERAL PUBLIC LICENSE" of the user manual, and available here. You may obtain copies of each open source license, the copyright notice, and the complete source code for any open source software program utilized in this product for a period of three years after the last shipment of this product by sending a money order or check for $10.00 to the following address:

EMIT Technologies, Inc.

GPL Compliance Division

PO Box 6785

Sheridan, WY 82801


Please include a note asking for the “source for ETS” which identifies your shipping address and preferred method of shipment. EMIT Technologies will ship a CD containing the open source license, the copyright notice, and the complete source code for any open source software program utilized in the product.

This offer is available to anyone in receipt of this information.

SD Or Boot Issues

For addressing and preventing EIM Boot issues, see this document:

https://drive.google.com/open?id=0BzOiNHLPWdg1WktkRnNsWmNQdGM

Ethernet

Overview

Some EIMs have an ethernet port on the back that can be connected to a customer network. The following serial number ranges have an ethernet port:

  • 1000 - 1899
  • 3203 and newer

The following functions are currently supported by the ethernet port:

  • Modbus TCP (EIM Versions 1.89 and later)

Other functions, such as file transfers and remote web access, may be supported in the future.

This page covers the setup of the ethernet port.

Ethernet Setup Page

If the EIM has an ethernet port, and if the kernel version has been updated to support ethernet, a page will be available to setup the IP Address. This page will be found from the System Menu at "System Settings" -> "Ethernet Port". The button will only show up if the kernel and software support ethernet.

This page appears as follows:

*Insert Image*

There are two IP address setup options:

  • DHCP: This option will cause the port to request an automatic address. The current address can be seen under "Port Status"
  • Manual: This option causes buttons to pop up allowing manual entry of the IP Address, Gateway, and Subnet Mask. If an address is entered in this way, the address must be properly covered by the gateway for "Submit" to accept the settings.

Separately, there is a setting for the Modbus/TCP port. If a different port is needed than the default port, it can be entered here.

After choosing the settings, select "Submit". If the page validates, the network port should update. Sometimes a power cycle may be required.

Security Key

Background

For EIM versions 1.98 and above, a special USB security key can be optionally used to lock out the "Engineering" password level of the EIM. The also DCT has very similar functionality with the same key.

The key part number is 20221-0001 -- USB SECURITY KEY F/ ETS, and can be ordered from EMIT.

The functionality is as follows:

Security Key Not Enabled

-EIM Security operates normally with passwords

Security Key Enabled

-With the security key not inserted, the user can only use 'Operator' or 'Setup' (with setup password) levels of the EIM

-With the security key inserted, the user can get to all three password levels

The security key itself can be used as a normal usb flash drive for storing files if desired- it can even be re-formatted. The security information is in un-partitioned space.

Enabling the Security Key Mode

A special USB security key (or keys) are obtained from EMIT. The key is the same for all EIMs. After inserting the key, the following dialog will automatically popup about 10 seconds later.

*Insert Image*

If "Change EIM to 'Key Required'" is selected, the EIM will change to 'Key Required' mode. Once in this mode, the key will be required to enter Engineering.

If the EIM is configured to 'Key Required' mode, the dialog will look like this when the key is inserted.

*Insert Image*

If 'Close Window' is selected, the access level can still be changed between operator, setup, and engineering if the different passwords are entered, as long as the key is in. As soon as the key is removed, the access level will return to operator, and 'engineering' level will be inaccessible. As seen in the above dialog, the 'Key Required' mode can also be turned back off with the key in.

If they EIM is in the 'Key Required' mode and the key is not inserted, the following error appears if the 'Engineering' password is entered.

*Insert Image*

Shutdown Logs

Beginning with EIM version 1.94, the EIM will save a log of sensor data for the previous 10 shutdowns, whether the shutdown was a fault or not. As new shutdowns occur, the oldest logs will be deleted so that there are never more than 10 logs.

These logs can be viewed, graphed, and downloaded (to view in Excel (R) ) just the same as the normal alarm logs are. However, there are two benefits of these logs over normal alarm logs:

  • Sometimes a unit will be reset (and the alarm log cleared/deleted) before the shutdown is more thoroughly investigated. Since the last 10 shutdowns are saved, they can be still later viewed even after the alarm is cleared.
  • Sometimes a unit will have a normal stop, in which case there is no alarm or alarm log, but a user may still want the shutdown data

The shutdown logs are found by selecting "Recent Shutdown Logs" on the EIM Alarms page.

*Insert Image*

EIM Alarms page- Button in lower-right shown to access recent shutdown logs

After selecting the button, a list of the last 10 shutdowns is shown.

*Insert Image*

Previous 10 shutdowns

Selecting one of the shutdowns from this list will bring up the shutdown event.

*Insert Image*

Individual shutdown event

Similar to normal alarm logs, a USB drive can be inserted on this screen to download the one minute datalog of the sensors before this shutdown. Selecting the graph allows for graphing of other sensors during the logged period.

Modbus Temporary Disable

Starting with EIM software version 2.00, the modbus can be temporary disabled during a PM to prevent inaccurate callouts during the maintenance. The system will automatically re-enable itself after a time period in case the user does not remember that modbus has been disabled.

Using Modbus Temporary Disable

To use, go to the MODBUS screen under "System Settings". If in "Engineering" password level, the disable button will be shown on the right.

*Insert Image*

After clicking 'Disable...' a confirmation dialog will come up. If 'Yes' is selected to disable, the number of hours will be asked.

*Insert Image*

The system will not respond to any modbus requests (either over serial 485 or TCP/Ethernet) until the timer expires, or the user manually re-enables the port, whichever comes first.

*Insert Image*

If the port is disabled, and the 'Disabled' button is selected, a dialog will ask the user if Modbus should be re-enabled immediately. Otherwise the timer will run out normally and re-enable automatically. The enable time is saved to disk, so the system can be power cycled multiple times and it will not affect the enabling.

Note: If the clock is changed during the disable period, it may clear the disable timer.