ICP DAS USA I-8124W User manual

I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04 1
I-8124W
DeviceNet Master Module
User’s Manual
Warranty
All products manufactured by ICP DAS are warranted
against defective materials for a period of one year from the
date of delivery to the original purchaser.
Warning
ICP DAS assumes no liability for damages consequent
to the use of this product. ICP DAS reserves the right to
change this manual at any time without notice. The
information furnished by ICP DAS is believed to be accurate
and reliable. However, no responsibility is assumed by ICP
DAS for its use, or for any infringements of patents or other
rights of third parties resulting from its use.
Copyright
Copyright 2010 by ICP DAS Co., LTD. All rights
reserved worldwide.
Trademark
The names used for identification only may be
registered trademarks of their respective companies.

I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04 2
Revision
Version
Firmware
Version
Date
Author
Description
1.6
2.1
2021/
10/04
Johney
Add new function
1. I8124_DisableKeepAliveMsg
1.5
1.8
2013/
10/01
Johney
1. Update the CAN pin description
and CAN bus wire connection.
1.4
1.8
2013/
06/11
Johney
Add new function
1. I8124_GetAttributeW
2. I8124_SetAttributeW
3. I8124_SendExplicitMSG_W
1.3
1.7
2012
01/04
Johney
Fix function
* I8124_ImportEEPROM
1.2
1.6
2011
01/10
Johney
Add new functions
* I8124_ReadInputArea
* I8124_WriteOutputArea
* I8124_ReadbackOutputArea
1.1
1.0
2010
05/25
Johney
Update the CAN pin
description
1.0
1.0
2010
03/28
Johney
This manual is for the I-
8124W module.

I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04 3
Contents
REVISION........................................................................................................................2
1. GENERAL INFORMATION.................................................................................6
1.1 DEVICENET INTRODUCTION........................................................................................6
1.2 DEVICENET APPLICATIONS.........................................................................................8
1.3 I-8124WWITH VENDOR’S DEVICENET SLAVES............................................................9
1.4 I-8124WARCHITECTURE..........................................................................................10
1.5 DEVICENET MASTER WORKING PROCEDURE.............................................................11
1.6 I-8124WFIRMWARE CHARACTERISTICS ....................................................................14
1.7 FEATURES................................................................................................................16
1.8 BLOCK DIAGRAM......................................................................................................17
1.9 PRODUCT CHECK LIST .............................................................................................18
2. HARDWARE CONFIGURATION......................................................................19
2.1 BOARD LAYOUT........................................................................................................19
2.2 JUMPER SELECTION..................................................................................................20
2.3 CONNECTOR PIN ASSIGNMENT..................................................................................21
2.4 WIRE CONNECTION...................................................................................................22
2.5 INDICATOR LED.......................................................................................................24
2.5.1 NS LED (Red)..................................................................................................24
2.5.2 RUN LED (Green) ..........................................................................................24
2.5.3 MS LED (Yellow)............................................................................................25
2.6 UPDATE THE I-8124W’S FIRMWARE..........................................................................26
3. FLOW CHART FOR DEVICENET APPLICATION.......................................29
3.1 FLOW CHART FOR SEARCHING DEVICES....................................................................31
3.2 FLOW CHART FOR SLAVE CONFIGURATION................................................................32
3.3 FLOW CHART FOR ON-LINE ADDING/REMOVING DEVICE...........................................33
3.5 FLOW CHART FOR “SETATTRIBUTE”AND “GETATTRIBUTE”.....................................35
3.6 FLOW CHART FOR I/O CONNECTION.........................................................................36
3.7 INPUT AND OUTPUT I/O DATA AREA (ADVANCED OPTION)........................................37
4. FUNCTION DESCRIPTION ...............................................................................40
4.1 DLL FUNCTION DEFINITION AND DESCRIPTION........................................................41
4.2 FUNCTION RETURN CODE ........................................................................................45
4.3 FUNCTION DESCRIPTION ..........................................................................................49

I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04 4
4.3.1 I8124_TotalI8124Module.............................................................................49
4.3.2 I8124_ActiveModule....................................................................................50
4.3.3 I8124_CloseModule......................................................................................51
4.3.4 I8124_GetDLLVersion.................................................................................52
4.3.5 I8124_GetFirmwareVersion.........................................................................53
4.3.6 I8124_ResetFirmware...................................................................................54
4.3.7 I8124_GetMasterMACID.............................................................................55
4.3.8 I8124_SetMasterMACID..............................................................................56
4.3.9 I8124_GetBaudRate......................................................................................57
4.3.10 I8124_SetBaudRate ....................................................................................58
4.3.11 I8124_GetMasterStatus ..............................................................................59
4.3.12 I8124_GetSlaveStatus.................................................................................60
4.3.13 I8124_StartDevice ......................................................................................61
4.3.14 I8124_StopDevice ......................................................................................62
4.3.15 I8124_StartAllDevice.................................................................................63
4.3.16 I8124_StopAllDevice .................................................................................64
4.3.17 I8124_AddDevice.......................................................................................65
4.3.18 I8124_RemoveDevice ................................................................................66
4.3.19 I8124_AddIOConnection............................................................................67
4.3.20 I8124_RemoveIOConnection .....................................................................68
4.3.21 I8124_GetAttribute.....................................................................................69
4.3.22 I8124_GetAttributeW.................................................................................70
4.3.23 I8124_IsGetAttributeOK ............................................................................71
4.3.24 I8124_GetAttributeValue ...........................................................................72
4.3.25 I8124_SetAttribute......................................................................................73
4.3.26 I8124_SetAttributeW..................................................................................74
4.3.27 I8124_IsSetAttributeOK.............................................................................75
4.3.28 I8124_ClearAllConfig ................................................................................76
4.3.29 I8124_SearchAllDevices ............................................................................77
4.3.30 I8124_SearchSpecificDevice......................................................................78
4.3.31 I8124_IsSearchOK......................................................................................79
4.3.32 I8124_GetSearchedDevices........................................................................80
4.3.33 I8124_GetDeviceInfoFromScanList...........................................................81
4.3.34 I8124_GetScanList .....................................................................................82
4.3.35 I8124_ImportEEPROM..............................................................................84
4.3.36 I8124_ReadInputData.................................................................................85
4.3.37 I8124_WriteOutputData .............................................................................86
4.3.38 I8124_SendExplicitMSG............................................................................87

I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04 5
4.3.39 I8124_SendExplicitMSG_W......................................................................88
4.3.40 I8124_IsExplicitMSGRespOK...................................................................89
4.3.41 I8124_GetExplicitMSGRespValue ............................................................90
4.3.42 I8124_ReadbackOutputData.......................................................................91
4.3.43 I8124_ReadInputArea (Advanced Option).................................................92
4.3.44 I8124_WriteOutputArea (Advanced Option).............................................94
4.3.45 I8124_ReadbackOutputArea (Advanced Option).......................................96
5. DNM_UTILITYCE FOR WP-8000 .......................................................................99
5.1 INTRODUCTION.....................................................................................................100
5.2 TUTORIAL DEMOS.................................................................................................101
5.2.1 Where to find the Hardware Information....................................................101
5.2.2 How to start using the utility.......................................................................102
5.2.3 How to search the slave devices.................................................................103
5.2.4 How to add I/O information into the EEPROM .........................................105
5.2.5 How to remove I/O information from the EEPROM .................................106
5.2.6 How to read/write the I/O data form/to the slave device............................107
5.3 DESCRIPTION OF THE BUTTONS AND FIELDS..........................................................109
5.3.1 Total Module Number ................................................................................109
5.3.2 Slot Number................................................................................................109
5.3.3 Active Module ............................................................................................109
5.3.4 Reset Firmware...........................................................................................109
5.3.5 Search All Device.......................................................................................109
5.3.6 Start All Device ..........................................................................................110
5.3.7 Stop All Device...........................................................................................110
5.3.8 Clear All Device.........................................................................................110
5.3.9 Write Output Data.......................................................................................110
5.3.10 Change Master ID.....................................................................................111
5.3.11 Change Baud Rate ....................................................................................111
5.3.12 Firmware Version.....................................................................................111
5.3.13 Master Status ............................................................................................111

I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04 6
1. General Information
1.1 DeviceNet Introduction
The CAN (Controller Area Network) is a serial communication protocol,
which efficiently supports distributed real-time control with a very high level of
security. It is an especially suited for networking "intelligent" devices as well as
sensors and actuators within a system or sub-system. In CAN networks, there
is no addressing of subscribers or stations in the conventional sense, but
instead, prioritized messages are transmitted. DeviceNet is one kind of the
network protocols based on the CAN bus and mainly used for machine control
network, such as textile machinery, printing machines, injection molding
machinery, or packaging machines, etc. DeviceNet is a low level network that
provides connections between simple industrial devices (sensors, actuators)
and higher-level devices (controllers), as shown in Figure 1.1.
Figure 1.1 Example of the DeviceNet network

I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04 7
DeviceNet is a cost effective solution to one kind application of control
area network. It reduces the connection wires between devices and provides
rapid troubleshooting function. The transfer rate can be up to 500 kbps within
100 meters bus length. The transfer distance can be up to 500 meters in 125
kbps baud (See Table 1.1). It allows direct peer to peer data exchange
between nodes in an organized and, if necessary, deterministic manner.
Master/Slave connection model can be supported in the same network.
Therefore, DeviceNet is able to facilitate all application communications based
on a redefine a connection scheme. However, DeviceNet connection object
strands as the communication path between multiple endpoints, which are
application objects that is needed to share data.
Baud rate (bit/s)
Max. Bus length (m)
500 k
100
250 k
250
125 k
500
Table 1.1 The Baud rate and the Bus length
I-8124W is a DeviceNet master device on the DeviceNet network. It
supports Group 2 only Server and UCMM functions to communication with
slave devices. It has an CAN bus communication port with the ability to cover a
wide range of DeviceNet applications because of the inside CPU. Besides, I-
8124W uses the new CAN controller Phillips SJA1000T and transceiver
82C250, which provide bus arbitration, error detection with auto correction and
re-transmission function. With WinPAC-8000, ViewPAC, and XPAC system, it
is an economic and high performance solution of DeviceNet application. There
are utility tool and demos for I-8124W to help you building your application
quickly. Therefore, it is popularly applied in the industrial automation, building
automation, vehicle, marine, and embedded control network.

I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04 8
1.2 DeviceNet Applications
DeviceNet is the standardized network application layer optimized for
factory automation. It is mainly used in low-volume and mid-volume
automation systems. Some users have also implemented DeviceNet in
machine control systems. The main DeviceNet application fields include the
applications shown below (For more information, please refer to
www.odva.org):
● Production cell builds and tests CPUs ● Dinnerware production
● Beer brewery ● HVAC module production
● Equipment for food packing ● Textile machines
● Fiberglass twist machine ● Trawler automation system
● Sponge production plant ● LCD manufacturing plant
● Isolation wall manufacturing ● Rolling steel door production
● Overhead storage bin production ● Bottling line
● Pocket-bread bakery ● Tight manufacturing

I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04 9
1.3 I-8124W with Vendor’s DeviceNet Slaves
We have communicated with the following DeviceNet slaves.
● Allen-Bradley PowerFlex series DeviceNet Inverters.
● BECKHOFF CX1500-B520 series DeviceNet I/O modules.
●BECKHOFF BK5250 series DeviceNet I/O modules.
● MKS 683 series DeviceNet exhaust throttles.
● MKS MFC (Mass Flow Controller) series DeviceNet devices.
● MKS DELTA-II FRC (Flow Ratio Controller) series DeviceNet devices.
● MKS DC Power Generator (OPT- xxx) series DeviceNet devices.
● OMRON DRT1-ID/ODxx series DeviceNet I/O modules.
●OMRON DRT2-MDxx series DeviceNet I/O modules.
● COSMOS PS-7 series DeviceNet gas detectors.
● CELERITY UNIT IFC-125 series DeviceNet devices.

I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04 10
1.4 I-8124W Architecture
The I-8124W provides the way to establish DeviceNet network rapidly by
Master/Slave connection model. It is a high-performance DeviceNet master
module with inside CPU. This architecture of the I-8124W only needs few
resources of main control unit (such as WinPAC-8000, ViewPAC-8000, XPAC-
8000 …) and really increases the work efficiency on DeviceNet network.
Applying the I-8124W, you don’t need to take care of the detail of the
DeviceNet protocol. The firmware implements the DeviceNet protocol to help
you setting up the connection with DeviceNet slave devices easily. The
illustration of the idea is shown as Figure 1.2.
Figure 1.2 I-8124W architecture

I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04 11
1.5 DeviceNet Master Working Procedure
Using the API functions, users don’t need to take care of the detail of the
DeviceNet protocol. It can reduce the complexity of user’s DeviceNet Master
Software. The firmware mainly supports the Predefined Master-Slave
Connection Set and UCMM functions to allow users to merge third party’s
DeviceNet devices into the DeviceNet network. It can help users establishing
the connection with DeviceNet slave devices easily. The general application
architecture is demonstrated as Figure 1.3.
Figure 1.3 Application architecture

I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04 12
The firmware of I-8124W provides the DeviceNet Master mechanism to
communicate with slave devices by the Predefined Master/Slave Connection
Set and UCMM Connection Set. In the DeviceNet communication protocol can
be clarify as two forms: Explicit Message and I/O Message. Here, we only
provide one explicit message connection and 4 I/O connections as depicted in
Figure 1.4.
Figure 1.4 DeviceNet Messaging
The DeviceNet Communication Protocol is based on the concept of
connections method. Master should create connections with slave devices
based on the command of exchanging information and I/O data. To establish
the master control mechanism, there are only 4 steps to be followed. Figure
1.5 demonstrates the basic process for the DeviceNet master communication.
Each step is described in below:
Figure 1.5 Four steps to establish connection

I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04 13
1. Add device into firmware
Add the slave device’s MAC ID into firmware by using API function.
2. Configure connection
Check the slave device’s I/O connection type and the I/O data length.
While configuring the I/O connection, provide these parameters to
configuration APIs.
3. Start Device
After configuring connections, the master will communicate with the slave
device which is triggered to active by using API function.
4. Access I/O data
After communicating with slave devices, you can access the I/O data with
corresponding read/write functions.
After adding the device into the firmware, the master will wait for users to
get the I/O configuration information. Users can create the I/O connections in
the next step. Once I/O connections have been created and activated, I/O data
can be exchanged among devices in the DeviceNet network according to the
requirement of the master device. The master device can access I/O data of
the slave devices by one of the four I/O connection methods. All of the steps
described above are implemented by API functions. The API functions are not
only easy to use but also providing a lot of the DeviceNet Master functions to
retrieve and deliver the I/O data of the slaves. For more information about
APIs, please refer to functions description and demo programs in section 4.

I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04 14
1.6 I-8124W Firmware Characteristics
The I-8124W is a high-performance DeviceNet master module. In the I-
8124W, there is a firmware which implements DeviceNet protocol
automatically when it is active. The firmware always listens to the bus and
receives the messages at the same time. It works as shown in Figure 1.6.
Figure 1.6 Message Router

I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04 15
The I-8124W firmware has a “ScanList” which is used for store the remote
slave devices information. After adding or removing a slave device into
firmware by APIs, the firmware will save immediately this information into
“ScanList”and update the EEPROM information. You don’t need to reboot for
this operation. When you reboot I-8124W next time, it will load the “ScanList”
information from EEPROM again and run with the slaves by following the
“ScanList”information. Users can easily use the DLL functions or Utility tools
to configure it by calling “add device”or “remote device”functions. It works as
following Figure 1.7.
Figure 1.7 ScanList data structure

I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04 16
1.7 Features
Hardware Features
CPU : 80186-80 MHz or compatible.
CAN Port : 5-pin screwed terminal block (CAN_L, CAN_GND, CAN_H,
N/A for others).
CAN Controller : NXP SJA1000T with 16M Hz clock.
CAN Transceiver : NXP 82C250.
Isolation : 3000 VDC for DC-to-DC, 2500 Vrms for photo-couple.
Specification : ISO-11898-2, CAN 2.0A and CAN 2.0B.
3 indicating LED (RUN, NS and MS).
Terminator resistor : Switch select 120Ω terminator resistor.
Power Consumption : 2W.
Operating Temperature : -25 ~ 75°C
Storage Temperature : -40 ~ 80°C
Humidity : 5 ~ 95% RH, non-condensing
Support PAC : ViewPAC, WinPAC, XPAC, XPAC-Atom series.
DeviceNet Firmware Features
Programmable Master MAC ID.
Programmable transfer-rate 125 kbps , 250 kbps, 500 kbps.
Each port support maximum nodes up to 64
Support Group 2 and UCMM functions
Predefined Master-Slave Connection Set
The maximum Fragment number is (Input/Output) up to 64
Support I/O Operation Mode: Poll, Bit-Strobe and Change Of
State/Cyclic
Support Auto-Scan slave device function.
Support on-line adding and removing devices.
Support Auto-Reconnect when the connection is broken.

I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04 17
1.8 Block Diagram
1.8 Block Diagram
The figure 1.8 shows the block diagram of the I-8124W module.
1. DPRAM :
The DPRAM provides the communication channel between PAC (WP-
8000 or XPAC-8000) and I-8124W module.
2. EEPROM :
The EEPROM stores the configuration information. While activating the I-
8120W, the “ScanList”will be loaded from EEPROM automatically.
3. CPU :
This CPU is for implementing the DeviceNet protocol and communicating
with the main control unit such as WP-8000 or XP-8000.
4. CAN Controller :
The CAN controller is used for sending and receiving the CAN messages.
I-8120W provides the photo isolation function between CAN controller
and CAN bus.
Figure 1.8 Block diagram of the I-8124W module

I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04 18
1.9 Product Check List
In addition to this manual, the package includes the following items:
I-8124W module;
Software CD ROM;
Quick Start manual;
Release Note
It is recommended that users should read the release note first. All of
the important information needed will be provided in the release note as
follows:
Where you can find the software driver, utility and demo programs.
How to install software & utility.
Where is the diagnostic program.
FAQ’s and answers.
Attention !
If any of these items are missing or damaged, please contact your local
field agent. Keep aside the shipping materials and carton in case you want to
ship or store the product in the future.

I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04 19
2. Hardware Configuration
This section will describe the hardware settings of the I-8124W. This
information includes the wire connection and terminal resistance configuration.
2.1 Board Layout
Figure2.1 I-8124W Board LAYOUT

I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04 20
2.2 Jumper Selection
The following table shows the definition of jumpers. Users need to refer to
this table to configure the I-8124W hardware.
Jumper
Description
Status
JP1
Flash Protection. If you need to update
the firmware, you should unlock it
before you download the firmware. The
default is lock.
SW1
CAN Port 120Ωterminal resistor.
Table 2.1 Jumper selections