Eigen Smart Module (esm)

Transcript

Eigen Smart Module (ESM) User Guide Version 1.7 May 2015 Eigen Smart Module - User Guide Copyright © 2014-2015 Eigen Innovations. All Rights Reserved. No part of this document can be reproduced, transferred, distributed or stored in any format without the prior written permission of Eigen. 2 Eigen Smart Module - User Guide Table of Contents 1.0 Introduction .......................................................................................................................................... 5 2.0 System Requirements and Specifications ............................................................................................. 6 3.0 Quick Setup ........................................................................................................................................... 7 3.1 Connection Guide ............................................................................................................................. 7 3.2 Network settings ............................................................................................................................... 8 4.0 Accessing the ESM Software ............................................................................................................... 11 5.0 Viewing the Video Stream................................................................................................................... 12 6.0 Working with Rules ............................................................................................................................. 14 6.1 Creating an Input ............................................................................................................................ 14 6.1.1 Region Type Inputs ................................................................................................................... 15 6.1.2 PLC Type Inputs ........................................................................................................................ 16 6.1.3 Pattern Type Inputs .................................................................................................................. 17 6.2 Creating a Condition ....................................................................................................................... 18 6.2.1 Conditions with a Region type input ........................................................................................ 18 6.2.2 Conditions with a PLC type input: ............................................................................................ 21 6.2.3 Conditions with a Pattern Type Input ...................................................................................... 23 6.3 Defining an Output.......................................................................................................................... 24 6.3.1 PLC Type Outputs ..................................................................................................................... 24 6.3.2 Video Type Outputs ................................................................................................................. 25 6.3.3 Email Type Outputs .................................................................................................................. 26 6.4 Defining a Rule ................................................................................................................................ 27 6.5 Viewing and editing existing Rules .................................................................................................. 30 6.6 Viewing the Rule Log ....................................................................................................................... 31 7.0 Recording Data.................................................................................................................................... 32 7.1 Manual recording ............................................................................................................................ 32 7.2 Rule based Recording ...................................................................................................................... 33 7.3 Rolling Recording ............................................................................................................................ 33 7.4 Managing Recordings ...................................................................................................................... 34 8.0 Configuration Options ......................................................................................................................... 35 8.1 Module Configuration ..................................................................................................................... 35 8.1.1 Camera Settings ....................................................................................................................... 35 3 Eigen Smart Module - User Guide 8.1.2 Health Alarm Settings .............................................................................................................. 36 8.1.3 SMTP Settings .......................................................................................................................... 37 8.2 Recording Configuration ................................................................................................................. 38 Appendix A – Officially Supported Thermal Cameras ............................................................................... 40 Appendix B – Troubleshooting .................................................................................................................. 41 Contact Us ................................................................................................................................................ 43 4 Eigen Smart Module - User Guide 1.0 Introduction The Eigen Smart Module (ESM) is a thermal vision system specifically designed for industrial environments. The software comes pre-installed on industrial grade, small form factor hardware. As a standalone solution, the ESM is capable of monitoring a stream of thermal data from a connected thermal camera and allows an operator to easily define specific events and conditions on which to take action. These actions can include logging results, recording video, or sending an alert signal to a connected Programmable Logic Controller (PLC) or email address. Through an easy to use interface operators can view a live thermal video stream and interact with it to monitor specific regions of interest for key indicators of anomalous or unexpected behavior in plant floor operations. Via the creation of “rules”, the ESM can continually monitor for these conditions 24/7 and perform the actions defined by the operator in real time. In highly connected environments, the ESM can also work in conjunction with other ESM’s, sensors, and data sources to sync data to Eigen’s centralized intelligence platform called Intellexon™. For more information on the Intellexon™ platform, please refer to the Intellexon™ user guide or speak to an Eigen representative. NOTE: The features and functions described in the following sections of this document represent system functionality available as of the time of writing of this manual. If you have a previous version of the system some of these features may not currently be available to you. You may however be eligible for a system upgrade. Contact an Eigen representative to discuss your options. 5 Eigen Smart Module - User Guide 2.0 System Requirements and Specifications Hardware The following additional hardware is required for installation of an ESM:      Available 12V power source Compatible GigE vision based thermal camera* Cat5e or Cat6 network cables Connected PC or peripherals such as a monitor, keyboard and mouse (required for ESM configuration only) Ethernet or RS-485 based I/O module or Modbus device (optional) NOTE: See appendix A for a list of officially supported thermal cameras Software The ESM hardware comes preloaded with Lubuntu 14.04 LTS OS (Linux) and the latest version of Eigen’s ESM software. Operating Environments The ESM hardware is designed to safely operate in environments with operating temperatures between 0 and 40 degrees Celsius. In extreme temperature, high moisture or high dust environments, please speak with an Eigen technical sales representative about optional enclosures to meet your needs. 6 Eigen Smart Module - User Guide 3.0 Quick Setup 3.1 Connection Guide Depending on the nature of your application, the hardware provided may not be exactly as shown below. The diagrams below represent the 2 most common form factors used by Eigen for industrial automation applications. 7 Eigen Smart Module - User Guide 3.2 Network settings The ESM hardware (both the 160 and 290 model) has 2 available Ethernet ports. The system comes preconfigured with LAN1 port configured for connection to the Internet or an internal network and LAN2 port configured for direct connection to a GigE Vision based camera. Alternate configurations are possible but require some modification of network settings within the OS. Details of the necessary settings are as follows: If you wish to directly connect another computer or a Modbus device to the ESM, you must first modify the network type of the LAN port you are connecting the device to (usually in place of the network plugged in to LAN1). To do this, click the Lubuntu start menu in the bottom left corner of the OS home screen, move your mouse over the “Preferences” option in the menu and select “Network Connections” from the sub menu. When the Network Connections Application launches, select the network port you wish to modify from the “Ethernet” list on the left hand side. Generally speaking, the LAN1 port corresponds to “Wired connection 1” in the list. Once the desired connection is selected, click the “Edit” button. This will bring up a new window where you can edit the network configuration of the selected network port. To establish a direct connection to a Modbus device (PLC) or I/O module: 1) Select the “IPv4 Settings” tab in the new window. 2) Click the dropdown box next to the “Method:” field and select Link-Local Only from the dropdown list 3) Select the “IPv6 Settings” tab 8 Eigen Smart Module - User Guide 4) Click the dropdown box next to the “Method:” field and select Link-Local Only from the dropdown list 5) Click the “Save…” button in the bottom right corner of the window. This will close the configuration window and return you to the Network Connections application 6) Exit out of the Network Connections application To establish a direct connection to another computer: (this is useful when the ESM is not connected to your local network and you don’t always have a monitor, mouse or keyboard directly connected to the ESM unit. You will however need to have these peripherals connected to make this network change!) 1) Select the “IPv4 Settings” tab in the new window. 2) Click the dropdown box next to the “Method:” field and select Shared to other computers from the dropdown list 3) Select the “IPv6 Settings” tab 4) Click the dropdown box next to the “Method:” field and select Automatic from the dropdown list 5) Click the “Save…” button in the bottom right corner of the window. This will close the configuration window and return you to the Network Connections application 6) Exit out of the Network Connections application 9 Eigen Smart Module - User Guide For help in setting up alternate configurations not listed above, please contact an Eigen representative who would be happy to assist you. 10 Eigen Smart Module - User Guide 4.0 Accessing the ESM Software The ESM software is a web based application and runs on a small webserver running on the ESM hardware. As such, the software interface is accessed through your web browser. NOTE: The ESM software has been designed to run best using either the Firefox web browser or the Google Chrome web browser. For best results, please use one of these browser when accessing the software. To access the ESM from another computer on the same network as the ESM module: 1) Open a browser on the computer and browse to the ESM server by typing the following in the address bar: http://:8000 where is the IP of the ESM module on your network (example: 192.168.0.101), then click Enter on your keyboard. If you don’t know the IP of your ESM module, check the network manager application (see section 3.2 above) on the module directly (requires a monitor and mouse), or contact your IT department for assistance. 2) The ESM login screen should display. Enter your ESM email and password and click “Login”. To access the ESM from another computer directly connected to the ESM module (see direct connection network setup above): 1) Open a browser on the computer and browse to the ESM server by typing the following in the address bar: http://10.42.0.1:8000, then click Enter on your Keyboard. 2) The ESM login screen should display. Enter your ESM email and password and click “Login”. If you have not been provided with your own unique user account credentials, the factory default user account pre-configured on the ESM module is as follows: Email: [email protected] Password: password NOTE: For security purposes, this account should be changed after logging in. This can be done by clicking the “Configure” tab in the top navigation once logged in and selecting “Edit User” from the menu. 11 Eigen Smart Module - User Guide 5.0 Viewing the Video Stream Once logged in, you will be presented with a menu of available options. To view the live video stream from a connected thermal camera, click on the “Watch Live Stream” main menu option, or select “Watch” from the top menu from anywhere within the software. 12 Eigen Smart Module - User Guide There are several options available to you from the Live Stream page: NUC Clicking this button will send a NUC (Non Uniformity Correction) request to the camera. As the camera heats up after extended usage the detector pixels begin to drift non-uniformly. This NUC request is essentially a manual trigger to correct for this pixel drift. Record This button allows you to manually toggle on and off the recording of the live thermal video stream Play/Pause This button allows you to toggle between pausing and playing the live video stream. This may be useful in cases where you wish to take action on a still frame (see section 6.1 for further details). When the stream is paused, the current frame of the video stream is displayed on the screen until such time as the button is pressed again. When the stream is resumed by clicking the button again it will advance to the current frame of the live feed and start streaming again. Thermal Palette This dropdown allows you to select the desired thermal color palette to display the live stream in. Thermal Range This dynamic slider, located on the right side of the stream allows you to narrow in the temperature range you want the stream to display. Dragging the top arrow will set the maximum temperature you want to range on and similarly, dragging the bottom arrow will set the minimum temperature. Adjusting these values may provide better contrast in the video stream if you are trying to detect very subtle changes in temperature in the field of view of the camera. 13 Eigen Smart Module - User Guide 6.0 Working with Rules The ESM is a thermal vision system designed for industrial applications. As with conventional vision system, the accompanying software must be configured through a series of settings and parameters to enable it to detect specific events and to know how to take action on those events. In the ESM this is achieved through a simple to use interface that allows you to create rules to describe the attributes the system should watch for. These rules are defined by a combination of elements in the form of Inputs, Conditions and Outputs. Rules can be as simple or as complex as needed. Rules can be constructed with multiple compounding conditions related through logic operators and they can have one or many simultaneous outputs. Additionally, multiple rules can be evaluated simultaneously to monitor for multiple independent events. The system has been optimized to provide the best performance and experience. However, although there are no imposed limits on the number of rules you can create, large numbers of enabled rules, or multiple rules evaluating on large distinct input regions may have an impact on performance of the system which could result in a reduction in the number of frames per second that can be evaluated. If you are unsure of how best to define and optimize your rules for detection, please feel free to speak with an Eigen representative. 6.1 Creating an Input One of the first building blocks of an ESM rule is an element called an Input. An input is defined as a specific region of the image, a pattern, or an external Modbus input signal that you want the ESM to monitor. 14 Eigen Smart Module - User Guide 6.1.1 Region Type Inputs To define a Region as an Input, follow these steps: 1) Navigate to the Live Stream page from the main menu, or from the “Watch” link in the top menu from anywhere within the ESM software. 2) Scroll to the bottom of the Thermal stream and select the INPUT tab if it’s not already selected. 3) Provide a descriptive “Name” for the Input so you can reference it later in the rule creation process 4) Select “Region” from the “Input Type” drop down menu. 5) Click the option to define your “Region Type” as either a rectangular, a line, or a single point. 6) Draw the region on the thermal stream by clicking and holding the right mouse button where you want to start drawing and dragging your mouse to the opposite corner. Release your mouse button when you are satisfied with the selected region. In the case of a point region, you only need to click once on the stream at the point you wish to use as your input. Thermal properties of the selected region will be displayed in the form. You can repeat this step multiple times if you wish to redraw the region. 7) Click the “Always Draw” toggle button to indicate if you want the region to always be visible on the stream view. If you toggle the button to “No”, it will only be visible when the rule is triggered. 8) Click the “Save Input” button to save your settings. Alternatively, click “Cancel” if you wish to discard your changes and reset the form. 15 Eigen Smart Module - User Guide 6.1.2 PLC Type Inputs To define a Modbus signal as an Input, follow these steps: 1) Navigate to the Live Stream page from the main menu, or from the “Watch” link in the top menu from anywhere within the ESM software. 2) Scroll to the bottom of the Thermal stream and select the INPUT tab if it’s not already selected. 3) Provide a descriptive “Name” for the Input so you can reference it later in the rule creation process 4) Select “PLC” from the “Input Type” drop down menu. 5) Specify the “PLC IP” of the Modbus device (PLC interface) you want to communicate with. This will tell the ESM to expect a signal from a PLC as an input to take action on 6) Specify the Modbus register from the external device that will be sending an input signal 7) Click the “Save Input” button to save your settings. Alternatively, click “Cancel” if you wish to discard your changes. 16 Eigen Smart Module - User Guide 6.1.3 Pattern Type Inputs To define a Pattern as an Input, follow these steps: 1) Navigate to the Live Stream page from the main menu, or from the “Watch” link in the top menu from anywhere within the ESM software. 2) Scroll to the bottom of the Thermal stream and select the INPUT tab if it’s not already selected. 3) Provide a descriptive “Name” for the Input so you can reference it later in the rule creation process 4) Select “Pattern” from the Input Type drop down menu. 5) Define your pattern by clicking and holding the right mouse button where you want to start and dragging your mouse to the opposite corner. Release your mouse button when you are satisfied with the selected pattern region. TIP: it may be useful to pause the live stream while you are defining your pattern. 6) A preview of the selected pattern will show up on the form. Review the pattern to ensure it’s accurate. If you wish you can define a new pattern by repeating step #5. 7) Click the “Save Input” button to save your settings. Alternatively, click “Cancel” if you wish to discard your changes. 17 Eigen Smart Module - User Guide 6.2 Creating a Condition The second rule element is called a Condition. A condition is a set of parameters that describe a particular state of the input being referenced. An example would be when a temperature exceeds a certain value in a particular region, a particular pattern is matched or when a signal of some sort is received from a connected Modbus device. Conditions are specific to a defined Input so you must have your inputs created before creating your conditions that will evaluate those inputs. To create a new Condition, select the CONDITION tab below the video stream to begin. 6.2.1 Conditions with a Region type input Conditions with region type input are particularly useful if you want to narrow in your condition logic to only a smaller defined known region of the cameras focus area. This allows you to exclude areas outside of the region that may not be of interest or that may not be relevant to the particular event you are trying to detect. If the condition you are creating is based on a region type input, you will need to define the following values: 1) Give your condition a descriptive “Name” to describe what it’s doing 2) Click the “Input” drop down and select a region type input that you created previously 3) Specify the “Attribute” of that region you are looking for by selecting one of the options from the “Attribute” drop down list. The available options are: a. Maximum – used when you are looking for a temperature over a certain value b. Minimum – used when you are looking for a temperature under a certain value c. Average – used when you are looking for an average temperature d. Difference – used when you are looking for a difference between the minimum and maximum value e. Count Pixels – used when you are looking for the number of pixels that represent a particular temperature range f. Count Peaks – used when you are looking for the number of peaks above a certain temperature along a line (note: this attribute is only useful with line type regions) If your condition attribute is one of “Maximum”, “Minimum”, “Average”, or “Difference”: 4) 5) Specify the “Constraint” you want to apply to the Attribute you just selected by selecting one of the available options from the “Constraint” drop down list. The options are: a. Greater than – used when you are looking for something greater than a particular temperature value b. Less than – used when you are looking for something less than a particular temperature value Specify the temperature “Value” and unit that represent the threshold you want your attribute and constraint to exceed in order for the condition to be true. Temperatures can be specified in degrees Celsius (C), Fahrenheit (F), or Kelvin (K) by selecting the appropriate unit from the drop down beside your temperature value. 18 Eigen Smart Module - User Guide 6) Lastly, specify the “Duration” that the condition must occur before being evaluated as true. This is to say how long the condition must be occurring before a rule is considered to be triggered or any defined output to be actioned. Duration is specified in seconds and a value of 0 signifies that the condition is evaluated as true as soon as it is initially detected. These condition attributes are used most commonly when you want to detect any pixel that is above, below specific values within your region of interest. (ie, does any part of the region meet the temperature criteria) Example: “The specific condition I am looking for is when a temperature is detected within my region of interest that is greater than 30 degrees Celsius for more than 5 seconds.” (maximum temperature condition attribute) 19 Eigen Smart Module - User Guide If your condition attribute is set to “Count Pixels”: 4) Specify the “Temp Range” criteria you want the pixel count to be evaluated on. The range can be specified as: a. Greater than – used when you want to count pixels that represent temperatures above a certain temperature boundary b. Less than – used when you want to count pixels that represent temperatures below a certain temperature boundary c. Between – used when you want to count pixels the represent temperatures between a certain temperature range 5) Specify the temperature boundary that corresponds to the “Temp Range” Criteria you just specified by inputting both a Temperature and specifying the temperature unit (C, F, or K). In the case of a “Temp Range” criteria of “Between”, you will need to specify both a Lower and Upper Bound. 6) Specify the specific pixel “Constraint” that describes how you want to pixel count total to be evaluated to determine if the condition is evaluated as true. The options are: a. Greater than – used when you want to condition to be evaluated as true when the total pixel count in your temperature range is above a certain number b. Less than - used when you want to condition to be evaluated as true when the total pixel count in your temperature range is below a certain number 7) Specify the total number (Value) of pixels that will serve as the boundary for evaluating the condition. 8) Lastly, specify the “Duration” that the condition must occur before being evaluated as true. This is to say how long the condition must be occurring before a rule containing this condition is considered to be triggered or any defined output of the rule is to be actioned. Duration is specified in seconds and a value of 0 signifies that the condition is evaluated as true as soon as it is initially detected. This condition attribute is used when you want to detect a specific amount of pixels that are above, below or within specific temperature ranges in your region of interest. (ie, how much of the region meets the temperature criteria) Example: “The specific condition I am looking for is when the total number of pixels within my region of interest that represent temperatures that are above 30 degrees Celsius is greater than 100 pixels total” 20 Eigen Smart Module - User Guide (count pixels condition attribute) Once you are satisfied that your Condition describes the particular state of the input region you are evaluating, click the “Save Condition” button at the bottom of the form. Alternatively, if you wish to start over from scratch, click the “Cancel” button and the form will be reset 6.2.2 Conditions with a PLC type input: Conditions with PLC type inputs are useful when you want the system to only take action based on a signal received from a connected Modbus device. As an example, this may be of benefit to allow you to limit a rule from being evaluated and actioned only in defined periods of time when it’s signalled to do so. If the condition you are creating is based on a region type input, you will need to define the following values: 1) Give your condition a descriptive “Name” to describe what it’s doing 2) Click the “Input” drop down and select a PLC type input that you created previously 3) Select the appropriate “State” of the Modbus signal you want your condition to evaluate. Your options are: 21 Eigen Smart Module - User Guide a. Rising – used when you want the condition to be evaluated when the signal state transitions from off to on. This evaluation will only occur during the state transition. b. On – used when you want the condition to be evaluated while the signal state is on c. Falling - used when you want the condition to be evaluated when the signal state transitions from on to off. This evaluation will only occur during the state transition. d. Off – used when you want the condition to be evaluated while the signal state is off 4) Lastly, specify the “Duration” that the condition must occur before being evaluated as true. This is to say how long the condition must be occurring before a rule is considered to be triggered or any defined output to be actioned. Duration is specified in seconds and a value of 0 signifies that the condition is evaluated as true as soon as it is initially detected. In the case of PLC type conditions, duration is only relevant for conditions based on static states (On, Off). Once you are satisfied that your Condition describes the particular state of the input region you are evaluating, click the “Save Condition” button at the bottom of the form. Alternatively, if you wish to start over from scratch, click the “Cancel” button and the form will be reset 22 Eigen Smart Module - User Guide 6.2.3 Conditions with a Pattern Type Input Conditions with Pattern type inputs are mean to be used in conjunction with Region type inputs (ie looking for a pattern within a region). They are useful when you want the system to take action when a particular image pattern is present in the thermal stream. Pattern conditions are particularly useful when the shape profile you are trying to detect is fairly static and does not have a lot of variation in shape or size. Examples of this could include looking at the heat profile of components on a circuit board, or heated products on an assembly line. If the condition you are creating is based on a pattern type input, you will need to define the following values: 5) 6) 7) 8) Give your condition a descriptive “Name” to describe what it’s doing Click the “Input” drop down and select a Pattern type input that you created previously In “Attribute” dropdown, select “Contained Within”. In the “Region” dropdown, select a Region input that you created previously to define the region that the system should look within to find the pattern. 9) Click and drag the pointer on the “Match Threshold” to indicate how much variation in the pattern will be considered by the system when evaluating if a pattern is matched. A higher percentage means that small variations may not be detected as a match, while a lower percentage means that larger variations will be accounted for, but may also lead to false positives as other shapes (other than were intended) may also be detected. Set the value relative to how much variation you are expecting. You may need to experiment with this value to fine tune your pattern match. You can do so by editing the condition after it has been created. (See section 6.5 for details on how to edit rules and rule elements). 10) Lastly, specify the “Duration” that the condition must occur before being evaluated as true. This is to say how long the condition must be occurring before a rule is considered to be triggered or any defined output to be actioned. Duration is specified in seconds and a value of 0 signifies that the condition is evaluated as true as soon as it is initially detected. In the case of PLC type conditions, duration is only relevant for conditions based on static states (On, Off). Once you are satisfied that your Condition describes the attributes of the pattern you are looking for, click the “Save Condition” button at the bottom of the form. Alternatively, if you wish to start over from scratch, click the “Cancel” button and the form will be reset 23 Eigen Smart Module - User Guide 6.3 Defining an Output The 3rd and final rule element is called an Output. An output is a specific action you want the rule to trigger when a condition is evaluated to be true. This action may be specified as a signal output to a Modbus device (PLC) or as a video recording of the event that triggered the rule. To create a new Output, select the OUTPUT tab below the video stream 6.3.1 PLC Type Outputs If you wish to send an output signal to a Modbus device (PLC) when a rule is triggered: 1) 2) 3) 4) 5) Give your output a descriptive “Name” to describe what action it is taking Select “PLC” from the output “Type” dropdown list Input the IP of the Modbus device you wish to send the signal to in the “PLC” field Input the Modbus register you want to send the signal to Check the “Enabled” box to enable to Modbus signal output. Alternatively, uncheck the box if you wish to temporarily disable to output signal. This may be useful when you are first setting up the system. 24 Eigen Smart Module - User Guide 6) Once you have specified the details of the Modbus device you want to signal, click the “Save Output” button at the bottom of the form. Alternatively, if you wish to start over from scratch, click the “Cancel” button and the form will be reset 6.3.2 Video Type Outputs If you wish to record the event that caused the rule to be triggered: 1) Give your output a descriptive “Name” to describe what action it is taking 2) Select “Video” from the output “Type” dropdown list 3) If you wish the video to be recorded for the length of the event and a specified time after the event has occurred, specify the time interval in the “Duration” field and check the “enabled” flag. (example: continue to record the video for 10 seconds after the event has occurred) 4) Click the “Save Output” button at the bottom of the form. Alternatively, if you wish to start over from scratch, click the “Cancel” button and the form will be reset. See section 7.2 for more details on recording video when a rule is triggered. 25 Eigen Smart Module - User Guide 6.3.3 Email Type Outputs If you wish to have the system send an email when an event occurs that triggers a rule: 1) Give your output a descriptive “Name” to describe what action it is taking 2) Select “Email” from the output “Type” dropdown list 3) In the “Email” field that is displayed, specify the email address of the recipient you wish the message to be sent to. 4) Click the “Save Output” button at the bottom of the form. Alternatively, if you wish to start over from scratch, click the “Cancel” button and the form will be reset. See section 7.2 for more details on recording video when a rule is triggered. NOTE: A rule output that generates an email notification will have the subject of “Rule Trigger for ” where rule name is the name you assigned the rule that was triggered. The body of the email will contain date and time details of when the rule was triggered. If more than one rules or events occur within a short period of time, the email may contain multiple instances of rule events. The email will be sent from “[email protected]”. Please ensure your spam filters do not log these emails as spam. 26 Eigen Smart Module - User Guide 6.4 Defining a Rule Once you have created all your rule elements (Inputs, Conditions, and Outputs), you can now begin to construct your rule. Rules are a set of instructions for the ESM software that defines what actions you want the system to take when it evaluates specific conditions to be true. The ESM software uses these rule based instructions to evaluate every frame of data that is received from the thermal camera. The rule is executed the instant that the rule condition is detected on an incoming frame. NOTE: As each active rule is evaluated against every frame received from the thermal camera, the more rules that are enabled the longer it takes to evaluate the frame and the more of a potential that there may be an impact to performance on the ESM. This reduction in performance may reduce the frame rate at which the system is able to process the incoming thermal stream and potentially resulting in delays in how quickly the system can take action after a rule triggering event occurs. More advanced ESM hardware options, such as the ESM290, are better suited for these more complex applications where multiple rules at high frame rate are required. 27 Eigen Smart Module - User Guide To create a rule: 1) Select the RULE tab below the video stream. 2) Give your rule a descriptive “Name” that describes what the rule is doing. 3) Select the Condition you want the rule to evaluate from the dropdown list in “Rule Logic” section of the form. This drop down contains both existing conditions and rules already defined in the system. An existing rule can act as a condition and allows the creation of more complex nested rule logic. 4) Specify what action you want the rule to take when the selected condition is evaluated as true by picking the desired “Output” from the dropdown list of available outputs you defined. If your output is a PLC type output, you will need to also specify the state you want to set on the connected Modbus device. Select one of the following states: a. Select ON if you want the rule to set the signal state to on when the rule event occurs b. Select OFF if you want the rule to set the signal state to off when the rule event occurs c. Select RULE if you want the rule to set the signal state to on while the rule event is occurring and back to off when the rule event is no longer occurring 5) Toggle whether you want to rule to create an entry in the system rule log (see section 6.6 for more details) by clicking on the “Log Hit” button to toggle the log entry On or Off. 6) Click the “Save Rule” button at the bottom of the form. Alternatively, if you wish to start over from scratch, click the “Cancel” button and the form will be reset. 7) Once you click “Save Rule” your Rule is now active by default. To disable a rule, see section 6.5 on viewing and editing existing rules. 28 Eigen Smart Module - User Guide If the event you are trying to detect is more complex in nature, you can create more complex rule logic by adding additional conditions and specifying how those conditions relate to each other. And if you want the rule to trigger more than a single action, you can specify multiple outputs that will each occur when the rule is triggered. To add multiple conditions: 1) Click the “Add Condition” button to bring up an additional condition dropdown box 2) Select the additional condition or rule you wish to add. 3) Repeat steps 1 and 2 as many times as you need to define the necessary rule logic. To remove a condition you don’t want to include, click the “--“ button next to the condition you want to remove. 4) Select an appropriate “Operator” from the dropdown box that appears above the list of conditions. This operator will apply to all selected conditions. The available options are: a. AND – Used when you want to ensure all conditions must be true for the rule to trigger b. OR – Used when you want the rule to trigger if any one of the conditions is true c. XOR – Used when you want the rule to trigger when one or the other conditions is true but not both. In cases where there are more than 2 conditions, the rule will trigger when there are an odd number conditions that are evaluated to be true (and conversely the rule wont trigger when there are an even number of conditions that are true) 5) Fill in the rest of the details to define the rule outputs and options, then click “Save Rule” 29 Eigen Smart Module - User Guide To add multiple outputs: 1) 2) 3) 4) Click the “+” button next to the previous output you defined. Select the additional output you wish to add from the new dropdown box. To remove an output, click the “—“ button next to the output you wish to remove. Fill in the rest of the details to define the rule conditions and options, then click “Save Rule” NOTE: If your ESM is registered and connected to our cloud based data intelligence platform, Intellexon™ you may also see a condition available in your rule condition dropdown list labelled “Intellexon”. This condition can be used in the same was as other conditions that were manually defined except that it contains intelligent detection logic specifically programmed by the cloud platform. 6.5 Viewing and editing existing Rules To view and/or edit existing rules, inputs, conditions or outputs: 1) Select the “Manage Rules” menu option from the main menu or from the “Rules” top navigation menu anywhere within the ESM software 2) Select the tab corresponding to the rule element (INPUT, CONDITION, OUTPUT) or rule you wish to view or edit. A list of those elements or rules already defined will be displayed along with the date they were created. 3) To edit the element or rule, click the attribute of the element or rule. icon. This will bring up a form allowing you to edit any 4) To delete the element or rule, click the icon. You will be prompted to confirm your request to delete. 5) To enable or disable a rule, select or deselect the “Enabled” checkbox next to the rule you wish to toggle on or off. 30 Eigen Smart Module - User Guide 6.6 Viewing the Rule Log To view a list of events that triggered a rule, select the “Rule Log” menu option from the main menu or from the “Rules” top navigation menu anywhere from within the ESM software. A list of events will be displayed along with the Rule Name, Start Time and Duration corresponding to the event. To view a screenshot of the first frame that triggered the rule, click the “View Capture” button next to the specific event you wish to view. The image representing the specific frame will be displayed in a new window. In the event there are more events in the log than can be displayed on a single page, click the “Load More Rule Logs” button at the bottom of the list to display the next page of events. Alternatively, you can also modify the number of events to display on a single page by selecting a larger number from the dropdown at the bottom of the list. By default this number is set to 10 events per page. To delete a specific event from the Rule Log, click the “Delete Log” button next to the corresponding event you wish to delete. If you wish to delete all events from the log, click the “Delete All” button in the top right corner of the list or at the bottom of the list. 31 Eigen Smart Module - User Guide 7.0 Recording Data If you wish to record the live video stream, you can either do so manually using the record button on the video stream page or optionally you can configure the system to trigger a video recording based on a specific condition of a rule being met (see section 6.2 and 6.3 above). All recorded video is stored on the file system in the location specified in the system configuration. By default this location is “EigenData” under the users home directory. This directory can be modified through your module’s configuration page (see section 8.2 below). Each individual recording is stored in it’s own folder named with the current epoch time (epoch time is defined as the number of seconds since midnight UTC on January 1, 1970). Example: “/EigenData/1430872123/” Inside each recording’s folder the video recording is composed of 2 data parts:   Meta data about the recording stored in “/chov/meta/settings.txt” A series of individual static frames in PNG image format stored in “/chov/raw_frames/.eig” 7.1 Manual recording To start a manual recording, click the record button located above the video stream on the video stream page. Once clicked, the button should turn red to indicate that the stream is currently being recorded. The stream will continue to record until such time as you manually stop the recording by clicking the button again or the hard drive you are recording to runs out of space. 32 Eigen Smart Module - User Guide 7.2 Rule based Recording If you are looking to record specific events, you can define a rule output (see section 6.3 above) and select an Output Type of “Video”. Any rule that implements this output will start to record video the instant the rule is triggered and will continue to record video until such time as the condition that triggered the rule is no longer occurring or the specified recording duration is reached, at which point the recording will stop. Video recordings triggered by rules are stored in the same directory and with the same video format as manually recorded videos. 7.3 Rolling Recording You may optionally wish to maintain a recording of the video stream that is continually recording. Since data storage is not unlimited and thermal video data is fairly large in size (about 1Gb per minute of thermal video), the rolling recording feature allows you to define how long of a period in the past you wish to keep the data for. Example: You may always wish to keep the last 6 hours of the video stream on the file system for reference and review in the case of any major event that has occurred. As new data is recorded, the system will always clean up data older than 6 hours, so that there is always a recording history that goes back 6 hours from the current time. This allows you to constantly gather new data while not having to worry about archiving older data or maintaining an excessively large storage volume. 33 Eigen Smart Module - User Guide The rolling record feature is disabled by default, but can be enabled through your module’s recording configuration page (see section 8.2 below). 7.4 Managing Recordings To view a log of the video recordings that have been captured, select the “Recordings” menu option from the main menu or from the “Recordings” top navigation menu anywhere from within the ESM software. A list of all recordings the system is currently aware of will be displayed along with the date/time they were recorded, the file location of where they are stored in the file system, the total duration of the video and the type of recording (manual, rule based, or rolling recordings). In the event there are more recordings in the log than can be displayed on a single page, click the “Load More Recordings” button at the bottom of the list to display the next page of recordings. Alternatively, you can also modify the number of recordings to display on a single page by selecting a larger number from the dropdown at the bottom of the list. By default this number is set to 10 recordings per page. If you wish to get additional details about what was occurring when the video was captured, you can click on the date/time of the video you wish to get more information on. Doing so will expand the list to show any system rules that were triggered during the recording or that may have caused the recording to occur. Since the videos are all stored in a proprietary frame-based format, they are not easily viewable by normal video players. As such, you can convert a recording to a more portable format by clicking the “Export” button next to the video you wish to export. The export process may take several minutes depending on the size of the video. When the export process is complete, the “Export” button will be replaced by a “Download” button instead allowing you to click and download the video to your local computer for playback in a local video player or via a browser. To delete a specific recording from the list and from the file system, click the “Delete” button next to the corresponding video recording you wish to delete. This will allow you to manage and clean up space on the file system without needing to access the file system directly. Deleting a recording from the list is a permanent action and cannot be undone. As such, you may wish to export and download a copy of the recording before deleting if it’s a recording that may contain important data. 34 Eigen Smart Module - User Guide 8.0 Configuration Options The system provides several options to allow you to tailor the module to your specific integration needs. Several configurations options are available within the system to customize your preferences and settings for communications, system monitoring, recordings, and camera settings. Depending on the nature of your specific application, these settings may need to be modified to suit your needs. If you need assistance with your integration, please speak with an Eigen representative who can guide you through your options. 8.1 Module Configuration To configure modules specific settings such as camera settings and communication preferences, select the “Configure Module” menu option from the main menu or click the “Configure” top navigation menu link anywhere from within the ESM software and select the “Configure Module” option from the dropdown menu. The module configuration page is divided in to several sections as described below: 8.1.1 Camera Settings Accurate measurements from a thermal camera is often dependent on environmental conditions and thermographic properties of the object being measured. The configuration settings provide compensation variables to be set according to the specific installation. Please consult the camera documentation for information on how to configure these settings appropriately for your environment. To modify any of these settings, scroll down to the section of the “Configure Module” page titled “Camera Settings”. Modify the settings specific to your environment and then click “Save Camera Settings” to save your changes. 35 Eigen Smart Module - User Guide 8.1.2 Health Alarm Settings In cases where the ESM software is part of a mission critical system, it may be of importance to know when the system is no longer monitoring a video stream and is thus not opperating as expected. The Health Alarm feature allows you to send a signal out to an external system through a connected modbus device when the system is no longer receiving a signal from a connected thermal camera. The system Health Alarm is disabled by default. To enable and configure the Health Alarm: 1) Scroll down to the section of the “Configure Module” page titled “Health Alarm Settings”. 2) Click the button next to the PLC settings to toggle the alarm state to “Enabled” (It is set to “Disabled” by default). 3) Input the IP Address of the connected Modbus device you wish to send the signal to. 4) Input the Register Address on the Modbus device you wish to send the signal to. 5) Press the “Test PLC” button to ensure the system can correctly communicate with the connected Modbus device. 6) Once you are satisfied with your settings, click the “Save Health Alarm Settings” button to save your changes. 36 Eigen Smart Module - User Guide 8.1.3 SMTP Settings In addition to communicating via modbus signals, the system is also capable of sending notifications of various system events via email. To do so however, the module must be configured to communicate via an external SMTP service that you must supply. The specific events for which an email notification are generated are detailed below. To enable and configure email notifications: 1) 2) 3) 4) Scroll down to the section of the “Configure Module” page titled “SMTP Server Settings”. Click the checkbox next to “Enable SMTP”. Enter the Host address for your SMTP server. Enter the Port on the SMTP server over which you will communicate (normally 25 or 465, but this may vary depending on your setup). 5) If your SMTP service requires authentication, input the Username and Password required to connect. 6) If you intend to use TLS to encrypt communication with your SMTP server, click the checkbox next to “TLS”. NOTE: If you are unsure of the SMTP server settings described in steps 3-6 above, you may need to speak with your local IT department for assistance on obtaining the necessary settings. 7) To enable rule outputs to send email notifications click the check box next to “Allow Rule Output Notifications”. This is required for rule output notifications to work. Rule output notifications will be sent to the recipient specified when the output is set up (see section 6.3.3). 8) Enter the Notification Email Address you want system notifications to be sent to. This email address will be used to forward notifications of all system event except rule outputs. 9) Select the notifications you wish the system to send. The options available to you are: a. Send Storage Notifications – By clicking this option, the system will send you an email notification any time the system detects that it is approaching the limits of 37 Eigen Smart Module - User Guide available file storage on the system (20% of file storage remaining), and when the system has reached its limit of allocated file storage space. b. Send PLC Notifications – By clicking this option, the system will send you an email notification when it is unable to communicate with a Modbus device that has been configured in the system. The email notification will contain details of the PLC address and register that are unreachable. c. Send Camera Notifications – By clicking this option, the system will send an email notification when it becomes disconnected from a camera stream. The notification will only be sent if a camera stream had been previously connected, but will not send a notification if no camera had been connected previously. 10) Once you are satisfied, click the “Save SMTP Settings” to save your changes. 8.2 Recording Configuration The system also provides the ability to modify some configuration options that define how and where video streams captures (sometimes referred to as CHOV’s) are recorded. To alter any of the default recording settings, click the “Configure” top navigation menu link anywhere from within the ESM software and select the “Configure Recording” option from the dropdown menu. 38 Eigen Smart Module - User Guide If you wish to enable compression on video stream captures, click the “Enable CHOV Compression” checkbox. Compression helps to reduce the file size of the recording stored on the file system by compressing the data as the file is written. This process however can be processor intensive and may impact the performance of the live video stream, making it appear slightly choppy while the recording is in progress. This option is disabled by default. If you wish to alter the physical location of where video stream captures are stored in the file system, you can do so by modifying the value specified in the “CHOV Directory” field. This allows you to specify your own file location, such as a mounted external storage drive, for writing of the data. By default the directory location is set to “/home/eigen/EigenData/”. If you wish to modify the frame rate at which the video stream captures are recorded, you can do so by modifying the “Recording Frame Rate” field. The system can be set to capture video streams at a frame rate as low as 1 frame per second or as high as the physical capabilities of the camera you are using (usually 30 or 60 fps). By default, this value is set to 30 frames per second. If you wish to enable the rolling recording feature (see section 7.3 above), check the “Enable Rolling Recording” checkbox and specify a “rolling period” in the “Rolling Recording Duration” field. The rolling period can be specified in terms of hours, and by default is set to 1 hour. Make sure you also specify the “Rolling Recording CHOV Directory”. Rolling video stream captures are stored in a separate directory from normal recordings. This is so that videos recordings that fall outside the rolling period can be cleaned up as new videos stream captures are recorded. 39 Eigen Smart Module - User Guide Appendix A – Officially Supported Thermal Cameras The ESM software has been tested with and currently supports the following thermal cameras: FLIR A35 FLIR A65 FLIR A315 FLIR A615 40 Eigen Smart Module - User Guide Appendix B – Troubleshooting If you experience any issues with the setup or operation of your ESM module, please check the following list of common problems and resolutions. If these resolutions do not solve your issue, please contact an Eigen representative for support by emailing [email protected]. Please provide as much detail as possible to help us resolve your issue quickly. Issue I have connected a monitor to the ESM module but I see nothing on screen I am logged in but I do not see any image on the live stream page I am not receiving any email outputs from the system I have rules created but they do not seem to be triggered when I expect that they will Possible Resolution  Make sure your monitor is connected prior to turning on the ESM module. If your ESM module was already on before connecting the monitor, turn it off by holding down the power button for 10 seconds and then once it is off, hit the power button again to turn it on.  Make sure that your camera is connected to the LAN2 port and that the camera is powered on.  Make sure that the camera you are using is a supported model GigE vision thermal camera  Use the Firefox web browser to access the live stream. The software is optimized for viewing in this browser  Ensure your network settings are correct for you specific integration type (see section 3.2).  Make sure that no other software program is running and connected to the camera. Most cameras are only able to stream to a single connection. If your camera is plugged directly to the unit, make sure no other 3rd party software is running on the ESM unit. If your camera is plugged in to a network switch, make sure no other device on the network is attempting to connect to the camera.  Make sure you have configured the SMTP settings in the “Configure Module” settings page and that you have enabled email output notifications.  Make sure your ESM is connected to the internet and is able to communicate with your SMTP server.  Check the rule log to ensure that rules have been triggered.  Verify that your rule logic is correct by reviewing your condition settings.  Check that your rules are enabled (see section 6.5)  Verify that your rule logic is correct by reviewing your condition settings. 41 Eigen Smart Module - User Guide I get an error when trying to launch the software  I cannot access the software from a remote computer  I get a message saying “Invalid email address or password” when attempting to log in.  The live stream appears all black (or white) or has very poor contrast  Verify that the hard drive on the ESM module is not full. Most models of ESM units have 64GB internal hard SSD drives. Although the software contains logic to prevent against filling of the physical drives with system recorded data, external sources and software may write to the drives outside of the control of the ESM software. In the event this hard drive is filled to capacity, the ESM software may be come unresponsive. If you discover the hard drive is at capacity, back up any important recorded data to an external drive and power off and on the ESM to reset the system. Verify the network settings are set correctly on the ESM module by connecting to the box directly with a monitor, keyboard and mouse. See section 3.2 for details on the required network settings for various remote access configurations. Double check that you entered your login credentials correctly by verifying that they match the details you were provided when you set up the box. If you have lost these credentials, contact your Eigen representative to have them provided again. Adjust the thermal range sliders to the right of the live stream to narrow the temperature ranges in view. The top slider should be adjusted to a temperature just above the max temperature you expect to see and the bottom slider should be adjusted to just below the min range. 42 Eigen Smart Module - User Guide Contact Us Mailing Address: Eigen Innovations Inc PO Box 30092 Prospect Plaza Fredericton, NB E3B 0H8 Email: [email protected] Phone: 506-333-3548 Fax: 506-799-1848 Copyright © 2014-2015 Eigen Innovations. All Rights Reserved. 43