Alicat Scientific EtherNet/IP User manual

EtherNet/IP
OperatingBulletin
The Fastest Flow Controller Company in the World!

2/06/2019 Rev3 DOC-MAN-ETHERNET-IP
RECALIBRATION
Your Alicat instrument is a precision device and Alicat strongly
recommends that you send it to us on a yearly basis for recalibration.
A yearly recalibration does a few things:
►It ensures that your unit is functioning according to specication.
►Contamination may cause the instrument to measure ow
improperly. Recalibration ensures the instrument is clean and free of
debris.
►Recalibration maintains your LIFETIME WARRANTY!
Sending your unit for recalibration is easy and inexpensive. Recalibrations
are usually shipped within ve days of receipt, so it’s fast too.
Please keep the original box to return your Alicat instrument for recalibration.
FULL TECHNICAL SUPPORT | LIFETIME WARRANTY

3
ALICAT EtherNet/IP™ OPERATING BULLETIN
Table of Contents
Physical Design and User Interface_____________________________4
Physical Packaging.
Ports and Status Lights.
Communications Menu Changes
EtherNet/IP™ Communication ________________________________5
Explicit Messaging I/O
Assembly 100 - Setpoint
Assembly 101 - Device Readings
Mass FlowController Default
Mass FlowMeter Default
Pressure Gauge Default
Pressure Controller Default
Assembly 102-104 - Device Commands
COMPOSER™ Personalized Mixed Gas Compositions
Network Conguration____________________________________12
IP Address Conguration
Conguring a Network Card for DHCP Operation.
Assigning an IP Using Rockwell Automation’s BootP-DHCP Tool.
Assigning an IP using TFTPD64
Assigning a Static IP
UsingThe Embedded Webserver _____________________________16
The Home Page:
The Data I/O Page
The Network Cong Page
The Device Cong Page
Rockwell PLC Setup ______________________________________19
Determining Assembly 101 Input Size
Creating an Alicat Module
Creating a Module from the EDS
Creating a Generic Ethernet Module
Formatting I/O Data
Changing The Setpoint
Sending a Command

4
ALICAT EtherNet/IP™ OPERATING BULLETIN
Physical Design and User Interface
This operating bulletin is designed to be used in conjunction with a manual for your
type of Alicat device. Physical manuals are usually provided with your device. Digital
copies can also be downloaded at our website at www.alicat.com/manuals.
Physical Packaging
Alicat EtherNet/IP devices have taller electronics assemblies to accommodate
the communications adapter that enables Ethernet/IP control. CAD les for
your specic device are available and can be obtained by contacting an Alicat
applications engineer.
Ports and Status Lights
All Alicat EtherNet/IP™ devices come equipped with two RJ45 ports, located on top
of the device. These can be used to daisy chain devices or establish a ring topology
network. Both ports can be used interchangeably to connect the device to a network.
When an active link is established on a port the yellow link LED on that port will light
up.The green data IO LED will ash when data is being transmitted over that link.
Additionally there are two multicolored red/green LEDs opposite the power jack,
the MOD and Net LEDs. These indicate specic things about your system status as
indicated by the table below:
LED status MOD LED NET LED
O Device not Powered No IP Address Assigned
Steady Green Device Operational Ethernet/IP connection
established.
Steady Red Major System Fault Duplicate IP conict
Flashing Red Minor System Fault Connection Timed Out
Flashing Red/Green Self-Test Self Test

5
Communications Menu Changes
Ethernet/IP devices will have a slightly dierent communications menu than the one
indicated by the operating manual for your device.
To access this menu from the front panel of the device press MENU> ADV SETUP >
COMM STATUS. This menu will display network status information and can be used to
troubleshoot/diagnose communications issues.
EtherNet/IP™ Communication
Alicat devices support the EtherNet/IP™ protocol as a communications adapter (device
type 12). The following sections describe the data format available through CIP explicit
messages or cyclic I/O.The EDS for your Alicat device can be downloaded directly from
the CIP le object (Class 0x37, Instance 200) or from alicat.com/eip.
Explicit Messaging I/O
The following objects and attributes are supported. All objects support the Get_Attribute_
Single and Set_Attribute_Single service in addition to any other specied services.
Identity Object - Class 1, Instance 1
Attrib Name Type Access Comment
1 Vendor ID UINT Get 1174
2 Device Type UINT Get 12
3 Product Code UINT Get 2
4 Revision STRUCT Get Major.Minor
5 Status WORD Get
6 Serial Number UDINT Get
7 Product Name STRING Get
Message Router - Class 2, Instance 1
Attrib
Name Type Access Comment
1
Object list STRUCT Get
2
Number available UINT Get

6
Assembly Object - Class 4
Attrib Name Type Access Comment
3 Data ARRAY Get/Set See instance
descriptions below
4 Size USINT Get Size of attrib 3
See the following sections for a list of supported assemblies.
Connection Manager - Class 6, Instance 1
Attrib Name Type Access Comment
1 Open Requests UINT Set
2 Open Format Rejects UINT Set
3 Open Resource Rejects UINT Set
4 Open Other Rejects UINT Set
5 Close Requests UINT Set
6 Close Format Rejects UINT Set
7 Close Other Rejects UINT Set
8 Connection Timeouts UINT Set
Connection Manager Services
Code Name Description
0x4E Forward_Close Closes a connection.
0x52 Unconnected_Send Unconnected message request.
0x54 Forward_Open Opens a connection.
0x5A Get_Connection_Owner Returns data about a connection.
0x5B Large_Forward_Open Opens a connection.
Assembly 100 - Setpoint
The device setpoint should be sent as a 32-bit IEEE oating point value. Setpoint is
ignored on devices without a controller.
Setpoint - Class 4, Instance 100, Attribute 3
Parameter Type Comment
Setpoint REAL

7
Assembly 101 - Device Readings
Your Alicat device can output up to 20 dierent data statistics depending on
the device’s conguration. Default statistics for each device type are specied in
sections 1.3.1 through 1.3.4 below. Each statistic present will increase the size of
the assembly. Assembly size can be determined by doing an explicit messaging
read of the assembly size attribute – class 4, instance 101, attribute 4.
The congured data statistics for assembly 101 can be viewed by directly
connecting to the embedded web server of the device and clicking on the tab
labeled“Data IO”. (See page 12 for information on assigning an IP and connecting
to the web server.)
Thevaluereturnedforapressurereadingcanbeabsolutepressure,gauge pressure
ordierentialpressure,dependingonyourdevice’sconguration. If you wish to
customize the format and the displayed readings of your device, please speak to
an Alicat applications engineer.
Device status conditions in the device are specied below. Values in parenthesis are
displayed on the display panel of the device. The device status is output as a 32-bit
DWORD. At the present time, bits 13-31 are reserved and should read as zero.
Bit Description
0 Temperature Overow (TOV)
1 Temperature Underow (TOV)
2 Volumetric Overow (VOV)
3 Volumetric Underow (VOV)
4 Mass Overow (MOV)
5 Mass Underow (MOV)
6 Pressure Overow (POV)
7 Totalizer Overow (OVR)
8 PID Loop in Hold (HLD)
9 ADC Error (ADC)
10 PID Exhaust (EXH)
11 Over Pressure Limit (OPL)
12 Flow Overow During Totalize (TMF)

8
Mass Flow Controller
Reading Number Statistic
1 Pressure
2 Flow Temperature
3 Volumetric Flow
4 Mass Flow
5 Mass Flow Setpoint
6 Mass Total*
Mass Flow Meter
Reading Number Statistic
1 Pressure
2 Flow Temperature
3 Volumetric Flow
4 Mass Flow
5 Mass Total*
Pressure Gauge
Reading Number Statistic
1 Pressure
Pressure Controller
Reading Number Statistic
1 Pressure
2 Pressure Setpoint
* Mass total will only appear on devices congured with a totalizer.

9
Assembly 102-104 - Device Commands
CommandsareissuedtoyourAlicatdevice through assemblyinstance 102.Acommand
isinitiatedonawritetoinstance102.Theresultof the lastcommand can be thenberead
in instance 103.
Command Request - Class 4, Instance 102, Attribute 3
Parameter Type Comment
Command ID UINT See Page 10 For Valid Commands
Command Argument UINT
Command Result - Class 4, Instance 103, Attribute 3
Parameter Type Description
Command ID UINT ID of last command.
Command Status UINT Status of last command.
Please note that commands are processed when the values in instance 102 change.
Passing repeated, identical command IDs and arguments to instance 102 will not
change the value, so these commands will be ignored. To send sequential identical
commands zeros should passed to instance 102, attribute 3 between commands.
If you are using Alicat’s provided add-on instruction sets (see page 13), then this
procedure is handled automatically.
A table of commands can be found on the next page. Depending on your device’s
rmware version and conguration, not all commands will be valid. Your device’s
rmware version and other device information can be found by accessing the
“Device Info”tab on the device’s internal webserver. See page 13 for more details.

10
CmdID Action Argument Notes
1 Change Selected
Gas 0 to 255 – Selected Gas Index
Gas select commands only valid on
mass ow instruments.
2 Gas Mix 0 – Use Next Open
Index Position
236 to 255 – Specify a
mix index
Creates or updates a custom gas mix
calibrations from inputs to instance
104 attribute 3 (see page 11).
3 Delete Gas
Mixture 236-255 – Mix Index
Will not allow deletion of non-custom
gas mixtures.
4 Tare 0 – Tare Pressure
1 – Tare Absolute
Pressure
2 – Tare Flow
Argument 0 only valid for gauge
and dierential pressure devices.
Argument 1 only valid for devices
with –IB part number. Argument 2
only valid for ow instruments.
5 Reset Totalizer 0 – No Argument
Necessary Only valid for mass or liquid ow instruments with a totalizer.
6 Valve Hold 0 – Cancel Current
Holds
1 – Hold Valves Closed
2 – Hold Valves at
Current Position
3 – Hold Exhaust Valve
Open
Only valid for controllers. Hold
commands stop all closed loop valve
control. Argument 3 is only available on
multi-valve instruments.
7 Display Lock 0 – Lock Display
1 – Unlock Display Only valid for devices with displays. Locking the display prevents changing
device settings from the front panel.
Menus can still be navigated and settings
viewed with display locked.
8 Set PID
Proportional Gain 0 to 65535 – P Gain PID settings only valid for controllers.
9 Set PID
Dierential Gain 0 to 65535 – D Gain PID settings only valid for controllers.
10 Set PID Integral
Gain
0 to 65535 – I Gain Integral value only valid when using PD2I
algorithm. See user manual for details.
11 Set PID Loop
Variable
0 – Mass Flow
1 – Volumetric Flow
2 – Dierential
Pressure
3 – Absolute Pressure
4 – Gauge Pressure
Depending on the available sensor
inputs, not all loop variables will be
available.
12 Save Power-Up
Setpoint
0 – No Arguments Save current setpoint to EEPROM.
EEPROM has limited write cycles. Avoid
code loops which generate fast, repeated
EEPROM writes. Only valid for controllers.
13 Set PID Loop
Algorithm
0 – Use PDF
algorithm
1 – Use PD2I
algorithm
Only valid for controllers with
rmware version 7v08 or greater. PDF
recommended for single valve devices.
PD2I recommended for dual valve
devices.
14 Read PID value 0 – Return P Gain
1 – Return D Gain
2 – Return I Gain
Only valid for controllers with rmware
version 7v08 or greater. After command
is sent the values can read as the
command status from instance 103,
attribute 3.
15 Select Active
Valve
0 – Select Valve 1
1 – Select Valve 2
Only valid for MCT series 3 valve
controllers with rmware versions 7v16
or higher.

11
Status Description
0
Success
0x8001 Invalid command ID
0x8002 Invalid setting
0x8003 Requested feature is unsupported
0x8004 Invalid gas mix index
0x8005 Invalid gas mix constituent
0x8006 Invalid gas mix percentage
0x0001 to
0xFFFF
Process value. Command 14 will return current PID values in
hexadecimal format as command status values. These may overlap
status codes depending on the value.
COMPOSER™ Personalized Mixed Gas Compositions
Custom gas mixtures can be congured with 2-5 gases using the mix assembly. The
mix is a two-step process. First, the desired constituent gas indexes and percentages
mustbewrittentothe mixassembly followedbyawriteof the Mix Gas command (ID 2)
into command assembly. Assembly 104 accepts a 20 byte input, structured according
to the following table:
Gas Mix - Class 4, Instance 104, Attribute 3
Parameter Type Notes
Mixture Gas 1 Index UINT
Mixture Gas 1 % UINT
Mixture Gas 2 Index UINT
Mixture Gas 2 % UINT
Mixture Gas 3 Index UINT
Mixture Gas 3 % UINT
Mixture Gas 4 Index UINT
Mixture Gas 4 % UINT
Mixture Gas 5 Index UINT
Mixture Gas 5 % UINT
All 20 bytes must be passed to the assembly, and all gas indexes must be valid gas
index numbers. See product manual for a list of indices. A combination of mixtures
can be created by using an existing gas mixture index, 236-255. However, the accuracy
of the ow calculations may degrade with complex mixtures of gases with dissimilar
chemical properties.
Gas mix percentages are interpreted as integer hundredths of a percent and the total
percentage must sum to 100%.The mix will be performed with the rst N gases that
have a non-zero percentage.
Once a valid gas mixture is dened in assembly 104, a new gas mixture index will be
created by passing command id 2 to instance 102, assembly 3. If one of the requested
mix gas indices does not exist, or the sum of gas percentages does not equal 100%, an
error will be returned in assembly 103 and the command will fail.

12
If the command argument passed with the mix command is 0, the new gas mix index
will be stored in the next empty index, starting at 255 and working down to 236. If
all gas mix indices are in use, the command will fail and an error will be returned in
assembly 103. If the command argument passed is between 236 and 255, the specied
index will be either created or updated to the new composition. If the index specied
is not valid (the command argument is neither 0 nor 236-255), the command will fail
and an error will be returned in assembly 103.
For example, to create a mixture of 50% argon (gas index 2), 25% nitrogen (gas index
9), and 25% oxygen (gas index 11) and assign it to gas index 244, pass the following
input to assembly 104, attribute 3:
Parameter Value Notes
First Gas Index (byte oset 0) 2 Argon Index
First Gas Percent (byte oset 2) 5000 In 100ths of a %
Second Gas Index (byte oset 4) 9 Nitrogen Index
Second Gas Percent (byte oset 6) 2500 In 100ths of a %
Third Gas Index (byte oset 8) 11 Oxygen Index
Third Gas Percent (byte oset 10) 2500 In 100ths of a %
Fourth Gas Index (byte oset 12) 1 Any valid gas index
Fourth Gas Percent (byte oset 14) 0 0% values ignored
Fifth Gas Index (byte oset 16) 1 Any valid gas index
Fifth Gas Percent (byte oset 18) 0 0% values ignored
Network Conguration
Alicat devices have two 10/100Mbps Ethernet ports with an embedded switch.
Either port can be used in a star topology network conguration. For linear or ring
topologies, one port can be used as the input and one port as the output to daisy
chain devices together. Device Level Ring (DLR) is also supported to build failsafe
network rings.
IP Address Conguration
The out-of-the-box conguration of your device uses DHCP to obtain an IP address.
The IP settings can be changed using either the TCP/IP CIP object or through the
device’s embedded web server. To do so, you must rst assign an address using DHCP.
Conguring a Network Card for DHCP Operation
All the following instructions rely on a network interface with a static IP address
being available to the Alicat device. To assign a static IP, rst open the settings for the
network adapter you are using to interact with your PLC network or device and assign
a static IP/ disable DHCP.
In Windows, navigate to the control panel, select“View Network Connections”, right
click the icon of the network adapter you are using, and click“Properties”. Within the
properties window scroll through the list of installed protocols and nd the entry
“Internet Protocol Version 4”. Click it, and click“Properties”to open the following window:

13
Assign a static IP by selecting“use the following IP addres”and typing in the desired IP
address and subnet mask.
Assigning an IP using Rockwell Automation’s BootP-DHCPTool
Disable or disconnect all network interfaces, except for the interface you are using as
your DHCP server. Then launch the BootP-DHCP tool from the start menu.
The rst time this software is launched, you will be prompted to enter your network
settings. At a minimum, you will need to dene a Subnet mask, which will be the same
mask you dened in previous section. In our example the mask value of 255.255.255.0 was
used. Once your network settings are entered, click“OK”to return to the main window.
In this window, double click the MAC address of the Alicat you wish to assign an IP.
On the next screen enter an IP address and click OK. Hostname and description are
optional. The MAC address of your Alicat device can be found on the calibration
sticker on the back of the device.

14
Assigning an IP using TFTPD64
This example uses the open sourceTftpd64 tool available at tftpd32.jounin.net.
Launch Tftpd64 and click the settings button in the lower middle of the screen. From
the newly launched settings window, click the DHCP tab.
The settings pictured in this screenshot congure the DHCP server on an adapter
with a static IP of 192.168.2.10.
Once TFTPD is congured as a DHCP server, connect your Alicat directly to the same
network as the PC and adapter running TFTPD, and supply power to the Alicat. After a
few moments, an address should be allocated to the device by the DHCP server.

15
Assigning a Static IP with EIP Tools
If DHCP is left enabled on the Alicat, then a new IP address will need to be assigned
every time the device is power cycled. To prevent this, disable DHCP and assign a static
IP address to the device.
The following shows how to use EIP_Tools, a free program available from molex, to
send EIP explicit messages to the device and disable DHCP.
Launch EIP tools from the start menu. Enter the Alicat’s IP address in the station eld at
the top left, and click on the tab labelled 0xF5 TCP/IP. From here, click Get_Attribute_
All to populate the elds with the device’s current settings:
To disable DHCP, click the Stored Value radio button within the attribute 3 pane and
click Set_Attribute.
To assign a new IP address to the Alicat, enter your desired IP address, subnet mask, and
gateway in the interface conguration pane of the window and click Set_Attribute.
Any changes to theTCP/IP object will take eect after power cycling the device.
The network conguration can also be changed using the device’s embedded
webserver, as illustrated in the next section.

16
Using the EmbeddedWebserver
All Ethernet/IP devices host an embedded webserver. This webserver provides
identication and conguration information about your Alicat device. You can also use
it to change some device settings.
To access this webserver, open a browser window from a PC on the same network as your
Alicat device, and enter the IP address of the device you wish to connect to in the address
bar. On connecting to the embedded webserver, the home page will load by default.
The Home Page
The home page gives some networking and troubleshooting information.The
information here is largely for troubleshooting purposes, but the rmware version can
be used to identify valid commands as dened in section 1.4.

17
The Data I/O Page
This page lists the structure of several control assemblies and denes various device
status codes.
If you are conguring a PLC or other program to read the device’s parameters, the
size and structure of assembly 101 can be determined from this screen. Parameters of
type REAL and UDINT are 4 byte parameters. Parameters of type UINT are 2 bytes. By
summing the byte size of all the parameters listed in assembly 101, the data assembly
size can be manually calculated.

18
The Network Cong Page
This page lists the current IP and DHCP settings of your Alicat. If you prefer to disable
DHCP or assign a new IP address from this page rather than by explicit messaging,
simply type in your new desired values, click the DHCP checkbox to toggle the device’s
DHCP state, and click update.
The Device Cong Page
This page can be used to read and write specic, low level conguration settings of
your Alicat. The Alicat serial communications primer (alicat.com/documents/Alicat-
Serial-Primer.pdf) describes the function of common user-congurable registers.
Writing settings to the device can invalidate your calibration, disable communication,
or even permanently damage your device. Do not write registers without a rm
understanding of the changes you are making.

19
Rockwell PLC Setup
This section shows how to setup an Alicat mass ow controller using a Rockwell
ControlLogix PLC.These instructions will work for other types of Alicat device with
simple alterations. In this example it is assumed that the EtherNet/IP scanner has
already been congured and assigned an IP on the 192.168.2.0 subnet.
Alicat provides an Electronic Data Sheet (EDS) as well as Logix XML les with Add-On
Instructions (AOIs) which can be imported into Rockwell’s Logix designer in order to
assist connecting to your device and mapping IO data. These can be downloaded from
the Alicat website at alicat.com/eip.
Determining Assembly 101 Input Size
As mentioned in section 1.3 above, the size and contents of input assembly 101 vary
depending on the conguration of your Alicat device. In order to create a connection
you will need to dene the correct input size in the connection parameters. If this is
not done, you will receive an“Invalid Input Size”communications fault from the PLC.
This value can be determined from the internal webserver. (See page 17), or by explicit
messaging using EIP Tools or RSNetWorx. The assembly size attribute is attribute 4. An
explicit message, 0x0E: Get Attribute Single sent to path class 4, instance 103, attribute
4 will return the assembly size in hex format.
The following example shows how to use RSNetWorx to determine the assembly size.
Launch RSNetworx from the computer you are using to manage your PLC. Add the
Alicat to your network tree (your scanner should add itself automatically). Then right
click on the Alicat device in your network tree and select“Class Instance Editor…”
Execute a Get Single Attribute call as shown below. Note that the instance value needs
to be in hex format (instance 101 is 16#65). The returned value is a 2 byte unsigned integer.

20
Creating an Alicat Module
There are two options for creating the Alicat device module in Logix. One is to create
the device as a Generic Ethernet Module. The other is to import the Alicat EDS le and
make an Alicat EtherNet/IP Adapter.
Creating a Module from the EDS
In order to create an Alicat IO device module, you must rst import the device EDS le.
The EDS is available on the Alicat website at alicat.com/eip.
Once you have the EDS, it can be imported into RSLogix under Tools -> EDS Hardware
Installation Tool.