ICP DAS USA I-8124W User Manual

ICP DAS USA I-8124W User Manual

Devicenet master module
Table of Contents

Advertisement

Quick Links

DeviceNet Master Module
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)
I-8124W
User's Manual
2021/10/04
1

Advertisement

Table of Contents
loading

Summary of Contents for ICP DAS USA I-8124W

  • Page 1 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...
  • Page 2: Revision

    Add new functions * I8124_ReadInputArea 01/10 Johney * I8124_WriteOutputArea * I8124_ReadbackOutputArea 2010 Update the CAN pin Johney 05/25 description This manual is for the I- 2010 Johney 8124W module. 03/28 I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04...
  • Page 3: Table Of Contents

    NPUT AND UTPUT DVANCED PTION FUNCTION DESCRIPTION ................40 4.1 DLL F ............41 UNCTION EFINITION AND ESCRIPTION 4.2 F ..................45 UNCTION ETURN 4.3 F ..................49 UNCTION ESCRIPTION I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04...
  • Page 4 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...
  • Page 5 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...
  • Page 6: General Information

    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...
  • Page 7 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.
  • Page 8: Devicenet Applications

    ● 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...
  • Page 9: I-8124W With Vendor's Devicenet Slaves

    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...
  • Page 10: I-8124W Architecture

    (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.
  • Page 11: Devicenet Master Working Procedure

    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...
  • Page 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.
  • Page 13 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...
  • Page 14: I-8124W Firmware Characteristics

    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.
  • Page 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.
  • Page 16: Features

    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...
  • Page 17: Block Diagram

    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”...
  • Page 18: Product Check List

    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...
  • Page 19: Hardware Configuration

    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...
  • Page 20: Jumper Selection

    Flash Protection. If you need to update the firmware, you should unlock it before you download the firmware. The default is lock. CAN Port 120Ω terminal resistor. Table 2.1 Jumper selections I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04...
  • Page 21: Connector Pin Assignment

    2.3 Connector Pin Assignment The I-8124W is equipped with one 5-pin screwed terminal connector for wire connection of the CAN bus. The connector’s pin assignment is specified as follows: The 5-pin screwed terminal connector of the CAN bus interface is shown in Figure 2.5.
  • Page 22: Wire Connection

    Device 2 Device N CAN_H CAN_L Figure 2.4 CAN bus network topology Figure 2.5 CAN bus wire connection without DC power Figure 2.6 CAN bus wire connection with 24VDC power I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04...
  • Page 23 (22AWG) 40~300 < 60 0.34(22AWG)~ 127 (0.1%) 0.6mm (20AWG) 300~600 < 40 0.5~0.6mm 150~300 (20AWG) 600~1K < 20 0.75~0.8mm 150~300 (18AWG) Table 2.4 Relationship between cable characteristics and terminal resistance I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04...
  • Page 24: Indicator Led

    (c) The MAC ID collision between master and slave devices is detected. 2.5.2 RUN LED (Green) The RUN LED presents the firmware status of I-8124W. There are three situations in RUN LED. (1). LED off : Some error happens on the bus or in the I-8124W module. The DeviceNet firmware doesn’t work.
  • Page 25: Ms Led (Yellow)

    (2). LED twinkle (Yellow) : This shows that at least one slave device has problem to communicate with I-8124W. It may occur if the configuration is wrong or the slave device is malfunction. I-8124W DeviceNet Master API functions User’s Manual (V 1.6)
  • Page 26: Update The I-8124W's Firmware

    2.6 Update the I-8124W’s firmware Generally, it is not necessary to update the firmware of I-8124W. If you need some special functions or there is a bug in firmware, it may be needed. When users want to download the new firmware into the I-8124W, they could achieve it by the following description.
  • Page 27 D. Updating the firmware. (1) Open the i8120w_utility (2) Select the slot number which the I-8124W plugged in. (3) Click the “Update Firmware” button. I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04...
  • Page 28 (4) Click the “Update” button to select the I-8124W firmware. (5) Click “OK” button to start downloading the firmware. E. Configuring the jumpers of I-8124W again The users should lock the flash protection jumper shown below. I-8124W DeviceNet Master API functions User’s Manual (V 1.6)
  • Page 29: Flow Chart For Devicenet Application

    I-8124W. Figure 3.1 Sketch Flow Chart 1. Active I-8124W Module Before using the I-8124W, the users should activate it. There is an API which is I8124_ActiveModuel to achieve this. The detail about this function is described in the next chapter.
  • Page 30 If the users need to close the application for any purpose, it is important to close the I-8124W module by calling the I8124_CloseModule. This would make the I-8124W to stop working. Refer to the description in the next chapter for more details.
  • Page 31: Flow Chart For Searching Devices

    DeviceNet network. When users have no idea about how to find the slave devices by I-8124W, the following steps in the figure 3.2 is good reference. The users could take advantage of the searching function to check the connection status of all slave devices.
  • Page 32: Flow Chart For Slave Configuration

    APIs or the utility tool, the information needs be saved into the EEPROM of the I-8124W. The users could follow the flow chart to save the parameters into the EEPROM of the I-8124W module. The firmware in the I-8124W module will load the previous configuration from the EEPROM in the next boot-up.
  • Page 33: Flow Chart For On-Line Adding/Removing Device

    Follow the steps to achieve this function. The steps are shown in Figure 3.6 and Figure 3.7. 1. On-line Adding Devices : Figure 3.6 On-line Add Device Flow Chart I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04...
  • Page 34 2. On-line Removing Devices : Figure 3.7 On-line Remove Device Flow Chart I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04...
  • Page 35: Flow Chart For "Setattribute" And "Getattribute

    3.5 Flow Chart for “SetAttribute” and “GetAttribute” Users can set or get the DeviceNet properties of the slaves via the DeviceNet network. I-8124W provides these functions to set or get these properties easily. The steps are shown in Figure 3.8.
  • Page 36: Flow Chart For I/O Connection

    More functions are described in chapter 4. Figure 3.9 I/O Connection Flow Chart Note: The Strobe connection doesn’t support the output channel. Users can not use the I8124_WriteOutputData with Strobe connection. I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04...
  • Page 37: Input And Output I/O Data Area (Advanced Option)

    Please refer to the Figure 3.10. Figure 3.10 The Memory Mapping of the I-8124W Users can read a bulk data from “Remote Input Area” in the I-8124W. This bulk data contains multiple devices’ input statuses. If one of the input status of the remote DeviceNet slave changes, the corresponding data located in the “Remote Input Area”...
  • Page 38 Figure 3.11 The example of the I-8124W memory mapping Figure 3.12 The example of the I-8124W memory mapping I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04...
  • Page 39 4.3.42 for more information. Note: If users add/remove any slaves’ information into/from the I-8124W, they need to reset firmware to update the modification of the data arrangement of the “Remote Input Area” and “Remote Output Area”. In other word, if users have called these functions below, they need to call I8124_ResetFirmware to make the modification active.
  • Page 40: Function Description

    Figure 4.1 Five Function Groups [Module Functions] The functions in this group help users to find the I-8124W modules or get the information of the I-8124W. The users can use these functions to configure or manage the I-8124W in the WP-8000 or XPAC-8000 series MCU.
  • Page 41: Dll Function Definition And Description

    I8124_DotNET.DLL Table 4.1.2 Functions Table (Firmware Functions) Function Name Description Get the version of the firmware inside the I8124_GetFirmwareVersion I-8124W module I8124_ResetFirmware Reset the firmware in the I-8124W module I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04...
  • Page 42 (DeviceNet Master) Add I/O information of the specific slave 13 I8124_AddIOConnection device into I-8124W module (DeviceNet Master) Remove specific slave device’s 14 I8124_RemoveIOConnection information from the I-8124W module (DeviceNet Master) I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04...
  • Page 43 28 I8124_SendExplicitMSG_W Send the explicit request command. Check whether the I-8124W has received 29 I8124_IsExplicitMSGRespOK the response message or not. Get the attribute value of the specific 30 I8124_GetExplicitMSGRespValue device’s instance. I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04...
  • Page 44 Read the bulk data from the input area I8124_ReadInputArea memory. Write the bulk data to the output area I8124_WriteOutputArea memory. Read back the bulk data from the output I8124_ReadbackOutputArea area memory. I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04...
  • Page 45: Function Return Code

    10035 I8120_BoardModeError 10036 I8120_SetDateTimeFailure Can not update the clock. 10040 I8120_SlotNotConfig The slot has not been configured 10041 I8120_SlotNotInit The slot has not been initialized 10042 I8120_ReplyError The slot replied error I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04...
  • Page 46 The Scan List has some errors. DNMXS_ScanListError 1056 The information of the slave device 1057 DNMXS_DeviceExist already exists. The information of the slave device 1058 DNMXS_DeviceNotExist doesn’t exist. 1059 DNMXS_MapTableError The MapTable has some errors. I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04...
  • Page 47 The COS connection has been 1107 DNMXS_COSAlreadyExist established. The Cyclic connection has been 1108 DNMXS_CyclicAlreadyExist established. The communication among I-8124W 1109 DNMXS_CommunicationPause and all slave devices has been suspended. I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04...
  • Page 48 The input length of the I/O 1154 DNMXS_InputDataLenError connection doesn't match the device's input length. The specific memory address is out 1200 DNMXS_OutofRange of range. I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04...
  • Page 49: Function Description

    4.3 Function Description 4.3.1 I8124_TotalI8124Module  Description: The function can get the count of total I-8124W modules in the user’s WP-8000 or XPAC-8000 series MCU.  Syntax: DWORD I8124_Total I8124Module (BYTE *TotalModules , BYTE *SlotNoList)  Parameter: TotalModules: [output] The amount of total modules.
  • Page 50: I8124_Activemodule

    4.3.2 I8124_ActiveModule  Description: The function is used to activate the entire I-8124W module. The user should wait at least two seconds before calling any other I-8124W functions. The DeviceNet master costs two seconds to check the duplicate MAC ID. It must be called once before using the other functions of I-8124W APIs.
  • Page 51: I8124_Closemodule

    4.3.3 I8124_CloseModule 4.3.3 I8124_CloseModule  Description: The function is used to stop and close the I-8124W driver. This method must be called once before exiting the user’s application program.  Syntax: DWORD I8124_CloseModule (BYTE cSlot)  Parameter: cSlot: [input] The slot number which the I-8124W is plugged in.
  • Page 52: I8124_Getdllversion

    The DLL version information. For example: If 100(hex) is returned, it means DLL version is 1.00.  Error Return: Please refer to the chapter 4.2 for the function return code. I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04...
  • Page 53: I8124_Getfirmwareversion

    I-8124W module.  Syntax: DWORD I8124_GetFirmwareVersion (BYTE cSlot)  Parameter: cSlot: [input] The slot number which the I-8124W is plugged in.  Return: The firmware version information. For example: If 100(hex) is returned, it means firmware version is 1.00. ...
  • Page 54: I8124_Resetfirmware

     Description: The function is used to reset the I-8124W firmware. When users have changed the baud rate of CAN bus or changed the Master’s MAC ID, the function must be called to make the modification enable. After calling this function, users should wait for 2 seconds to make the firmware boot up completely.
  • Page 55: I8124_Getmastermacid

    4.3.7 I8124_GetMasterMACID 4.3.7 I8124_GetMasterMACID  Description: The function can get the MAC ID of the DeviceNet master (I-8124W).  Syntax: DWORD I8124_GetMasterMACID (BYTE cSlot)  Parameter: cSlot: [input] The slot number which the I-8124W is plugged in.  Return: The MAC ID information (0 ~ 64).
  • Page 56: I8124_Setmastermacid

    4.3.8 I8124_SetMasterMACID  Description: The function can set the MAC ID of the DeviceNet master (I-8124W). After calling this function, users must call I8124_ResetFirmware to make the modification enabled. It will save the information in the EEPROM of the I-8124W.
  • Page 57: I8124_Getbaudrate

     Syntax: DWORD I8124_GetBaudRate (BYTE cSlot)  Parameter: cSlot: [input] The slot number which the I-8124W is plugged in.  Return: The CAN bus baud rate information in the I-8124W. If the value is 0, the baud rate is 125Kbps.
  • Page 58: I8124_Setbaudrate

    4.3.10 I8124_SetBaudRate  Description: This function can set the DeviceNet baud rate of the I-8124W. After calling this function, you must call I8124_ResetFirmware to reset the firmware to make change enabled.  Syntax: DWORD I8124_SetBaudRate (BYTE cSlot,BYTE BaudRate)  Parameter: cSlot: [input] The slot number which the I-8124W is plugged in.
  • Page 59: I8124_Getmasterstatus

    4.3.11 I8124_GetMasterStatus  Description: The function is used to obtain the firmware status inside the I-8124W. The users can call this function to make sure that the DeviceNet master is online successfully.  Syntax: DWORD I8124_GetMasterStatus (BYTE cSlot)  Parameter: cSlot: [input] The slot number which the I-8124W is plugged in.
  • Page 60: I8124_Getslavestatus

    Syntax: DWORD I8124_GetSlaveStatus (BYTE cSlot, BYTE DesMACID)  Parameter: cSlot: [input] The slot number which the I-8124W is plugged in. DesMACID: [input] The remote slave’s MAC ID. (0~63)  Return: Please refer to the chapter 4.2 for the function return code.
  • Page 61: I8124_Startdevice

    Syntax: DWORD I8124_StartDevice (BYTE cSlot, BYTE DesMACID)  Parameter: cSlot: [input] The slot number which the I-8124W is plugged in. DesMACID: [input] The remote slave’s MAC ID. (0~63)  Return: Please refer to the chapter 4.2 for the function return code.
  • Page 62: I8124_Stopdevice

    Syntax: DWORD I8124_StopDevice (BYTE cSlot, BYTE DesMACID)  Parameter: cSlot: [input] The slot number which the I-8124W is plugged in. DestMACID: [input] The remote slave device’s MAC ID (0~63)  Return: Please refer to the chapter 4.2 for the function return code.
  • Page 63: I8124_Startalldevice

    Syntax: DWORD I8124_StartAllDevice (BYTE cSlot)  Parameter: cSlot: [input] The slot number which the I-8124W is plugged in.  Return: Please refer to the chapter 4.2 for the function return code. I-8124W DeviceNet Master API functions User’s Manual (V 1.6)
  • Page 64: I8124_Stopalldevice

    Syntax: DWORD I8124_StopAllDevice (BYTE cSlot)  Parameter: cSlot: [input] The slot number which the I-8124W is plugged in.  Return: Please refer to the chapter 4.2 for the function return code. I-8124W DeviceNet Master API functions User’s Manual (V 1.6)
  • Page 65: I8124_Adddevice

    DWORD I8124_AddDevice (BYTE cSlot, BYTE DesMACID, WORD Explicit_EPR)  Parameter: cSlot: [input] The slot number which the I-8124W is plugged in. DestMACID: [input] The remote slave device’s MAC ID (0~63) Explicit_EPR: [input] The Expected Packet Rate. (Usually is 2500). ...
  • Page 66: I8124_Removedevice

    4.3.18 I8124_RemoveDevice  Description: This function is used to remove the specified slave device from the ScanList in the I-8124W, and the information of the device in the EEPROM is erased at the same time.  Syntax: DWORD I8124_RemoveDevice (BYTE cSlot, BYTE DesMACID) ...
  • Page 67: I8124_Addioconnection

    Description: This method is used to configure the I/O connection of the device which has specific MAC ID. The I-8124W can get/set the data via the connection, which is applied to the specific slave, according to the produced / consumed connection path of this slave device. This configuration data will be saved into EEPROM of the I-8124W.
  • Page 68: I8124_Removeioconnection

    DWORD I8124_RemoveIOConnection (BYTE cSlot, BYTE DesMACID, BYTE ConType)  Parameter: cSlot: [input] The slot number which the I-8124W is plugged in. DestMACID: [input] The remote slave device’s MAC ID (0~63) ConType: [input] The remote slave device’s I/O connection type 0 : Explicit connection type...
  • Page 69: I8124_Getattribute

    BYTE ClassID, BYTE InstanceID, BYTE AttributeID)  Parameter: cSlot: [input] The slot number which the I-8124W is plugged in. DestMACID: [input] The remote slave device’s MAC ID (0~63) ClassID: [input] The remote slave device’s ClassID(BYTE) InstanceID: [input] The remote slave device’s InstanceID(BYTE) AttributeID: [input] The remote slave device’s AttributeID...
  • Page 70: I8124_Getattributew

    InstanceID, BYTE AttributeID)  Parameter: cSlot: [input] The slot number which the I-8124W is plugged in. DestMACID: [input] The remote slave device’s MAC ID (0~63) ClassID: [input] The remote slave device’s ClassID(WORD) InstanceID: [input] The remote slave device’s InstanceID(WORD) AttributeID: [input] The remote slave device’s AttributeID ...
  • Page 71: I8124_Isgetattributeok

    4.3.23 I8124_IsGetAttributeOK  Description: This function is used to check whether the I-8124W has received the response message or not. After checking the response message, you should execute the “I8124_GetAttributeValue” to get the response message returned from the remote slave device.
  • Page 72: I8124_Getattributevalue

    WORD *DataLen, BYTE *DATA)  Parameter: cSlot: [input] The slot number which the I-8124W is plugged in. DestMACID: [input] The remote slave device’s MAC ID (0~63) DataLen: [output] The length of the attribute value (in byte). DATA: [output] The attribute value that returned from the slave device.
  • Page 73: I8124_Setattribute

    BYTE AttributeID, WORD DataLen, BYTE *DATA)  Parameter: cSlot: [input] The slot number which the I-8124W is plugged in. DestMACID: [input] The remote slave device’s MAC ID (0~63) ClassID: [input] The remote slave device’s ClassID(BYTE) InstanceID: [input] The remote slave device’s InstanceID(BYTE) AttributeID: [input] The remote slave device’s AttributeID...
  • Page 74: I8124_Setattributew

    BYTE AttributeID, WORD DataLen, BYTE *DATA)  Parameter: cSlot: [input] The slot number which the I-8124W is plugged in. DestMACID: [input] The remote slave device’s MAC ID (0~63) ClassID: [input] The remote slave device’s ClassID(WORD) InstanceID: [input] The remote slave device’s InstanceID(WORD) AttributeID: [input] The remote slave device’s AttributeID...
  • Page 75: I8124_Issetattributeok

    Syntax: DWORD I8124_IsSetAttributeOK (BYTE cSlot, BYTE DesMACID)  Parameter: cSlot: [input] The slot number which the I-8124W is plugged in. DestMACID: [input] The remote slave device’s MAC ID (0~63)  Return: Please refer to the chapter 4.2 for the function return code.
  • Page 76: I8124_Clearallconfig

    Syntax: DWORD I8124_ClearAllConfig (BYTE cSlot)  Parameter: cSlot: [input] The slot number which the I-8124W is plugged in.  Return: Please refer to the chapter 4.2 for the function return code. I-8124W DeviceNet Master API functions User’s Manual (V 1.6)
  • Page 77: I8124_Searchalldevices

    Description: This function is used to retrieve all devices in DeviceNet network. This function makes the I-8124W to start the searching process. The users need to check whether the process is complete or not by calling the “I8124_IsSearchOK”. After completing the search process, the users could call the “I8124_GetSearchedDevices“...
  • Page 78: I8124_Searchspecificdevice

    Description: This function is used to retrieve some devices which specified by the users. This function makes the I-8124W to start the searching process. The users need to check whether the process is complete or not by calling the “I8124_IsSearchOK”. After completing the search process, the users could call the “I8124_GetSearchedDevices“...
  • Page 79: I8124_Issearchok

    Syntax: DWORD I8124_IsSearchOK (BYTE cSlot)  Parameter: cSlot: [input] The slot number which the I-8124W is plugged in.  Return: Please refer to the chapter 4.2 for the function return code. I-8124W DeviceNet Master API functions User’s Manual (V 1.6)
  • Page 80: I8124_Getsearcheddevices

    WORD *DeviceOutputLen)  Parameter: cSlot: [input] The slot number which the I-8124W is plugged in the PAC. TotalDevices: [output] The amount of all slave device which ware found. DesMACID: [output] The list of slave’s MAC ID which ware found. Type: [output] The list of slave’s connection type which ware found.
  • Page 81: I8124_Getdeviceinfofromscanlist

    BYTE *ConnectionTypeList, WORD *InputDataLenList, WORD *OutputDataLenList,WORD *EPRList)  Parameter: cSlot: [input] The slot number which the I-8124W is plugged in. DesMACID: [input] The MAC ID number which the users want to get the information. ListCount: [output] The amount of all information items.
  • Page 82: I8124_Getscanlist

    4.3.34 I8124_GetScanList 4.3.34 I8124_GetScanList  Description: This function will get all the ScanList data in the I-8124W.  Syntax: DWORD I8124_GetScanList (BYTE cSlot, WORD *TotalDevices, BYTE *DesMACIDList, BYTE *ConnectionTypeList, WORD *InputDataLenList, WORD *OutputDataLenList, WORD *EPR_List)  Parameter: cSlot: [input] The slot number which the I-8124W is plugged in.
  • Page 83 I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04...
  • Page 84: I8124_Importeeprom

    WORD *EPR_List)  Parameter: cSlot: [input] The slot number which the I-8124W is plugged in. ListCount: [input] The data count of all the information. DestMACIDList: [input] The MAC ID of all the slave devices. ConnectionTypeList: [input] The connection type of all slave devices.
  • Page 85: I8124_Readinputdata

    BYTE ConType, WORD *IOLen, BYTE *IODATA)  Parameter: cSlot: [input] The slot number which the I-8124W is plugged in. DestMACID: [input] The remote slave device’s MAC ID (0~63) ConType: [input] The connection type of the remote slave. 0 : Explicit connection type...
  • Page 86: I8124_Writeoutputdata

    BYTE ConType, WORD IOLen, BYTE *IODATA)  Parameter: cSlot: [input] The slot number which the I-8124W is plugged in. DestMACID: [input] The remote slave device’s MAC ID (0~63) ConType: [input] The connection type of the remote slave. 0 : Explicit connection type...
  • Page 87: I8124_Sendexplicitmsg

    BYTE InstanceID,WORD DataLen, BYTE *DATA)  Parameter: cSlot: [input] The slot number which the I-8124W is plugged in. DestMACID: [input] The remote slave device’s MAC ID (0~63) ServiceID: [input] The remote slave device’s ServiceID. ClassID: [input] The remote slave device’s ClassID(BYTE).
  • Page 88: I8124_Sendexplicitmsg_W

    InstanceID,WORD DataLen, BYTE *DATA)  Parameter: cSlot: [input] The slot number which the I-8124W is plugged in. DestMACID: [input] The remote slave device’s MAC ID (0~63) ServiceID: [input] The remote slave device’s ServiceID. ClassID: [input] The remote slave device’s ClassID(WORD).
  • Page 89: I8124_Isexplicitmsgrespok

    4.3.40 I8124_IsExplicitMSGRespOK  Description: This function is used to check whether the I-8124W has received the response message or not. After checking the response message, you should execute the “I8124_GetExplicitMSGRespValue” to get the response message returned from the remote slave device.
  • Page 90: I8124_Getexplicitmsgrespvalue

    BYTE *DATA)  Parameter: cSlot: [input] The slot number which the I-8124W is plugged in. DestMACID: [input] The remote slave device’s MAC ID (0~63) DataLen: [output] The length of the attribute value (in byte). DATA: [output] The attribute value that returned from the slave device.
  • Page 91: I8124_Readbackoutputdata

    WORD *IOLen, BYTE *IODATA)  Parameter: cSlot: [input] The slot number which the I-8124W is plugged in. DestMACID: [input] The remote slave device’s MAC ID (0~63) ConType: [input] The connection type of the remote slave. 0 : Explicit connection type...
  • Page 92: I8124_Readinputarea (Advanced Option)

    BYTE *DataArray)  Parameter: cSlot: [input] The slot number which the I-8124W is plugged in. Offset: [input] The offset of the input area memory. DataLen: [input] The length in byte which the users want to read. DataArray: [output] The data pointer of the obtained data from the input area memory.
  • Page 93 Offset = 4 + 4; //Read the data from the beginning of the ID = 5. DataLen = 4; //The input length of the ID = 5. I8124_ReadInputArea (cSlot, Offset, DataLen, DataArray); DataArray = [The input data of the slave device which ID = 5]; I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04...
  • Page 94: I8124_Writeoutputarea (Advanced Option)

    BYTE *DataArray)  Parameter: cSlot: [input] The slot number which the I-8124W is plugged in. Offset: [input] The offset of the input area memory. DataLen: [input] The length in byte which the users want to write. DataArray: [input] The data pointer pointed the data written to the output data area.
  • Page 95 Offset = 5 + 4; //Write the data from the beginning of the ID = 5. DataLen = 5; //The output length of the ID = 5. DataArray = [The output data of the ID = 5]; I8124_WriteOutputArea (cSlot, Offset, DataLen, DataArray); I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04...
  • Page 96: I8124_Readbackoutputarea (Advanced Option)

    BYTE *DataArray)  Parameter: cSlot: [input] The slot number which the I-8124W is plugged in. Offset: [input] The offset of the output area memory. DataLen: [input] The length in byte which the users want to read. DataArray: [output] The data pointer pointed the observed data form the output area memory.
  • Page 97 Offset = 5 + 4; //Read back the data from the beginning of the ID = 5. DataLen = 5; //The output length of the ID = 5. I8124_WriteOutputArea (cSlot, Offset, DataLen, DataArray); DataArray = [The output data of the ID = 5]; I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04...
  • Page 98 This function can disable the read process. For some slave devices, the keep explicit connection is not necessary. The users can call this function after the I8124_ActiveModule(). This disable will NOT keep in I-8124W. The users need to call this for every boot-up. ...
  • Page 99: Dnm_Utilityce For Wp-8000

    5. DNM_UtilityCE for WP-8000 The utility does not work normally if the DeviceNet master series hardware driver is not installed correctly. After selecting the I-8124W modules, the screen shoot is shown below. I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04...
  • Page 100: Introduction

    The software utility can easily access the I/O data of all slave devices. Users can monitor the input data of the specific slave device and change the output data to the remote slave device with this utility. I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04...
  • Page 101: Tutorial Demos

    1. The utility would search how many modules in WP-8000 automatically. It shows the count of the modules which have been found. 2. The utility also lists the slot numbers of all modules in the “Slot No” field. I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04...
  • Page 102: How To Start Using The Utility

    DeviceNet master device hardware. That would initialize the DeviceNet master device which you have selected in the “Slot No” field. 2. After activating the specific I-8124W, the utility will read all configurations from the EEPROM of the I-8124W. After reading the configuration from EEPROM of the DeviceNet master device successfully, the utility shows the information in the “Devices in EEPROM”...
  • Page 103: How To Search The Slave Devices

    The numbers of scanned device is 64. 2. After finishing the searching procedure, the utility shows the information of all slave devices in the “Searched Devices” field. I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04...
  • Page 104 3. Users can expand the device to find out more I/O connection information of those devices. I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04...
  • Page 105: How To Add I/O Information Into The Eeprom

    “Add>>” button to add the item into the “EEPROM“ field. 4. If the procedure is successful, users would see the successful message below. You can find the selected item which has been added into the “EEPROM” field. I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04...
  • Page 106: How To Remove I/O Information From The Eeprom

    1. Please activate your module. Refer to section 5.2.2 for more information. 2. Please select one of the device items in the “EEPROM” field, and then click the “Del<<” button. I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04...
  • Page 107: How To Read/Write The I/O Data Form/To The Slave Device

    The warning message would pop-up. In this example, please click “Yes”. 3. The users can click “Remote Device I/O Monitor” tag to view the I/O data of the slave devices. I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04...
  • Page 108 4. Users can press the device No. to display the device information, including the device name and input data. 5. Users can press “Write” button to send the output data to the slave device. I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04...
  • Page 109: Description Of The Buttons And Fields

    “Slot No” field. Users should click this button before using other functions. 5.3.4 Reset Firmware This button can restart the firmware of the I-8124W. If users have changed the baud rate or the MAC ID of the I-8124W, you must restart firmware to make the modification enable. 5.3.5 Search All Device This button can search all the slave devices in the network.
  • Page 110: Start All Device

    “Output Data” field to change the value to the output channel. Finish the value modification, and press the “Write” button to send the new data to the slave device. I-8124W DeviceNet Master API functions User’s Manual (V 1.6) 2021/10/04...
  • Page 111: Change Master Id

    This filed shows the firmware version. 5.3.13 Master Status This filed shows the current status of the I-8124W. Please refer to the chapter 4.2, the function return code, to explain the meanings of this field. I-8124W DeviceNet Master API functions User’s Manual (V 1.6)

Table of Contents