EIM Overview: Difference between revisions

From EMIT Controls
Line 81: Line 81:


Press the “Submit” button
Press the “Submit” button
== 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 ==
== Datalogging ==

Revision as of 16:30, 21 July 2022

EIM Documents and Guides

Timers

Alarms

Engine Information

Modbus RTU

Custom Modbus Map

Datalogging

System Settings / Utilities Pages

Software Update

Notes Page

Open Source Software Notice

SD Or Boot Issues

Ethernet

Security Key

Shutdown Logs

Modbus Temporary Disable

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

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.