FLOW Technology microLinK Implementation Manual
microLinK
Temperature Compensating Linearizing Pickoff
CANbus Implementation Manual
TM-100823, Rev A
TM-100823, Rev A
microLinK CANbus Implementation Manual
Page 2
Thank you for selecting a Flow Technology, Inc. product for your flow measurement
application.
Virtually every major commercial, government, and scientific organization is making use of our
products, expertise and extensive technical support. This is a culmination of years of
refinement in our flow meter and calibrator designs, which has resulted in the technological
leadership in the flow measurements field that we enjoy.
We are proud of our quality products, our courteous service and welcome you, as a valued
customer, to our growing family.
Flow Technology Inc.
8930 South Beck Ave
Suite #107
Tempe, AZ 85284
Tel: +1 480 240 3400
Fax: +1 480 240 3401
www.ftimeters.com
SF-100828 Rev A
TM-100823, Rev A
microLinK CANbus Implementation Manual
Page 3
DATE
REVISION
ECO NUMBER
APPROVAL
11/12/2012
A
22345
J. BLASIUS
The specifications contained in this manual are subject to change
without notice and any user of these specifications should verify from
the manufacturer that the specifications are currently in effect.
Otherwise, the manufacturer assumes no responsibility for the use of
specifications, which have been changed, and are no longer in effect.
TM-100823 REVISIONS
PUBLISHED BY FLOW TECHNOLOGY, INC. – November 2012
SF-100828 Rev A
TM-100823, Rev A
microLinK CANbus Implementation Manual
Page 4
WARRANTY
Limited Warranty
Seller warrants that goods delivered hereunder will at delivery be free from defects in materials and workmanship
and will conform to seller's operating specifications. Seller makes no other warranties, express or implied, and
specifically makes NO WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
Limitation of Liability
Seller's obligation under the warranty shall be limited to replacing or repairing at Seller's option, the defective
goods within twelve (12) months from the date of shipment, or eighteen (18) months from the date of shipment
for destination outside of the United States, provided that Buyer gives Seller proper notice of any defect or failure
and satisfactory proof thereof. Defective goods must be returned to Seller's plant or to a designated Seller's
service center for inspection. Buyer will prepay all freight charges to return any products to Seller's plant, or other
facility designated by Seller. Seller will deliver replacements for defective goods to Buyer freight prepaid. The
warranty on said replacements shall be limited to the unexpired portion of the original warranty. Goods returned
to Seller for which Seller provides replacement under the above warranty shall become the property of the Seller.
The limited warranty does not apply to failures caused by mishandling or misapplication. Seller's warranty
obligations shall not apply to any goods that (a) are normally consumed in operation or (b) have a normal life
inherently shorter than the warranty period stated herein. In the event that goods are altered or repaired by the
Buyer without prior written approval by the Seller, all warranties are void. Equipment and accessories not
manufactured by Seller are warranted only to the extent of and by the original manufacturer's warranty. Repair or
replacement goods furnished pursuant to the above warranty shall remain under warranty only for the unexpired
portion of the original warranty period.
Should Seller fail to manufacture or deliver goods other than standard products appearing in Seller's catalog,
Seller's exclusive liability and Buyer's exclusive remedy shall be release of the Buyer from the obligation to pay
purchase price therefore.
THE FORGOING WARRANTIES ARE IN LIEU OF ALL OTHER WARRANTIES WHETHER ORAL, WRITTEN, EXPRESSED,
IMPLIED OR STATUTORY. IMPLIED WARRANTIES OF FITNESS AND MERCHANTABILITY SHALL NOT APPLY SELLER'S
WARRANTY OBLIGATIONS AND BUYER'S REMEDIES THEREUNDER (EXCEPT AS TO TITLE) ARE SOLELY AND
EXCLUSIVELY AS STATED HEREIN. IN NO CASE WILL SELLER BE LIABLE FOR SPECIAL, INCIDENTAL OR
CONSEQUENTIAL DAMAGE.
The total liability of Seller (including its subcontractors) on any claim whether in contract, tort (including
negligence whether sole or concurrent) or otherwise, arising out of or connected with, or resulting from the
manufacture, sales, delivery, resale, repair, replacement or use of any goods or the furnishing of any service
hereunder shall not exceed the price allocable to the product or service or part thereof which gives rise to the
claim.
SF-100828 Rev A
TM-100823, Rev A
microLinK CANbus Implementation Manual
Page 5
TABLE OF CONTENTS
1 INTRODUCTION ................................................................................................................... 7
1.1 Scope ............................................................................................................................. 7
1.2 Reference Documentation ............................................................................................ 7
2 INSTALLATION ..................................................................................................................... 8
2.1 Mechanical Installation of the microLinK pickoff to the flow meter ............................ 8
2.2 Electrical Installation ..................................................................................................... 8
3 CANOPEN INFORMATION ................................................................................................. 10
3.1 Device Profile .............................................................................................................. 10
3.2 Service Data Objects (SDO) Communication .............................................................. 10
3.3 Process Data Objects (PDO) Communication ............................................................. 10
3.4 Run Levels ................................................................................................................... 10
3.4.1 Changing run levels ............................................................................................... 12
3.5 Object Dictionary ........................................................................................................ 12
3.5.1 Object 0x1000 – Device Type ................................................................................ 12
3.5.2 Object 0x1001 – Error Register ............................................................................. 12
3.5.3 Object 0x1002 – Manufacturer Status Register ................................................... 13
3.5.4 Object 0x1003 – Pre-Defined Error Field .............................................................. 13
3.5.5 Object 0x1008 – Manufacturer Device Name ...................................................... 14
3.5.6 Object 0x1009 – Manufacturer Hardware Version .............................................. 14
3.5.7 Object 0x100A – Manufacturer Software Version................................................ 15
3.5.8 Object 0x1017 – Producer Heartbeat Time .......................................................... 15
3.5.9 Object 0x1018 – Identity Object ........................................................................... 15
3.5.10 Object 0x1800 – Transmit PDO Communication Parameter 1 ............................. 16
3.5.11 Object 0x1801 – Transmit PDO Communication Parameter 2 ............................. 17
3.5.12 Object 0x1A00 – TPDO Mapping Parameter 1 ..................................................... 18
3.5.13 Object 0x1A01 – TPDO Mapping Parameter 2 ..................................................... 18
3.5.14 Object 0x2010 – Flow Totals ................................................................................. 19
3.5.15 Object 0x2011 – Flow Rates .................................................................................. 20
3.5.16 Object 0x2012 – Raw Frequency .......................................................................... 20
3.5.17 Object 0x2013 – Live Temperature....................................................................... 20
3.5.18 Object 0x2021 – Flow Constants .......................................................................... 21
3.5.19 Object 0x2022 – Frequency Information .............................................................. 21
3.5.20 Object 0x2023 – Customer Information ............................................................... 23
3.5.21 Object 0x2024 – Model Numbers ......................................................................... 24
3.5.22 Object 0x2025 – Serial Numbers .......................................................................... 25
3.5.23 Object 0x2026 – Programming and Calibration Information ............................... 26
3.5.24 Object 0x2030 – Curve Data ................................................................................. 27
3.5.25 Object 0x2040 – Density Data .............................................................................. 27
3.5.26 Object 0x2041 – Viscosity Data ............................................................................ 29
3.5.27 Object 0x2042 – Fluids .......................................................................................... 31
3.5.28 Object 0x2050 – Density ....................................................................................... 32
SF-100828 Rev A
TM-100823, Rev A
microLinK CANbus Implementation Manual
Page 6
3.5.29 Object 0x2051 – Viscosity ..................................................................................... 32
3.5.30 Object 0x2052 – COE ............................................................................................ 32
3.5.31 Object 0x2053 – Temperature Correction ............................................................ 32
3.5.32 Object 0x2054 – Calibration Temperature ........................................................... 33
3.5.33 Object 0x2055 –Temperature Source ................................................................... 33
3.5.34 Object 0x2057 – Fault Temperature ..................................................................... 34
3.5.35 Object 0x2060 – Units ........................................................................................... 34
3.5.36 Object 0x20FF – Boot Load Entry .......................................................................... 36
3.5.37 Object 0x2106 – Power On Counter ..................................................................... 36
3.5.38 Object 0x2107 – Run Level.................................................................................... 36
3.5.39 Object 0x2108 – CANbus Active COM Parameters ............................................... 37
3.5.40 Object 0x2109 – CANbus Bootup COM Parameters ............................................. 37
APPENDIX A MODEL NUMBER BREAK DOWN ........................................................................... 39
LIST OF FIGURES
Figure 1 – MS Connector Pinout ..................................................................................................... 8
Figure 2 – Flying Leads Wire Designators ....................................................................................... 9
LIST OF TABLES
Table 1 - Run Level Write Permissions .......................................................................................... 11
Table 2 - Error Register Bits (from CiA 301) ................................................................................. 13
Table 3 – Product Codes ............................................................................................................... 15
SF-100828 Rev A
TM-100823, Rev A
microLinK CANbus Implementation Manual
Page 7
1 INTRODUCTION
1.1 Scope
This manual provides information and guidance for personnel responsible for using the
microLinK pickoff in a CANbus environment. For general purpose information regarding the
microLinK product, please consult Flow Technology manual TM-100736
1.2 Reference Documentation
This manual is not intended to be an all-inclusive CAN resource; it provides information
that is unique to the microLinK product. For more detailed information regarding CAN
communications and protocols, please consult the following documents.
CiA 102: CAN Physical Layer for Industrial Applications
CiA 301: CANopen Application layer and communication profile
CiA 303-1: CANopen Recommendation - Cabling and Connector Pin Assignment
CiA 306: CANopen Electronic data sheet specification
Additional Resources:
CAN in Automation (CiA) http://www.can-cia.org/
http://www.canopen.us/
SF-100828 Rev A
TM-100823, Rev A
microLinK CANbus Implementation Manual
Page 8
2 INSTALLATION
2.1 Mechanical Installation of the microLinK pickoff to the flow meter
The pickoff should bottom in the well of the flow meter housing but only be finger
tightened to approximately 4 lb-in (0.5 N-m) max to prevent distortion of the coil housing.
The pickoff is secured in position by tightening the lock nut to approximately 25 lb-in (2.8
N-m). The pickoff can be removed by loosening the hex lock nut and unscrewing the
pickoff from the housing.
2.2 Electrical Installation
This section provides the professional installer with information for connecting the
microLinK to the user's system.
WARNING:
Verify that the power is off before connecting or servicing!
The connecting cable between the pickoff and the electronic instrumentation should use
22-28 AWG conductors. Shielded and twisted pairs are recommended for CANbus
installations. The cable should not be installed in a conduit or tray containing power lines,
or close to strong electromagnetic sources such as electric lines, electric motors,
transformers, welding machines, or high voltage lines. These sources may induce
transient electrical noise in the coil and cause false readings.
Since the Linearized Frequency and the Raw Frequency outputs both output pulse signals,
these signals can couple or crosstalk between wires. It is recommended that these wires
not be run together for more than 10 feet to avoid problems with crosstalk. Since the
Raw frequency is primarily used for diagnostics, it is recommended that this wire not be
attached to the connector wiring except when diagnostics are needed.
The connector pinout is shown in below Figure 1. The connector on the pickoff is a
commercial equivalent of MS27478Y8E35P. For package options “-5” and “-6” (flying
leads) see Figure 2.
SF-100828 Rev A
Figure 1 – MS Connector Pinout
TM-100823, Rev A
microLinK CANbus Implementation Manual
Page 9
Figure 2 – Flying Leads Wire Designators
SF-100828 Rev A
TM-100823, Rev A
microLinK CANbus Implementation Manual
Page 10
3 CANOPEN INFORMATION
3.1 Device Profile
The microLinK product follows the basic device profile specified in CiA 301. Additional
objects unique to the product are discussed in section 3.5. All objects are listed in EDS file
82-100951-xx.eds, where xx is the major revision number listed in object 0x1018sub3. For
example, if the major revision number is 1, then xx will be 01. Be sure that the EDS file
matches the microLinK revision.
3.2 Service Data Objects (SDO) Communication
Communication via Service Data Objects provides access to the objects listed in the
device dictionary. All of the objects listed may be queried and will respond with the data
stored in the object. Some of these objects are read only, some are read/write, and some
will respond as read only until the proper password is written to the Bootloader Object
(0x20FF), then are read/write.
The microLinK pickoff meets the requirements of the CANopen CiA 301 Application layer
and communication profile specification for SDOs. Please refer to this document for more
information on Service Data Objects.
3.3 Process Data Objects (PDO) Communication
Real time data transfer is provided via Process Data Objects. PDOs provide a lower
overhead communication method. The microLinK pickoff provides two PDO
transmissions, each of which contains two operating parameters. The first PDO provides
the volume rate and mass rate data. The second PDO provides raw frequency and
temperature data. The microLinK pickoff only supports timer-driven asynchronous
transmit PDOs.
The microLinK pickoff meets the requirements of the CANopen CiA 301 Application layer
and communication profile specification for PDOs. Please refer to this document for more
information on Process Data Objects.
3.4 Run Levels
The microLinK uses three run levels to protect data from accidental modification. SDO
data is readable at any run level, but may only be written if the current run level supports
writing for that object. The run level privileges are incremental, i.e. any object that is
writable at run level 1 is also writable at run level 2.
The run level scheme is intended to prevent accidental modification to SDO data. It is not
intended as a security scheme to prevent malicious changes to the SDO data.
Run level 0 is the default run level. The microLinK is set on power up or reset to this run
level. This run level protects most objects from accidental writing.
Run level 1 is user level. Certain objects that may need to be changed during operation
can be written to at this run level.
SF-100828 Rev A
TM-100823, Rev A
microLinK CANbus Implementation Manual
Page 11
Description
Index
Run Level
0 1 2
Customer Name
0x2023sub1
X X X
Job Number
0x2023sub2
X X X
PO Number
0x2023sub3
X X X
Meter Model Number
0x2024sub1
X X X
Meter Tag Number
0x2024sub2
X X X
Electronic Model Number
0x2024sub3
X X X
Electronic Tag Number
0x2024sub4
X X X
Bootloader Object
0x20FF
X X X
Producer Heartbeat Time
0x2017
X X
PDO Inhibit Times
0x1800sub3,
0x1801sub3
X X
PDO Event Timers
0x1800sub5,
0x1801sub5
X X
Totalizers
0x2010sub1-4
X X
Frequency Information
Low Frequency Cutoff
Frequency Averaging Factor
Scaling Data
Volumetric or Mass Flow
Averaging Limit
0x2022sub1
0x2022sub4
0x2022sub5-8
0x2022sub9
0x2022subA
X X
Active Fluid
0x2042sub1
X X
Fluid Names
0x2042sub2-4
X X
Temperature Correction
0x2053
X X
External Temperature Control
0x2055
X X
Baud Rate
0x2109sub2
X X
Node ID
0x2109sub1
X X
Timebase
0x2021sub2
X
Meter Overspeed Frequency
0x2022sub2
X
Meter Serial Number
0x2025sub1
X
Electronic Serial Number
0x2025sub2
X
Programming Date
0x2026sub1
X
Technician Name
0x2026sub2
X
Calibration Curve Data (f/ curve)
0x2030
X
Fluid Viscosity Data
0x2041
X
Fluid Density Data
0x2040
X
COE
0x2052
X
Run level 2 is the pickoff configuration level. Objects such as calibration data that will not
be changed during normal operation are only writable at this run level.
Table 1 - Run Level Write Permissions
SF-100828 Rev A
TM-100823, Rev A
microLinK CANbus Implementation Manual
Page 12
Description
Index
Run Level
0 1 2
Calibration Temperature
0x2054
X
Fault Temperature
0x2057
X
Data Units
0x2060
X
Index
0x1000
Object Name
Device Type
Data Type
UNSIGNED32
Access Type
RO | RO | RO
3.4.1 Changing run levels
The run level is changed by writing a password to object 0x20FF. The run level change is
persistent until another password is written to object 0x20FF or until the pickoff is reset.
Object 0x20FF is used for other functions such as putting the pickoff into bootloader
mode. This object is used for some factory-only functions and writing values other than
the specified passwords may cause erroneous operation of the pickoff.
Run Level 0 password = 0x0FF
Run Level 1 password = 0xC5EF
Run Level 2 password = 0xACC355
3.5 Object Dictionary
This section lists objects available for configuration and operation of the microLinK
pickoff. The read-write status for each object is shown as three choices. These choices are
listed in the following order run level 0 | run level 1 | run level 2. For example the
Producer Heartbeat Time in object 0x1017 shows RO | RW | RW for the Access
Type. This means that run level 0 has read-only permissions while run levels 1 and 2 have
read-write permissions.
3.5.1 Object 0x1000 – Device Type
This object specifies the device profile in effect for the unit. The microLinK pickoff does
not follow a standardized device profile and therefore is zero.
3.5.2 Object 0x1001 – Error Register
This object holds the errors for the device. The following error bits are supported by the
microLinK pickoff.
SF-100828 Rev A
Loading...