National Instruments FOUNDATION NI-FBUS Hardware And Software User Manual Download Page 105

Page: 105 / 178

Chapter 6

NI-FBUS Function Reference

National Instruments Corporation

6-43

NI-FBUS Hardware and Software User Manual

Return Values

E_OK

The call was successful.

E_INVALID_DESCRIPTOR

The descriptor you specified is not valid.

E_TIMEOUT

The device containing the object is present but did not respond
within the timeout period.

E_MULTIPLE

More than one identical tag was found. The function failed.

E_NOT_FOUND

The NI-FBUS Communications Manager could not find the
specified object.

E_BAD_ARGUMENT

The object specified by index was that of a simple data type,
which must already be known to you.

E_RESOURCES

The NI-FBUS Communications Manager is unable to allocate
some system resource. This is usually a memory problem.

E_SERVER_CONNECTION_LOST

The session established with the NI-FBUS Communications
Manager, under which the descriptor was opened, has been lost or
closed.

Visible String

FF_VISIBLE_STRING

1, 2, 3, ...

Octet String

FF_OCTET_STRING

1, 2, 3, ...

Date

FF_DATE

Time of Day

FF_TIMEOFDAY

4 or 6

Time Difference

FF_TIME_DIFF

4 or 6

Bit String

FF_BIT_STRING

1, 2, 3, ...

Time Value

FF_TIME_VALUE

Table 6-4.

Object Codes for the

nifObjTypeList_t

Data Structure (Continued)

Data Type

objTypeIndex

fbtypes.h

Number of Octets (Size)

Summary of Contents for FOUNDATION NI-FBUS

Page 1: ...FOUNDATION TM Fieldbus NI FBUS Hardware and Software User Manual NI FBUS Hardware and Software User Manual August 2011 371994G 01 ...

Page 2: ...current events National Instruments Corporate Headquarters 11500 North Mopac Expressway Austin Texas 78759 3504 USA Tel 512 683 0100 For further support information refer to the Technical Support and Professional Services appendix To comment on National Instruments documentation refer to the National Instruments Web site at ni com info and enter the Info Code feedback 2006 2011 National Instrument...

Page 3: ...rporation National Instruments respects the intellectual property of others and we ask our users to do the same NI software is protected by copyright and other intellectual property laws Where NI software may be used to reproduce software or other materials belonging to others you may use NI software only to reproduce materials that you may reproduce in accordance with the terms of any applicable ...

Page 4: ...re encouraged to try to correct the interference by one or more of the following measures Reorient the antenna of the receiver the device suffering interference Relocate the transmitter the device generating interference with respect to the receiver Plug the transmitter into a different outlet so that the transmitter and the receiver are on different branch circuits Some hardware may require the u...

Page 5: ...n Installing the Software 2 1 Installing the Hardware 2 2 Install Your PCI FBUS Card 2 2 Install Your PCMCIA FBUS Card 2 3 Install Your USB 8486 2 5 Mount and Connect Your USB 8486 2 7 Install Your FBUS HSE H1 LD 2 12 Setting the Communication Parameters and Interface Name 2 15 Testing the Installation 2 17 Changing or Deleting Existing Interface Information 2 17 Importing Device Descriptions 2 18...

Page 6: ...4 7 Choose to Write Single Thread or Multi Thread Applications 4 8 Single Thread Applications 4 8 Multi Thread Applications 4 8 Access Object Dictionary Entries 4 9 Access Management Information Base MIB Parameters 4 9 H1 Device MIB List Parameters 4 10 H1 Device MIB Parameters 4 10 HSE Device MIB List Parameters 4 11 HSE Device MIB Parameters 4 11 Use the NI FBUS Dialog Utility to Communicate wit...

Page 7: ...istrative Functions 6 1 List of Administrative Functions 6 1 Core Fieldbus Functions 6 26 List of Core Functions 6 26 Using Interface Macros 6 55 Alert and Trend Functions 6 56 Appendix A Specifications PCI FBUS 2 A 1 PCMCIA FBUS A 4 USB 8486 A 7 FBUS HSE H1 Linking Device A 10 Appendix B Troubleshooting and Common Questions Interface Board USB PCI and PCMCIA B 1 HSE Linking Device B 8 NI FBUS Sof...

Page 8: ...r click in the software such as menu items and dialog box options Bold text also denotes parameter names italic Italic text denotes variables emphasis a cross reference or an introduction to a key concept Italic text also denotes text that is a placeholder for a word or value that you must supply monospace Text in this font denotes text or characters that you should enter from the keyboard section...

Page 9: ...umentation The following documents contain information that you may find helpful as you read this manual Fieldbus Standard for Use in Industrial Control Systems Part 2 ISA S50 02 1992 Wiring and Installation 31 25 kbit s Voltage Mode Wire Medium Application Guide Fieldbus Foundation ...

Page 10: ... Fieldbus devices can be connected to the same set of wires FOUNDATION Fieldbus has two communication protocols H1 and HSE The first H1 transmits at 31 25 Kb s and is used to connect the field devices The second protocol High Speed Ethernet HSE uses 10 or 100 Mbps Ethernet as the physical later and provides a high speed backbone for the network Please refer to FOUNDATIONTM Fieldbus Overview docume...

Page 11: ...ed to the HSE network running at 10 Mbps or higher is a crucial component in FOUNDATION Fieldbus technology The combined H1 HSE solution allows for full integration of sensor process discrete control and hybrid batch control subsystems with higher level supervisory applications The HSE linking device is the key to integrate H1 and HSE technology NI FBUS Software Products Communications Manager The...

Page 12: ...data packets from the Fieldbus monitors the live list and performs statistical analysis of packets You can use the NI FBUS Monitor to diagnose the communication of H1 network or debug the development of device You can use FOUNDATION Fieldbus products with National Instruments HMI software packages including Lookout and LabVIEW DSC And you can also use third party HMI software through NI FBUS OPC S...

Page 13: ...m their defaults Reinstalling the software may cause you to lose any existing card and port configuration information 1 Log in as Administrator or as a user that has Administrator privileges 2 Insert the NI FBUS Software for Windows CD into the CD ROM drive If the installer does not launch automatically navigate to the CD using Windows Explorer and launch the autorun exe file from the CD 3 The int...

Page 14: ...rt of the system chassis to discharge electrostatic energy which can damage several components on the PCI FBUS card To install the PCI FBUS card complete the following steps 1 Shut down and power off the computer Keep the computer plugged in so that it remains grounded while you install the PCI FBUS card 2 Remove the top cover or access port of the I O channel 3 Remove the expansion slot cover on ...

Page 15: ...do not conflict 7 Power on the computer 8 Launch the Interface Configuration Utility Make sure that the PCI FBUS card is listed and enabled 9 Close the Interface Configuration Utility and start the NI FBUS Communications Manager or NI FBUS Configurator Install Your PCMCIA FBUS Card Caution Before you remove the card from the package touch the antistatic plastic package to a metal part of the syste...

Page 16: ...o insert the PCMCIA FBUS and how to connect the PCMCIA FBUS cable and connector to the PCMCIA FBUS card However the PCMCIA FBUS 2 card has two connectors Refer to Chapter 3 Connector and Cabling for more information about these two connectors Figure 2 2 Inserting the PCMCIA FBUS Card 3 Connect the PCMCIA FBUS to the Fieldbus network Your kit contains a PCMCIA FBUS cable Refer to Chapter 3 Connecto...

Page 17: ...ons Do not unplug the USB 8486 when the NI FBUS software is running The USB 8486 has the following two variants USB 8486 without screw retention and mounting option USB 8486 with screw retention and mounting option You can connect the USB 8486 without screw retention and mounting option to a desktop PC or a laptop PC Figure 2 3 Connecting the USB 8486 to a Desktop PC 1 Desktop PC 2 USB 8486 3 DB 9...

Page 18: ... a free USB port as shown in Figure 2 3 and Figure 2 4 3 Connect the USB 8486 to the Fieldbus network Refer to the USB 8486 section of Chapter 3 Connector and Cabling for more information about the connectors 4 Launch the Interface Configuration Utility 5 Right click the USB 8486 to enable if it is disabled 6 Close the Interface Configuration Utility and start the NI FBUS Communications Manager or...

Page 19: ...g option to a CompactRIO This device provides the following mounting options DIN mount using the unthreaded DIN rail mounting holes Panel mount using the panel mount notch and tab DIN Rail Mounting You can use the DIN rail mounting kit to mount your USB 8486 to a standard DIN rail as shown in Figure 2 5 Figure 2 5 Fastening a DIN Rail Clip to the USB 8486 1 USB 8486 2 DIN Rail Clip 3 Thread Formin...

Page 20: ...luded in the DIN rail mounting kit Tighten the screws to a torque of 0 76 N m 6 7 lb in Figure 2 5 shows a DIN rail clip being attached to the device 2 Clip the device onto the DIN rail as shown in Figure 2 6 Note Using the thread forming screws permanently affixes the DIN rail clip to the device Unscrewing and reinstalling the thread forming screws produces a compromised connection between the DI...

Page 21: ... can mount the device to a DIN rail horizontally by using the additional screw positions Panel Mounting You can use 8 or M4 pan head screws to mount the USB 8486 to a board or panel as shown in Figure 2 7 Figure 2 7 Mounting the USB 8486 to a Broad or Panel 1 8 or M4 Pan Head Screw 2 USB 8486 3 8 or M4 Pan Head Screw 1 2 3 ...

Page 22: ...er point on the panel 2 Set the USB 8486 on the screw by fitting the screw head into the bottom screw notch on the underside of the enclosure 3 Screw a 8 or M4 pan head screw through the upper mounting tab on the USB 8486 Figure 2 8 shows the distance between the bottom screw notch and the upper mounting tab on the USB 8486 Figure 2 8 Dimensions of the Mounting Tab and Notch 15 24 mm 0 600 in 78 2...

Page 23: ...USB 8486 to a CompactRIO To install the USB 8486 on a CompactRIO target complete the following steps 1 Power on the CompactRIO 2 Insert the USB 8486 into the USB port as shown in Figure 2 9 3 Connect the USB 8486 to the Fieldbus network Refer to the USB 8486 section of Chapter 3 Connector and Cabling for more information about the connectors 1 DB 9 Connector 2 USB 8486 3 USB Plug with Retention Th...

Page 24: ...he Interface Configuration Utility and start the NI FBUS Communications Manager or NI FBUS Configurator Install Your FBUS HSE H1 LD The FBUS HSE H1 LD has a simple rail clip for reliable mounting onto a standard 35 mm DIN rail To install the FBUS HSE H1 LD complete the following steps 1 Use a flathead screwdriver to open the DIN rail clip to the unlocked position as shown in Figure 2 10 Figure 2 1...

Page 25: ...e the FBUS HSE H1 LD to the desired position along the DIN rail After the FBUS HSE H1 LD is in position lock it to the DIN rail by pushing the rail clip to the locked position as shown in Figure 2 10 4 Connect the RJ 45 Ethernet port of the FBUS HSE H1 LD to an Ethernet hub using a standard Category 5 Ethernet cable Note Do not use a cable longer than 100 m If you are using a 10 Mbps Ethernet Nati...

Page 26: ...5 Figure 2 12 shows the power H1 and Ethernet connectors on the FBUS HSE H1 LD Figure 2 12 Connectors on the FBUS HSE H1 LD 6 Use the Fieldbus cable with 9 pin female D sub connector to connect the H1 ports of FBUS HSE H1 LD to a Fieldbus network 1 H1 Port 1 2 H1 Port 2 3 Power 4 Ethernet 1 2 3 4 ...

Page 27: ... the POST status refer to the LED Indicators section of Appendix B Troubleshooting and Common Questions Note If you are using the third party HSE H1 linking device refer to the related user manual or reference materials to install the hardware Setting the Communication Parameters and Interface Name Complete the following steps to use the NI FBUS Interface Configuration utility to set the Fieldbus ...

Page 28: ...iod of time using a visitor address could break VCR endpoints and cause VCR_FULL_ERROR errors c If you want third party Fieldbus configuration software to assign an address to your interface over the Fieldbus choose Default Address You should only choose to use a default address when you want third party configuration software to assign a permanent address A device at a default address cannot be c...

Page 29: ...xisting Interface Information To change or delete information about any interface complete the following steps 1 Select Start All Programs National Instruments NI FBUS Utilities Interface Configuration Utility 2 Click the Boardx icon where x refers to the board number of the interface you want to change or delete 3 Click the Edit button You can edit the interface configuration information that you...

Page 30: ...l Programs National Instruments NI FBUS Utilities Interface Configuration Utility to run the Interface Configuration utility 3 Click the Import DD CFF button The Import DD CFF dialog box opens 4 Click the Browse button browse to the cff capability file path or ffo device description file path and click Open Typically the device description for your Fieldbus device is supplied on a disk from the ma...

Page 31: ...oks for all device descriptions Do not change the base directory after you have started importing device descriptions Otherwise NI FBUS will not be able to find the device descriptions you previously imported Your device description files will automatically be placed in the appropriate manufacturer ID subdirectory under this base directory Your base directory will include one folder for each diffe...

Page 32: ...ieldbus Cable Connector Pinout To make a Fieldbus cable ensure that pins 6 and 7 are used for the Fieldbus signals as shown in Figure 3 1 The cable must also follow the technical specifications listed in the document Fieldbus Standard for Use in Industrial Control Systems Part 2 ISA S50 02 1992 Refer to Figure 3 1 for the connector pinout of the PCI FBUS Figure 3 1 Fieldbus Connector Pinout for th...

Page 33: ... longer cable than the one provided in your kit Figure 3 2 shows the PCMCIA FBUS cable An arrow on the cable points to pin 1 of the screw terminal block Figure 3 2 PCMCIA FBUS Cable The PCMCIA FBUS 2 cable has two Fieldbus connectors that are similar to the one shown in Figure 3 2 The connector labeled PCMCIA FBUS PORT 1 is the connector for Fieldbus port 1 and the connector labeled PCMCIA FBUS PO...

Page 34: ...rial Control Systems Part 2 ISA S50 02 1992 Pins 2 and 4 of the J2 screw terminal block provide an alternate connection to the Fieldbus However the screw terminal block is not an independent link All of the signals on the screw terminal block provide a direct connection to the 9 pin D SUB National Instruments provides the Power and Power connections as passive connections from the D SUB to the scr...

Page 35: ... of the USB 8486 uses pins 6 and 7 of the connector for the Fieldbus signals as specified in the Fieldbus Standard for Use in Industrial Control Systems Part 2 ISA S50 02 1992 9 Pin D SUB DB 9 Cable Information A 2 meter cable has been included in your kit which converts the 9 pin D SUB connector to three wire pigtails Figure 3 6 DB 9 Cable for the USB 8486 1 2 3 4 5 6 7 8 9 No Connection No Conne...

Page 36: ... DB 9 Cable Table 3 1 provides the cable pigtail pinout All of the signals on the three wire pigtails provide a direct corresponding connection to the 9 pin D SUB FBUS HSE H1 Linking Device This section contains information about the pinout of the FBUS FBUS H1 linking device connectors Table 3 1 Information for Cable Pigtails Signal Color Size Data Red 22 AWG Data Black 22 AWG Shield Green 22 AWG ...

Page 37: ... connector pinouts for FBUS HSE H1 Ethernet cables Figure 3 8 Ethernet Cable Layout Table 3 2 Ethernet Cable Wiring Connections Pin Connector 1 Connector 2 Normal Connector 2 Crossover 1 White Orange White Orange White Green 2 Orange Orange Green 3 White Green White Green White Orange 4 Blue Blue Blue 5 White Blue White Blue White Blue 6 Green Green Orange 7 White brown White Brown White Brown 8 B...

Page 38: ...ly using an FBUS HSE H1 LD the power hub is not being used for power For other FOUNDATION Fieldbus devices that use bus powering you would apply power to the hub from which devices would get their power Refer to the Fieldbus Foundation Wiring and Installation 31 25 kbit s Voltage Mode Wire Medium Application Guide for specific information about wiring and installing a Fieldbus network If you want ...

Page 39: ...unication stack and the user application It also handles the details of communicating with the Fieldbus Messaging Specification FMS and lower layers of the communications stack The NI FBUS Communications Manager hides the low level details of Virtual Communication Relationships VCRs connection management addresses and Object Dictionary indices and offers name access to physical devices Virtual Fie...

Page 40: ...lled manually To do this open a DOS command prompt and run the following commands from the target directory regsvr32 opccomn_ps dll regsvr32 opcproxy dll nifb_opcda exe regserver NI FBUS Functions Overview The NI FBUS functions are classified into four categories Administrative functions Core functions Alert and trend functions Device description functions All NI FBUS functions are described in de...

Page 41: ...rocessing function block parameters primarily the nifReadObject and nifWriteObject functions which read and write block parameters The NI FBUS Communications Manager encapsulates the device description services with the core function nifGetObjectAttributes which gives you the device description attributes of any parameter Function blocks contain view or display objects As the name implies these ob...

Page 42: ...end Functions When a properly configured device detects an alarm condition the device broadcasts the data A host device receives the alarm then sends a communication acknowledgment and an operator acknowledgment to the field device The field device also can collect trends based on a configured sample type and interval When the field device collects 16 samples it broadcasts the trend data on the Fi...

Page 43: ...Your application can use the NI FBUS function nifGetObjectAttributes to decode attributes of parameters including data type data size help strings and other attributes defined in the Device Description Language Specification document In addition device description symbol files are used automatically to assist in allowing your applications to access parameters by name The NI FBUS Communications Man...

Page 44: ...f the communication stack and should only be changed if you are aware of the effect of your changes on the stack You must make sure to specify a unique non default Fieldbus network address for the NI FBUS Communications Manager to work properly You can use a default address if another entity on the Fieldbus assigns your interface a non default address You can change the address from the NI FBUS In...

Page 45: ...te your application this way If it is easier for you to keep track of a descriptor for each block rather than a tag for each block you should open a block descriptor for each block you are communicating with keep track of that descriptor value and access parameters by PARAMNAME using the block descriptor Choose to Access by Name or Index The NI FBUS Communications Manager supports access by name o...

Page 46: ...Thread Applications If your application monitors or tests several devices at a time communication delays might affect the throughput of your application and therefore be unacceptable If so you can develop a multi threaded application to improve the performance of your application There are several ways to multi thread your application If you are accessing information from function blocks or transd...

Page 47: ...rtual field device on the device with the tag MIB You can use the resulting virtual field device descriptor to access the MIB parameters by index or by their names as described in the FOUNDATIONTM Fieldbus Specification For example to write the macrocycle duration access the MIB parameter MACROCYCLE_DURATION and to read the live list access the object named LIVE_LIST_STATUS This method works both ...

Page 48: ...Parameters AP_CLOCK_SYNC_INTERVAL BOOT_OPERAT_FUNCTIONAL_CLASS CHANNEL_STATES CONFIGURED_LINK_SETTING CURRENT_LINK_SETTING CURRENT_TIME DEV_ID DLME_BASIC_CHARACTERISTICS DLME_BASIC_INFO DLME_LINK_MASTER_INFO LINK_SCHEDULE_ACTIVATION LINK_SCHEDULE_LIST_CHARACTERISTICS LIVE_LIST_STATUS LOCAL_TIME_DIFF MACROCYCLE_DURATION OPERATIONAL_POWERUP PD_TAG PLME_BASIC_CHARACTERISTICS PLME_BASIC_INFO PRIMARY_A...

Page 49: ...EADER HSE_AUTOMATIC_VCR_LIST_HEADER BRIDGE_CHARACTERISTICS CURRENT_NMA_CONFIGURATION_ACCESS PREVIOUS_NMA_CONFIGURATION_ACCESS INTERFACE_ADDRESS_ARRAY INTERFACE_DESIRED_STATE_ARRAY INTERFACE_ACTUAL_STATE_ARRAY Use the NI FBUS Dialog Utility to Communicate with Devices The NI FBUS Dialog utility helps you perform simple tests of your whole Fieldbus setup including the NI FBUS Communications Manager ...

Page 50: ...correct parameters incorrect bus configuration or communication failures An application that fails to check return values might use output parameters from NI FBUS calls that are NULL or uninitialized leading to incorrect behavior or a program crash If you plan to call any of the indefinitely blocking functions including nifGetDeviceList nifWaitAlert nifWaitAlert2 and nifWaitTrend you should probab...

Page 51: ... Manager NIFB process has started and is entirely initialized before your application makes its first NI FBUS call Ensure your compiler has the structure padding or alignment parameter set to eight bytes This will allow proper communication of data structures The nifbus h header file and nifb lib library have been compiled and linked with Microsoft Visual C C version 6 0 or later Note NI FBUS soft...

Page 52: ...you open a descriptor the NI FBUS Dialog utility adds an icon representing that descriptor You can use the NI FBUS Dialog utility to perform operations on the descriptors you have opened Select the operation you want to perform on a descriptor by right clicking the descriptor icon and choosing an item on the menu that appears or by selecting the icon with a single click and choosing an item on the...

Page 53: ...ces 6 Highlight the interface name of your choice and click the OpenLink button or Open a link by selecting the OpenLink function and entering the interface name 7 Right click the Link icon and select GetDeviceList The NI FBUS Dialog utility displays a list of active devices on your Fieldbus link Your Fieldbus interface board also is included in this list Example 2 Download a Schedule to an Interf...

Page 54: ...enter the name of the parameter to read in the BLOCKTAG PARAM format where BLOCKTAG is the tag of the block containing the parameter and PARAM is the name of the parameter For example to read the OUT parameter of an Analog Input block called FT 201 enter FT 201 OUT 6 Click the Read button to perform the read operation If the call completes successfully the NI FBUS Dialog utility automatically dete...

Page 55: ... and block descriptors To exit the NI FBUS Dialog utility select Exit from the File menu Configuring the Link Active Schedule File If you want to do scheduling and use publishers and subscribers you must follow the instructions in this section You may ignore this section if there is no schedule if the schedule is downloaded over the network to your Fieldbus interface or if you are using software s...

Page 56: ...ule x Sequence x 1 Sequence x y The general line format for all other lines is VARIABLE VALUE where the valid variable names and values are defined in Tables 4 1 to 4 4 Table 4 1 Valid Variable Names and Values for the Schedule Summary Section Variable Name Valid Values Implied Units Default encodingVersionNumber 0 7 none none versionNumber 0x0 0xffff none none builderIdentifier 0x100 0xfff none n...

Page 57: ...mplied Units Default period 0x0 0xffffffff 1 32 ms none numSequence 0 255 none none Table 4 3 Valid Variable Names and Values for the Sequence Section Variable Name Valid Values Implied Units Default maxDuration 0x0 0xffff 1 32 ms none numElement 0 255 none none Table 4 4 Valid Variable Names Including the Variable N and Values for the Sequence Section Variable Name Valid Values Implied Units Defa...

Page 58: ...lop your own LabVIEW programs Refer to NI FBUS VI Help for more information about these VIs Visual C The NI FBUS software supports Microsoft Visual C C version 6 or later The header file and library for Visual C C are in the MS Visual C folder of the NI FBUS folder The typical path to this folder is Program Files National Instruments NI FBUS MS Visual C To use the NI FBUS API include the nifbus h ...

Page 59: ...munications Manager The Declares bas are located in the MS Visual Basic folder of the NI FBUS folder The typical path to this folder is Program Files National Instruments NI FBUS MS Visual Basic The reference for each NI FBUS API function is in Chapter 6 NI FBUS Function Reference You can also refer to Chapter 4 NI FBUS CM Software You can find example for Visual Basic in the example subfolder of ...

Page 60: ...pExample csproj file is the Visual C project of the example Another NET example can be found in examples AdvDemo subfolder of the MS NET folder The AdvDemo csproj file is the Visual C project of the example OPC Server NI FBUS software includes a separate OPC Data Access Server which is compliant with the OPC Data Access 2 0 and 3 0 Specification Any OPC client program can easily access NI FBUS OPC...

Page 61: ... VT_I4 Unsigned8 VT_UI1 Unsigned16 VT_UI2 Unsigned32 VT_UI4 Floating Point VT_R4 Visible String VT_BSTR Octet String VT_ARRAY VT_UI1 Date VT_DATE Time of Day VT_DATE Time Difference VT_DATE Bit String VT_ARRAY VT_UI1 Time Value VT_DATE Array Boolean VT_ARRAY VT_BOOL Integer8 VT_ARRAY VT_I1 Integer16 VT_ARRAY VT_I2 Integer32 VT_ARRAY VT_I4 Unsigned8 VT_ARRAY VT_UI1 Unsigned16 VT_ARRAY VT_UI2 Unsign...

Page 62: ... Foundation Compliance Test for more information please visit OPC Foundation web site www opcfoundation org Array continued Octet String Date VT_ARRAY VT_DATE Time of Day VT_ARRAY VT_DATE Time Difference VT_ARRAY VT_DATE Bit String Time Value VT_ARRAY VT_DATE Table 5 1 OPC Data Type Mapping Rule Continued Meta Type FMS Standard Data Types OPC Data Type ...

Page 63: ...loses an open descriptor nifDownloadDomain Downloads data to the virtual field device VFD domain nifGetBlockList Returns a list of information for all blocks of the type specified in the VFD nifGetDeviceList Returns the list of information for all active devices on the network nifGetInterfaceList Reads the list of interface names from the NI FBUS Communications Manager nifGetVFDList Gathers VFD in...

Page 64: ...e usual time but an error code is returned indicating that you closed the descriptor prematurely If you make more synchronous wait calls that wait on the closing descriptor such as nifWaitTrend nifWaitAlert nifWaitAlert2 and nifGetDeviceList the NI FBUS Communications Manager aborts these functions and returns an error code indicating that you closed the descriptor Since calls that wait on a close...

Page 65: ...n 6 3 NI FBUS Hardware and Software User Manual Return Values E_OK The call was successful E_INVALID_DESCRIPTOR The descriptor is invalid E_SERVER_CONNECTION_LOST The session established with the NI FBUS Communications Manager for this descriptor has been closed or lost ...

Page 66: ...s to the specified VFD domain The domain is specified by index To determine the appropriate index value consult the documentation of the device to which you are trying to download the domain If the device supports the Domain Download feature the index for download should be specified in the documentation Return Values E_OK The call was successful E_INVALID_DESCRIPTOR The descriptor specified is no...

Page 67: ...Context VFD Description nifGetBlockList returns information about all the blocks in the specified VFD A block can be a resource block transducer block or function block residing within a VFD Only blocks of the types specified by whichTypes are returned To determine how many list items are to be returned call the function twice The first time you call the function set the numBlocks parameter to 0 T...

Page 68: ...the wrong type E_COMM_ERROR The NI FBUS Communications Manager failed to communicate with the device E_BUF_TOO_SMALL The buffer does not contain enough entries to hold all the information for the blocks If you receive this error buffer entries that you allocated do not contain valid block information when the call returns E_OBSOLETE_DESC The input descriptor is no longer valid It was closed before...

Page 69: ...dbus interface to the specified link Context Link Description nifGetDeviceList returns a list of information describing each device on the link A link is a group of Fieldbus devices connected across a single wire pair with no intervening bridges Before nifGetDeviceList returns the list of information it waits until the revision argument passed in differs from the live list revision number the Fiel...

Page 70: ...he call was made To determine how many list items are to be returned in the call call the function twice The first time you call the function set the numDevices parameter to 0 The function will return an error stating that there were not enough buffers configured and it will return a new number for numDevices Use this new numDevices parameter to allocate memory for the data When you call the funct...

Page 71: ...r is invalid E_BUF_TOO_SMALL There are not enough buffers allocated If you receive this error your input buffers do not contain valid data E_COMM_ERROR The NI FBUS Communications Manager failed to communicate with the device E_OBSOLETE_DESC The input descriptor is no longer valid It was closed before nifGetDeviceList completed E_SERVER_CONNECTION_LOST The session established with the NI FBUS Commu...

Page 72: ...ameter is an IN OUT parameter On input it must contain the number of buffers that info allocates and points to and on output it contains the total number of interface information entries available If enough buffers were not allocated or if the info buffer is NULL the NI FBUS Communications Manager returns an error and does not copy any data to the buffers In this case the numIntf parameter is stil...

Page 73: ...E 1 nifInterfaceInfo_t Note nifGetInterfaceList is an internal function for the NI FBUS Communications Manager and does not cause Fieldbus activity Return Values E_OK The call was successful E_BUF_TOO_SMALL The buffer does not contain enough entries to hold all the interface information E_CONFIG_ERROR Some configuration information such as registry information or network configuration information ...

Page 74: ...w input buffers or if the input buffer pointer is NULL an error code is returned but the numBuffers parameter is set to the total number of VFDs in the device In this case no buffers contain valid data on output To determine how many list items are to be returned in the call call the function twice The first time you call the function set the numBuffers parameter to 0 The function will return an e...

Page 75: ...ications Manager failed to communicate with the device E_INVALID_DESCRIPTOR The input descriptor does not correspond to a physical device E_BUF_TOO_SMALL There were not enough allocated buffers Your specified input buffers do not contain valid data E_SM_NOT_OPERATIONAL The device is present but cannot respond because it is at a default address E_OBSOLETE_DESC The input descriptor is no longer vali...

Page 76: ...block you request Context VFD physical device link session Description nifOpenBlock returns a descriptor for the block you specify You must pass a valid session link physical device or VFD descriptor to this function There are two ways to specify the block by tag and by ordinal number To open the block by its tag you must set blockTag to the current tag of the block The NI FBUS Communications Mana...

Page 77: ...ccurred when the NI FBUS Communications Manager communicated with the device E_NOT_FOUND There is no such block in the device or VFD with the specified tag E_OBSOLETE_DESC The input descriptor is no longer valid It was closed before nifOpenBlock completed E_RESOURCES A system resource problem occurred The resource problem is usually a memory shortage E_SERVER_CONNECTION_LOST The session establishe...

Page 78: ...t Session Description nifOpenLink returns a descriptor for the link you specify You must pass a valid session descriptor to this function There are two ways you can specify the link If the interfaceOrDevID parameter is zero then name specifies the name of the interface the link is connected to The list of valid interface names is contained in a configuration source which the NI FBUS Communications...

Page 79: ...configuration information is incorrect E_NOT_FOUND The interface name device ID or link ID you specified is not found E_RESOURCES A system resource problem occurred The resource problem is usually a memory shortage E_BAD_ARGUMENT The interfaceOrDevID value is not valid E_OBSOLETE_DESC The input descriptor is no longer valid It was closed before nifOpenLink completed E_SERVER_CONNECTION_LOST The se...

Page 80: ...r for the physical device you specify You must pass a valid session or link descriptor to this function If you pass a link descriptor the NI FBUS Communications Manager searches only that link for the specified device There are two ways you can specify the device If the tagOrDevID parameter is zero then the name specifies the tag of the physical device If tagOrDevID is one then name is the device ...

Page 81: ...ROR An error occurred when the NI FBUS Communications Manager communicated with the device E_RESOURCES A system resource problem occurred The resource problem is usually a memory shortage E_OBSOLETE_DESC The input descriptor is no longer valid It was closed before nifOpenPhysicalDevice completed E_SERVER_CONNECTION_LOST The session established with the NI FBUS Communications Manager for this descr...

Page 82: ...e NI FBUS Communications Manager establishes a communication channel between your application and the NI FBUS entity All subsequent descriptors you open are associated with this session and all the NI FBUS calls on these descriptors communicate with the NI FBUS entity through the communication channel established during the nifOpenSession call The reserved argument is reserved for future use You m...

Page 83: ...vice Description nifOpenVfd returns a descriptor for the VFD you specify More than one VFD can reside within a physical device You must pass a valid physical device descriptor to this function There are two ways to specify the VFD by tag and by ordinal number To open the VFD by its tag you must set the vfdTag parameter to the current tag of the VFD The NI FBUS Communications Manager returns an err...

Page 84: ...unicated with the device E_NOT_FOUND No VFD in the device has the specified VFD tag E_RESOURCES A system resource problem occurred The resource problem is usually a memory shortage E_SM_NOT_OPERATIONAL The device is present but cannot respond because it is at a default address E_OBSOLETE_DESC The input descriptor is no longer valid It was closed before nifOpenVfd completed E_SERVER_CONNECTION_LOST...

Page 85: ...er has been cleanly closed If the interval time is exceeded the NI FBUS Communications Manager process will be forcefully closed Output None Context Not applicable Description nifShutdownCM closes the NI FBUS Communications Manager The return value indicates whether the NI FBUS Communications Manager has been forcibly closed If the NI FBUS Communications Manager cannot be closed normally within th...

Page 86: ...ger interval The maximum waiting time in milliseconds for the NI FBUS Communications Manager to complete the initialization If interval is set to 0 this function will immediately return after the NI FBUS Communications Manager process is created If interval is set to NIFB_TIMEOUT_INFINITE the function will return only when the NI FBUS Communications Manager has completed initialization or an error...

Page 87: ...is function will return an error code Return Values E_OK The NI FBUS Communications Manager has launched successfully E_FILE_NOT_FOUND The NI FBUS Communications Manager binary cannot be found or is corrupt E_REGKEY_NOT_FOUND The NI FBUS system registry information cannot be found or is corrupt E_TIMEOUT The NI FBUS Communications Manager has started but the initialization procedure has not comple...

Page 88: ...nctions Function Purpose nifFreeObjectAttributes Frees an nifAttributes_t structure allocated during a previous call to nifGetObjectAttributes nifFreeObjectType Frees an nifObjTypeLinst_t structure allocated during a previous call to nifGetObjectType nifGetObjectAttributes Reads a single set of object attributes from the Device Description DD nifGetObjectName Returns the Object Dictionary symbol n...

Page 89: ...ibutes Output Not applicable Context Session block VFD physical device link Description nifFreeObjectAttributes frees up the memory associated with the nifAttributes_t structure specified by attr attr must have been filled in by a successful call to nifGetObjectAttributes Once this function has been called the contents of attr are no longer valid If your application does not call this function aft...

Page 90: ... block VFD physical device link Description nifFreeObjectType frees up the memory associated with the nifObjTypeList_t structure specified by typeData typeData must have been filled in by a successful call to nifGetObjectType Once this function has been called the contents of typeData are no longer valid If your application does not call this function after calling nifGetObjectType your applicatio...

Page 91: ...fDesc_t ud NIFB_INDEX_SUBINDEX uint32 idx uint32 subidx nifAttributes_t attr nifError_t nifGetObjectAttributes nifDesc_t ud NIFB_ITEM uint32 item nifAttributes_t attr nifError_t nifGetObjectAttributes nifDesc_t ud NIFB_ITEM_SUBINDEX uint32 item uint32 subidx nifAttributes_t attr nifError_t nifGetObjectAttributes nifDesc_t ud NIFB_BLOCK_ITEM char blocktag uint32 item nifAttributes_t attr nifError_t...

Page 92: ... the object Output attr Object attribute values read from the DDOD Device Description Object Dictionary The type nifAttributes_t consists of a data structure including a type code which selects from a list of structures one for each type of object Other information including whether individual attributes were successfully evaluated and whether individual attributes are dynamic meaning they could c...

Page 93: ...ly if it does not perform this operation Return Values E_OK The call was successful E_CONFIG_ERROR Some configuration information such as registry information or network configuration information is incorrect E_INVALID_DESCRIPTOR The device descriptor does not correspond to a VFD or block E_SYMBOL_FILE_NOT_FOUND The NI FBUS Communications Manager could not find the symbol file E_SM_NOT_OPERATIONAL...

Page 94: ...e nifDesc_t ud NIFB_INDEX_SUBINDEX uint32 idx uint32 subidx char outName nifError_t nifGetObjectName nifDesc_t ud NIFB_ITEM uint32 item char outName nifError_t nifGetObjectName nifDesc_t ud NIFB_ITEM_SUBINDEX uint32 item uint32 subidx char outName nifError_t nifGetObjectName nifDesc_t ud NIFB_BLOCK_INDEX char blocktag uint32 idx char outName nifError_t nifGetObjectName nifDesc_t ud NIFB_BLOCK_INDE...

Page 95: ...FD MIB objects or communication objects from devices If ud is the descriptor of a link then inName must be in BLOCKTAG PARAM_NAME format If ud is a session descriptor then all links are searched for the given BLOCKTAG PARAM_NAME The call fails if identical BLOCKTAG PARAM_NAME tags are found on the bus Index access is not allowed for session descriptors If ud is the descriptor of a general function...

Page 96: ...ndex was that of a simple data type which must already be known to you E_SERVER_CONNECTION_LOST The session established with the NI FBUS Communication Manager under which the descriptor was opened has been lost or closed E_DEVICE_CHANGED The device you specified is changed E_VFD_CHANGED The VFD you specified is changed E_COMM_ERROR An error occurred when the NI FBUS Communication Manager tried to ...

Page 97: ... ud NIFB_INDEX_SUBINDEX uint32 idx uint32 subidx int16 size_in_bytes nifError_t nifGetObjectSize nifDesc_t ud NIFB_ITEM uint32 item int16 size_in_bytes nifError_t nifGetObjectSize nifDesc_t ud NIFB_ITEM_SUBINDEX uint32 item uint32 subidx int16 size_in_bytes nifError_t nifGetObjectSize nifDesc_t ud NIFB_BLOCK_ITEM char blocktag uint32 item int16 size_in_bytes nifError_t nifGetObjectSize nifDesc_t u...

Page 98: ...OCKTAG PARAM form To specify a structure element by name specify the name in BLOCKTAG STRUCT ELEMENT format Refer to Table 6 5 for an explanation of how to use macros to specify the character string name Output size_in_bytes The size of the object Context Session block VFD physical device link Description This function returns the size of the specified Object Value You have to pass a buffer of the...

Page 99: ...IPLE Multiple identical tags were found the function failed E_OBSOLETE_DESC The input descriptor is no longer valid It was closed before nifGetObjectSize completed E_ORDINAL_NUM_OUT_OF_RANGE The ordinal number is out of the device range E_SERVER_CONNECTION_LOST The session established with the NI FBUS Communications Manager for this descriptor has been closed or lost ...

Page 100: ...INDEX uint32 idx uint32 subidx nifObjTypeList_t typeData nifError_t nifGetObjectType nifDesc_t ud NIFB_ITEM uint32 item nifObjTypeList_t typeData nifError_t nifGetObjectType nifDesc_t ud NIFB_ITEM_SUBINDEX uint32 item uint32 subidx nifObjTypeList_t typeData nifError_t nifGetObjectType nifDesc_t ud NIFB_BLOCK_ITEM char blocktag uint32 item nifObjTypeList_t typeData nifError_t nifGetObjectType nifDe...

Page 101: ...ock objName The name of the parameter you want to read the OD type of in BLOCKTAG PARAM form Refer to Table 6 5 for an explanation of how to use macros to specify the parameter To specify a named structure element supply name in BLOCKTAG STRUCT ELEMENT format To specify a type index returned by a previous call to nifGetObjectType use the NIFB_TYPE_INDEX macro Output typeData Object Type value read...

Page 102: ..._NAME format If ud is the descriptor of a function block and you use the NIFB_INDEX or NIFB_INDEX_SUBINDEX macro the index specified is the relative index of the parameter within the block Relative indices start at one for the first parameter Index zero retrieves the OD type of the block itself In all cases you can expand PARAM_NAME to STRUCT ELEMENT format to represent a named element of a named ...

Page 103: ...Elems loop For variable list objects type ODT_VARLIST you must call nifGetObjectType for each element in the list of elements with the typeIndex of the element returned in the list with the first nifGetObjectType call The typeIndex of the element returned in the list in this case is the relative index of the element within the block whose name is returned by blockTag These subsequent calls to nifG...

Page 104: ...ctType you must call nifFreeObjectType to clean up memory allocated within these structures For objects with the object codes ODT_DOMAIN ODT_PI ODT_EVENT and ODT_SIMPLETYPE only the object type is returned and the list of elements allElems in the structure nifObjTypeList_t is empty The list of standard data types for an object which has the object code ODT_SIMPLETYPE also is as specified in the FM...

Page 105: ...pecified by index was that of a simple data type which must already be known to you E_RESOURCES The NI FBUS Communications Manager is unable to allocate some system resource This is usually a memory problem E_SERVER_CONNECTION_LOST The session established with the NI FBUS Communications Manager under which the descriptor was opened has been lost or closed Visible String FF_VISIBLE_STRING 1 2 3 Oct...

Page 106: ..._t nifReadObject nifDesc_t ud NIFB_INDEX_SUBINDEX uint32 idx uint32 subidx void buffer uint8 length nifError_t nifReadObject nifDesc_t ud NIFB_ITEM uint32 item void buffer uint8 length nifError_t nifReadObject nifDesc_t ud NIFB_ITEM_SUBINDEX uint32 item uint32 subidx void buffer uint8 length nifError_t nifReadObject nifDesc_t ud NIFB_BLOCK_ITEM char blocktag uint32 item void buffer uint8 length ni...

Page 107: ..._BLOCK_NAME_SUBINDEX char blocktag char name uint32 subidx void buffer uint8 length Input ud The descriptor of the session link physical device VFD or block if reading by name If reading by index ud must be a VFD or block name Name of the parameter your application reads in BLOCKTAG PARAM format To specify a structure element by name specify the name in BLOCKTAG STRUCT ELEMENT format Refer to Tabl...

Page 108: ...MENT format to represent a named element of a named structure In each case name can represent either a variable or a variable list object You should determine the size of the object beforehand possibly with a call to nifGetObjectSize If the object is larger than the buffer size specified in length the NI FBUS Communications Manager returns an error and none of the data in the buffer is valid Refer...

Page 109: ...Communications Manager could not find the symbol file E_OBSOLETE_DESC The input descriptor is no longer valid It was closed before nifReadObject completed E_COMM_ERROR The NI FBUS Communications Manager failed to communicate with the device E_PARAMETER_CHECK The device reported a violation of parameter specific checks E_SERVER_CONNECTION_LOST The session established with the NI FBUS Communications...

Page 110: ... element by index and subindex use the NIFB_INDEX_SUBINDEX macro To specify a named structure element supply the parameter name in the form of BLOCKTAG STRUCT ELEMENT numObjects The number of parameter names specified in blkParamList The maximum number of objects that can be specified in blkParamList is given by the constant MAX_LIST_ELEMS length The size of the buffer to hold the result of all th...

Page 111: ...hin the block Relative indices start at 1 for the first block parameter In all descriptor cases any PARAM_NAME specified in blkParamList can be expanded to STRUCT ELEMENT format to represent a named element of a named structure For each name specified in blkParamList the name can either represent a variable or a variable list object You should determine the size of each object specified in blkPara...

Page 112: ...s no longer valid E_BUF_TOO_SMALL The size of the data resulting from the read of all objects specified in the list is larger than your buffer E_RESOURCES A system resource problem occurred The resource problem is usually a memory shortage E_SERVER_CONNECTION_LOST The session established with the NI FBUS Communications Manager for this descriptor has been closed or lost ...

Page 113: ...gth nifError_t nifWriteObject nifDesc_t ud NIFB_INDEX_SUBINDEX uint32 idx uint32 subidx void buffer uint8 length nifError_t nifWriteObject nifDesc_t ud NIFB_ITEM uint32 item void buffer uint8 length nifError_t nifWriteObject nifDesc_t ud NIFB_ITEM_SUBINDEX uint32 item uint32 subidx void buffer uint8 length nifError_t nifWriteObject nifDesc_t ud NIFB_BLOCK_ITEM char blocktag uint32 item void buffer...

Page 114: ...LOCK_NAME_SUBINDEX char blocktag char name uint32 subidx void buffer uint8 length Input ud The descriptor of the session link physical device VFD or block if writing by name If writing by index ud must be a VFD or block name Name of the parameter you want the NI FBUS Communications Manager to write in BLOCKTAG PARAM form To specify a structure element by name specify the name in BLOCKTAG STRUCT EL...

Page 115: ...x of the parameter within the block Relative indices start at one for the first parameter In all descriptor cases you can expand PARAM_NAME itself to STRUCT ELEMENT format to represent a named element of a named structure Refer to Table 6 5 for an explanation of how to use macros to specify the parameter Return Values E_OK The call was successful E_INVALID_DESCRIPTOR The device descriptor does not...

Page 116: ... not allow you to write to the parameter E_WRITE_IS_PROHIBITED The device reported that the WRITE_LOCK parameter value is set The WRITE_LOCK parameter prohibits writing to the name parameter E_DATA_NEVER_WRITABLE The specified object is read only E_SERVER_CONNECTION_LOST The session established with the NI FBUS Communications Manager for this descriptor has been closed or lost ...

Page 117: ... specify an object by its item ID with the NIFB_ITEM macro or you can specify a subelement by its item ID with the NIFB_ITEM_SUBINDEX macro Table 6 5 Core Function Macros Descriptor Type You Have Parameter Information You Have Macro to Use Block Descriptor Name Normal Access by Name Name and Subindex NIFB_NAME_SUBINDEX Relative Index within the Block NIFB_INDEX Relative Index and Subindex NIFB_IND...

Page 118: ...specify a subindex You can find all these macros in the nifbus h header file Alert and Trend Functions The following tables list the alert and trend functions Table 6 6 Alert Functions Function Purpose nifAcknowledgeAlarm Acknowledges an alarm received nifWaitAlert Waits for an alert an event or an alarm from a specific device or from any device nifWaitAlert2 Waits for an alert an event or an alar...

Page 119: ...s an alarm notification from a device The NI FBUS Communications Manager clears the unacknowledged field associated with the alarm object alarmName If ud is a block descriptor the alarmName is the same as the alarmOrEventName field of the alert data you get in the nifWaitAlert or nifWaitAlert2 call If ud is a session link VFD or physical device descriptor then alarmName is in BLOCKTAG PARAMNAME fo...

Page 120: ...ALARM_ACKNOWLEDGED The alarm has already been acknowledged E_MULTIPLE There are identical block tags E_NOT_FOUND There is no such block in the device or VFD with the specified tag E_SYMBOL_FILE_NOT_FOUND The NI FBUS Communications Manager could not find the symbol file E_SERVER_CONNECTION_LOST The session established with the NI FBUS Communications Manager for this descriptor has been closed or lo...

Page 121: ...NI FBUS Communications Manager waits for an alert from any block in the Virtual Field Device If ud is a block the NI FBUS Communications Manager waits for an alarm or event from the block ud refers to If ud represents a link nifWaitAlert completes when an event is received from any device connected to that link If the descriptor is a session descriptor the function waits on any event from any atta...

Page 122: ...descriptor on which the call was made The alertType parameter can be ALERT_ANALOG ALERT_DISCRETE or ALERT_UPDATE nifAlertData_t is defined as follows typedef struct nifAlertData_t uint8 alertType char deviceTag TAG_SIZE 1 char blockTag TAG_SIZE 1 char alarmOrEventName TAG_SIZE 1 uint8 alertKey uint8 standardType uint8 mfrType uint8 messageType uint8 priority nifTime_t timeStamp uint16 subCode uint...

Page 123: ...f the alert types of nifWaitAlert and nifWaitAlert2 is able to support Standard Diagnostics Alert It is recommended that you use nifWaitAlert2 instead of nifWaitAlert ud represents a descriptor of a session link a physical device a VFD or a block If ud is a VFD descriptor then the NI FBUS Communications Manager waits for an alert from any block in the Virtual Field Device If ud is a block the NI F...

Page 124: ...o receive the same alert the NI FBUS Communications Manager sends a copy of the alert to all the waiting threads Your application must ensure that only one thread acknowledges any one alarm with a call to nifAcknowledgeAlarm You can abort a pending nifWaitAlert2 call by closing the descriptor on which the call was made The alertType parameter can be ALERT_ANALOG ALERT_DISCRETE ALERT_UPDATE or or A...

Page 125: ...t32 relativeIndex nifAlertUpdateData_t typedef struct nifAlertStandardDiagnosticsData_t uint32 subCode uint8 value uint32 relativeIndex uint16 sourceBlockIndex nifAlertStandardDiagnosticsData_t Return Values E_OK The call was successful E_INVALID_DESCRIPTOR The descriptor you gave is invalid E_OBSOLETE_DESC The input descriptor is no longer valid It was closed before nifWaitAlert2 completed E_SERV...

Page 126: ...y device connected to that link If the descriptor is a session descriptor nifWaitTrend waits on any trend from any attached link nifWaitTrend waits indefinitely until the NI FBUS Communications Manager interface receives a trend Your application can have a dedicated thread which does nifWaitTrend only When a trend comes in the trend parameter is filled in with the information about the trend The f...

Page 127: ...E or TREND_BITSTRING The sample type can be SAMPLE_INSTANT or SAMPLE_AVERAGE nifTrendData_t is defined as follows typedef struct nifTrendData_t uint8 trendType char deviceTag TAG_SIZE 1 char blockTag TAG_SIZE 1 char paramName TAG_SIZE 1 uint8 sampleType uint32 sampleInterval nifTime_t lastUpdate uint8 status 16 union float f 16 uint8 d 16 uint8 bs 32 trendData nifTrendData_t Return Values E_OK The...

Page 128: ...US HSE H1 linking device PCI FBUS 2 Power Requirement PCI FBUS 2 820 mA Typical Physical Dimensions 10 67 17 46 cm 4 2 6 88 in I O connector 9 pin male D SUB 1 per Fieldbus link Altitude 2 000 m Pollution Degree 2 Indoor use only Environment Operating Environment Ambient temperature 0 to 55 C Relative humidity 10 to 90 noncondensing Storage Environment Ambient temperature 20 to 70 C Relative humid...

Page 129: ...sions Basic immunity EN 55011 CISPR 11 Group 1 Class A emissions AS NZS CISPR 11 Group 1 Class A emissions FCC 47 CFR Part 15B Class A emissions ICES 001 Class A emissions Note For EMC declarations and certifications refer to the Online Product Certification section Note For EMC compliance operate this device with shielded cables and accessories CE Compliance This product meets the essential requi...

Page 130: ...tal regulations and directives with which NI complies as well as other environmental information not included in this document Waste Electrical and Electronic Equipment WEEE EU Customers At the end of the product life cycle all products must be sent to a WEEE recycling center For more information about WEEE recycling centers National Instruments WEEE initiatives and compliance with WEEE Directive ...

Page 131: ...l Dimensions 8 56 5 40 0 5 cm 3 4 2 1 0 2 in I O connector PCMCIA FBUS cable with 9 pin male D SUB and pluggable screw terminal for each port Altitude 2 000 m Pollution Degree 2 Indoor use only Environment Operating Environment Ambient temperature 0 to 55 C Relative humidity 10 to 90 noncondensing tested in accordance with IEC 60068 2 1 IEC 60068 2 2 EC 60068 2 56 Storage Environment Ambient tempe...

Page 132: ... Class A emissions Basic immunity EN 55011 CISPR 11 Group 1 Class A emissions AS NZS CISPR 11 Group 1 Class A emissions FCC 47 CFR Part 15B Class A emissions ICES 001 Class A emissions Note For EMC declarations and certifications refer to the Online Product Certification section Note For EMC compliance operate this device with shielded cables and accessories CE Compliance This product meets the es...

Page 133: ...ns and directives with which NI complies as well as other environmental information not included in this document Waste Electrical and Electronic Equipment WEEE EU Customers At the end of the product life cycle all products must be sent to a WEEE recycling center For more information about WEEE recycling centers National Instruments WEEE initiatives and compliance with WEEE Directive 2002 96 EC on...

Page 134: ... powered Device Working Mode Current 300 mA maximum full temperature range 180 mA typical at 25 C Suspend Current 2 5 mA maximum full temperature range Physical USB 8486 without Screw Retention and Mounting Options Dimensions 7 87 6 35 2 54 cm 3 1 2 5 1 0 in Weight 165 g 5 82 oz Captive USB cable length 2 m I O connector USB Standard series A plug FOUNDATION Fieldbus H1 Interface 9 pin male D SUB ...

Page 135: ...tandard series A plug with retention thumbscrew FOUNDATION Fieldbus H1 Interface 9 pin male D SUB Altitude 2 000 m Pollution Degree 2 Indoor use only Environment Operating Environment Ambient temperature 0 to 55 C Relative humidity 10 to 90 noncondensing tested in accordance with IEC 60068 2 1 IEC 60068 2 2 EC 60068 2 56 Storage Environment Ambient temperature 20 to 70 C Relative humidity 5 to 95 ...

Page 136: ... Class A emissions Basic immunity EN 55011 CISPR 11 Group 1 Class A emissions AS NZS CISPR 11 Group 1 Class A emissions FCC 47 CFR Part 15B Class A emissions ICES 001 Class A emissions Note For EMC declarations and certifications refer to the Online Product Certification section Note For EMC compliance operate this device with shielded cables and accessories CE Compliance This product meets the es...

Page 137: ...t Waste Electrical and Electronic Equipment WEEE EU Customers At the end of the product life cycle all products must be sent to a WEEE recycling center For more information about WEEE recycling centers National Instruments WEEE initiatives and compliance with WEEE Directive 2002 96 EC on Waste and Electronic Equipment visit ni com environment weee FBUS HSE H1 Linking Device FBUS HSE H1 LD High Spe...

Page 138: ...onment Operating Environment Ambient temperature 20 to 55 C Relative humidity 10 to 90 noncondensing Storage Environment Ambient temperature 55 to 85 C Relative humidity 5 to 95 noncondensing Safety This product meets the requirements of the following standards of safety for electrical equipment for measurement control and laboratory use IEC 60950 1 EN 60950 1 UL 60950 1 CSA 60950 1 Note For UL an...

Page 139: ...icable European Directives as follows 2006 95 EC Low Voltage Directive safety 2004 108 EC Electromagnetic Compatibility Directive EMC Online Product Certification To obtain product certifications and the Declaration of Conformity DoC for this product visit ni com certification search by model number or product line and click the appropriate link in the Certification column Environmental Management...

Page 140: ...recycling center For more information about WEEE recycling centers National Instruments WEEE initiatives and compliance with WEEE Directive 2002 96 EC on Waste and Electronic Equipment visit ni com environment weee ᄤֵᙃѻક ᶧ ࠊㅵ ࡲ Ё RoHS Ё ᅶ National Instruments ヺড়Ё ᄤֵᙃѻકЁ䰤ࠊՓ ᶤѯ ᆇ 䋼ᣛҸ RoHS Ǆ Ѣ National Instruments Ё RoHS ড়㾘ᗻֵᙃˈ䇋ⱏᔩ ni com environment rohs_chinaǄ For information about China RoHS compli...

Page 141: ...s National Instruments NI FBUS Utilities Interface Configuration Utility Ensure that your board appears under the list of interfaces Ensure the NIFB driver is started Select Start Settings Control Panel System Hardware Device Manager Select National Instruments FieldBus Interfaces USB 8486 or PCI FBUS 2 or PCMCIA FBUS right click and select Properties Ensure there are no conflicts When using a USB...

Page 142: ...istry entries for NI FBUS may have been deleted or corrupted Uninstall the NI FBUS software then reinstall the software In the Interface Configuration Utility I see more boards than what physically exist in the machine Select Edit for the extra board In the next window select Delete Caution You should not attempt to make unguided changes in the Windows registry Doing so can cause many problems wit...

Page 143: ... the system Also check that the number of ports match the physical hardware one port versus two port boards Link masters do not always work well together if you have another link master on the link Try setting the board to be a basic device in the Interface Configuration Utility If a board interface is configured as a basic device another link master device must be present on this link before the ...

Page 144: ... steps to use the NI FBUS Dialog utility to check device description files 1 Start the NIFB process Wait until the process has finished initializing 2 Select Start All Programs National Instruments NI FBUS Utilities Dialog 3 Right click Open Descriptors and select Expand All 4 After the expansion is complete click Cancel to close the Expand All window 5 Right click the resource block for your devi...

Page 145: ...umber from step 9 The device revision is the first two digits and the device description revision is the second two digits For example if your number from step 8 was 2 and from step 9 was 1 you should see files called 0201 ffo and 0201 sym Device descriptions are backward compatible This means that instead of seeing 0201 you might see 0202 This is allowed by the Fieldbus specification Also having ...

Page 146: ...H1 Fieldbus port encountered a fatal network error Complete the following steps to correct the issue 1 Remove the USB 8486 from the computer and close NI FBUS Communications Manager 2 Re connect the USB 8486 to the USB port of the system again 3 Restart the NI FBUS Communication Manager and check the H1 Fieldbus LED state Configuring Advanced Parameters Caution Do not modify the Advanced parameter...

Page 147: ...l itself T1 describes the expected response delay of the device at a given address T3 describes the expected time for the device to respond at its new address Uninstalling the Software If you are only using the Communications Manager uninstall the NI FBUS Communications Manager If you are using the NI FBUS Configurator uninstall the NI FBUS Configurator The uninstall utility does not remove the NI...

Page 148: ...evice LED Indicators The FBUS HSE H1 LD has seven LED indicators on the top panel and three LEDs on the front panel as shown in Figure B 2 Figure B 2 LEDs on the FBUS HSE H1 LD 1 H1 Port1 Network Status 2 Power 3 Process 4 Ethernet Status 5 Module Status 6 TX 7 RX 8 H1 Port 2 Network Status 9 Link 2 4 3 7 6 1 9 5 8 ...

Page 149: ...ng STATUS LED a specific number of times Table B 2 describes the STATUS LED flashing sequences and the corresponding error conditions The green TX LED is lit when the FBUS HSE H1 LD transmits data over the Ethernet The green RX LED is lit when the FBUS HSE H1 LD receives data from the Ethernet Because of unrelated network traffic this LED blinks occasionally even when the FBUS HSE H1 LD is inactiv...

Page 150: ...ce has left standby state because the necessary network configuration if any has occurred 3 The FBUS HSE H1 LD cannot communicate with the NIFBUS Ensure that the NIFBUS is running on the computer you specified when you configured the FBUS HSE H1 LD 4 or more The FBUS HSE H1 LD has detected an unrecoverable error Contact National Instruments for more information of finding the cause of this error T...

Page 151: ...e B 3 Figure B 3 LEDs on the USB 8486 Table B 4 Description of Fieldbus Network Status LED States LED State Meaning Off Fieldbus port is not receiving packets Steady green Fieldbus port is alive as Link Active Scheduler Flashing green Fieldbus port is not alive as Link Active Scheduler Flashing red and green Fieldbus port is seeing traffic but is at a default or visitor address Flashing red Fieldb...

Page 152: ...B 8486 USB STATUS LED LED State Meaning Off There is no power on the USB port the USB 8486 is disabled or an error has occurred Solid green The USB 8486 is working in USB 2 0 full speed mode Solid amber The USB 8486 is working in USB 2 0 high speed mode Table B 6 Interpretation of USB 8486 H1 Fieldbus Status LED LED State Meaning Off The USB 8486 has not been initialized Solid green The Fieldbus p...

Page 153: ...ce a link master device must be present on this link before NI FBUS will start up Call to Open Session Fails If the call fails ensure that your NI FBUS Communications Manager process is running and that it has not displayed any error message boxes during startup You can check this by maximizing and looking at the nifb exe console window If the title bar does not end in Running NI FBUS did not star...

Page 154: ... error that is indicative of a T3 value that is too small if this occurs increase your T3 value until the IDENTIFY to the new address occurs after the PR All of the System Management Info timers are in units of 1 32 of a millisecond for instance T3 32000 units means that T3 1 second Setting Number of Polled Addresses The Fieldbus specification describes how a Link Active Scheduler device LAS devic...

Page 155: ...T milliseconds for a device to get on the bus If however the LAS probed only the first 16 addresses and the last 16 addresses it might take 32T milliseconds for the device to get on the bus This results in the new device being recognized almost eight times faster These parameters also affect the Set Address protocol because recognizing a device at a new address is really the same as recognizing a ...

Page 156: ...bles are regarded as leaf nodes in the OPC address space The RECORD type variables are regarded as branch nodes you need to access each of its member variable through this branch node Table B 7 shows the data type mapping rule Table B 7 OPC Data Type Mapping Rule Meta Type FMS Standard Data Types OPC Data Type Simple Boolean VT_BOOL Integer8 VT_I1 Integer16 VT_I2 Integer32 VT_I4 Unsigned8 VT_UI1 U...

Page 157: ...tion source set to Remote Then set the Remote source to the Activate member of the OPCClient object Leave edit mode then set the switch to the off FALSE position 4 Add all the items you are interested in to the OPCClient object s Array Boolean VT_ARRAY VT_BOOL Integer8 VT_ARRAY VT_I1 Integer16 VT_ARRAY VT_I2 Integer32 VT_ARRAY VT_I4 Unsigned8 VT_ARRAY VT_UI1 Unsigned16 VT_ARRAY VT_UI2 Unsigned32 V...

Page 158: ...r Explorer 1 Launch the Server Explorer 2 Create an inactive OPC client group a Right click NIFB_OPCDA 3 and select Add Edit Groups b Create a group with the appropriate parameters Ensure there is no checkmark in the Active box 3 Add all items 4 Select File OPC Save to save the file 5 Activate the group by right clicking the group and selecting Activate Group 6 When you open the saved file and wan...

Page 159: ...he lookout dat file the next time it is started When it regenerates the file it will see that Fieldbus software has been installed and will make the Fieldbus objects available Fieldbus Alarms in Lookout In Lookout there is a separate alarms window for Fieldbus alarms Under the Options menu select Fieldbus to show this window The window also can be shown using traditional Lookout datamember ShowAla...

Page 160: ...les members to direct access to NI Applications Engineers via phone and email for one to one technical support as well as exclusive access to eLearning training modules at ni com eLearning NI offers complementary membership for a full year after purchase after which you may renew to continue your benefits For information about other technical support options in your area visit ni com services or c...

Page 161: ... DoC for your product by visiting ni com certification Calibration Certificate If your product supports calibration you can obtain the calibration certificate for your product at ni com calibration You also can visit the Worldwide Offices section of ni com niglobal to access the branch office Web sites which provide up to date contact information support phone numbers email addresses and current e...

Page 162: ...code that identifies a specific location or series of locations in memory Administrative Function An NI FBUS function that deals with administrative tasks such as returning descriptors and closing descriptors Alarm A notification the NI FBUS Communications Manager software sends when it detects that a block leaves or returns to a particular state Alarm condition A notification that a Fieldbus devi...

Page 163: ...arameters its block type specifies The values of the parameters persist from one invocation of the block to the next It can be a resource block transducer block or function block residing within a virtual field device Block tag A character string name that uniquely identifies a block on a Fieldbus network Buffer Temporary storage for acquired or generated data Bus The group of conductors that inte...

Page 164: ...ames if they are not received correctly It also performs error checking to maintain a sound virtual channel to the next layer DD See Device Description Descriptor A number returned to the application by the NI FBUS Communications Manager used to specify a target for future NI FBUS calls Device A sensor actuator or control equipment attached to the Fieldbus Device Description A machine readable des...

Page 165: ...or Fieldbus that has characteristics important for good signal transmission and are within the requirements of the Fieldbus standard Fieldbus Foundation An organization that developed a Fieldbus network specifically based upon the work and principles of the ISA IEC standards committees Fieldbus Messaging Specification The layer of the communication stack that defines a model for applications to in...

Page 166: ...The 31 25 kbit second type of Fieldbus Hard code To permanently establish something that should be variable in a program Header file A C language source file containing important definitions and function prototypes HMI Human Machine Interface A graphical user interface for the process with supervisory control and data acquisition capability Host device A computer or controller on a Fieldbus networ...

Page 167: ... schedule of times in the macrocycle when devices must publish their output values on the Fieldbus Link Active Scheduler The Fieldbus device that is currently controlling access to the Fieldbus A device that is responsible for keeping a link operational The LAS executes the link schedule circulates tokens distributes time and probes for new devices Link master device A device that is capable of be...

Page 168: ...Fieldbus communication stack that contains objects that other layers of the communication stack use such as Data Link FAS and FMS You can read and write SM and NM objects over the Fieldbus using FMS Read and FMS Write services NI FBUS API The function calls provided by NI FBUS Communication Manager NI FBUS Communications Manager Software shipped with National Instruments Fieldbus interfaces that l...

Page 169: ...m or written to a device Octet A single 8 bit value OD See Object Dictionary OPC OLE for Process Control Output parameter A block parameter that sends data to another block P Parameter One of a set of network visible values that makes up a function block PC Personal Computer PCMCIA Personal Computer Memory Card International Association PD Proportional Derivative Physical device A single device re...

Page 170: ...Fieldbus compliant devices S s Seconds Sample type Specifies how trends are sampled on a device whether by averaging data or by instantaneous sampling Segment See Link Sensor A device that responds to a physical stimulus heat light sound pressure motion flow and so on and produces a corresponding electrical signal Server Device that receives a message request Service Services allow user applicatio...

Page 171: ... Fieldbus communication stack that assigns addresses and physical device tags maintains the function block schedule for the function blocks in that device and distributes application time You also can locate a device or a function block tag through SM T Tag A name you can define for a block virtual field device or device Thread An operating system object that consists of a flow of control within a...

Page 172: ...applications use Virtual Communication Relationship Preconfigured or negotiated connections between virtual field devices on a network Virtual Field Device The virtual field device is a model for remotely viewing data described in the object dictionary The services provided by the Fieldbus Messaging Specification allow you to read and write information about the object dictionary read and write th...

Page 173: ...sing level of communication 4 7 compiling linking and running 4 13 core functions 4 3 developing your NI FBUS Communications Manager application 4 7 device description functions 4 5 LabVIEW 5 1 name or index access 4 7 NET class libraries 5 2 NI FBUS Dialog Utility 4 11 single thread versus multi thread applications multi thread 4 8 single thread 4 8 using the NI FBUS Communications Manager proces...

Page 174: ...ces C 1 related documentation xii downloading schedule to interface 4 15 drivers NI resources C 1 E error messages B 1 Ethernet cable wiring connections table 3 6 STATUS LED flashes and corresponding errors table B 9 Ethernet LEDs LINK B 9 POWER B 9 PROCESS B 9 RX B 9 STATUS B 9 TX B 9 examples NI resources C 1 F FBUS HSE H1 Linking Device LD cabling and connectors 3 5 connector pinout figure 3 7 ...

Page 175: ... 1 MIB list parameters 4 11 MIB parameters 4 11 I import device descriptions 2 18 index based access 4 7 installation and configuration 2 1 testing 2 17 installation of OPC NI FBUS Server 4 2 instrument drivers NI resources C 1 interface information changing or deleting existing information 2 17 interface macros NI FBUS 6 55 interface name setting 2 15 K KnowledgeBase C 1 L LabVIEW DSC troubleshoo...

Page 176: ...ing for a trend 4 16 NI FBUS functions administrative functions 4 2 alert and trend functions 4 4 core functions 4 3 device description functions 4 5 overview 4 2 nifClose function 6 2 nifDownloadDomain function 6 4 nifFreeObjectAttributes function 6 27 nifFreeObjectType function 6 28 nifGetBlockList function 6 5 nifGetDeviceList function 4 7 4 8 4 12 6 7 nifGetInterfaceList function 6 10 nifGetOb...

Page 177: ...ut figure 2 15 programming examples NI resources C 1 R related documentation xii running applications 4 13 S sample programs 4 13 schedule downloading 4 15 screw terminal block pinout figure 3 3 Server Explorer and OPC NI FBUS server troubleshooting B 18 set address troubleshooting B 13 single thread applications 4 8 software developing applications 4 2 alert and trend functions 4 4 compile link a...

Page 178: ...B 18 set address B 13 number of polled addresses B 14 startup problems B 13 USB 8486 B 6 using Fieldbus with OPC B 15 using manufacturer defined features B 3 U uninstalling the software B 7 USB 8486 cabling and connectors 3 4 DB 9 cable connector pinout figure 3 5 Fieldbus connector figure 3 4 Fieldbus connector pinout figure 3 4 H1 Fieldbus status LEDs table B 12 LEDs figure B 11 specifications A...

Search results

Summary of Contents for FOUNDATION NI-FBUS

Reviews:

Related manuals for FOUNDATION NI-FBUS

Brands by name

Popular brands

National Instruments FOUNDATION NI-FBUS, Hardware And Software User Manual

Search results

Summary of Contents for FOUNDATION NI-FBUS

Reviews:

Related manuals for FOUNDATION NI-FBUS

Brands by name

Popular brands