Omron SYSMAC-XR005 User Manual
  1. Manuals
  2. Brands
  3. Omron Manuals
  4. Industrial Electrical
  5. SYSMAC-XR005
  6. User manual
Omron SYSMAC-XR005 User Manual

Omron SYSMAC-XR005 User Manual

For ethercat n-smart series library, sysmac library
Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
Sysmac Library
User's Manual
for EtherCAT
N-Smart Series Library
®
SYSMAC-XR005
W549-E1-06

Advertisement

Table of Contents
loading

Related Manuals for Omron SYSMAC-XR005

Summary of Contents for Omron SYSMAC-XR005

  • Page 1 Sysmac Library User’s Manual for EtherCAT N-Smart Series Library ® SYSMAC-XR005 W549-E1-06...
  • Page 2 No patent liability is assumed with respect to the use of the information contained herein. Moreover, because OMRON is constantly striving to improve its high-quality products, the information contained in this manual is subject to change without notice. Every precaution has been taken in the preparation of this manual. Neverthe- less, OMRON assumes no responsibility for errors or omissions.

  • Page 3: Introduction

    Keep this manual in a safe place where it will be available for reference during operation. Features of the Library The EtherCAT N-Smart Series Library is used to back up and restore the parameters for an OMRON E3NW Sensor Communications Unit (an EtherCAT type). You can use this library to reduce manpower of programming when implementing the processing for a Sensor Communications Unit.

  • Page 4: Manual Structure

    Manual Structure Manual Structure Special Information Special information in this manual is classified as follows: Precautions for Safe Use Precautions on what to do and what not to do to ensure safe usage of the product. Precautions for Correct Use Precautions on what to do and what not to do to ensure proper operation and performance.
  • Page 5 Manual Structure Sysmac Library User’s Manual for EtherCAT N-Smart Series Library (W549)

  • Page 6: Table Of Contents

    CONTENTS CONTENTS Introduction ......................1 Features of the Library..........................1 Intended Audience............................1 Applicable Products ............................. 1 Manual Structure ...................... 2 Special Information ............................2 CONTENTS........................ 4 Terms and Conditions Agreement ................6 Warranty, Limitations of Liability ........................6 Application Considerations .......................... 7 Disclaimers ..............................
  • Page 7 CONTENTS Sysmac Library User’s Manual for EtherCAT N-Smart Series Library (W549)

  • Page 8: Terms And Conditions Agreement

    Omron’s exclusive warranty is that the Products will be free from defects in materials and workman- ship for a period of twelve months from the date of sale by Omron (or such other period expressed in writing by Omron). Omron disclaims all other warranties, express or implied.

  • Page 9: Application Considerations

    Disclaimers Performance Data Data presented in Omron Company websites, catalogs and other materials is provided as a guide for the user in determining suitability and does not constitute a warranty. It may represent the result of Omron’s test conditions, and the user must correlate it to actual application requirements. Actual perfor- mance is subject to the Omron’s Warranty and Limitations of Liability.

  • Page 10: Safety Precautions

    Safety Precautions Safety Precautions Definition of Precautionary Information The following notation is used in this user’s manual to provide precautions required to ensure safe usage of an NJ/NX-series Controller and an NY-series Industrial PC. The safety precautions that are provided are extremely important to safety. Always read and heed the information provided in all safety precautions.

  • Page 11: Cautions

    Safety Precautions Cautions Caution Read all related manuals carefully before you use this library. Emergency stop circuits, interlock circuits, limit circuits, and similar safety measures must be provided in external control circuits. Check the user program, data, and parameter settings for proper execution before you use them for actual operation.

  • Page 12: Precautions For Correct Use

    Precautions for Correct Use Precautions for Correct Use Using the Library • When you use the library, functions or function blocks that are not described in the library manual may be displayed on the Sysmac Studio. Do not use functions or function blocks that are not described in the manual.

  • Page 13: Related Manuals

    Related Manuals Related Manuals The following are the manuals related to this manual. Use these manuals for reference. Manual name Cat. No. Model numbers Application Description NX-series CPU Unit W535 NX701- Learning the basic specifi- An introduction to the entire NX701 CPU Unit cations of the NX-series system is provided along with the following infor- Hardware User’s Manual...
  • Page 14 Related Manuals Manual name Cat. No. Model numbers Application Description NY-series IPC Machine W556 NY512- Learning the basic specifi- An introduction to the entire NY-series system is Controller Industrial Box cations of the NY-series provided along with the following information on PC Hardware User's Industrial Box PCs, includ- the Industrial Box PC.
  • Page 15 Related Manuals Manual name Cat. No. Model numbers Application Description G code Instructions Ref- O031 NJ501-5300 Learning about the specifi- The G code/M code instructions are described. erence Manual cations of the G code/M Use this manual together with the NJ/NY-series NY532-5400 code instructions.

  • Page 16: Revision History

    Revision History Revision History A manual revision code appears as a suffix to the catalog number on the front and back covers of the manual. W549-E1-06 Cat. No. Revision code Revision code Date Revised content April 2015 Original production December 2015 Corrected mistakes.

  • Page 17: Procedure To Use Sysmac Libraries

    Procedure to Use Sysmac Libraries Sysmac Library User’s Manual for EtherCAT N-Smart Series Library (W549)

  • Page 18: Procedure To Use Sysmac Libraries Installed Using The Installer

    Procedure to Use Sysmac Libraries Installed Using the Installer Procedure to Use Sysmac Librar- ies Installed Using the Installer This section describes the procedure to use Sysmac Libraries that you installed using the installer. There are two ways to use libraries. •...
  • Page 19 Procedure to Use Sysmac Libraries Installed Using the Installer Select Project – Library – Show References. Device Precautions for Correct Use If you have more than one registered device in the project, make sure that the device selected currently is an NJ/NX-series CPU Unit or an NY-series Industrial PC. If you do not select an NJ/NX-series CPU Unit or an NY-series Industrial PC as the device, Library References does not appear in the above menu.
  • Page 20 Procedure to Use Sysmac Libraries Installed Using the Installer • Right-click the programming editor, select Insert Function Block in the menu, and enter the fully qualified name (\\name of namespace\name of function block). Precautions for Correct Use After you upgrade the Sysmac Studio, check all programs and make sure that there is no error of the program check results on the Build Tab Page.
  • Page 21 Procedure to Use Sysmac Libraries Installed Using the Installer Add the desired Sysmac Library to the list and click the OK Button. Sysmac Library User’s Manual for EtherCAT N-Smart Series Library (W549)

  • Page 22: Procedure To Use Sysmac Libraries Uploaded From A Cpu Unit Or An Industrial Pc

    Procedure to Use Sysmac Libraries Uploaded from a CPU Unit or an Industrial PC Procedure to Use Sysmac Librar- ies Uploaded from a CPU Unit or an Industrial PC You can use Sysmac Libraries uploaded from a CPU Unit or an Industrial PC to your computer if they are not installed.
  • Page 23 Procedure to Use Sysmac Libraries Uploaded from a CPU Unit or an Industrial PC • Right-click the programming editor, select Insert Function Block in the menu, and enter the fully qualified name (\\name of namespace\name of function block). Precautions for Correct Use •...
  • Page 24 Procedure to Use Sysmac Libraries Uploaded from a CPU Unit or an Industrial PC Sysmac Library User’s Manual for EtherCAT N-Smart Series Library (W549)

  • Page 25: Common Specifications Of Function Blocks

    Common Specifications of Function Blocks Sysmac Library User’s Manual for EtherCAT N-Smart Series Library (W549)

  • Page 26: Common Variables

    Common Variables Common Variables This section describes the specifications of variables (EN, Execute, Enable, Abort, ENO, Done, Cal- cRslt, Enabled, Busy, CommandAborted, Error, ErrorID, and ErrorIDEx) that are used for more than one function or function block. The specifications are described separately for functions, for exe- cute-type function blocks, and for enable-type function blocks.
  • Page 27 Common Variables Function/function block type to use Data Variable Function block Meaning Definition type Function Execute- Enable- type type Output BOOL Done The variable changes to TRUE when the processing ends normally. It is FALSE when the processing ends in an error, the processing is in progress, or the execution condition is not met.
  • Page 28 Common Variables Abcd_instance Abcd InOut_Val InOut_Val In-out variables In-out variables Execute Done Busy CommandAborted Input variables Output variables Error ErrorID ErrorIDEx • If Execute is TRUE and Done, CommandAborted, or Error changes to TRUE, Done, Command- Aborted, and Error changes to FALSE when Execute is changed to FALSE. •...
  • Page 29 Common Variables  Aborted Execution Execute Done Busy CommandAborted Error ErrorID 16#0000 ErrorIDEx 16#00000000  Errors Execute Done Busy CommandAborted Error ErrorID 16#0000 ErrorID ErrorID ErrorID 16#0000 ErrorID ErrorIDEx 16#00000000 ErrorIDEx 16#00000000 ErrorIDEx Sysmac Library User’s Manual for EtherCAT N-Smart Series Library (W549)
  • Page 30 Common Variables Enable-type Function Blocks • Processing is executed while Enable is TRUE. • When Enable changes to TRUE, Busy also changes to TRUE. Enabled is TRUE during calculation of the output value. • If an error occurs in the function block, Error changes to TRUE and Busy and Enabled change to FALSE.
  • Page 31 Common Variables  Errors Enable Enabled Retained Retained CalcRslt Busy Error ErrorID 16#0000 16#0000 16#0000 ErrorID ErrorID ErrorID 16#0000 ErrorID ErrorIDEx 16#00000000 ErrorID ErrorID ErrorID ErrorID 16#00000000 Sysmac Library User’s Manual for EtherCAT N-Smart Series Library (W549)

  • Page 32: Precautions

    Precautions Precautions This section provides precautions for the use of this function block. Nesting You can nest calls to this function block for up to four levels. For details on nesting, refer to the CPU Unit software user’s manual. Instruction Options You cannot use the upward differentiation option for this function block.

  • Page 33: Individual Specifications Of Function Blocks

    Individual Specifications of Function Blocks Function block name Name Page Backup_E3NW E3NW Parameter Backup P.32 Restore_E3NW E3NW Parameter Restore P.45 Sysmac Library User’s Manual for EtherCAT N-Smart Series Library (W549)

  • Page 34: Backup_E3Nw

    Backup_E3NW Backup_E3NW The Backup_E3NW function block backs up the parameters for the Sensor Amplifier Unit that is con- nected to an E3NW-ECT Sensor Communications Unit or E3NW-DS Distributed Sensor Unit and stores them on the SD Memory Card inserted into the Controller. Function block Name Graphic expression...
  • Page 35 Backup_E3NW Variables Name Meaning Description Valid range Unit Default TRUE: Executes the instruction. TRUE or Execute Execute Input FALSE FALSE: Does not execute the FALSE instruction. Slave Node NodeAdr Input Specifies the node address. 1 to 512 Address Specifies the directory on the SD DirName Directory Name Input...
  • Page 36 Backup_E3NW Real Times, durations, Bit strings Integers num- dates, and text strings bers Name Execute NodeAdr DirName OverWrite TimeOut Done Busy SdoBusy Error ErrorID ErrorIDEx Sysmac Library User’s Manual for EtherCAT N-Smart Series Library (W549)
  • Page 37 • To use this function block, you need to create in advance a directory named OM_ObjList\Sensor in the root directory on the SD Memory Card and store object lists provided by OMRON in it. Be sure to store all the object list files. Then, access the object lists to back up the parameters with this function block.
  • Page 38  Procedure Create a directory named OM_ObjList\Sensor in the root directory on the SD Memory Card and store all the object lists provided by OMRON in it. Execute the function block. For NodeAdr (Slave Node Address), specify the node address of the backup target slave.
  • Page 39 Backup_E3NW  Timing Chart for Error End Scan Execute Done Busy SdoBusy Done Error ErrorID #0000 ErrorID #0000 ErrorID ErrorIDEx #00000000 ErrorIDEx #00000000 ErrorIDEx Additional Information • An object list is binary data that stores, by the revision number of EtherCAT slaves, SDO parameter information (Index, Subindex, and Complete Access) for the backup target parameters.
  • Page 40 Backup_E3NW Related System-defined Variables Name Meaning Data type Description TRUE when the SD Memory Card is recognized. It is FALSE when the SD SD Memory Card Memory Card is not recognized. _Card1Ready BOOL Ready Flag TRUE: Can be used. FALSE: Cannot be used. This table indicates the slaves that can perform message communica- tions.
  • Page 41 Backup_E3NW Expansion Error code Status Description Correction error code 16#1401 16#00000000 SD Memory An attempt was made to write Remove write protection from Card Write-pro- to a write-protected SD Mem- the SD Memory Card. Slide the tected ory Card. small switch on the side of the SD Memory Card from the LOCK position to the writable position.
  • Page 42 Backup_E3NW Expansion Error code Status Description Correction error code 16#1804 SDO Abort SDO Abort Error The cause of this error Refer to the manual for the Eth- depends on the specifications erCAT slave and correct the Code of the EtherCAT slave. problem.
  • Page 43 Backup_E3NW  External Variables Variable Data type Constant Comment Message Communications _EC_MBXSlavTbl  ARRAY[1..N ] OF BOOL Enabled Slave Table _Card1Ready BOOL SD Memory Card Ready Flag  *1. N = 192 for NJ501, NJ301 and NJ101. N = 512 for NX701. ...
  • Page 44 Backup_E3NW Sysmac Library User’s Manual for EtherCAT N-Smart Series Library (W549)
  • Page 45 Backup_E3NW  External Variables Variable Data type Constant Comment Message Communications _EC_MBXSlavTbl  ARRAY[1..N ] OF BOOL Enabled Slave Table _Card1Ready BOOL SD Memory Card Ready Flag  *1. N = 192 for NJ501, NJ301 and NJ101. N = 512 for NX701. ...
  • Page 46 Backup_E3NW IF (BackupOperating=TRUE) THEN BACKUP_E3NW_instance( Execute :=TRUE, NodeAdr:=TargetSlave, DirName:=TargetDirectory, OverWrite:=FALSE, TimeOut:=TargetTimeOut, Busy=>BackupBusy); IF (BACKUP_E3NW_instance.Done=TRUE) THEN // Processing after normal end. BackupOperating:=FALSE; END_IF; IF (BACKUP_E3NW_instance.Error=TRUE) THEN // Processing after error end. BackupOperating:=FALSE; END_IF; END_IF; // Detect when RestoreTrigger changes to TRUE. IF ( (RestoreTrigger=TRUE) AND (RestoreLastTrigger=FALSE) AND (_EC_MBXSlavTbl[TargetSlave]=TRUE) AND (_Card1Ready=TRUE) AND (BackupBusy=FALSE) AND...

  • Page 47: Restore_E3Nw

    Restore_E3NW Restore_E3NW The Restore_E3NW function block restores the backup data on the SD Memory Card to the Sensor Amplifier Unit that is connected to an E3NW-ECT Sensor Communications Unit or E3NW-DS Distrib- uted Sensor Unit. Function block Name Graphic expression ST expression name Restore_E3NW...
  • Page 48 Restore_E3NW Variables Name Meaning Description Valid range Unit Default TRUE: Executes the instruction. TRUE or Execute Execute Input FALSE FALSE: Does not execute the FALSE instruction. Slave Node NodeAdr Input Specifies the node address. 1 to 512 Address Specifies the directory on the SD Memory Card.
  • Page 49 Restore_E3NW Real Times, durations, Bit strings Integers num- dates, and text strings bers Name Execute NodeAdr DirName NoProductChk TimeOut Done Busy SdoBusy Error ErrorID ErrorIDEx Function • When Execute changes to TRUE, the Restore_E3NW function block restores the backup file(s) in the directory specified with DirName (Directory Name) on the SD Memory Card to each Sensor Amplifier Unit that is connected to the E3NW Unit specified with NodeAdr (Node Address).
  • Page 50 Restore_E3NW  Procedure Execute the function block. For NodeAdr (Slave Node Address), specify the node address of the restore target slave. If necessary, set DirName (Directory Name) and TimeOut (Timeout Time). The backup file in the directory specified with DirName (Directory Name) is restored to the E3NW Unit when execution of the function block is ended.
  • Page 51 Restore_E3NW Additional Information • For information on the characters that can be used in DirName, refer to Specifications of Supported SD Memory Cards, Folders, and Files in the software user’s manual. • Do not cycle the power supply to the E3NW Unit after completion of the restore processing. •...
  • Page 52 Restore_E3NW Related System-defined Variables Name Meaning Data type Description TRUE when the SD Memory Card is recognized. It is FALSE when the SD SD Memory Card Memory Card is not recognized. _Card1Ready BOOL Ready Flag TRUE: Can be used. FALSE: Cannot be used. This table indicates the slaves that can perform message communica- tions.
  • Page 53 Restore_E3NW Troubleshooting Expansion Error code Status Description Correction error code 16#0000 16#00000000 Normal End Specify a backup file with a The VenderID in the backup file VenderID Not VenderID that matches the 16#3C10 16#00000001 does not match the VenderID of Matched VenderID of the restore target the restore target node.
  • Page 54 Restore_E3NW Expansion Error code Status Description Correction error code The maximum number of open Correct the user program to Too Many Files 16#140B 16#00000000 files was exceeded when open- decrease the number of open Open ing a file for the function block. files.
  • Page 55 Restore_E3NW Additional Information The following gives an object list for the backup and restore targets. Refer to the E3NW-ECT EtherCAT® Digital Sensor Communication Unit Operation Manual (Cat. No. E429) for details on each object. Data attri- Supported Sensor Amplifier Unit Index Subindex Access...
  • Page 56 Restore_E3NW Sysmac Library User’s Manual for EtherCAT N-Smart Series Library (W549)

  • Page 57: Appendix

    Appendix Sysmac Library User’s Manual for EtherCAT N-Smart Series Library (W549)

  • Page 58: Referring To Library Information

    Referring to Library Information Referring to Library Information When you make an inquiry to OMRON about the library, you can refer to the library information to iden- tify the library to ask about. The library information is useful in identifying the target library among the libraries provided by OMRON or created by the user.
  • Page 59 Referring to Library Information Referring to Attributes of Libraries, Function Blocks and Functions You can refer to the attributes of libraries, function blocks and functions of the library information at the following locations on the Sysmac Studio. • Library Reference Dialog Box •...
  • Page 60 Select a function block and function to display its library information at the bottom of the Toolbox Pane. The text “by OMRON” which is shown on the right of the library name (1) indicates that this library was provided by OMRON.

  • Page 61: Referring To Function Block And Function Source Codes

    Referring to Function Block and Function Source Codes You can refer to the source codes of function blocks and functions provided by OMRON to customize them to suit the user’s environment. User function blocks and user functions can be created based on the copies of these source codes.
  • Page 62 Referring to Function Block and Function Source Codes Sysmac Library User’s Manual for EtherCAT N-Smart Series Library (W549)
  • Page 64 The Netherlands Hoffman Estates, IL 60169 U.S.A. Tel: (31)2356-81-300/Fax: (31)2356-81-388 Tel: (1) 847-843-7900/Fax: (1) 847-843-7787 © OMRON Corporation 2015-2019 All Rights Reserved. OMRON (CHINA) CO., LTD. OMRON ASIA PACIFIC PTE. LTD. In the interest of product improvement, Room 2211, Bank of China Tower, No.

Table of Contents