Quick Start Guide - IO Module IO Module.pdf · 1. Make sure the cFP network module and I/O modules...

33
Diablo EZReporter Analog & Digital Output Module Quick Start Guide Copyright 2012, Diablo Analytical, Inc.

Transcript of Quick Start Guide - IO Module IO Module.pdf · 1. Make sure the cFP network module and I/O modules...

Page 1: Quick Start Guide - IO Module IO Module.pdf · 1. Make sure the cFP network module and I/O modules are powered and ready (the “Power” and “Status” LEDs on each module should

Diablo EZReporter

Analog & Digital Output Module Quick Start Guide

Copyright 2012, Diablo Analytical, Inc.

Page 2: Quick Start Guide - IO Module IO Module.pdf · 1. Make sure the cFP network module and I/O modules are powered and ready (the “Power” and “Status” LEDs on each module should

Diablo Analytical EZReporter Software

Analog & Digital Output Module Quick Start Guide

Copyright 2011-2012, Diablo Analytical, Inc. All rights reserved.

This software and documentation are copyrighted by Diablo Analytical, Inc. All other brands or product names are trademarks or registered trademarks of their respective owners.

Diablo Analytical, Inc.5141 Lone Tree WayAntioch, CA 94531

Phone: 925-755-1005Fax: 925-755-1007

E-mail: [email protected] Page: www.diabloanalytical.com

Manual Revision 20121113-1055

Page 3: Quick Start Guide - IO Module IO Module.pdf · 1. Make sure the cFP network module and I/O modules are powered and ready (the “Power” and “Status” LEDs on each module should

DIABLO ANALYTICAL, INC. SOFTWARE LICENSE AGREEMENT AND LIMITED WARRANTY

LICENSE AGREEMENT

IMPORTANT: Please carefully read the License Agreement below before installing the software. The right to use this software product is sold only on the condition that the customer agrees to the following license. INSTALLING THE SOFTWARE INDICATES YOUR ACCEPTANCE OF THESE TERMS AND CONDITIONS.

In return for payment of the one-time license fee for this software product, Customer receives from Diablo Analytical, Inc. (Diablo) a license to use the product subject to the following terms and conditions:

Use: The product may be used one computer or workstation. A separate license agreement and fee is required for each additional computer or workstation on which the product is used. Customer may not reverse assemble, decompile, or modify the software.

Copies: The software product may not be duplicated or copied except for archive purposes, program error verification, or to replace defective media, and all copies made must bear the copyright notices contained in the original.

Ownership: Purchase of this license does not transfer any right, title or interest in the software product to Customer except as specifically set forth in this License Agreement. Customer is on notice that the software product is protected under copyright laws.

Transfer of Rights: This license and the software product may be transferred to a third party, with prior written consent from Diablo, provided the third party agrees to all the terms of this License Agreement and the Customer does not retain any copies of the software product.

Sublicensing and Distribution: Customer may not sublicense the software or distribute copies of the software to the public in physical media or by telecommunication without the prior written consent of Diablo.

Termination: Diablo reserves the right to terminate this license upon breach. In event of termination, Customer will either return all copies of the product to Diablo, or with Diablo's prior consent, provide Diablo with a certificate of destruction of all copies.

Updates and Upgrades: Customer agrees that the software does not include updates and upgrades which may be available from Diablo in a separate support agreement.

Export Restrictions: Customer agrees not to export or re-export the software or any copy in violation of the U.S. Export Administration regulations or other applicable regulation.

LIMITED WARRANTY

Limited Warranty: Diablo warrants that the original disks are free from defects for 90 days from the date of delivery of the software.

No Other Warranties: To the maximum extent permitted by applicable law, Diablo expressly disclaims any warranty for the software product. The software product and any related documentation is provided "as is" without warranty of any kind, either express or implied, including, without limitation, the implied warranties or merchantability of fitness for a particular purpose. The entire risk arising out of use or performance of the software product remains with the customer.

Limitation of Liability and Customer Remedies: Diablo's entire liability and the customer's exclusive remedy under this license agreement shall be, at Diablo's option, either (a) return of the price paid for the software or (b) replacement of the software that does not meet Diablo's Limited Warranty and which is returned to Diablo with a copy of the customer's receipt. Any replacement software will be warranted for the remainder of the original warranty period, or 30 days, whichever is longer. These remedies are not available outside the United States of America.

Page 4: Quick Start Guide - IO Module IO Module.pdf · 1. Make sure the cFP network module and I/O modules are powered and ready (the “Power” and “Status” LEDs on each module should

No Liability for Consequential Damages: To the maximum extent permitted by applicable law, in no event shall Diablo be liable for any damages whatsoever (including, without limitation, damages for loss of business profit, business interruption, loss of business information, or any other pecuniary loss) arising out of the use or inability to use the product, even if Diablo has been advised of the possibility of such damages. Because some states/jurisdictions do not allow the exclusion or limitation of liability for consequential or incidental damages, the above limitation may not apply to you.

Page 5: Quick Start Guide - IO Module IO Module.pdf · 1. Make sure the cFP network module and I/O modules are powered and ready (the “Power” and “Status” LEDs on each module should

Diablo EZReporter Analog & Digital Output Module Quick Start Guide Contents v

Contents

Introduction 1

Overview of the EZReporter Analog & Digital Output Module ............................................... 1Hardware and Software Requirements ...................................................................................... 2

Installation and Configuration 3

Installation and Configuration Checklist ................................................................................... 3Installing the Compact FieldPoint Driver Software .................................................................. 3Configuring Compact FieldPoint............................................................................................... 4Installing the EZReporter Analog & Digital Output Module .................................................... 7Configuring the EZReporter Analog & Digital Output Module................................................ 8

Define the Compact FieldPoint I/O Hardware Configuration..................................... 9Test the Compact FieldPoint Configuration.............................................................. 10Add Analog and Digital Output Channels to the Configuration ............................... 11Enable the Data Ready Output Pulse (optional)........................................................ 12Enable Debug Logging (optional)............................................................................. 12

Using The Analog & Digital Output Module 13

Using Analog Result Outputs .................................................................................................. 13Configuring Analog Output Zero and Span .............................................................. 13

Using Digital Alarm Outputs................................................................................................... 14Resetting the Digital Alarm Output........................................................................... 15

The I/O Channels Tab and Real-Time Channel Display ......................................................... 16Connecting and Disconnecting the I/O Channels...................................................... 17I/O Module Status ..................................................................................................... 18Manual Control of Output Channels ......................................................................... 19

Troubleshooting 20

Test the Configuration............................................................................................................. 20Examples of Configuration Test Windows ............................................................... 21Network Module Ping Test ....................................................................................... 22Network Module Connect Test ................................................................................. 23Network Module Read Test ...................................................................................... 23I/O Module Module Connect Test............................................................................. 23

Socket Errors ........................................................................................................................... 23Quality Errors .......................................................................................................................... 24Debug Logging........................................................................................................................ 25

Index 27

Page 6: Quick Start Guide - IO Module IO Module.pdf · 1. Make sure the cFP network module and I/O modules are powered and ready (the “Power” and “Status” LEDs on each module should
Page 7: Quick Start Guide - IO Module IO Module.pdf · 1. Make sure the cFP network module and I/O modules are powered and ready (the “Power” and “Status” LEDs on each module should

Diablo EZReporter Analog & Digital Output Module Quick Start Guide Introduction 1

Introduction

Overview of the EZReporter Analog & Digital Output ModuleThe EZReporter Analog & Digital Output Module allows you to generate analog/signal outputs and digital/alarm outputs based on Monitored Parameter results using National Instruments Compact FieldPoint I/O hardware.

Page 8: Quick Start Guide - IO Module IO Module.pdf · 1. Make sure the cFP network module and I/O modules are powered and ready (the “Power” and “Status” LEDs on each module should

2 Introduction Diablo EZReporter Analog & Digital Output Module Quick Start Guide

Hardware and Software RequirementsThe EZReporter Analog & Digital Output Module requires the National Instruments Compact FieldPoint distributed I/O hardware and software. For more information on Compact FieldPoint, please refer to the National Instruments web site:

http://www.ni.com/compactfieldpoint/

The EZReporter Analog & Digital Output Module currently supports the following Compact FieldPoint network/control modules and I/O modules.

Network Modules

Module Description

cFP-1804 Network module with an Ethernet interface and backplane to control up to four Compact FieldPoint I/O modules.

cFP-1808 Network module with an Ethernet interface and backplane to control up to eight Compact FieldPoint I/O modules.

I/O Modules

Module Type Description

cFP-AO-200 Eight-channel 20 mA loop output module Eight, 0-20 or 4-20 mA outputs; 12-bit resolution; up to 1 k-ohm load impedance with 24-V loop supply.

cFP-RLY-421 Eight-channel SPST relay module Eight, single-pole and single-throw (SPST) relay channels; switches up to 1.5A at 40 VDC or 250 VAC.

Note: Other Compact FieldPoint I/O modules may be compatible with the EZReporter Analog & Digital OutputModule. Contact Diablo Analytical directly to discuss your needs.

Page 9: Quick Start Guide - IO Module IO Module.pdf · 1. Make sure the cFP network module and I/O modules are powered and ready (the “Power” and “Status” LEDs on each module should

Diablo EZReporter Analog & Digital Output Module Quick Start Guide Installation and Configuration 3

Installation and Configuration

Installation and Configuration ChecklistThe Compact FieldPoint hardware and software and EZReporter Analog & Digital Output Module should be installed in the following order:

1. Assemble the Compact FieldPoint hardware by installing the I/O modules and connector blocks into the network module back plane and then make required power and signal connections according to the Compact FieldPoint documentation.

2. Install the Compact FieldPoint Software (See “Installing the Compact FieldPoint Driver Software” on page 3).

3. Configure the Compact FieldPoint Software (See “Configuring Compact FieldPoint” on page 4).

4. Install the EZReporter software with support for the Analog & Digital Output Module using the “Advanced Setup” installation option. (See “Installing the EZReporter Analog & Digital Output Module” on page 7).

5. Configure and test the EZReporter Analog & Digital Output Module and edit EZReporter’s monitored parameters to use analog/signal outputs or digital/alarm outputs as needed for your application (See “Configuring the EZReporter Analog & Digital Output Module” on page 8).

6. Review “Using The Analog & Digital Output Module” on page 13 for instructions on how to use the Analog & Digital Output Module.

7. Refer to “Troubleshooting” on page 20 if you experience any problems configuring or using the Analog & Digital Output Module.

Installing the Compact FieldPoint Driver SoftwareImportant: Before attempting to install, configure or use the EZReporter Analog & Digital Output Module, you mustfirst install the National Instruments (NI) Compact FieldPoint (cFP) driver software, and then configure the cFP hardware using the NI Measurement and Automation Explorer (MAX).

When you purchase the NI Compact FieldPoint I/O hardware, you will receive a “FieldPoint” driver CD. Alternatively, you can download the latest drivers from: http://www.ni.com/compactfieldpoint/

When installing the Compact FieldPoint driver software simply select the default options by clicking the “Next” button. When the installer has finished copying files, you should allow it to reboot your computer.

Page 10: Quick Start Guide - IO Module IO Module.pdf · 1. Make sure the cFP network module and I/O modules are powered and ready (the “Power” and “Status” LEDs on each module should

4 Installation and Configuration Diablo EZReporter Analog & Digital Output Module Quick Start Guide

Configuring Compact FieldPointPlease refer to the documentation for the Compact FieldPoint (cFP) hardware and software for detailed information on configuring your Compact FieldPoint hardware and software.

Once you have installed the hardware and software drivers, you can configure Compact FieldPoint using the NI Measurement & Automation Explorer (MAX) as follows:

1. Make sure the cFP network module and I/O modules are powered and ready (the “Power” and “Status” LEDs on each module should be green). In addition the cFP network module should be connected to the computer via an Ethernet connection.

2. Double click the “Measurement & Automation” icon on the desktop.

3. If a Windows Firewall alert is displayed, check the “Domain Networks” and Private networks” options and then click the “Allow access” button.

Important: After allowing access you must close and restart MAX before proceeding with subsequent configuration steps.

4. Click the “Remote Systems” branch (click the “+” or “>”) of the configuration tree and wait for MAX to search for and find your cFP network module. Once the module has beem found it will be displayed in the Remote Systems tree with an IP address of “0.0.0.0” until you have configured the correct address.

Page 11: Quick Start Guide - IO Module IO Module.pdf · 1. Make sure the cFP network module and I/O modules are powered and ready (the “Power” and “Status” LEDs on each module should

Diablo EZReporter Analog & Digital Output Module Quick Start Guide Installation and Configuration 5

5. Select the “0.0.0.0” branch and then the “Network” tab at the bottom of the window. Enter the IPv4 address, and subnet mask that you have assigned to the cFP unit. These addresses should be on the same subnet as the computer running the EZReporter software. The subnet mask will usually be “255.255.255.0” but check with your network administrator to confirm this.

6. Click the “Save” button and allow MAX to restart your cFP network module.

Page 12: Quick Start Guide - IO Module IO Module.pdf · 1. Make sure the cFP network module and I/O modules are powered and ready (the “Power” and “Status” LEDs on each module should

6 Installation and Configuration Diablo EZReporter Analog & Digital Output Module Quick Start Guide

7. When the “System State” is “Connected – Running”, click “Find Devices” button and answer “OK” to the “Comm Resource” dialog.

MAX should automatically find all of the I/O modules and channels attached to your network module and add them to the “Remote Systems” and “Data Neighborhood”.

Page 13: Quick Start Guide - IO Module IO Module.pdf · 1. Make sure the cFP network module and I/O modules are powered and ready (the “Power” and “Status” LEDs on each module should

Diablo EZReporter Analog & Digital Output Module Quick Start Guide Installation and Configuration 7

Note: You can use MAX to troubleshoot problems with your Compact FieldPoint system. Refer to the Compact FieldPoint documentation for more information.

8. When complete, save the configuration by clicking “File | Save All”. You can specify any file name.

9. You can now close MAX and proceed with installation and configuration of the EZReporter software.

Installing the EZReporter Analog & Digital Output Module

Important: Important: Before installing EZReporter with support for the Analog & Digital Output Module, you must first install the National Instruments (NI) Compact FieldPoint (cFP) driver software that came with your Compact FieldPoint hardware.

Page 14: Quick Start Guide - IO Module IO Module.pdf · 1. Make sure the cFP network module and I/O modules are powered and ready (the “Power” and “Status” LEDs on each module should

8 Installation and Configuration Diablo EZReporter Analog & Digital Output Module Quick Start Guide

To install EZReporter with support for the Analog & Digital Output Module, you must select the “Advanced Setup” option on the “Setup Type” panel of the EZReporter installer.

Note: see the EZReporter reference manual for complete instructions on installing the EZReporter software.

In the subsequent, “Select Components” panel, you must check the “IO Module” option:

Configuring the EZReporter Analog & Digital Output ModuleTo configure the EZReporter Analog & Digital Output Module, you must open the EZReporter Configuration Editor by clicking the “Edit configuration…” option of the “Tools” menu and then switching to the “I/O Module” tab.

Page 15: Quick Start Guide - IO Module IO Module.pdf · 1. Make sure the cFP network module and I/O modules are powered and ready (the “Power” and “Status” LEDs on each module should

Diablo EZReporter Analog & Digital Output Module Quick Start Guide Installation and Configuration 9

The first step in configuring the Analog & Digital Output Module is to define and test the Compact FieldPoint I/O hardware configuration by clicking the “Configure” button.

Important: Important: Before attempting to configure the EZReporter Analog & Digital Output Module make sure you have already installed the National Instruments (NI) Compact FieldPoint driver software and have configured the Compact FieldPoint hardware using the NI Measurement and Automation Studio (MAX) software.

Define the Compact FieldPoint I/O Hardware Configuration

You must define the Compact FieldPoint hardware configuration as follows. When you are finished, make sure to click the “Save” button.

1. Select the Network Module model you are using. Currently the cFP-1804 (four bank) and cFP-1808 (eight bank) models are supported.

2. Enter the IP address that you have assigned to the Network Module using the National Instruments Measurement and Automation Explorer (MAX).

3. In the module table, select the I/O module that is physically installed in each bank of the Network Module from the drop-down list box in each row of the “Module” column in the table. If a bank is empty you can either leave the module setting blank, or select “Empty” from the list.

Note: Each “Bank” consists of a pair of physical “slots” – one for the I/O module, and one for the CB-1 connector block that is used to make external connections. Banks are numbered sequentially starting with “Bank 1”, which is located immediately adjacent to the network module.

Page 16: Quick Start Guide - IO Module IO Module.pdf · 1. Make sure the cFP network module and I/O modules are powered and ready (the “Power” and “Status” LEDs on each module should

10 Installation and Configuration Diablo EZReporter Analog & Digital Output Module Quick Start Guide

Test the Compact FieldPoint Configuration

Once you have defined the Compact FieldPoint hardware configuration, you can test it to make sure that the configuration and network communications are correct by clicking the “Test” button to display the “Test I/O Module Configuration” window. Click the “Start” button to start the configuration tests.

If the Windows Firewall warning is displayed, click “Allow access” for “Domain networks” and “Private networks” as you did previously.

For more information on the I/O module configuration tests see, “Test the Configuration” on page 20.

Page 17: Quick Start Guide - IO Module IO Module.pdf · 1. Make sure the cFP network module and I/O modules are powered and ready (the “Power” and “Status” LEDs on each module should

Diablo EZReporter Analog & Digital Output Module Quick Start Guide Installation and Configuration 11

Add Analog and Digital Output Channels to the Configuration

Once you have defined the I/O module hardware configuration channels, you must add each output channel you will be using to the configuration by clicking the “Add” button on the I/O Module configuration tab. You will need to repeat this procedure for each output channel you want to use in your configuration.

The “Add Channel” window will be displayed:

Page 18: Quick Start Guide - IO Module IO Module.pdf · 1. Make sure the cFP network module and I/O modules are powered and ready (the “Power” and “Status” LEDs on each module should

12 Installation and Configuration Diablo EZReporter Analog & Digital Output Module Quick Start Guide

1. Select the type of channel you are adding (Analog/Signal Output, or Digital/Alarm Output) by clicking the desired entry in the “Channel Type” list box.

2. Select the “Bank” in which the desired I/O module is installed in the network module. Banks are numbered from left to right in the backplane of the network module. The cFP-1804 has banks numbered from 1-4, while the cFP-1808 has banks numbered 1-8.

3. Select the I/O module “Channel” to which you will be making a connection for this channel. The 8-channel modules will have channels numbered from 00 to 07. Refer to the FieldPoint Operating Instructions for the specific output module you are using to determine which terminal connections in the cFP-CB-1 Connector Block are assigned to a particular output channel.

4. Optionally, enter a “Description” for the output channel. If you don’t enter a description, then a default description will be created automatically. The description helps you select the appropriate output channel when setting up the alarm and signal outputs when configuring the monitored parameters.

5. When you have finished, click the “Add” button to add this channel to the configuration. You will need to repeat this procedure for each output channel you want to use in your configuration.

Enable the Data Ready Output Pulse (optional)

If you have a digital output module installed and have added at least one digital output channel to your configuration, then you will have the option to enable a “Data Ready” digital output “pulse”. If this option is enabled, then a pulse will be generated on the specified digital output channel for the specified duration in milliseconds when new analog/signal output data is available to read on the analog output channels.

Enable Debug Logging (optional)

If you enable debug logging, the EZReporter Analog & Digital Output module will log data socket communication commands and responses sent between EZReporter and the Compact FieldPoint modules to the file, ‘cfp_debug.log’, which is created in the EZReporter installation folder.

Important: This option should not be enabled unless you are troubleshooting a specific problem and it should be disabled once you have collected the log file. A status window is displayed on the main I/O Module tab to remind you when debug logging is enabled.

Page 19: Quick Start Guide - IO Module IO Module.pdf · 1. Make sure the cFP network module and I/O modules are powered and ready (the “Power” and “Status” LEDs on each module should

Diablo EZReporter Analog & Digital Output Module Quick Start GuideUsing The Analog & Digital Output Module 13

Using The Analog & Digital Output Module

Using Analog Result OutputsIf you have an analog output module installed and have added at least one analog/signal output channel to the configuration than you can configure the value of a Monitored Parameter numeric result to be output on an analog output channel. See the EZReporter reference manual for information on configuring, editing, and using Monitored Parameters.

To configure the value of a monitored Parameter’s numeric result so that it is output on an analog output channel, you must edit the Monitored Parameter, switch to the “Analog Output” tab, and check “Enable Analog Output for this parameter”. Finally, choose the analog output channel to which this parameter’s result value will be written.

Configuring Analog Output Zero and Span

Analog output channels are usually restricted to a specific voltage or current range. For example, the cFP-AO-200 module is restricted to 0-20 mA or 4-20 mA current loop outputs. Consequently, the monitored parameter result must be scaled properly for this output range. This scaling is accomplished using the “Zero” and “Span” settings.

Page 20: Quick Start Guide - IO Module IO Module.pdf · 1. Make sure the cFP network module and I/O modules are powered and ready (the “Power” and “Status” LEDs on each module should

14 Using The Analog & Digital Output ModuleDiablo EZReporter Analog & Digital Output Module Quick Start Guide

Output Zero and Span

The output zero and span settings are set automatically to the maximum and minimum output value supported by the analog output module. In the case of the cFP-AO-200 module this results in the Zero being set to 0 Amps and the span being set to 0.020 Amps (20 mA). If you want the Output Zero limited to 4 mA, you can set the value to 0.004 Amps.

Result Zero and Span

You typically set the Result Zero and Span so that it covers the range that the parameter’s value is expected to occur. By default the Result Zero - Span Range is 0-100. If the parameter’s value is greater than the Result Span or less than the Result Zero, then it will be automatically set to the Result Span or Zero value, respectively. Otherwise the parameter result value will be scaled so that the Output value in the Output Range is proportionally the same as the Result value in the Result Range.

Important: Important: You must also make sure that the device that is reading the output signal is using the same Zero and Span.

Using Digital Alarm OutputsIf you have a digital/relay output module installed and have added at least one digital/relay output channel to the configuration than you can configure a Monitored Parameter to generate a digital alarm output when a parameter alarm occurs. See the EZReporter reference manual for information on configuring, editing, and using Monitored Parameters and Parameter Alarms.

Page 21: Quick Start Guide - IO Module IO Module.pdf · 1. Make sure the cFP network module and I/O modules are powered and ready (the “Power” and “Status” LEDs on each module should

Diablo EZReporter Analog & Digital Output Module Quick Start GuideUsing The Analog & Digital Output Module 15

To configure a Monitored Parameter to generate a digital alarm output you must first enable an Alarm on the “Alarms” tab (see the EZReporter reference manual) and then switch to the “Alarm Actions” tab. On the “Alarm Actions” tab, check “Enable Digital/Relay Output for this parameter”, and select the desired Digital Output Channel.

When an alarm condition occurs for this parameter, the I/O Module will change the value of the specified digital/relay output from Off/Low/Open/Pass to On/High/Closed/Fail.

Resetting the Digital Alarm Output

Once an alarm output has been has been switched to the On/Fail condition, there are two ways for it to be reset to the Off/Pass condition:

1. Automatically when a parameter alarm using the alarm output is next processed and the status of that alarm is “Pass”.

2. Manually by double clicking the output channel in the Real-Time Channel Display and clicking the “Off” button. See “Manual Control of Output Channels” on page 19 for more information.

Note that it is possible to have multiple parameter alarms using the same digital/relay output channel. This allows you to have a single “Master” alarm output that is set if any of the parameters alarms fail. In this mode, you should set the firstparameter alarm that uses the Master alarm output to “Automatic” reset and the remainder to “Manual” reset. When configured in this way, the alarm output is only reset when all of the alarms achieve “Pass” status.

Page 22: Quick Start Guide - IO Module IO Module.pdf · 1. Make sure the cFP network module and I/O modules are powered and ready (the “Power” and “Status” LEDs on each module should

16 Using The Analog & Digital Output ModuleDiablo EZReporter Analog & Digital Output Module Quick Start Guide

The I/O Channels Tab and Real-Time Channel DisplayOnce you have configured the Analog & Digital Output Module and associated Monitored Parameter analog outputs or digital alarms, you can monitor the status of all of the output channels on the Real-Time Channel Display of the main I/O Channels Tab.

The Real-Time Channel Display

The following table describes the fields that are displayed in the Real-Time Channel Display.

Field Description

# The I/O Channel number.

Description The channel description that was entered when the channel was added to the configuration.

Type The type of output channel (analog or digital).

Bank The physical bank in the network module backplane that the I/O module for this channel resides in.

Channel The channel number in the specified output module.

Status The current status of the output channel.

Value The current/last value written to the output channel.

Page 23: Quick Start Guide - IO Module IO Module.pdf · 1. Make sure the cFP network module and I/O modules are powered and ready (the “Power” and “Status” LEDs on each module should

Diablo EZReporter Analog & Digital Output Module Quick Start GuideUsing The Analog & Digital Output Module 17

Field Description

Max. Value The maximum value that can be written to the output channel.

Min. Value The minimum value that can be written to the output channel.

Quality The data quality of the current/last value. The Quality should be 0 unless a Quality Error has occurred. See “Quality Errors” on page 24 for more information.

Message The last informational message received by the data socket from the network module for this channel. If the channel “Status” is “Error”, then the message field will contain the error message, which may be useful in troubleshooting the error.

Connecting and Disconnecting the I/O Channels

In order for the EZReporter Analog & Digital Output Module to update the output channels when processing results, an active data socket connection must have been made to each configured channel. You can initiate a data socket connection by clicking the “Connect” button. If connections are made to all channels successfully, then the I/O Module status will change from “Connecting” to “Active” (see “I/O Module Status” on page 18 for additional I/O module status information).

If you want to continue to process results with EZReporter but don’t want to update the output channels, then click the “Disconnect” button. Any active connections to I/O channels will be terminated and the channels will not be updated when EZReporter processes results subsequently.

Important: Important: Whenever you open the EZReporter configuration editor, the I/O Module will automatically disconnect from all I/O Channels. You will have to reconnect once you have exited the configuration editor.

Page 24: Quick Start Guide - IO Module IO Module.pdf · 1. Make sure the cFP network module and I/O modules are powered and ready (the “Power” and “Status” LEDs on each module should

18 Using The Analog & Digital Output ModuleDiablo EZReporter Analog & Digital Output Module Quick Start Guide

I/O Module Status

The following table summarizes the possible I/O Module status values.

I/O Status Description

The EZReporter I/O Module is not connected to any of the analog or digital output channels. When EZReporter processes results, the I/O channels will not be processed and no error will be generated.

The “Connect” button has been pressed and EZReporter is attempting to open a data socket connection to each of the analog and digital output channels. Don’t try to process results until the connection status has changed to “Active”.

A data socket connection has been made successfully to all analog and digital output channels. When EZReporter processes results, the output channels will be updated automatically based on the individual Monitored Parameter settings.

One or more of the analog or digital output channels has reported a Socket Error. You should troubleshoot and correct this error before processing additional results. See “Socket Errors” on page 23 for more information.

One or more of the analog or digital output channels has reported a Quality Error. You should troubleshoot and correct this error before processing additional results. See “Quality Errors” on page 24 for more information.

Page 25: Quick Start Guide - IO Module IO Module.pdf · 1. Make sure the cFP network module and I/O modules are powered and ready (the “Power” and “Status” LEDs on each module should

Diablo EZReporter Analog & Digital Output Module Quick Start GuideUsing The Analog & Digital Output Module 19

I/O Status Description

This status usually means that you haven’t defined the I/O hardware configuration and/or added any I/O channels to the EZReporter I/O Module configuration.

Manual Control of Output Channels

You can write values manually to any configured output channel by double clicking on the desired channel in the Real-Time Channel Display on the I/O Module tab. There must be an “Active” connection to the I/O Channel for the feature to be enabled. A different window will be displayed depending on whether the selected channel is an analog or digital/relay output channel. Press the “Exit” button when you have finished writing new values to the output channel.

Write to Analog Output Channel

The following window is displayed to write a value manually to an analog output channel. Enter the new value into the “Value” text box and then click the “Write” button. The new value will be written to the specified analog output channel immediately. Note that if the value you write is either greater than the “Max Value” or less than the “Min Value” listed in the “Channel Information” table, it will be adjusted automatically to the maximum value or minimum value, respectively.

Write to Digital/Relay Output Channel

The following window is displayed to write a value manually to a digital/relay output channel. To change the value of the digital/relay output, simply click the “On” or “Off” button. The new state will be written to the specified digital/relay output channel immediately. Note that “On:” means “True”, “High”, or “Closed”, while “Off” means “Off”, “Low”, or “Open”.

Page 26: Quick Start Guide - IO Module IO Module.pdf · 1. Make sure the cFP network module and I/O modules are powered and ready (the “Power” and “Status” LEDs on each module should

20 Troubleshooting Diablo EZReporter Analog & Digital Output Module Quick Start Guide

Troubleshooting

Test the ConfigurationYou can test your network module, I/O module, and networking configuration by clicking the “Test” button on the EZReporter Compact FieldPoint Configuration window. This displays the “Test I/O Module Configuration” window. Click the “Start” button to begin the configuration test.

Page 27: Quick Start Guide - IO Module IO Module.pdf · 1. Make sure the cFP network module and I/O modules are powered and ready (the “Power” and “Status” LEDs on each module should

Diablo EZReporter Analog & Digital Output Module Quick Start Guide Troubleshooting 21

The test progress will be updated in the “I/O Configuration Test Results” table. If you want to cancel the configuration test, click the “Cancel” button. The test will be cancelled after the current test is complete. Descriptions of each of the configuration tests are included below along with instructions on how to troubleshoot failed tests.

Examples of Configuration Test Windows

The following are examples of configuration test dialogs for a test in progress, a passed test, and a failed test:

Test in Progress:

This screen capture shows the configuration test window with the test in progress. Note that the “Start” and “Exit” buttons are disabled. You must “Cancel” the test in progress before starting a new test or exiting the test window.

The Configuration Passed All Tests:

This is the test window after all tests have been completed and all tests have passed.

Page 28: Quick Start Guide - IO Module IO Module.pdf · 1. Make sure the cFP network module and I/O modules are powered and ready (the “Power” and “Status” LEDs on each module should

22 Troubleshooting Diablo EZReporter Analog & Digital Output Module Quick Start Guide

The Configuration Failed One or More Tests:

This is the test window after all tests have been completed and one or more tests have failed. In this case the connect test failed with “Quality” errors for both I/O modules.

Network Module Ping Test

This test simply “pings” the IP address specified in the I/O Module configuration to see if a device responds at that address.

If This Test Passes: It simply means that there is a device responding at the specified IP address. The device could be the Compact FieldPoint network module, but could also be another computer on the network.

If This Test Fails: It means that no device can be found at that IP address. This could be due to any of the following:

Page 29: Quick Start Guide - IO Module IO Module.pdf · 1. Make sure the cFP network module and I/O modules are powered and ready (the “Power” and “Status” LEDs on each module should

Diablo EZReporter Analog & Digital Output Module Quick Start Guide Troubleshooting 23

1. The Compact FieldPoint network module is not powered up or completely booted up. If you just applied power to the network module, wait several seconds and then perform the test again. The “Power” LED on the network module should be green, and the “Power” and “Ready” LEDs on each I/O module should also be green.

2. The specified IP address is incorrect. This could happen if you configured the Compact FieldPoint network module to receive its IP address via a DHCP server, and the server changed it. The best way to troubleshoot this problem is to open the National Instruments Measurement and Automation Explorer (MAX) and click on the Compact FieldPoint unit under the “Remote Systems” branch. Check to see what IPv4 address is assigned to the unit.

3. The network cabling is incorrect: Check the network cables between the computer and the Compact FieldPoint network module. If they are connected through a network switch, make sure the switch is powered.

Network Module Connect Test

This tests attempts to make a data socket connection to the Compact FieldPoint network module.

If This Test Passes: It means that a Compact FieldPoint network module was found at the specified IP address.

If This Test Fails: It means that a Compact FieldPoint network module was not found at the specified IP address. This is could be due to any of the following:

1. The device at the specified IP address is not a Compact FieldPoint network module. Follow the instructions above for using the National Instruments Measurement and Automation Explorer to confirm the IP address being used by the network module.

Network Module Read Test

This test reads the firmware version from the Compact FieldPoint network module.

If This Test Passes: It means that the Compact FieldPoint network module is communicating and responding as expected.

If This Test Fails: It means that the Compact FieldPoint network module returned an invalid or unexpected response. Contact Diablo Analytical support.

I/O Module Module Connect Test

If all of the Compact FieldPoint network module tests passed, then each I/O module defined in the configuration module table will be tested by attempting to make a connection to Channel 00 of the module.

If This Test Passes: It means that the I/O module was found and is configured correctly.

If This Test Fails: It means that the I/O module either wasn’t found, or it is not configured correctly. The error message displayed will provide an indication of the cause of the failure:

1. A “Quality” failure may indicate that you have a module assigned to an empty bank in the I/O module configuration, or the type of module assigned to the bank is incorrect.

2. A “Connection Status” failure may indicate a problem with the network connection between the computer and Compact FieldPoint network module.

Socket ErrorsSocket errors are usually caused by problems with networking and communication with the Compact FieldPoint network module. An error message will usually be displayed in the “Message” column of the I/O Module channel table to help with your troubleshooting.

Page 30: Quick Start Guide - IO Module IO Module.pdf · 1. Make sure the cFP network module and I/O modules are powered and ready (the “Power” and “Status” LEDs on each module should

24 Troubleshooting Diablo EZReporter Analog & Digital Output Module Quick Start Guide

The best way to troubleshoot Socket Errors is to run the I/O module configuration test. If either the “Network Module Ping Test” or “Network Module Connect Test” fails, then you likely have a problem with networking.

Quality ErrorsQuality errors are usually associated with bad data quality being generated by a particular I/O channel. The actual value of the Quality Error may or may not be helpful in determining the cause of the problem. However, it is worth recording the non-zero Quality value and provide it to support. The following are the most common causes of Quality Errors:

1. In the I/O module configuration you have assigned an incorrect module type to a particular bank or have assigned a module type to an empty bank.

2. The network module has detected a problem with the output channel. For example if the output channel is a current loop output, then a quality error will be generated if the output is an open circuit and not properly connected to a load.

3. A network communication problem has occurred since making the original connection. Generally this will also result in a “Socket Error”.

Page 31: Quick Start Guide - IO Module IO Module.pdf · 1. Make sure the cFP network module and I/O modules are powered and ready (the “Power” and “Status” LEDs on each module should

Diablo EZReporter Analog & Digital Output Module Quick Start Guide Troubleshooting 25

Debug LoggingIf you enable debug logging, the EZReporter Analog & Digital Output module will log data socket communication commands and responses sent between EZReporter and the Compact FieldPoint modules to the file, ‘cfp_debug.log’, which is created in the EZReporter installation folder.

After collecting a debug log, the easiest way to send it to support personnel is to save the current EZReporter configuration and log files to a backup zip file using the EZReporter, “Tools | Backup Current Configuration Files…” menu option. Simply e-mail the resulting Zip file to support personnel.

Important: Important: This option should not be enabled unless you are troubleshooting a specific problem and it should be disabled once you have collected the log file. A status window is displayed on the main I/O Module tab to remind you when debug logging is enabled.

Page 32: Quick Start Guide - IO Module IO Module.pdf · 1. Make sure the cFP network module and I/O modules are powered and ready (the “Power” and “Status” LEDs on each module should
Page 33: Quick Start Guide - IO Module IO Module.pdf · 1. Make sure the cFP network module and I/O modules are powered and ready (the “Power” and “Status” LEDs on each module should

Diablo EZReporter Analog & Digital Output Module Quick Start Guide Index 27

Index

A

Add Analog and Digital Output Channels to the Configuration 11

C

Configuring Analog Output Zero and Span 13Configuring Compact FieldPoint 4Configuring the EZReporter Analog & Digital Output

Module 8Connecting and Disconnecting the I/O Channels 17

D

Debug Logging 25Define the Compact FieldPoint I/O Hardware

Configuration 9

E

Enable Debug Logging (optional) 12Enable the Data Ready Output Pulse (optional) 12Examples of Configuration Test Windows 21

H

Hardware and Software Requirements 2

I

I/O Module Module Connect Test 23I/O Module Status 18Installation and Configuration 3Installation and Configuration Checklist 3Installing the Compact FieldPoint Driver Software 3Installing the EZReporter Analog & Digital Output

Module 7Introduction 1

M

Manual Control of Output Channels 19

N

Network Module Connect Test 23Network Module Ping Test 22Network Module Read Test 23

O

Overview of the EZReporter Analog & Digital Output Module 1

Q

Quality Errors 24

R

Resetting the Digital Alarm Output 15

S

Socket Errors 23

T

Test the Compact FieldPoint Configuration 10Test the Configuration 20The I/O Channels Tab and Real-Time Channel Display

16Troubleshooting 20

U

Using Analog Result Outputs 13Using Digital Alarm Outputs 14Using The Analog & Digital Output Module 13