Documente Academic
Documente Profesional
Documente Cultură
April 2012
FOUNDATION Fieldbus Toolkit for Field Communicator Device Developers
Disclaimer
The contents of this publication are presented for informational
purposes only, and while every effort has been made to ensure their
accuracy, they are not to be construed as warranties or guarantees,
express or implied, regarding the products or services described
herein or their use or applicability. We reserve the right to modify or
improve the designs or specifications of such products at any time
without notice.
Document History
Date Description
Table of Contents
Disclaimer ...................................................................................... ii
Copyright and Trademark Information .......................................... ii
Document History .......................................................................... ii
Introduction Introduction..................................................................................... 1-1
Overview..................................................................................... 1-1
System Requirements ................................................................. 1-1
Files............................................................................................. 1-3
References................................................................................... 1-4
Toolkit Questions........................................................................ 1-4
Using the Toolkit ............................................................................ 2-1
Install the FOUNDATION Fieldbus DD Developer Kits ............... 2-1
Write and Tokenize Your Device Description............................ 2-1
Create Your CFF File ................................................................. 2-1
Generate the FOUNDATION fieldbus DDP .................................. 2-2
Load the FOUNDATION fieldbus DDP......................................... 2-5
Importing FOUNDATION fieldbus DDPs into the Easy Upgrade
Utility PC Database .................................................................... 2-6
Downloading FOUNDATION fieldbus DDPs to the Field
Communicator through IrDA...................................................... 2-7
Downloading FOUNDATION fieldbus DDPs to the 475 Field
Communicator through Bluetooth .............................................. 2-9
Using a Card Reader ................................................................... 2-9
Menus ....................................................................................... 2-10
Methods .................................................................................... 2-11
Block Items Definitions ............................................................ 2-12
Read/Write Parameter Access .................................................. 2-12
Block Instantiation .................................................................... 2-12
Rules for Displaying Parameter Labels .................................... 2-13
Supported EDDL Features ........................................................ 2-14
Help in DD................................................................................ 2-14
DD Restrictions and Known Issues ................................................ 3-1
DD Restrictions .......................................................................... 3-1
Issue with Refresh Actions for Charts and Graphs ..................... 3-2
DD Testing and Registration .......................................................... 4-1
Testing Guidelines ...................................................................... 4-1
DD Registration .......................................................................... 4-2
Glossary .......................................................................................... 5-1
Overview
This toolkit is used to develop Device Driver Packages (DDPs) for
FOUNDATION fieldbus devices for use on the 375 or 475 Field
Communicator. The toolkit takes output from the FOUNDATION
fieldbus Device Description Integrated Development Environment
(not included) and processes it for use on the Field Communicator.
The toolkit consists of the following components:
• Field Communicator FF DD Package Wizard
• FOUNDATION Fieldbus Toolkit for Field Communicator Device
Developers User Manual (this document)
System Requirements
PC Hardware Requirements
• 1 GB disk space - More space may be required as you add file
packages
• 256MB RAM
• 866MHz processor
• Windows XP Professional SP2 or higher, Windows Vista
Business SP1 or higher, or Windows 7 Professional (32 or 64
bit)
PC Software Requirements
Note: The following software is not included in the toolkit:
Files
The toolkit consists of the following files:
• Readme.pdf - Readme file in PDF format
• License.pdf - License file in PDF format
• FieldCommunicatorFFToolkit.pdf - This document in PDF
format
• Facsimile Lead Sheet.pdf – Field Communicator FF Device
Description Production Approval Form
• FieldCommunicatorFFDDPWizard.exe – Field Communicator
FF DDP wizard
• TazTskGen.exe – Field Communicator FF DD stack information
generator is a tool used by the Field Communicator FF DDP
wizard
• GenPackedSym.exe – Field Communicator FF packed symbol
file generator is a tool used by the Field Communicator FF DDP
wizard
• TazCifGen.exe – Field Communicator capability information file
(CIF) generator is a tool used by the Field Communicator FF
DDP wizard
• DDPEngine.dll – Field Communicator FF DDP Engine DLL is a
library used by the Field Communicator FF DDP wizard
• ManufacturerIDTable.xml - List of all manufacturer names and
IDs used by the Field Communicator FF DDP wizard
• PVECommonTools.dll - Common tools DLL is a library used by
the Field Communicator FF DDP wizard
• PVETranslator.dll - Translation DLL is a library used by the
Field Communicator FF DDP wizard
• zlib.dll - Zip utility DLL is a library used by the Field
Communicator FF DDP wizard
• PVEStandard.dct - Standard translation dictionary (note: this is
not the FOUNDATION fieldbus dictionary file).
• 375FFDDPWizard.dct – Field Communicator FF DDP Wizard
dictionary
• TAZDDWizard.hlp - Field Communicator FF DDP Wizard
online help file
• TAZDDWizard.cnt - Field Communicator FF DDP Wizard
online help content file
References
FOUNDATION Fieldbus Specification – Device Description Language
(document number: FF-900, Revision FS 5.1)
FOUNDATION Specification Common File Format (document
number: FF-103, Revision 1.9)
Toolkit Questions
Email any questions concerning the use of this toolkit to:
FieldCommunicatorToolkit@emerson.com.
6. Click Next.
7. The DD Package Wizard displays a summary of the DDP it will
create. Click Back to make corrections or click Finish to create
the DDP.
The output .fdd and .fhd files are stored in the same folder with the
input files. The naming convention used for these files is the
combination of the manufacturer ID (6 hex digits), the device ID (4
hex digits), the device revision (2 hex digits), and the device
description revision (2 hex digits).
Menus
Menus can be displayed as block menus or device-level menus. If
device-level menus are defined in the DD, they are used by the Field
Communicator.
Device-level Menus
Device-level menus are not associated with any one block and may
not be listed in any block's MENU_ITEMS list.
hh_device_root_menu
hh_process_variables_root_menu
hh_diagnostic_root_menu
There can be any level of device-level menus under each root menu.
Block Menus
Menu_Top_TB, Menu_Top_AI
If block menus are not defined for a particular block, the Field
Communicator uses a set of default menus to group the block
parameters and methods.
a) If there is just one menu in the MENU_ITEMS list, that menu is
chosen as the root menu.
b) If there are multiple menus in the MENU_ITEMS list, and one of
the menus in the list includes the string "Menu_Top" in its symbol
name, that menu is chosen as the root menu.
c) If there are multiple menus in the MENU_ITEMS list, but no
menu's name includes "Menu_Top", all the menus in the list are
combined to create a single root menu.
d) If the DD does not declare any MENU_ITEMS for a block, the
Field Communicator uses its own default menus to group the block
parameters.
Methods
Methods can be classified as device-level methods or block methods.
Device-level Methods
Block Methods
Block methods may be referenced in a block menu or in a device-
level menu using cross block references.
If a block has no DD menus defined and no menus containing
methods, the Field Communicator also groups DD methods in
separate submenus based on each method’s CLASS attribute as
defined in the DD. The submenu “Diagnostic Methods,” contains all
methods with the Class DIAGNOSTIC attribute. If no methods meet
this class criteria, the submenu “Diagnostic Methods” is not
displayed. Submenu, “Calibration Methods,” contains all methods
not listed in the “Diagnostic Methods” submenu, and has one or
more of the following class attributes: SERVICE, OPERATE,
ALARM, TUNE. If no methods meet this class criteria, the submenu
“Calibration Methods” is not displayed. If neither of these class
criteria is met, submenu “Methods” contains all of the block’s
methods.
Block Instantiation
The Field Communicator Fieldbus Application lets you
instantiate/delete function blocks and transducer blocks in devices
that support block instantiation. The Field Communicator Fieldbus
Application uses information contained in the device CFF file to
determine if there are instantiable block types in the device.
Help in DD
Customer feedback indicates that a robust Help implementation in
DD is very beneficial. The Field Communicator group recommends
device developers create Help for their DDs.
DD Restrictions
The following FOUNDATION fieldbus DDL constructs and variable
attributes are not supported in the Field Communicator:
• Edit Displays construct
• Programs construct
• Domains construct
• Response Codes construct
• Read/Write Timeout variable attributes
• Pre/Post Edit Actions variable attributes
• PreWrite Actions variable attribute
Testing Guidelines
Device developers are responsible for testing the device and device
description with the Field Communicator to ensure operational
integrity and quality.
When testing the DD with the Field Communicator, the device
developer should check every block. In each block, the device
developer must ensure:
• Menus (either the DD menus or the Field Communicator default
menus) are displayed correctly.
• Parameters in each menu are displayed correctly.
• Read/write access to a parameter is correct.
• Methods can be run correctly.
When testing a device with the Field Communicator, the device
developer should check the following:
• The device is correctly identified on the live list.
• The block list correctly shows all the blocks in the device.
• The block list correctly shows the actual modes of all the blocks.
• The Scheduling menu under the block list allows the Field
Communicator to successfully schedule the I/O blocks of the
device.
DD Registration
When the device developer is satisfied with the amount of Field
Communicator testing performed on the DD, the tested DD should
be registered with the Fieldbus Foundation. After the tested DD has
been registered, the device developer should sign the Field
Communicator FF Device Description Production Approval
Form (Facsimile Lead Sheet.pdf). This form is saved in the Field
Communicator FOUNDATION fieldbus Toolkit Install folder at
C:\Program Files\ Field Communicator FF Toolkit. The Production
Approval Form indicates that the development and test process
associated with DD files has been successfully completed and the
DD is ready for release to a production environment.
Only after the signed Field Communicator FF Device Description
Production Approval Form has been received by Emerson Process
Management is the DD integrated into the next Field Communicator
release as “Tested.” If the DD is not marked as “Tested,” whenever it
is accessed during run time, the Field Communicator displays the
warning message:
“This Device Description may not have been tested with this version
of Field Communicator software. Do you want to proceed with this
DD anyway?”