Home

netSCOPE - Instrument Driver for LabVIEW

1. 15pt Application Font Bes or SS p Graph update interval ms Number of values to display elect Interface 250 r 100000 Display of numeric boolean and bit data types 1 Configure Variables Set Bus Inactive Stop Capture 47 l I I l 12 12 30 297873974 12 12 31 297873974 12 12 32 297873974 12 12 33 297873974 12 12 34 29 13 11 2013 13 11 2013 13 11 2013 13 11 2013 13 11 Time EST ER Display of string data types P Jo timestamg Event List Timestamp Event Additional info T Search pH buffer fill level 0 current write position 0 newest stored time 00 00 00 000000000 DD MM YYYY oldest stored time 00 00 00 000000000 DD MM YYYY 12 12 31 000 13 11 2013 Instrument connected to bus Evaluation Figure 5 netSCOPE Ivlib Interactive Example vi Front Panel gt Click Run netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW 14 94 2 Select Interface is enabled 3 netSCOPE lvlib Interactive Ex File Edit View Project Operate Tools Window Help Graph update interval ms Number of values to display b i ei J 250 y 100000 Display of numeric boolean and bit data types onfiqure Variables d zi I 1 1 12 12 30 297873974 12 12 31 297873974 12 12 32 297873974 12 12 33 297873974 13 11 20
2. Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE lvlib EtherCAT Select Variables Dialog vi 43 94 Done gt Click on Done The netSCOPE Ivlib EtherCAT Select Variables Dialog vi pane is closed dv The newly defined variables are saved 3 4 2 3 Controls and Indicators in the Frontpanel error in no error status code instrument handle in Le di E System Handle source o 8 Target System d 1 i A PROFINET Instrument name Instance Handle 00000000 Known Symbols error out code 4h amp urce p selected variable IDs instrument handle out System Handle Target System PROFINET Instrument name m Instance Handle oggggggg E nawn Symbols Figure 33 netSCOPE Ivlib netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal EtherCAT Select Variables Dialog vi Controls and Indicators Hilscher 2013 Instrument Driver for LabVIEW netSCOPE Ivlib Get Capture Buffer State vi 44 94 3 5 Public Action Status 3 5 1 netSCOPE Ivlib Get Capture Buffer State vi Gets the current state of the capture ring buffer instrument handle out buffer fill level SS current write position 75 aldest stored time newest stored time error out Figure 34 netSCOPE Ivlib Get Capture Buffer State vi instrument handle
3. instrument handle in instrument handle out error in no error error out Stops the capture task for process data values After stopping no new data will be stored in the capture ring buffer but yet captured data is still available For details see section netSCOPE Ivlib Stop Capture vi on page 52 e Set Bus Inactive vi instrument handle in OL instrument handle out error in no error error out Deactivates the physical connection to the communication bus or network If a capture is running is must be stopped via the Stop Capture VI first For details see section netSCOPE Ivlib Set Bus Inactive vi on page 50 e Close Instrument vi instrument handle system handle error in no error error out Closes an instrument and returns the system handle the instrument belongs to This will discard all configurations and captured ring buffer data for this instrument The Instrument will not be accessible anymore unless it is reopened via the Initialize Instrument VI For details see section netSCOPE Ivlib Close Instrument vi on page 83 e Close System vi system handle error in no error EI Closes a system All instruments belonging to this system will be closed automatically all captured ringbuffer data in this system will be discarded For details see section netSCOPE lvlib Close System vi on page 84 e Error Description vi error descriptions out error cades out This VI returns all netSCOPE specific er
4. Instrument Driver for LabVIEW netSCOPE Ivlib Revision Query vi 82 94 3 10 7 netSCOPE Ivlib Revision Query vi Queries version information of all netSCOPE software and hardware modules revision infa error out error in no error Figure 58 netSCOPE lvlib Revision Query vi error in no error describes error conditions that occur before this VI runs The default input of this cluster is no error If an error already occurred this VI returns the value of error in in error out The VI runs normally only if no incoming error exists Otherwise the VI passes the error in value to error out The error in cluster contains the following parameters status is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE code is the error or warning code The default is O If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error H revision info Includes version information of individual system components driver version ringbuffer version Revision Info Entry Structure with version information Component Name Name of the component Component Details Version information error out
5. The default is O If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE Ivlib lnitialize Instrument vi 85 94 3 11 3 netSCOPE Ivlib lnitialize Instrument vi Initialize one instrument specified by its name This VI must be called once before using any instrument specific VIs system handle instrument handle system ID instrument name error in no error error out Figure 61 netSCOPE Ivlib lnitialize Instrument vi es system handle in Valid system handle generated by Initialize System vi see section netSCOPE Ivlib lnitialize System vi page 86 system ID Target system identifier instrument name Name of the instrument that should be initialized error in no error describes error conditions that occur before this VI runs The default input of this cluster is no error If an error already occurred this VI returns the value of error in in error out The VI runs normally only if no incoming error exists Otherwise the VI passes the error in value to error out The error in cluster contains the following parameters sta
6. Variable n Data Offset Variable n Length Variablen Data Normalization Normalize Variable Value Normalization Slope Din Normalization Offset d 0 s 00000001 Variable Byte Order Datagram Length DEC LITTLE ENDIAN BYTE ORDER A g Expected WKC Fy y Add Variable Arte I Cancel Figure 50 EtherCAT Datagram and Variable Definition Variable Name EtherCAT variable 02 Command Datagram Header Area This selection specifies the EtherCAT command executed in the EtherCAT datagram Corresponds to the EtherCAT command specified in the Command field of the EtherCAT datagram The following EtherCAT commands are defined in the EtherCAT specification netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE lvlib EtherCAT Get Specific Variable Definition vi 69 94 FRMW Configured address physical read multiple write Table 6 EtherCAT Commands DH Command Address Datagram Header Area This value is specified as a hexadecimal address Corresponds to the address specified in the Command field of the EtherCAT datagram address The allowed value range extends from 0x0 to OXFFFFFFFF Working Counter Datagram Header Area Expected value of the working counter Corresponds to the value specified in the field Expected WKC of the EtherCAT datagram The allowed value range extends from
7. accompanying texts and documentation at all times and without advance notice without obligation to report the change Changes will be included in future manuals and do not constitute any obligations There is no entitlement to revisions of delivered documents The manual delivered with the product applies Hilscher Gesellschaft f r Systemautomation mbH is not liable under any circumstances for direct indirect incidental or follow on damage or loss of earnings resulting from the use of the information contained in this publication netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Introduction 7 94 1 2 3 Exclusion of Liability The software was produced and tested with utmost care by Hilscher Gesellschaft f r Systemautomation mbH and is made available as is No warranty can be assumed for the performance and flawlessness of the software for all usage conditions and cases and for the results produced when utilized by the user Liability for any damages that may result from the use of the hardware or software or related documents is limited to cases of intent or grossly negligent violation of significant contractual obligations Indemnity claims for the violation of significant contractual obligations are limited to damages that are foreseeable and typical for this type of contract It is strictly prohibited to use the software in the following areas e
8. bus bus Capturing of data is not longer possible Access to internal instrument functionality failed The Instrument Error instrument specific error code is transmitted in OXXXXXXXX Additional Information field Detailed description of error codes see in the netSCOPE documentation Instrument access failed License for this product is not The license for this product is not activated The activated capturing of data was automatically stopped Internal backend module Ringbuffer reports no free system memory Ecat out of memory een Internal backend module EtherCAT Decoder reports The data type of read data is incompatible to defined Incompatible data type data types in LabVIEW The execution of Read Data vi is broken Ringbuffer out of memory Table 3 Important Error Codes possible Causes and Troubleshooting netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE Ivlib Ringbuffer Configuration vi 57 94 3 7 2 netSCOPE Ivlib Ringbuffer Configuration vi Configures the ringbuffer storage size in Megabytes and location RAM storage location does not need a save path HDD storage location needs a save path to be specified Note that HDD storage is most likely less performant than RAM storage ringbuffer save path instrument handle in ringbuffer size MByte ringbuffer save location R
9. netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE Ivlib Select Device Frontpanel vi 32 94 Target System jJ EtherCAT Device Name netANALYZER 2 system ID EtherCAT instrument name instruments list system handle in system handle out 0 0 Figure 24 netSCOPE lvlib Select Device Frontpanel vi Front Panel In the netSCOPE Ivlib Select Device Frontpanel vi pane gt Select the Target System EtherCAT gt Click Identify device to identify your device optionally The STAO and the STA1 LED at the netSCOPE data acquisition card blink green for approx 10 sec gt Click Select device and select your device gt The netSCOPE Ivlib Select Device Frontpanel vi is in Stop mode netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE Ivlib EtherCAT Add or Modify Variable Dialog vi 33 94 3 4 Examples Helpers EtherCAT 3 4 1 netSCOPE Ivlib EtherCAT Add or Modify Variable Dialog vi Adds or modifies the EtherCAT specific definition of the given variable EtherCAT specific VI instrument handle in SOP instrument handle out variable ID in error in no error Figure 25 netSCOPE Ivlib EtherCAT Add or Modify Variable Dialog vi error aut ins
10. occurred this VI returns the value of error in in error out The VI runs normally only if no incoming error exists Otherwise the VI passes the error in value to error out The error in cluster contains the following parameters status is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE code is the error or warning code The default is O If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error system handle out Valid system handle generated by Initialize System vi see section netSCOPE lvlib Initialize System vi page 86 instruments list A list of available instruments found on the system instruments list Structure with device information Instruments list Device number of the instrument Device number 7330100 NSCP C100 RE 50 7330101 NSCP C100 RE 50E 7330102 NSCP C100 RE 70E 7330103 NSCP C100 RE 80 7330105 NSCP C100 RE 90E Serial number Serial number of the instrument Device Class Device class of the instrument Name Instrument name error out contains error information If error in indicates that an error occurred before this VI or function ran error out cont
11. Automation GmbH Laboratory Virtual Instrumentation Engineering Workbench netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Appendix 93 94 LabVIEW is a graphical programming system from National Instruments It is the leading graphical programming language for measurement and automation applications netSCOPE Hilscher s netSCOPE is a tool to capture network traffic from Real Time Ethernet systems and to display data content for analysis purposes VI Virtual Instrument LabVIEW programs subroutines are called virtual instruments VIs netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Appendix 5 5 Contacts Headquarters Germany Hilscher Gesellschaft f r Systemautomation mbH Rheinstrasse 15 65795 Hattersheim Phone 49 0 6190 9907 0 Fax 49 0 6190 9907 50 E Mail info hilscher com Support Phone 49 0 6190 9907 99 E Mail de support hilscher com Subsidiaries China Hilscher Systemautomation Shanghai Co Ltd 200010 Shanghai Phone 86 0 21 6355 5161 E Mail info hilscher cn Support Phone 86 0 21 6355 5161 E Mail cn support hilscher com France Hilscher France S a r l 69500 Bron Phone 33 0 4 72 37 98 40 E Mail info hilscher fr Support Phone 33 0 4 72 37 98 40 E Mail fr support hilscher com
12. English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE Ivlib EtherCAT Load ENI File vi 72 94 3 9 9 netSCOPE Ivlib EtherCAT Load ENI File vi Loads all variables from the given ENI file EtherCAT specific VI instrument handle in ENI file path error in no error Figure 51 netSCOPE Ivlib EtherCAT Load ENI File vi instrument handle out error out instrument handle in identifies a particular instrument session ENI file path Path to the EtherCAT specific ENI file error in no error describes error conditions that occur before this VI runs The default input of this cluster is no error If an error already occurred this VI returns the value of error in in error out The VI runs normally only if no incoming error exists Otherwise the VI passes the error in value to error out The error in cluster contains the following parameters status is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE code is the error or warning code The default is O If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error instrument handle out
13. Ivlib Read Data vi 61 94 Variable ID Value Value of the variable ID Instance Handle Internal driver information timestamp list in Timestamp array with pre initialized size value list in Value array with pre initialized size The data type of this array should match the expected value data type status list in State array with pre initialized size error in no error describes error conditions that occur before this VI runs The default input of this cluster is no error If an error already occurred this VI returns the value of error in in error out The VI runs normally only if no incoming error exists Otherwise the VI passes the error in value to error out The error in cluster contains the following parameters status is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE code is the error or warning code The default is O If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error instrument handle out has the same value as the instrument handle count of read values Counter that indicates how many values were read from the ringbuffer relevant for timestamp list out value list ou
14. Project Operate Tools Window Help Graph update interval ms Number of values to display Configure Variables Display of numeric boolean and bit data types Set Bus Active 17 I l 12 12 30 297873974 12 12 31 297873974 12 12 32 297873974 12 12 33 297873974 12 12 34 29 13 11 2013 13 11 2013 13 11 2013 13 11 2013 13 11 Time buffer fill level A wi 0 Display of string data types a 0 current write position timesta I 0 newest stored time 00 00 00 000000000 DD MM YYYY oldest stored time 00 00 00 000000000 DD MM YYYY Event List Timestamp Additional info Evaluation Figure 14 netSCOPE Ivlib Interactive Example vi Front Panel Via Set Bus Active the netSCOPE data acquisition card is started Set Bus Active changes to Set Bus Inactive 6 The netSCOPE data acquisition card is activated on the bus and ready for data capturing The measurement and data capturing are not yet started netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW 21 94 3 2 1 5 Start Capture gt Select Start Capture netSCOPE lvlib Interacti mo s File Edit View Project Operate Tools Window Help Sei Graph update interval ms Number of values to display n n J 250 J 100000 Configure Variables Display
15. RE ECS 1 RxPDO 1 Byte Out 1 Box 1 CIFX RE ECS 1 RXPDO 1 Byte Qut 2 Box 1 CIFX RE ECS 1 RxPDO 1 Byte Out 3 Box 1 CIFX RE ECS 1 RxPDO 1 Byte Out 4 Box 1 CIFX RE ECS 1 RxPDO 1 Byte Out 5 Box 1 CIFX RE ECS 1 RxPDO 1 Byte Out 6 Box 1 CIFX RE ECS 1 RxPDO 1 Byte Out 7 Box 1 CIFX RE ECS 1 RxPDO 1 Byte Out 8 Box 1 CIFX RE ECS 1 RxPDO 1 Byte Out 9 x 1 CIFX RF FC amp 1 Ref Rete Qut 01 00 K Figure 10 netSCOPE Ivlib EtherCAT Select Variables Dialog vi Available Variables netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW 17 94 Under Available Variables you can remove a variable clear all variables add a variable manually or edit a variable Remove selected To remove a variable from the Available Variables list gt Select the variable to be removed gt Click on Remove selected Clear list To clear the total Available Variables list gt Click on Clear list Manually add variable To add a variable manually to the Available Variables list gt Click on Manually add variable The netSCOPE Ivlib Add or Modify Variable Dialog vi pane is Variable n Data tt Offset Offset Offset Variable 1 Variable 2 Variable n wt a Length Length Length Variable 1 Variable 2 Variablen Data Flow Direction A Variable ID Data Normalizati
16. Specific Variable Definition vi 70 94 Data Type Number of Bits Range of Value Long Float VISIBLE_STRING Visible string 1 octet per character OCTET_STRING Sequence of octets ENE ODE SEG Sequence of UNIT w Table 7 Supported Data Types in EtherCAT OO Variable Direction Data Flow Area Indicates the signal direction and can either have the value input or output Cod Variable Byte Order Variable Definition Area This value indicates the byte order used in the internal representation of the variable currently to be defined Possible values are DEC LITTLE ENDIAN BYTE ORDER Intel format which means the most significant byte comes first the less significant comes last DEC BIG ENDIAN BYTE ORDER Motorola format which means the less significant byte comes first the most significant byte comes last Name Variable Definition Area This value indicates the full name of the variable currently to be defined Normalization Slope Data Normalization Area The data can be normalized if necessary by multiplication by a normalization factor and adding a normalization offset In this field the normalization factor can be specified Normalization Offset Data Normalization Area The data can be normalized if necessary by multiplication by a normalization factor and adding a normalization offset In this field the normalization offset can be specified H Variable ID Variable Definition Area ID that uniquely identifie
17. before this VI or function ran error out contains the same error information Otherwise it describes the error status that this VI or function produces status is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE code is the error or warning code The default is O If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE Ivlib Get Capture Buffer State vi 45 94 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE Ivlib Get Ethernet Port State vi 46 94 3 5 2 netSCOPE Ivlib Get Ethernet Port State vi Gets the state of the Ethernet capture ports of the instrument instrument handle in instrument handle out error in no error Ethernet port 0 state Ethernet port 1 state error out Figure 35 netSCOPE Ivlib Get Ethernet Port State vi instrument handle in identifies a particular
18. error out The VI runs normally only if no incoming error exists Otherwise the VI passes the error in value to error out The error in cluster contains the following parameters status is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE code is the error or warning code The default is O If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error EtherCAT variable definition Cluster of specific EtherCAT variable definition netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 EtherCAT Datagram and Variables Definition Instrument Driver for LabVIEW netSCOPE Ivlib EtherCAT Get Specific Variable Definition vi 68 94 has am Exp ected Variable 1 Vari able 2 Data Data Offset Offset Variable 1 Variable Length Length Variable 1 Variable 3 Data Flow Variable Definition Direction Variable ID Fh y 100 E Input Data Start Offset Bits in Datagram Datagram Header H H EH Variable Length Bits APRD GC Command Address An Si Variable Representation DEC_DATATYPE_BOOLEAN
19. error status that this VI or function produces status is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE code is the error or warning code The default is O If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE Ivlib EtherCAT Configure Detection vi 54 94 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE Ivlib Register Notification Event Handler vi 55 94 3 Public Configure 3 7 1 netSCOPE Ivlib Register Notification Event Handler vi Registers an user event which will be issued every time a status or error notification is generated by an instrument see section Notification Events on page 56 instrument handle in instrument handle outindle user event error in no error error out Figure 42 netSCOPE Ivlib Register Notification Event Handler vi instrument han
20. for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE Ivlib Get Generic Variable Definition vi 76 94 status is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE code is the error or warning code The default is O If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE Ivlib Get Instrument List vi 77 94 3 10 3 netSCOPE Ivlib Get Instrument List vi Returns a list of all instruments of the system system handle in system handle out instruments list error out errar in na error Figure 54 netSCOPE Ivlib Get Instrument List vi us system handle in Valid system handle generated by Initialize System vi see section netSCOPE Ivlib lnitialize System vi page 86 error in no error describes error conditions that occur before this VI runs The default input of this cluster is no error If an error already
21. for military purposes or in weapon systems e for the design construction maintenance or operation of nuclear facilities e in air traffic control systems air traffic or air traffic communication Systems e in life support systems e in systems in which failures in the software could lead to personal injury or injuries leading to death We inform you that the software was not developed for use in dangerous environments requiring fail proof control mechanisms Use of the software in such an environment occurs at your own risk No liability is assumed for damages or losses due to unauthorized use 1 2 4 Warranty Although the hardware and software was developed with utmost care and tested intensively Hilscher Gesellschaft f r Systemautomation mbH does not guarantee its suitability for any purpose not confirmed in writing It cannot be guaranteed that the hardware and software will meet your requirements that the use of the software operates without interruption and that the software is free of errors No guarantee is made regarding infringements violations of patents rights of ownership or the freedom from interference by third parties No additional guarantees or assurances are made regarding marketability freedom of defect of title integration or usability for certain purposes unless they are required in accordance with the law and cannot be limited Warranty claims are limited to the right to claim rectification netSCOPE
22. gets process data from the automation network and provides the process data to LabVIEW Users can program their application in LabVIEW In LabVIEW first the netSCOPE data recording card is initialized then the signals to be detected are parameterized then the process values can be recorded and processed in LabVIEW po De X49 x After the measurement is complete the netSCOPE data recording card is closed Use Cases e Machine condition monitoring visualization The netSCOPE device acquires process data The user implements condition monitoring tasks and visualization in LabVIEW e Process documentation netSCOPE device acquires process data User implements documentation tasks and database connection in LabVIEW Generic Variable Definition Note If possible avoid to use specific variable definitions Instead use generic variable definitions This allows you to reuse the variable definitions for other systems netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Overview 10 94 2 2 netSCOPE System Data Flow The netSCOPE for LabVIEW instrument driver supports process data recording with multiple netSCOPE data acquisition cards at the same time The process data captured from the network is stored in an individual ring buffer of the PC Depending on the user configuration the ring buffer is being created either in the main memory RAM
23. gt hilscher COMPETENCE IN COMMUNICATION Operating Instruction Manual netSCOPE Instrument Driver for LabVIEW netSCOPE Data al a CF HSCF 1 H k al a 1 H k Eu E e E Fd E HE HE HE 27 Data Action Status Close Instru Close Syste Configure Controls Data 1 H F E Ed E Initialize Instr Initialize Syst Utility Close instrument Initialize instrument Hilscher Gesellschaft fur Systemautomation mbH www hilscher com DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Table of Contents 2 94 Table of Contents 1 INTRODUCTION E 4 1 1 leie n EC nl E E 4 1 1 1 le leen EE 4 1 1 2 EISEORHEVISIONS staat Ge i es ee 4 1 1 3 Gonvenuons e RE Ta EEN 5 1 2 Er HRS 6 1 2 1 GOD VU IN essen 6 1 2 2 HMDORMANEIN OCS EE 6 1 2 3 EXCIUSIONMOE BE el TEE 7 1 2 4 LA ge sista een Vene unsere 7 1 2 5 eet EE 8 1 2 6 Registered Trademarks eene nnne nnne nnn nnn nnns 8 2 OVERVIEW C 9 2 1 About netSCOPE Tor LabVIEW usen oer rrt een 9 2 2 nelbCOPE System Data FOW otio erre RE amos eti OD es 10 3 INSTRUMENT DRIVER FOR LARVIEW menn 11 3 1 Opening LabVIEW netSCOPE Ivlib and VT 11 3 2 E KATA ISS au re fame quom Eden heine 13 3 2 1 netSCOPE Ivlib Interactive Example vi 13 3 2 2 NetSCOPE WMIB Simple Example Vi Arsen a bd 23 3 3 Example5S e El EE 30 3 3 1 netSCOPE Ivlib Select Device Frontpoanel wv 30
24. has the same value as the instrument handle error out contains error information If error in indicates that an error occurred before this VI or function ran error out contains the same error information Otherwise it describes the error status that this VI or function produces status is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE code is the error or warning code The default is O If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE Ivlib Error Descriptions vi 73 94 3 10 Public Utility 3 10 1 netSCOPE Ivlib Error Descriptions vi This VI returns all netSCOPE specific error codes and descriptions Useful to be connected to the General Error Handler Vis user defined codes and user defined descriptions inputs error descriptions out error codes out Figure 52 netSCOPE Ivlib Error Descriptions vi error descriptions out Error code error codes out Error short description netSCOP
25. instrument session error in no error describes error conditions that occur before this VI runs The default input of this cluster is no error If an error already occurred this VI returns the value of error in in error out The VI runs normally only if no incoming error exists Otherwise the VI passes the error in value to error out The error in cluster contains the following parameters status is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE code is the error or warning code The default is O If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error instrument handle out has the same value as the instrument handle Ethernet port 0 state Current state information of the netSCOPE instrument on the port 0 Ethernet link up Current link state of this port FALSE link down TRUE link up Correct frames Total number of successfully received Ethernet frames RX_ER errors Total number of faulty received Ethernet frames bel Alignment errors Number of frames with alignment errors 1 additional nibble received FCS errors Number of frames with a bad FCS including short frames
26. no error occurred before this VI or function ran The default is FALSE code is the error or warning code The default is O If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE Ivlib EtherCAT Add or Modify Variable Dialog vi 34 94 3 4 1 1 Open Front Panel configure Variable In the LabVIEW netSCOPE Ivlib on Main Application Instance Items pane gt Select the Items tab gt netSCOPE lvlib gt Examples gt Helpers gt EtherCAT gt Double click to netSCOPE Ivlib EtherCAT Add or Modify Variable Dialog vi The Front Panel view of the netSCOPE Ivlib Add or Modify Variable Dialog vi is displayed gt Click Run 2 Add Variable is enabled Ether CAT Datagram and Variables Definition eg am Dee ected Variable 1 Variable 2 Variable n Data Data Data tt Offset Offset Offset Variable 1 Variable 2 Variable n Length Length Length Variable 1 Variable 2 Vari able n Data Flow Variable Definition Direction Ei b Input Variable ID Data Mormalization Fi ST Datagram Header Command APRD Gs Command Address 00000001
27. no incoming error exists Otherwise the VI passes the error in value to error out The error in cluster contains the following parameters status is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE code is the error or warning code The default is O If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error instrument handle out has the same value as the instrument handle selected variable IDs An array of variable identifiers of all selected variables error out contains error information If error in indicates that an error occurred before this VI or function ran error out contains the same error information Otherwise it describes the error status that this VI or function produces status is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE code is the error or warning code The default is O If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code 35 8 source identifies where an error occurred The sourc
28. or function ran error out contains the same error information Otherwise it describes the error status that this VI or function produces status is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE code is the error or warning code The default is O If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE Ivlib Ringbuffer Configuration vi 58 94 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE Ivlib Unregister Notification Event Handler vi 59 94 3 7 3 netSCOPE Ivlib Unregister Notification Event Handler vi Unregisters the instruments notification user event handler No more user events will be issued instrument handle in instrument handle out error in no error error out Figure 44 netSCOPE Ivlib Unregister Notification Event Handler vi instrument handle in identifies a
29. session regular expression Variable name error in no error describes error conditions that occur before this VI runs The default input of this cluster is no error If an error already occurred this VI returns the value of error in in error out The VI runs normally only if no incoming error exists Otherwise the VI passes the error in value to error out The error in cluster contains the following parameters status is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE code is the error or warning code The default is O If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error instrument handle out has the same value as the instrument handle variable ID list An array of variable identifiers that match the given variable name variable ID Identifier of the variable that should be read from the ring buffer Variable ID Value Value of the variable ID Instance Handle Internal driver information error out contains error information If error in indicates that an error occurred before this VI or function ran error out contains the same error information Otherwise it describ
30. the capturing of the data is no longer possible Instrument is connected to the bus but stopped because an internal instrument error occurred the capturing of data is not longer possible capture state Current capture state of the instrument Data capturing is started Data capturing is stopped error out contains error information If error in indicates that an error occurred before this VI or function ran error out contains the same error information Otherwise it describes the error status that this VI or function produces status is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE code is the error or warning code The default is 0 If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE Ivlib Set Bus Active vi 49 94 3 5 4 netSCOPE Ivlib Set Bus Active vi Activates the physical connection to the communication bus or network This is a prerequisite before calling the Start Capture VI ins
31. with a bad FCS Frame length errors Number of frames with invalid Ethernet frame length SFD errors Number of Ethernet frames with a SFD Start of frame delimiter errors Preamble length errors Number of frames with invalid length of preamble netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE Ivlib Get Ethernet Port State vi 47 94 Average bus load Bus load on this port in percent Ethernet speed Current Ethernet speed 10MBit or 100MBit Ethernet port 1 state Current state information of the netSCOPE instrument on the port 1 Ethernet link up Current link state of this port 0 link down 1 link up Correct frames Total number of successfully received Ethernet frames RX_ER errors Total number of faulty received Ethernet frames russ Alignment errors Number of frames with alignment errors 1 additional nibble received FCS errors Number of frames with a bad FCS including short frames with a bad FCS Frame length errors Number of frames with invalid Ethernet frame length SFD errors Number of Ethernet frames with a SFD Start of frame delimiter errors Preamble length errors Number of frames with invalid length of preamble Average bus load Bus load on this port in percent Ethernet speed Current Ethernet speed 10MBit or 100MBit error out contains error information If error in indica
32. 0 to 65535 DESCH Command Length Datagram Header Area Length of the datagram expressed as the number of bits in the datagram Corresponds to the length specified in the Datagram Length field of the EtherCAT datagram Variable Bit Address Variable Definition Area Data Start Offset Bits in Datagram This value indicates the offset of the variable currently to be defined relative to the beginning of the data field data in the EtherCAT datagram It is expressed as the number of bits counted from the memory location of the first bit of the first variable of the data field If the variable currently to be defined is the first in the data field the value is O Generic Variable Definition Cluster of generic variable definition Variable Data Type Variable Definition Area This value specifies the data type of the variable currently to be defined The following data types are supported in EtherCAT Boer 1 TRUE Rm CO nn am genge In 49M KREE wm RR EC wo o o gt o 7 o BE E BE BEE wm TI en uv ane In vam Unsigned stoninteger 8 0 85 Umm 2 up Unsigned doubleinteger Uva 4 Um 4 SR EC m In UINT56 ULINT Unsigned long integer netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 0 ae 0 65535 Instrument Driver for LabVIEW netSCOPE Ivlib EtherCAT Get
33. 0050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Error Codes 89 94 Value Error Code Description Definition 0x8021000C NETANA_TRANSFER Transfer timed out _TIMEOUT 0x8021000D NETANA IRQEVENT _ Error creating interrupt events CREATION FAILED 0x8021000E NETANA_IRQLOCK_ Error creating internal IRQ locks CREATION FAILED Table 12 Toolkit Errors Description 4 5 Driver Errors Value Error Code Description Possible Causes Troubleshooting Definition 0x80220002 NETANA_ netANALYZER The netANALYZER Install the netANALYZER DRIVER_NOT_ netSCOPE Windows netSCOPE Windows netSCOPE Windows Device RUNNING Device Driver is not Device Driver is not Driver running installed The netANALYZER The netANALYZER hardware netSCOPE Windows installed in the PC and connect Device Driver is installed but the netANALYZER hardware is not installed in the PC or not connected The netSCOPE Enable the netSCOPE device in device is disabled in Device Manager the device manager 0x80220003 NETANA_ Device with the given The netSCOPE Update the netSCOPE Software DEVICE NOT name does not exist device was removed device list FOUND from the PC during operation of the netSCOPE software 0x80220004 NETANA_ Device is stillinuse by The netSCOPE Close the netSCOPE device in DEVICE_STILL another application device was already the other application or select OPEN opened in another an
34. 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE lvlib EtherCAT Select Variables Dialog vi 41 94 EtherCAT Datagram and Variables Definition ee am Exp setae Variable 1 Variable 2 Variable n Data Data TE Data tt Offset Offset Offset Variable 1 Variable 2 Variable n TT ne Length Length Length Variable 1 Variable 3 Variablen Data Flow Variable Definition Direction A Variable ID Data Normalization ei Input j Data Start Offset Bits in Datagram Normalize Variable Value gt Datagram Header J 120 Variable Length Bits Command A SS sch 8 j y ARD E Normalization Offset Normalization Slope Variable Representation DEC_DATATYPE_UNSIGNEDS Command Address Io 01000800 l Variable Byte Ord Datagram Length EE A DEC LITTLE ENDIAM BYTE ORDER 16 v Expected WKC E b 1 Variable Mame Box 1 CIFX RE ECS 1 TxPDO 1 Byte In 15 Figure 31 netSCOPE Ivlib Add or Modify Variable Dialog vi The single variable definition values as described in the table Supported Data Types in EtherCAT on page 75 Editor change the values gt Click on Modify Variable below the entry fields The variable definition values are changes and the netSCOPE Ivlib Add or Modify Variable Dialog vi pane is closed netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument
35. 13 13 11 2013 13 11 2013 13 11 2013 Time HE Display of string data types buffer fill level 0 current write position timestamp 0 newest stored time 00 00 00 000000000 DD MM YYYY oldest stored time 00 00 00 000000000 DD MM YYYY Event List Timestamp Additional info Evaluation Figure 6 netSCOPE Ivlib Interactive Example vi Front Panel gt Click on Select Interface The Select Device Frontpanel pane is opened Target System a y Ether CAT Device Name Serial Number netS C OPE 1 Select device Tdentify device Figure 7 netSCOPE Ivlib Interactive Example vi Select Device Frontpanel vi netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW 15 94 Inthe Select Device Frontpanel pane gt gt gt gt Select the Target System EtherCAT Click Identify device to identify your device optionally The STAO and the STA1 LED at the netSCOPE data acquisition card blink green for approx 10 sec Click Select device and select your device The Select Device Frontpanel pane is closed 3 2 1 2 Configure Variables Configure Variables and Set Bus Active are enabled netSCOPE lvlib er tive Example File Edit View Project Operate Tools Window Help AC Select Interface Configure Variables Set Bus Activ
36. 3 4 Examples Helpers ElherCAl ana eisen aaa 33 3 4 1 netSCOPE lvlib EtherCAT Add or Modify Variable Dialog vi 33 3 4 2 netSCOPE lvlib EtherCAT Select Variables Dialog vi 37 3 5 PUBIC ACION S All E 44 3 5 1 netSCOPE Ivlib Get Capture Buffer Gate vi 44 3 5 2 netSCOPE Ivlib Get Ethernet Port Giate vi 46 3 5 3 netSCOPE Ivlib Get Instrument State vi 48 3 5 4 netSCOPE viib Set Bus ACIIV6 VI or dee dese cele ea 49 3 5 5 netSCOPE lvlib Set Bus Inactive vi 50 3 5 6 netSCOPE Ivlib Start Capture vi 51 3 5 7 netSCOPE lvlib Stop CAPU Vikonda e aas 52 3 6 Publie Configure BIBeI ONT EE 53 3 6 1 netSCOPE lvlib EtherCAT Configure Detechon vi 53 3 7 PUIG en tre EE 55 3 7 1 netSCOPE Ivlib Register Notification Event Handler vi 55 3 7 2 netSCOPE Ivlip Ringbuffer Confouraton vi 57 3 7 3 netSCOPE Ivlib Unregister Notification Event Handler vi 59 3 8 Publie Data ana HH 60 netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Table of Contents 3 94 3 8 1 netSCOPE lvlib Read Dalai Vi na aaa 60 3 9 P blic Bir S xi in 1167 au a 63 3 9 1 netSCOPE lvlib EtherCAT Add or Modify Variable vi 63 3 9 2 netSCOPE lvlib EtherCAT Get S
37. 5003 Target system not The selected target system isn t supported of netSCOPE supported 5004 Error loading backend Loading of internal DLL components is failed DLLs 5005 Error loading file Loading of ENI file is failed Invalid path was specified or imported file has incorrect format 5006 Variable ID not found The variable with the specified ID wasn t found in variable list 5007 Array sizes don t match The size of timestamp data and valid array don t match 5008 Incompatible data type The variable data type don t match with defined LabVIEW data types see Variable Data Type ctl 5009 Out of memory No more free system memory available 5010 Unknown interface Unknown backend interface command command 501 1 Invalid instance handle Invalid instance handle 0x00000000 Open Instrument vi wasn t executed or during the execution failed 5012 System not initialized System not initialized Initialize System vi wasn t executed or during the execution failed 5014 Invalid parameter Invalid parameter in the calling VI 5100 Instrument access failed Access to internal instrument functionality is failed It triggers a notification event which contains a detailed description of this error 5101 Instrument invalid Wrong configuration parameter internal instrument error parameter 5102 Instrument not found Instrument with passed name wasn t found internal instrument error 5103 Instrument IOCTL failed General error at sending o
38. AM error in no error Figure 43 netSCOPE Ivlib Ringbuffer Configuration vi instrument handle out errar out ringbuffer save path Path of the ring buffer location on the HDD instrument handle in identifies a particular instrument session ringbuffer size MByte Size of the ring buffer ringbuffer save location RAM Specifies where the ring buffer should be created RAM HDD error in no error describes error conditions that occur before this VI runs The default input of this cluster is no error If an error already occurred this VI returns the value of error in in error out The VI runs normally only if no incoming error exists Otherwise the VI passes the error in value to error out The error in cluster contains the following parameters status is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE code is the error or warning code The default is O If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error instrument handle out has the same value as the instrument handle error out contains error information If error in indicates that an error occurred before this VI
39. AT Datagram and Variables Definition les am Ep ected Variable 1 Variable 2 Variablen Data Data Data tt Offset Offset Offset Variable 1 Variable 3 Variable n M Length Length Length Variable 1 Variable 2 Variablen Data Flow Variable Definition Direction An Variable ID Data Normalization E Input A Fh 7 Ze Datagram Header Command APRD i Command Address Data Start Offset Bits in Datagram Z A 0 y Variable Length Bits A y Variable Representation Normalize Variable Value gt Normalization Slope Mormalization Offset DEC_DATATYPE_BOOLEAN d Variable Byte Order Datagram Length DEC LITTLE ENDIAM BYTE ORDER be p Expected WKC n b D Variable Name Add Variable Eh Cancel Figure 30 netSCOPE Ivlib Add or Modify Variable Dialog vi gt Enter the single variable definition values as described in the table Supported Data Types in EtherCAT on page 75 gt Click on Add Variable below the entry fields 2 The variable definition values for the new variable are stored and the netSCOPE Ivlib Add or Modify Variable Dialog vi pane is closed Edit variable To edit a variable given in the Available Variables list Click on Edit variable The netSCOPE Ivlib Add or Modify Variable Dialog vi pane is displayed showing the variable definition values of the selected variable netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision
40. DD M Ether CAT W 2 HSCE ooo SAM LEE mr aA Li LI Keen Figure 19 netSCOPE Ivlib Simple Example vi Block Diagram Slope for Manual Data Input 4 Start Visualization gt Change to the netSCOPE lvlib Simple Example vi Front Panel gt Click to Run By The values of the variable are displayed in the XY graph over Time diagram S Stop Visualization To stop the visualization click on STOP netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE Ivlib Simple Example vi 25 94 3 2 2 2 netSCOPE Ivlib Simple Example vi Block Diagram Feetcre acting this VI modify these Suen to match your configuration Inter name cf vanable to display regexp Change to path for ENI f s BJ Change to dete type the variable has Aiur ef value Tis der IHHHHHEBEZEMHHHHHHHHHBEHEEZZEHHHHHHHHEZEH j naihi Stemm ua Get Inetruenenit Let a CN Enti meri Ab P Filer D oles Lond ae tre Ap her Los FINI Flea Sts tin A n EG rt ater aes Fu ans a d 1 O 8 G A zi SERS ES C gg ES omen ro een EE MR gt Figure 20 netSCOPE Ivlib Simple Example vi Block Diagram netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE Ivlib Simple Exampl
41. Datagram Length g Expected WKC g Data Start Offset Bits in Datagram Z5 y Variable Length Bits F y Variable Representation DEC DATATYPE BOOLEAN Variable Byte Order DEC LITTLE EMDIAN BYTE ORDER Variable Name EtherCAT variable 02 Normalize Variable Value Normalization Slope Normalization Offset Add Variable er Figure 26 netSCOPE Ivlib EtherCAT Add or Modify Variable Dialog vi Front Panel gt Enter the single variable definition values as described in the table Supported Data Types in EtherCAT on page 75 netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE Ivlib EtherCAT Add or Modify Variable Dialog vi 35 94 Data Flow Area Direction Indicates the signal direction and can either have the value input or output Datagram Header Area Command This selection specifies the EtherCAT command executed in the EtherCAT datagram Corresponds to the EtherCAT command specified in the Command field of the EtherCAT datagram The following EtherCAT commands are defined in the EtherCAT specification Command Address This value is specified as a hexadecimal address Corresponds to the address specified in the Command field of the EtherCAT datagram address The allowed value range extends from 0x0 to OxFFFFFFFF Datagram Length Length of the datagram expressed as the number
42. Driver for LabVIEW netSCOPE lvlib EtherCAT Select Variables Dialog vi 42 94 3 4 2 2 Show in waveform gt Inthe netSCOPE Ivlib EtherCAT Select Variables Dialog vi pane put a variable from the Available Variable list by drag amp drop to the Show in waveform1i list 33 netSCOPE Mib EtherCAT Select ENI file H Manual netX Products User Guides rCAT_ENI file ENI_File_von Heinz Network_Configuration_Filexm Gar 1 Available Variables Variable Name Box 1 CIFX RE ECS 1 R PDO 1 Byte Out 11 Box 1 CIFX RE ECS 1 R PDO 1 Byte Out 12 Box 1 CIFX RE ECS 1 R PDO 1 Byte Out 13 Box 1 CIFX RE ECS 1 R PDO 1 Byte Out 14 Box 1 CIFX RE ECS 1 R PDO 1 Byte Out 15 Box 1 CIFX RE ECS 1 TxPDO 1 Byte In 0 Box 1 CIFX RE ECS 1 TxPDO 1 Byte In 1 Box 1 CIFX RE ECS 1 TxPDO 1 Byte In 2 Box 1 CIFX RE ECS 1 TxPDO 1 Byte In 3 Box 1 CIFX RE ECS 1 TxPDO 1 Byte In 4 Rox 1 fCIFX RF FCSLT TxPDO 1 Rute In 51 Show in waveform 1 Variable Name Box 1 CIFX RE ECS 1 TxPDO 1 Byte In 0 Figure 32 netSCOPE Ivlib EtherCAT Select Variables Dialog vi Under Show in waveform1 you can remove a variable and clear all variables Remove selected To remove a variable from the Show in waveform list Select the variable to be removed gt Click on Remove selected Clear list To clear the total Show in waveform1 list gt Click on Clear list netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN
43. E Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE Ivlib Get Generic Variable Definition vi 74 94 3 10 2 netSCOPE lvlib Get Generic Variable Definition vi Gets the generic system independent definition of a variable instrument handle out generic variable definition error out instrument handle in variable ID error in no error Figure 53 netSCOPE Ivlib Get Generic Variable Definition vi instrument handle in identifies a particular instrument session variable ID Variable identifier Variable ID Value Value of the variable ID Instance Handle Internal driver information error in no error describes error conditions that occur before this VI runs The default input of this cluster is no error If an error already occurred this VI returns the value of error in in error out The VI runs normally only if no incoming error exists Otherwise the VI passes the error in value to error out The error in cluster contains the following parameters status is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE code is the error or warning code The default is O If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code 35 8 source iden
44. Heinz Network_Configuration_Filexm Gar 1 Available Variables Variable Name Box 1 CIFX RE ECS 1 R PDO 1 Byte Out 11 Box 1 CIFX RE ECS 1 R PDO 1 Byte Out 12 Box 1 CIFX RE ECS 1 R PDO 1 Byte Out 13 Box 1 CIFX RE ECS 1 R PDO 1 Byte Out 14 Box 1 CIFX RE ECS 1 R PDO 1 Byte Out 15 Box 1 CIFX RE ECS 1 TxPDO 1 Byte In 0 Box 1 CIFX RE ECS 1 TxPDO 1 Byte In 1 Box 1 CIFX RE ECS 1 TxPDO 1 Byte In 2 Box 1 CIFX RE ECS 1 TxPDO 1 Byte In 3 Box 1 CIFX RE ECS 1 TxPDO 1 Byte In 4 Rox 1 fCIFX RF FCSLT TxPDO 1 Rute In 51 Show in waveform 1 Variable Name Box 1 CIFX RE ECS 1 TxPDO 1 Byte In 0 Figure 13 netSCOPE Ivlib EtherCAT Select Variables Dialog vi Under Show in waveform1 you can remove a variable and clear all variables Remove selected To remove a variable from the Show in waveform list Select the variable to be removed gt Click on Remove selected Clear list To clear the total Show in waveform1 list gt Click on Clear list netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW 20 94 Done gt Click on Done The netSCOPE Ivlib EtherCAT Select Variables Dialog vi pane is closed dv The newly defined variables are saved 3 2 1 4 Set Bus Active Set Bus Inactive Select Set Bus Active 4 34 netSCOPE lvlib Interacti z File Edit View
45. India Hilscher India Pvt Ltd New Delhi 110 065 Phone 491 11 26915430 E Mail info hilscher in Italy Hilscher Italia S r l 20090 Vimodrone MI Phone 39 02 25007068 E Mail info hilscher it Support Phone 39 02 25007068 E Mail it support hilscher com netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal 94 94 Japan Hilscher Japan KK Tokyo 160 0022 Phone 81 0 3 5362 0521 E Mail info hilscher jp Support Phone 81 0 3 5362 0521 E Mail jp support hilscher com Korea Hilscher Korea Inc Seongnam Gyeonggi 463 400 Phone 82 0 31 789 3715 E Mail info hilscher kr Switzerland Hilscher Swiss GmbH 4500 Solothurn Phone 41 0 32 623 6633 E Mail info hilscher ch Support Phone 49 0 6190 9907 99 E Mail ch support hilscher com USA Hilscher North America Inc Lisle IL 60532 Phone 1 630 505 5301 E Mail info hilscher us Support Phone 1 630 505 5301 E Mail us support hilscher com Hilscher 2013
46. Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Introduction 8 94 1 2 5 Export Regulations The delivered product including the technical data is subject to export or import laws as well as the associated regulations of different counters in particular those of Germany and the USA The software may not be exported to countries where this is prohibited by the United States Export Administration Act and its additional provisions You are obligated to comply with the regulations at your personal responsibility We wish to inform you that you may require permission from state authorities to export re export or import the product 1 2 6 Registered Trademarks Windows XP Windows Vista Windows 7 and Windows 8 are registered trademarks of Microsoft Corporation EtherCAT is a registered trademark of Beckhoff Automation GmbH Verl Germany formerly Elektro Beckhoff GmbH LabVIEW is a graphical programming system from National Instruments All other mentioned trademarks are property of their respective legal owners netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Overview 9 94 2 Overview 2 1 About netSCOPE for LabVIEW netSCOPE uses LabVIEW as software frontend The netSCOPE device is delivered with the LabVIEW instrument driver interface The netSCOPE device
47. Internal Hilscher 2013 Instrument Driver for LabVIEW 86 94 3 11 4 netSCOPE lvlib Initialize System vi Initialized the netSCOPE system This is the first VI to be called before any other netSCOPE VI is useable system handle error out Figure 62 netSCOPE Ivlib Initialize System vi error in no error error in no error describes error conditions that occur before this VI runs The default input of this cluster is no error If an error already occurred this VI returns the value of error in in error out The VI runs normally only if no incoming error exists Otherwise the VI passes the error in value to error out The error in cluster contains the following parameters status is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE code is the error or warning code The default is O If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error russ system handle in Valid system handle generated by Initialize System vi see section netSCOPE lvlib Initialize System vi page 86 error out contains error information If error in indicates that an error occurred before this
48. LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE Ivlib Select Device Frontpanel vi 31 94 code is the error or warning code The default is O If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error 3 3 1 1 Select Device Frontpanel In the LabVIEW netSCOPE lvlib on Main Application Instance Items pane gt Select the Items tab gt netSCOPE Ivlib gt Examples gt Helpers gt Double click to netSCOPE Ivlib Select Device Frontpanel vi 2 The Front Panel view of the netSCOPE vlib Select Device Frontpanel vi is opened FB netSCOPE Vvlib Select Device Frontpanel vi Front Pane File Edit View Project Operate Tools Window Help OJH 15pt Application Font E sr ES Target System Y PROFINET Device Name Serial Number netSCOPE 1 netANALYZER_2 error out Status Code Fi Po o system ID EtherCAT Quelle A instrument name instruments list 0 Inst system handle in system handle out 0 0 Evaluation Figure 23 netSCOPE lvlib Select Device Frontpanel vi Front Panel gt Click Run The netSCOPE Ivlib Select Device Frontpanel vi is in Run mode
49. Start Capture vi instrument handle in identifies a particular instrument session instrument handle out has the same value as the instrument handle error out contains error information If error in indicates that an error occurred before this VI or function ran error out contains the same error information Otherwise it describes the error status that this VI or function produces status is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE code is the error or warning code The default is O If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE Ivlib Stop Capture vi 52 94 3 5 7 netSCOPE Ivlib Stop Capture vi Stops the capture task for process data values After stopping no new data will be stored in the capture ring buffer but yet captured data is still available instrument handle in instrument handle out error in no error error out Figure 40 netSCOPE Ivlib Stop Capture vi instrum
50. VI or function ran error out contains the same error information Otherwise it describes the error status that this VI or function produces status is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE code is the error or warning code The default is O If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Error Codes 87 94 4 Error Codes 4 1 Overview Error Codes LabVIEW Errors 5000 5305 netANALYZER 0x00000000 0x80200009 netSCOPE Windows Toolkit Errors 0x80210001 0x8021000E Device Driver Errors 1 0x80220001 0x80220012 Capturing Errors 0x00000000 0xC0770000 Table 9 Overview Error Codes and Ranges 4 2 LabVIEW Errors Description 5000 Duplicate variable ID During manual configuration of variable was assigned a duplicate variable ID 5001 Instrument not opened No instrument initialized Open Instrument vi wasn t executed or during the execution failed 5002 Instance mismatch Wrong instrument instance
51. Variable Byte Order Variable Definition Area This value indicates the byte order used in the internal representation of the variable currently to be defined Possible values are DEC LITTLE ENDIAN BYTE ORDER Intel format which means the most significant byte comes first the less significant comes last DEC BIG ENDIAN BYTE ORDER Motorola format which means the less significant byte comes first the most significant byte comes last Name Variable Definition Area This value indicates the full name of the variable currently to be defined Normalization Slope Data Normalization Area The data can be normalized if necessary by multiplication by a normalization factor and adding a normalization offset In this field the normalization factor can be specified Normalization Offset Data Normalization Area The data can be normalized if necessary by multiplication by a normalization factor and adding a normalization offset In this field the normalization offset can be specified H Variable ID Variable Definition Area ID that uniquely identifies the variable Variable ID Value Value of the variable ID netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE lvlib EtherCAT Add or Modify Variable vi 66 94 Instance Handle Internal driver information Scaling active Normalization Slope and Normalizat
52. ains the same error information Otherwise it describes the error status that this VI or function produces status is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE Ivlib Get Instrument List vi 78 94 code is the error or warning code The default is 0 If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE Ivlib Get Variable IDs by Name vi 79 94 3 10 4 netSCOPE Ivlib Get Variable IDs by Name vi Returns a list of variables IDs for all variables which s name matches the given regular expression instrument handle in regular expression error in no error instrument handle out variable ID list error out Figure 55 netSCOPE Ivlib Get Variable IDs by Name vi instrument handle in identifies a particular instrument
53. al or mechanical methods printing photocopying or other methods to manipulate or transfer using electronic systems without prior written consent You are not permitted to make changes to copyright notices markings trademarks or ownership declarations The included diagrams do not take the patent situation into account The company names and product descriptions included in this document may be trademarks or brands of the respective owners and may be trademarked or patented Any form of further use requires the explicit consent of the respective rights owner 1 2 2 Important Notes The user manual accompanying texts and the documentation were created for the use of the products by qualified experts however errors cannot be ruled out For this reason no guarantee can be made and neither juristic responsibility for erroneous information nor any liability can be assumed Descriptions accompanying texts and documentation included in the user manual do not present a guarantee nor any information about proper use as stipulated in the contract or a warranted feature It cannot be ruled out that the user manual the accompanying texts and the documentation do not correspond exactly to the described features standards or other data of the delivered product No warranty or guarantee regarding the correctness or accuracy of the information is assumed We reserve the right to change our products and their specification as well as related user manuals
54. ariable 1 Variable 2 Variablen Data Flow Variable Definition Direction Zi D Input Variable ID Data Mormalization Sit Datagram Header Command LRD E Command Address Data Start Offset Bits n Datagram gm Variable Length Bits s Variable Representation Normalize Variable Value Normalization Slope zz Normalization Offset io 01000800 DEC_DATATYPE_UNSIGNEDS j Variable Byte Order Datagram Length DEC LITTLE ENDIAM BYTE ORDER fF h y Variable Mame Expected WKC Box 1 CIFA RE ECS 1 TxPDO 1 Byte In 15 Fa g Modify Variable Figure 12 netSCOPE Ivlib Add or Modify Variable Dialog vi The single variable definition values as described in the table Supported Data Types in EtherCAT on page 75 Editor change the values gt Click on Modify Variable below the entry fields The variable definition values are changes and the netSCOPE Ivlib Add or Modify Variable Dialog vi pane is closed netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW 19 94 3 2 1 3 Show in waveform gt Inthe netSCOPE Ivlib EtherCAT Select Variables Dialog vi pane put a variable from the Available Variable list by drag amp drop to the Show in waveform 1 list 33 netSCOPE Iviib EtherCAT Select ENI file H Manual netX Products User Guides rCAT_ENI file ENI_File_von
55. ate interval ms Number of values to display 250 74 100000 Ce Configure Variables Display of numeric boolean and bit data types 0 l i I 1 ET 15 25 05 688132763 15 25 10 688132763 15 25 15 688132763 15 25 18 6 18 11 2013 18 11 2013 18 11 2013 18 11 Time HS wi buffer fill level 0 Display of string data types a 0 current write position 0 newest stored time 15 25 18 679804349 18 11 2013 oldest stored time 15 25 05 027511989 18 11 2013 Event List Timestamp Additional info 15 22 27 000 18 11 2013 Instrument connected to bus Evaluation 4 Figure 16 netSCOPE Ivlib Interactive Example vi Front Panel Example 4 Bytes in cyclic 3 2 1 6 Stop Capture Set Bus inactive STOP gt To stop the capturing process click on Stop Capture gt Tosetthe Bus inactive click on Set Bus Inactive gt To stop the netSCOPE Ilvlib Interactive Example vi click on STOP EN Note When STOP has been selected for another measuring and capturing cycle the ENI file must bee loaded newly Important Do not use the LabVIEW s Abort Execution to stop the capturing and measuring process Instead of this use Stop Capture Set Bus inactive and STOP d netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW 23 94 3 2 2 netSCOPE Ivlib Simple Example vi The netSCOPE Ivlib Simple Examp
56. completed netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE Ivlib EtherCAT Add or Modify Variable vi 63 94 3 9 Public Utility EtherCAT 3 9 1 netSCOPE Ivlib EtherCAT Add or Modify Variable vi Adds or modifies the EtherCAT specific definition of the given variable EtherCAT specific VI instrument handle in EtherCAT variable definition error in ne error Figure 47 netSCOPE Ivlib EtherCAT Add or Modify Variable vi instrument handle out error out instrument handle in identifies a particular instrument session instrument handle out has the same value as the instrument handle EtherCAT variable definition Cluster of specific EtherCAT variable definition Ether CAT Datagram and Variables Definition Vnd am es ected Variable 1 Variable 2 Variable n Data Data Data tt Offset Offset Offset Variable 1 Variable 3 Variable n m nr Length Length Length Variable 1 Variable 2 Variablen Data Flow Variable Definition Direction Ke Variable ID Data Normalization Input y y 100 Data Start Offset Bits in Datagram Normalize Variable Value gt Normalization Slope Datagram Header J 2 Command APRD wm Command Address d A z ago00001 Datagram Length d 1 y Expected WKC d 1 p Variable Length Bits n gy Variable Representation DEC DATATYPE BOOLEAM Va
57. contains error information If error in indicates that an error occurred before this VI or function ran error out contains the same error information Otherwise it describes the error status that this VI or function produces status is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE code is the error or warning code The default is O If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE Ivlib Close Instrument vi 83 94 3 11 Public 3 11 1 netSCOPE Ivlib Close Instrument vi Closes an instrument and returns the system handle the instrument belongs to This will discard all configuration and captured ring buffer data for this instrument The Instrument will not be accessible anymore unless it is reopened via the Initialize Instrument VI instrument handle system handle error in na error error out Figure 59 netSCOPE lvlib Close Instrument vi instrument handle in identifies a particular ins
58. ding a normalization offset In this field the normalization offset can be specified Table 2 netSCOPE Ivlib Add or Modify Variable Dialog vi Example EtherCAT Click on Add Variable below the entry fields 2 The variable definition values for the new variable are stored and the netSCOPE Ivlib Add or Modify Variable Dialog vi pane is closed netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE lvlib EtherCAT Select Variables Dialog vi 37 94 3 1 2 netSCOPE lvlib EtherCAT Select Variables Dialog vi The netSCOPE lvlib EtherCAT Select Variables Dialog vi example represents a subfunction of the netSCOPE Ivlib Interactive Example vi see section Open Front Panel Select Interface Select Device Frontpanel on page 13 and includes the subfuntions Import variables from ENI Manually add variable Edit variable and Show in waveform1 instrument handle in SCF instrument handle out selected variable IDs error out Figure 27 netSCOPE Ivlib EtherCAT Select Variables Dialog vi error in no error instrument handle in identifies a particular instrument session error in no error describes error conditions that occur before this VI runs The default input of this cluster is no error If an error already occurred this VI returns the value of error in in error out The VI runs normally only if
59. dle in identifies a particular instrument session user event User event handle that allows receiving the notification events from the backend This user event is generated by the LabVIEW specific Create User Event vi notification event entry Notification event structure This structure should be specified when creating the user Time Stamp Timestamp of the notification event Event Notification event identifier Additional Information Additional information notification event dependent error in no error describes error conditions that occur before this VI runs The default input of this cluster is no error If an error already occurred this VI returns the value of error in in error out The VI runs normally only if no incoming error exists Otherwise the VI passes the error in value to error out The error in cluster contains the following parameters status is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE code is the error or warning code The default is O If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error instrument handle out has the same value as the instrument
60. e Evaluation Graph update interval ms Number of values to display ei Li J 250 Ri 100000 Display of numeric boolean and bit data types 1 Amplitude bbo TE 0 8 1 l I 1 l 12 12 30 297873974 12 12 31 297873974 12 12 32 297873974 12 12 33 297873974 12 12 34 29 13 11 2013 13 11 2013 13 11 2013 13 11 2013 13 11 Time E Ei l d level Display of string data types current write position Jo en 0 newest stored time 00 00 00 000000000 DD MM YYYY oldest stored time 00 00 00 000000000 DD MM YYYY Event List Timestamp i Event i Additional info Figure 8 netSCOPE Ivlib Interactive Example vi Front Panel gt Click on Configure Variables The netSCOPE Ivlib EtherCAT Select Variables Dialog vi pane is opened netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW 16 9 es Dialog v EMI file 1 Available Variables Variable Name Show in waveform 1 Variable Mame Figure 9 netSCOPE Ivlib EtherCAT Select Variables Dialog vi gt Select 1 Select the required ENI file xml Select Import variables from ENI The imported variables are listed in the Available Variables table EMI file T Network Configuration File xml re d Available Variables Variable Mame A Box 1 CIFX RE ECS 1 RxPDO 1 Byte Out 0 Beau selected Box 1 CIFX
61. e Definition Area Data Start Offset Bits in Datagram This value indicates the offset of the variable currently to be defined relative to the beginning of the data field data in the EtherCAT datagram It is expressed as the number of bits counted from the memory location of the first bit of the first variable of the data field If the variable currently to be defined is the first in the data field the value is O Generic Variable Definition Cluster of generic variable definition Variable Data Type Variable Definition Area This value specifies the data type of the variable currently to be defined The following data types are supported in EtherCAT Data Type Number of Bits Range of Value BOOLBIT 0 FALSE 1 1 TRUE BITS o8 NEE SINT Short integer 8 127 netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE lvlib EtherCAT Add or Modify Variable vi 65 94 24 Nap o DI wm o o EN wm o nn 0 i Dis i 0 8 Uma 8 Uva an uge Um 8 VISIBLE STRING Visible string 1 octet per character SL n UNICODE_STRING Sequence of UNIT 16 n 1 Table 5 Supported Data Types in EtherCAT 264 1 OO Variable Direction Data Flow Area Indicates the signal direction and can either have the value input or output OO
62. e string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE lvlib EtherCAT Select Variables Dialog vi 38 94 3 4 2 1 Open Front Panel select Variables ENI file 3 Available Variables Variable Name Show in waveform 1 Variable Name In the LabVIEW netSCOPE Ivlib on Main Application Instance Items pane gt Select the Items tab gt netSCOPE Ivlib gt Examples gt Helpers gt EtherCAT gt Double click to netSCOPE Ivlib EtherCAT Select Variables Dialog vi The Front Panel view of the netSCOPE Ivlib EtherCAT Select Variables Dialog vi is displayed Click Run The netSCOPE Ivlib EtherCAT Select Variables Dialog vi is in Run mode Figure 28 netSCOPE Ivlib EtherCAT Select Variables Dialog vi AB vvv Select e 2 Select the required ENI file xml Select Import variables from ENI The imported variables are listed in the Available Variables table netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE lvlib EtherCAT Select Variables Dialog vi 39 94 Box 1 CIFX RE ECS 4 Box 1 CIFX RE ECS 1 Box 1 CIFX RE ECS 1 Box 1 CIFX RE ECS 1 B
63. e vi 26 94 The netSCOPE lvlib Simple Example vi Block Diagram see figure netSCOPE Ivlib Simple Example vi Block Diagram on page 25 shows the Vis required to visualize the values of a certain variable and how they are connected to each other in the block diagram from the left side to the right side e Initialize System vi system handle error In no error error out This driver VI initializes the netSCOPE system This is the first VI to be called before any other netSCOPE VI is useable For details see section netSCOPE Ivlib lnitialize System vi on page 86 e Get Instrument List vi system handle in system handle out 2n instruments list error out error in no error This driver VI returns a list of all instruments of the system For details see section neiSCOPE Ivlib Get Instrument List vi on page 77 e Connection to the device Get Instrument List vi Initialize Instrument vi The first netSCOPE device is selected e Initialize Instrument vi system handle system ID instrument name error in no error This VI initializes one instrument specified by its name This VI must be called once before using any instrument specific Vls For details see section netSCOPE Ivlib lnitialize Instrument vi on page 85 instrument handle error aut e Ringbuffer Configuration vi ringbuffer save path instrument handle in ringbuffer size MByte ringbuffer save location RAM error in no error Configures the ringbuffe
64. ed and the end of capture file is reached Table 14 Capturing Errors Description netSCOPE Instrument Driver for LabVIEW DOC1310050101 EN Revision 1 English 2013 11 In Development Internal 90 94 Check whether the hard disk of the PC is fast enough to save the captured data The theoretical maximum load is 50 MB s Heduce the load of the data to be captured Record only IEEE802 3 compliant message traffic Check whether the hard disk of the PC is fast enough to save the captured data The theoretical maximum load is 50 MB s Reduce the load of the data to be captured Check whether the hard disk of the PC is fast enough to save the captured data The theoretical maximum load is 50 MB s Reduce the load of the data to be captured Optimize your application or use a faster PC No error Hilscher 2013 Appendix 91 94 5 Appendix 5 1 References 1 Driver Manual netANALYZER API Windows XP Vista 7 8 V1 x 5 2 List of Figures Figure 1 netSCOPE System Data Flow 10 Figure 2 LabVIEW Start Screen 11 Figure 3 LabVIEW netSCOPE Ivlib on Main Application Instance Items Pane 12 Figure 4 netSCOPE Ivlib Interactive Example vi 13 Figure 5 netSCOPE Ivlib Interactive Example vi Front Panel 13 Figure 6 netSCOPE Ivlib Interactive Example vi Front Panel 14 Figure 7 netSCOPE Ivlib Interactive Example vi Select Device Frontpanel vi 14 Figure 8 netSCOPE Ivlib Interactive Example vi Front Pane
65. egative error code If status is FALSE code is 0 or a warning code 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE Ivlib Remove Variable vi 81 94 3 10 6 netSCOPE Ivlib Remove Variable vi Removes a variable definition from the list of known variables If the variable is removed its values may not be read out anymore by the Get Data VI instrument handle in variable ID error in no error Figure 57 netSCOPE Ivlib Remove Variable vi instrument handle out error out instrument handle in identifies a particular instrument session variable ID Identifier of the variable that should be removed from the known variables list Variable ID Value Value of the variable ID Instance Handle Internal driver information error in no error describes error conditions that occur before this VI runs The default input of this cluster is no error If an error already occurred this VI returns the value of error in in error out The VI runs normally only if no incoming error exists Otherwise the VI passes the error in value to error out The error in cluster contains the following parameters status is TRUE X if an error
66. enerated by Initialize System vi see section netSCOPE Ivlib lnitialize System vi page 86 error in no error describes error conditions that occur before this VI runs The default input of this cluster is no error If an error already occurred this VI returns the value of error in in error out The VI runs normally only if no incoming error exists Otherwise the VI passes the error in value to error out The error in cluster contains the following parameters status is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE code is the error or warning code The default is O If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error error out contains error information If error in indicates that an error occurred before this VI or function ran error out contains the same error information Otherwise it describes the error status that this VI or function produces status is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE code is the error or warning code
67. ent handle in identifies a particular instrument session instrument handle out has the same value as the instrument handle error out contains error information If error in indicates that an error occurred before this VI or function ran error out contains the same error information Otherwise it describes the error status that this VI or function produces status is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE code is the error or warning code The default is O If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE Ivlib EtherCAT Configure Detection vi 53 94 3 6 Public Configure EtherCAT 3 6 1 netSCOPE Ivlib EtherCAT Configure Detection vi Configures how the EtherCAT direction detection for input output data works It can be set either to automatic detection or to a user specified fixed configuration instrument handle in instrument handle out EtherCAT direction detection error in no er
68. es the error status that this VI or function produces status is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE code is the error or warning code The default is O If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE Ivlib ldentify vi 80 94 3 10 5 netSCOPE lvlib Identify vi Blinks the given instruments LEDs for identification system handle in HSCF system handle cut instrument name error in no error Figure 56 netSCOPE Ivlib ldentify vi error out 64 system handle in Valid system handle generated by Initialize System vi see section netSCOPE Ivlib lnitialize System vi page 86 instrument name Instrument name for example netSCOPEO The instrument name can be extracted from the instrument list generated by Get Instrument List vi see section netSCOPE Ivlib Get Instrument List vipage 77 error in no error describes error conditions that occur before this VI runs The defaul
69. f IOCTL internal instrument error 5200 Ringbuffer failed Internal ringbuffer module error internal instrument error 5201 Ringbuffer get time Invalid read data time span from time is greater as to time internal invalid ringbuffer error 5202 Ringbuffer invalid Access to EtherCAT Decoder failed because of an invalid transfer parameter parameter internal ringbuffer error 5203 Ringbuffer out of No more free system memory available internal ringbuffer error memory netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Error Codes 88 94 Error Code Definition Short Description 5204 Ringbuffer invalid var Read data failed invalid variable group ID group ID 5205 Ringbuffer thread Internal nn of ringbuffer failed Data capturing not possible internal creating failed ringbuffer error 5206 Ringbuffer not stopped Configuration of ringbuffer not possible because it wasn t stopped 5300 Ecat invalid parameter Access to EtherCAT Decoder failed because of an invalid transfer parameter internal EtherCAT error 5301 Ecat out of memory No more free system memory available internal EtherCAT error 5302 Ecat load ringbuffer Load of internal ringbuffer module failed internal EtherCAT error failed Ecat wrong ringbuffer I version number of loaded ringbuffer module internal EtherCAT version error 5304 Ecat ringbuffer not Access to ri
70. g vi Available Variables 39 Figure 30 netSCOPE Ivlib Add or Modify Variable Dialog vi 40 Figure 31 netSCOPE Ivlib Add or Modify Variable Dialog vi 41 Figure 32 netSCOPE Ivlib EtherCAT Select Variables Dialog vi 42 Figure 33 netSCOPE lvlib EtherCAT Select Variables Dialog vi Controls and Indicators 43 Figure 34 netSCOPE Ivlib Get Capture Buffer State vi 44 Figure 35 netSCOPE Ivlib Get Ethernet Port State vi 46 Figure 36 netSCOPE Ivlib Get Instrument State vi 48 Figure 37 netSCOPE Ivlib Set Bus Active vi 49 Figure 38 netSCOPE lvlib Set Bus Inactive vi 50 Figure 39 netSCOPE Ivlib Start Capture vi 51 Figure 40 netSCOPE Ivlib Stop Capture vi 52 Figure 41 netSCOPE lvlib EtherCAT Configure Detection vi 53 Figure 42 netSCOPE lvlib Register Notification Event Handler vi 55 Figure 43 netSCOPE Ivlib Ringbuffer Configuration vi 57 Figure 44 netSCOPE Ivlib Unregister Notification Event Handler vi 59 netSCOPE Instrument Driver for LabVIEW DOC1310050101 EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Appendix 92 94 Figure 45 netSCOPE lvlib Read Data vi 60 Figure 46 Variable Data Management 60 Figure 47 netSCOPE Ivlib EtherCAT Add or Modify Variable vi 63 Figure 48 EtherCAT Datagram and Variable Definition 63 Figure 49 netSCOPE lvlib EtherCAT Get Specific Variable Definition vi 67 Figure 50 EtherCAT Datagram and Variable Definition 68 Figure 51 netSCOPE lvlib EtherCAT Load ENT File vi 72 Fi
71. gure 52 netSCOPE lvlib Error Descriptions vi 73 Figure 53 netSCOPE Ivlib Get Generic Variable Definition vi 74 Figure 54 netSCOPE Ivlib Get Instrument List vi 77 Figure 55 netSCOPE lvlib Get Variable IDs by Name vi 79 Figure 56 netSCOPE Ivlib ldentify vi 80 Figure 57 netSCOPE lvlib Remove Variable vi 81 Figure 58 netSCOPE Ivlib Revision Query vi 82 Figure 59 netSCOPE lvlib Close Instrument vi 83 Figure 60 netSCOPE Ivlib Close System vi 84 Figure 61 netSCOPE lvlib Initialize Instrument vi 85 Figure 62 netSCOPE lvlib Initialize System vi 86 5 3 List of Tables Table 1 List of Revisions 4 Table 2 netSCOPE Ivlib Add or Modify Variable Dialog vi Example EtherCAT 36 Table 3 Important Error Codes possible Causes and Troubleshooting 56 Table 4 EtherCAT Commands 64 Table 5 Supported Data Types in EtherCAT 65 Table 6 EtherCAT Commands 69 Table 7 Supported Data Types in EtherCAT 70 Table 8 Supported Data Types in EtherCAT 75 Table 9 Overview Error Codes and Ranges 87 Table 10 LabVIEW Errors Description 88 Table 11 Generic Errors Description 88 Table 12 Toolkit Errors Description 89 Table 13 Toolkit Errors Description 89 Table 14 Capturing Errors Description 90 5 4 Glossary ENI EtherCAT LabVIEW EtherCAT Network Information The EtherCAT Network Information ENI Specification describes the structure of ENI files using XML schemas A communication system for industrial Ethernet designed and developed by Beckhoff
72. handle error out contains error information If error in indicates that an error occurred before this VI or function ran error out contains the same error information Otherwise it describes the error status that this VI or function produces status is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE Ivlib Register Notification Event Handler vi 56 94 code is the error or warning code The default is O If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error 3 7 1 1 Notification Events Instmmenteonmactedto Bus The instrument was successfully connected on the bus and is ready to capture of data The capture of data was automatically stopped Instrument connected to bus Instrument Error because an internal instrument error occurred but stopped by error OxXXXXXXX Use Set Bus Inactive vi to disconnect the instrument from the bus Instrument disconnected from The instrument was successfully disconnected from
73. i im Close System vi z CH Initialize Instrument vi Initialize System vi Figure 3 LabVIEW netSCOPE Ivlib on Main Application Instance Items Pane gt Double click to the VI you need e g Interactive Example vi You can use e the netSCOPE VIs in the folder Examples to understand how to create the netSCOPE programming in LabVIEW e he Vis in the folder Public to create your netSCOPE programming dv The Front Panel view of the corresponding VI is opened e g Interactive Example vi see section netSCOPE lvlib Interactive Example vi on page 13 netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW 3 2 Examples 3 2 1 netSCOPE Ivlib Interactive Example vi 13 94 The netSCOPE Ivlib Interactive Example vi example shows how to import variables from ENI file and how to add a variable manually or to edit a value and respectively how to visualize the resulting data Figure 4 netSCOPE Ivlib Interactive Example vi 3 2 1 1 Open Front Panel Select Interface Select Device Frontpanel In the LabVIEW netSCOPE Ivlib on Main Application Instance Items pane gt Select the Items tab gt netSCOPE Ivlib gt Examples gt Double click to Interactive Example vi The Front Panel view of the netSCOPE Ivlib interactive Example vi is opened File Edit View Project Operate Tools Window Help gt gt Om
74. in error in no error instrument handle in identifies a particular instrument session error in no error describes error conditions that occur before this VI runs The default input of this cluster is no error If an error already occurred this VI returns the value of error in in error out The VI runs normally only if no incoming error exists Otherwise the VI passes the error in value to error out The error in cluster contains the following parameters status is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE code is the error or warning code The default is O If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error instrument handle out has the same value as the instrument handle buffer fill level Current ring buffer fill level in percent current write position Current write position of the ring buffer in percent oldest stored time Current write position of the ring buffer in percent newest stored time Time stamp of the oldest captured and stored datagram in the ring buffer error out contains error information If error in indicates that an error occurred
75. ion Offset and are only considered when Scaling active is TRUE Variable Bit Length Variable Definition Area This value specifies the length of the variable currently to be defined specified as number of the bits error in no error describes error conditions that occur before this VI runs The default input of this cluster is no error If an error already occurred this VI returns the value of error in in error out The VI runs normally only if no incoming error exists Otherwise the VI passes the error in value to error out The error in cluster contains the following parameters status is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE code is the error or warning code The default is O If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error instrument handle out has the same value as the instrument handle error out contains error information If error in indicates that an error occurred before this VI or function ran error out contains the same error information Otherwise it describes the error status that this VI or function produces status is TRUE X if an er
76. k This is a prerequisite before calling the Start Capture VI For details see section netSCOPE lIvlib Set Bus Active vi on page 49 Start Capture vi instrument handle in instrument handle out error in no error error out otarts the capture task for process data values This requires the bus to be activated via the Set Bus Active VI For details see section Start Capture on page 21 Get Variable IDs by Name vi instrument handle in ES instrument handle out regular expression D Bayariable ID list error in no error error out Returns a list of variables IDs for all variables which s name matches the given regular expression For details see section netSCOPE Ivlib Get Variable IDs by Name vi on page 79 netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE Ivlib Simple Example vi 28 94 gt e Value not valid J e Data Visualization The variable is visualized E EB bad This example shows a graph of one single variable Get Capture Buffer State vi p T i d E Stop Capture vi G NSC gt EL aH Lie Ma u fiol NSCP en Figure 21 netSCOPE Ivlib Simple Example vi Block Diagram Loop for Data Visualization e netSCOPE Ivlib Get Capture Buffer State vi instrument handle in a Instrument handle out buffer fill level 9 current write position 25 oldest sto
77. l 15 Figure 9 netSCOPE Ivlib EtherCAT Select Variables Dialog vi 16 Figure 10 netSCOPE Ivlib EtherCAT Select Variables Dialog vi Available Variables 16 Figure 11 netSCOPE Ivlib Add or Modify Variable Dialog vi 17 Figure 12 netSCOPE Ivlib Add or Modify Variable Dialog vi 18 Figure 13 netSCOPE Ivlib EtherCAT Select Variables Dialog vi 19 Figure 14 netSCOPE Ivlib Interactive Example vi Front Panel 20 Figure 15 netSCOPE Ivlib Interactive Example vi Front Panel 21 Figure 16 netSCOPE lvlib Interactive Example vi Front Panel Example 4 Bytes in cyclic 22 Figure 17 netSCOPE lvlib Simple Example vi 23 Figure 18 netSCOPE lvlib Simple Example vi Front Panel 23 Figure 19 netSCOPE Ivlib Simple Example vi Block Diagram Slope for Manual Data Input 24 Figure 20 netSCOPE Ivlib Simple Example vi Block Diagram 25 Figure 21 netSCOPE Ivlib Simple Example vi Block Diagram Loop for Data Visualization 28 Figure 22 netSCOPE lvlib Select Device Frontpanel vi 30 Figure 23 netSCOPE Ivlib Select Device Frontpanel vi Front Panel 31 Figure 24 netSCOPE Ivlib Select Device Frontpanel vi Front Panel 32 Figure 25 netSCOPE Ivlib EtherCAT Add or Modify Variable Dialog vi 33 Figure 26 netSCOPE Ivlib EtherCAT Add or Modify Variable Dialog vi Front Panel 34 Figure 27 netSCOPE lvlib EtherCAT Select Variables Dialog vi 37 Figure 28 netSCOPE lvlib EtherCAT Select Variables Dialog vi 38 Figure 29 netSCOPE Ivlib EtherCAT Select Variables Dialo
78. le vi shows the minimal programming effort which is needed to acquire a single process data signal from a netSCOPE device Figure 17 netSCOPE Ivlib Simple Example vi 3 2 2 1 Open Front Panel In the LabVIEW netSCOPE Ivlib on Main Application Instance Items pane 1 Open Frontpanel gt Select the Items tab gt netSCOPE Ivlib gt Examples Double click to Simple Example vi The Front Panel view of the netSCOPE Ivlib Simple Example vi is opened Before you start this VI configure it in the block diagram Ploto Fe Figure 18 netSCOPE Ivlib Simple Example vi Front Panel 2 Open Block Diagram gt Double click to the netSCOPE Ivlib Simple Example vi Front Panel The netSCOPE Ivlib Simple Example vi Block Diagram is opened see figure netSCOPE Ivlib Simple Example vi on page 23 3 Enter or change data manually Under My variable name Enter the name of the variable to display regexp netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW 24 94 gt Under Change to path for ENI file Select the path to the ENI file to be loaded gt Under Change to data type the variable has Manually select the data type of the variable which shall be displayed Under Number of values to display Enter or change the number of samples which can be viewed in the graph at the same time 00 00
79. ming steps 1 1 1 Online Help The netSCOPE VlIs in LabVIEW contains an integrated online help facility gt To open the online help click on Help or press F1 1 1 2 List of Revisions Index Date Version Component Chapter Revision 01 13 11 12 netSCOPE for 1 0 x x All Created LabVIEW Instrument Driver Table 1 List of Revisions netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Introduction 5 94 1 1 3 Conventions in this Manual Notes operation instructions and results of operation steps are marked as follows Notes Important lt important note gt Note lt note gt Ss lt note where to find further information Operation Instructions 1 instruction 2 instruction or instruction Results Y lt result gt netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Introduction 6 94 1 2 Legal Notes 1 2 1 Copyright Hilscher 2013 Hilscher Gesellschaft f r Systemautomation mbH All rights reserved The images photographs and texts in the accompanying material user manual accompanying texts documentation etc are protected by German and international copyright law as well as international trade and protection provisions You are not authorized to duplicate these in whole or in part using technic
80. ndle out error in no error error out Figure 38 netSCOPE Ivlib Set Bus Inactive vi instrument handle in identifies a particular instrument session instrument handle out has the same value as the instrument handle error out contains error information If error in indicates that an error occurred before this VI or function ran error out contains the same error information Otherwise it describes the error status that this VI or function produces status is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE code is the error or warning code The default is 0 If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE Ivlib Start Capture vi 51 94 3 5 6 netSCOPE lvlib Start Capture vi Starts the capture task for process data values This requires the bus to be activated via the Set Bus Active VI instrument handle in instrument handle out error in no error error out Figure 39 netSCOPE Ivlib
81. ngbuffer Be not possible because module wasn t loaded loaded internal EtherCAT error 5305 Ecat invalid backend Access to EtherCAT Decoder failed because of an invalid handle internal handle EtherCAT error Table 10 LabVIEW Errors Description 4 3 Generic Errors Value Error Code Description Possible Causes Troubleshooting Definition 0x80200003 NETANA OUT Out of memory The available Upgrade the storage capacity of _OF_MEMORY storage capacity of the central memory Tai He Close all other open SR applications on the PC Table 11 Generic Errors Description 4 4 Toolkit Errors Value Error Code Description Definition 0x80210001 NETANA_TKIT_ Toolkit initialization failed INITIALIZATION _ FAILED 0x80210002 NETANA_ Creation of DMA buffers failed DMABUFFER CREATION_FAILED 0x80210003 NETANA HWRESET Error during hardware reset of device ERROR 0x80210004 NETANA CHIP NOT Chip type is not supported by toolkit SUPPORTED 0x80210005 NETANA DOWNLOAD Download of Bootloader Firmware failed _ FAILED 0x80210006 NETANA FW Error starting firmware START FAILED 0x80210007 NETANA DEN Device mailbox is full MAILBOX_FULL 0x80210008 NETANA DEV NOT Device not ready READY 0x80210009 NETANA DEV MAILB Mailbox is too short for packet OX TOO SHORT 0x8021000A NETANA DEV GET No packet available NO PACKET 0x8021000B NETANA BUFFER Given buffer is too short TOO SHORT netSCOPE Instrument Driver for LabVIEW DOC131
82. occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE code is the error or warning code The default is 0 If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error instrument handle out has the same value as the instrument handle error out contains error information If error in indicates that an error occurred before this VI or function ran error out contains the same error information Otherwise it describes the error status that this VI or function produces status is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE code is the error or warning code The default is O If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013
83. of bits in the datagram Corresponds to the length specified in the Datagram Length field of the EtherCAT datagram Expected WKC Expected value of the working counter Corresponds to the value specified in the field Expected WKC of the EtherCAT datagram The allowed value range extends from 0 to 65535 Variable Definition Area Variable ID ID that uniquely identifies the variable Note You must not use the same variable ID twice otherwise the error message is displayed Duplicate Variable ID please select another ID Data Start Offset Bits in This value indicates the offset of the variable currently to be defined relative to the Datagram beginning of the data field data in the EtherCAT datagram It is expressed as the number of bits counted from the memory location of the first bit of the first variable of the data field If the variable currently to be defined is the first in the data field the value is O Variable Length Bits This value specifies the length of the variable currently to be defined specified as number of the bits Variable Representation This value specifies the data type of the variable currently to be defined The following data types are supported in EtherCAT Data Type Number of Bits Range of Value BOOLBIT 0 FALSE 1 1 TRUE BITE lcu SINT Short integer B 128 127 netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Inte
84. of numeric boolean and bit data types 1 0 8 0 6 0 4 s 0 0 2 04 0 6 0 8 Se 1 I 1 12 12 30 297873974 12 12 31 297873974 12 12 32 297873974 12 12 33 297873974 12 12 34 29 13 11 2013 13 11 2013 13 11 2013 13 11 2013 13 11 Time buffer fill level A w 0 Display of string data types 9 0 current write position T tin t 0 newest stored time 00 00 00 000000000 DD MM YYYY oldest stored time 00 00 00 000000000 Event List Timestamp Additional info 15 22 27 000 18 11 2013 Instrument connected to bus Evaluation Figure 15 netSCOPE Ivlib Interactive Example vi Front Panel Via Start Capture the measurement and data capturing are started Start Capture changes to Stop Capture Inthe Event List below any possible notification events states or error states are listed See section Notification Events on page 56 netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW 22 94 The display shows the measured and captured data which are transferred from the Slave to the Master The history of the variable gets visible Any values transferred at the bus get visible inputs outputs default values counter sinus signals etc 3 netSCOPE lvlib Interacti File Edit View Project Operate Tools Window Help Sen Graph upd
85. on vi Input A y A y Data Start Offset Bits in Datagram Normalize Variable Value Datagram Header J 0 Variable Length Bits Normalization Slope Command a ariable Length Bits Ar APRD x y l Normalization Offset EE Variable Representation zm 00000000 DEC DATATYPE BOOLEAN Variable Byte Order Datagram Length DEC_LITTLE_ENDIAN_BYTE_ORDER Variable Name _ Cancel Figure 11 netSCOPE Ivlib Add or Modify Variable Dialog vi gt Enter the single variable definition values as described in the table Supported Data Types in EtherCAT on page 75 netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW 18 94 gt Click on Add Variable below the entry fields 2 The variable definition values for the new variable are stored and the netSCOPE Ivlib Add or Modify Variable Dialog vi pane is closed Edit variable To edit a variable given in the Available Variables list gt Click on Edit variable The netSCOPE Ivlib Add or Modify Variable Dialog vi pane is displayed showing the variable definition values of the selected variable 3 netSCOPE Ivlib EtherCAT Add or Modify V Ether CAT Datagram and Variables Definition Sid am Exp eL Variable 1 Variable 3 Variable n Data Data Data DEN Offset Offset Offset Variable 1 Variable 2 Variable n Length Length Length V
86. or on the hard drive HDD The ring buffer data is then being converted to be displayed in LabVIEW using the Get Data vi function In LabVIEW the acquisition data can be shown in a diagram or histogram for example LabVIEW Process Data Visualisation Graph Get Datawi set Data vi Get Data vi netSCOPE LabVIEW Driver E NEE BE p PC Memory Ringbuffer 1 RAM HDD Ringbuffer2 Ringbuffer n RAM HDO RAM HDO t netSCOPE Card 1 ert z Ethernet network 1 netSCOPE Card eck a ki Ethernet network 2 Port netsCOPE Card n Fort Ethernet network n 9 Slaves Figure 1 netSCOPE System Data Flow netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW 11 94 3 Instrument Driver for LabVIEW 3 1 Opening LabVIEW netSCOPE Ivlib and VI gt Open LabVIEW File Operate Tools Help fa LabVIEW 2013 rg D Open Existing Show All net SCOPE hl S FM cd Create Project Find Drivers and Add ons fj Community and Support Welcome to LabVIEW Connect to devices and expand the Participate in the discussion forums or Leam to use LabVIEW and upgrade functionality of LabVIEW request technical support from previous versions LabVIEW News 5 Things You Need to Know About LabVIEW Bookmarks Figure 2 LabVIEW Start Screen gt Selec
87. other device application Table 13 Toolkit Errors Description netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Error Codes 4 6 Capturing Errors Value Error Code Description Possible Causes Troubleshooting Definition 0xC0660004 0xC0660005 0xC066000B 0xC066000C 0xC066000D 0xC0770000 NETANA_ CAPTURE_ ERROR NO DMACHANNEL NETANA_ CAPTURE_ ERROR URX OVERFLOW NETANA_ CAPTURE ER ROR NO HOS TBUFFER NETANA_ CAPTURE_ ERROR NO IN TRAMBUFFER NETANA_ CAPTURE_ ERROR_FIFO_ FULL NETANA_ CAPTURE_ ERROR DRIVER FILE FULL No free DMA channel available Probably host is too slow XC buffer overflow URX overflow No free DMA buffer available Internal capture buffer overflow Firmware is out of FIFO resources and is unable to buffer more data End of capture file reached Driver has stopped capturing The data load of the capturing is too high Occurs because a non IEEE802 3 conform traffic is captured e g too short frames too small IFG Host is too slow to handle data efficiently No free INTRAM Firmware is out of memory resources and is unable to buffer more data This may also be caused by a slow file system or a slow application This may also be caused by a slow file system or a slow application The error is triggered when the ringbuffer mode is not activat
88. ox 1 CIFX RE ECS 1 Row 1 CIFX REECH m ENI file 1 Network_Configuration_Filexml br Available Variables Variable Mame A Remove selected Box 1 CIFX RE ECS 1 RxPDO 1 Byte Out 0 Box 1 CIFX RE ECS 1 RXPDO 1 Byte Out 1 Box 1 CIFX RE ECS 1 RXPDO 1 Byte Out 2 Box 1 CIFX RE ECS 1 RxPDO 1 Byte Out 3 Box 1 CIFX RE ECS 1 RxPDO 1 Byte Out 4 Manuallv add variable RxPDO 1 Byte Qut 5 RxPDO 1 Byte Qut 6 RxPDO 1 Byte Qut 7 RxPDO 1 Byte Qut 8 RxPDO 1 Byte Qut 9 RxPDO 1 Rute Qut 1m x Edit variable netSCOPE Instrument DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Figure 29 netSCOPE Ivlib EtherCAT Select Variables Dialog vi Available Variables Under Available Variables you can remove a variable clear all variables add a variable manually or edit a variable Remove selected To remove a variable from the Available Variables list gt Select the variable to be removed gt Click on Remove selected Clear list To clear the total Available Variables list gt Click on Clear list Manually add variable To add a variable manually to the Available Variables list gt Click on Manually add variable The netSCOPE Ivlib Add or Modify Variable Dialog vi pane is displayed Driver for LabVIEW Instrument Driver for LabVIEW netSCOPE lvlib EtherCAT Select Variables Dialog vi 40 94 33 netSCOPE Ivlib EtherCAT Add EtherC
89. particular instrument session instrument handle out has the same value as the instrument handle error out contains error information If error in indicates that an error occurred before this VI or function ran error out contains the same error information Otherwise it describes the error status that this VI or function produces status is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE code is the error or warning code The default is O If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE Ivlib Read Data vi 60 94 3 8 Public Data 3 8 1 netSCOPE Ivlib Read Data vi Reads a variables values from the capture data ring buffer Reading is limited to the time span given read from timestamp must always be specified The maximum amount of data that is read out is implicitly specified by the input arrays size All input arrays timestamp list value list status list must have the same si
90. pecific Variable Definition vi 67 3 9 3 netSCOPE lvlib EtherCAT Load ENI Eievw s 72 SA0 PUDICA UU qo E 73 3 10 1 netSCOPE Ivlib Error Descriptions vi 73 3 10 2 netSCOPE Ivlib Get Generic Variable Detnton vi 74 3 10 3 netSCOPE Ivlib Get Instrument Let vi 77 3 10 4 netSCOPE lvlib Get Variable IDs by Name vi 79 3 10 5 rie Sc OPEVID Identlly VI EE 80 3 10 6 netSCOPE Ivlib Remove Vanable vi 81 3 10 7 netSCOPE Ivlib Revision QUETY vi 82 3 11 BE e e 83 3 11 1 net COPE Nlib Glose Instrument Vi a 83 3 11 2 netSCOPE Ivlib Close Gvstem vi 84 3 11 3 netSCOPE Ivlib lnitialize Instrument vi 85 3 11 4 netSCOPE Ivlib lnitialilze Gvsiem vi 86 4 ERROR EI 87 4 1 Overview Error COS EE 87 4 2 LABVIEW ErfOrs DESENDUON seta ee een reset 87 4 3 Generic Ge TEEN 88 4 4 Beie tg e a eek een 88 4 5 DRIVER EIOS Se an Res lg 89 4 6 KEREN EE 90 5 BAI a LEE 91 5 1 MEISLENCES Ee Ee 91 5 2 BI geg let ie 91 5 3 EISTOR TODE T UN 92 5 4 KEEN J 92 5 5 e ee eE E EE E A E E 94 netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Introduction 4 94 1 Introduction 1 1 About this Manual This manual provides to you descriptions about the netSCOPE instrument driver in LabVIEW For the netSCOPE data processing in LabVIEW you only need to perform a view program
91. r storage size in Megabytes and location RAM storage location does not need a save path HDD storage location needs a save path to be specified Note that HDD storage is most likely less performant than RAM storage For details see section netSCOPE Ivlib Ringbuffer Configuration vi on page 5 instrument handle out error out netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE Ivlib Simple Example vi 27 94 Manual Data Input My variable name To enter the name of variable to be displayed regexp Change to path for ENI file The path to the ENI file to be loaded must be selected The ENI file contains all variables and its values Change to data type the variable has To manually select the data type of the variable which shall be displayed Number of values to display Allows to enter or change the number of samples which can be viewed in the graph at the same time EtherCAT Load ENI File vi system handle system ID instrument name error in no error This EtherCAT specific VI loads all variables from the given ENI file For details see section netSCOPE lvlib EtherCAT Load ENT File vi on page 72 Instrument handle error out Set Bus Active vi instrument handle in instrument handle out error in mo error error out Activates the physical connection to the communication bus or networ
92. red time newest stored time error out error in no error Gets the current state of the capture ring buffer For details see section netSCOPE Ivlib Get Capture Buffer State vi on page 44 e Read Data vi read to timestamp read from timestamp instrument handle in instrument handle out variable ID count of read values timestamp list in timestamp list out value list in value l st out status list out error out nae more data Reads a variables value from the capture data ring buffer Reading is limited to the time span given from time must always be specified The maximum amount of data that is read out is implicitly specified by the input array size All input arrays timestamp list value list status list must have the same size The value list contains elements which must be preinitialized with the LabVIEW data type and its expected size The amount of actually read values is returned by count of read values if this value is smaller than the array size the rest of the arrays elements do not contain correct data and must be ignored The VI does not resize the arrays automatically For details see section netSCOPE Ivlib Read Data vi on page 60 status list in error in mo error netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE Ivlib Simple Example vi 29 94 e Stop Capture vi
93. riable Byte Order DEC LITTLE ENDIAM BYTE ORDER Variable Name EtherCAT variable 02 Zn Normalization Offset Add Variable Figure 48 EtherCAT Datagram and Variable Definition Command Datagram Header Area This selection specifies the EtherCAT command executed Corresponds netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal the EtherCAT datagram to the EtherCAT command specified in the Command field of the EtherCAT datagram Hilscher 2013 Instrument Driver for LabVIEW netSCOPE lvlib EtherCAT Add or Modify Variable vi 64 94 The following EtherCAT commands are defined in the EtherCAT specification WR BRW LWA LAW Table 4 EtherCAT Commands DH Command Address Datagram Header Area This value is specified as a hexadecimal address Corresponds to the address specified in the Command field of the EtherCAT datagram address The allowed value range extends from 0x0 to OXFFFFFFFF Working Counter Datagram Header Area Expected value of the working counter Corresponds to the value specified in the field Expected WKC of the EtherCAT datagram The allowed value range extends from 0 to 65535 ISCH Command Length Datagram Header Area Length of the datagram expressed as the number of bits in the datagram Corresponds to the length specified in the Datagram Length field of the EtherCAT datagram Variable Bit Address Variabl
94. rnal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE lvlib EtherCAT Add or Modify Variable Dialog vi 36 94 DINT Double 32 231 4231 1 integer USINT Unsigned 0 255 short integer UINT Unsigned 16 0 65535 integer Word UDINT Unsigned 32 double integer ULINT Unsigned 64 long integer REAL Floating 32 point VISIBLE STRING Visible string 8 n 1 octet per character 8 OCTET_STRING Sequence of n 1 octets UNICODE_STRING Sequence of 16 n 1 UNIT This value indicates the byte order used in the internal representation of the variable currently to be defined Variable Byte Order Possible values are DEC LITTLE ENDIAN BYTE ORDER Intel format which means the most significant byte comes first the less significant comes last DEC BIG ENDIAN BYTE ORDER Motorola format which means the less significant byte comes first the most significant byte comes last Variable Name This value indicates the full name of the variable currently to be defined Note You must enter a variable name otherwise the error message is displayed No variable name specified Data Normalization Area Normalization Factor The data can be normalized if necessary by multiplication by a normalization factor and adding a normalization offset In this field the normalization factor can be specified Normalization Offset The data can be normalized if necessary by multiplication by a normalization factor and ad
95. ror Figure 41 netSCOPE Ivlib EtherCAT Configure Detection vi error out instrument handle in identifies a particular instrument session EtherCAT direction detection Specified EtherCAT direction of input output data Port O input Port 1 output Port O output Port 1 input Automatic error in no error describes error conditions that occur before this VI runs The default input of this cluster is no error If an error already occurred this VI returns the value of error in in error out The VI runs normally only if no incoming error exists Otherwise the VI passes the error in value to error out The error in cluster contains the following parameters status is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE code is the error or warning code The default is O If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error instrument handle out has the same value as the instrument handle error out contains error information If error in indicates that an error occurred before this VI or function ran error out contains the same error information Otherwise it describes the
96. ror codes and descriptions Useful to be connected to the General Error Handler Vis user defined codes and user defined descriptions inputs For details see section netSCOPE Ivlib Close System vi on page 84 netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE Ivlib Select Device Frontpanel vi 30 94 3 3 Examples Helpers 3 3 1 netSCOPE Ivlib Select Device Frontpanel vi The netSCOPE Ivlib Select Device Frontpanel vi example represents a subfunction of the netSCOPE Ivlib Interactive Example vi see section Open Front Panel Select Interface Select Device Frontpanel on page 13 and includes the subfuntions Select the Target System Identify device and Select device system handle in system handle aut instruments list system ID error in instrument name error out Figure 22 netSCOPE Ivlib Select Device Frontpanel vi el system handle in Valid system handle generated by Initialize System vi see section netSCOPE Ivlib lnitialize System vi page 86 instrument list A list of available instruments found on the system The instrument list is created by Get Instrument List vi see section netSCOPE Ivlib Get Instrument List vi page 77 error in no error describes error conditions that occur before this VI runs The default input of this cluster is no error If an error already occurred this VI ret
97. ror occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE code is the error or warning code The default is O If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE Ivlib EtherCAT Get Specific Variable Definition vi 67 94 3 9 2 netSCOPE Ivlib EtherCAT Get Specific Variable Definition vi Gets the EtherCAT specific definition of a variable EtherCAT specific VI instrument handle in instrument handle out variable ID EtherC AT variable definition error in no error error out Figure 49 netSCOPE Ivlib EtherCAT Get Specific Variable Definition vi instrument handle in identifies a particular instrument session variable ID Variable identifier Variable ID Value Value of the variable ID Instance Handle Internal driver information error in no error describes error conditions that occur before this VI runs The default input of this cluster is no error If an error already occurred this VI returns the value of error in in
98. s the variable Variable ID Value Value of the variable ID Instance Handle Internal driver information Scaling active Normalization Slope and Normalization Offset and are only considered when Scaling active is TRUE Variable Bit Length Variable Definition Area This value specifies the length of the variable currently to be defined specified as number of the bits error out contains error information If error in indicates that an error occurred before this VI or function ran error out contains the same error information Otherwise it describes the error status that this VI or function produces status is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE Ivlib EtherCAT Get Specific Variable Definition vi 71 94 code is the error or warning code The default is O If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1
99. t and status list out arrays timestamp list out Array of read timestamps value list out Array of read values status list out Array of read value states error out contains error information If error in indicates that an error occurred before this VI or function ran error out contains the same error information Otherwise it describes the error status that this VI or function produces status is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE code is the error or warning code The default is O If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error more data Indicates if reading values has been completed in the spe cified time span reading from timestamp reading to timestamp True Reading the data has not been completed because the size of pre initialized arrays timestamp list in value list in and status list in netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE Ivlib Read Data vi 62 94 was not sufficient False Reading the data has been
100. t input of this cluster is no error If an error already occurred this VI returns the value of error in in error out The VI runs normally only if no incoming error exists Otherwise the VI passes the error in value to error out The error in cluster contains the following parameters status is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE code is the error or warning code The default is O If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error system handle out Valid system handle generated by Initialize System vi see section netSCOPE lvlib Initialize System vi page 86 error out contains error information If error in indicates that an error occurred before this VI or function ran error out contains the same error information Otherwise it describes the error status that this VI or function produces status is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE code is the error or warning code The default is O If status is TRUE code is a n
101. t netSCOPE Ivlib The netSCOPE Ivlib on Main Application Instance Items window is displayed Select the Items tab gt Select netSCOPE Ivlib netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW 12 94 File Edit View Project Operate Tools Window Help EE Examples OD Helpers B G EtherCAT j Pj EtherCAT Add or Modify Variable Dialog vi iE EtherCAT Select Variables Dialog vi wi Configure Variables vi ime Select Device Frontpanel vi d wl Interactive Example vi mei Simple Example vi B CP Private EE Public EFE Action Status mi Get Capture Buffer State vi Get Ethernet Port State ut Get Instrument State Ai Set Bus Active vi Set Bus Inactive vi Start Capture vi Stop Capture vi T Ze onfigure E Ether CAT 2 i ei EtherCAT Configure Detection vi B Register Notification Event Handler vi mi Ringbuffer Configuration vi i e Unregister Notification Event Handler vi B CJ Controls a Data i al Read Data vi 2 T Utility 8 de EtherC AT ei EtherCAT Add or Modify Variable vi K mi EtherCAT Get Specific Variable Definition vi n EtherCAT Load ENI File vi wl Error Descriptions vi mil Get Generic Variable Definition vi z wi Get Instrument List vi m Get Variable IDs by Name vi m m Identify vi CH Remove Variable vi wl Revision Query vi j i Close Instrument v
102. tes that an error occurred before this VI or function ran error out contains the same error information Otherwise it describes the error status that this VI or function produces status is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE code is the error or warning code The default is 0 If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE Ivlib Get Instrument State vi 48 94 3 5 3 netSCOPE Ivlib Get Instrument State vi Gets the current state of the instrument instrument handle in instrument handle out error in no error bus state capture state error out Figure 36 netSCOPE Ivlib Get Instrument State vi instrument handle in identifies a particular instrument session instrument handle out has the same value as the instrument handle bus state Current bus state of the instrument Instrument is connected to the bus and ready to capture the data Instrument is disconnected from the bus
103. tifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error instrument handle out has the same value as the instrument handle generic variable definition Cluster of generic variable definition Variable Data Type Variable Definition Area This value specifies the data type of the variable currently to be defined The following data types are supported in EtherCAT e p 1 TRUE Bm EEE EEE am genee In e mes 0 1 Lem aaa Dwm E ow bwWemwe Is a wa o o o wu o o 4 o wm o 8 o Uv iwgmee In vam Unsigned stoninteger 8 fe netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE Ivlib Get Generic Variable Definition vi 75 94 UINT24 ua ln EE EC Um 8 RE Fewmpit sf WEN iwgFom 9 VISIBLE STRING Visible string 8 n 1 octet per character OCTET_STRING Sequence of octets 8 n 1 UNICODE STRING Sequence of UNIT 16 n 1 WE Table 8 Supported Data Types in EtherCAT Variable Direction Data Flow Area Indicates the signal direction and can either have the value input or output Variable Byte Order Variable Definition Area This value indicates the byte order used in the internal representa
104. tion of the variable currently to be defined Possible values are DEC LITTLE ENDIAN BYTE ORDER Intel format which means the most significant byte comes first the less significant comes last DEC BIG ENDIAN BYTE ORDER Motorola format which means the less significant byte comes first the most significant byte comes last Name Variable Definition Area This value indicates the full name of the variable currently to be defined Normalization Slope Data Normalization Area The data can be normalized if necessary by multiplication by a normalization factor and adding a normalization offset In this field the normalization factor can be specified Normalization Offset Data Normalization Area The data can be normalized if necessary by multiplication by a normalization factor and adding a normalization offset In this field the normalization offset can be specified Variable ID Variable Definition Area ID that uniquely identifies the variable Variable ID Value Value of the variable ID Instance Handle Internal driver information Scaling active Normalization Slope and Normalization Offset and are only considered when Scaling active is TRUE error out contains error information If error in indicates that an error occurred before this VI or function ran error out contains the same error information Otherwise it describes the error status that this VI or function produces netSCOPE Instrument Driver
105. trument handle in identifies a particular instrument session variable ID Identifier of the existing variable that should be modified error in no error describes error conditions that occur before this VI runs The default input of this cluster is no error If an error already occurred this VI returns the value of error in in error out The VI runs normally only if no incoming error exists Otherwise the VI passes the error in value to error out The error in cluster contains the following parameters status is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE code is the error or warning code The default is O If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error instrument handle out has the same value as the instrument handle error out contains error information If error in indicates that an error occurred before this VI or function ran error out contains the same error information Otherwise it describes the error status that this VI or function produces status is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that
106. trument handle in instrument handle out error in no error error out Figure 37 netSCOPE Ivlib Set Bus Active vi instrument handle in identifies a particular instrument session instrument handle out has the same value as the instrument handle error out contains error information If error in indicates that an error occurred before this VI or function ran error out contains the same error information Otherwise it describes the error status that this VI or function produces status is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE code is the error or warning code The default is 0 If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE Ivlib Set Bus Inactive vi 50 94 3 5 5 netSCOPE Ivlib Set Bus Inactive vi Deactivates the physical connection to the communication bus or network If a capture is running it must be stopped via the Stop Capture VI first instrument handle in RR instrument ha
107. trument session el system handle in Valid system handle generated by Initialize System vi see section netSCOPE Ivlib lnitialize System vi page 86 error out contains error information If error in indicates that an error occurred before this VI or function ran error out contains the same error information Otherwise it describes the error status that this VI or function produces status is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE code is the error or warning code The default is O If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE Ivlib Close System vi 84 94 3 11 2 netSCOPE lvlib Close System vi Closes a system All instruments belonging to this system will be closed automatically all captured ringbuffer data in this system will be discarded system handle error in no error error out Figure 60 netSCOPE lvlib Close System vi el system handle in Valid system handle g
108. tus is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE code is the error or warning code The default is O If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error instrument handle out has the same value as the instrument handle error out contains error information If error in indicates that an error occurred before this VI or function ran error out contains the same error information Otherwise it describes the error status that this VI or function produces status is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE code is the error or warning code The default is O If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development
109. urns the value of error in in error out The VI runs normally only if no incoming error exists Otherwise the VI passes the error in value to error out The error in cluster contains the following parameters status is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE code is the error or warning code The default is O If status is TRUE code is a negative error code If status is FALSE code is 0 or a warning code 35 8 source identifies where an error occurred The source string includes the name of the VI that produced the error what inputs are in error and how to eliminate the error system handle out Valid system handle generated by Initialize System vi see section netSCOPE lvlib Initialize System vi page 86 system ID Selected target system identifier instrument name Name of the selected instrument for example netSCOPE error out contains error information If error in indicates that an error occurred before this VI or function ran error out contains the same error information Otherwise it describes the error status that this VI or function produces status is TRUE X if an error occurred before this VI or function ran or FALSE checkmark to indicate a warning or that no error occurred before this VI or function ran The default is FALSE netSCOPE Instrument Driver for
110. ze The value list contains elements which must be preinitialized with the LabVIEW data type and its expected size The amount of actually read values is returned by count of read values if this value is smaller than the array size the rest of the arrays elements do not contain correct data and must be ignored The VI does not resize the arrays automatically read to timestamp read from timestamp gt instrument handle in I Ge instrument handle out variable ID m Ses paa mmm 7 count af read values timestamp list in sch M Ha timestam p list out value list in bw value list out status list in status list out error in no error error out Sou EAU mare data Figure 45 netSCOPE Ivlib Read Data vi preallacate timestamp array preallacate values array with correct data type Y I Read Variable From Ringbuffer preallacate varStete array number of values more data Figure 46 Variable Data Management read to timestamp Timestamp where the reading process should be aborted read from timestamp Timestamp where the reading process should be started instrument handle in identifies a particular instrument session variable ID Identifier of the variable that should be read from the ring buffer netSCOPE Instrument Driver for LabVIEW DOC1310050I01EN Revision 1 English 2013 11 In Development Internal Hilscher 2013 Instrument Driver for LabVIEW netSCOPE

netSCOPE - Instrument Driver for LabVIEW

Contents

Download Pdf Manuals

Related Search

Related Contents