477
A-96.250.861 / 160718 HART Interface Description

HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

  • Upload
    others

  • View
    4

  • Download
    0

Embed Size (px)

Citation preview

Page 1: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

A-96.250.861 / 160718

HART

Interface Description

Page 2: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

Customer Support

SWAN and its representatives maintain a fully trained staff of technical specialists around the world. For any technical question, contact your nearest SWAN representative, or the manufacturer: SWAN ANALYTISCHE INSTRUMENTE AG Studbachstrasse 13 8340 Hinwil Switzerland Internet: www.swan.ch E-mail: [email protected]

Document Status

Title HART Interface Description

ID: A-96.250.861

Revision Issue

00 July 2016 First edition

01 August 2016 Added AMI Codes-II, AMI Deltacon and AMI Sodium

02 September 2016 Added AMI Oxysafe, AMI pH/mV:pH/mV, AMI Silica and AMI Solicon4

03 October 2016 Added AMI Inducon, AMI LineTOC and AMI Turbi

04 November 2016 Added chapter “Introduction”

05 January 2017 Added AMI CACE, AMI Hydrogen, AMI Pharmacon and AMI Rescon

06 October 2017 Added AMI Phosphate HL

07 January 2018 Added AMI Codes-II CC, AMI Codes-II O3 and AMI SAC254

© 2018 SWAN ANALYTISCHE INSTRUMENTE AG, Switzerland, all rights reserved

Subject to change without notice

Page 3: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

HART Interface Description

A-96.250.861 / 160718

Table of Contents

Click on the links below:

Introduction

AMI CACE

AMI Codes-II

AMI Codes-II CC

AMI Codes-II O3

AMI Deltacon

AMI Hydrogen

AMI Inducon

AMI LineTOC

AMI Oxysafe

AMI Oxytrace

AMI Pharmacon

AMI pH/mV:pH/mV

AMI Phosphate HL

AMI pH-Redox

AMI Powercon

AMI Rescon

AMI SAC254

AMI Silica

AMI Silitrace

AMI Silitrace Ultra

AMI Sodium

AMI Solicon4

AMI Trides

AMI Turbi

Page 4: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

HART Interface Description

A-96.250.861 / 160718

Introduction

The HART communication option for AMI transmitters supports HART Protocol Revision 7.5.

Requirements

- Mainboard AMI V2.5 or higher - HART interface PCB installed on the mainboard - Firmware V6.20 or higher

DD file

The manufacturer-specific DD file is available for download at http://www.swan.ch.

In some cases, a DD file is used by several instruments. The instruments concerned and the corresponding chapters are listed in the table below.

Instruments using the same DD file See chapter

AMI Deltacon DG and AMI Deltacon Power AMI Deltacon

AMI Sodium A and AMI Sodium P AMI Sodium

AMI Turbiwell, AMI Turbitrack, AMI Turbitrace AMI Turbi

AMI pH/mV:pH/mV and AMI pH/mV:pH/mV Pool AMI pH/mV:pH/mV

Page 5: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments

HART® 7.x Field Device Specification for AMI CACE Transmitters

SWAN Analytical Instruments 8340, Studbachstrasse 13

Hinwil Switzerland

Page 6: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI CACE HART Manual

109560.00/ 180518 2

TABLE OF CONTENTS

1. Introduction ..................................................................................................................................... 4

1.1 Scope ................................................................................................................................... 4

1.2 Purpose ................................................................................................................................ 4

1.3 Who should use this document? ......................................................................................... 4

1.4 References ........................................................................................................................... 4

2. Device Identification ....................................................................................................................... 5

3. Product Overview ........................................................................................................................... 5

3.1 Connections ......................................................................................................................... 5

3.1.1 Point to point Mode ............................................................................................. 5

3.1.2 Multidrop Mode ................................................................................................... 6

3.1.3 HARTREC Board ................................................................................................ 6

4. Product Interfaces............................................................................................................................ 7

4.1 Process Interface ................................................................................................................. 7

4.1.1 Sensor Input Channels ......................................................................................... 7

4.2 Host Interface ...................................................................................................................... 7

4.2.1 Process Specific Conductivity ............................................................................. 7

4.3 Local Interfaces ................................................................................................................... 7

4.3.1 Local Controls and Displays ................................................................................ 7

4.3.2 Write Protection ................................................................................................... 7

5. Device Variables ............................................................................................................................. 8

5.1 Device Variable 0 Specific Conductivity (sc) ..................................................................... 8

5.2 Device Variable 1 Cation Conductivity (cc) ....................................................................... 8

5.3 Device Variable 2 Degassed Conductivity (dc) .................................................................. 8

5.4 Device Variable 3 First Temperature .................................................................................. 8

5.5 Device Variable 4 Second Temperature ............................................................................. 8

5.6 Device Variable 5 Third Temperature ................................................................................ 9

5.7 Device Variable 6 Conductivity Difference ........................................................................ 9

5.8 Device Variable 7 Main Flow ............................................................................................. 9

5.9 Device Variable 8 First Calculated Value (pH) .................................................................. 9

5.10 Device Variable 9 Second Calculated Value (Ammonium) ............................................... 9

5.11 Device Variable 10 Case Temperature ............................................................................... 9

Page 7: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI CACE HART Manual

109560.00/ 180518 3

6. Dynamic Variables ...........................................................................................................................9

6.1 Mappable Variables .............................................................................................................9

6.2 PV Transfer Functions .......................................................................................................10

7. Status Information ..........................................................................................................................11

7.1 Field Device Status ............................................................................................................11

7.2 Extended Device Status .....................................................................................................11

7.3 Additional Device Status (Command #48) ........................................................................12

8. Universal Commands .....................................................................................................................14

9. Common-Practice Commands .......................................................................................................16

9.1 Supported Common Practice Commands ..........................................................................16

9.2 Burst Mode .........................................................................................................................16

9.3 Catch Device Variable .......................................................................................................16

10. Device-Specific Commands ...........................................................................................................16

11. Tables 17

11.1 Engineering Type Unit Codes ............................................................................................17

11.2 Classification Type Unit Codes .........................................................................................17

12. Performance ...................................................................................................................................18

12.1 Sampling Rates ..................................................................................................................18

12.2 Power-Up ...........................................................................................................................18

12.3 Command Response Times................................................................................................18

12.4 Long Messages ...................................................................................................................18

12.5 Non-Volatile Memory ........................................................................................................18

12.6 Modes .................................................................................................................................18

12.7 Write Protection .................................................................................................................18

12.8 Damping .............................................................................................................................18

Annex A. Capability Checklist ...........................................................................................................19

Annex B. Default Configuration ........................................................................................................20

Annex C. Revision History ................................................................................................................21

Page 8: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI CACE HART Manual

109560.00/ 180518 4

1. INTRODUCTION 1.1 Scope The SWAN Analytical Instruments model AMI CACE transmitter complies with HART Protocol Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering Unit Codes supported). The functionality of this Field Device is described sufficiently to allow its proper application in a process and its complete support in HART capable Host Applications.

1.2 Purpose This specification is designed to complement the AMI CACE manual by providing a complete description of this Field Device from a HART Communication perspective.

1.3 Who should use this document? The specification is designed to be a technical reference for HART capable Host Application Developers, System Integrators and knowledgeable End Users. It also provides functional specifications (e.g., commands and performance requirements) used during development, maintenance and testing. This document assumes the reader is familiar with HART Protocol requirements and terminology.

1.4 References HART Smart Communications Protocol Specification. HCF_SPEC-12. Available from the HCF.

MenAMI_CACE_xx.pdf. Available from the SWAN Analytical Instruments web page.

Page 9: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI CACE HART Manual

109560.00/ 180518 5

2. DEVICE IDENTIFICATION Manufacturer Name: SWAN Analytical

Instruments Model Name(s): AMI CACE

Manufacture ID Code: 24757 (60B5 Hex)

Device Type Code:

58246 (E386 Hex)

HART Protocol Revision 7.5 Device Revision: 1

Number of Device Variables 11

Physical Layers Supported FSK

Physical Device Category Transmitter, Non-DC-isolated Bus Device

3. PRODUCT OVERVIEW The AMI CACE HART communication option board provides a 4 to 20mA output signal and can be monitored and configured using a HART master device or a hand-held communicator.

3.1 Connections 3.1.1 Point to point Mode

An external minimum 250 Ω (maximum 800 Ω) resistor is needed in order to communicate with HART protocol.

Page 10: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI CACE HART Manual

109560.00/ 180518 6

3.1.2 Multidrop Mode

A single minimum 250 Ω resistor (maximum 800 Ω) is needed to communicate with all the instruments connected to the bus, and each of them must provide 4mA.

3.1.3 HARTREC Board

The HARTREC Board must be installed in the AMI transmitter in order to communicate with HART.

Page 11: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI CACE HART Manual

109560.00/ 180518 7

4. PRODUCT INTERFACES 4.1 Process Interface 4.1.1 Sensor Input Channels Refer to AMI CACE manual to details on mounting Conductivity and Flow sensors.

4.2 Host Interface 4.2.1 Process Specific Conductivity The 4 to 20mA output of the AMI CACE HART option board represents a process value measurement, scaled according to the configured range of the instrument. This output corresponds to the Primary Variable. HART Communication is supported on this loop.

Since Dynamic Variables are mappable, PV can correspond to one of the following variables:

- Specific Conductivity (sc)

- Cation Conductivity (cc)

- Degassed Conductivity (dc)

- First Temperature

- Second Temperature

- Third Temperature

- Conductivity difference

- Main Flow

- First Calculated Value (pH)

- Second Calculated Value (Ammonium)

It is also possible to set the PV from the instrument local display, in the “Signal Output 3 / Parameter” settings.

4.3 Local Interfaces 4.3.1 Local Controls and Displays This device has a local display that allows the complete configurability of the instrument.

Refer to AMI CACE manual to details on it.

4.3.2 Write Protection The Field Device has no “Write protection mode”.

Page 12: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI CACE HART Manual

109560.00/ 180518 8

5. DEVICE VARIABLES This Field Device exposes 11 Device Variables.

Device Variables Variables Meaning Units 0 Specific Conductivity (sc) uS/cm

1 Cation Conductivity (cc) uS/cm

2 Degassed Conductivity (dc) uS/cm

3 First Temperature °C

4 Second Temperature °C

5 Third Temperature °C

6 Conductivity Difference uS/cm

7 Main Flow l/h

8 First Calculated Value (pH) pH

9 Second Calculated Value (Ammonium) ppm

10 Case Temperature °C

5.1 Device Variable 0 Specific Conductivity (sc) Specific Conductivity is read by Specific Conductivity - 1st Temperature sensors (Refer to AMI CACE manual to details on it).

5.2 Device Variable 1 Cation Conductivity (cc) Cation Conductivity is read by Cation Conductivity - 2nd Temperature sensors (Refer to AMI CACE manual to details on it).

5.3 Device Variable 2 Degassed Conductivity (dc) Degassed Conductivity is read by Degassed Conductivity - 3rd Temperature sensors (Refer to AMI CACE manual to details on it).

5.4 Device Variable 3 First Temperature First Temperature is read by Specific Conductivity - 1st Temperature sensors (Refer to AMI CACE manual to details on it).

5.5 Device Variable 4 Second Temperature Second Temperature is read by Cation Conductivity - 2nd Temperature sensors (Refer to AMI CACE manual to details on it).

Page 13: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI CACE HART Manual

109560.00/ 180518 9

5.6 Device Variable 5 Third Temperature Third Temperature is read by Degassed Conductivity - 3rd Temperature sensors (Refer to AMI CACE manual to details on it).

5.7 Device Variable 6 Conductivity Difference Conductivity Difference is calculated starting from Specific and Cation Conductivity sensor (Refer to AMI CACE manual to details on it).

5.8 Device Variable 7 Main Flow Main Flow is read by the flow rate sensor (Refer to AMI CACE manual to details on it).

5.9 Device Variable 8 First Calculated Value (pH) pH is calculated starting from Specific Conductivity-1st Temperature and Cation Conductivity - 2nd Temperature sensors (Refer to AMI CACE manual to details on it).

5.10 Device Variable 9 Second Calculated Value (Ammonium) Ammonium is calculated starting from Specific Conductivity - 1st Temperature and Cation Conductivity - 2nd Temperature sensors (Refer to AMI CACE manual to details on it).

5.11 Device Variable 10 Case Temperature Case Temperature shows the Temperature read inside the Electronic Box.

6. DYNAMIC VARIABLES 6.1 Mappable Variables Four mappable Dynamic Variables are implemented.

Dynamic Variables Variables Meaning Units

PV

Spec. Cond. – Cat. Cond. – Deg. Cond. – 1st Temp – 2nd Temp – 3rd Temp – Cond. Diff. –

Main Flow – pH – Ammonium

uS/cm - uS/cm - uS/cm -°C –°C –°C – uS/cm - l/h – pH

– ppm

SV

Spec. Cond. – Cat. Cond. – Deg. Cond. – 1st Temp – 2nd Temp – 3rd Temp – Cond. Diff. – Main Flow – pH – Ammonium

uS/cm - uS/cm - uS/cm -°C –°C –°C – uS/cm - l/h – pH – ppm

TV

Spec. Cond. – Cat. Cond. – Deg. Cond. – 1st Temp – 2nd Temp – 3rd Temp – Cond. Diff. – Main Flow – pH – Ammonium

uS/cm - uS/cm - uS/cm -°C –°C –°C – uS/cm - l/h – pH – ppm

QV

Spec. Cond. – Cat. Cond. – Deg. Cond. – 1st Temp – 2nd Temp – 3rd Temp – Cond. Diff. – Main Flow – pH – Ammonium

uS/cm - uS/cm - uS/cm -°C –°C –°C – uS/cm - l/h – pH – ppm

Page 14: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI CACE HART Manual

109560.00/ 180518 10

It is possible to associate any of these dynamic variables to PV, SV, TV or QV with a HART Master (or Handheld Communicator).

The PV is also settable from the instrument local display’s settings.

6.2 PV Transfer Functions The Primary Variable Transfer Function can be read with command 15. Its meaning is referred to the following table.

Transfer Function Type Code

Linear 240

Bilinear 241

Logarithmic 242

Control Upwards 243

Control Downwards 244

Page 15: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI CACE HART Manual

109560.00/ 180518 11

7. STATUS INFORMATION 7.1 Field Device Status The functions of the Field Device Status bits are specified in HCF_SPEC-99. Further details of their implementation are described in the following table.

Bit Name Notes

7 Device Malfunction Set on any detected Hardware Error

6 Configuration Changed Set if any changes are made to Field Device Configuration

5 Cold Start Set when powered-up or after a device reset

4 More Status Available Set if any Alarm or Maintenance has changed its status. More information is available via cmd 48

3 Loop Current Fixed The Loop Current is being held at a fixed value and is not responding to process variations

2 Loop Current Saturated The Loop Current has reached its upper (or lower) endpoint limit and cannot increase (or decrease) any further

1 Non-PV Out of Limits A Device Variable not mapped to the PV is beyond its

operating limits

0 PV Out of Limits The PV is beyond its operating limit

7.2 Extended Device Status Contains additional information regarding the status of the Field Device.

Bit Name Notes

2 Critical Power Failure Set when battery is becoming critically low (less than 15 min) and Field Device not connected to Power Supply

1 Device Variable Alert

Set when one or more Device Variables are in one of the following conditions:

• Hi/low limited (Limit Status)

• Bad (Process Data Status)

• Poor Accuracy (Process Data Status)

0 Maintenance Required Not Used

Page 16: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI CACE HART Manual

109560.00/ 180518 12

7.3 Additional Device Status (Command #48) Command #48 returns 10 additional bytes of data (Int32 or Int16 Little Endian), with the following status information:

(ALARMS-MAINTENANCE CODES)

Byte Bit Meaning Code

0-3 (INT32)

0 Cond. 1 Alarm high E001 1 Cond. 1 Alarm low E002 2 Cond. 2 Alarm high E003 3 Cond. 2 Alarm low E004 4 Cond. 3 Alarm high E005 5 Cond. 3 Alarm low E006 6 Temp. 1 high E007 7 Temp. 1 low E008 8 Sample Flow high E009 9 Sample Flow low E010 10 Temp.1 shorted E011 11 Temp.1 disconnected E012 12 Case Temp. high E013 13 Case Temp. low E014 14 pH Calculation undef E015 15 Degasser Frontend E016 16 Control Timeout E017 17 Degasser disconnected E018 18 Temp.2 shorted E019 19 Temp.2 disconnected E020 20 Temp.3 shorted E021 21 Temp.3 disconnected E022 22 Degasser Ctl Timeout E023 23 Input active E024 24 IC MK41T56 E025 25 IC LM75 E026 26 IC PCF8574 E027 27 Signal output open E028 28 Calibration Degasser E029 29 EEProm Frontend E030 30 Calibration Recout E031 31 Wrong Frontend E032

Page 17: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI CACE HART Manual

109560.00/ 180518 13

4-5 (INT16)

0 EDI module exhausted E065

1 Reserved 2 Reserved 3 Reserved 4 Reserved 5 Reserved 6 Reserved 7 Reserved 8 Reserved 9 Reserved 10 Reserved 11 Reserved 12 Reserved 13 Reserved 14 Reserved 15 Reserved

14-17 (INT32)

0 pH Alarm high E033 1 pH Alarm low E034 2 Alk. Alarm high E035 3 Alk. Alarm low E036 4 Temp. 2 high E037 5 Temp. 2 low E038 6 Temp. 3 high E039 7 Temp. 3 low E040 8 Degasser Line Voltage E041 9 Degasser Temp. Shorted E042 10 EDI out of range E043 11 No Sample Flow E044 12 EDI DAC disconnected E045 13 EDI ADC disconnected E046 14 EDI Module Worn-Out E047 15 Reserved

16-31 Reserved "Reserved" bits are always set to 0.

All bits used in these bytes indicate device/sensor failure or maintenances, and always set bit 4 of the Device Status byte.

Page 18: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI CACE HART Manual

109560.00/ 180518 14

8. UNIVERSAL COMMANDS Number Name Notes

0 Read Unique Identifier Returns identity information of the Field Device

1 Read Primary Variable Returns PV value and its unit

2 Read Loop Current and Percent of Range Returns AO value and % range

3 Read Dynamic Variables and Loop Current Returns PV, SV, TV and QV values and corresponding unit values along with AO value

6 Write Polling Address Changes Field Device’s polling address and loop current mode

7 Read Loop Configuration Returns polling address and loop current mode status

8 Read Dynamic Variable Classifications Returns dynamic variables classification

9 Read Device Variables with Status Returns device variables with status

11 Read Unique Identifier Associated With Tag Same response as command 0 when Tag matches

12 Read Message Returns 24 bytes of packed ASCII data

13 Read Tag, Descriptor, Date Returns tag, descriptor (packed ASCII format) and date from the device

14 Read Primary Variable Transducer Information Returns PV transducer limits and span

15 Read Device Information Returns PV unit value, LRV, URV, damping value and write protect code

16 Read Final Assembly Number Returns final assembly number

17 Write Message Write 24 bytes of packed ASCII data.

18 Write Tag, Descriptor, Date Writes tag, descriptor (packed ASCII format) and date to the device

19 Write Final Assembly Number Writes final assembly number

Page 19: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI CACE HART Manual

109560.00/ 180518 15

to the device

20 Read Long Tag Returns 32-byte Long Tag

21 Read Unique Identifier Associated with Long Tag Same response as command 0 when Long Tag matches

22 Write Long Tag Writes Long Tag to the Field Device

38 Reset Configuration Changed Flag Resets the configuration change flag

48 Read Additional Device Status See 7.3 for details

Page 20: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI CACE HART Manual

109560.00/ 180518 16

9. COMMON-PRACTICE COMMANDS

9.1 Supported Common Practice Commands

9.2 Burst Mode This Field Device does not support Burst Mode.

9.3 Catch Device Variable This Field Device does not support Catch Device Variable.

10. DEVICE-SPECIFIC COMMANDS This Field Device does not support Device Specific Commands.

Number Name Notes

33 Read Device Variables Returns all the Supported Device Variables

50 Read Dynamic Variable Assignment Returns the Variable Numbers associated with PV, SV,TV and QV

51 Write Dynamic Variable Assignment Writes the Variable Numbers associated with PV, SV,TV and QV

Page 21: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI CACE HART Manual

109560.00/ 180518 17

11. TABLES 11.1 Engineering Type Unit Codes

Units of Measurement Unit Code Temperature Degrees Celsius 32 Electric Potential millivolts 36 Electric Resistance Ω 37 Miscellaneous Hertz 38 Electric Current milliamperes 39 Time Minutes 50 Time Seconds 51 Time Hours 52 Time Days 53 Miscellaneous Percent 57 Electric Potential Volts 58 Miscellaneous pH 59 Miscellaneous Micro Siemens per centimeter 67 Flow Liters per hour 138 Concentration Parts per million 139 Electric Resistance kΩ 163 Concentration Parts per billion 169 Not used 250 Special 253

11.2 Classification Type Unit Codes Measurement Meas. Code Temperature 64 Volumetric flow 66 Time 70 Frequency 80 Analytical 81 Electric Potential 83 Current 84 Resistance 85 Conductance 87 Concentration 90 Turbidity 97 Not used 250 Special 253

Page 22: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI CACE HART Manual

109560.00/ 180518 18

12. PERFORMANCE 12.1 Sampling Rates Typical sampling rates are shown in the following table.

Conductivity (Specific, Cation and Degassed) sensor value sample 1 per second

Temperature (1st, 2nd and 3rd ) sensors value sample 1 per second

Flow rate sensor value sample 1 per second

Case Temperature sensor sample 1 per second

Note: all the Device Variables use an Infinite Impulse Response Filter, with coefficients depending on the measured variable. The Damping Value is different for each of the Device Variables, and can be read through Command 15.

12.2 Power-Up On power up, the transmitter takes approximately 10 seconds to be ready. During this period, the device will not respond to HART commands.

12.3 Command Response Times

Minimum 2ms

Typical 5ms

Maximum 150ms

12.4 Long Messages The largest data field used is in the response to Command 9: up to 71 bytes including the two status bytes.

12.5 Non-Volatile Memory EEPROM is used to hold the device’s configuration parameters. New data is written to this memory immediately on execution of a write command, before the consequent response.

12.6 Modes Loop current mode can be disabled or enabled using command 6.

12.7 Write Protection Write-protection is not selectable, and is always set as “not write protected”.

12.8 Damping Damping time is calculated for each dynamic variable.

Page 23: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI CACE HART Manual

109560.00/ 180518 19

ANNEX A. CAPABILITY CHECKLIST

Manufacturer, model and revision SWAN Analytic Instruments, AMI CACE rev. 1

Device type Transmitter

HART revision 7.x

Device Description available Yes

Number and type of sensors 8 (seven external, one internal)

Number and type of actuators 0

Number and type of host side signals 1: 4 - 20mA analog

Number of Device Variables 11

Number of Dynamic Variables 4

Mappable Dynamic Variables? Yes

Number of common-practice commands 3

Number of device-specific commands 0

Bits of additional device status 80

Alternative operating modes? No

Burst mode? No

Write-protection? No

Page 24: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI CACE HART Manual

109560.00/ 180518 20

ANNEX B. DEFAULT CONFIGURATION

Parameter Default value

PV Sensor Type Specific Conductivity

Lower Range Value 0 uS/cm

Upper Range Value 3000 uS/cm

PV Units uS/cm

Damping time constant 3.184 seconds

Fault-indication jumper Not used

Write-protect jumper Not used

Number of response preambles 5

Page 25: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI CACE HART Manual

109560.00/ 180518 21

ANNEX C. REVISION HISTORY

Document Title HART Interface Description AMI CACE

Document ID 109560.00

Document Revision

Date Device Revision DD Revision Description

1.0 26/10/2016 1 1 First release, for HART 7.x Device

2.0 18/05/2018 1 2 E047 added

Page 26: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments

HART® 7.x Field Device Specification for AMI Codes-II Transmitters

SWAN Analytical Instruments 8340, Studbachstrasse 13

Hinwil Switzerland

Page 27: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II HART Manual

109351.00 / 270616 2

TABLE OF CONTENTS

1. Introduction ......................................................................................................................................4

1.1 Scope ....................................................................................................................................4

1.2 Purpose .................................................................................................................................4

1.3 Who should use this document? ..........................................................................................4

1.4 References ............................................................................................................................4

2. Device Identification ........................................................................................................................5

3. Product Overview ............................................................................................................................5

3.1 Connections..........................................................................................................................5

3.1.1 Point to point Mode ..............................................................................................5

3.1.2 Multidrop Mode ....................................................................................................6

3.1.3 HARTREC Board .................................................................................................6

4. Product Interfaces ............................................................................................................................7

4.1 Process Interface ..................................................................................................................7

4.1.1 Sensor Input Channels ..........................................................................................7

4.2 Host Interface .......................................................................................................................7

4.2.1 Process Free residual chlorine ...............................................................................7

4.3 Local Interfaces ....................................................................................................................7

4.3.1 Local Controls and Displays .................................................................................7

4.3.2 Write Protection ....................................................................................................7

5. Device Variables ..............................................................................................................................8

5.1 Device Variable 0 Disinfectant ............................................................................................8

5.2 Device Variable 1 pH ...........................................................................................................8

5.3 Device Variable 2 Main Temperature ..................................................................................8

5.4 Device Variable 3 Flow Rate ...............................................................................................8

5.5 Device Variable 4 Case Temperature ..................................................................................8

6. Dynamic Variables ...........................................................................................................................8

6.1 Mappable Variables .............................................................................................................8

6.2 PV Transfer Functions .........................................................................................................9

7. Status Information ............................................................................................................................9

Page 28: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II HART Manual

109351.00 / 270616 3

7.1 Field Device Status ..............................................................................................................9

7.2 Extended Device Status .....................................................................................................10

7.3 Additional Device Status (Command #48) ........................................................................11

8. Universal Commands .....................................................................................................................12

9. Common-Practice Commands .......................................................................................................14

9.1 Supported Common Practice Commands ..........................................................................14

9.2 Burst Mode .........................................................................................................................14

9.3 Catch Device Variable .......................................................................................................14

10. Device-Specific Commands ...........................................................................................................14

11. Tables 15

11.1 Engineering Type Unit Codes ............................................................................................15

11.2 Classification Unit Codes ..................................................................................................15

12. Performance ...................................................................................................................................16

12.1 Sampling Rates ..................................................................................................................16

12.2 Power-Up ...........................................................................................................................16

12.3 Command Response Times................................................................................................16

12.4 Long Messages ...................................................................................................................16

12.5 Non-Volatile Memory ........................................................................................................16

12.6 Modes .................................................................................................................................16

12.7 Write Protection .................................................................................................................16

12.8 Damping .............................................................................................................................16

13. Capability Checklist .......................................................................................................................17

Annex A. Default Configuration ........................................................................................................18

Annex B. Revision History ................................................................................................................19

Page 29: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II HART Manual

109351.00 / 270616 4

1. INTRODUCTION 1.1 Scope The SWAN Analytical Instruments model AMI Codes-II transmitter complies with HART Protocol Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering Unit Codes supported). The functionality of this Field Device is described sufficiently to allow its proper application in a process and its complete support in HART capable Host Applications.

1.2 Purpose This specification is designed to complement the AMI Codes-II manual by providing a complete description of this Field Device from a HART Communication perspective.

1.3 Who should use this document? The specification is designed to be a technical reference for HART capable Host Application Developers, System Integrators and knowledgeable End Users. It also provides functional specifications (e.g., commands and performance requirements) used during development, maintenance and testing. This document assumes the reader is familiar with HART Protocol requirements and terminology.

1.4 References HART Smart Communications Protocol Specification. HCF_SPEC-12. Available from the HCF.

MenAMI_Codes-II_xx.pdf. Available from the SWAN Analytical Instruments web page.

Page 30: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II HART Manual

109351.00 / 270616 5

2. DEVICE IDENTIFICATION Manufacturer Name: SWAN Analytical

Instruments Model Name(s): AMI Codes-II

Manufacture ID Code: 24757 (60B5 Hex)

Device Type Code:

58177 (E341 Hex)

HART Protocol Revision 7.5 Device Revision: 1

Number of Device Variables 5

Physical Layers Supported FSK

Physical Device Category Transmitter, Non-DC-isolated Bus Device

3. PRODUCT OVERVIEW The AMI Codes-II HART communication option board provides a 4 to 20mA output signal and can be monitored and configured using a HART master device or a hand-held communicator.

3.1 Connections 3.1.1 Point to point Mode

An external minimum 250 Ω (maximum 800 Ω) resistor is needed in order to communicate with HART protocol.

Page 31: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II HART Manual

109351.00 / 270616 6

3.1.2 Multidrop Mode

A single minimum 250 Ω resistor (maximum 800 Ω) is needed to communicate with all the instruments connected to the bus, and each of them must provide 4mA.

3.1.3 HARTREC Board

The HARTREC Board must be installed in the AMI transmitter in order to communicate with HART.

Page 32: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II HART Manual

109351.00 / 270616 7

4. PRODUCT INTERFACES 4.1 Process Interface 4.1.1 Sensor Input Channels Refer to AMI Codes-II manual to details on mounting external sensors.

4.2 Host Interface 4.2.1 Process Free residual chlorine The 4 to 20mA output of the AMI Codes-II HART option board represents a process value measurement, scaled according to the configured range of the instrument. This output corresponds to the Primary Variable. HART Communication is supported on this loop.

Since Dynamic Variables are mappable, PV can correspond to one of the following variables:

- Disinfectant

- Flow Rate

- pH

- Main Temperature

It is also possible to set the PV from the instrument local display, in the “Signal Output 3 / Parameter” settings.

4.3 Local Interfaces 4.3.1 Local Controls and Displays This device has a local display that allows the complete configurability of the instrument.

Refer to AMI Codes-II manual to details on it.

4.3.2 Write Protection The Field Device has no “Write protection mode”.

Page 33: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II HART Manual

109351.00 / 270616 8

5. DEVICE VARIABLES This Field Device exposes five Device Variables

Device Variables Variables Meaning Units

0 Disinfectant ppm 1 pH pH 2 Main Temperature °C 3 Flow Rate B/s 4 Case Temperature °C

5.1 Device Variable 0 Disinfectant Disinfectant is read with photometer sensor (Refer to AMI Codes-II manual to details on it).

5.2 Device Variable 1 pH pH is read with pH sensor (Refer to AMI Codes-II manual to details on it).

5.3 Device Variable 2 Main Temperature Main Temperature is read with temperature sensor (Refer to AMI Codes-II manual to details on it).

5.4 Device Variable 3 Flow Rate Flow rate is read with air bubble detector.

5.5 Device Variable 4 Case Temperature Case Temperature shows the Temperature read inside the Electronic Box.

6. DYNAMIC VARIABLES 6.1 Mappable Variables Four mappable Dynamic Variables are implemented.

Dynamic Variables Variables Meaning Units

PV Dis. – pH – Temp - Flow-rate ppm - pH - °C - B/s

SV Dis. – pH – Temp - Flow-rate ppm - pH - °C - B/s

TV Dis. – pH – Temp - Flow-rate ppm - pH - °C - B/s

QV Dis. – pH – Temp - Flow-rate ppm - pH - °C - B/s

It is possible to associate any of these dynamic variables to PV, SV, TV or QV with a HART Master (or Handheld Communicator).

The PV is also settable from the instrument local display’s settings.

Page 34: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II HART Manual

109351.00 / 270616 9

6.2 PV Transfer Functions The Primary Variable Transfer Function can be read with command 15. Its meaning is referred to the following table.

Transfer Function Type Code

Linear 240

Bilinear 241

Logarithmic 242

Control Upwards 243

Control Downwards 244

7. STATUS INFORMATION 7.1 Field Device Status The functions of the Field Device Status bits are specified in HCF_SPEC-99. Further details of their implementation are described in the following table.

Bit Name Notes

7 Device Malfunction Set on any detected Hardware Error

6 Configuration Changed Set if any changes are made to Field Device Configuration

5 Cold Start Set when powered-up or after a device reset

4 More Status Available Set if any Alarm or Maintenance has changed its status. More information is available via command 48

3 Loop Current Fixed The Loop Current is being held at a fixed value and is not responding to process variations

2 Loop Current Saturated The Loop Current has reached its upper (or lower) endpoint limit and cannot increase (or decrease) any further

1 Non-PV Out of Limits A Device Variable not mapped to the PV is beyond its

operating limits

0 PV Out of Limits The PV is beyond its operating limit

Page 35: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II HART Manual

109351.00 / 270616 10

7.2 Extended Device Status Contains additional information regarding the status of the Field Device.

Bit Name Notes

2 Critical Power Failure Set when battery is becoming critically low (less than 15 min) and Field Device not connected to Power Supply

1 Device Variable Alert

Set when one or more Device Variables are in one of the following conditions:

• Hi/low limited (Limit Status)

• Bad (Process Data Status)

• Poor Accuracy (Process Data Status)

0 Maintenance Required Not Used

Page 36: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II HART Manual

109351.00 / 270616 11

7.3 Additional Device Status (Command #48) Command #48 returns 6 additional bytes of data (Int32 or Int16 Little Endian), with the following status information:

ALARMS CODES:

Byte Bit Meaning Code

0-3 (INT32)

0 DIS. Alarm high E001 1 DIS. Alarm low E002 2 pH Alarm high E003 3 pH Alarm low E004 4 DIS. too high E005 5 Reserved

6 Sample Temp. high E007 7 Sample Temp. low E008 8 Sample Flow high E009 9 Sample Flow low E010 10 Temp. shorted E011 11 Temp. disconnected E012 12 Case Temp. high E013 13 Case Temp. low E014 14 Valve defective E015 15 Reserved

16 Control Timeout E017 17 Reagent Pump E018 18 FOME not connected E019 19 FOME dirty E020 20 DIS. invalid E021 21 Reagent empty E022 22 Cleaning Solution E023 23 Input active E024 24 IC MK41T56 E025 25 IC LM75 E026 26 IC PCF8574 E027 27 Signal output open E028 28 EEProm Motherboard E029 29 EEProm Frontend E030 30 Calibration Recout E031 31 Wrong Frontend E032

Page 37: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II HART Manual

109351.00 / 270616 12

0 DPD / Buffer E065 1 Reserved 2 Cleaning Solution E067 3 Reserved 4 Reserved 5 Reserved 6 Reserved 7 Reserved 8 Reserved 9 Reserved 10 Reserved 11 Reserved 12 Reserved 13 Reserved 14 Reserved 15 Reserved

4-5 (INT16U)

"Reserved" bits are always set to 0.

All bits used in these bytes indicate device/sensor failure or maintenances, and always set bit 4 of the Device Status byte.

8. UNIVERSAL COMMANDS Number Name Notes

0 Read Unique Identifier Returns identity information of the Field Device

1 Read Primary Variable Returns PV value and its unit

2 Read Loop Current and Percent of Range Returns AO value and % range

3 Read Dynamic Variables and Loop Current Returns PV, SV, TV and QV values and corresponding unit values along with AO value

6 Write Polling Address Changes Field Device’s polling address and loop current mode

Page 38: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II HART Manual

109351.00 / 270616 13

7 Read Loop Configuration Returns polling address and loop current mode status

8 Read Dynamic Variable Classifications Returns dynamic variables classification

9 Read Device Variables with Status Returns device variables with status

11 Read Unique Identifier Associated With Tag Same response as command 0 when Tag matches

12 Read Message Returns 24 bytes of packed ASCII data

13 Read Tag, Descriptor, Date Returns tag, descriptor (packed ASCII format) and date from the device

14 Read Primary Variable Transducer Information Returns PV transducer limits and span

15 Read Device Information Returns PV unit value, LRV, URV, damping value and write protect code

16 Read Final Assembly Number Returns final assembly number

17 Write Message Write 24 bytes of packed ASCII data.

18 Write Tag, Descriptor, Date Writes tag, descriptor (packed ASCII format) and date to the device

19 Write Final Assembly Number Writes final assembly number to the device

20 Read Long Tag Returns 32-byte Long Tag

21 Read Unique Identifier Associated with Long Tag Same response as command 0 when Long Tag matches

22 Write Long Tag Writes Long Tag to the Field Device

38 Reset Configuration Changed Flag Resets the configuration change flag

48 Read Additional Device Status See 7.3 for details

Page 39: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II HART Manual

109351.00 / 270616 14

9. COMMON-PRACTICE COMMANDS

9.1 Supported Common Practice Commands

9.2 Burst Mode This Field Device does not support Burst Mode.

9.3 Catch Device Variable This Field Device does not support Catch Device Variable.

10. DEVICE-SPECIFIC COMMANDS This Field Device does not support Device Specific Commands.

Number Name Notes

33 Read Device Variables Returns all the Supported Device Variables

50 Read Dynamic Variable Assignment Returns the Variable Numbers associated with PV, SV,TV and QV

51 Write Dynamic Variable Assignment Writes the Variable Numbers associated with PV, SV,TV and QV

Page 40: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II HART Manual

109351.00 / 270616 15

11. TABLES 11.1 Engineering Type Unit Codes

Units of Measurement Unit Code Temperature Degrees Celsius 32 Electric Potential millivolts 36 Electric Resistance Ω 37 Miscellaneous Hertz 38 Electric Current milliamperes 39 Time Minutes 50 Time Seconds 51 Time Hours 52 Time Days 53 Miscellaneous Percent 57 Electric Potential Volts 58 Miscellaneous pH 59 Miscellaneous Micro Siemens per centimeter 67 Flow Liters per hour 138 Concentration Parts per million 139 Electric Resistance kΩ 163 Concentration Parts per billion 169 Bubbles per second 240 Not used 250

11.2 Classification Unit Codes Measurement Meas. Code Temperature 64 Volumetric flow 66 Time 70 Frequency 80 Analytical 81 Electric Potential 83 Current 84 Resistance 85 Conductance 87 Concentration 90 Turbidity 97 Not used 250 Special 253

Page 41: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II HART Manual

109351.00 / 270616 16

12. PERFORMANCE 12.1 Sampling Rates Typical sampling rates are shown in the following table.

Photometer sensor value sample 1 per second

Temperature sensor value sample 1 per second

Flow Rate sensor value sample 1 per second

pH sensor value sample 1 per second

Note: all the Device Variables use an Infinite Impulse Response Filter, with coefficients depending on the measured variable. The Damping Value is different for each of the Device Variables, and can be read through Command 15.

12.2 Power-Up On power up, the transmitter takes approximately 10 seconds to be ready. During this period, the device will not respond to HART commands.

12.3 Command Response Times

Minimum 2ms

Typical 5ms

Maximum 150ms

12.4 Long Messages The largest data field used is in the response to Command 9: up to 71 bytes including the two status bytes.

12.5 Non-Volatile Memory EEPROM is used to hold the device’s configuration parameters. New data is written to this memory immediately on execution of a write command, before the consequent response.

12.6 Modes Loop current mode can be disabled or enabled using command 6.

12.7 Write Protection Write-protection is not selectable, and is always set as “not write protected”.

12.8 Damping Damping time is calculated for each dynamic variable.

Page 42: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II HART Manual

109351.00 / 270616 17

13. CAPABILITY CHECKLIST

Manufacturer, model and revision SWAN Analytic Instruments, AMI Codes-II rev. 1

Device type Transmitter

HART revision 7.x

Device Description available Yes

Number and type of sensors 4 (three external, one internal)

Number and type of actuators 0

Number and type of host side signals 1: 4 - 20mA analog

Number of Device Variables 5

Number of Dynamic Variables 4

Mappable Dynamic Variables? Yes

Number of common-practice commands 3

Number of device-specific commands 0

Bits of additional device status 48

Alternative operating modes? No

Burst mode? No

Write-protection? No

Page 43: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II HART Manual

109351.00 / 270616 18

ANNEX A. DEFAULT CONFIGURATION

Parameter Default value

PV Sensor Type Photometer (Disinfectant)

Lower Range Value 0 ppm

Upper Range Value 20 ppm

PV Units ppm

Damping time constant 0.796 seconds

Fault-indication jumper Not used

Write-protect jumper Not used

Number of response preambles 5

Page 44: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II HART Manual

109351.00 / 270616 19

ANNEX B. REVISION HISTORY

Document Title HART Interface Description AMI Codes-II

Document ID 109351.00

Document Revision

Date Device Revision DD Revision Description

1.0 27/06/2016 1 1 First release, for HART 7.x Device

Page 45: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments

HART® 7.x Field Device Specification for AMI Codes-II CC Transmitters

SWAN Analytical Instruments 8340, Studbachstrasse 13

Hinwil Switzerland

Page 46: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II CC HART Manual

109352.00 / 280616 2

TABLE OF CONTENTS

1. Introduction ......................................................................................................................................4

1.1 Scope ....................................................................................................................................4

1.2 Purpose .................................................................................................................................4

1.3 Who should use this document? ..........................................................................................4

1.4 References ............................................................................................................................4

2. Device Identification ........................................................................................................................5

3. Product Overview ............................................................................................................................5

3.1 Connections..........................................................................................................................5

3.1.1 Point to point Mode ..............................................................................................5

3.1.2 Multidrop Mode ....................................................................................................6

3.1.3 HARTREC Board .................................................................................................6

4. Product Interfaces ............................................................................................................................7

4.1 Process Interface ..................................................................................................................7

4.1.1 Sensor Input Channels ..........................................................................................7

4.2 Host Interface .......................................................................................................................7

4.2.1 Process Free residual chlorine ...............................................................................7

4.3 Local Interfaces ....................................................................................................................7

4.3.1 Local Controls and Displays .................................................................................7

4.3.2 Write Protection ....................................................................................................7

5. Device Variables ..............................................................................................................................8

5.1 Device Variable 0 Free residual chlorine (frc) .....................................................................8

5.2 Device Variable 1 Total residual chlorine 1 (tc1) ................................................................8

5.3 Device Variable 2 Total residual chlorine 2 (tc2) ................................................................8

5.4 Device Variable 3 Calculated monochloramine (cmc) ........................................................8

5.5 Device Variable 4 Combined chlorine (ccc) ........................................................................8

5.6 Device Variable 5 Calculated dichloramine (cdc) ...............................................................8

5.7 Device Variable 6 Temperature ...........................................................................................8

5.8 Device Variable 7 Flow Rate ...............................................................................................8

5.9 Device Variable 8 pH ...........................................................................................................9

Page 47: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II CC HART Manual

109352.00 / 280616 3

5.10 Device Variable 10 Case Temperature ................................................................................9

6. Dynamic Variables ...........................................................................................................................9

6.1 Mappable Variables .............................................................................................................9

6.2 PV Transfer Functions .........................................................................................................9

7. Status Information ..........................................................................................................................10

7.1 Field Device Status ............................................................................................................10

7.2 Extended Device Status .....................................................................................................10

7.3 Additional Device Status (Command #48) ........................................................................11

8. Universal Commands .....................................................................................................................13

9. Common-Practice Commands .......................................................................................................15

9.1 Supported Common Practice Commands ..........................................................................15

9.2 Burst Mode .........................................................................................................................15

9.3 Catch Device Variable .......................................................................................................15

10. Device-Specific Commands ...........................................................................................................15

11. Tables 16

11.1 Engineering Type Unit Codes ............................................................................................16

11.2 Classification Unit Codes ..................................................................................................16

12. Performance ...................................................................................................................................17

12.1 Sampling Rates ..................................................................................................................17

12.2 Power-Up ...........................................................................................................................17

12.3 Command Response Times................................................................................................17

12.4 Long Messages ...................................................................................................................17

12.5 Non-Volatile Memory ........................................................................................................17

12.6 Modes .................................................................................................................................17

12.7 Write Protection .................................................................................................................17

12.8 Damping .............................................................................................................................17

13. Capability Checklist .......................................................................................................................18

Annex A. Default Configuration ........................................................................................................19

Annex B. Revision History ................................................................................................................20

Page 48: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II CC HART Manual

109352.00 / 280616 4

1. INTRODUCTION 1.1 Scope The SWAN Analytical Instruments model AMI Codes-II CC transmitter complies with HART Protocol Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering Unit Codes supported). The functionality of this Field Device is described sufficiently to allow its proper application in a process and its complete support in HART capable Host Applications.

1.2 Purpose This specification is designed to complement the AMI Codes-II CC manual by providing a complete description of this Field Device from a HART Communication perspective.

1.3 Who should use this document? The specification is designed to be a technical reference for HART capable Host Application Developers, System Integrators and knowledgeable End Users. It also provides functional specifications (e.g., commands and performance requirements) used during development, maintenance and testing. This document assumes the reader is familiar with HART Protocol requirements and terminology.

1.4 References HART Smart Communications Protocol Specification. HCF_SPEC-12. Available from the HCF.

MenAMI_Codes-II_CC_xx.pdf. Available from the SWAN Analytical Instruments web page.

Page 49: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II CC HART Manual

109352.00 / 280616 5

2. DEVICE IDENTIFICATION Manufacturer Name: SWAN Analytical

Instruments Model Name(s): AMI Codes-II CC

Manufacture ID Code: 24757 (60B5 Hex)

Device Type Code:

58178 (E342 Hex)

HART Protocol Revision 7.5 Device Revision: 1

Number of Device Variables 10

Physical Layers Supported FSK

Physical Device Category Transmitter, Non-DC-isolated Bus Device

3. PRODUCT OVERVIEW The AMI Codes-II CC HART communication option board provides a 4 to 20mA output signal and can be monitored and configured using a HART master device or a hand-held communicator.

3.1 Connections 3.1.1 Point to point Mode

An external minimum 250 Ω (maximum 800 Ω) resistor is needed in order to communicate with HART protocol.

Page 50: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II CC HART Manual

109352.00 / 280616 6

3.1.2 Multidrop Mode

A single minimum 250 Ω resistor (maximum 800 Ω) is needed to communicate with all the instruments connected to the bus, and each of them must provide 4mA.

3.1.3 HARTREC Board

The HARTREC Board must be installed in the AMI transmitter in order to communicate with HART.

Page 51: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II CC HART Manual

109352.00 / 280616 7

4. PRODUCT INTERFACES 4.1 Process Interface 4.1.1 Sensor Input Channels Refer to AMI Codes-II CC manual to details on mounting external sensors.

4.2 Host Interface 4.2.1 Process Free residual chlorine The 4 to 20mA output of the AMI Codes-II CC HART option board represents a process value measurement, scaled according to the configured range of the instrument. This output corresponds to the Primary Variable. HART Communication is supported on this loop.

Since Dynamic Variables are mappable, PV can correspond to one of the following variables:

- Free residual chlorine (frc)

- Total residual chlorine 1 (tc1)

- Total residual chlorine 2 (tc2)

- Flow rate

- Calculated monochloramine (cmc)

- Combined chlorine (ccc)

- Calculated dichloramine (cdc)

- Temperature

- pH

It is also possible to set the PV from the instrument local display, in the “Signal Output 3 / Parameter” settings.

4.3 Local Interfaces 4.3.1 Local Controls and Displays This device has a local display that allows the complete configurability of the instrument.

Refer to AMI Codes-II CC manual to details on it.

4.3.2 Write Protection The Field Device has no “Write protection mode”.

Page 52: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II CC HART Manual

109352.00 / 280616 8

5. DEVICE VARIABLES This Field Device exposes ten Device Variables

Device Variables Variables Meaning Units

0 Free residual chlorine ppm 1 Total residual chlorine 1 ppm 2 Total residual chlorine 2 ppm 3 Calculated monochloramine ppm 4 Combined chlorine ppm 5 Calculated dichloramine ppm 6 Temperature °C 7 Flow Rate B/s 8 pH pH 9 Case Temperature °C

5.1 Device Variable 0 Free residual chlorine (frc) Free residual chlorine is read with photometer sensor (Refer to AMI Codes-II CC manual to details on it).

5.2 Device Variable 1 Total residual chlorine 1 (tc1) Total residual chlorine 1 is read with photometer sensor (Refer to AMI Codes-II CC manual to details on it).

5.3 Device Variable 2 Total residual chlorine 2 (tc2) Total residual chlorine 2 is read with photometer sensor (Refer to AMI Codes-II CC manual to details on it).

5.4 Device Variable 3 Calculated monochloramine (cmc) Calculated monochloramine is calculated (Refer to AMI Codes-II CC manual to details on it).

5.5 Device Variable 4 Combined chlorine (ccc) Combined chlorine is calculated (Refer to AMI Codes-II CC manual to details on it).

5.6 Device Variable 5 Calculated dichloramine (cdc) Calculated dichloramine is calculated.

5.7 Device Variable 6 Temperature Temperature is read with Temperature sensor.

5.8 Device Variable 7 Flow Rate Flow rate is read with air bubble detector.

Page 53: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II CC HART Manual

109352.00 / 280616 9

5.9 Device Variable 8 pH pH rate is read with pH sensor.

5.10 Device Variable 10 Case Temperature Case Temperature shows the Temperature read inside the Electronic Box.

6. DYNAMIC VARIABLES 6.1 Mappable Variables Four mappable Dynamic Variables are implemented.

Dynamic Variables Variables Meaning Units

PV frc-tc1-tc2-cmc-ccc-cdc/Temp/Flow-rate/pH ppm / °C / (B/s) / pH

SV frc-tc1-tc2-cmc-ccc-cdc/Temp/Flow-rate/pH ppm / °C / (B/s) / pH

TV frc-tc1-tc2-cmc-ccc-cdc/Temp/Flow-rate/pH ppm / °C / (B/s) / pH

QV frc-tc1-tc2-cmc-ccc-cdc/Temp/Flow-rate/pH ppm / °C / (B/s) / pH

It is possible to associate any of these dynamic variables to PV, SV, TV or QV with a HART Master (or Handheld Communicator).

The PV is also settable from the instrument local display’s settings.

6.2 PV Transfer Functions The Primary Variable Transfer Function can be read with command 15. Its meaning is referred to the following table.

Transfer Function Type Code

Linear 240

Bilinear 241

Logarithmic 242

Control Upwards 243

Control Downwards 244

Page 54: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II CC HART Manual

109352.00 / 280616 10

7. STATUS INFORMATION 7.1 Field Device Status The functions of the Field Device Status bits are specified in HCF_SPEC-99. Further details of their implementation are described in the following table.

Bit Name Notes

7 Device Malfunction Set on any detected Hardware Error

6 Configuration Changed Set if any changes are made to Field Device Configuration

5 Cold Start Set when powered-up or after a device reset

4 More Status Available Set if any Alarm or Maintenance has changed its status. More information is available via command 48

3 Loop Current Fixed The Loop Current is being held at a fixed value and is not responding to process variations

2 Loop Current Saturated The Loop Current has reached its upper (or lower) endpoint limit and cannot increase (or decrease) any further

1 Non-PV Out of Limits A Device Variable not mapped to the PV is beyond its

operating limits

0 PV Out of Limits The PV is beyond its operating limit

7.2 Extended Device Status Contains additional information regarding the status of the Field Device.

Bit Name Notes

2 Critical Power Failure Set when battery is becoming critically low (less than 15 min) and Field Device not connected to Power Supply

1 Device Variable Alert

Set when one or more Device Variables are in one of the following conditions:

• Hi/low limited (Limit Status)

• Bad (Process Data Status)

• Poor Accuracy (Process Data Status)

0 Maintenance Required Not Used

Page 55: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II CC HART Manual

109352.00 / 280616 11

7.3 Additional Device Status (Command #48) Command #48 returns 10 additional bytes of data (Int32 or Int16 Little Endian), with the following status information:

ALARMS CODES:

Byte Bit Meaning Code

0-3 (INT32)

0 Alarm high fac E001 1 Alarm low fac E002 2 Alarm high tc1 E003 3 Alarm low tc1 E004 4 Alarm high tc2 E005 5 Alarm low tc2 E006 6 Sample Temp. high E007 7 Sample Temp. low E008 8 Sample Flow high E009 9 Sample Flow low E010 10 Temp. shorted E011 11 Temp. disconnected E012 12 Case Temp. high E013 13 Case Temp. low E014 14 Valve 1 defective E015 15 DIS. Invalid E016 16 Control Timeout E017 17 Reagent Pump E018

18 Photometer not connected E019

19 Photometer dirty E020 20 Absorbance too high E021 21 Reagent empty E022 22 Cleaning Solution E023 23 Input active E024 24 IC MK41T56 E025 25 IC LM75 E026 26 IC PCF8574 E027 27 Signal output open E028 28 EEProm Motherboard E029 29 EEProm Frontend E030 30 Calibration Recout E031 31 Wrong Frontend E032

Page 56: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II CC HART Manual

109352.00 / 280616 12

4-5 (INT16)

0 DPD / Buffer E065 1 Potassium Iodide E066 2 Cleaning Solution E067 3 Reserved 4 Reserved 5 Reserved 6 Reserved 7 Reserved 8 Reserved 9 Reserved 10 Reserved 11 Reserved 12 Reserved 13 Reserved 14 Reserved 15 Reserved

14-17 (INT32)

0 Alarm high cmc E033 1 Alarm low cmc E034 2 Alarm high ccc E035 3 Alarm low ccc E036 4 Alarm high cdc E037 5 Alarm low cdc E038 6 Alarm high pH E039 7 Alarm low pH E040

8-31 Reserved "Reserved" bits are always set to 0.

All bits used in these bytes indicate device/sensor failure or maintenances, and always set bit 4 of the Device Status byte.

Page 57: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II CC HART Manual

109352.00 / 280616 13

8. UNIVERSAL COMMANDS Number Name Notes

0 Read Unique Identifier Returns identity information of the Field Device

1 Read Primary Variable Returns PV value and its unit

2 Read Loop Current and Percent of Range Returns AO value and % range

3 Read Dynamic Variables and Loop Current Returns PV, SV, TV and QV values and corresponding unit values along with AO value

6 Write Polling Address Changes Field Device’s polling address and loop current mode

7 Read Loop Configuration Returns polling address and loop current mode status

8 Read Dynamic Variable Classifications Returns dynamic variables classification

9 Read Device Variables with Status Returns device variables with status

11 Read Unique Identifier Associated With Tag Same response as command 0 when Tag matches

12 Read Message Returns 24 bytes of packed ASCII data

13 Read Tag, Descriptor, Date Returns tag, descriptor (packed ASCII format) and date from the device

14 Read Primary Variable Transducer Information Returns PV transducer limits and span

15 Read Device Information Returns PV unit value, LRV, URV, damping value and write protect code

16 Read Final Assembly Number Returns final assembly number

17 Write Message Write 24 bytes of packed ASCII data.

18 Write Tag, Descriptor, Date Writes tag, descriptor (packed ASCII format) and date to the device

Page 58: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II CC HART Manual

109352.00 / 280616 14

19 Write Final Assembly Number Writes final assembly number to the device

20 Read Long Tag Returns 32-byte Long Tag

21 Read Unique Identifier Associated with Long Tag Same response as command 0 when Long Tag matches

22 Write Long Tag Writes Long Tag to the Field Device

38 Reset Configuration Changed Flag Resets the configuration change flag

48 Read Additional Device Status See 7.3 for details

Page 59: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II CC HART Manual

109352.00 / 280616 15

9. COMMON-PRACTICE COMMANDS

9.1 Supported Common Practice Commands

9.2 Burst Mode This Field Device does not support Burst Mode.

9.3 Catch Device Variable This Field Device does not support Catch Device Variable.

10. DEVICE-SPECIFIC COMMANDS This Field Device does not support Device Specific Commands.

Number Name Notes

33 Read Device Variables Returns all the Supported Device Variables

50 Read Dynamic Variable Assignment Returns the Variable Numbers associated with PV, SV,TV and QV

51 Write Dynamic Variable Assignment Writes the Variable Numbers associated with PV, SV,TV and QV

Page 60: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II CC HART Manual

109352.00 / 280616 16

11. TABLES 11.1 Engineering Type Unit Codes

Units of Measurement Unit Code Temperature Degrees Celsius 32 Electric Potential millivolts 36 Electric Resistance Ω 37 Miscellaneous Hertz 38 Electric Current milliamperes 39 Time Minutes 50 Time Seconds 51 Time Hours 52 Time Days 53 Miscellaneous Percent 57 Electric Potential Volts 58 Miscellaneous pH 59 Miscellaneous Micro Siemens per centimeter 67 Flow Liters per hour 138 Concentration Parts per million 139 Electric Resistance kΩ 163 Concentration Parts per billion 169 Bubbles per second (custom) 240 Not used 250

11.2 Classification Unit Codes Measurement Meas. Code Temperature 64 Volumetric flow 66 Time 70 Frequency 80 Analytical 81 Electric Potential 83 Current 84 Resistance 85 Conductance 87 Concentration 90 Turbidity 97 Not used 250 Special 253

Page 61: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II CC HART Manual

109352.00 / 280616 17

12. PERFORMANCE 12.1 Sampling Rates Typical sampling rates are shown in the following table.

frc-tc1-tc2-cmc-ccc-cdc sensor value sample 1 per second

Temperature sensor value sample 1 per second

Flow Rate sensor value sample 1 per second

pH sensor value sample 1 per second

Note: all the Device Variables use an Infinite Impulse Response Filter, with coefficients depending on the measured variable. The Damping Value is different for each of the Device Variables, and can be read through Command 15.

12.2 Power-Up On power up, the transmitter takes approximately 10 seconds to be ready. During this period, the device will not respond to HART commands.

12.3 Command Response Times

Minimum 2ms

Typical 5ms

Maximum 150ms

12.4 Long Messages The largest data field used is in the response to Command 9: up to 71 bytes including the two status bytes.

12.5 Non-Volatile Memory EEPROM is used to hold the device’s configuration parameters. New data is written to this memory immediately on execution of a write command, before the consequent response.

12.6 Modes Loop current mode can be disabled or enabled using command 6.

12.7 Write Protection Write-protection is not selectable, and is always set as “not write protected”.

12.8 Damping Damping time is calculated for each dynamic variable.

Page 62: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II CC HART Manual

109352.00 / 280616 18

13. CAPABILITY CHECKLIST

Manufacturer, model and revision SWAN Analytic Instruments, AMI Codes-II CC rev. 1

Device type Transmitter

HART revision 7.x

Device Description available Yes

Number and type of sensors 5 (four external, one internal)

Number and type of actuators 2 on-off valves

Number and type of host side signals 1: 4 - 20mA analog

Number of Device Variables 10

Number of Dynamic Variables 4

Mappable Dynamic Variables? Yes

Number of common-practice commands 3

Number of device-specific commands 0

Bits of additional device status 80

Alternative operating modes? No

Burst mode? No

Write-protection? No

Page 63: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II CC HART Manual

109352.00 / 280616 19

ANNEX A. DEFAULT CONFIGURATION

Parameter Default value

PV Sensor Type Free residual chlorine (frc)

Lower Range Value 0 ppm

Upper Range Value 20 ppm

PV Units ppm

Damping time constant 0.796 seconds

Fault-indication jumper Not used

Write-protect jumper Not used

Number of response preambles 5

Page 64: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II CC HART Manual

109352.00 / 280616 20

ANNEX B. REVISION HISTORY

Document Title HART Interface Description AMI Codes-II CC

Document ID 109352.00

Document Revision

Date Device Revision DD Revision Description

1.0 28/06/2016 1 1 First release, for HART 7.x Device

Page 65: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments

HART® 7.x Field Device Specification for AMI Codes-II O3 Transmitters

SWAN Analytical Instruments 8340, Studbachstrasse 13

Hinwil Switzerland

Page 66: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II O3 HART Manual

109717.00 / 181017 2

TABLE OF CONTENTS

1. Introduction ......................................................................................................................................4

1.1 Scope ....................................................................................................................................4

1.2 Purpose .................................................................................................................................4

1.3 Who should use this document? ..........................................................................................4

1.4 References ............................................................................................................................4

2. Device Identification ........................................................................................................................5

3. Product Overview ............................................................................................................................5

3.1 Connections..........................................................................................................................5

3.1.1 Point to point Mode ..............................................................................................5

3.1.2 Multidrop Mode ....................................................................................................6

3.1.3 HARTREC Board .................................................................................................6

4. Product Interfaces ............................................................................................................................7

4.1 Process Interface ..................................................................................................................7

4.1.1 Sensor Input Channels ..........................................................................................7

4.2 Host Interface .......................................................................................................................7

4.2.1 Process Free residual chlorine ...............................................................................7

4.3 Local Interfaces ....................................................................................................................7

4.3.1 Local Controls and Displays .................................................................................7

4.3.2 Write Protection ....................................................................................................7

5. Device Variables ..............................................................................................................................8

5.1 Device Variable 0 Disinfectant ............................................................................................8

5.2 Device Variable 1 pH ...........................................................................................................8

5.3 Device Variable 2 Main Temperature ..................................................................................8

5.4 Device Variable 3 Flow Rate ...............................................................................................8

5.5 Device Variable 4 Case Temperature ..................................................................................8

6. Dynamic Variables ...........................................................................................................................8

6.1 Mappable Variables .............................................................................................................8

6.2 PV Transfer Functions .........................................................................................................9

7. Status Information ............................................................................................................................9

Page 67: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II O3 HART Manual

109717.00 / 181017 3

7.1 Field Device Status ..............................................................................................................9

7.2 Extended Device Status .....................................................................................................10

7.3 Additional Device Status (Command #48) ........................................................................11

8. Universal Commands .....................................................................................................................12

9. Common-Practice Commands .......................................................................................................14

9.1 Supported Common Practice Commands ..........................................................................14

9.2 Burst Mode .........................................................................................................................14

9.3 Catch Device Variable .......................................................................................................14

10. Device-Specific Commands ...........................................................................................................14

11. Tables 15

11.1 Engineering Type Unit Codes ............................................................................................15

11.2 Classification Unit Codes ..................................................................................................15

12. Performance ...................................................................................................................................16

12.1 Sampling Rates ..................................................................................................................16

12.2 Power-Up ...........................................................................................................................16

12.3 Command Response Times................................................................................................16

12.4 Long Messages ...................................................................................................................16

12.5 Non-Volatile Memory ........................................................................................................16

12.6 Modes .................................................................................................................................16

12.7 Write Protection .................................................................................................................16

12.8 Damping .............................................................................................................................16

13. Capability Checklist .......................................................................................................................17

Annex A. Default Configuration ........................................................................................................18

Annex B. Revision History ................................................................................................................19

Page 68: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II O3 HART Manual

109717.00 / 181017 4

1. INTRODUCTION 1.1 Scope The SWAN Analytical Instruments model AMI Codes-II O3 transmitter complies with HART Protocol Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering Unit Codes supported). The functionality of this Field Device is described sufficiently to allow its proper application in a process and its complete support in HART capable Host Applications.

1.2 Purpose This specification is designed to complement the AMI Codes-II O3 manual by providing a complete description of this Field Device from a HART Communication perspective.

1.3 Who should use this document? The specification is designed to be a technical reference for HART capable Host Application Developers, System Integrators and knowledgeable End Users. It also provides functional specifications (e.g., commands and performance requirements) used during development, maintenance and testing. This document assumes the reader is familiar with HART Protocol requirements and terminology.

1.4 References HART Smart Communications Protocol Specification. HCF_SPEC-12. Available from the HCF.

MenAMI_Codes-II_O3_xx.pdf. Available from the SWAN Analytical Instruments web page.

Page 69: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II O3 HART Manual

109717.00 / 181017 5

2. DEVICE IDENTIFICATION Manufacturer Name: SWAN Analytical

Instruments Model Name(s): AMI Codes-II O3

Manufacture ID Code: 24757 (60B5 Hex)

Device Type Code:

58303 (E3BF Hex)

HART Protocol Revision 7.5 Device Revision: 1

Number of Device Variables 5

Physical Layers Supported FSK

Physical Device Category Transmitter, Non-DC-isolated Bus Device

3. PRODUCT OVERVIEW The AMI Codes-II O3 HART communication option board provides a 4 to 20mA output signal and can be monitored and configured using a HART master device or a hand-held communicator.

3.1 Connections 3.1.1 Point to point Mode

An external minimum 250 Ω (maximum 800 Ω) resistor is needed in order to communicate with HART protocol.

Page 70: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II O3 HART Manual

109717.00 / 181017 6

3.1.2 Multidrop Mode

A single minimum 250 Ω resistor (maximum 800 Ω) is needed to communicate with all the instruments connected to the bus, and each of them must provide 4mA.

3.1.3 HARTREC Board

The HARTREC Board must be installed in the AMI transmitter in order to communicate with HART.

Page 71: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II O3 HART Manual

109717.00 / 181017 7

4. PRODUCT INTERFACES 4.1 Process Interface 4.1.1 Sensor Input Channels Refer to AMI Codes-II O3 manual to details on mounting external sensors.

4.2 Host Interface 4.2.1 Process Free residual chlorine The 4 to 20mA output of the AMI Codes-II O3 HART option board represents a process value measurement, scaled according to the configured range of the instrument. This output corresponds to the Primary Variable. HART Communication is supported on this loop.

Since Dynamic Variables are mappable, PV can correspond to one of the following variables:

- Disinfectant

- Flow Rate

- pH

- Main Temperature

It is also possible to set the PV from the instrument local display, in the “Signal Output 3 / Parameter” settings.

4.3 Local Interfaces 4.3.1 Local Controls and Displays This device has a local display that allows the complete configurability of the instrument.

Refer to AMI Codes-II O3 manual to details on it.

4.3.2 Write Protection The Field Device has no “Write protection mode”.

Page 72: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II O3 HART Manual

109717.00 / 181017 8

5. DEVICE VARIABLES This Field Device exposes five Device Variables

Device Variables Variables Meaning Units

0 Disinfectant ppb 1 pH pH 2 Main Temperature °C 3 Flow Rate B/s 4 Case Temperature °C

5.1 Device Variable 0 Disinfectant Disinfectant is read with photometer sensor (Refer to AMI Codes-II O3 manual to details on it).

5.2 Device Variable 1 pH pH is read with pH sensor (Refer to AMI Codes-II O3 manual to details on it).

5.3 Device Variable 2 Main Temperature Main Temperature is read with temperature sensor (Refer to AMI Codes-II O3 manual to details on it).

5.4 Device Variable 3 Flow Rate Flow rate is read with air bubble detector.

5.5 Device Variable 4 Case Temperature Case Temperature shows the Temperature read inside the Electronic Box.

6. DYNAMIC VARIABLES 6.1 Mappable Variables Four mappable Dynamic Variables are implemented.

Dynamic Variables Variables Meaning Units

PV Dis. – pH – Temp - Flow-rate ppb - pH - °C - B/s

SV Dis. – pH – Temp - Flow-rate ppb - pH - °C - B/s

TV Dis. – pH – Temp - Flow-rate ppb - pH - °C - B/s

QV Dis. – pH – Temp - Flow-rate ppb - pH - °C - B/s

It is possible to associate any of these dynamic variables to PV, SV, TV or QV with a HART Master (or Handheld Communicator).

The PV is also settable from the instrument local display’s settings.

Page 73: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II O3 HART Manual

109717.00 / 181017 9

6.2 PV Transfer Functions The Primary Variable Transfer Function can be read with command 15. Its meaning is referred to the following table.

Transfer Function Type Code

Linear 240

Bilinear 241

Logarithmic 242

Control Upwards 243

Control Downwards 244

7. STATUS INFORMATION 7.1 Field Device Status The functions of the Field Device Status bits are specified in HCF_SPEC-99. Further details of their implementation are described in the following table.

Bit Name Notes

7 Device Malfunction Set on any detected Hardware Error

6 Configuration Changed Set if any changes are made to Field Device Configuration

5 Cold Start Set when powered-up or after a device reset

4 More Status Available Set if any Alarm or Maintenance has changed its status. More information is available via command 48

3 Loop Current Fixed The Loop Current is being held at a fixed value and is not responding to process variations

2 Loop Current Saturated The Loop Current has reached its upper (or lower) endpoint limit and cannot increase (or decrease) any further

1 Non-PV Out of Limits A Device Variable not mapped to the PV is beyond its

operating limits

0 PV Out of Limits The PV is beyond its operating limit

Page 74: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II O3 HART Manual

109717.00 / 181017 10

7.2 Extended Device Status Contains additional information regarding the status of the Field Device.

Bit Name Notes

2 Critical Power Failure Set when battery is becoming critically low (less than 15 min) and Field Device not connected to Power Supply

1 Device Variable Alert

Set when one or more Device Variables are in one of the following conditions:

• Hi/low limited (Limit Status)

• Bad (Process Data Status)

• Poor Accuracy (Process Data Status)

0 Maintenance Required Not Used

Page 75: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II O3 HART Manual

109717.00 / 181017 11

7.3 Additional Device Status (Command #48) Command #48 returns 6 additional bytes of data (Int32 or Int16 Little Endian), with the following status information:

ALARMS CODES:

Byte Bit Meaning Code

0-3 (INT32)

0 DIS. Alarm high E001 1 DIS. Alarm low E002 2 pH Alarm high E003 3 pH Alarm low E004 4 DIS. too high E005 5 Reserved

6 Sample Temp. high E007 7 Sample Temp. low E008 8 Sample Flow high E009 9 Sample Flow low E010 10 Temp. shorted E011 11 Temp. disconnected E012 12 Case Temp. high E013 13 Case Temp. low E014 14 Valve defective E015 15 Reserved

16 Control Timeout E017 17 Reagent Pump E018 18 FOME not connected E019 19 FOME dirty E020 20 DIS. invalid E021 21 Reagent empty E022 22 Cleaning Solution E023 23 Input active E024 24 IC MK41T56 E025 25 IC LM75 E026 26 IC PCF8574 E027 27 Signal output open E028 28 EEProm Motherboard E029 29 EEProm Frontend E030 30 Calibration Recout E031 31 Wrong Frontend E032

Page 76: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II O3 HART Manual

109717.00 / 181017 12

0 DPD / Buffer E065 1 Reagents expired E066 2 Cleaning Solution E067 3 Reserved 4 Reserved 5 Reserved 6 Reserved 7 Reserved 8 Reserved 9 Reserved 10 Reserved 11 Reserved 12 Reserved 13 Reserved 14 Reserved 15 Reserved

4-5 (INT16U)

"Reserved" bits are always set to 0.

All bits used in these bytes indicate device/sensor failure or maintenances, and always set bit 4 of the Device Status byte.

8. UNIVERSAL COMMANDS Number Name Notes

0 Read Unique Identifier Returns identity information of the Field Device

1 Read Primary Variable Returns PV value and its unit

2 Read Loop Current and Percent of Range Returns AO value and % range

3 Read Dynamic Variables and Loop Current Returns PV, SV, TV and QV values and corresponding unit values along with AO value

6 Write Polling Address Changes Field Device’s polling address and loop current mode

Page 77: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II O3 HART Manual

109717.00 / 181017 13

7 Read Loop Configuration Returns polling address and loop current mode status

8 Read Dynamic Variable Classifications Returns dynamic variables classification

9 Read Device Variables with Status Returns device variables with status

11 Read Unique Identifier Associated With Tag Same response as command 0 when Tag matches

12 Read Message Returns 24 bytes of packed ASCII data

13 Read Tag, Descriptor, Date Returns tag, descriptor (packed ASCII format) and date from the device

14 Read Primary Variable Transducer Information Returns PV transducer limits and span

15 Read Device Information Returns PV unit value, LRV, URV, damping value and write protect code

16 Read Final Assembly Number Returns final assembly number

17 Write Message Write 24 bytes of packed ASCII data.

18 Write Tag, Descriptor, Date Writes tag, descriptor (packed ASCII format) and date to the device

19 Write Final Assembly Number Writes final assembly number to the device

20 Read Long Tag Returns 32-byte Long Tag

21 Read Unique Identifier Associated with Long Tag Same response as command 0 when Long Tag matches

22 Write Long Tag Writes Long Tag to the Field Device

38 Reset Configuration Changed Flag Resets the configuration change flag

48 Read Additional Device Status See 7.3 for details

Page 78: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II O3 HART Manual

109717.00 / 181017 14

9. COMMON-PRACTICE COMMANDS

9.1 Supported Common Practice Commands

9.2 Burst Mode This Field Device does not support Burst Mode.

9.3 Catch Device Variable This Field Device does not support Catch Device Variable.

10. DEVICE-SPECIFIC COMMANDS This Field Device does not support Device Specific Commands.

Number Name Notes

33 Read Device Variables Returns all the Supported Device Variables

50 Read Dynamic Variable Assignment Returns the Variable Numbers associated with PV, SV,TV and QV

51 Write Dynamic Variable Assignment Writes the Variable Numbers associated with PV, SV,TV and QV

Page 79: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II O3 HART Manual

109717.00 / 181017 15

11. TABLES 11.1 Engineering Type Unit Codes

Units of Measurement Unit Code Temperature Degrees Celsius 32 Electric Potential millivolts 36 Electric Resistance Ω 37 Miscellaneous Hertz 38 Electric Current milliamperes 39 Time Minutes 50 Time Seconds 51 Time Hours 52 Time Days 53 Miscellaneous Percent 57 Electric Potential Volts 58 Miscellaneous pH 59 Miscellaneous Micro Siemens per centimeter 67 Flow Liters per hour 138 Concentration Parts per million 139 Electric Resistance kΩ 163 Concentration Parts per billion 169 Bubbles per second 240 Not used 250

11.2 Classification Unit Codes Measurement Meas. Code Temperature 64 Volumetric flow 66 Time 70 Frequency 80 Analytical 81 Electric Potential 83 Current 84 Resistance 85 Conductance 87 Concentration 90 Turbidity 97 Not used 250 Special 253

Page 80: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II O3 HART Manual

109717.00 / 181017 16

12. PERFORMANCE 12.1 Sampling Rates Typical sampling rates are shown in the following table.

Photometer sensor value sample 1 per second

Temperature sensor value sample 1 per second

Flow Rate sensor value sample 1 per second

pH sensor value sample 1 per second

Note: all the Device Variables use an Infinite Impulse Response Filter, with coefficients depending on the measured variable. The Damping Value is different for each of the Device Variables, and can be read through Command 15.

12.2 Power-Up On power up, the transmitter takes approximately 10 seconds to be ready. During this period, the device will not respond to HART commands.

12.3 Command Response Times

Minimum 2ms

Typical 5ms

Maximum 150ms

12.4 Long Messages The largest data field used is in the response to Command 9: up to 71 bytes including the two status bytes.

12.5 Non-Volatile Memory EEPROM is used to hold the device’s configuration parameters. New data is written to this memory immediately on execution of a write command, before the consequent response.

12.6 Modes Loop current mode can be disabled or enabled using command 6.

12.7 Write Protection Write-protection is not selectable, and is always set as “not write protected”.

12.8 Damping Damping time is calculated for each dynamic variable.

Page 81: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II O3 HART Manual

109717.00 / 181017 17

13. CAPABILITY CHECKLIST

Manufacturer, model and revision SWAN Analytic Instruments, AMI Codes-II O3 rev. 1

Device type Transmitter

HART revision 7.x

Device Description available Yes

Number and type of sensors 4 (three external, one internal)

Number and type of actuators 0

Number and type of host side signals 1: 4 - 20mA analog

Number of Device Variables 5

Number of Dynamic Variables 4

Mappable Dynamic Variables? Yes

Number of common-practice commands 3

Number of device-specific commands 0

Bits of additional device status 48

Alternative operating modes? No

Burst mode? No

Write-protection? No

Page 82: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II O3 HART Manual

109717.00 / 181017 18

ANNEX A. DEFAULT CONFIGURATION

Parameter Default value

PV Sensor Type Photometer (Disinfectant)

Lower Range Value 0 ppb

Upper Range Value 500 ppb

PV Units ppb

Damping time constant 0.796 seconds

Fault-indication jumper Not used

Write-protect jumper Not used

Number of response preambles 5

Page 83: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Codes-II O3 HART Manual

109717.00 / 181017 19

ANNEX B. REVISION HISTORY

Document Title HART Interface Description AMI Codes-II O3

Document ID 109351.00

Document Revision

Date Device Revision DD Revision Description

1.0 18/10/2017 1 1 First release, for HART 7.x Device

Page 84: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments

HART® 7.x Field Device Specification for AMI Deltacon Transmitters

SWAN Analytical Instruments 8340, Studbachstrasse 13

Hinwil Switzerland

Page 85: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Deltacon HART Manual

109347.00/ 270616 2

TABLE OF CONTENTS

1. Introduction ..................................................................................................................................... 4

1.1 Scope ................................................................................................................................... 4

1.2 Purpose ................................................................................................................................ 4

1.3 Who should use this document? ......................................................................................... 4

1.4 References ........................................................................................................................... 4

2. Device Identification ....................................................................................................................... 5

3. Product Overview ........................................................................................................................... 5

3.1 Connections ......................................................................................................................... 5

3.1.1 Point to point Mode ............................................................................................. 5

3.1.2 Multidrop Mode ................................................................................................... 6

3.1.3 HARTREC Board ................................................................................................ 6

4. Product Interfaces............................................................................................................................ 7

4.1 Process Interface ................................................................................................................. 7

4.1.1 Sensor Input Channels ......................................................................................... 7

4.2 Host Interface ...................................................................................................................... 7

4.2.1 Process Specific Conductivity ............................................................................. 7

4.3 Local Interfaces ................................................................................................................... 7

4.3.1 Local Controls and Displays ................................................................................ 7

4.3.2 Write Protection ................................................................................................... 7

5. Device Variables ............................................................................................................................. 8

5.1 Device Variable 0 Specific Conductivity (sc) ..................................................................... 8

5.2 Device Variable 1 Cation Conductivity (cc) ....................................................................... 8

5.3 Device Variable 2 Degassed Conductivity (dc) .................................................................. 8

5.4 Device Variable 3 First Temperature .................................................................................. 8

5.5 Device Variable 4 Second Temperature ............................................................................. 8

5.6 Device Variable 5 Third Temperature ................................................................................ 9

5.7 Device Variable 6 Conductivity Difference ........................................................................ 9

5.8 Device Variable 7 Main Flow ............................................................................................. 9

5.9 Device Variable 8 First Calculated Value (pH) .................................................................. 9

5.10 Device Variable 9 Second Calculated Value (Ammonium) ............................................... 9

5.11 Device Variable 10 Case Temperature ............................................................................... 9

Page 86: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Deltacon HART Manual

109347.00/ 270616 3

6. Dynamic Variables ...........................................................................................................................9

6.1 Mappable Variables .............................................................................................................9

6.2 PV Transfer Functions .......................................................................................................10

7. Status Information ..........................................................................................................................11

7.1 Field Device Status ............................................................................................................11

7.2 Extended Device Status .....................................................................................................11

7.3 Additional Device Status (Command #48) ........................................................................12

8. Universal Commands .....................................................................................................................14

9. Common-Practice Commands .......................................................................................................16

9.1 Supported Common Practice Commands ..........................................................................16

9.2 Burst Mode .........................................................................................................................16

9.3 Catch Device Variable .......................................................................................................16

10. Device-Specific Commands ...........................................................................................................16

11. Tables 17

11.1 Engineering Type Unit Codes ............................................................................................17

11.2 Classification Type Unit Codes .........................................................................................17

12. Performance ...................................................................................................................................18

12.1 Sampling Rates ..................................................................................................................18

12.2 Power-Up ...........................................................................................................................18

12.3 Command Response Times................................................................................................18

12.4 Long Messages ...................................................................................................................18

12.5 Non-Volatile Memory ........................................................................................................18

12.6 Modes .................................................................................................................................18

12.7 Write Protection .................................................................................................................18

12.8 Damping .............................................................................................................................18

Annex A. Capability Checklist ...........................................................................................................19

Annex B. Default Configuration ........................................................................................................20

Annex C. Revision History ................................................................................................................21

Page 87: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Deltacon HART Manual

109347.00/ 270616 4

1. INTRODUCTION 1.1 Scope The SWAN Analytical Instruments model AMI Deltacon transmitter complies with HART Protocol Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering Unit Codes supported). The functionality of this Field Device is described sufficiently to allow its proper application in a process and its complete support in HART capable Host Applications.

1.2 Purpose This specification is designed to complement the AMI Deltacon manual by providing a complete description of this Field Device from a HART Communication perspective.

1.3 Who should use this document? The specification is designed to be a technical reference for HART capable Host Application Developers, System Integrators and knowledgeable End Users. It also provides functional specifications (e.g., commands and performance requirements) used during development, maintenance and testing. This document assumes the reader is familiar with HART Protocol requirements and terminology.

1.4 References HART Smart Communications Protocol Specification. HCF_SPEC-12. Available from the HCF.

MenAMI_DeltaconPower _xx.pdf / MenAMI_DeltaconDG_xx.pdf Available from the SWAN Analytical Instruments web page.

Page 88: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Deltacon HART Manual

109347.00/ 270616 5

2. DEVICE IDENTIFICATION Manufacturer Name: SWAN Analytical

Instruments Model Name(s): AMI Deltacon

Manufacture ID Code: 24757 (60B5 Hex)

Device Type Code:

58151 (E327 Hex)

HART Protocol Revision 7.5 Device Revision: 1

Number of Device Variables 11

Physical Layers Supported FSK

Physical Device Category Transmitter, Non-DC-isolated Bus Device

3. PRODUCT OVERVIEW The AMI Deltacon HART communication option board provides a 4 to 20mA output signal and can be monitored and configured using a HART master device or a hand-held communicator.

3.1 Connections 3.1.1 Point to point Mode

An external minimum 250 Ω (maximum 800 Ω) resistor is needed in order to communicate with HART protocol.

Page 89: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Deltacon HART Manual

109347.00/ 270616 6

3.1.2 Multidrop Mode

A single minimum 250 Ω resistor (maximum 800 Ω) is needed to communicate with all the instruments connected to the bus, and each of them must provide 4mA.

3.1.3 HARTREC Board

The HARTREC Board must be installed in the AMI transmitter in order to communicate with HART.

Page 90: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Deltacon HART Manual

109347.00/ 270616 7

4. PRODUCT INTERFACES 4.1 Process Interface 4.1.1 Sensor Input Channels Refer to AMI Deltacon manual to details on mounting Conductivity and Flow sensors.

4.2 Host Interface 4.2.1 Process Specific Conductivity The 4 to 20mA output of the AMI Deltacon HART option board represents a process value measurement, scaled according to the configured range of the instrument. This output corresponds to the Primary Variable. HART Communication is supported on this loop.

Since Dynamic Variables are mappable, PV can correspond to one of the following variables:

- Specific Conductivity (sc)

- Cation Conductivity (cc)

- Degassed Conductivity (dc)

- First Temperature

- Second Temperature

- Third Temperature

- Conductivity difference

- Main Flow

- First Calculated Value (pH)

- Second Calculated Value (Ammonium)

It is also possible to set the PV from the instrument local display, in the “Signal Output 3 / Parameter” settings.

4.3 Local Interfaces 4.3.1 Local Controls and Displays This device has a local display that allows the complete configurability of the instrument.

Refer to AMI Deltacon manual to details on it.

4.3.2 Write Protection The Field Device has no “Write protection mode”.

Page 91: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Deltacon HART Manual

109347.00/ 270616 8

5. DEVICE VARIABLES This Field Device exposes 11 Device Variables.

Device Variables Variables Meaning Units 0 Specific Conductivity (sc) uS/cm

1 Cation Conductivity (cc) uS/cm

2 Degassed Conductivity (dc) uS/cm

3 First Temperature °C

4 Second Temperature °C

5 Third Temperature °C

6 Conductivity Difference uS/cm

7 Main Flow l/h

8 First Calculated Value (pH) pH

9 Second Calculated Value (Ammonium) ppm

10 Case Temperature °C

5.1 Device Variable 0 Specific Conductivity (sc) Specific Conductivity is read by Specific Conductivity-1 P

stP Temperature sensors (Refer to AMI

Deltacon manual to details on it).

5.2 Device Variable 1 Cation Conductivity (cc) Cation Conductivity is read by Cation Conductivity-2 P

ndP Temperature sensors (Refer to AMI Deltacon

manual to details on it).

5.3 Device Variable 2 Degassed Conductivity (dc) Degassed Conductivity is read by Degassed Conductivity-3 P

rdP Temperature sensors (Refer to AMI

Deltacon manual to details on it).

5.4 Device Variable 3 First Temperature First Temperature is read by Specific Conductivity -1P

stP Temperature sensors (Refer to AMI Deltacon

manual to details on it).

5.5 Device Variable 4 Second Temperature Second Temperature is read by Cation Conductivity -2 P

ndP Temperature sensors (Refer to AMI

Deltacon manual to details on it).

Page 92: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Deltacon HART Manual

109347.00/ 270616 9

5.6 Device Variable 5 Third Temperature Third Temperature is read by Degassed Conductivity–3 P

rdP Temperature sensors (Refer to AMI

Deltacon manual to details on it).

5.7 Device Variable 6 Conductivity Difference Conductivity Difference is calculated starting from Specific and Cation Conductivity sensor (Refer to AMI Deltacon manual to details on it).

5.8 Device Variable 7 Main Flow Main Flow is read by the flow rate sensor (Refer to AMI Deltacon manual to details on it).

5.9 Device Variable 8 First Calculated Value (pH) pH is calculated starting from Specific Conductivity-1 P

stP Temperature and Cation Conductivity-2 P

ndP

Temperature sensors (Refer to AMI Deltacon manual to details on it).

5.10 Device Variable 9 Second Calculated Value (Ammonium) Ammonium is calculated starting from Specific Conductivity-1P

stP Temperature and Cation

Conductivity-2P

ndP Temperature sensors (Refer to AMI Deltacon manual to details on it).

5.11 Device Variable 10 Case Temperature Case Temperature shows the Temperature read inside the Electronic Box.

6. DYNAMIC VARIABLES 6.1 Mappable Variables Four mappable Dynamic Variables are implemented.

Dynamic Variables Variables Meaning Units

PV

Spec. Cond. – Cat. Cond. – Deg. Cond. – 1P

stP

Temp – 2 P

ndP Temp – 3 P

rdP Temp – Cond. Diff. –

Main Flow – pH – Ammonium

uS/cm - uS/cm - uS/cm -°C –°C –°C – uS/cm - l/h – pH

– ppm

SV

Spec. Cond. – Cat. Cond. – Deg. Cond. – 1P

stP

Temp – 2P

ndP Temp – 3P

rdP Temp – Cond. Diff. –

Main Flow – pH – Ammonium

uS/cm - uS/cm - uS/cm -°C –°C –°C – uS/cm - l/h – pH – ppm

TV

Spec. Cond. – Cat. Cond. – Deg. Cond. – 1P

stP

Temp – 2P

ndP Temp – 3P

rdP Temp – Cond. Diff. –

Main Flow – pH – Ammonium

uS/cm - uS/cm - uS/cm -°C –°C –°C – uS/cm - l/h – pH – ppm

QV

Spec. Cond. – Cat. Cond. – Deg. Cond. – 1P

stP

Temp – 2P

ndP Temp – 3P

rdP Temp – Cond. Diff. –

Main Flow – pH – Ammonium

uS/cm - uS/cm - uS/cm -°C –°C –°C – uS/cm - l/h – pH – ppm

Page 93: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Deltacon HART Manual

109347.00/ 270616 10

It is possible to associate any of these dynamic variables to PV, SV, TV or QV with a HART Master (or Handheld Communicator).

The PV is also settable from the instrument local display’s settings.

6.2 PV Transfer Functions The Primary Variable Transfer Function can be read with command 15. Its meaning is referred to the following table.

Transfer Function Type Code

Linear 240

Bilinear 241

Logarithmic 242

Control Upwards 243

Control Downwards 244

Page 94: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Deltacon HART Manual

109347.00/ 270616 11

7. STATUS INFORMATION 7.1 Field Device Status The functions of the Field Device Status bits are specified in HCF_SPEC-99. Further details of their implementation are described in the following table.

Bit Name Notes

7 Device Malfunction Set on any detected Hardware Error

6 Configuration Changed Set if any changes are made to Field Device Configuration

5 Cold Start Set when powered-up or after a device reset

4 More Status Available Set if any Alarm or Maintenance has changed its status. More information is available via cmd 48

3 Loop Current Fixed The Loop Current is being held at a fixed value and is not responding to process variations

2 Loop Current Saturated The Loop Current has reached its upper (or lower) endpoint limit and cannot increase (or decrease) any further

1 Non-PV Out of Limits A Device Variable not mapped to the PV is beyond its

operating limits

0 PV Out of Limits The PV is beyond its operating limit

7.2 Extended Device Status Contains additional information regarding the status of the Field Device.

Bit Name Notes

2 Critical Power Failure Set when battery is becoming critically low (less than 15 min) and Field Device not connected to Power Supply

1 Device Variable Alert

Set when one or more Device Variables are in one of the following conditions:

• Hi/low limited (Limit Status)

• Bad (Process Data Status)

• Poor Accuracy (Process Data Status)

0 Maintenance Required Not Used

Page 95: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Deltacon HART Manual

109347.00/ 270616 12

7.3 Additional Device Status (Command #48) Command #48 returns 10 additional bytes of data (Int32 or Int16 Little Endian), with the following status information:

(ALARMS-MAINTENANCE CODES)

Byte Bit Meaning Code

0-3 (INT32)

0 Cond. 1 Alarm high E001 1 Cond. 1 Alarm low E002 2 Cond. 2 Alarm high E003 3 Cond. 2 Alarm low E004 4 Cond. 3 Alarm high E005 5 Cond. 3 Alarm low E006 6 Temp. 1 high E007 7 Temp. 1 low E008 8 Sample Flow high E009 9 Sample Flow low E010 10 Temp.1 shorted E011 11 Temp.1 disconnected E012 12 Case Temp. high E013 13 Case Temp. low E014 14 pH Calculation undef. E015 15 Degasser Frontend E016 16 Control Timeout E017 17 Degasser disconnected E018 18 Temp.2 shorted E019 19 Temp.2 disconnected E020 20 Temp.3 shorted E021 21 Temp.3 disconnected E022 22 Degasser Ctl Timeout E023 23 Input active E024 24 IC MK41T56 E025 25 IC LM75 E026 26 IC PCF8574 E027 27 Signal output open E028 28 Calibration Degasser E029 29 EEProm Frontend E030 30 Calibration Recout E031 31 Wrong Frontend E032

Page 96: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Deltacon HART Manual

109347.00/ 270616 13

4-5 (INT16)

0 Reserved

1 Reserved 2 Resin depleted E067 3 Reserved 4 Reserved 5 Reserved 6 Reserved 7 Reserved 8 Reserved 9 Reserved 10 Reserved 11 Reserved 12 Reserved 13 Reserved 14 Reserved 15 Reserved

14-17 (INT32)

0 pH Alarm high E033 1 pH Alarm low E034 2 Alk. Alarm high E035 3 Alk. Alarm low E036 4 Temp. 2 high E037 5 Temp. 2 low E038 6 Temp. 3 high E039 7 Temp. 3 low E040 8 Degasser Line Voltage E041

9 Degasser Temp. Shorted E042

10 Reserved 11 Reserved 12 Reserved 13 Reserved 14 Reserved 15 Quality Assurance E048

16-31 Reserved "Reserved" bits are always set to 0.

All bits used in these bytes indicate device/sensor failure or maintenances, and always set bit 4 of the Device Status byte.

Page 97: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Deltacon HART Manual

109347.00/ 270616 14

8. UNIVERSAL COMMANDS Number Name Notes

0 Read Unique Identifier Returns identity information of the Field Device

1 Read Primary Variable Returns PV value and its unit

2 Read Loop Current and Percent of Range Returns AO value and % range

3 Read Dynamic Variables and Loop Current Returns PV, SV, TV and QV values and corresponding unit values along with AO value

6 Write Polling Address Changes Field Device’s polling address and loop current mode

7 Read Loop Configuration Returns polling address and loop current mode status

8 Read Dynamic Variable Classifications Returns dynamic variables classification

9 Read Device Variables with Status Returns device variables with status

11 Read Unique Identifier Associated With Tag Same response as command 0 when Tag matches

12 Read Message Returns 24 bytes of packed ASCII data

13 Read Tag, Descriptor, Date Returns tag, descriptor (packed ASCII format) and date from the device

14 Read Primary Variable Transducer Information Returns PV transducer limits and span

15 Read Device Information Returns PV unit value, LRV, URV, damping value and write protect code

16 Read Final Assembly Number Returns final assembly number

17 Write Message Write 24 bytes of packed ASCII data.

18 Write Tag, Descriptor, Date Writes tag, descriptor (packed ASCII format) and date to the device

19 Write Final Assembly Number Writes final assembly number

Page 98: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Deltacon HART Manual

109347.00/ 270616 15

to the device

20 Read Long Tag Returns 32-byte Long Tag

21 Read Unique Identifier Associated with Long Tag Same response as command 0 when Long Tag matches

22 Write Long Tag Writes Long Tag to the Field Device

38 Reset Configuration Changed Flag Resets the configuration change flag

48 Read Additional Device Status See 7.3 for details

Page 99: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Deltacon HART Manual

109347.00/ 270616 16

9. COMMON-PRACTICE COMMANDS

9.1 Supported Common Practice Commands

9.2 Burst Mode This Field Device does not support Burst Mode.

9.3 Catch Device Variable This Field Device does not support Catch Device Variable.

10. DEVICE-SPECIFIC COMMANDS This Field Device does not support Device Specific Commands.

Number Name Notes

33 Read Device Variables Returns all the Supported Device Variables

50 Read Dynamic Variable Assignment Returns the Variable Numbers associated with PV, SV,TV and QV

51 Write Dynamic Variable Assignment Writes the Variable Numbers associated with PV, SV,TV and QV

Page 100: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Deltacon HART Manual

109347.00/ 270616 17

11. TABLES 11.1 Engineering Type Unit Codes

Units of Measurement Unit Code Temperature Degrees Celsius 32 Electric Potential millivolts 36 Electric Resistance Ω 37 Miscellaneous Hertz 38 Electric Current milliamperes 39 Time Minutes 50 Time Seconds 51 Time Hours 52 Time Days 53 Miscellaneous Percent 57 Electric Potential Volts 58 Miscellaneous pH 59 Miscellaneous Micro Siemens per centimeter 67 Flow Liters per hour 138 Concentration Parts per million 139 Electric Resistance kΩ 163 Concentration Parts per billion 169 Not used 250 Special 253

11.2 Classification Type Unit Codes Measurement Meas. Code Temperature 64 Volumetric flow 66 Time 70 Frequency 80 Analytical 81 Electric Potential 83 Current 84 Resistance 85 Conductance 87 Concentration 90 Turbidity 97 Not used 250 Special 253

Page 101: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Deltacon HART Manual

109347.00/ 270616 18

12. PERFORMANCE 12.1 Sampling Rates Typical sampling rates are shown in the following table.

Conductivity (Specific, Cation and Degassed) sensor value sample 1 per second

Temperature (1 P

stP, 2 P

ndP and 3 P

rdP ) sensors value sample 1 per second

Flow rate sensor value sample 1 per second

Case Temperature sensor sample 1 per second

Note: all the Device Variables use an Infinite Impulse Response Filter, with coefficients depending on the measured variable. The Damping Value is different for each of the Device Variables, and can be read through Command 15.

12.2 Power-Up On power up, the transmitter takes approximately 10 seconds to be ready. During this period, the device will not respond to HART commands.

12.3 Command Response Times

Minimum 2ms

Typical 5ms

Maximum 150ms

12.4 Long Messages The largest data field used is in the response to Command 9: up to 71 bytes including the two status bytes.

12.5 Non-Volatile Memory EEPROM is used to hold the device’s configuration parameters. New data is written to this memory immediately on execution of a write command, before the consequent response.

12.6 Modes Loop current mode can be disabled or enabled using command 6.

12.7 Write Protection Write-protection is not selectable, and is always set as “not write protected”.

12.8 Damping Damping time is calculated for each dynamic variable.

Page 102: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Deltacon HART Manual

109347.00/ 270616 19

ANNEX A. CAPABILITY CHECKLIST

Manufacturer, model and revision SWAN Analytic Instruments, AMI Deltacon rev. 1

Device type Transmitter

HART revision 7.x

Device Description available Yes

Number and type of sensors 8 (seven external, one internal)

Number and type of actuators 0

Number and type of host side signals 1: 4 - 20mA analog

Number of Device Variables 11

Number of Dynamic Variables 4

Mappable Dynamic Variables? Yes

Number of common-practice commands 3

Number of device-specific commands 0

Bits of additional device status 80

Alternative operating modes? No

Burst mode? No

Write-protection? No

Page 103: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Deltacon HART Manual

109347.00/ 270616 20

ANNEX B. DEFAULT CONFIGURATION

Parameter Default value

PV Sensor Type Specific Conductivity

Lower Range Value 0 uS/cm

Upper Range Value 3000 uS/cm

PV Units uS/cm

Damping time constant 3.184 seconds

Fault-indication jumper Not used

Write-protect jumper Not used

Number of response preambles 5

Page 104: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Deltacon HART Manual

109347.00/ 270616 21

ANNEX C. REVISION HISTORY

Document Title HART Interface Description AMI Deltacon

Document ID 109347.00

Document Revision

Date Device Revision DD Revision Description

1.0 27/06/2016 1 1 First release, for HART 7.x Device

Page 105: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments

HART® 7.x Field Device Specification for AMI Hydrogen Transmitters

SWAN Analytical Instruments 8340, Studbachstrasse 13

Hinwil Switzerland

Page 106: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Hydrogen HART Manual

109356.00 / 280616 2

TABLE OF CONTENTS

1. Introduction ......................................................................................................................................4

1.1 Scope ....................................................................................................................................4

1.2 Purpose .................................................................................................................................4

1.3 Who should use this document? ..........................................................................................4

1.4 References ............................................................................................................................4

2. Device Identification ........................................................................................................................5

3. Product Overview ............................................................................................................................5

3.1 Connections..........................................................................................................................5

3.1.1 Point to point Mode ..............................................................................................5

3.1.2 Multidrop Mode ....................................................................................................6

3.1.3 HARTREC Board .................................................................................................6

4. Product Interfaces ............................................................................................................................7

4.1 Process Interface ..................................................................................................................7

4.1.1 Sensor Input Channels ..........................................................................................7

4.2 Process Flow Rate 4-20mA Analog Output .........................................................................7

4.3 Local Interfaces ....................................................................................................................7

4.3.1 Local Controls and Displays .................................................................................7

4.3.2 Write Protection ....................................................................................................7

5. Device Variables ..............................................................................................................................8

5.1 Device Variable 0 Hydrogen ................................................................................................8

5.2 Device Variable 1 Temperature ...........................................................................................8

5.3 Device Variable 2 Flow Rate ...............................................................................................8

5.4 Device Variable 3 Saturation ...............................................................................................8

5.5 Device Variable 4 Case Temperature ..................................................................................8

6. Dynamic Variables ...........................................................................................................................9

6.1 Mappable Variables .............................................................................................................9

6.2 PV Transfer Functions .........................................................................................................9

7. Status Information ..........................................................................................................................10

7.1 Field Device Status ............................................................................................................10

Page 107: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Hydrogen HART Manual

109356.00 / 280616 3

7.2 Extended Device Status .....................................................................................................10

7.3 Additional Device Status (Command #48) ........................................................................11

8. Universal Commands .....................................................................................................................13

9. Common-Practice Commands .......................................................................................................15

9.1 Supported Common Practice Commands ..........................................................................15

9.2 Burst Mode .........................................................................................................................15

9.3 Catch Device Variable .......................................................................................................15

10. Device-Specific Commands ...........................................................................................................15

11. Tables 16

11.1 Engineering Type Unit Codes ............................................................................................16

11.2 Classification Type Unit Codes .........................................................................................16

12. Performance ...................................................................................................................................17

12.1 Sampling Rates ..................................................................................................................17

12.2 Power-Up ...........................................................................................................................17

12.3 Command Response Times................................................................................................17

12.4 Long Messages ...................................................................................................................17

12.5 Non-Volatile Memory ........................................................................................................17

12.6 Modes .................................................................................................................................17

12.7 Write Protection .................................................................................................................17

12.8 Damping .............................................................................................................................17

Annex A. Capability Checklist ...........................................................................................................18

Annex B. Default Configuration ........................................................................................................19

Annex C. Revision History ................................................................................................................20

Page 108: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Hydrogen HART Manual

109356.00 / 280616 4

1. INTRODUCTION 1.1 Scope The SWAN Analytical Instruments model AMI Hydrogen transmitter complies with HART Protocol Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering Unit Codes supported). The functionality of this Field Device is described sufficiently to allow its proper application in a process and its complete support in HART capable Host Applications.

1.2 Purpose This specification is designed to complement the AMI Hydrogen manual by providing a complete description of this Field Device from a HART Communication perspective.

1.3 Who should use this document? The specification is designed to be a technical reference for HART capable Host Application Developers, System Integrators and knowledgeable End Users. It also provides functional specifications (e.g., commands and performance requirements) used during development, maintenance and testing. This document assumes the reader is familiar with HART Protocol requirements and terminology.

1.4 References HART Smart Communications Protocol Specification. HCF_SPEC-12. Available from the HCF.

MenAMI_Hydrogen_xx.pdf. Available from the SWAN Analytical Instruments web page.

Page 109: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Hydrogen HART Manual

109356.00 / 280616 5

2. DEVICE IDENTIFICATION Manufacturer Name: SWAN Analytical

Instruments Model Name(s): AMI Hydrogen

Manufacture ID Code: 24757 (60B5 Hex)

Device Type Code:

58183 (E347 Hex)

HART Protocol Revision 7.5 Device Revision: 1

Number of Device Variables 5

Physical Layers Supported FSK

Physical Device Category Transmitter, Non-DC-isolated Bus Device

3. PRODUCT OVERVIEW The AMI Hydrogen HART communication option board provides a 4 to 20mA output signal and can be monitored and configured using a HART master device or a hand-held communicator.

3.1 Connections 3.1.1 Point to point Mode

An external minimum 250 Ω (maximum 800 Ω) resistor is needed in order to communicate with HART protocol.

Page 110: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Hydrogen HART Manual

109356.00 / 280616 6

3.1.2 Multidrop Mode

A single minimum 250 Ω resistor (maximum 800 Ω) is needed to communicate with all the instruments connected to the bus, and each of them must provide 4mA.

3.1.3 HARTREC Board

The HARTREC Board must be installed in the AMI transmitter in order to communicate with HART.

Page 111: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Hydrogen HART Manual

109356.00 / 280616 7

4. PRODUCT INTERFACES 4.1 Process Interface 4.1.1 Sensor Input Channels Refer to AMI Hydrogen manual to details on mounting external sensors.

4.2 Process Flow Rate 4-20mA Analog Output The 4 to 20mA output of the AMI Hydrogen HART option board represents a process value measurement, scaled according to the configured range of the instrument. This output corresponds to the Primary Variable. HART Communication is supported on this loop.

Since Dynamic Variables are mappable, PV can correspond to one of the following variables:

- Hydrogen

- Temperature

- Flow rate

- Saturation

It is also possible to set the PV from the instrument local display, in the “Signal Output 3 / Parameter” settings.

4.3 Local Interfaces 4.3.1 Local Controls and Displays This device has a local display that allows the complete configurability of the instrument.

Refer to AMI Hydrogen manual to details on it.

4.3.2 Write Protection The Field Device has no “Write protection mode”.

Page 112: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Hydrogen HART Manual

109356.00 / 280616 8

5. DEVICE VARIABLES This Field Device exposes five Device Variables

Device Variables Variables Meaning Units 0 Hydrogen ppb

1 Temperature °C

2 Flow Rate l/h

3 Saturation %

4 Case Temperature °C

5.1 Device Variable 0 Hydrogen The Hydrogen is read by the Hydrogen sensor (Refer to AMI Hydrogen manual to details on it).

5.2 Device Variable 1 Temperature Temperature is read by the temperature sensor inside the Temperature sensor (Refer to AMI Hydrogen manual to details on it).

5.3 Device Variable 2 Flow Rate Flow Rate is read by the Flow sensor (Refer to AMI Hydrogen manual to details on it).

5.4 Device Variable 3 Saturation Saturation is calculated with air pressure and Hydrogen.

5.5 Device Variable 4 Case Temperature Case Temperature shows the Temperature read inside the Electronic Box.

Page 113: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Hydrogen HART Manual

109356.00 / 280616 9

6. DYNAMIC VARIABLES 6.1 Mappable Variables Three mappable Dynamic Variables are implemented.

Dynamic Variables Variables Meaning Units

PV Hydrogen– Temperature – Flow Rate -

Saturation ppb - °C – l/h – %

SV Hydrogen– Temperature – Flow Rate -

Saturation ppb - °C – l/h – %

TV Hydrogen– Temperature – Flow Rate -

Saturation ppb - °C – l/h – %

QV Hydrogen– Temperature – Flow Rate -

Saturation ppb - °C – l/h – %

It is possible to associate any of these dynamic variables to PV, SV, TV or QV with a HART Master (or Handheld Communicator).

The PV is also settable from the instrument local display’s settings.

6.2 PV Transfer Functions The Primary Variable Transfer Function can be read with command 15. Its meaning is referred to the following table.

Transfer Function Type Code

Linear 240

Bilinear 241

Logarithmic 242

Control Upwards 243

Control Downwards 244

Page 114: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Hydrogen HART Manual

109356.00 / 280616 10

7. STATUS INFORMATION 7.1 Field Device Status The functions of the Field Device Status bits are specified in HCF_SPEC-99. Further details of their implementation are described in the following table.

Bit Name Notes

7 Device Malfunction Set on any detected Hardware Error

6 Configuration Changed Set if any changes are made to Field Device Configuration

5 Cold Start Set when powered-up or after a device reset

4 More Status Available Set if any Alarm or Maintenance has changed its status. More information is available via command 48

3 Loop Current Fixed The Loop Current is being held at a fixed value and is not responding to process variations

2 Loop Current Saturated The Loop Current has reached its upper (or lower) endpoint limit and cannot increase (or decrease) any further

1 Non-PV Out of Limits A Device Variable not mapped to the PV is beyond its

operating limits

0 PV Out of Limits The PV is beyond its operating limit

7.2 Extended Device Status Contains additional information regarding the status of the Field Device.

Bit Name Notes

2 Critical Power Failure Set when battery is becoming critically low (less than 15 min) and Field Device not connected to Power Supply

1 Device Variable Alert

Set when one or more Device Variables are in one of the following conditions:

• Hi/low limited (Limit Status)

• Bad (Process Data Status)

• Poor Accuracy (Process Data Status)

0 Maintenance Required Not Used

Page 115: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Hydrogen HART Manual

109356.00 / 280616 11

7.3 Additional Device Status (Command #48) Command #48 returns 6 additional bytes of data (Int32 or Int16 Little Endian), with the following status information:

ALARMS CODES:

Byte Bit Meaning Alarm Code

0 – 3

(INT32)

0 Hydrogen Alarm high E001 1 Hydrogen Alarm low E002 2 Saturation Alarm high E003 3 Saturation Alarm low E004 4 Reserved 5 Reserved 6 Sample Temp. high E007 7 Sample Temp. low E008 8 Sample Flow high E009 9 Sample Flow low E010 10 Temp. shorted E011 11 Temp. disconnected E012 12 Case Temp. high E013 13 Case Temp. low E014 14 Reserved 15 Reserved 16 Control Timeout E017 17 Faraday Efficiency E018 18 Quality Assurance E019 19 Reserved 20 Reserved 21 Reserved 22 Reserved 23 Input active E024 24 IC MK41T56 E025 25 IC LM75 E026 26 IC PCF8574 E027 27 Signal output open E028 28 EEProm Motherboard E029 29 EEProm Frontend E030 30 Calibration Recout E031 31 Wrong Frontend E032

"Reserved" bits are always set to 0.

Page 116: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Hydrogen HART Manual

109356.00 / 280616 12

All bits used in this four bytes indicate device or sensor failure, and always set bit 4 of the Device Status byte.

MAINTENANCE CODES:

Byte Bit Meaning Alarm Code

4-5 (INT16)

0 Electrolyte depleted E065 1 Reserved 2 Reserved 3 Reserved 4 Reserved 5 Reserved 6 Reserved 7 Reserved 8 Reserved 9 Reserved

10 Reserved 11 Reserved 12 Reserved 13 Reserved 14 Reserved 15 Reserved

Page 117: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Hydrogen HART Manual

109356.00 / 280616 13

8. UNIVERSAL COMMANDS Number Name Notes

0 Read Unique Identifier Returns identity information of the Field Device

1 Read Primary Variable Returns PV value and its unit

2 Read Loop Current and Percent of Range Returns AO value and % range

3 Read Dynamic Variables and Loop Current Returns PV, SV, TV and QV values and corresponding unit values along with AO value

6 Write Polling Address Changes Field Device’s polling address and loop current mode

7 Read Loop Configuration Returns polling address and loop current mode status

8 Read Dynamic Variable Classifications Returns dynamic variables classification

9 Read Device Variables with Status Returns device variables with status

11 Read Unique Identifier Associated With Tag Same response as command 0 when Tag matches

12 Read Message Returns 24 bytes of packed ASCII data

13 Read Tag, Descriptor, Date Returns tag, descriptor (packed ASCII format) and date from the device

14 Read Primary Variable Transducer Information Returns PV transducer limits and span

15 Read Device Information Returns PV unit value, LRV, URV, damping value and write protect code

16 Read Final Assembly Number Returns final assembly number

17 Write Message Write 24 bytes of packed ASCII data.

18 Write Tag, Descriptor, Date Writes tag, descriptor (packed ASCII format) and date to the device

Page 118: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Hydrogen HART Manual

109356.00 / 280616 14

19 Write Final Assembly Number Writes final assembly number to the device

20 Read Long Tag Returns 32-byte Long Tag

21 Read Unique Identifier Associated with Long Tag Same response as command 0 when Long Tag matches

22 Write Long Tag Writes Long Tag to the Field Device

38 Reset Configuration Changed Flag Resets the configuration change flag

48 Read Additional Device Status See 7.3 for details

Page 119: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Hydrogen HART Manual

109356.00 / 280616 15

9. COMMON-PRACTICE COMMANDS

9.1 Supported Common Practice Commands

9.2 Burst Mode This Field Device does not support Burst Mode.

9.3 Catch Device Variable This Field Device does not support Catch Device Variable.

10. DEVICE-SPECIFIC COMMANDS This Field Device does not support Device Specific Commands.

Number Name Notes

33 Read Device Variables Returns all the Supported Device Variables

50 Read Dynamic Variable Assignment Returns the Variable Numbers associated with PV, SV,TV and QV

51 Write Dynamic Variable Assignment Writes the Variable Numbers associated with PV, SV,TV and QV

Page 120: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Hydrogen HART Manual

109356.00 / 280616 16

11. TABLES 11.1 Engineering Type Unit Codes Units of Measurement Unit Code Temperature Degrees Celsius 32 Electric Potential millivolts 36 Electric Resistance Ω 37 Miscellaneous Hertz 38 Electric Current milliamperes 39 Time Minutes 50 Time Seconds 51 Time Hours 52 Time Days 53 Miscellaneous Percent 57 Electric Potential Volts 58 Miscellaneous pH 59 Miscellaneous Micro Siemens per centimeter 67 Flow Liters per hour 138 Revolutions per minute 119 Concentration Parts per million 139 Electric Resistance kΩ 163 Concentration Parts per billion 169 Milligram per liter 170 Not used 250 Special 253

11.2 Classification Type Unit Codes Measurement Meas. Code Temperature 64 Volumetric flow 66 Time 70 Frequency 80 Analytical 81 Electric Potential 83 Current 84 Resistance 85 Conductance 87 Concentration 90 Turbidity 97 Not used 250 Special 253

Page 121: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Hydrogen HART Manual

109356.00 / 280616 17

12. PERFORMANCE 12.1 Sampling Rates Typical sampling rates are shown in the following table.

Hydrogen sensor value sample 1 per second

Temperature sensor value sample 1 per second

Flow rate sensor value sample 1 per second

Saturation value 1 per second

Case Temperature sensor sample 1 per second

Note: all the Device Variables use an Infinite Impulse Response Filter, with coefficients depending on the measured variable. The Damping Value is different for each of the Device Variables, and can be read through Command 15.

12.2 Power-Up On power up, the transmitter takes approximately 10 seconds to be ready. During this period, the device will not respond to HART commands.

12.3 Command Response Times

Minimum 2ms

Typical 5ms

Maximum 150ms

12.4 Long Messages The largest data field used is in the response to Command 9: up to 71 bytes including the two status bytes.

12.5 Non-Volatile Memory EEPROM is used to hold the device’s configuration parameters. New data is written to this memory immediately on execution of a write command, before the consequent response.

12.6 Modes Loop current mode can be disabled or enabled using command 6.

12.7 Write Protection Write-protection is not selectable, and is always set as “not write protected”.

12.8 Damping Damping time is calculated for each dynamic variable.

Page 122: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Hydrogen HART Manual

109356.00 / 280616 18

ANNEX A. CAPABILITY CHECKLIST

Manufacturer, model and revision SWAN Analytic Instruments, AMI Hydrogen rev. 1

Device type Transmitter

HART revision 7.x

Device Description available Yes

Number and type of sensors 5 (four external, one internal)

Number and type of actuators 0

Number and type of host side signals 1: 4 - 20mA analog

Number of Device Variables 5

Number of Dynamic Variables 4

Mappable Dynamic Variables? Yes

Number of common-practice commands 3

Number of device-specific commands 0

Bits of additional device status 48

Alternative operating modes? No

Burst mode? No

Write-protection? No

Page 123: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Hydrogen HART Manual

109356.00 / 280616 19

ANNEX B. DEFAULT CONFIGURATION

Parameter Default value

PV Sensor Type Hydrogen

Lower Range Value 0 ppb

Upper Range Value 20000 ppb

PV Units ppb

Damping time constant 1.59 seconds

Fault-indication jumper Not used

Write-protect jumper Not used

Number of response preambles 5

Page 124: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Hydrogen HART Manual

109356.00 / 280616 20

ANNEX C. REVISION HISTORY

Document Title HART Interface Description AMI Hydrogen

Document ID 109356.00

Document Revision

Date Device Revision DD Revision Description

1.0 28/06/2016 1 1 First release, for HART 7.x Device

Page 125: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments

HART® 7.x Field Device Specification for AMI Inducon Transmitters

SWAN Analytical Instruments 8340, Studbachstrasse 13

Hinwil Switzerland

Page 126: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Inducon HART Manual

109357.00 / 080416 2

TABLE OF CONTENTS

1. Introduction ......................................................................................................................................4

1.1 Scope ....................................................................................................................................4

1.2 Purpose .................................................................................................................................4

1.3 Who should use this document? ..........................................................................................4

1.4 References ............................................................................................................................4

2. Device Identification ........................................................................................................................5

3. Product Overview ............................................................................................................................5

3.1 Connections..........................................................................................................................5

3.1.1 Point to point Mode ..............................................................................................5

3.1.2 Multidrop Mode ....................................................................................................6

3.1.3 HARTREC Board .................................................................................................6

4. Product Interfaces ............................................................................................................................7

4.1 Process Interface ..................................................................................................................7

4.1.1 Sensor Input Channels ..........................................................................................7

4.2 Process Flow Rate 4-20mA Analog Output .........................................................................7

4.3 Local Interfaces ....................................................................................................................7

4.3.1 Local Controls and Displays .................................................................................7

4.3.2 Write Protection ....................................................................................................7

5. Device Variables ..............................................................................................................................8

5.1 Device Variable 0 Conductivity ...........................................................................................8

5.2 Device Variable 1 Temperature ...........................................................................................8

5.3 Device Variable 2 Flow Rate ...............................................................................................8

5.4 Device Variable 3 Uncompensated Conductivity ................................................................8

5.5 Device Variable 4 Concentration .........................................................................................8

5.6 Device Variable 5 Case Temperature ..................................................................................8

6. Dynamic Variables ...........................................................................................................................9

6.1 Mappable Variables .............................................................................................................9

6.2 PV Transfer Functions .........................................................................................................9

7. Status Information ..........................................................................................................................10

Page 127: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Inducon HART Manual

109357.00 / 080416 3

7.1 Field Device Status ............................................................................................................10

7.2 Extended Device Status .....................................................................................................10

7.3 Additional Device Status (Command #48) ........................................................................11

8. Universal Commands .....................................................................................................................13

9. Common-Practice Commands .......................................................................................................15

9.1 Supported Common Practice Commands ..........................................................................15

9.2 Burst Mode .........................................................................................................................15

9.3 Catch Device Variable .......................................................................................................15

10. Device-Specific Commands ...........................................................................................................15

11. Tables 16

11.1 Engineering Type Unit Codes ............................................................................................16

11.2 Classification Type Unit Codes .........................................................................................16

12. Performance ...................................................................................................................................17

12.1 Sampling Rates ..................................................................................................................17

12.2 Power-Up ...........................................................................................................................17

12.3 Command Response Times................................................................................................17

12.4 Long Messages ...................................................................................................................17

12.5 Non-Volatile Memory ........................................................................................................17

12.6 Modes .................................................................................................................................17

12.7 Write Protection .................................................................................................................17

12.8 Damping .............................................................................................................................17

Annex A. Capability Checklist ...........................................................................................................18

Annex B. Default Configuration ........................................................................................................19

Annex C. Revision History ................................................................................................................20

Page 128: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Inducon HART Manual

109357.00 / 080416 4

1. INTRODUCTION 1.1 Scope The SWAN Analytical Instruments model AMI Inducon transmitter complies with HART Protocol Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering Unit Codes supported). The functionality of this Field Device is described sufficiently to allow its proper application in a process and its complete support in HART capable Host Applications.

1.2 Purpose This specification is designed to complement the AMI Inducon manual by providing a complete description of this Field Device from a HART Communication perspective.

1.3 Who should use this document? The specification is designed to be a technical reference for HART capable Host Application Developers, System Integrators and knowledgeable End Users. It also provides functional specifications (e.g., commands and performance requirements) used during development, maintenance and testing. This document assumes the reader is familiar with HART Protocol requirements and terminology.

1.4 References HART Smart Communications Protocol Specification. HCF_SPEC-12. Available from the HCF.

MenAMI_Inducon_xx.pdf. Available from the SWAN Analytical Instruments web page.

Page 129: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Inducon HART Manual

109357.00 / 080416 5

2. DEVICE IDENTIFICATION Manufacturer Name: SWAN Analytical

Instruments Model Name(s): AMI Inducon

Manufacture ID Code: 24757 (60B5 Hex)

Device Type Code:

58184 (E348 Hex)

HART Protocol Revision 7.5 Device Revision: 1

Number of Device Variables 5

Physical Layers Supported FSK

Physical Device Category Transmitter, Non-DC-isolated Bus Device

3. PRODUCT OVERVIEW The AMI Inducon HART communication option board provides a 4 to 20mA output signal and can be monitored and configured using a HART master device or a hand-held communicator.

3.1 Connections 3.1.1 Point to point Mode

An external minimum 250 Ω (maximum 800 Ω) resistor is needed in order to communicate with HART protocol.

Page 130: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Inducon HART Manual

109357.00 / 080416 6

3.1.2 Multidrop Mode

A single minimum 250 Ω resistor (maximum 800 Ω) is needed to communicate with all the instruments connected to the bus, and each of them must provide 4mA.

3.1.3 HARTREC Board

The HARTREC Board must be installed in the AMI transmitter in order to communicate with HART.

Page 131: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Inducon HART Manual

109357.00 / 080416 7

4. PRODUCT INTERFACES 4.1 Process Interface 4.1.1 Sensor Input Channels Refer to AMI Inducon manual to details on mounting external sensors.

4.2 Process Flow Rate 4-20mA Analog Output The 4 to 20mA output of the AMI Inducon HART option board represents a process value measurement, scaled according to the configured range of the instrument. This output corresponds to the Primary Variable. HART Communication is supported on this loop.

Since Dynamic Variables are mappable, PV can correspond to one of the following variables:

- Conductivity

- Temperature

- Flow rate

- Uncompensated Conductivity

- Concentration

It is also possible to set the PV from the instrument local display, in the “Signal Output 3 / Parameter” settings.

4.3 Local Interfaces 4.3.1 Local Controls and Displays This device has a local display that allows the complete configurability of the instrument.

Refer to AMI Inducon manual to details on it.

4.3.2 Write Protection The Field Device has no “Write protection mode”.

Page 132: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Inducon HART Manual

109357.00 / 080416 8

5. DEVICE VARIABLES This Field Device exposes five Device Variables

Device Variables Variables Meaning Units 0 Conductivity mS/cm

1 Temperature °C

2 Flow Rate l/h

3 Uncomp. Conductivity mS/cm

4 Concentration % OR mg/l

5 Case Temperature °C

5.1 Device Variable 0 Conductivity The Conductivity is read by the Conductivity sensor Swansensor Inducon1000 (Refer to AMI Inducon manual to details on it).

5.2 Device Variable 1 Temperature Temperature is read by the Conductivity sensor Swansensor Inducon1000 (Refer to AMI Inducon manual to details on it).

5.3 Device Variable 2 Flow Rate Flow Rate is read by the Flow sensor (Refer to AMI Inducon manual to details on it).

5.4 Device Variable 3 Uncompensated Conductivity Uncomp. Conductivity is read by the Conductivity sensor.

5.5 Device Variable 4 Concentration Concentration is calculated based on the conductivity (Refer to AMI Inducon manual to details on it).

5.6 Device Variable 5 Case Temperature Case Temperature shows the Temperature read inside the Electronic Box.

Page 133: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Inducon HART Manual

109357.00 / 080416 9

6. DYNAMIC VARIABLES 6.1 Mappable Variables Four mappable Dynamic Variables are implemented.

Dynamic Variables Variables Meaning Units

PV Conductivity – Temperature – Flow Rate –

Uncomp. Cond. - Concentration mS/cm - °C – l/h – mS/cm -

% OR mg/l

SV Conductivity – Temperature – Flow Rate –

Uncomp. Cond. - Concentration mS/cm - °C – l/h – mS/cm -

% OR mg/l

TV Conductivity – Temperature – Flow Rate –

Uncomp. Cond. - Concentration mS/cm - °C – l/h – mS/cm -

% OR mg/l

QV Conductivity – Temperature – Flow Rate –

Uncomp. Cond. - Concentration mS/cm - °C – l/h – mS/cm -

% OR mg/l

It is possible to associate any of these dynamic variables to PV, SV, TV or QV with a HART Master (or Handheld Communicator).

The PV is also settable from the instrument local display’s settings.

6.2 PV Transfer Functions The Primary Variable Transfer Function can be read with command 15. Its meaning is referred to the following table.

Transfer Function Type Code

Linear 240

Bilinear 241

Logarithmic 242

Control Upwards 243

Control Downwards 244

Page 134: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Inducon HART Manual

109357.00 / 080416 10

7. STATUS INFORMATION 7.1 Field Device Status The functions of the Field Device Status bits are specified in HCF_SPEC-99. Further details of their implementation are described in the following table.

Bit Name Notes

7 Device Malfunction Set on any detected Hardware Error

6 Configuration Changed Set if any changes are made to Field Device Configuration

5 Cold Start Set when powered-up or after a device reset

4 More Status Available Set if any Alarm or Maintenance has changed its status. More information is available via command 48

3 Loop Current Fixed The Loop Current is being held at a fixed value and is not responding to process variations

2 Loop Current Saturated The Loop Current has reached its upper (or lower) endpoint limit and cannot increase (or decrease) any further

1 Non-PV Out of Limits A Device Variable not mapped to the PV is beyond its

operating limits

0 PV Out of Limits The PV is beyond its operating limit

7.2 Extended Device Status Contains additional information regarding the status of the Field Device.

Bit Name Notes

2 Critical Power Failure Set when battery is becoming critically low (less than 15 min) and Field Device not connected to Power Supply

1 Device Variable Alert

Set when one or more Device Variables are in one of the following conditions:

• Hi/low limited (Limit Status)

• Bad (Process Data Status)

• Poor Accuracy (Process Data Status)

0 Maintenance Required Not Used

Page 135: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Inducon HART Manual

109357.00 / 080416 11

7.3 Additional Device Status (Command #48) Command #48 returns 6 additional bytes of data (Int32 or Int16 Little Endian), with the following status information:

ALARMS CODES:

Byte Bit Meaning Alarm Code

0 – 3

(INT32)

0 Cond. Alarm high E001 1 Cond. Alarm low E002 2 Conc. Alarm high E003 3 Conc. Alarm low E004 4 Reserved 5 Reserved 6 Sample Temp. high E007 7 Sample Temp. low E008 8 Sample Flow high E009 9 Sample Flow low E010 10 Temp. shorted E011 11 Temp. disconnected E012 12 Case Temp. high E013 13 Case Temp. low E014 14 Reserved 15 Reserved 16 Control Timeout E017 17 Temp. out of Table Range E018 18 Conc. out of Table Range E019 19 Reserved 20 Reserved 21 Reserved 22 Reserved 23 Input active E024 24 IC MK41T56 E025 25 IC LM75 E026 26 IC PCF8574 E027 27 Signal output open E028 28 EEProm Motherboard E029 29 EEProm Frontend E030 30 Calibration Recout E031 31 Wrong Frontend E032

"Reserved" bits are always set to 0.

Page 136: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Inducon HART Manual

109357.00 / 080416 12

All bits used in this four bytes indicate device or sensor failure, and always set bit 4 of the Device Status byte.

MAINTENANCE CODES:

Byte Bit Meaning Alarm Code

4-5 (INT16)

0 Photometer dirty E065 1 Filter congested E066 2 Reserved 3 Reserved 4 Reserved 5 Reserved 6 Reserved 7 Reserved 8 Reserved 9 Reserved

10 Reserved 11 Reserved 12 Reserved 13 Reserved 14 Reserved 15 Reserved

Page 137: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Inducon HART Manual

109357.00 / 080416 13

8. UNIVERSAL COMMANDS Number Name Notes

0 Read Unique Identifier Returns identity information of the Field Device

1 Read Primary Variable Returns PV value and its unit

2 Read Loop Current and Percent of Range Returns AO value and % range

3 Read Dynamic Variables and Loop Current Returns PV, SV, TV and QV values and corresponding unit values along with AO value

6 Write Polling Address Changes Field Device’s polling address and loop current mode

7 Read Loop Configuration Returns polling address and loop current mode status

8 Read Dynamic Variable Classifications Returns dynamic variables classification

9 Read Device Variables with Status Returns device variables with status

11 Read Unique Identifier Associated With Tag Same response as command 0 when Tag matches

12 Read Message Returns 24 bytes of packed ASCII data

13 Read Tag, Descriptor, Date Returns tag, descriptor (packed ASCII format) and date from the device

14 Read Primary Variable Transducer Information Returns PV transducer limits and span

15 Read Device Information Returns PV unit value, LRV, URV, damping value and write protect code

16 Read Final Assembly Number Returns final assembly number

17 Write Message Write 24 bytes of packed ASCII data.

18 Write Tag, Descriptor, Date Writes tag, descriptor (packed ASCII format) and date to the device

Page 138: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Inducon HART Manual

109357.00 / 080416 14

19 Write Final Assembly Number Writes final assembly number to the device

20 Read Long Tag Returns 32-byte Long Tag

21 Read Unique Identifier Associated with Long Tag Same response as command 0 when Long Tag matches

22 Write Long Tag Writes Long Tag to the Field Device

38 Reset Configuration Changed Flag Resets the configuration change flag

48 Read Additional Device Status See 7.3 for details

Page 139: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Inducon HART Manual

109357.00 / 080416 15

9. COMMON-PRACTICE COMMANDS

9.1 Supported Common Practice Commands

9.2 Burst Mode This Field Device does not support Burst Mode.

9.3 Catch Device Variable This Field Device does not support Catch Device Variable.

10. DEVICE-SPECIFIC COMMANDS This Field Device does not support Device Specific Commands.

Number Name Notes

33 Read Device Variables Returns all the Supported Device Variables

50 Read Dynamic Variable Assignment Returns the Variable Numbers associated with PV, SV,TV and QV

51 Write Dynamic Variable Assignment Writes the Variable Numbers associated with PV, SV,TV and QV

Page 140: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Inducon HART Manual

109357.00 / 080416 16

11. TABLES 11.1 Engineering Type Unit Codes Units of Measurement Unit Code Temperature Degrees Celsius 32 Electric Potential millivolts 36 Electric Resistance Ω 37 Miscellaneous Hertz 38 Electric Current milliamperes 39 Time Minutes 50 Time Seconds 51 Time Hours 52 Time Days 53 Miscellaneous Percent 57 Electric Potential Volts 58 Miscellaneous pH 59 Miscellaneous Milli Siemens per centimeter 66 Miscellaneous Micro Siemens per centimeter 67 Flow Liters per hour 138 Concentration Parts per million 139 Electric Resistance kΩ 163 Concentration Parts per billion 169 Milligram per liter 242 Not used 250

11.2 Classification Type Unit Codes Measurement Meas. Code Temperature 64 Volumetric flow 66 Time 70 Frequency 80 Analytical 81 Electric Potential 83 Current 84 Resistance 85 Conductance 87 Concentration 90 Turbidity 97 Not used 250 Special 253

Page 141: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Inducon HART Manual

109357.00 / 080416 17

12. PERFORMANCE 12.1 Sampling Rates Typical sampling rates are shown in the following table.

Conductivity sensor value sample 1 per second

Temperature sensor value sample 1 per second

Flow rate sensor value sample 1 per second

Uncompensated conductivity value sample 1 per second

Concentration 1 per second

Case Temperature sensor sample 1 per second

Note: all the Device Variables use an Infinite Impulse Response Filter, with coefficients depending on the measured variable. The Damping Value is different for each of the Device Variables, and can be read through Command 15.

12.2 Power-Up On power up, the transmitter takes approximately 10 seconds to be ready. During this period, the device will not respond to HART commands.

12.3 Command Response Times Minimum 2ms

Typical 5ms

Maximum 150ms

12.4 Long Messages The largest data field used is in the response to Command 9: up to 71 bytes including the two status bytes.

12.5 Non-Volatile Memory EEPROM is used to hold the device’s configuration parameters. New data is written to this memory immediately on execution of a write command, before the consequent response.

12.6 Modes Loop current mode can be disabled or enabled using command 6.

12.7 Write Protection Write-protection is not selectable, and is always set as “not write protected”.

12.8 Damping Damping time is calculated for each dynamic variable.

Page 142: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Inducon HART Manual

109357.00 / 080416 18

ANNEX A. CAPABILITY CHECKLIST

Manufacturer, model and revision SWAN Analytic Instruments, AMI Inducon rev. 1

Device type Transmitter

HART revision 7.x

Device Description available Yes

Number and type of sensors 4 (three external, one internal)

Number and type of actuators 0

Number and type of host side signals 1: 4 - 20mA analog

Number of Device Variables 6

Number of Dynamic Variables 4

Mappable Dynamic Variables? Yes

Number of common-practice commands 3

Number of device-specific commands 0

Bits of additional device status 48

Alternative operating modes? No

Burst mode? No

Write-protection? No

Page 143: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Inducon HART Manual

109357.00 / 080416 19

ANNEX B. DEFAULT CONFIGURATION

Parameter Default value

PV Sensor Type Conductivity

Lower Range Value 0 mS/cm

Upper Range Value 2000 uS/cm

PV Units mS/cm

Damping time constant 3.184 seconds

Fault-indication jumper Not used

Write-protect jumper Not used

Number of response preambles 5

Page 144: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Inducon HART Manual

109357.00 / 080416 20

ANNEX C. REVISION HISTORY

Document Title HART Interface Description AMI Inducon

Document ID 109357.00

Document Revision

Date Device Revision DD Revision Description

1.0 08/04/2016 1 1 First release, for HART 7.x Device

Page 145: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments

HART® 7.x Field Device Specification for AMI LineTOC Transmitters

SWAN Analytical Instruments 8340, Studbachstrasse 13

Hinwil Switzerland

Page 146: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI LineTOC HART Manual

109369.00 / 090816 2

TABLE OF CONTENTS

1. Introduction ......................................................................................................................................4

1.1 Scope ....................................................................................................................................4

1.2 Purpose .................................................................................................................................4

1.3 Who should use this document? ..........................................................................................4

1.4 References ............................................................................................................................4

2. Device Identification ........................................................................................................................5

3. Product Overview ............................................................................................................................5

3.1 Connections..........................................................................................................................5

3.1.1 Point to point Mode ..............................................................................................5

3.1.2 Multidrop Mode ....................................................................................................6

3.1.3 HARTREC Board .................................................................................................6

4. Product Interfaces ............................................................................................................................7

4.1 Process Interface ..................................................................................................................7

4.1.1 Sensor Input Channels ..........................................................................................7

4.2 Process Flow Rate 4-20mA Analog Output .........................................................................7

4.3 Local Interfaces ....................................................................................................................7

4.3.1 Local Controls and Displays .................................................................................7

4.3.2 Write Protection ....................................................................................................7

5. Device Variables ..............................................................................................................................8

5.1 Device Variable 0 Total Organic Carbon (TOC) .................................................................8

5.2 Device Variable 1 Conductivity 1 ........................................................................................8

5.3 Device Variable 2 Conductivity 2 ........................................................................................8

5.4 Device Variable 3 Temperature 1 ........................................................................................8

5.5 Device Variable 4 Temperature 2 ........................................................................................8

5.6 Device Variable 5 Concentration 1 ......................................................................................8

5.7 Device Variable 6 Concentration 2 ......................................................................................8

5.8 Device Variable 7 Case Temperature ..................................................................................8

6. Dynamic Variables ...........................................................................................................................9

6.1 Mappable Variables .............................................................................................................9

Page 147: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI LineTOC HART Manual

109369.00 / 090816 3

6.2 PV Transfer Functions .........................................................................................................9

7. Status Information ..........................................................................................................................10

7.1 Field Device Status ............................................................................................................10

7.2 Extended Device Status .....................................................................................................10

7.3 Additional Device Status (Command #48) ........................................................................11

8. Universal Commands .....................................................................................................................12

9. Common-Practice Commands .......................................................................................................14

9.1 Supported Common Practice Commands ..........................................................................14

9.2 Burst Mode .........................................................................................................................14

9.3 Catch Device Variable .......................................................................................................14

10. Device-Specific Commands ...........................................................................................................14

11. Tables 15

11.1 Engineering Type Unit Codes ............................................................................................15

11.2 Classification Type Unit Codes .........................................................................................15

12. Performance ...................................................................................................................................16

12.1 Sampling Rates ..................................................................................................................16

12.2 Power-Up ...........................................................................................................................16

12.3 Command Response Times................................................................................................16

12.4 Long Messages ...................................................................................................................16

12.5 Non-Volatile Memory ........................................................................................................16

12.6 Modes .................................................................................................................................16

12.7 Write Protection .................................................................................................................16

12.8 Damping .............................................................................................................................16

Annex A. Capability Checklist ...........................................................................................................17

Annex B. Default Configuration ........................................................................................................18

Annex C. Revision History ................................................................................................................19

Page 148: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI LineTOC HART Manual

109369.00 / 090816 4

1. INTRODUCTION 1.1 Scope The SWAN Analytical Instruments model AMI LineTOC transmitter complies with HART Protocol Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering Unit Codes supported). The functionality of this Field Device is described sufficiently to allow its proper application in a process and its complete support in HART capable Host Applications.

1.2 Purpose This specification is designed to complement the AMI LineTOC manual by providing a complete description of this Field Device from a HART Communication perspective.

1.3 Who should use this document? The specification is designed to be a technical reference for HART capable Host Application Developers, System Integrators and knowledgeable End Users. It also provides functional specifications (e.g., commands and performance requirements) used during development, maintenance and testing. This document assumes the reader is familiar with HART Protocol requirements and terminology.

1.4 References HART Smart Communications Protocol Specification. HCF_SPEC-12. Available from the HCF.

MenAMI_LineTOC_xx.pdf. Available from the SWAN Analytical Instruments web page.

Page 149: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI LineTOC HART Manual

109369.00 / 090816 5

2. DEVICE IDENTIFICATION Manufacturer Name: SWAN Analytical

Instruments Model Name(s): AMI LineTOC

Manufacture ID Code: 24757 (60B5 Hex)

Device Type Code:

58196 (E354 Hex)

HART Protocol Revision 7.5 Device Revision: 1

Number of Device Variables 8

Physical Layers Supported FSK

Physical Device Category Transmitter, Non-DC-isolated Bus Device

3. PRODUCT OVERVIEW The AMI LineTOC HART communication option board provides a 4 to 20mA output signal and can be monitored and configured using a HART master device or a hand-held communicator.

3.1 Connections 3.1.1 Point to point Mode

An external minimum 250 Ω (maximum 800 Ω) resistor is needed in order to communicate with HART protocol.

Page 150: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI LineTOC HART Manual

109369.00 / 090816 6

3.1.2 Multidrop Mode

A single minimum 250 Ω resistor (maximum 800 Ω) is needed to communicate with all the instruments connected to the bus, and each of them must provide 4mA.

3.1.3 HARTREC Board

The HARTREC Board must be installed in the AMI transmitter in order to communicate with HART.

Page 151: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI LineTOC HART Manual

109369.00 / 090816 7

4. PRODUCT INTERFACES 4.1 Process Interface 4.1.1 Sensor Input Channels Refer to AMI LineTOC manual to details on mounting external sensors.

4.2 Process Flow Rate 4-20mA Analog Output The 4 to 20mA output of the AMI LineTOC HART option board represents a process value measurement, scaled according to the configured range of the instrument. This output corresponds to the Primary Variable. HART Communication is supported on this loop.

Since Dynamic Variables are mappable, PV can correspond to one of the following variables:

- Total Organic Carbon (TOC)

- Conductivity 1

- Conductivity 2

- Temperature 1

- Temperature 2

- Concentration 1

- Concentration 2

It is also possible to set the PV from the instrument local display, in the “Signal Output 3 / Parameter” settings.

4.3 Local Interfaces 4.3.1 Local Controls and Displays This device has a local display that allows the complete configurability of the instrument.

Refer to AMI LineTOC manual to details on it.

4.3.2 Write Protection The Field Device has no “Write protection mode”.

Page 152: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI LineTOC HART Manual

109369.00 / 090816 8

5. DEVICE VARIABLES This Field Device exposes eight Device Variables

Device Variables Variables Meaning Units 0 Total Organic Carbon (TOC) ppb

1 Conductivity 1 uS/cm

2 Conductivity 2 uS/cm

3 Temperature 1 °C

4 Temperature 2 °C

5 Concentration 1 ppb

6 Concentration 2 ppb

7 Case Temperature °C

5.1 Device Variable 0 Total Organic Carbon (TOC) Total Organic Carbon is calculated by means of the conductivity sensor (Refer to AMI LineTOC manual to details on it).

5.2 Device Variable 1 Conductivity 1 Conductivity 1 is read by the conductivity sensor 1 (Refer to AMI LineTOC manual to details on it).

5.3 Device Variable 2 Conductivity 2 Conductivity 2 is read by the conductivity sensor 2 (Refer to AMI LineTOC manual to details on it).

5.4 Device Variable 3 Temperature 1 Temperature 1 is read by the temperature sensor inside Conductivity sensor 1.

5.5 Device Variable 4 Temperature 2 Temperature 2 is read by the temperature sensor inside Conductivity sensor 2.

5.6 Device Variable 5 Concentration 1 Concentration 1 is calculated by means of Conductivity 1 and Temperature 1.

5.7 Device Variable 6 Concentration 2 Concentration 2 is calculated by means of Conductivity 2 and Temperature 2.

5.8 Device Variable 7 Case Temperature Case Temperature shows the Temperature read inside the Electronic Box.

Page 153: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI LineTOC HART Manual

109369.00 / 090816 9

6. DYNAMIC VARIABLES 6.1 Mappable Variables Four mappable Dynamic Variables are implemented.

Dynamic Variables Variables Meaning Units

PV TOC– Cond 1– Cond 2 –Temp1 – Temp2 –

Conc1 – Conc2 Ppb – uS/cm – uS/cm - °C -

°C – ppb - ppb

SV TOC– Cond 1– Cond 2 –Temp1 – Temp2 –

Conc1 – Conc2 Ppb – uS/cm – uS/cm - °C -

°C – ppb - ppb

TV TOC– Cond 1– Cond 2 –Temp1 – Temp2 –

Conc1 – Conc2 Ppb – uS/cm – uS/cm - °C -

°C – ppb - ppb

QV TOC– Cond 1– Cond 2 –Temp1 – Temp2 –

Conc1 – Conc2 Ppb – uS/cm – uS/cm - °C -

°C – ppb - ppb

It is possible to associate any of these dynamic variables to PV, SV, TV or QV with a HART Master (or Handheld Communicator).

The PV is also settable from the instrument local display’s settings.

6.2 PV Transfer Functions The Primary Variable Transfer Function can be read with command 15. Its meaning is referred to the following table.

Transfer Function Type Code

Linear 240

Bilinear 241

Logarithmic 242

Control Upwards 243

Control Downwards 244

Page 154: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI LineTOC HART Manual

109369.00 / 090816 10

7. STATUS INFORMATION 7.1 Field Device Status The functions of the Field Device Status bits are specified in HCF_SPEC-99. Further details of their implementation are described in the following table.

Bit Name Notes

7 Device Malfunction Set on any detected Hardware Error

6 Configuration Changed Set if any changes are made to Field Device Configuration

5 Cold Start Set when powered-up or after a device reset

4 More Status Available Set if any Alarm or Maintenance has changed its status. More information is available via command 48

3 Loop Current Fixed The Loop Current is being held at a fixed value and is not responding to process variations

2 Loop Current Saturated The Loop Current has reached its upper (or lower) endpoint limit and cannot increase (or decrease) any further

1 Non-PV Out of Limits A Device Variable not mapped to the PV is beyond its

operating limits

0 PV Out of Limits The PV is beyond its operating limit

7.2 Extended Device Status Contains additional information regarding the status of the Field Device.

Bit Name Notes

2 Critical Power Failure Set when battery is becoming critically low (less than 15 min) and Field Device not connected to Power Supply

1 Device Variable Alert

Set when one or more Device Variables are in one of the following conditions:

• Hi/low limited (Limit Status)

• Bad (Process Data Status)

• Poor Accuracy (Process Data Status)

0 Maintenance Required Not Used

Page 155: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI LineTOC HART Manual

109369.00 / 090816 11

7.3 Additional Device Status (Command #48) Command #48 returns 10 additional bytes of data (Int32 or Int16 Little Endian), with the following status information:

ALARMS / MAINTENANCE CODES:

Byte Bit Meaning Alarm Code

0 – 3

(INT32)

0 TOC Alarm high E001 1 TOC Alarm low E002 2 Cond. 1 Alarm high E003 3 Cond. 1 Alarm low E004 4 Cond. 2 Alarm high E005 5 Cond. 2 Alarm low E006 6 Temp. 1 Alarm high E007 7 Temp. 1 Alarm low E008 8 Sample Flow high E009 9 Sample Flow low E010 10 Temp. 1 shorted E011 11 Temp. 1 disconnected E012 12 Case Temp. high E013 13 Case Temp. low E014 14 Lamp E015 15 Rovalve E016 16 Control Timeout E017 17 Periclip E018 18 Temp.2 shorted E019 19 Temp.2 disconnected E020 20 Temp. 2 Alarm high E021 21 Temp. 2 Alarm low E022 22 EVG E023 23 Input active E024 24 IC MK41T56 E025 25 IC LM75 E026 26 IC PCF8574 E027 27 Signal output open E028 28 EEProm Motherboard E029 29 EEProm Frontend E030 30 Calibration Recout E031 31 Wrong Frontend E032

Page 156: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI LineTOC HART Manual

109369.00 / 090816 12

"Reserved" bits are always set to 0.

Byte Bit Meaning Alarm Code

4-5

(INT16)

0 Photometer dirty E065 1 Filter congested E066 2 Reserved 3 Reserved 4 Reserved 5 Reserved 6 Reserved 7 Reserved 8 Reserved 9 Reserved

10 Reserved 11 Reserved 12 Reserved 13 Reserved 14 Reserved 15 Reserved

All bits used in this eight bytes indicate device or sensor failure, and always set bit 4 of the Device Status byte.

8. UNIVERSAL COMMANDS Number Name Notes

0 Read Unique Identifier Returns identity information of the Field Device

1 Read Primary Variable Returns PV value and its unit

2 Read Loop Current and Percent of Range Returns AO value and % range

3 Read Dynamic Variables and Loop Current Returns PV, SV, TV and QV values and corresponding unit values along with AO value

6 Write Polling Address Changes Field Device’s polling address and loop current mode

7 Read Loop Configuration Returns polling address and loop current mode status

8 Read Dynamic Variable Classifications Returns dynamic variables

Page 157: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI LineTOC HART Manual

109369.00 / 090816 13

classification

9 Read Device Variables with Status Returns device variables with status

11 Read Unique Identifier Associated With Tag Same response as command 0 when Tag matches

12 Read Message Returns 24 bytes of packed ASCII data

13 Read Tag, Descriptor, Date Returns tag, descriptor (packed ASCII format) and date from the device

14 Read Primary Variable Transducer Information Returns PV transducer limits and span

15 Read Device Information Returns PV unit value, LRV, URV, damping value and write protect code

16 Read Final Assembly Number Returns final assembly number

17 Write Message Write 24 bytes of packed ASCII data.

18 Write Tag, Descriptor, Date Writes tag, descriptor (packed ASCII format) and date to the device

19 Write Final Assembly Number Writes final assembly number to the device

20 Read Long Tag Returns 32-byte Long Tag

21 Read Unique Identifier Associated with Long Tag Same response as command 0 when Long Tag matches

22 Write Long Tag Writes Long Tag to the Field Device

38 Reset Configuration Changed Flag Resets the configuration change flag

48 Read Additional Device Status See 7.3 for details

Page 158: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI LineTOC HART Manual

109369.00 / 090816 14

9. COMMON-PRACTICE COMMANDS

9.1 Supported Common Practice Commands

9.2 Burst Mode This Field Device does not support Burst Mode.

9.3 Catch Device Variable This Field Device does not support Catch Device Variable.

10. DEVICE-SPECIFIC COMMANDS This Field Device does not support Device Specific Commands.

Number Name Notes

33 Read Device Variables Returns all the Supported Device Variables

50 Read Dynamic Variable Assignment Returns the Variable Numbers associated with PV, SV,TV and QV

51 Write Dynamic Variable Assignment Writes the Variable Numbers associated with PV, SV,TV and QV

Page 159: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI LineTOC HART Manual

109369.00 / 090816 15

11. TABLES 11.1 Engineering Type Unit Codes Units of Measurement Unit Code Temperature Degrees Celsius 32 Electric Potential millivolts 36 Electric Resistance Ω 37 Miscellaneous Hertz 38 Electric Current milliamperes 39 Time Minutes 50 Time Seconds 51 Time Hours 52 Time Days 53 Miscellaneous Percent 57 Electric Potential Volts 58 Miscellaneous pH 59 Miscellaneous Micro Siemens per centimeter 67 Flow Liters per hour 138 Concentration Parts per million 139 Electric Resistance kΩ 163 Concentration Parts per billion 169 Milligram per liter 170 Not used 250 Special 253

11.2 Classification Type Unit Codes Measurement Meas. Code Temperature 64 Volumetric flow 66 Time 70 Frequency 80 Analytical 81 Electric Potential 83 Current 84 Resistance 85 Conductance 87 Concentration 90 Turbidity 97 Not used 250 Special 253

Page 160: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI LineTOC HART Manual

109369.00 / 090816 16

12. PERFORMANCE 12.1 Sampling Rates Typical sampling rates are shown in the following table.

Conductivity sensor value sample 1 per second

Temperature sensor value sample 1 per second

Concentration 1 per second

Case Temperature sensor sample 1 per second

Note: all the Device Variables use an Infinite Impulse Response Filter, with coefficients depending on the measured variable. The Damping Value is different for each of the Device Variables, and can be read through Command 15.

12.2 Power-Up On power up, the transmitter takes approximately 10 seconds to be ready. During this period, the device will not respond to HART commands.

12.3 Command Response Times

Minimum 2ms

Typical 5ms

Maximum 150ms

12.4 Long Messages The largest data field used is in the response to Command 9: up to 71 bytes including the two status bytes.

12.5 Non-Volatile Memory EEPROM is used to hold the device’s configuration parameters. New data is written to this memory immediately on execution of a write command, before the consequent response.

12.6 Modes Loop current mode can be disabled or enabled using command 6.

12.7 Write Protection Write-protection is not selectable, and is always set as “not write protected”.

12.8 Damping Damping time is calculated for each dynamic variable.

Page 161: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI LineTOC HART Manual

109369.00 / 090816 17

ANNEX A. CAPABILITY CHECKLIST

Manufacturer, model and revision SWAN Analytic Instruments, AMI LineTOC rev. 1

Device type Transmitter

HART revision 7.x

Device Description available Yes

Number and type of sensors 4 (three external, one internal)

Number and type of actuators 0

Number and type of host side signals 1: 4 - 20mA analog

Number of Device Variables 8

Number of Dynamic Variables 4

Mappable Dynamic Variables? Yes

Number of common-practice commands 3

Number of device-specific commands 0

Bits of additional device status 80

Alternative operating modes? No

Burst mode? No

Write-protection? No

Page 162: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI LineTOC HART Manual

109369.00 / 090816 18

ANNEX B. DEFAULT CONFIGURATION

Parameter Default value

PV Sensor Type Conductivity

Lower Range Value 0 ppb

Upper Range Value 2000 ppb

PV Units ppb

Damping time constant 4.778 seconds

Fault-indication jumper Not used

Write-protect jumper Not used

Number of response preambles 5

Page 163: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI LineTOC HART Manual

109369.00 / 090816 19

ANNEX C. REVISION HISTORY

Document Title HART Interface Description AMI LineTOC

Document ID 109354.00

Document Revision

Date Device Revision DD Revision Description

1.0 09/08/2016 1 1 First release, for HART 7.x Device

Page 164: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments

HART® 7.x Field Device Specification for AMI Oxysafe Transmitters

SWAN Analytical Instruments 8340, Studbachstrasse 13

Hinwil Switzerland

Page 165: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Oxysafe HART Manual

109359.00 / 270616 2

TABLE OF CONTENTS

1. Introduction ......................................................................................................................................4

1.1 Scope ....................................................................................................................................4

1.2 Purpose .................................................................................................................................4

1.3 Who should use this document? ..........................................................................................4

1.4 References ............................................................................................................................4

2. Device Identification ........................................................................................................................5

3. Product Overview ............................................................................................................................5

3.1 Connections..........................................................................................................................5

3.1.1 Point to point Mode ..............................................................................................5

3.1.2 Multidrop Mode ....................................................................................................6

3.1.3 HARTREC Board .................................................................................................6

4. Product Interfaces ............................................................................................................................7

4.1 Process Interface ..................................................................................................................7

4.1.1 Sensor Input Channels ..........................................................................................7

4.2 Process Flow Rate 4-20mA Analog Output .........................................................................7

4.3 Local Interfaces ....................................................................................................................7

4.3.1 Local Controls and Displays .................................................................................7

4.3.2 Write Protection ....................................................................................................7

5. Device Variables ..............................................................................................................................8

5.1 Device Variable 0 Oxygen ...................................................................................................8

5.2 Device Variable 1 Temperature ...........................................................................................8

5.3 Device Variable 2 Flow Rate ...............................................................................................8

5.4 Device Variable 3 Saturation ...............................................................................................8

5.5 Device Variable 4 Case Temperature ..................................................................................8

6. Dynamic Variables ...........................................................................................................................9

6.1 Mappable Variables .............................................................................................................9

6.2 PV Transfer Functions .........................................................................................................9

7. Status Information ..........................................................................................................................10

7.1 Field Device Status ............................................................................................................10

Page 166: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Oxysafe HART Manual

109359.00 / 270616 3

7.2 Extended Device Status .....................................................................................................10

7.3 Additional Device Status (Command #48) ........................................................................11

8. Universal Commands .....................................................................................................................12

9. Common-Practice Commands .......................................................................................................14

9.1 Supported Common Practice Commands ..........................................................................14

9.2 Burst Mode .........................................................................................................................14

9.3 Catch Device Variable .......................................................................................................14

10. Device-Specific Commands ...........................................................................................................14

11. Tables 15

11.1 Engineering Type Unit Codes ............................................................................................15

11.2 Classification Type Unit Codes .........................................................................................15

12. Performance ...................................................................................................................................16

12.1 Sampling Rates ..................................................................................................................16

12.2 Power-Up ...........................................................................................................................16

12.3 Command Response Times................................................................................................16

12.4 Long Messages ...................................................................................................................16

12.5 Non-Volatile Memory ........................................................................................................16

12.6 Modes .................................................................................................................................16

12.7 Write Protection .................................................................................................................16

12.8 Damping .............................................................................................................................16

Annex A. Capability Checklist ...........................................................................................................17

Annex B. Default Configuration ........................................................................................................18

Annex C. Revision History ................................................................................................................19

Page 167: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Oxysafe HART Manual

109359.00 / 270616 4

1. INTRODUCTION 1.1 Scope The SWAN Analytical Instruments model AMI Oxysafe transmitter complies with HART Protocol Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering Unit Codes supported). The functionality of this Field Device is described sufficiently to allow its proper application in a process and its complete support in HART capable Host Applications.

1.2 Purpose This specification is designed to complement the AMI Oxysafe manual by providing a complete description of this Field Device from a HART Communication perspective.

1.3 Who should use this document? The specification is designed to be a technical reference for HART capable Host Application Developers, System Integrators and knowledgeable End Users. It also provides functional specifications (e.g., commands and performance requirements) used during development, maintenance and testing. This document assumes the reader is familiar with HART Protocol requirements and terminology.

1.4 References HART Smart Communications Protocol Specification. HCF_SPEC-12. Available from the HCF.

MenAMI_Oxysafe_xx.pdf. Available from the SWAN Analytical Instruments web page.

Page 168: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Oxysafe HART Manual

109359.00 / 270616 5

2. DEVICE IDENTIFICATION Manufacturer Name: SWAN Analytical

Instruments Model Name(s): AMI Oxysafe

Manufacture ID Code: 24757 (60B5 Hex)

Device Type Code:

58186 (E34A Hex)

HART Protocol Revision 7.5 Device Revision: 1

Number of Device Variables 5

Physical Layers Supported FSK

Physical Device Category Transmitter, Non-DC-isolated Bus Device

3. PRODUCT OVERVIEW The AMI Oxysafe HART communication option board provides a 4 to 20mA output signal and can be monitored and configured using a HART master device or a hand-held communicator.

3.1 Connections 3.1.1 Point to point Mode

An external minimum 250 Ω (maximum 800 Ω) resistor is needed in order to communicate with HART protocol.

Page 169: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Oxysafe HART Manual

109359.00 / 270616 6

3.1.2 Multidrop Mode

A single minimum 250 Ω resistor (maximum 800 Ω) is needed to communicate with all the instruments connected to the bus, and each of them must provide 4mA.

3.1.3 HARTREC Board

The HARTREC Board must be installed in the AMI transmitter in order to communicate with HART.

Page 170: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Oxysafe HART Manual

109359.00 / 270616 7

4. PRODUCT INTERFACES 4.1 Process Interface 4.1.1 Sensor Input Channels Refer to AMI Oxysafe manual to details on mounting external sensors.

4.2 Process Flow Rate 4-20mA Analog Output The 4 to 20mA output of the AMI Oxysafe HART option board represents a process value measurement, scaled according to the configured range of the instrument. This output corresponds to the Primary Variable. HART Communication is supported on this loop.

Since Dynamic Variables are mappable, PV can correspond to one of the following variables:

- Oxygen

- Temperature

- Flow rate

- Saturation

It is also possible to set the PV from the instrument local display, in the “Signal Output 3 / Parameter” settings.

4.3 Local Interfaces 4.3.1 Local Controls and Displays This device has a local display that allows the complete configurability of the instrument.

Refer to AMI Oxysafe manual to details on it.

4.3.2 Write Protection The Field Device has no “Write protection mode”.

Page 171: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Oxysafe HART Manual

109359.00 / 270616 8

5. DEVICE VARIABLES This Field Device exposes five Device Variables

Device Variables Variables Meaning Units 0 Oxygen ppm

1 Temperature °C

2 Flow Rate l/h

3 Saturation %

4 Case Temperature °C

5.1 Device Variable 0 Oxygen The Oxygen is read with Swansensor Oxysafe 1000 (Refer to AMI Oxysafe manual to details on it).

5.2 Device Variable 1 Temperature Temperature is read by the temperature sensor inside the Oxygen sensor (Refer to AMI Oxysafe manual to details on it).

5.3 Device Variable 2 Flow Rate Flow Rate is read by the Flow sensor (Refer to AMI Oxysafe manual to details on it).

5.4 Device Variable 3 Saturation Saturation is calculated with Swansensor Oxysafe 1000 (Refer to AMI Oxysafe manual to details on it).

5.5 Device Variable 4 Case Temperature Case Temperature shows the Temperature read inside the Electronic Box.

Page 172: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Oxysafe HART Manual

109359.00 / 270616 9

6. DYNAMIC VARIABLES 6.1 Mappable Variables Three mappable Dynamic Variables are implemented.

Dynamic Variables Variables Meaning Units

PV Oxygen – Temperature – Flow Rate -

Saturation ppm - °C – l/h – %

SV Oxygen – Temperature – Flow Rate -

Saturation ppm - °C – l/h – %

TV Oxygen – Temperature – Flow Rate -

Saturation ppm - °C – l/h – %

QV Oxygen – Temperature – Flow Rate -

Saturation ppm - °C – l/h – %

It is possible to associate any of these dynamic variables to PV, SV, TV or QV with a HART Master (or Handheld Communicator).

The PV is also settable from the instrument local display’s settings.

6.2 PV Transfer Functions The Primary Variable Transfer Function can be read with command 15. Its meaning is referred to the following table.

Transfer Function Type Code

Linear 240

Bilinear 241

Logarithmic 242

Control Upwards 243

Control Downwards 244

Page 173: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Oxysafe HART Manual

109359.00 / 270616 10

7. STATUS INFORMATION 7.1 Field Device Status The functions of the Field Device Status bits are specified in HCF_SPEC-99. Further details of their implementation are described in the following table.

Bit Name Notes

7 Device Malfunction Set on any detected Hardware Error

6 Configuration Changed Set if any changes are made to Field Device Configuration

5 Cold Start Set when powered-up or after a device reset

4 More Status Available Set if any Alarm or Maintenance has changed its status. More information is available via command 48

3 Loop Current Fixed The Loop Current is being held at a fixed value and is not responding to process variations

2 Loop Current Saturated The Loop Current has reached its upper (or lower) endpoint limit and cannot increase (or decrease) any further

1 Non-PV Out of Limits A Device Variable not mapped to the PV is beyond its

operating limits

0 PV Out of Limits The PV is beyond its operating limit

7.2 Extended Device Status Contains additional information regarding the status of the Field Device.

Bit Name Notes

2 Critical Power Failure Set when battery is becoming critically low (less than 15 min) and Field Device not connected to Power Supply

1 Device Variable Alert

Set when one or more Device Variables are in one of the following conditions:

• Hi/low limited (Limit Status)

• Bad (Process Data Status)

• Poor Accuracy (Process Data Status)

0 Maintenance Required Not Used

Page 174: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Oxysafe HART Manual

109359.00 / 270616 11

7.3 Additional Device Status (Command #48) Command #48 returns 4 additional bytes of data (Int32 or Int16 Little Endian), with the following status information:

ALARMS CODES:

Byte Bit Meaning Alarm Code

0 – 3

(INT32)

0 Oxygen Alarm high E001 1 Oxygen Alarm low E002 2 Saturation Alarm high E003 3 Saturation Alarm low E004 4 Reserved 5 Reserved 6 Sample Temp. high E007 7 Sample Temp. low E008 8 Sample Flow high E009 9 Sample Flow low E010 10 Temp. shorted E011 11 Temp. disconnected E012 12 Case Temp. high E013 13 Case Temp. low E014 14 Reserved 15 Reserved 16 Control Timeout E017 17 Reserved 18 Reserved 19 Reserved 20 Reserved 21 Reserved 22 Reserved 23 Input active E024 24 IC MK41T56 E025 25 IC LM75 E026 26 IC PCF8574 E027 27 Signal output open E028 28 EEProm Motherboard E029 29 EEProm Frontend E030 30 Calibration Recout E031 31 Wrong Frontend E032

"Reserved" bits are always set to 0.

Page 175: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Oxysafe HART Manual

109359.00 / 270616 12

All bits used in this four bytes indicate device or sensor failure, and always set bit 4 of the Device Status byte.

8. UNIVERSAL COMMANDS Number Name Notes

0 Read Unique Identifier Returns identity information of the Field Device

1 Read Primary Variable Returns PV value and its unit

2 Read Loop Current and Percent of Range Returns AO value and % range

3 Read Dynamic Variables and Loop Current Returns PV, SV, TV and QV values and corresponding unit values along with AO value

6 Write Polling Address Changes Field Device’s polling address and loop current mode

7 Read Loop Configuration Returns polling address and loop current mode status

8 Read Dynamic Variable Classifications Returns dynamic variables classification

9 Read Device Variables with Status Returns device variables with status

11 Read Unique Identifier Associated With Tag Same response as command 0 when Tag matches

12 Read Message Returns 24 bytes of packed ASCII data

13 Read Tag, Descriptor, Date Returns tag, descriptor (packed ASCII format) and date from the device

14 Read Primary Variable Transducer Information Returns PV transducer limits and span

15 Read Device Information Returns PV unit value, LRV, URV, damping value and write protect code

16 Read Final Assembly Number Returns final assembly number

17 Write Message Write 24 bytes of packed ASCII data.

Page 176: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Oxysafe HART Manual

109359.00 / 270616 13

18 Write Tag, Descriptor, Date Writes tag, descriptor (packed ASCII format) and date to the device

19 Write Final Assembly Number Writes final assembly number to the device

20 Read Long Tag Returns 32-byte Long Tag

21 Read Unique Identifier Associated with Long Tag Same response as command 0 when Long Tag matches

22 Write Long Tag Writes Long Tag to the Field Device

38 Reset Configuration Changed Flag Resets the configuration change flag

48 Read Additional Device Status See 7.3 for details

Page 177: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Oxysafe HART Manual

109359.00 / 270616 14

9. COMMON-PRACTICE COMMANDS

9.1 Supported Common Practice Commands

9.2 Burst Mode This Field Device does not support Burst Mode.

9.3 Catch Device Variable This Field Device does not support Catch Device Variable.

10. DEVICE-SPECIFIC COMMANDS This Field Device does not support Device Specific Commands.

Number Name Notes

33 Read Device Variables Returns all the Supported Device Variables

50 Read Dynamic Variable Assignment Returns the Variable Numbers associated with PV, SV,TV and QV

51 Write Dynamic Variable Assignment Writes the Variable Numbers associated with PV, SV,TV and QV

Page 178: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Oxysafe HART Manual

109359.00 / 270616 15

11. TABLES 11.1 Engineering Type Unit Codes Units of Measurement Unit Code Temperature Degrees Celsius 32 Electric Potential millivolts 36 Electric Resistance Ω 37 Miscellaneous Hertz 38 Electric Current milliamperes 39 Time Minutes 50 Time Seconds 51 Time Hours 52 Time Days 53 Miscellaneous Percent 57 Electric Potential Volts 58 Miscellaneous pH 59 Miscellaneous Micro Siemens per centimeter 67 Flow Liters per hour 138 Revolutions per minute 119 Concentration Parts per million 139 Electric Resistance kΩ 163 Concentration Parts per billion 169 Milligram per liter 170 Not used 250 Special 253

11.2 Classification Type Unit Codes Measurement Meas. Code Temperature 64 Volumetric flow 66 Time 70 Frequency 80 Analytical 81 Electric Potential 83 Current 84 Resistance 85 Conductance 87 Concentration 90 Turbidity 97 Not used 250 Special 253

Page 179: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Oxysafe HART Manual

109359.00 / 270616 16

12. PERFORMANCE 12.1 Sampling Rates Typical sampling rates are shown in the following table.

Oxygen sensor value sample 1 per second

Temperature sensor value sample 1 per second

Flow rate sensor value sample 1 per second

Saturation value 1 per second

Case Temperature sensor sample 1 per second

Note: all the Device Variables use an Infinite Impulse Response Filter, with coefficients depending on the measured variable. The Damping Value is different for each of the Device Variables, and can be read through Command 15.

12.2 Power-Up On power up, the transmitter takes approximately 10 seconds to be ready. During this period, the device will not respond to HART commands.

12.3 Command Response Times

Minimum 2ms

Typical 5ms

Maximum 150ms

12.4 Long Messages The largest data field used is in the response to Command 9: up to 71 bytes including the two status bytes.

12.5 Non-Volatile Memory EEPROM is used to hold the device’s configuration parameters. New data is written to this memory immediately on execution of a write command, before the consequent response.

12.6 Modes Loop current mode can be disabled or enabled using command 6.

12.7 Write Protection Write-protection is not selectable, and is always set as “not write protected”.

12.8 Damping Damping time is calculated for each dynamic variable.

Page 180: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Oxysafe HART Manual

109359.00 / 270616 17

ANNEX A. CAPABILITY CHECKLIST

Manufacturer, model and revision SWAN Analytic Instruments, AMI Oxysafe rev. 1

Device type Transmitter

HART revision 7.x

Device Description available Yes

Number and type of sensors 4 (three external, one internal)

Number and type of actuators 0

Number and type of host side signals 1: 4 - 20mA analog

Number of Device Variables 5

Number of Dynamic Variables 4

Mappable Dynamic Variables? Yes

Number of common-practice commands 3

Number of device-specific commands 0

Bits of additional device status 32

Alternative operating modes? No

Burst mode? No

Write-protection? No

Page 181: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Oxysafe HART Manual

109359.00 / 270616 18

ANNEX B. DEFAULT CONFIGURATION

Parameter Default value

PV Sensor Type Oxygen

Lower Range Value 0 ppm

Upper Range Value 20.0 ppm

PV Units ppm

Damping time constant 3.185 seconds

Fault-indication jumper Not used

Write-protect jumper Not used

Number of response preambles 5

Page 182: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Oxysafe HART Manual

109359.00 / 270616 19

ANNEX C. REVISION HISTORY

Document Title HART Interface Description AMI Oxysafe

Document ID 109359.00

Document Revision

Date Device Revision DD Revision Description

1.0 27/06/2016 1 1 First release, for HART 7.x Device

Page 183: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments

HART® 7.x Field Device Specification for AMI Oxytrace Transmitters

SWAN Analytical Instruments 8340, Studbachstrasse 13

Hinwil Switzerland

Page 184: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Oxytrace HART Manual

109348.00/ 170616 2

TABLE OF CONTENTS

1. Introduction ......................................................................................................................................4

1.1 Scope ....................................................................................................................................4

1.2 Purpose .................................................................................................................................4

1.3 Who should use this document? ..........................................................................................4

1.4 References ............................................................................................................................4

2. Device Identification ........................................................................................................................5

3. Product Overview ............................................................................................................................5

3.1 Connections..........................................................................................................................5

3.1.1 Point to point Mode ..............................................................................................5

3.1.2 Multidrop Mode ....................................................................................................6

3.1.3 HARTREC Board .................................................................................................6

4. Product Interfaces ............................................................................................................................7

4.1 Process Interface ..................................................................................................................7

4.1.1 Sensor Input Channels ..........................................................................................7

4.2 Process Flow Rate 4-20mA Analog Output .........................................................................7

4.3 Local Interfaces ....................................................................................................................7

4.3.1 Local Controls and Displays .................................................................................7

4.3.2 Write Protection ....................................................................................................7

5. Device Variables ..............................................................................................................................8

5.1 Device Variable 0 Oxygen ...................................................................................................8

5.2 Device Variable 1 Temperature ...........................................................................................8

5.3 Device Variable 2 Saturation ...............................................................................................8

5.4 Device Variable 3 Flow Rate ...............................................................................................8

5.5 Device Variable 4 Case Temperature ..................................................................................8

6. Dynamic Variables ...........................................................................................................................9

6.1 Mappable Variables .............................................................................................................9

6.2 PV Transfer Functions .........................................................................................................9

7. Status Information ..........................................................................................................................10

7.1 Field Device Status ............................................................................................................10

Page 185: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Oxytrace HART Manual

109348.00/ 170616 3

7.2 Extended Device Status .....................................................................................................10

7.3 Additional Device Status (Command #48) ........................................................................11

8. Universal Commands .....................................................................................................................13

9. Common-Practice Commands .......................................................................................................15

9.1 Supported Common Practice Commands ..........................................................................15

9.2 Burst Mode .........................................................................................................................15

9.3 Catch Device Variable .......................................................................................................15

10. Device-Specific Commands ...........................................................................................................15

11. Tables 16

11.1 Engineering Type Unit Codes ............................................................................................16

11.2 Classification Type Unit Codes .........................................................................................16

12. Performance ...................................................................................................................................17

12.1 Sampling Rates ..................................................................................................................17

12.2 Power-Up ...........................................................................................................................17

12.3 Command Response Times................................................................................................17

12.4 Long Messages ...................................................................................................................17

12.5 Non-Volatile Memory ........................................................................................................17

12.6 Modes .................................................................................................................................17

12.7 Write Protection .................................................................................................................17

12.8 Damping .............................................................................................................................17

Annex A. Capability Checklist ...........................................................................................................18

Annex B. Default Configuration ........................................................................................................19

Annex C. Revision History ................................................................................................................20

Page 186: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Oxytrace HART Manual

109348.00/ 170616 4

1. INTRODUCTION 1.1 Scope The SWAN Analytical Instruments model AMI Oxytrace transmitter complies with HART Protocol Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering Unit Codes supported). The functionality of this Field Device is described sufficiently to allow its proper application in a process and its complete support in HART capable Host Applications.

1.2 Purpose This specification is designed to complement the AMI Oxytrace manual by providing a complete description of this Field Device from a HART Communication perspective.

1.3 Who should use this document? The specification is designed to be a technical reference for HART capable Host Application Developers, System Integrators and knowledgeable End Users. It also provides functional specifications (e.g., commands and performance requirements) used during development, maintenance and testing. This document assumes the reader is familiar with HART Protocol requirements and terminology.

1.4 References HART Smart Communications Protocol Specification. HCF_SPEC-12. Available from the HCF.

MenAMI_ Oxytrace _xx.pdf. Available from the SWAN Analytical Instruments web page.

Page 187: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Oxytrace HART Manual

109348.00/ 170616 5

2. DEVICE IDENTIFICATION Manufacturer Name: SWAN Analytical

Instruments Model Name(s): AMI Oxytrace

Manufacture ID Code: 24757 (60B5 Hex)

Device Type Code:

58153 (E329 Hex)

HART Protocol Revision 7.5 Device Revision: 1

Number of Device Variables 5

Physical Layers Supported FSK

Physical Device Category Transmitter, Non-DC-isolated Bus Device

3. PRODUCT OVERVIEW The AMI Oxytrace HART communication option board provides a 4 to 20mA output signal and can be monitored and configured using a HART master device or a hand-held communicator.

3.1 Connections 3.1.1 Point to point Mode

An external minimum 250 Ω (maximum 800 Ω) resistor is needed in order to communicate with HART protocol.

Page 188: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Oxytrace HART Manual

109348.00/ 170616 6

3.1.2 Multidrop Mode

A single minimum 250 Ω resistor (maximum 800 Ω) is needed to communicate with all the instruments connected to the bus, and each of them must provide 4mA.

3.1.3 HARTREC Board

The HARTREC Board must be installed in the AMI transmitter in order to communicate with HART.

Page 189: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Oxytrace HART Manual

109348.00/ 170616 7

4. PRODUCT INTERFACES 4.1 Process Interface 4.1.1 Sensor Input Channels Refer to AMI Oxytrace manual to details on mounting Faraday electrode, Oxygen and Flow sensors.

4.2 Process Flow Rate 4-20mA Analog Output The 4 to 20mA output of the AMI Oxytrace HART option board represents a process value measurement, scaled according to the configured range of the instrument. This output corresponds to the Primary Variable. HART Communication is supported on this loop.

Since Dynamic Variables are mappable, PV can correspond to one of the following variables:

- Oxygen

- Temperature

- Saturation

- Flow rate

It is also possible to set the PV from the instrument local display, in the “Signal Output 3 / Parameter” settings.

4.3 Local Interfaces 4.3.1 Local Controls and Displays This device has a local display that allows the complete configurability of the instrument.

Refer to AMI Oxytrace manual to details on it.

4.3.2 Write Protection The Field Device has no “Write protection mode”.

Page 190: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Oxytrace HART Manual

109348.00/ 170616 8

5. DEVICE VARIABLES This Field Device exposes five Device Variables.

Device Variables Variables Meaning Units 0 Oxygen ppb

1 Temperature °C

2 Saturation %

3 Flow Rate l/h

4 Case Temperature °C

5.1 Device Variable 0 Oxygen Oxygen concentration is read by the Swansensor Oxygen sensor (Refer to AMI Oxytrace manual to details on it).

5.2 Device Variable 1 Temperature Temperature is read by the temperature sensor inside the Swansensor Oxygen sensor (Refer to AMI Oxytrace manual to details on it).

5.3 Device Variable 2 Saturation Saturation is read by the Swansensor Oxygen sensor (Refer to AMI Oxytrace manual to details on it).

5.4 Device Variable 3 Flow Rate Flow Rate is read by the Flow sensor (Refer to AMI Oxytrace manual to details on it).

5.5 Device Variable 4 Case Temperature Case Temperature shows the Temperature read inside the Electronic Box.

Page 191: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Oxytrace HART Manual

109348.00/ 170616 9

6. DYNAMIC VARIABLES 6.1 Mappable Variables Four mappable Dynamic Variables are implemented.

Dynamic Variables Variables Meaning Units

PV Oxygen – Temperature – Saturation - Flow Rate Ppb - °C – % - l/h

SV Oxygen – Temperature – Saturation - Flow Rate Ppb - °C – % - l/h

TV Oxygen – Temperature – Saturation - Flow Rate Ppb - °C – % - l/h

QV Oxygen – Temperature – Saturation - Flow Rate Ppb - °C – % - l/h

It is possible to associate any of these dynamic variables to PV, SV, TV or QV with a HART Master (or Handheld Communicator).

The PV is also settable from the instrument local display’s settings.

6.2 PV Transfer Functions The Primary Variable Transfer Function can be read with command 15. Its meaning is referred to the following table.

Transfer Function Type Code

Linear 240

Bilinear 241

Logarithmic 242

Control Upwards 243

Control Downwards 244

Page 192: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Oxytrace HART Manual

109348.00/ 170616 10

7. STATUS INFORMATION 7.1 Field Device Status The functions of the Field Device Status bits are specified in HCF_SPEC-99. Further details of their implementation are described in the following table.

Bit Name Notes

7 Device Malfunction Set on any detected Hardware Error

6 Configuration Changed Set if any changes are made to Field Device Configuration

5 Cold Start Set when powered-up or after a device reset

4 More Status Available Set if any Alarm or Maintenance has changed its status. More information is available via cmd 48

3 Loop Current Fixed The Loop Current is being held at a fixed value and is not responding to process variations

2 Loop Current Saturated The Loop Current has reached its upper (or lower) endpoint limit and cannot increase (or decrease) any further

1 Non-PV Out of Limits A Device Variable not mapped to the PV is beyond its

operating limits

0 PV Out of Limits The PV is beyond its operating limit

7.2 Extended Device Status Contains additional information regarding the status of the Field Device.

Bit Name Notes

2 Critical Power Failure Set when battery is becoming critically low (less than 15 min) and Field Device not connected to Power Supply

1 Device Variable Alert

Set when one or more Device Variables are in one of the following conditions:

• Hi/low limited (Limit Status)

• Bad (Process Data Status)

• Poor Accuracy (Process Data Status)

0 Maintenance Required Not Used

Page 193: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Oxytrace HART Manual

109348.00/ 170616 11

7.3 Additional Device Status (Command #48) Command #48 returns 6 additional bytes of data (Int32 or Int16 Little Endian), with the following status information:

(ALARMS-MAINTENANCE CODES)

Byte Bit Meaning Alarm Code

0 – 3

(INT32)

0 Oxygen Alarm high E001 1 Oxygen Alarm low E002 2 Saturation Alarm high E003 3 Saturation Alarm low E004 4 Reserved 5 Reserved 6 Sample Temp. high E007 7 Sample Temp. low E008 8 Sample Flow high

E009

9 Sample Flow low

E010 10 Temp. shorted E011 11 Temp. disconnected E012 12 Case Temp. high E013 13 Case Temp. low E014 14 Reserved 15 Reserved 16 Control Timeout E017 17 Faraday Efficiency E018 18 Quality Assurance E019 19 Reserved 20 Reserved 21 Reserved 22 Reserved 23 Input active E024 24 IC MK41T56

E025

25 IC LM75

E026 26 IC PCF8574

E027

27 Signal output open

E028 28 EEProm Motherboard

E029

29 EEProm Frontend

E030 30 Cal. Recout

E031

31 Wrong Frontend

E032 "Reserved" bits are always set to 0.

Page 194: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Oxytrace HART Manual

109348.00/ 170616 12

All bits used in these bytes indicate device or sensor failure, and always set bit 4 of the Device Status byte.

MAINTENANCE CODES:

Byte Bit Meaning Alarm Code

4-5 (INT16)

0 Electrolyte depleted E065 1 Reserved 2 Reserved 3 Reserved 4 Reserved 5 Reserved 6 Reserved 7 Reserved 8 Reserved 9 Reserved

10 Reserved 11 Reserved 12 Reserved 13 Reserved 14 Reserved 15 Reserved

Page 195: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Oxytrace HART Manual

109348.00/ 170616 13

8. UNIVERSAL COMMANDS Number Name Notes

0 Read Unique Identifier Returns identity information of the Field Device

1 Read Primary Variable Returns PV value and its unit

2 Read Loop Current and Percent of Range Returns AO value and % range

3 Read Dynamic Variables and Loop Current Returns PV, SV, TV and QV values and corresponding unit values along with AO value

6 Write Polling Address Changes Field Device’s polling address and loop current mode

7 Read Loop Configuration Returns polling address and loop current mode status

8 Read Dynamic Variable Classifications Returns dynamic variables classification

9 Read Device Variables with Status Returns device variables with status

11 Read Unique Identifier Associated With Tag Same response as command 0 when Tag matches

12 Read Message Returns 24 bytes of packed ASCII data

13 Read Tag, Descriptor, Date Returns tag, descriptor (packed ASCII format) and date from the device

14 Read Primary Variable Transducer Information Returns PV transducer limits and span

15 Read Device Information Returns PV unit value, LRV, URV, damping value and write protect code

16 Read Final Assembly Number Returns final assembly number

17 Write Message Write 24 bytes of packed ASCII data.

18 Write Tag, Descriptor, Date Writes tag, descriptor (packed ASCII format) and date to the device

Page 196: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Oxytrace HART Manual

109348.00/ 170616 14

19 Write Final Assembly Number Writes final assembly number to the device

20 Read Long Tag Returns 32-byte Long Tag

21 Read Unique Identifier Associated with Long Tag Same response as command 0 when Long Tag matches

22 Write Long Tag Writes Long Tag to the Field Device

38 Reset Configuration Changed Flag Resets the configuration change flag

48 Read Additional Device Status See 7.3 for details

Page 197: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Oxytrace HART Manual

109348.00/ 170616 15

9. COMMON-PRACTICE COMMANDS

9.1 Supported Common Practice Commands

9.2 Burst Mode This Field Device does not support Burst Mode.

9.3 Catch Device Variable This Field Device does not support Catch Device Variable.

10. DEVICE-SPECIFIC COMMANDS This Field Device does not support Device Specific Commands.

Number Name Notes

33 Read Device Variables Returns all the Supported Device Variables

50 Read Dynamic Variable Assignment Returns the Variable Numbers associated with PV, SV,TV and QV

51 Write Dynamic Variable Assignment Writes the Variable Numbers associated with PV, SV,TV and QV

Page 198: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Oxytrace HART Manual

109348.00/ 170616 16

11. TABLES 11.1 Engineering Type Unit Codes

Units of Measurement Unit Code Temperature Degrees Celsius 32 Electric Potential millivolts 36 Electric Resistance Ω 37 Miscellaneous Hertz 38 Electric Current milliamperes 39 Time Minutes 50 Time Seconds 51 Time Hours 52 Time Days 53 Miscellaneous Percent 57 Electric Potential Volts 58 Miscellaneous pH 59 Miscellaneous Micro Siemens per centimeter 67 Flow Liters per hour 138 Concentration Parts per million 139 Electric Resistance kΩ 163 Concentration Parts per billion 169 Not used 250 Special 253

11.2 Classification Type Unit Codes Measurement Meas. Code Temperature 64 Volumetric flow 66 Time 70 Frequency 80 Analytical 81 Electric Potential 83 Current 84 Resistance 85 Conductance 87 Concentration 90 Turbidity 97 Not used 250 Special 253

Page 199: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Oxytrace HART Manual

109348.00/ 170616 17

12. PERFORMANCE 12.1 Sampling Rates Typical sampling rates are shown in the following table.

Oxygen sensor value sample 1 per second

Temperature sensor value sample 1 per second

Flow rate sensor value sample 1 per second

Saturation value sample 1 per second

Case Temperature sensor sample 1 per second

Note: all the Device Variables use an Infinite Impulse Response Filter, with coefficients depending on the measured variable. The Damping Value is different for each of the Device Variables, and can be read through Command 15.

12.2 Power-Up On power up, the transmitter takes approximately 10 seconds to be ready. During this period, the device will not respond to HART commands.

12.3 Command Response Times

Minimum 2ms

Typical 5ms

Maximum 150ms

12.4 Long Messages The largest data field used is in the response to Command 9: up to 71 bytes including the two status bytes.

12.5 Non-Volatile Memory EEPROM is used to hold the device’s configuration parameters. New data is written to this memory immediately on execution of a write command, before the consequent response.

12.6 Modes Loop current mode can be disabled or enabled using command 6.

12.7 Write Protection Write-protection is not selectable, and is always set as “not write protected”.

12.8 Damping Damping time is calculated for each dynamic variable.

Page 200: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Oxytrace HART Manual

109348.00/ 170616 18

ANNEX A. CAPABILITY CHECKLIST

Manufacturer, model and revision SWAN Analytic Instruments, AMI Oxytrace rev. 1

Device type Transmitter

HART revision 7.x

Device Description available Yes

Number and type of sensors 5 (four external, one internal)

Number and type of actuators 0

Number and type of host side signals 1: 4 - 20mA analog

Number of Device Variables 5

Number of Dynamic Variables 4

Mappable Dynamic Variables? Yes

Number of common-practice commands 3

Number of device-specific commands 0

Bits of additional device status 48

Alternative operating modes? No

Burst mode? No

Write-protection? No

Page 201: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Oxytrace HART Manual

109348.00/ 170616 19

ANNEX B. DEFAULT CONFIGURATION

Parameter Default value

PV Sensor Type Oxygen

Lower Range Value 0 ppb

Upper Range Value 20000 ppb

PV Units Ppb

Damping time constant 1.592 seconds

Fault-indication jumper Not used

Write-protect jumper Not used

Number of response preambles 5

Page 202: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Oxytrace HART Manual

109348.00/ 170616 20

ANNEX C. REVISION HISTORY Document Title HART Interface Description AMI Oxytrace

Document ID 109348.00

Document Revision

Date Device Revision DD Revision Description

1.0 17/06/2016 1 1 First release, for HART 7.x Device

Page 203: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments

HART® 7.x Field Device Specification for AMI Pharmacon Transmitters

SWAN Analytical Instruments 8340, Studbachstrasse 13

Hinwil Switzerland

Page 204: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Pharmacon HART Manual

109360.00 / 170616 2

TABLE OF CONTENTS

1. Introduction ......................................................................................................................................4

1.1 Scope ....................................................................................................................................4

1.2 Purpose .................................................................................................................................4

1.3 Who should use this document? ..........................................................................................4

1.4 References ............................................................................................................................4

2. Device Identification ........................................................................................................................5

3. Product Overview ............................................................................................................................5

3.1 Connections..........................................................................................................................5

3.1.1 Point to point Mode ..............................................................................................5

3.1.2 Multidrop Mode ....................................................................................................6

3.1.3 HARTREC Board .................................................................................................6

4. Product Interfaces ............................................................................................................................7

4.1 Process Interface ..................................................................................................................7

4.1.1 Sensor Input Channels ..........................................................................................7

4.2 Process Flow Rate 4-20mA Analog Output .........................................................................7

4.3 Local Interfaces ....................................................................................................................7

4.3.1 Local Controls and Displays .................................................................................7

4.3.2 Write Protection ....................................................................................................7

5. Device Variables ..............................................................................................................................8

5.1 Device Variable 0 Conductivity ...........................................................................................8

5.2 Device Variable 1 Temperature ...........................................................................................8

5.3 Device Variable 2 Flow Rate ...............................................................................................8

5.4 Device Variable 3 Uncompensated Conductivity ................................................................8

5.5 Device Variable 4 Case Temperature ..................................................................................8

6. Dynamic Variables ...........................................................................................................................9

6.1 Mappable Variables .............................................................................................................9

6.2 PV Transfer Functions .........................................................................................................9

7. Status Information ..........................................................................................................................10

7.1 Field Device Status ............................................................................................................10

Page 205: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Pharmacon HART Manual

109360.00 / 170616 3

7.2 Extended Device Status .....................................................................................................10

7.3 Additional Device Status (Command #48) ........................................................................11

8. Universal Commands .....................................................................................................................12

9. Common-Practice Commands .......................................................................................................14

9.1 Supported Common Practice Commands ..........................................................................14

9.2 Burst Mode .........................................................................................................................14

9.3 Catch Device Variable .......................................................................................................14

10. Device-Specific Commands ...........................................................................................................14

11. Tables 15

11.1 Engineering Type Unit Codes ............................................................................................15

11.2 Classification Type Unit Codes .........................................................................................15

12. Performance ...................................................................................................................................16

12.1 Sampling Rates ..................................................................................................................16

12.2 Power-Up ...........................................................................................................................16

12.3 Command Response Times................................................................................................16

12.4 Long Messages ...................................................................................................................16

12.5 Non-Volatile Memory ........................................................................................................16

12.6 Modes .................................................................................................................................16

12.7 Write Protection .................................................................................................................16

12.8 Damping .............................................................................................................................16

Annex A. Capability Checklist ...........................................................................................................17

Annex B. Default Configuration ........................................................................................................18

Annex C. Revision History ................................................................................................................19

Page 206: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Pharmacon HART Manual

109360.00 / 170616 4

1. INTRODUCTION 1.1 Scope The SWAN Analytical Instruments model AMI Pharmacon transmitter complies with HART Protocol Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering Unit Codes supported). The functionality of this Field Device is described sufficiently to allow its proper application in a process and its complete support in HART capable Host Applications.

1.2 Purpose This specification is designed to complement the AMI Pharmacon manual by providing a complete description of this Field Device from a HART Communication perspective.

1.3 Who should use this document? The specification is designed to be a technical reference for HART capable Host Application Developers, System Integrators and knowledgeable End Users. It also provides functional specifications (e.g., commands and performance requirements) used during development, maintenance and testing. This document assumes the reader is familiar with HART Protocol requirements and terminology.

1.4 References HART Smart Communications Protocol Specification. HCF_SPEC-12. Available from the HCF.

MenAMI_Pharmacon_xx.pdf. Available from the SWAN Analytical Instruments web page.

Page 207: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Pharmacon HART Manual

109360.00 / 170616 5

2. DEVICE IDENTIFICATION Manufacturer Name: SWAN Analytical

Instruments Model Name(s): AMI Pharmacon

Manufacture ID Code: 24757 (60B5 Hex)

Device Type Code:

58187 (E34B Hex)

HART Protocol Revision 7.5 Device Revision: 1

Number of Device Variables 5

Physical Layers Supported FSK

Physical Device Category Transmitter, Non-DC-isolated Bus Device

3. PRODUCT OVERVIEW The AMI Pharmacon HART communication option board provides a 4 to 20mA output signal and can be monitored and configured using a HART master device or a hand-held communicator.

3.1 Connections 3.1.1 Point to point Mode

An external minimum 250 Ω (maximum 800 Ω) resistor is needed in order to communicate with HART protocol.

Page 208: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Pharmacon HART Manual

109360.00 / 170616 6

3.1.2 Multidrop Mode

A single minimum 250 Ω resistor (maximum 800 Ω) is needed to communicate with all the instruments connected to the bus, and each of them must provide 4mA.

3.1.3 HARTREC Board

The HARTREC Board must be installed in the AMI transmitter in order to communicate with HART.

Page 209: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Pharmacon HART Manual

109360.00 / 170616 7

4. PRODUCT INTERFACES 4.1 Process Interface 4.1.1 Sensor Input Channels Refer to AMI Pharmacon manual to details on mounting Conductivity and Flow sensors.

4.2 Process Flow Rate 4-20mA Analog Output The 4 to 20mA output of the AMI Pharmacon HART option board represents a process value measurement, scaled according to the configured range of the instrument. This output corresponds to the Primary Variable. HART Communication is supported on this loop.

Since Dynamic Variables are mappable, PV can correspond to one of the following variables:

- Conductivity

- Temperature

- Flow rate

- Uncompensated Conductivity

It is also possible to set the PV from the instrument local display, in the “Signal Output 3 / Parameter” settings.

4.3 Local Interfaces 4.3.1 Local Controls and Displays This device has a local display that allows the complete configurability of the instrument.

Refer to AMI Pharmacon manual to details on it.

4.3.2 Write Protection The Field Device has no “Write protection mode”.

Page 210: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Pharmacon HART Manual

109360.00 / 170616 8

5. DEVICE VARIABLES This Field Device exposes five Device Variables

Device Variables Variables Meaning Units 0 Conductivity uS/cm

1 Temperature °C

2 Flow Rate l/h

3 Uncomp. Conductivity uS/cm

4 Case Temperature °C

5.1 Device Variable 0 Conductivity The Conductivity is read by the two-electrode Conductivity sensor (Refer to AMI Pharmacon manual to details on it).

5.2 Device Variable 1 Temperature Temperature is read by the Pt1000 temperature sensor inside the Conductivity sensor (Refer to AMI Pharmacon manual to details on it).

5.3 Device Variable 2 Flow Rate Flow Rate is read by the Flow sensor (Refer to AMI Pharmacon manual to details on it).

5.4 Device Variable 3 Uncompensated Conductivity Uncomp. Conductivity is read by the Conductivity sensor.

5.5 Device Variable 4 Case Temperature Case Temperature shows the Temperature read inside the Electronic Box.

Page 211: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Pharmacon HART Manual

109360.00 / 170616 9

6. DYNAMIC VARIABLES 6.1 Mappable Variables Four mappable Dynamic Variables are implemented.

Dynamic Variables Variables Meaning Units

PV Conductivity– Temperature – Flow Rate –

Uncomp_ Cond. uS/cm - °C – l/h – uS/cm

SV Conductivity– Temperature – Flow Rate –

Uncomp_ Cond. uS/cm - °C – l/h – uS/cm

TV Conductivity– Temperature – Flow Rate –

Uncomp_ Cond. uS/cm - °C – l/h – uS/cm

QV Conductivity– Temperature – Flow Rate –

Uncomp_ Cond. uS/cm - °C – l/h – uS/cm

It is possible to associate any of these dynamic variables to PV, SV, TV or QV with a HART Master (or Handheld Communicator).

The PV is also settable from the instrument local display’s settings.

6.2 PV Transfer Functions The Primary Variable Transfer Function can be read with command 15. Its meaning is referred to the following table.

Transfer Function Type Code

Linear 240

Bilinear 241

Logarithmic 242

Control Upwards 243

Control Downwards 244

Page 212: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Pharmacon HART Manual

109360.00 / 170616 10

7. STATUS INFORMATION 7.1 Field Device Status The functions of the Field Device Status bits are specified in HCF_SPEC-99. Further details of their implementation are described in the following table.

Bit Name Notes

7 Device Malfunction Set on any detected Hardware Error

6 Configuration Changed Set if any changes are made to Field Device Configuration

5 Cold Start Set when powered-up or after a device reset

4 More Status Available Set if any Alarm or Maintenance has changed its status. More information is available via command 48

3 Loop Current Fixed The Loop Current is being held at a fixed value and is not responding to process variations

2 Loop Current Saturated The Loop Current has reached its upper (or lower) endpoint limit and cannot increase (or decrease) any further

1 Non-PV Out of Limits A Device Variable not mapped to the PV is beyond its

operating limits

0 PV Out of Limits The PV is beyond its operating limit

7.2 Extended Device Status Contains additional information regarding the status of the Field Device.

Bit Name Notes

2 Critical Power Failure Set when battery is becoming critically low (less than 15 min) and Field Device not connected to Power Supply

1 Device Variable Alert

Set when one or more Device Variables are in one of the following conditions:

• Hi/low limited (Limit Status)

• Bad (Process Data Status)

• Poor Accuracy (Process Data Status)

0 Maintenance Required Not Used

Page 213: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Pharmacon HART Manual

109360.00 / 170616 11

7.3 Additional Device Status (Command #48) Command #48 returns 4 additional bytes of data (Int32 or Int16 Little Endian), with the following status information:

Byte Bit Meaning Alarm Code

0 – 3

(INT32)

0 Cond. Alarm high E001 1 Cond. Alarm low E002 2 Reserved 3 Reserved 4 Reserved 5 Reserved 6 Sample Temp. high E007 7 Sample Temp. low E008 8 Sample Flow high E009 9 Sample Flow low E010 10 Temp. shorted E011 11 Temp. disconnected E012 12 Case Temp. high E013 13 Case Temp. low E014 14 USP Error E015 15 Reserved 16 Control Timeout E017 17 Quality Assurance E018 18 Reserved 19 Reserved 20 Reserved 21 Reserved 22 Reserved 23 Input active E024 24 IC MK41T56 E025 25 IC LM75 E026 26 IC PCF8574 E027 27 Signal output open E028 28 EEProm Motherboard E029 29 EEProm Frontend E030 30 Calibration Recout E031 31 Wrong Frontend E032

"Reserved" bits are always set to 0.

All bits used in this four bytes indicate device or sensor failure, and always set bit 4 of the Device Status byte.

Page 214: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Pharmacon HART Manual

109360.00 / 170616 12

8. UNIVERSAL COMMANDS Number Name Notes

0 Read Unique Identifier Returns identity information of the Field Device

1 Read Primary Variable Returns PV value and its unit

2 Read Loop Current and Percent of Range Returns AO value and % range

3 Read Dynamic Variables and Loop Current Returns PV, SV, TV and QV values and corresponding unit values along with AO value

6 Write Polling Address Changes Field Device’s polling address and loop current mode

7 Read Loop Configuration Returns polling address and loop current mode status

8 Read Dynamic Variable Classifications Returns dynamic variables classification

9 Read Device Variables with Status Returns device variables with status

11 Read Unique Identifier Associated With Tag Same response as command 0 when Tag matches

12 Read Message Returns 24 bytes of packed ASCII data

13 Read Tag, Descriptor, Date Returns tag, descriptor (packed ASCII format) and date from the device

14 Read Primary Variable Transducer Information Returns PV transducer limits and span

15 Read Device Information Returns PV unit value, LRV, URV, damping value and write protect code

16 Read Final Assembly Number Returns final assembly number

17 Write Message Write 24 bytes of packed ASCII data.

18 Write Tag, Descriptor, Date Writes tag, descriptor (packed ASCII format) and date to the device

Page 215: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Pharmacon HART Manual

109360.00 / 170616 13

19 Write Final Assembly Number Writes final assembly number to the device

20 Read Long Tag Returns 32-byte Long Tag

21 Read Unique Identifier Associated with Long Tag Same response as command 0 when Long Tag matches

22 Write Long Tag Writes Long Tag to the Field Device

38 Reset Configuration Changed Flag Resets the configuration change flag

48 Read Additional Device Status See 7.3 for details

Page 216: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Pharmacon HART Manual

109360.00 / 170616 14

9. COMMON-PRACTICE COMMANDS

9.1 Supported Common Practice Commands

9.2 Burst Mode This Field Device does not support Burst Mode.

9.3 Catch Device Variable This Field Device does not support Catch Device Variable.

10. DEVICE-SPECIFIC COMMANDS This Field Device does not support Device Specific Commands.

Number Name Notes

33 Read Device Variables Returns all the Supported Device Variables

50 Read Dynamic Variable Assignment Returns the Variable Numbers associated with PV, SV,TV and QV

51 Write Dynamic Variable Assignment Writes the Variable Numbers associated with PV, SV,TV and QV

Page 217: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Pharmacon HART Manual

109360.00 / 170616 15

11. TABLES 11.1 Engineering Type Unit Codes

Units of Measurement Unit Code Temperature Degrees Celsius 32 Electric Potential millivolts 36 Electric Resistance Ω 37 Miscellaneous Hertz 38 Electric Current milliamperes 39 Time Minutes 50 Time Seconds 51 Time Hours 52 Time Days 53 Miscellaneous Percent 57 Electric Potential Volts 58 Miscellaneous pH 59 Miscellaneous Micro Siemens per centimeter 67 Flow Liters per hour 138 Concentration Parts per million 139 Electric Resistance kΩ 163 Concentration Parts per billion 169 Not used 250 Special 253

11.2 Classification Type Unit Codes Measurement Meas. Code Temperature 64 Volumetric flow 66 Time 70 Frequency 80 Analytical 81 Electric Potential 83 Current 84 Resistance 85 Conductance 87 Concentration 90 Turbidity 97 Not used 250 Special 253

Page 218: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Pharmacon HART Manual

109360.00 / 170616 16

12. PERFORMANCE 12.1 Sampling Rates Typical sampling rates are shown in the following table.

Conductivity sensor value sample 1 per second

Temperature sensor value sample 1 per second

Flow rate sensor value sample 1 per second

Uncompensated conductivity value sample 1 per second

Case Temperature sensor sample 1 per second

Note: all the Device Variables use an Infinite Impulse Response Filter, with coefficients depending on the measured variable. The Damping Value is different for each of the Device Variables, and can be read through Command 15.

12.2 Power-Up On power up, the transmitter takes approximately 10 seconds to be ready. During this period, the device will not respond to HART commands.

12.3 Command Response Times

Minimum 2ms

Typical 5ms

Maximum 150ms

12.4 Long Messages The largest data field used is in the response to Command 9: up to 71 bytes including the two status bytes.

12.5 Non-Volatile Memory EEPROM is used to hold the device’s configuration parameters. New data is written to this memory immediately on execution of a write command, before the consequent response.

12.6 Modes Loop current mode can be disabled or enabled using command 6.

12.7 Write Protection Write-protection is not selectable, and is always set as “not write protected”.

12.8 Damping Damping time is calculated for each dynamic variable.

Page 219: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Pharmacon HART Manual

109360.00 / 170616 17

ANNEX A. CAPABILITY CHECKLIST

Manufacturer, model and revision SWAN Analytic Instruments, AMI Pharmacon rev. 1

Device type Transmitter

HART revision 7.x

Device Description available Yes

Number and type of sensors 4 (three external, one internal)

Number and type of actuators 0

Number and type of host side signals 1: 4 - 20mA analog

Number of Device Variables 5

Number of Dynamic Variables 4

Mappable Dynamic Variables? Yes

Number of common-practice commands 3

Number of device-specific commands 0

Bits of additional device status 32

Alternative operating modes? No

Burst mode? No

Write-protection? No

Page 220: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Pharmacon HART Manual

109360.00 / 170616 18

ANNEX B. DEFAULT CONFIGURATION

Parameter Default value

PV Sensor Type Conductivity

Lower Range Value 0 uS/cm

Upper Range Value 300000 uS/cm

PV Units uS/cm

Damping time constant 1.592 seconds

Fault-indication jumper Not used

Write-protect jumper Not used

Number of response preambles 5

Page 221: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Pharmacon HART Manual

109360.00 / 170616 19

ANNEX C. REVISION HISTORY

Document Title HART Interface Description AMI Pharmacon

Document ID 109360.00

Document Revision

Date Device Revision DD Revision Description

1.0 17/06/2016 1 1 First release, for HART 7.x Device

Page 222: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments

HART® 7.x Field Device Specification for AMI pH/mV:pH/mV Transmitters

SWAN Analytical Instruments 8340, Studbachstrasse 13

Hinwil Switzerland

Page 223: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI pH/mV:pH/mV HART Manual

109350.00 / 270616 2

TABLE OF CONTENTS

1. Introduction ......................................................................................................................................4

1.1 Scope ....................................................................................................................................4

1.2 Purpose .................................................................................................................................4

1.3 Who should use this document? ..........................................................................................4

1.4 References ............................................................................................................................4

2. Device Identification ........................................................................................................................5

3. Product Overview ............................................................................................................................5

3.1 Connections..........................................................................................................................5

3.1.1 Point to point Mode ..............................................................................................5

3.1.2 Multidrop Mode ....................................................................................................6

3.1.3 HARTREC Board .................................................................................................6

4. Product Interfaces ............................................................................................................................7

4.1 Process Interface ..................................................................................................................7

4.1.1 Sensor Input Channels ..........................................................................................7

4.2 Host Interface .......................................................................................................................7

4.2.1 Process pH 1 .........................................................................................................7

4.3 Local Interfaces ....................................................................................................................7

4.3.1 Local Controls and Displays .................................................................................7

4.3.2 Write Protection ....................................................................................................7

5. Device Variables ..............................................................................................................................8

5.1 Device Variable 0 pH 1 / Redox 1 .......................................................................................8

5.2 Device Variable 1 pH 2 / Redox 2 .......................................................................................8

5.3 Device Variable 2 Temperature 1 ........................................................................................8

5.4 Device Variable 3 Temperature 2 ........................................................................................8

5.5 Device Variable 4 Flow Rate ...............................................................................................8

5.6 Device Variable 5 pH Difference .........................................................................................8

5.7 Device Variable 6 Case Temperature ..................................................................................8

6. Dynamic Variables ...........................................................................................................................9

6.1 Mappable Variables .............................................................................................................9

Page 224: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI pH/mV:pH/mV HART Manual

109350.00 / 270616 3

6.2 PV Transfer Functions .........................................................................................................9

7. Status Information ..........................................................................................................................10

7.1 Field Device Status ............................................................................................................10

7.2 Extended Device Status .....................................................................................................10

7.3 Additional Device Status (Command #48) ........................................................................11

8. Universal Commands .....................................................................................................................12

9. Common-Practice Commands .......................................................................................................14

9.1 Supported Common Practice Commands ..........................................................................14

9.2 Burst Mode .........................................................................................................................14

9.3 Catch Device Variable .......................................................................................................14

10. Device-Specific Commands ...........................................................................................................14

11. Tables 15

11.1 Engineering Type Unit Codes ............................................................................................15

11.2 Classification Unit Codes ..................................................................................................15

12. Performance ...................................................................................................................................16

12.1 Sampling Rates ..................................................................................................................16

12.2 Power-Up ...........................................................................................................................16

12.3 Command Response Times................................................................................................16

12.4 Long Messages ...................................................................................................................16

12.5 Non-Volatile Memory ........................................................................................................16

12.6 Modes .................................................................................................................................16

12.7 Write Protection .................................................................................................................16

12.8 Damping .............................................................................................................................17

Annex A. Default Configuration ........................................................................................................18

Annex B. Revision History ................................................................................................................19

Page 225: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI pH/mV:pH/mV HART Manual

109350.00 / 270616 4

1. INTRODUCTION 1.1 Scope The SWAN Analytical Instruments model AMI pH/mV:pH/mV transmitter complies with HART Protocol Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering Unit Codes supported). The functionality of this Field Device is described sufficiently to allow its proper application in a process and its complete support in HART capable Host Applications.

1.2 Purpose This specification is designed to complement the AMI pH/mV:pH/mV manual by providing a complete description of this Field Device from a HART Communication perspective.

1.3 Who should use this document? The specification is designed to be a technical reference for HART capable Host Application Developers, System Integrators and knowledgeable End Users. It also provides functional specifications (e.g., commands and performance requirements) used during development, maintenance and testing. This document assumes the reader is familiar with HART Protocol requirements and terminology.

1.4 References HART Smart Communications Protocol Specification. HCF_SPEC-12. Available from the HCF.

MenAMI_pH-mV_01.pdf. Available from the SWAN Analytical Instruments web page.

Page 226: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI pH/mV:pH/mV HART Manual

109350.00 / 270616 5

2. DEVICE IDENTIFICATION Manufacturer Name: SWAN Analytical

Instruments Model Name(s): AMI

pH/mV:pH/mV

Manufacture ID Code: 24757 (60B5 Hex)

Device Type Code:

58176 (E340 Hex)

HART Protocol Revision 7.5 Device Revision: 1

Number of Device Variables 7

Physical Layers Supported FSK

Physical Device Category Transmitter, Non-DC-isolated Bus Device

3. PRODUCT OVERVIEW The AMI pH/mV:pH/mV HART communication option board provides a 4 to 20mA output signal and can be monitored and configured using a HART master device or a hand-held communicator.

3.1 Connections 3.1.1 Point to point Mode

An external minimum 250 Ω (maximum 800 Ω) resistor is needed in order to communicate with HART protocol.

Page 227: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI pH/mV:pH/mV HART Manual

109350.00 / 270616 6

3.1.2 Multidrop Mode

A single minimum 250 Ω resistor (maximum 800 Ω) is needed to communicate with all the instruments connected to the bus, and each of them must provide 4mA.

3.1.3 HARTREC Board

The HARTREC Board must be installed in the AMI transmitter in order to communicate with HART.

Page 228: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI pH/mV:pH/mV HART Manual

109350.00 / 270616 7

4. PRODUCT INTERFACES 4.1 Process Interface 4.1.1 Sensor Input Channels Refer to AMI pH/mV:pH/mV manual to details on mounting external sensors.

4.2 Host Interface 4.2.1 Process pH 1 The 4 to 20mA output of the AMI pH/mV:pH/mV HART option board represents a process value measurement, scaled according to the configured range of the instrument. This output corresponds to the Primary Variable. HART Communication is supported on this loop.

Since Dynamic Variables are mappable, PV can correspond to one of the following variables:

- pH 1 / Redox 1

- pH 2 / Redox 2

- Temperature 1

- Temperature 2

- Flow Rate

- pH Difference

It is also possible to set the PV from the instrument local display, in the “Signal Output 3 / Parameter” settings.

4.3 Local Interfaces 4.3.1 Local Controls and Displays This device has a local display that allows the complete configurability of the instrument.

Refer to AMI pH/mV:pH/mV manual to details on it.

4.3.2 Write Protection The Field Device has no “Write protection mode”.

Page 229: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI pH/mV:pH/mV HART Manual

109350.00 / 270616 8

5. DEVICE VARIABLES This Field Device exposes seven Device Variables

Device Variables Variables Meaning Units 0 pH 1 / Redox 1 pH / mV

1 pH 2 / Redox 2 pH / mV

2 Temperature 1 °C

3 Temperature 2 °C

4 Flow Rate l/h

5 pH Difference pH

6 Case Temperature °C

5.1 Device Variable 0 pH 1 / Redox 1 pH 1 / Redox 1 is read with pH sensor / Redox sensor (Refer to AMI pH/mV:pH/mV manual to details on it).

5.2 Device Variable 1 pH 2 / Redox 2 pH 2 / Redox 2 is read with pH sensor / Redox sensor (Refer to AMI pH/mV:pH/mV manual to details on it).

5.3 Device Variable 2 Temperature 1 Temperature 1 is read with Temperature sensor (Refer to AMI pH/mV:pH/mV manual to details on it).

5.4 Device Variable 3 Temperature 2 Temperature 2 is read with Temperature sensor (Refer to AMI pH/mV:pH/mV manual to details on it).

5.5 Device Variable 4 Flow Rate Flow Rate is read with Delta T Flow sensor (Refer to AMI pH/mV:pH/mV manual to details on it).

5.6 Device Variable 5 pH Difference pH Difference is calculated with pH 1 and pH 2.

5.7 Device Variable 6 Case Temperature Case Temperature shows the Temperature read inside the Electronic Box.

Page 230: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI pH/mV:pH/mV HART Manual

109350.00 / 270616 9

6. DYNAMIC VARIABLES 6.1 Mappable Variables Four mappable Dynamic Variables are implemented.

Dynamic Variables Variables Meaning Units

PV pH 1-2 / Redox 1-2 – Temp 1-2 – Main Flow –

pH Diff. pH/mV - °C – l/h - pH

SV pH 1-2 / Redox 1-2 – Temp 1-2 – Main Flow –

pH Diff. pH/mV - °C – l/h - pH

TV pH 1-2 / Redox 1-2 – Temp 1-2 – Main Flow –

pH Diff. pH/mV - °C – l/h - pH

QV pH 1-2 / Redox 1-2 – Temp 1-2 – Main Flow –

pH Diff. pH/mV - °C – l/h - pH

It is possible to associate any of these dynamic variables to PV, SV, TV or QV with a HART Master (or Handheld Communicator).

The PV is also settable from the instrument local display’s settings.

6.2 PV Transfer Functions The Primary Variable Transfer Function can be read with command 15. Its meaning is referred to the following table.

Transfer Function Type Code

Linear 240

Bilinear 241

Logarithmic 242

Control Upwards 243

Control Downwards 244

Page 231: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI pH/mV:pH/mV HART Manual

109350.00 / 270616 10

7. STATUS INFORMATION 7.1 Field Device Status The functions of the Field Device Status bits are specified in HCF_SPEC-99. Further details of their implementation are described in the following table.

Bit Name Notes

7 Device Malfunction Set on any detected Hardware Error

6 Configuration Changed Set if any changes are made to Field Device Configuration

5 Cold Start Set when powered-up or after a device reset

4 More Status Available Set if any Alarm or Maintenance has changed its status. More information is available via command 48

3 Loop Current Fixed The Loop Current is being held at a fixed value and is not responding to process variations

2 Loop Current Saturated The Loop Current has reached its upper (or lower) endpoint limit and cannot increase (or decrease) any further

1 Non-PV Out of Limits A Device Variable not mapped to the PV is beyond its

operating limits

0 PV Out of Limits The PV is beyond its operating limit

7.2 Extended Device Status Contains additional information regarding the status of the Field Device.

Bit Name Notes

2 Critical Power Failure Set when battery is becoming critically low (less than 15 min) and Field Device not connected to Power Supply

1 Device Variable Alert

Set when one or more Device Variables are in one of the following conditions:

• Hi/low limited (Limit Status)

• Bad (Process Data Status)

• Poor Accuracy (Process Data Status)

0 Maintenance Required Not Used

Page 232: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI pH/mV:pH/mV HART Manual

109350.00 / 270616 11

7.3 Additional Device Status (Command #48) Command #48 returns 4 additional bytes of data (Int32 or Int16 Little Endian), with the following status information:

Byte Bit Meaning Alarm Code

0 – 3

(INT32)

0 Alarm 1 high E001 1 Alarm 1 low E002 2 Alarm 2 high E003 3 Alarm 2 low E004 4 Temp. 1 high E005 5 Temp. 1 low E006 6 Temp. 2 high E007 7 Temp. 2 low E008 8 Sample Flow high E009 9 Sample Flow low E010 10 Temp. 1 shorted E011 11 Temp. 1 disconnected E012 12 Case Temp. high E013 13 Case Temp. low E014 14 Difference high E015 15 Difference low E016 16 Control Timeout E017 17 Reserved 18 Temp. 2 shorted E019 19 Temp. 2 disconnected E020 20 Reserved 21 Reserved 22 Reserved 23 Input active E024 24 IC MK41T56 E025 25 IC LM75 E026 26 IC PCF8574 E027 27 Signal output open E028 28 EEProm Motherboard E029 29 EEProm Frontend E030 30 Cal. Recout E031 31 Wrong Frontend E032

"Reserved" bits are always set to 0.

All bits used in these bytes indicate device/sensor failure or maintenances, and always set bit 4 of the Device Status byte.

Page 233: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI pH/mV:pH/mV HART Manual

109350.00 / 270616 12

8. UNIVERSAL COMMANDS Number Name Notes

0 Read Unique Identifier Returns identity information of the Field Device

1 Read Primary Variable Returns PV value and its unit

2 Read Loop Current and Percent of Range Returns AO value and % range

3 Read Dynamic Variables and Loop Current Returns PV, SV, TV and QV values and corresponding unit values along with AO value

6 Write Polling Address Changes Field Device’s polling address and loop current mode

7 Read Loop Configuration Returns polling address and loop current mode status

8 Read Dynamic Variable Classifications Returns dynamic variables classification

9 Read Device Variables with Status Returns device variables with status

11 Read Unique Identifier Associated With Tag Same response as command 0 when Tag matches

12 Read Message Returns 24 bytes of packed ASCII data

13 Read Tag, Descriptor, Date Returns tag, descriptor (packed ASCII format) and date from the device

14 Read Primary Variable Transducer Information Returns PV transducer limits and span

15 Read Device Information Returns PV unit value, LRV, URV, damping value and write protect code

16 Read Final Assembly Number Returns final assembly number

17 Write Message Write 24 bytes of packed ASCII data.

18 Write Tag, Descriptor, Date Writes tag, descriptor (packed ASCII format) and date to the device

Page 234: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI pH/mV:pH/mV HART Manual

109350.00 / 270616 13

19 Write Final Assembly Number Writes final assembly number to the device

20 Read Long Tag Returns 32-byte Long Tag

21 Read Unique Identifier Associated with Long Tag Same response as command 0 when Long Tag matches

22 Write Long Tag Writes Long Tag to the Field Device

38 Reset Configuration Changed Flag Resets the configuration change flag

48 Read Additional Device Status See 7.3 for details

Page 235: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI pH/mV:pH/mV HART Manual

109350.00 / 270616 14

9. COMMON-PRACTICE COMMANDS

9.1 Supported Common Practice Commands

9.2 Burst Mode This Field Device does not support Burst Mode.

9.3 Catch Device Variable This Field Device does not support Catch Device Variable.

10. DEVICE-SPECIFIC COMMANDS This Field Device does not support Device Specific Commands.

Number Name Notes

33 Read Device Variables Returns all the Supported Device Variables

50 Read Dynamic Variable Assignment Returns the Variable Numbers associated with PV, SV,TV and QV

51 Write Dynamic Variable Assignment Writes the Variable Numbers associated with PV, SV,TV and QV

Page 236: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI pH/mV:pH/mV HART Manual

109350.00 / 270616 15

11. TABLES 11.1 Engineering Type Unit Codes

Units of Measurement Unit Code Temperature Degrees Celsius 32 Electric Potential millivolts 36 Electric Resistance Ω 37 Miscellaneous Hertz 38 Electric Current milliamperes 39 Time Minutes 50 Time Seconds 51 Time Hours 52 Time Days 53 Miscellaneous Percent 57 Electric Potential Volts 58 Miscellaneous pH 59 Miscellaneous Micro Siemens per centimeter 67 Flow Liters per hour 138 Concentration Parts per million 139 Electric Resistance kΩ 163 Concentration Parts per billion 169 Not used 250 Special 253

11.2 Classification Unit Codes Measurement Meas. Code Temperature 64 Volumetric flow 66 Time 70 Frequency 80 Analytical 81 Electric Potential 83 Current 84 Resistance 85 Conductance 87 Concentration 90 Turbidity 97 Not used 250 Special 253

Page 237: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI pH/mV:pH/mV HART Manual

109350.00 / 270616 16

12. PERFORMANCE 12.1 Sampling Rates Typical sampling rates are shown in the following table.

Ph1 - 2 / Redox 1 - 2 sensor value sample 1 per second

Temperature 1 - 2 sensor value sample 1 per second

Flow Rate sensor value sample 1 per second

Note: all the Device Variables use an Infinite Impulse Response Filter, with coefficients depending on the measured variable. The Damping Value is different for each of the Device Variables, and can be read through Command 15.

12.2 Power-Up On power up, the transmitter takes approximately 10 seconds to be ready. During this period, the device will not respond to HART commands.

12.3 Command Response Times

Minimum 2ms

Typical 5ms

Maximum 150ms

12.4 Long Messages The largest data field used is in the response to Command 9: up to 71 bytes including the two status bytes.

12.5 Non-Volatile Memory EEPROM is used to hold the device’s configuration parameters. New data is written to this memory immediately on execution of a write command, before the consequent response.

12.6 Modes Loop current mode can be disabled or enabled using command 6.

12.7 Write Protection Write-protection is not selectable, and is always set as “not write protected”.

Page 238: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI pH/mV:pH/mV HART Manual

109350.00 / 270616 17

12.8 Damping Damping time is calculated for each dynamic variable. Capability Checklist

Manufacturer, model and revision SWAN Analytic Instruments, AMI pH/mV:pH/mV rev. 1

Device type Transmitter

HART revision 7.x

Device Description available Yes

Number and type of sensors 5 (four external, one internal)

Number and type of actuators 0

Number and type of host side signals 1: 4 - 20mA analog

Number of Device Variables 7

Number of Dynamic Variables 4

Mappable Dynamic Variables? Yes

Number of common-practice commands 3

Number of device-specific commands 0

Bits of additional device status 32

Alternative operating modes? No

Burst mode? No

Write-protection? No

Page 239: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI pH/mV:pH/mV HART Manual

109350.00 / 270616 18

ANNEX A. DEFAULT CONFIGURATION

Parameter Default value

PV Sensor Type pH 1 / Redox 1

Lower Range Value -3 pH / -500 mV

Upper Range Value 15 pH / 1500 mV

PV Units pH / mV

Damping time constant 1.592 seconds

Fault-indication jumper Not used

Write-protect jumper Not used

Number of response preambles 5

Page 240: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI pH/mV:pH/mV HART Manual

109350.00 / 270616 19

ANNEX B. REVISION HISTORY

Document Title HART Interface Description AMI pH/mV:pH/mV

Document ID 109350.00

Document Revision

Date Device Revision DD Revision Description

1.0 27/06/2016 1 1 First release, for HART 7.x Device

Page 241: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments

HART® 7.x Field Device Specification for AMI Phosphate-HL Transmitters

SWAN Analytical Instruments 8340, Studbachstrasse 13

Hinwil Switzerland

Page 242: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Phosphate-HL HART Manual

109362.00 / 280616 2

TABLE OF CONTENTS

1. Introduction ......................................................................................................................................4

1.1 Scope ....................................................................................................................................4

1.2 Purpose .................................................................................................................................4

1.3 Who should use this document? ..........................................................................................4

1.4 References ............................................................................................................................4

2. Device Identification ........................................................................................................................5

3. Product Overview ............................................................................................................................5

3.1 Connections..........................................................................................................................5

3.1.1 Point to point Mode ..............................................................................................5

3.1.2 Multidrop Mode ....................................................................................................6

3.1.3 HARTREC Board .................................................................................................6

4. Product Interfaces ............................................................................................................................7

4.1 Process Interface ..................................................................................................................7

4.1.1 Sensor Input Channels ..........................................................................................7

4.2 Host Interface .......................................................................................................................7

4.2.1 Process Phosphate 1 ..............................................................................................7

4.3 Local Interfaces ....................................................................................................................7

4.3.1 Local Controls and Displays .................................................................................7

4.3.2 Write Protection ....................................................................................................7

5. Device Variables ..............................................................................................................................8

5.1 Device Variable 0 ÷ 5 Phosphate 1 ÷ 6 ................................................................................8

5.2 Device Variable 7 Main Flow ..............................................................................................8

5.3 Device Variable 8 Case Temperature ..................................................................................8

6. Dynamic Variables ...........................................................................................................................9

6.1 Mappable Variables .............................................................................................................9

6.2 PV Transfer Functions .........................................................................................................9

7. Status Information ..........................................................................................................................10

7.1 Field Device Status ............................................................................................................10

7.2 Extended Device Status .....................................................................................................10

Page 243: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Phosphate-HL HART Manual

109362.00 / 280616 3

7.3 Additional Device Status (Command #48) ........................................................................11

8. Universal Commands .....................................................................................................................13

9. Common-Practice Commands .......................................................................................................15

9.1 Supported Common Practice Commands ..........................................................................15

9.2 Burst Mode .........................................................................................................................15

9.3 Catch Device Variable .......................................................................................................15

10. Device-Specific Commands ...........................................................................................................15

11. Tables 16

11.1 Engineering Type Unit Codes ............................................................................................16

11.2 Classification Unit Codes ..................................................................................................16

12. Performance ...................................................................................................................................17

12.1 Sampling Rates ..................................................................................................................17

12.2 Power-Up ...........................................................................................................................17

12.3 Command Response Times................................................................................................17

12.4 Long Messages ...................................................................................................................17

12.5 Non-Volatile Memory ........................................................................................................17

12.6 Modes .................................................................................................................................17

12.7 Write Protection .................................................................................................................17

12.8 Damping .............................................................................................................................17

13. Capability Checklist .......................................................................................................................18

Annex A. Default Configuration ........................................................................................................19

Annex B. Revision History ................................................................................................................20

Page 244: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Phosphate-HL HART Manual

109362.00 / 280616 4

1. INTRODUCTION 1.1 Scope The SWAN Analytical Instruments model AMI Phosphate-HL transmitter complies with HART Protocol Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering Unit Codes supported). The functionality of this Field Device is described sufficiently to allow its proper application in a process and its complete support in HART capable Host Applications.

1.2 Purpose This specification is designed to complement the AMI Phosphate-HL manual by providing a complete description of this Field Device from a HART Communication perspective.

1.3 Who should use this document? The specification is designed to be a technical reference for HART capable Host Application Developers, System Integrators and knowledgeable End Users. It also provides functional specifications (e.g., commands and performance requirements) used during development, maintenance and testing. This document assumes the reader is familiar with HART Protocol requirements and terminology.

1.4 References HART Smart Communications Protocol Specification. HCF_SPEC-12. Available from the HCF.

MenAMI_Phosphate_HL_xx.pdf. Available from the SWAN Analytical Instruments web page.

Page 245: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Phosphate-HL HART Manual

109362.00 / 280616 5

2. DEVICE IDENTIFICATION Manufacturer Name: SWAN Analytical

Instruments Model Name(s): AMI Phosphate-

HL

Manufacture ID Code: 24757 (60B5 Hex)

Device Type Code:

58189 (E34D Hex)

HART Protocol Revision 7.5 Device Revision: 1

Number of Device Variables 8

Physical Layers Supported FSK

Physical Device Category Transmitter, Non-DC-isolated Bus Device

3. PRODUCT OVERVIEW The AMI Phosphate-HL HART communication option board provides a 4 to 20mA output signal and can be monitored and configured using a HART master device or a hand-held communicator.

3.1 Connections 3.1.1 Point to point Mode

An external minimum 250 Ω (maximum 800 Ω) resistor is needed in order to communicate with HART protocol.

Page 246: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Phosphate-HL HART Manual

109362.00 / 280616 6

3.1.2 Multidrop Mode

A single minimum 250 Ω resistor (maximum 800 Ω) is needed to communicate with all the instruments connected to the bus, and each of them must provide 4mA.

3.1.3 HARTREC Board

The HARTREC Board must be installed in the AMI transmitter in order to communicate with HART.

Page 247: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Phosphate-HL HART Manual

109362.00 / 280616 7

4. PRODUCT INTERFACES 4.1 Process Interface 4.1.1 Sensor Input Channels Refer to AMI Phosphate-HL manual to details on mounting FOME sensor.

4.2 Host Interface 4.2.1 Process Phosphate 1 The 4 to 20mA output of the AMI Phosphate-HL HART option board represents a process value measurement, scaled according to the configured range of the instrument. This output corresponds to the Primary Variable. HART Communication is supported on this loop.

Since Dynamic Variables are mappable, PV can correspond to one of the following variables:

- Phosphate 1

- Phosphate 2

It is also possible to set the PV from the instrument local display, in the “Signal Output 3 / Parameter” settings.

4.3 Local Interfaces 4.3.1 Local Controls and Displays This device has a local display that allows the complete configurability of the instrument.

Refer to AMI Phosphate-HL manual to details on it.

4.3.2 Write Protection The Field Device has no “Write protection mode”.

Page 248: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Phosphate-HL HART Manual

109362.00 / 280616 8

5. DEVICE VARIABLES This Field Device exposes eight Device Variables

Device Variables Variables Meaning Units 0 Phosphate 1 ppm

1 Phosphate 2 ppm

2 Phosphate 3 ppm

3 Phosphate 4 ppm

4 Phosphate 5 ppm

5 Phosphate 6 ppm

6 Main Flow B/s

7 Case Temperature °C

5.1 Device Variable 0 ÷ 5 Phosphate 1 ÷ 6 Phosphate 1÷6 are read by FOME sensor (Refer to AMI Phosphate-HL manual to details on it).

5.2 Device Variable 7 Main Flow Main Flow is read by the Bubble Detector (Refer to AMI Phosphate-HL manual to details on it).

5.3 Device Variable 8 Case Temperature Case Temperature shows the Temperature read inside the Electronic Box.

Page 249: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Phosphate-HL HART Manual

109362.00 / 280616 9

6. DYNAMIC VARIABLES 6.1 Mappable Variables Two mappable Dynamic Variables are implemented.

Dynamic Variables Variables Meaning Units

PV Phosphate 1 – Phosphate 2 ppm

SV Phosphate 1 – Phosphate 2 ppm

It is possible to associate these dynamic variables both to PV or SV with a HART Master (or Handheld Communicator).

The PV is also settable from the instrument local display’s settings.

6.2 PV Transfer Functions The Primary Variable Transfer Function can be read with command 15. Its meaning is referred to the following table.

Transfer Function Type Code

Linear 240

Bilinear 241

Logarithmic 242

Control Upwards 243

Control Downwards 244

Page 250: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Phosphate-HL HART Manual

109362.00 / 280616 10

7. STATUS INFORMATION 7.1 Field Device Status The functions of the Field Device Status bits are specified in HCF_SPEC-99. Further details of their implementation are described in the following table.

Bit Name Notes

7 Device Malfunction Set on any detected Hardware Error

6 Configuration Changed Set if any changes are made to Field Device Configuration

5 Cold Start Set when powered-up or after a device reset

4 More Status Available Set if any Alarm or Maintenance has changed its status. More information is available via command 48

3 Loop Current Fixed The Loop Current is being held at a fixed value and is not responding to process variations

2 Loop Current Saturated The Loop Current has reached its upper (or lower) endpoint limit and cannot increase (or decrease) any further

1 Non-PV Out of Limits A Device Variable not mapped to the PV is beyond its

operating limits

0 PV Out of Limits The PV is beyond its operating limit

7.2 Extended Device Status Contains additional information regarding the status of the Field Device.

Bit Name Notes

2 Critical Power Failure Set when battery is becoming critically low (less than 15 min) and Field Device not connected to Power Supply

1 Device Variable Alert

Set when one or more Device Variables are in one of the following conditions:

• Hi/low limited (Limit Status)

• Bad (Process Data Status)

• Poor Accuracy (Process Data Status)

0 Maintenance Required Not Used

Page 251: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Phosphate-HL HART Manual

109362.00 / 280616 11

7.3 Additional Device Status (Command #48) Command #48 returns 10 additional bytes of data (Int32 or Int16 Little Endian), with the following status information:

ALARMS CODES:

Byte Bit Meaning Alarm Code

0 – 3

(INT32)

0 Phos. 1 Alarm high E001 1 Phos. 1 Alarm low E002 2 Phos. 2 Alarm high E003 3 Phos. 2 Alarm low E004 4 Absorbance too high E005 5 Reserved 6 Reserved 7 Reserved 8 Sample Flow high E009 9 Sample Flow low E010

10 Reserved 11 Reserved 12 Case Temp. high E013 13 Case Temp. low E014 14 Valve defective E015 15 Reserved 16 Control Timeout E017 17 Reagent Pump E018 18 FOME not connected E019 19 FOME dirty E020 20 Sequencer E021 21 Reagent empty E022 22 Cleaning Solution E023 23 Input active E024 24 IC MK41T56 E025 25 IC LM75 E026 26 IC PCF8574 E027 27 Signal output open E028 28 EEProm Motherboard E029 29 EEProm Frontend E030 30 Calibration Recout E031 31 Wrong Frontend E032

Page 252: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Phosphate-HL HART Manual

109362.00 / 280616 12

4-5 (INT16)

0 Reagents Low E065 1 Reserved 2 Cleaning Solution E067 3 Reserved 4 Reserved 5 Reserved 6 Reserved 7 Reserved 8 Reserved 9 Reserved 10 Reserved 11 Reserved 12 Reserved 13 Reserved 14 Reserved 15 Reserved

14-17 (INT32)

0 Sample Flow 1 low E033 1 Sample Flow 2 low E034 2 Sample Flow 3 low E035 3 Sample Flow 4 low E036 4 Sample Flow 5 low E037 5 Sample Flow 6 low E038 6 Sample Flow low E039 7 Reserved 8 Reagents low E041 9 Reserved 10 Cleaning Solution E043

11-31 Reserved "Reserved" bits are always set to 0.

All bits used in these bytes indicate device/sensor failure or maintenances, and always set bit 4 of the Device Status byte.

Page 253: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Phosphate-HL HART Manual

109362.00 / 280616 13

8. UNIVERSAL COMMANDS Number Name Notes

0 Read Unique Identifier Returns identity information of the Field Device

1 Read Primary Variable Returns PV value and its unit

2 Read Loop Current and Percent of Range Returns AO value and % range

3 Read Dynamic Variables and Loop Current Returns PV, SV, TV and QV values and corresponding unit values along with AO value

6 Write Polling Address Changes Field Device’s polling address and loop current mode

7 Read Loop Configuration Returns polling address and loop current mode status

8 Read Dynamic Variable Classifications Returns dynamic variables classification

9 Read Device Variables with Status Returns device variables with status

11 Read Unique Identifier Associated With Tag Same response as command 0 when Tag matches

12 Read Message Returns 24 bytes of packed ASCII data

13 Read Tag, Descriptor, Date Returns tag, descriptor (packed ASCII format) and date from the device

14 Read Primary Variable Transducer Information Returns PV transducer limits and span

15 Read Device Information Returns PV unit value, LRV, URV, damping value and write protect code

16 Read Final Assembly Number Returns final assembly number

17 Write Message Write 24 bytes of packed ASCII data.

18 Write Tag, Descriptor, Date Writes tag, descriptor (packed ASCII format) and date to the device

Page 254: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Phosphate-HL HART Manual

109362.00 / 280616 14

19 Write Final Assembly Number Writes final assembly number to the device

20 Read Long Tag Returns 32-byte Long Tag

21 Read Unique Identifier Associated with Long Tag Same response as command 0 when Long Tag matches

22 Write Long Tag Writes Long Tag to the Field Device

38 Reset Configuration Changed Flag Resets the configuration change flag

48 Read Additional Device Status See 7.3 for details

Page 255: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Phosphate-HL HART Manual

109362.00 / 280616 15

9. COMMON-PRACTICE COMMANDS

9.1 Supported Common Practice Commands

9.2 Burst Mode This Field Device does not support Burst Mode.

9.3 Catch Device Variable This Field Device does not support Catch Device Variable.

10. DEVICE-SPECIFIC COMMANDS This Field Device does not support Device Specific Commands.

Number Name Notes

33 Read Device Variables Returns all the Supported Device Variables

50 Read Dynamic Variable Assignment Returns the Variable Numbers associated with PV and SV

51 Write Dynamic Variable Assignment Writes the Variable Numbers associated with PV and SV

Page 256: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Phosphate-HL HART Manual

109362.00 / 280616 16

11. TABLES 11.1 Engineering Type Unit Codes

Units of Measurement Unit Code Temperature Degrees Celsius 32 Electric Potential millivolts 36 Electric Resistance Ω 37 Miscellaneous Hertz 38 Electric Current milliamperes 39 Time Minutes 50 Time Seconds 51 Time Hours 52 Time Days 53 Miscellaneous Percent 57 Electric Potential Volts 58 Miscellaneous pH 59 Miscellaneous Micro Siemens per centimeter 67 Flow Liters per hour 138 Concentration Parts per million 139 Electric Resistance kΩ 163 Concentration Parts per billion 169 Bubbles per second 240 Not used 250

11.2 Classification Unit Codes Measurement Meas. Code Temperature 64 Volumetric flow 66 Time 70 Frequency 80 Analytical 81 Electric Potential 83 Current 84 Resistance 85 Conductance 87 Concentration 90 Turbidity 97 Not used 250 Special 253

Page 257: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Phosphate-HL HART Manual

109362.00 / 280616 17

12. PERFORMANCE 12.1 Sampling Rates Typical sampling rates are shown in the following table.

Flow rate sensor value sample 1 per second

Phosphate sensor value sample 1 per second

Case Temperature sensor sample 1 per second

Note: all the Device Variables use an Infinite Impulse Response Filter, with coefficients depending on the measured variable. The Damping Value is different for each of the Device Variables, and can be read through Command 15.

12.2 Power-Up On power up, the transmitter takes approximately 10 seconds to be ready. During this period, the device will not respond to HART commands.

12.3 Command Response Times

Minimum 2ms

Typical 5ms

Maximum 150ms

12.4 Long Messages The largest data field used is in the response to Command 9: up to 71 bytes including the two status bytes.

12.5 Non-Volatile Memory EEPROM is used to hold the device’s configuration parameters. New data is written to this memory immediately on execution of a write command, before the consequent response.

12.6 Modes Loop current mode can be disabled or enabled using command 6.

12.7 Write Protection Write-protection is not selectable, and is always set as “not write protected”.

12.8 Damping Damping time is calculated for each dynamic variable.

Page 258: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Phosphate-HL HART Manual

109362.00 / 280616 18

13. CAPABILITY CHECKLIST

Manufacturer, model and revision SWAN Analytic Instruments, AMI Phosphate-HL rev. 1

Device type Transmitter

HART revision 7.x

Device Description available Yes

Number and type of sensors 3 (two external, one internal)

Number and type of actuators 0

Number and type of host side signals 1: 4 - 20mA analog

Number of Device Variables 8

Number of Dynamic Variables 2

Mappable Dynamic Variables? Yes

Number of common-practice commands 3

Number of device-specific commands 0

Bits of additional device status 80

Alternative operating modes? No

Burst mode? No

Write-protection? No

Page 259: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Phosphate-HL HART Manual

109362.00 / 280616 19

ANNEX A. DEFAULT CONFIGURATION

Parameter Default value

PV Sensor Type Phosphate 1

Lower Range Value 0 ppm

Upper Range Value 10 ppm

PV Units Ppm

Damping time constant 0.796 seconds

Fault-indication jumper Not used

Write-protect jumper Not used

Number of response preambles 5

Page 260: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Phosphate-HL HART Manual

109362.00 / 280616 20

ANNEX B. REVISION HISTORY

Document Title HART Interface Description AMI Phosphate-HL

Document ID 109362.00

Document Revision

Date Device Revision DD Revision Description

1.0 28/06/2016 1 1 First release, for HART 7.x Device

Page 261: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

HART® 7.x Field Device Specification for AMI pH-Redox Transmitters

SWAN Analytical Instruments

8340, Studbachstrasse 13

Hinwil

Switzerland

Page 262: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI pH-Redox HART Manual

109349.00 / 240616 2

TABLE OF CONTENTS

1. Introduction ......................................................................................................................................4

1.1 Scope ....................................................................................................................................4

1.2 Purpose .................................................................................................................................4

1.3 Who should use this document? ..........................................................................................4

1.4 References ............................................................................................................................4

2. Device Identification ........................................................................................................................5

3. Product Overview ............................................................................................................................5

3.1 Connections..........................................................................................................................5

3.1.1 Point to point Mode ..............................................................................................5

3.1.2 Multidrop Mode ....................................................................................................6

3.1.3 HARTREC Board .................................................................................................6

4. Product Interfaces ............................................................................................................................7

4.1 Process Interface ..................................................................................................................7

4.1.1 Sensor Input Channels ..........................................................................................7

4.2 Process Flow Rate 4-20mA Analog Output .........................................................................7

4.3 Local Interfaces ....................................................................................................................7

4.3.1 Local Controls and Displays .................................................................................7

4.3.2 Write Protection ....................................................................................................7

5. Device Variables ..............................................................................................................................7

5.1 Device Variable 0 Measured Value .....................................................................................8

5.2 Device Variable 1 Flow Rate ...............................................................................................8

5.3 Device Variable 2 Temperature ...........................................................................................8

5.4 Device Variable 3 Case Temperature ..................................................................................8

6. Dynamic Variables ...........................................................................................................................9

6.1 Mappable Variables .............................................................................................................9

6.2 PV Transfer Functions .........................................................................................................9

7. Status Information ..........................................................................................................................10

7.1 Field Device Status ............................................................................................................10

7.2 Extended Device Status .....................................................................................................10

Page 263: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI pH-Redox HART Manual

109349.00 / 240616 3

7.3 Additional Device Status (Command #48) ........................................................................11

8. Universal Commands .....................................................................................................................12

9. Common-Practice Commands .......................................................................................................14

9.1 Supported Common Practice Commands ..........................................................................14

9.2 Burst Mode .........................................................................................................................14

9.3 Catch Device Variable .......................................................................................................14

10. Device-Specific Commands ...........................................................................................................14

11. Tables 15

11.1 Engineering Type Unit Codes ............................................................................................15

11.2 Classification Type Unit Codes .........................................................................................15

12. Performance ...................................................................................................................................16

12.1 Sampling Rates ..................................................................................................................16

12.2 Power-Up ...........................................................................................................................16

12.3 Command Response Times................................................................................................16

12.4 Long Messages ...................................................................................................................16

12.5 Non-Volatile Memory ........................................................................................................16

12.6 Modes .................................................................................................................................16

12.7 Write Protection .................................................................................................................16

12.8 Damping .............................................................................................................................16

Annex A. Capability Checklist ...........................................................................................................17

Annex B. Default Configuration ........................................................................................................18

Annex C. Revision History ................................................................................................................19

Page 264: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI pH-Redox HART Manual

109349.00 / 240616 4

1. INTRODUCTION

1.1 Scope The SWAN Analytical Instruments model AMI pH-Redox transmitter complies with HART Protocol

Revision 7.5. This document specifies all the device specific features and documents HART

Protocol implementation details (i.e. the Engineering Unit Codes supported). The functionality of

this Field Device is described sufficiently to allow its proper application in a process and its

complete support in HART capable Host Applications.

1.2 Purpose This specification is designed to compliment the AMI pH-Redox manual by providing a complete

description of this Field Device from a HART Communication perspective.

1.3 Who should use this document? The specification is designed to be a technical reference for HART capable Host Application

Developers, System Integrators and knowledgeable End Users. It also provides functional

specifications (e.g., commands and performance requirements) used during development,

maintenance and testing. This document assumes the reader is familiar with HART Protocol

requirements and terminology.

1.4 References

HART Smart Communications Protocol Specification. HCF_SPEC-12. Available from the

HCF.

MenAMI_pH-Redox_xx.pdf. Available from the SWAN Analytical Instruments web page.

Page 265: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI pH-Redox HART Manual

109349.00 / 240616 5

2. DEVICE IDENTIFICATION

Manufacturer Name: SWAN Analytical

Instruments Model Name(s): AMI pH-Redox

Manufacturer ID Code: 24757 (60B5

Hex) Device Type

Code:

58152 (E328

Hex)

HART Protocol Revision 7.5 Device Revision: 1

Number of Device Variables 4

Physical Layers Supported FSK

Physical Device Category Transmitter, Non-DC-isolated Bus Device

3. PRODUCT OVERVIEW

The pH-Redox HART communication option board provides a 4 to 20mA output signal and can be

monitored and configured using a HART master device or a hand-held communicator.

3.1 Connections

3.1.1 Point to point Mode

An external minimum 250 Ω (maximum 800 Ω) resistor is needed in order to communicate with

HART protocol.

Page 266: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI pH-Redox HART Manual

109349.00 / 240616 6

3.1.2 Multidrop Mode

A single minimum 250 Ω resistor (maximum 800 Ω) is needed to communicate with all the

instruments connected to the bus, and each of them must provide 4mA.

3.1.3 HARTREC Board

The HARTREC Board must be installed in the AMI transmitter in order to communicate with

HART.

Page 267: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI pH-Redox HART Manual

109349.00 / 240616 7

4. PRODUCT INTERFACES

4.1 Process Interface

4.1.1 Sensor Input Channels

Refer to AMI pH-Redox manual to details on mounting pH, Redox, Temperature and Flow sensors.

4.2 Process Flow Rate 4-20mA Analog Output The 4 to 20mA output of the AMI pH-Redox HART option board represents a process value measurement, scaled according to the configured range of the instrument. This output corresponds to the Primary Variable. HART Communication is supported on this loop.

Since Dynamic Variables are mappable, PV can correspond to one of the following variables:

- Measured Value (pH or Redox)

- Temperature

- Flow Rate

It is also possible to set the PV from the instrument local display, in the “Signal Output 3 /

Parameter” settings.

4.3 Local Interfaces

4.3.1 Local Controls and Displays

This device has a local display that allows the complete configurability of the instrument.

Refer to AMI pH-Redox manual to details on it.

4.3.2 Write Protection

The Field Device has no “Write protection mode”.

5. DEVICE VARIABLES This Field Device exposes four Device Variables

Device Variables Variables Meaning Units

0 Measured Value pH / Redox

1 Flow Rate l/h

2 Temperature °C

3 Case Temperature °C

Page 268: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI pH-Redox HART Manual

109349.00 / 240616 8

5.1 Device Variable 0 Measured Value Measured Value corresponds to pH [pH] or Redox [mV], based on the instrument mounted (Refer to

AMI pH-Redox manual for additional details).

5.2 Device Variable 1 Flow Rate Flow Rate is read by the Flow sensor, when mounted (Refer to AMI pH-Redox manual for additional

details).

5.3 Device Variable 2 Temperature Temperature is read by the Temperature sensor, when mounted (Refer to AMI pH-Redox for

additional details).

5.4 Device Variable 3 Case Temperature Case Temperature shows the Temperature read inside the Electronic Box.

Page 269: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI pH-Redox HART Manual

109349.00 / 240616 9

6. DYNAMIC VARIABLES

6.1 Mappable Variables Three mappable Dynamic Variables are implemented.

Dynamic Variables Variables Meaning Units

PV pH/Redox - Flow Rate - Temperature pH/mV - l/h - °C

SV pH/Redox - Flow Rate - Temperature pH/mV - l/h - °C

TV pH/Redox - Flow Rate - Temperature pH/mV - l/h - °C

It is possible to associate any of these dynamic variables to PV, SV, or TV, with a HART Master (or

Handheld Communicator).

The PV is also settable from the instrument local display’s settings.

6.2 PV Transfer Functions The Primary Variable Transfer Function can be read with command 15. Its meaning is referred to the

following table.

Transfer Function Type Code

Linear 240

Bilinear 241

Logarithmic 242

Control Upwards 243

Control Downwards 244

Page 270: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI pH-Redox HART Manual

109349.00 / 240616 10

7. STATUS INFORMATION

7.1 Field Device Status

The functions of the Field Device Status bits are specified in HCF_SPEC-99. Further details of their

implementation are described in the following table.

Bit Name Notes

7 Device Malfunction Set on any detected Hardware Error

6 Configuration Changed Set if any changes are made to Field Device Configuration

5 Cold Start Set when powered-up or after a device reset

4 More Status Available

Set if any Alarm or Maintenance has changed its status. More

information is available via command 48

3 Loop Current Fixed The Loop Current is being held at a fixed value and is not

responding to process variations

2 Loop Current Saturated The Loop Current has reached its upper (or lower) endpoint

limit and cannot increase (or decrease) any further

1 Non-PV Out of Limits

A Device Variable not mapped to the PV is beyond its

operating limits

0 PV Out of Limits The PV is beyond its operating limit

7.2 Extended Device Status Contains additional information regarding the status of the Field Device.

Bit Name Notes

2 Critical Power Failure Set when battery is becoming critically low (less than 15

min) and Field Device not connected to Power Supply

1 Device Variable Alert

Set when one or more Device Variables are in one of the

following conditions:

Hi/low limited (Limit Status)

Bad (Process Data Status)

Poor Accuracy (Process Data Status)

0 Maintenance Required Not Used

Page 271: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI pH-Redox HART Manual

109349.00 / 240616 11

7.3 Additional Device Status (Command #48) Command #48 returns 4 additional bytes of data (Int32 Little Endian), with the following status

information:

Byte Bit Meaning Alarm Code

0 – 3

(INT32)

0 Alarm high E001

1 Alarm low E002

2 Reserved

3 Reserved

4 Reserved

5 Reserved

6 Sample Temp. high E007

7 Sample Temp. low E008

8 Sample Flow high

E009

9 Sample Flow low

E010

10 Temp. shorted E011

11 Temp. disconnected E012

12 Case Temp. high E013

13 Case Temp. low E014

14 Reserved

15 Reserved

16 Control Timeout E017

17 Quality Assurance E018

18 Reserved

19 Reserved

20 Reserved

21 Reserved

22 Reserved

23 Input active E024

24 IC MK41T56

E025

25 IC LM75

E026

26 IC PCF8574

E027

27 Signal output open

E028

28 EEPROM Motherboard

E029

29 EEPROM Frontend

E030

30 Cal. Recout

E031

31 Wrong Frontend

E032

"Reserved" bits are always set to 0.

All bits used in these bytes indicate device or sensor failure, and always set bit 4 of the Device Status

byte.

Page 272: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI pH-Redox HART Manual

109349.00 / 240616 12

8. UNIVERSAL COMMANDS Number Name Notes

0 Read Unique Identifier Returns identity information

of the Field Device

1 Read Primary Variable Returns PV value and its unit

2 Read Loop Current and Percent of Range

Returns AO value and % range

3 Read Dynamic Variables and Loop Current

Returns PV, SV and TV

values and corresponding unit

values along with AO value

6 Write Polling Address Changes Field Device’s

polling address and loop

current mode

7 Read Loop Configuration Returns polling address and

loop current mode status

8 Read Dynamic Variable Classifications

Returns dynamic variables

classification

9 Read Device Variables with Status Returns device variables with

status

11 Read Unique Identifier Associated With Tag

Same response as command 0

when Tag matches

12 Read Message Returns 24 bytes of packed

ASCII data

13 Read Tag, Descriptor, Date Returns tag, descriptor

(packed ASCII format) and

date from the device

14 Read Primary Variable Transducer Information

Returns PV transducer limits

and span

15 Read Device Information Returns PV unit value, LRV,

URV, damping value and

write protect code

16 Read Final Assembly Number Returns final assembly number

17 Write Message Write 24 bytes of packed

ASCII data.

18 Write Tag, Descriptor, Date Writes tag, descriptor (packed

ASCII format) and date to the

device

Page 273: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI pH-Redox HART Manual

109349.00 / 240616 13

19 Write Final Assembly Number Writes final assembly number

to the device

20 Read Long Tag Returns 32-byte Long Tag

21 Read Unique Identifier Associated with Long Tag Same response as command 0

when Long Tag matches

22 Write Long Tag Writes Long Tag to the Field

Device

38 Reset Configuration Changed Flag Resets the configuration

change flag

48 Read Additional Device Status See 7.3 for details

Page 274: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI pH-Redox HART Manual

109349.00 / 240616 14

9. COMMON-PRACTICE COMMANDS

9.1 Supported Common Practice Commands

9.2 Burst Mode This Field Device does not support Burst Mode.

9.3 Catch Device Variable This Field Device does not support Catch Device Variable.

10. DEVICE-SPECIFIC COMMANDS This Field Device does not support Device Specific Commands.

Number Name Notes

33 Read Device Variables Returns all the Supported

Device Variables

50 Read Dynamic Variable Assignment Returns the Variable Numbers

associated with PV, SV and TV

51 Write Dynamic Variable Assignment

Writes the Variable Numbers

associated with PV, SV and TV

Page 275: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI pH-Redox HART Manual

109349.00 / 240616 15

11. TABLES

11.1 Engineering Type Unit Codes

Units of Measurement Unit Code

Temperature Degrees Celsius 32

Electric Potential millivolts 36

Electric Resistance Ω 37

Miscellaneous Hertz 38

Electric Current milliamperes 39

Time Minutes 50

Time Seconds 51

Time Hours 52

Time Days 53

Miscellaneous Percent 57

Electric Potential Volts 58

Miscellaneous pH 59

Miscellaneous Micro Siemens per centimeter 67

Flow Liters per hour 138

Concentration Parts per million 139

Electric Resistance kΩ 163

Concentration Parts per billion 169

Not used 250

Special 253

11.2 Classification Type Unit Codes

Measurement Meas. Code

Temperature 64

Volumetric flow 66

Time 70

Frequency 80

Analytical 81

Electric Potential 83

Current 84

Resistance 85

Conductance 87

Concentration 90

Turbidity 97

Not used 250

Special 253

Page 276: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI pH-Redox HART Manual

109349.00 / 240616 16

12. PERFORMANCE

12.1 Sampling Rates Typical sampling rates are shown in the following table.

pH sensor value sample 1 per second

Redox sensor value sample 1 per second

Flow rate sensor value sample 1 per second

Case Temperature sensor sample 1 per second

Temperature sensor sample 1 per second

Note: all the Device Variables use an Infinite Impulse Response Filter, with coefficients depending

on the measured variable. The Damping Value is different for each of the Device Variables, and can

be read with command 15.

12.2 Power-Up On power up, the transmitter takes approximately 8 seconds to be ready. During this period, the

device will not respond to HART commands.

12.3 Command Response Times

Minimum 2ms

Typical 5ms

Maximum 150ms

12.4 Long Messages The largest data field used is in the response to command 9: up to 71 bytes including the two status

bytes.

12.5 Non-Volatile Memory EEPROM is used to hold the device’s configuration parameters. New data is written to this memory

immediately on execution of a write command, before the consequent response.

12.6 Modes Loop current mode can be disabled or enabled using command 6.

12.7 Write Protection Write-protection is not selectable, and is always set as “not write protected”.

12.8 Damping Damping time is calculated for each dynamic variable.

Page 277: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI pH-Redox HART Manual

109349.00 / 240616 17

ANNEX A. CAPABILITY CHECKLIST

Manufacturer, model and revision SWAN Analytical Instruments, AMI pH-Redox rev. 1

Device type Transmitter

HART revision 7.x

Device Description available Yes

Number and type of sensors 5 (four external, one internal)

Number and type of actuators 0

Number and type of host side signals 1: 4 - 20mA analog

Number of Device Variables 4

Number of Dynamic Variables 3

Mappable Dynamic Variables? Yes

Number of common-practice commands 3

Number of device-specific commands 0

Bits of additional device status 32

Alternative operating modes? No

Burst mode? No

Write-protection? No

Page 278: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI pH-Redox HART Manual

109349.00 / 240616 18

ANNEX B. DEFAULT CONFIGURATION

Parameter Default value

Sensor Type pH or Redox (depends on the sensor mounted)

Lower Range Value 0.0 pH / 0mV

Upper Range Value 14.0 pH / 1000mV

PV Units pH / mV

Damping time constant 4.77 seconds

Fault-indication jumper Not used

Write-protect jumper Not used

Number of response preambles 5

Page 279: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI pH-Redox HART Manual

109349.00 / 240616 19

ANNEX C. REVISION HISTORY

Document Title HART Interface Description AMI pH-Redox

Document ID 109349.00

Document

Revision

Date Device Revision DD Revision Description

1.0 24/06/2016 1 1 First release, for

HART 7.x Device

Page 280: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments

HART® 7.x Field Device Specification for AMI Powercon Transmitters

SWAN Analytical Instruments

8340, Studbachstrasse 13

Hinwil

Switzerland

Page 281: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Powercon HART Manual

109346.00 / 100316 2

TABLE OF CONTENTS

1. Introduction ......................................................................................................................................4

1.1 Scope ....................................................................................................................................4

1.2 Purpose .................................................................................................................................4

1.3 Who should use this document? ..........................................................................................4

1.4 References ............................................................................................................................4

2. Device Identification ........................................................................................................................5

3. Product Overview ............................................................................................................................5

3.1 Connections..........................................................................................................................5

3.1.1 Point to point Mode ..............................................................................................5

3.1.2 Multidrop Mode ....................................................................................................6

3.1.3 HARTREC Board .................................................................................................6

4. Product Interfaces ............................................................................................................................7

4.1 Process Interface ..................................................................................................................7

4.1.1 Sensor Input Channels ..........................................................................................7

4.2 Process Flow Rate 4-20mA Analog Output .........................................................................7

4.3 Local Interfaces ....................................................................................................................7

4.3.1 Local Controls and Displays .................................................................................7

4.3.2 Write Protection ....................................................................................................7

5. Device Variables ..............................................................................................................................8

5.1 Device Variable 0 Conductivity ...........................................................................................8

5.2 Device Variable 1 Temperature ...........................................................................................8

5.3 Device Variable 2 Flow Rate ...............................................................................................8

5.4 Device Variable 3 Uncompensated Conductivity ................................................................8

5.5 Device Variable 4 Case Temperature ..................................................................................8

6. Dynamic Variables ...........................................................................................................................9

6.1 Mappable Variables .............................................................................................................9

6.2 PV Transfer Functions .........................................................................................................9

7. Status Information ..........................................................................................................................10

7.1 Field Device Status ............................................................................................................10

Page 282: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Powercon HART Manual

109346.00 / 100316 3

7.2 Extended Device Status .....................................................................................................10

7.3 Additional Device Status (Command #48) ........................................................................11

8. Universal Commands .....................................................................................................................12

9. Common-Practice Commands .......................................................................................................14

9.1 Supported Common Practice Commands ..........................................................................14

9.2 Burst Mode .........................................................................................................................14

9.3 Catch Device Variable .......................................................................................................14

10. Device-Specific Commands ...........................................................................................................14

11. Tables 15

11.1 Engineering Type Unit Codes ............................................................................................15

11.2 Classification Type Unit Codes .........................................................................................15

12. Performance ...................................................................................................................................16

12.1 Sampling Rates ..................................................................................................................16

12.2 Power-Up ...........................................................................................................................16

12.3 Command Response Times................................................................................................16

12.4 Long Messages ...................................................................................................................16

12.5 Non-Volatile Memory ........................................................................................................16

12.6 Modes .................................................................................................................................16

12.7 Write Protection .................................................................................................................16

12.8 Damping .............................................................................................................................17

Annex A. Capability Checklist ...........................................................................................................18

Annex B. Default Configuration ........................................................................................................19

Annex C. Revision History ................................................................................................................20

Page 283: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Powercon HART Manual

109346.00 / 100316 4

1. INTRODUCTION

1.1 Scope The SWAN Analytical Instruments model AMI Powercon transmitter complies with HART Protocol

Revision 7.5. This document specifies all the device specific features and documents HART

Protocol implementation details (i.e. the Engineering Unit Codes supported). The functionality of

this Field Device is described sufficiently to allow its proper application in a process and its

complete support in HART capable Host Applications.

1.2 Purpose This specification is designed to complement the AMI Powercon manual by providing a complete

description of this Field Device from a HART Communication perspective.

1.3 Who should use this document? The specification is designed to be a technical reference for HART capable Host Application

Developers, System Integrators and knowledgeable End Users. It also provides functional

specifications (e.g., commands and performance requirements) used during development,

maintenance and testing. This document assumes the reader is familiar with HART Protocol

requirements and terminology.

1.4 References

HART Smart Communications Protocol Specification. HCF_SPEC-12. Available from the

HCF.

MenAMI_ Powercon _xx.pdf. Available from the SWAN Analytical Instruments web page.

Page 284: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Powercon HART Manual

109346.00 / 100316 5

2. DEVICE IDENTIFICATION

Manufacturer Name: SWAN Analytical

Instruments Model Name(s): AMI Powercon

Manufacture ID Code: 24757 (60B5

Hex) Device Type

Code:

58150 (E326

Hex)

HART Protocol Revision 7.5 Device Revision: 1

Number of Device Variables 5

Physical Layers Supported FSK

Physical Device Category Transmitter, Non-DC-isolated Bus Device

3. PRODUCT OVERVIEW

The AMI Powercon HART communication option board provides a 4 to 20mA output signal and can

be monitored and configured using a HART master device or a hand-held communicator.

3.1 Connections

3.1.1 Point to point Mode

An external minimum 250 Ω (maximum 800 Ω) resistor is needed in order to communicate with

HART protocol.

Page 285: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Powercon HART Manual

109346.00 / 100316 6

3.1.2 Multidrop Mode

A single minimum 250 Ω resistor (maximum 800 Ω) is needed to communicate with all the

instruments connected to the bus, and each of them must provide 4mA.

3.1.3 HARTREC Board

The HARTREC Board must be installed in the AMI transmitter in order to communicate with

HART.

Page 286: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Powercon HART Manual

109346.00 / 100316 7

4. PRODUCT INTERFACES

4.1 Process Interface

4.1.1 Sensor Input Channels

Refer to AMI Powercon manual to details on mounting Conductivity and Flow sensors.

4.2 Process Flow Rate 4-20mA Analog Output The 4 to 20mA output of the AMI Powercon HART option board represents a process value

measurement, scaled according to the configured range of the instrument. This output corresponds to the Primary Variable. HART Communication is supported on this loop.

Since Dynamic Variables are mappable, PV can correspond to one of the following variables:

- Conductivity

- Temperature

- Flow rate

- Uncompensated Conductivity

It is also possible to set the PV from the instrument local display, in the “Signal Output 3 /

Parameter” settings.

4.3 Local Interfaces

4.3.1 Local Controls and Displays

This device has a local display that allows the complete configurability of the instrument.

Refer to AMI Powercon manual to details on it.

4.3.2 Write Protection

The Field Device has no “Write protection mode”.

Page 287: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Powercon HART Manual

109346.00 / 100316 8

5. DEVICE VARIABLES This Field Device exposes five Device Variables

Device Variables Variables Meaning Units

0 Conductivity uS/cm

1 Temperature °C

2 Flow Rate l/h

3 Uncomp. Conductivity uS/cm

4 Case Temperature °C

5.1 Device Variable 0 Conductivity The Conductivity is read by the Slot-lock or Cation Conductivity sensor (Refer to AMI Powercon

manual to details on it).

5.2 Device Variable 1 Temperature Temperature is read by the temperature sensor inside the Conductivity sensor (Refer to AMI

Powercon manual to details on it).

5.3 Device Variable 2 Flow Rate Flow Rate is read by the Flow sensor (Refer to AMI Powercon manual to details on it).

5.4 Device Variable 3 Uncompensated Conductivity Uncomp. Conductivity is read by the Conductivity sensor.

5.5 Device Variable 4 Case Temperature Case Temperature shows the Temperature read inside the Electronic Box.

Page 288: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Powercon HART Manual

109346.00 / 100316 9

6. DYNAMIC VARIABLES

6.1 Mappable Variables Four mappable Dynamic Variables are implemented.

Dynamic Variables Variables Meaning Units

PV

Conductivity– Temperature – Flow Rate –

Uncomp_ Cond. uS/cm - °C – l/h – uS/cm

SV

Conductivity– Temperature – Flow Rate –

Uncomp_ Cond. uS/cm - °C – l/h – uS/cm

TV

Conductivity– Temperature – Flow Rate –

Uncomp_ Cond. uS/cm - °C – l/h – uS/cm

QV

Conductivity– Temperature – Flow Rate –

Uncomp_ Cond. uS/cm - °C – l/h – uS/cm

It is possible to associate any of these dynamic variables to PV, SV, TV or QV with a HART Master

(or Handheld Communicator).

The PV is also settable from the instrument local display’s settings.

6.2 PV Transfer Functions The Primary Variable Transfer Function can be read with command 15. Its meaning is referred to the

following table.

Transfer Function Type Code

Linear 240

Bilinear 241

Logarithmic 242

Control Upwards 243

Control Downwards 244

Page 289: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Powercon HART Manual

109346.00 / 100316 10

7. STATUS INFORMATION

7.1 Field Device Status

The functions of the Field Device Status bits are specified in HCF_SPEC-99. Further details of their

implementation are described in the following table.

Bit Name Notes

7 Device Malfunction Set on any detected Hardware Error

6 Configuration Changed Set if any changes are made to Field Device Configuration

5 Cold Start Set when powered-up or after a device reset

4 More Status Available

Set if any Alarm or Maintenance has changed its status. More

information is available via command 48

3 Loop Current Fixed The Loop Current is being held at a fixed value and is not

responding to process variations

2 Loop Current Saturated The Loop Current has reached its upper (or lower) endpoint

limit and cannot increase (or decrease) any further

1 Non-PV Out of Limits

A Device Variable not mapped to the PV is beyond its

operating limits

0 PV Out of Limits The PV is beyond its operating limit

7.2 Extended Device Status Contains additional information regarding the status of the Field Device.

Bit Name Notes

2 Critical Power Failure Set when battery is becoming critically low (less than 15

min) and Field Device not connected to Power Supply

1 Device Variable Alert

Set when one or more Device Variables are in one of the

following conditions:

Hi/low limited (Limit Status)

Bad (Process Data Status)

Poor Accuracy (Process Data Status)

0 Maintenance Required Not Used

Page 290: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Powercon HART Manual

109346.00 / 100316 11

7.3 Additional Device Status (Command #48) Command #48 returns 6 additional bytes of data (Int32 or Int16 Little Endian), with the following

status information:

Byte Bit Meaning Alarm Code

0 – 3

(INT32)

0 Cond. Alarm high E001

1 Cond. Alarm low E002

2 Reserved

3 Reserved

4 Reserved

5 Reserved

6 Sample Temp. high E007

7 Sample Temp. low E008

8 Sample Flow high

E009

9 Sample Flow low

E010

10 Temp. shorted E011

11 Temp. disconnected E012

12 Case Temp. high E013

13 Case Temp. low E014

14 Reserved

15 Reserved

16 Control Timeout E017

17 Quality Assurance E018

18 Undefined E019

19 Reserved

20 Reserved

21 Reserved

22 Reserved

23 Input active E024

24 IC MK41T56

E025

25 IC LM75

E026

26 IC PCF8574

E027

27 Signal output open

E028

28 EEProm Motherboard

E029

29 EEProm Frontend

E030

30 Cal. Recout

E031

31 Wrong Frontend

E032

"Reserved" bits are always set to 0.

All bits used in this four bytes indicate device or sensor failure, and always set bit 4 of the Device

Status byte.

Page 291: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Powercon HART Manual

109346.00 / 100316 12

8. UNIVERSAL COMMANDS Number Name Notes

0 Read Unique Identifier Returns identity information

of the Field Device

1 Read Primary Variable Returns PV value and its unit

2 Read Loop Current and Percent of Range

Returns AO value and % range

3 Read Dynamic Variables and Loop Current

Returns PV, SV, TV and QV

values and corresponding unit

values along with AO value

6 Write Polling Address Changes Field Device’s

polling address and loop

current mode

7 Read Loop Configuration Returns polling address and

loop current mode status

8 Read Dynamic Variable Classifications

Returns dynamic variables

classification

9 Read Device Variables with Status Returns device variables with

status

11 Read Unique Identifier Associated With Tag

Same response as command 0

when Tag matches

12 Read Message Returns 24 bytes of packed

ASCII data

13 Read Tag, Descriptor, Date Returns tag, descriptor

(packed ASCII format) and

date from the device

14 Read Primary Variable Transducer Information

Returns PV transducer limits

and span

15 Read Device Information Returns PV unit value, LRV,

URV, damping value and

write protect code

16 Read Final Assembly Number Returns final assembly number

17 Write Message Write 24 bytes of packed

ASCII data.

18 Write Tag, Descriptor, Date Writes tag, descriptor (packed

ASCII format) and date to the

device

Page 292: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Powercon HART Manual

109346.00 / 100316 13

19 Write Final Assembly Number Writes final assembly number

to the device

20 Read Long Tag Returns 32-byte Long Tag

21 Read Unique Identifier Associated with Long Tag Same response as command 0

when Long Tag matches

22 Write Long Tag Writes Long Tag to the Field

Device

38 Reset Configuration Changed Flag Resets the configuration

change flag

48 Read Additional Device Status See 7.3 for details

Page 293: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Powercon HART Manual

109346.00 / 100316 14

9. COMMON-PRACTICE COMMANDS

9.1 Supported Common Practice Commands

9.2 Burst Mode This Field Device does not support Burst Mode.

9.3 Catch Device Variable This Field Device does not support Catch Device Variable.

10. DEVICE-SPECIFIC COMMANDS This Field Device does not support Device Specific Commands.

Number Name Notes

33 Read Device Variables Returns all the Supported

Device Variables

50 Read Dynamic Variable Assignment

Returns the Variable Numbers

associated with PV, SV,TV and

QV

51 Write Dynamic Variable Assignment

Writes the Variable Numbers

associated with PV, SV,TV and

QV

Page 294: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Powercon HART Manual

109346.00 / 100316 15

11. TABLES

11.1 Engineering Type Unit Codes

Units of Measurement Unit Code

Temperature Degrees Celsius 32

Electric Potential millivolts 36

Electric Resistance Ω 37

Miscellaneous Hertz 38

Electric Current milliamperes 39

Time Minutes 50

Time Seconds 51

Time Hours 52

Time Days 53

Miscellaneous Percent 57

Electric Potential Volts 58

Miscellaneous pH 59

Miscellaneous Micro Siemens per centimeter 67

Flow Liters per hour 138

Concentration Parts per million 139

Electric Resistance kΩ 163

Concentration Parts per billion 169

Not used 250

Special 253

11.2 Classification Type Unit Codes

Measurement Meas. Code

Temperature 64

Volumetric flow 66

Time 70

Frequency 80

Analytical 81

Electric Potential 83

Current 84

Resistance 85

Conductance 87

Concentration 90

Turbidity 97

Not used 250

Special 253

Page 295: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Powercon HART Manual

109346.00 / 100316 16

12. PERFORMANCE

12.1 Sampling Rates Typical sampling rates are shown in the following table.

Conductivity sensor value sample 1 per second

Temperature sensor value sample 1 per second

Flow rate sensor value sample 1 per second

Uncompensated conductivity value sample 1 per second

Case Temperature sensor sample 1 per second

Note: all the Device Variables use an Infinite Impulse Response Filter, with coefficients depending

on the measured variable. The Damping Value is different for each of the Device Variables, and can

be read through Command 15.

12.2 Power-Up On power up, the transmitter takes approximately 10 seconds to be ready. During this period, the

device will not respond to HART commands.

12.3 Command Response Times

Minimum 2ms

Typical 5ms

Maximum 150ms

12.4 Long Messages The largest data field used is in the response to Command 9: up to 71 bytes including the two status

bytes.

12.5 Non-Volatile Memory EEPROM is used to hold the device’s configuration parameters. New data is written to this memory

immediately on execution of a write command, before the consequent response.

12.6 Modes Loop current mode can be disabled or enabled using command 6.

12.7 Write Protection Write-protection is not selectable, and is always set as “not write protected”.

Page 296: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Powercon HART Manual

109346.00 / 100316 17

12.8 Damping Damping time is calculated for each dynamic variable.

Page 297: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Powercon HART Manual

109346.00 / 100316 18

ANNEX A. CAPABILITY CHECKLIST

Manufacturer, model and revision SWAN Analytic Instruments, AMI Powercon rev. 1

Device type Transmitter

HART revision 7.x

Device Description available Yes

Number and type of sensors 4 (three external, one internal)

Number and type of actuators 0

Number and type of host side signals 1: 4 - 20mA analog

Number of Device Variables 5

Number of Dynamic Variables 4

Mappable Dynamic Variables? Yes

Number of common-practice commands 3

Number of device-specific commands 0

Bits of additional device status 32

Alternative operating modes? No

Burst mode? No

Write-protection? No

Page 298: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Powercon HART Manual

109346.00 / 100316 19

ANNEX B. DEFAULT CONFIGURATION

Parameter Default value

PV Sensor Type Conductivity

Lower Range Value 0 uS/cm

Upper Range Value 300000 uS/cm

PV Units uS/cm

Damping time constant 1.592 seconds

Fault-indication jumper Not used

Write-protect jumper Not used

Number of response preambles 5

Page 299: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Powercon HART Manual

109346.00 / 100316 20

ANNEX C. REVISION HISTORY

Document Title HART Interface Description AMI Powercon

Document ID 109346.00

Document

Revision

Date Device Revision DD Revision Description

1.0 10/03/2016 1 1 First release, for

HART 7.x Device

Page 300: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments

HART® 7.x Field Device Specification for AMI Rescon Transmitters

SWAN Analytical Instruments 8340, Studbachstrasse 13

Hinwil Switzerland

Page 301: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Rescon HART Manual

109363.00 / 280616 2

TABLE OF CONTENTS

1. Introduction ......................................................................................................................................4

1.1 Scope ....................................................................................................................................4

1.2 Purpose .................................................................................................................................4

1.3 Who should use this document? ..........................................................................................4

1.4 References ............................................................................................................................4

2. Device Identification ........................................................................................................................5

3. Product Overview ............................................................................................................................5

3.1 Connections..........................................................................................................................5

3.1.1 Point to point Mode ..............................................................................................5

3.1.2 Multidrop Mode ....................................................................................................6

3.1.3 HARTREC Board .................................................................................................6

4. Product Interfaces ............................................................................................................................7

4.1 Process Interface ..................................................................................................................7

4.1.1 Sensor Input Channels ..........................................................................................7

4.2 Process Flow Rate 4-20mA Analog Output .........................................................................7

4.3 Local Interfaces ....................................................................................................................7

4.3.1 Local Controls and Displays .................................................................................7

4.3.2 Write Protection ....................................................................................................7

5. Device Variables ..............................................................................................................................8

5.1 Device Variable 0 Resistivity - Conductivity ......................................................................8

5.2 Device Variable 1 Temperature ...........................................................................................8

5.3 Device Variable 2 Flow Rate ...............................................................................................8

5.4 Device Variable 3 Uncomp. Res./Cond. ..............................................................................8

5.5 Device Variable 4 Case Temperature ..................................................................................8

6. Dynamic Variables ...........................................................................................................................9

6.1 Mappable Variables .............................................................................................................9

6.2 PV Transfer Functions .........................................................................................................9

7. Status Information ..........................................................................................................................10

7.1 Field Device Status ............................................................................................................10

Page 302: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Rescon HART Manual

109363.00 / 280616 3

7.2 Extended Device Status .....................................................................................................10

7.3 Additional Device Status (Command #48) ........................................................................11

8. Universal Commands .....................................................................................................................12

9. Common-Practice Commands .......................................................................................................14

9.1 Supported Common Practice Commands ..........................................................................14

9.2 Burst Mode .........................................................................................................................14

9.3 Catch Device Variable .......................................................................................................14

10. Device-Specific Commands ...........................................................................................................14

11. Tables 15

11.1 Engineering Type Unit Codes ............................................................................................15

11.2 Unit Type Unit Codes ........................................................................................................15

12. Performance ...................................................................................................................................16

12.1 Sampling Rates ..................................................................................................................16

12.2 Power-Up ...........................................................................................................................16

12.3 Command Response Times................................................................................................16

12.4 Long Messages ...................................................................................................................16

12.5 Non-Volatile Memory ........................................................................................................16

12.6 Modes .................................................................................................................................16

12.7 Write Protection .................................................................................................................16

12.8 Damping .............................................................................................................................16

Annex A. Capability Checklist ...........................................................................................................17

Annex B. Default Configuration ........................................................................................................18

Annex C. Revision History ................................................................................................................19

Page 303: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Rescon HART Manual

109363.00 / 280616 4

1. INTRODUCTION 1.1 Scope The SWAN Analytical Instruments model AMI Rescon transmitter complies with HART Protocol Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering Unit Codes supported). The functionality of this Field Device is described sufficiently to allow its proper application in a process and its complete support in HART capable Host Applications.

1.2 Purpose This specification is designed to complement the AMI Rescon manual by providing a complete description of this Field Device from a HART Communication perspective.

1.3 Who should use this document? The specification is designed to be a technical reference for HART capable Host Application Developers, System Integrators and knowledgeable End Users. It also provides functional specifications (e.g., commands and performance requirements) used during development, maintenance and testing. This document assumes the reader is familiar with HART Protocol requirements and terminology.

1.4 References HART Smart Communications Protocol Specification. HCF_SPEC-12. Available from the HCF.

MenAMI_Rescon_xx.pdf. Available from the SWAN Analytical Instruments web page.

Page 304: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Rescon HART Manual

109363.00 / 280616 5

2. DEVICE IDENTIFICATION Manufacturer Name: SWAN Analytical

Instruments Model Name(s): AMI Rescon

Manufacture ID Code: 24757 (60B5 Hex)

Device Type Code:

58190 (E34E Hex)

HART Protocol Revision 7.5 Device Revision: 1

Number of Device Variables 5

Physical Layers Supported FSK

Physical Device Category Transmitter, Non-DC-isolated Bus Device

3. PRODUCT OVERVIEW The AMI Rescon HART communication option board provides a 4 to 20mA output signal and can be monitored and configured using a HART master device or a hand-held communicator.

3.1 Connections 3.1.1 Point to point Mode

An external minimum 250 Ω (maximum 800 Ω) resistor is needed in order to communicate with HART protocol.

Page 305: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Rescon HART Manual

109363.00 / 280616 6

3.1.2 Multidrop Mode

A single minimum 250 Ω resistor (maximum 800 Ω) is needed to communicate with all the instruments connected to the bus, and each of them must provide 4mA.

3.1.3 HARTREC Board

The HARTREC Board must be installed in the AMI transmitter in order to communicate with HART.

Page 306: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Rescon HART Manual

109363.00 / 280616 7

4. PRODUCT INTERFACES 4.1 Process Interface 4.1.1 Sensor Input Channels Refer to AMI Rescon manual to details on mounting Conductivity and Flow sensors.

4.2 Process Flow Rate 4-20mA Analog Output The 4 to 20mA output of the AMI Rescon HART option board represents a process value measurement, scaled according to the configured range of the instrument. This output corresponds to the Primary Variable. HART Communication is supported on this loop.

Since Dynamic Variables are mappable, PV can correspond to one of the following variables:

- Resistivity / Conductivity

- Temperature

- Flow rate

- Uncompensated Resistivity / Uncompensated Conductivity

It is also possible to set the PV from the instrument local display, in the “Signal Output 3 / Parameter” settings.

4.3 Local Interfaces 4.3.1 Local Controls and Displays This device has a local display that allows the complete configurability of the instrument.

Refer to AMI Rescon manual to details on it.

4.3.2 Write Protection The Field Device has no “Write protection mode”.

Page 307: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Rescon HART Manual

109363.00 / 280616 8

5. DEVICE VARIABLES This Field Device exposes five Device Variables

Device Variables Variables Meaning Units 0 Resistivity-Conductivity MΩ - uS/cm

1 Temperature °C

2 Flow Rate l/h

3 Uncomp. Resistivity –

Uncomp. Conductivity MΩ - uS/cm

4 Case Temperature °C

5.1 Device Variable 0 Resistivity - Conductivity The Resistivity - Conductivity is read by Conductivity sensor RC-U [A] (Refer to AMI Rescon manual to details on it).

5.2 Device Variable 1 Temperature Temperature is read by the temperature sensor inside the Conductivity sensor RC-U [A] (Refer to AMI Rescon manual to details on it).

5.3 Device Variable 2 Flow Rate Flow Rate is read by the Flow sensor (Refer to AMI Rescon manual to details on it).

5.4 Device Variable 3 Uncomp. Res./Cond. Uncomp. Resistivity – Uncomp. Conductivity is read by the Conductivity sensor RC-U[A].

5.5 Device Variable 4 Case Temperature Case Temperature shows the Temperature read inside the Electronic Box.

Page 308: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Rescon HART Manual

109363.00 / 280616 9

6. DYNAMIC VARIABLES 6.1 Mappable Variables Four mappable Dynamic Variables are implemented.

Dynamic Variables Variables Meaning Units

PV Res./Cond– Temperature – Flow Rate –

Uncomp_ Res/Cond. MΩ,uS/cm - °C – l/h –

MΩ,uS/cm

SV Res./Cond– Temperature – Flow Rate –

Uncomp_ Res/Cond. MΩ,uS/cm - °C – l/h –

MΩ,uS/cm

TV Res./Cond– Temperature – Flow Rate –

Uncomp_ Res/Cond. MΩ,uS/cm - °C – l/h –

MΩ,uS/cm

QV Res./Cond– Temperature – Flow Rate –

Uncomp_ Res/Cond. MΩ,uS/cm - °C – l/h –

MΩ,uS/cm

It is possible to associate any of these dynamic variables to PV, SV, TV or QV with a HART Master (or Handheld Communicator).

The PV is also settable from the instrument local display’s settings.

6.2 PV Transfer Functions The Primary Variable Transfer Function can be read with command 15. Its meaning is referred to the following table.

Transfer Function Type Code

Linear 240

Bilinear 241

Logarithmic 242

Control Upwards 243

Control Downwards 244

Page 309: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Rescon HART Manual

109363.00 / 280616 10

7. STATUS INFORMATION 7.1 Field Device Status The functions of the Field Device Status bits are specified in HCF_SPEC-99. Further details of their implementation are described in the following table.

Bit Name Notes

7 Device Malfunction Set on any detected Hardware Error

6 Configuration Changed Set if any changes are made to Field Device Configuration

5 Cold Start Set when powered-up or after a device reset

4 More Status Available Set if any Alarm or Maintenance has changed its status. More information is available via command 48

3 Loop Current Fixed The Loop Current is being held at a fixed value and is not responding to process variations

2 Loop Current Saturated The Loop Current has reached its upper (or lower) endpoint limit and cannot increase (or decrease) any further

1 Non-PV Out of Limits A Device Variable not mapped to the PV is beyond its

operating limits

0 PV Out of Limits The PV is beyond its operating limit

7.2 Extended Device Status Contains additional information regarding the status of the Field Device.

Bit Name Notes

2 Critical Power Failure Set when battery is becoming critically low (less than 15 min) and Field Device not connected to Power Supply

1 Device Variable Alert

Set when one or more Device Variables are in one of the following conditions:

• Hi/low limited (Limit Status)

• Bad (Process Data Status)

• Poor Accuracy (Process Data Status)

0 Maintenance Required Not Used

Page 310: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Rescon HART Manual

109363.00 / 280616 11

7.3 Additional Device Status (Command #48) Command #48 returns 4 additional bytes of data (Int32 or Int16 Little Endian), with the following status information:

Byte Bit Meaning Alarm Code

0 – 3

(INT32)

0 Alarm high E001 1 Alarm low E002 2 Reserved 3 Reserved 4 Reserved 5 Reserved 6 Sample Temp. high E007 7 Sample Temp. low E008 8 Sample Flow high E009 9 Sample Flow low E010 10 Temp. shorted E011 11 Temp. disconnected E012 12 Case Temp. high E013 13 Case Temp. low E014 14 USP Error E015 15 Reserved 16 Control Timeout E017 17 Reserved 18 Sensor shorted E019 19 Sensor interrupted E020 20 Reserved 21 Reserved 22 Reserved 23 Input active E024 24 IC MK41T56 E025 25 IC LM75 E026 26 IC PCF8574 E027 27 Signal output open E028 28 EEProm Motherboard E029 29 EEProm Frontend E030 30 Calibration Recout E031 31 Wrong Frontend E032

"Reserved" bits are always set to 0.

All bits used in this four bytes indicate device or sensor failure, and always set bit 4 of the Device Status byte.

Page 311: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Rescon HART Manual

109363.00 / 280616 12

8. UNIVERSAL COMMANDS Number Name Notes

0 Read Unique Identifier Returns identity information of the Field Device

1 Read Primary Variable Returns PV value and its unit

2 Read Loop Current and Percent of Range Returns AO value and % range

3 Read Dynamic Variables and Loop Current Returns PV, SV, TV and QV values and corresponding unit values along with AO value

6 Write Polling Address Changes Field Device’s polling address and loop current mode

7 Read Loop Configuration Returns polling address and loop current mode status

8 Read Dynamic Variable Classifications Returns dynamic variables classification

9 Read Device Variables with Status Returns device variables with status

11 Read Unique Identifier Associated With Tag Same response as command 0 when Tag matches

12 Read Message Returns 24 bytes of packed ASCII data

13 Read Tag, Descriptor, Date Returns tag, descriptor (packed ASCII format) and date from the device

14 Read Primary Variable Transducer Information Returns PV transducer limits and span

15 Read Device Information Returns PV unit value, LRV, URV, damping value and write protect code

16 Read Final Assembly Number Returns final assembly number

17 Write Message Write 24 bytes of packed ASCII data.

18 Write Tag, Descriptor, Date Writes tag, descriptor (packed ASCII format) and date to the device

Page 312: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Rescon HART Manual

109363.00 / 280616 13

19 Write Final Assembly Number Writes final assembly number to the device

20 Read Long Tag Returns 32-byte Long Tag

21 Read Unique Identifier Associated with Long Tag Same response as command 0 when Long Tag matches

22 Write Long Tag Writes Long Tag to the Field Device

38 Reset Configuration Changed Flag Resets the configuration change flag

48 Read Additional Device Status See 7.3 for details

Page 313: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Rescon HART Manual

109363.00 / 280616 14

9. COMMON-PRACTICE COMMANDS

9.1 Supported Common Practice Commands

9.2 Burst Mode This Field Device does not support Burst Mode.

9.3 Catch Device Variable This Field Device does not support Catch Device Variable.

10. DEVICE-SPECIFIC COMMANDS This Field Device does not support Device Specific Commands.

Number Name Notes

33 Read Device Variables Returns all the Supported Device Variables

50 Read Dynamic Variable Assignment Returns the Variable Numbers associated with PV, SV,TV and QV

51 Write Dynamic Variable Assignment Writes the Variable Numbers associated with PV, SV,TV and QV

Page 314: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Rescon HART Manual

109363.00 / 280616 15

11. TABLES 11.1 Engineering Type Unit Codes

Units of Measurement Unit Code Temperature Degrees Celsius 32 Electric Potential millivolts 36 Electric Resistance Ω 37 Miscellaneous Hertz 38 Electric Current milliamperes 39 Time Minutes 50 Time Seconds 51 Time Hours 52 Time Days 53 Miscellaneous Percent 57 Electric Potential Volts 58 Miscellaneous pH 59 Miscellaneous Micro Siemens per centimeter 67 Flow Liters per hour 138 Concentration Parts per million 139 Electric Resistance kΩ 163 Concentration Parts per billion 169 Electric Resistance MΩ 170 Not used 250 Special 253

11.2 Unit Type Unit Codes Measurement Meas. Code Temperature 64 Volumetric flow 66 Time 70 Frequency 80 Analytical 81 Electric Potential 83 Current 84 Resistance 85 Conductance 87 Concentration 90 Turbidity 97 Not used 250 Special 253

Page 315: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Rescon HART Manual

109363.00 / 280616 16

12. PERFORMANCE 12.1 Sampling Rates Typical sampling rates are shown in the following table.

Resistivity-Conductivity sensor value sample 1 per second

Temperature sensor value sample 1 per second

Flow rate sensor value sample 1 per second

Uncompensated Resistivity-Conductivity value sample

1 per second

Case Temperature sensor sample 1 per second

Note: all the Device Variables use an Infinite Impulse Response Filter, with coefficients depending on the measured variable. The Damping Value is different for each of the Device Variables, and can be read through Command 15.

12.2 Power-Up On power up, the transmitter takes approximately 10 seconds to be ready. During this period, the device will not respond to HART commands.

12.3 Command Response Times

Minimum 2ms

Typical 5ms

Maximum 150ms

12.4 Long Messages The largest data field used is in the response to Command 9: up to 71 bytes including the two status bytes.

12.5 Non-Volatile Memory EEPROM is used to hold the device’s configuration parameters. New data is written to this memory immediately on execution of a write command, before the consequent response.

12.6 Modes Loop current mode can be disabled or enabled using command 6.

12.7 Write Protection Write-protection is not selectable, and is always set as “not write protected”.

12.8 Damping Damping time is calculated for each dynamic variable.

Page 316: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Rescon HART Manual

109363.00 / 280616 17

ANNEX A. CAPABILITY CHECKLIST

Manufacturer, model and revision SWAN Analytic Instruments, AMI Rescon rev. 1

Device type Transmitter

HART revision 7.x

Device Description available Yes

Number and type of sensors 4 (three external, one internal)

Number and type of actuators 0

Number and type of host side signals 1: 4 - 20mA analog

Number of Device Variables 5

Number of Dynamic Variables 4

Mappable Dynamic Variables? Yes

Number of common-practice commands 3

Number of device-specific commands 0

Bits of additional device status 32

Alternative operating modes? No

Burst mode? No

Write-protection? No

Page 317: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Rescon HART Manual

109363.00 / 280616 18

ANNEX B. DEFAULT CONFIGURATION

Parameter Default value

PV Sensor Type Resistivity

Lower Range Value 0 MΩ

Upper Range Value 200 MΩ

PV Units MΩ

Damping time constant 3.185 seconds

Fault-indication jumper Not used

Write-protect jumper Not used

Number of response preambles 5

Page 318: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Rescon HART Manual

109363.00 / 280616 19

ANNEX C. REVISION HISTORY

Document Title HART Interface Description AMI Rescon

Document ID 109363.00

Document Revision

Date Device Revision DD Revision Description

1.0 28/06/2016 1 1 First release, for HART 7.x Device

Page 319: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments

HART® 7.x Field Device Specification for AMI SAC 254 Transmitters

SWAN Analytical Instruments 8340, Studbachstrasse 13

Hinwil Switzerland

Page 320: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI SAC 254 HART Manual

109687.00 / 190917 2

TABLE OF CONTENTS

1. Introduction ......................................................................................................................................4

1.1 Scope ....................................................................................................................................4

1.2 Purpose .................................................................................................................................4

1.3 Who should use this document? ..........................................................................................4

1.4 References ............................................................................................................................4

2. Device Identification ........................................................................................................................5

3. Product Overview ............................................................................................................................5

3.1 Connections..........................................................................................................................5

3.1.1 Point to point Mode ..............................................................................................5

3.1.2 Multidrop Mode ....................................................................................................6

3.1.3 HARTREC Board .................................................................................................6

4. Product Interfaces ............................................................................................................................7

4.1 Process Interface ..................................................................................................................7

4.1.1 Sensor Input Channels ..........................................................................................7

4.2 Host Interface .......................................................................................................................7

4.2.1 Process Spectral Absorption Coefficient (SAC 254) ............................................7

4.3 Local Interfaces ....................................................................................................................7

4.3.1 Local Controls and Displays .................................................................................7

4.3.2 Write Protection ....................................................................................................7

5. Device Variables ..............................................................................................................................8

5.1 Device Variable 0 SAC 254 .................................................................................................8

5.2 Device Variable 1 UVT .......................................................................................................8

5.3 Device Variable 2 Concentration .........................................................................................8

5.4 Device Variable 3 Flow Rate ...............................................................................................8

5.5 Device Variable 4 Heater Temperature ................................................................................8

5.6 Device Variable 5 Case Temperature ..................................................................................8

6. Dynamic Variables ...........................................................................................................................8

6.1 Mappable Variables .............................................................................................................8

6.2 PV Transfer Functions .........................................................................................................9

Page 321: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI SAC 254 HART Manual

109687.00 / 190917 3

7. Status Information ............................................................................................................................9

7.1 Field Device Status ..............................................................................................................9

7.2 Extended Device Status .....................................................................................................10

7.3 Additional Device Status (Command #48) ........................................................................11

8. Universal Commands .....................................................................................................................12

9. Common-Practice Commands .......................................................................................................14

9.1 Supported Common Practice Commands ..........................................................................14

9.2 Burst Mode .........................................................................................................................14

9.3 Catch Device Variable .......................................................................................................14

10. Device-Specific Commands ...........................................................................................................14

11. Tables 15

11.1 Engineering Type Unit Codes ............................................................................................15

11.2 Classification Unit Codes ..................................................................................................15

12. Performance ...................................................................................................................................16

12.1 Sampling Rates ..................................................................................................................16

12.2 Power-Up ...........................................................................................................................16

12.3 Command Response Times................................................................................................16

12.4 Long Messages ...................................................................................................................16

12.5 Non-Volatile Memory ........................................................................................................16

12.6 Modes .................................................................................................................................16

12.7 Write Protection .................................................................................................................16

12.8 Damping .............................................................................................................................17

13. Capability Checklist .......................................................................................................................17

Annex A. Default Configuration ........................................................................................................18

Annex B. Revision History ................................................................................................................19

Page 322: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI SAC 254 HART Manual

109687.00 / 190917 4

1. INTRODUCTION 1.1 Scope The SWAN Analytical Instruments model AMI SAC 254 transmitter complies with HART Protocol Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering Unit Codes supported). The functionality of this Field Device is described sufficiently to allow its proper application in a process and its complete support in HART capable Host Applications.

1.2 Purpose This specification is designed to complement the AMI SAC 254 manual by providing a complete description of this Field Device from a HART Communication perspective.

1.3 Who should use this document? The specification is designed to be a technical reference for HART capable Host Application Developers, System Integrators and knowledgeable End Users. It also provides functional specifications (e.g., commands and performance requirements) used during development, maintenance and testing. This document assumes the reader is familiar with HART Protocol requirements and terminology.

1.4 References HART Smart Communications Protocol Specification. HCF_SPEC-12. Available from the HCF.

MenAMI_SAC254_xx.pdf. Available from the SWAN Analytical Instruments web page.

Page 323: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI SAC 254 HART Manual

109687.00 / 190917 5

2. DEVICE IDENTIFICATION Manufacturer Name: SWAN Analytical

Instruments Model Name(s): AMI SAC 254

Manufacture ID Code: 24757 (60B5 Hex)

Device Type Code:

58247 (E387 Hex)

HART Protocol Revision 7.5 Device Revision: 1

Number of Device Variables 6

Physical Layers Supported FSK

Physical Device Category Transmitter, Non-DC-isolated Bus Device

3. PRODUCT OVERVIEW The AMI SAC 254 HART communication option board provides a 4 to 20mA output signal and can be monitored and configured using a HART master device or a hand-held communicator.

3.1 Connections 3.1.1 Point to point Mode

An external minimum 250 Ω (maximum 800 Ω) resistor is needed in order to communicate with HART protocol.

Page 324: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI SAC 254 HART Manual

109687.00 / 190917 6

3.1.2 Multidrop Mode

A single minimum 250 Ω resistor (maximum 800 Ω) is needed to communicate with all the instruments connected to the bus, and each of them must provide 4mA.

3.1.3 HARTREC Board

The HARTREC Board must be installed in the AMI transmitter in order to communicate with HART.

Page 325: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI SAC 254 HART Manual

109687.00 / 190917 7

4. PRODUCT INTERFACES 4.1 Process Interface 4.1.1 Sensor Input Channels Refer to AMI SAC 254 manual to details on mounting external sensors.

4.2 Host Interface 4.2.1 Process Spectral Absorption Coefficient (SAC 254) The 4 to 20mA output of the AMI SAC 254 HART option board represents a process value measurement, scaled according to the configured range of the instrument. This output corresponds to the Primary Variable. HART Communication is supported on this loop.

Since Dynamic Variables are mappable, PV can correspond to one of the following variables:

- SAC 254 Value

- UV Transmission

- Concentration

- Flow Rate

It is also possible to set the PV from the instrument local display, in the “Signal Output 3 / Parameter” settings.

4.3 Local Interfaces 4.3.1 Local Controls and Displays This device has a local display that allows the complete configurability of the instrument.

Refer to AMI SAC 254 manual to details on it.

4.3.2 Write Protection The Field Device has no “Write protection mode”.

Page 326: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI SAC 254 HART Manual

109687.00 / 190917 8

5. DEVICE VARIABLES This Field Device exposes six Device Variables

Device Variables Variables Meaning Units

0 SAC 254 1/cm 1 UV Transmission % 2 Concentration ppb 3 Flow Rate l/h 4 Heater Temperature °C 5 Case Temperature °C

5.1 Device Variable 0 SAC 254 SAC 254 is obtained using a photometer sensor (Refer to AMI SAC 254 manual to details on it).

5.2 Device Variable 1 UVT UV Transmission is calculated starting from SAC 254 value (Refer to AMI SAC 254 manual to details on it).

5.3 Device Variable 2 Concentration Concentration is calculated starting from SAC 254 value (Refer to AMI SAC 254 manual to details on it).

5.4 Device Variable 3 Flow Rate Flow rate is derived from a pressure sensor.

5.5 Device Variable 4 Heater Temperature Heater Temperature shows the Temperature of the heater.

5.6 Device Variable 5 Case Temperature Case Temperature shows the Temperature read inside the Electronic Box.

6. DYNAMIC VARIABLES 6.1 Mappable Variables Four mappable Dynamic Variables are implemented.

Dynamic Variables Variables Meaning Units

PV SAC – UVT – Conc. – Flow 1/cm - % - ppb – l/h

SV SAC – UVT – Conc. – Flow 1/cm - % - ppb – l/h

TV SAC – UVT – Conc. – Flow 1/cm - % - ppb – l/h

QV SAC – UVT – Conc. – Flow 1/cm - % - ppb – l/h

Page 327: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI SAC 254 HART Manual

109687.00 / 190917 9

It is possible to associate any of these dynamic variables to PV, SV, TV or QV with a HART Master (or Handheld Communicator).

The PV is also settable from the instrument local display’s settings.

6.2 PV Transfer Functions The Primary Variable Transfer Function can be read with command 15. Its meaning is referred to the following table.

Transfer Function Type Code

Linear 240

Bilinear 241

Logarithmic 242

Control Upwards 243

Control Downwards 244

7. STATUS INFORMATION 7.1 Field Device Status The functions of the Field Device Status bits are specified in HCF_SPEC-99. Further details of their implementation are described in the following table.

Bit Name Notes

7 Device Malfunction Set on any detected Hardware Error

6 Configuration Changed Set if any changes are made to Field Device Configuration

5 Cold Start Set when powered-up or after a device reset

4 More Status Available Set if any Alarm or Maintenance has changed its status. More information is available via command 48

3 Loop Current Fixed The Loop Current is being held at a fixed value and is not responding to process variations

2 Loop Current Saturated The Loop Current has reached its upper (or lower) endpoint limit and cannot increase (or decrease) any further

1 Non-PV Out of Limits A Device Variable not mapped to the PV is beyond its

operating limits

0 PV Out of Limits The PV is beyond its operating limit

Page 328: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI SAC 254 HART Manual

109687.00 / 190917 10

7.2 Extended Device Status Contains additional information regarding the status of the Field Device.

Bit Name Notes

2 Critical Power Failure Set when battery is becoming critically low (less than 15 min) and Field Device not connected to Power Supply

1 Device Variable Alert

Set when one or more Device Variables are in one of the following conditions:

• Hi/low limited (Limit Status)

• Bad (Process Data Status)

• Poor Accuracy (Process Data Status)

0 Maintenance Required Not Used

Page 329: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI SAC 254 HART Manual

109687.00 / 190917 11

7.3 Additional Device Status (Command #48) Command #48 returns 6 additional bytes of data (Int32 or Int16 Little Endian), with the following status information:

ALARMS CODES:

Byte Bit Meaning Code

0-3 (INT32)

0 SAC 254 Alarm high E001 1 SAC 254 Alarm low E002 2 UV Transm. Alarm high E003 3 UV Transm. Alarm low E004 4 Conc. Alarm high E005 5 Conc. Alarm low E006 6 Reserved 7 No Sample Flow E008 8 Sample Flow high E009 9 Sample Flow low E010 10 Turbidity Correction E011 11 Concentration Offset E012 12 Case Temp. high E013 13 Case Temp. low E014 14 MV disconnected E015 15 Invalid measurement E016 16 Control Timeout E017 17 SAC disconnected E018 18 Temp. out of range E019 19 Heater Temp. low E020 20 Press. Sens. Error E021 21 Absorbance high E022 22 Cleaning Solution E023 23 Input active E024 24 IC MK41T56 E025 25 IC LM75 E026 26 IC PCF8574 E027 27 Signal output open E028 28 EEProm Motherboard E029 29 EEProm Frontend E030 30 Calibration Recout E031 31 Wrong Frontend E032

Page 330: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI SAC 254 HART Manual

109687.00 / 190917 12

4 – 7

(INT32)

0 Cuvette dirty E065 1 Reserved 2 Cleaning Solution E067 3 Reserved 4 Reserved 5 Reserved 6 Reserved 7 Reserved 8 Reserved 9 Reserved 10 Reserved 11 Reserved 12 Reserved 13 Reserved 14 Reserved 15 Reserved

4-5 (INT16U)

"Reserved" bits are always set to 0.

All bits used in these bytes indicate device/sensor failure or maintenances, and always set bit 4 of the Device Status byte.

8. UNIVERSAL COMMANDS Number Name Notes

0 Read Unique Identifier Returns identity information of the Field Device

1 Read Primary Variable Returns PV value and its unit

2 Read Loop Current and Percent of Range Returns AO value and % range

3 Read Dynamic Variables and Loop Current Returns PV, SV, TV and QV values and corresponding unit values along with AO value

6 Write Polling Address Changes Field Device’s polling address and loop current mode

Page 331: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI SAC 254 HART Manual

109687.00 / 190917 13

7 Read Loop Configuration Returns polling address and loop current mode status

8 Read Dynamic Variable Classifications Returns dynamic variables classification

9 Read Device Variables with Status Returns device variables with status

11 Read Unique Identifier Associated With Tag Same response as command 0 when Tag matches

12 Read Message Returns 24 bytes of packed ASCII data

13 Read Tag, Descriptor, Date Returns tag, descriptor (packed ASCII format) and date from the device

14 Read Primary Variable Transducer Information Returns PV transducer limits and span

15 Read Device Information Returns PV unit value, LRV, URV, damping value and write protect code

16 Read Final Assembly Number Returns final assembly number

17 Write Message Write 24 bytes of packed ASCII data.

18 Write Tag, Descriptor, Date Writes tag, descriptor (packed ASCII format) and date to the device

19 Write Final Assembly Number Writes final assembly number to the device

20 Read Long Tag Returns 32-byte Long Tag

21 Read Unique Identifier Associated with Long Tag Same response as command 0 when Long Tag matches

22 Write Long Tag Writes Long Tag to the Field Device

38 Reset Configuration Changed Flag Resets the configuration change flag

48 Read Additional Device Status See 7.3 for details

Page 332: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI SAC 254 HART Manual

109687.00 / 190917 14

9. COMMON-PRACTICE COMMANDS

9.1 Supported Common Practice Commands

9.2 Burst Mode This Field Device does not support Burst Mode.

9.3 Catch Device Variable This Field Device does not support Catch Device Variable.

10. DEVICE-SPECIFIC COMMANDS This Field Device does not support Device Specific Commands.

Number Name Notes

33 Read Device Variables Returns all the Supported Device Variables

50 Read Dynamic Variable Assignment Returns the Variable Numbers associated with PV, SV,TV and QV

51 Write Dynamic Variable Assignment Writes the Variable Numbers associated with PV, SV,TV and QV

Page 333: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI SAC 254 HART Manual

109687.00 / 190917 15

11. TABLES 11.1 Engineering Type Unit Codes Units of Measurement Unit Code Temperature Degrees Celsius 32 Electric Potential millivolts 36 Electric Resistance Ω 37 Miscellaneous Hertz 38 Electric Current milliamperes 39 Time Minutes 50 Time Seconds 51 Time Hours 52 Time Days 53 Miscellaneous Percent 57 Electric Potential Volts 58 Miscellaneous pH 59 Miscellaneous Micro Siemens per centimeter 67 Flow Liters per hour 138 Concentration Parts per million 139 Electric Resistance kΩ 163 Concentration Parts per billion 169 Bubbles per second 240 Spectral Absorption Coefficient (SAC 254) 243 Not used 250

11.2 Classification Unit Codes Measurement Meas. Code Temperature 64 Volumetric flow 66 Time 70 Frequency 80 Analytical 81 Electric Potential 83 Current 84 Resistance 85 Conductance 87 Concentration 90 Turbidity 97 Not used 250 Special 253

Page 334: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI SAC 254 HART Manual

109687.00 / 190917 16

12. PERFORMANCE 12.1 Sampling Rates Typical sampling rates are shown in the following table.

Photometer sensor value sample 2 per second

Temperature sensor value sample 2 per second

Pressure sensor value sample 2 per second

Heater Temperature sensor value 2 per second

Case Temperature sensor value sample 1 per second

Note: some of the Device Variables use an Infinite Impulse Response Filter, with coefficients depending on the measured variable. The Damping Value is different for each of the Device Variables, and can be read through Command 15.

12.2 Power-Up On power up, the transmitter takes approximately 10 seconds to be ready. During this period, the device will not respond to HART commands.

12.3 Command Response Times

Minimum 2ms

Typical 5ms

Maximum 150ms

12.4 Long Messages The largest data field used is in the response to Command 9: up to 71 bytes including the two status bytes.

12.5 Non-Volatile Memory EEPROM is used to hold the device’s configuration parameters. New data is written to this memory immediately on execution of a write command, before the consequent response.

12.6 Modes Loop current mode can be disabled or enabled using command 6.

12.7 Write Protection Write-protection is not selectable, and is always set as “not write protected”.

Page 335: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI SAC 254 HART Manual

109687.00 / 190917 17

12.8 Damping Damping time is calculated for each dynamic variable.

13. CAPABILITY CHECKLIST

Manufacturer, model and revision SWAN Analytic Instruments, AMI SAC 254 rev. 1

Device type Transmitter

HART revision 7.x

Device Description available Yes

Number and type of sensors 5 (four external, one internal)

Number and type of actuators 0

Number and type of host side signals 1: 4 - 20mA analog

Number of Device Variables 6

Number of Dynamic Variables 4

Mappable Dynamic Variables? Yes

Number of common-practice commands 3

Number of device-specific commands 0

Bits of additional device status 48

Alternative operating modes? No

Burst mode? No

Write-protection? No

Page 336: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI SAC 254 HART Manual

109687.00 / 190917 18

ANNEX A. DEFAULT CONFIGURATION

Parameter Default value

PV Sensor Type Photometer (SAC 254)

Lower Range Value 0 cm-1

Upper Range Value 2 cm-1

PV Units cm-1

Damping time constant 0.5 s

Fault-indication jumper Not used

Write-protect jumper Not used

Number of response preambles 5

Page 337: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI SAC 254 HART Manual

109687.00 / 190917 19

ANNEX B. REVISION HISTORY

Document Title HART Interface Description AMI SAC 254

Document ID 109687.00

Document Revision

Date Device Revision DD Revision Description

1.0 19/09/2017 1 1 First release, for HART 7.x Device

Page 338: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments

HART® 7.x Field Device Specification for AMI Silica Transmitters

SWAN Analytical Instruments 8340, Studbachstrasse 13

Hinwil Switzerland

Page 339: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silica HART Manual

109364.00 / 270616 2

TABLE OF CONTENTS

1. Introduction ......................................................................................................................................4

1.1 Scope ....................................................................................................................................4

1.2 Purpose .................................................................................................................................4

1.3 Who should use this document? ..........................................................................................4

1.4 References ............................................................................................................................4

2. Device Identification ........................................................................................................................5

3. Product Overview ............................................................................................................................5

3.1 Connections..........................................................................................................................5

3.1.1 Point to point Mode ..............................................................................................5

3.1.2 Multidrop Mode ....................................................................................................6

3.1.3 HARTREC Board .................................................................................................6

4. Product Interfaces ............................................................................................................................7

4.1 Process Interface ..................................................................................................................7

4.1.1 Sensor Input Channels ..........................................................................................7

4.2 Host Interface .......................................................................................................................7

4.2.1 Process Silica 1 .....................................................................................................7

4.3 Local Interfaces ....................................................................................................................7

4.3.1 Local Controls and Displays .................................................................................7

4.3.2 Write Protection ....................................................................................................7

5. Device Variables ..............................................................................................................................8

5.1 Device Variable 0 Temperature ...........................................................................................8

5.2 Device Variable 1 Flow .......................................................................................................8

5.3 Device Variable 2 ÷ 7 Silica 1 ÷ 6 .......................................................................................8

5.4 Device Variable 8 Case Temperature ..................................................................................8

6. Dynamic Variables ...........................................................................................................................9

6.1 Mappable Variables .............................................................................................................9

6.2 PV Transfer Functions .........................................................................................................9

7. Status Information ..........................................................................................................................10

7.1 Field Device Status ............................................................................................................10

Page 340: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silica HART Manual

109364.00 / 270616 3

7.2 Extended Device Status .....................................................................................................10

7.3 Additional Device Status (Command #48) ........................................................................11

8. Universal Commands .....................................................................................................................13

9. Common-Practice Commands .......................................................................................................15

9.1 Supported Common Practice Commands ..........................................................................15

9.2 Burst Mode .........................................................................................................................15

9.3 Catch Device Variable .......................................................................................................15

10. Device-Specific Commands ...........................................................................................................15

11. Tables 16

11.1 Engineering Type Unit Codes ............................................................................................16

11.2 Classification Unit Codes ..................................................................................................16

12. Performance ...................................................................................................................................17

12.1 Sampling Rates ..................................................................................................................17

12.2 Power-Up ...........................................................................................................................17

12.3 Command Response Times................................................................................................17

12.4 Long Messages ...................................................................................................................17

12.5 Non-Volatile Memory ........................................................................................................17

12.6 Modes .................................................................................................................................17

12.7 Write Protection .................................................................................................................17

12.8 Damping .............................................................................................................................17

13. Capability Checklist .......................................................................................................................18

Annex A. Default Configuration ........................................................................................................19

Annex B. Revision History ................................................................................................................20

Page 341: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silica HART Manual

109364.00 / 270616 4

1. INTRODUCTION 1.1 Scope The SWAN Analytical Instruments model AMI Silica transmitter complies with HART Protocol Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering Unit Codes supported). The functionality of this Field Device is described sufficiently to allow its proper application in a process and its complete support in HART capable Host Applications.

1.2 Purpose This specification is designed to complement the AMI Silica manual by providing a complete description of this Field Device from a HART Communication perspective.

1.3 Who should use this document? The specification is designed to be a technical reference for HART capable Host Application Developers, System Integrators and knowledgeable End Users. It also provides functional specifications (e.g., commands and performance requirements) used during development, maintenance and testing. This document assumes the reader is familiar with HART Protocol requirements and terminology.

1.4 References HART Smart Communications Protocol Specification. HCF_SPEC-12. Available from the HCF.

MenAMI_Silica_xx.pdf. Available from the SWAN Analytical Instruments web page.

Page 342: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silica HART Manual

109364.00 / 270616 5

2. DEVICE IDENTIFICATION Manufacturer Name: SWAN Analytical

Instruments Model Name(s): AMI Silica

Manufacture ID Code: 24757 (60B5 Hex)

Device Type Code:

58191 (E34F Hex)

HART Protocol Revision 7.5 Device Revision: 1

Number of Device Variables 9

Physical Layers Supported FSK

Physical Device Category Transmitter, Non-DC-isolated Bus Device

3. PRODUCT OVERVIEW The AMI Silica HART communication option board provides a 4 to 20mA output signal and can be monitored and configured using a HART master device or a hand-held communicator.

3.1 Connections 3.1.1 Point to point Mode

An external minimum 250 Ω (maximum 800 Ω) resistor is needed in order to communicate with HART protocol.

Page 343: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silica HART Manual

109364.00 / 270616 6

3.1.2 Multidrop Mode

A single minimum 250 Ω resistor (maximum 800 Ω) is needed to communicate with all the instruments connected to the bus, and each of them must provide 4mA.

3.1.3 HARTREC Board

The HARTREC Board must be installed in the AMI transmitter in order to communicate with HART.

Page 344: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silica HART Manual

109364.00 / 270616 7

4. PRODUCT INTERFACES 4.1 Process Interface 4.1.1 Sensor Input Channels Refer to AMI Silica manual to details on mounting FOME sensor.

4.2 Host Interface 4.2.1 Process Silica 1 The 4 to 20mA output of the AMI Silica HART option board represents a process value measurement, scaled according to the configured range of the instrument. This output corresponds to the Primary Variable. HART Communication is supported on this loop.

Since Dynamic Variables are mappable, PV can correspond to one of the following variables:

- Silica 1

- Main Temperature

- Main Flow

- Silica 2

It is also possible to set the PV from the instrument local display, in the “Signal Output 3 / Parameter” settings.

4.3 Local Interfaces 4.3.1 Local Controls and Displays This device has a local display that allows the complete configurability of the instrument.

Refer to AMI Silica manual to details on it.

4.3.2 Write Protection The Field Device has no “Write protection mode”.

Page 345: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silica HART Manual

109364.00 / 270616 8

5. DEVICE VARIABLES This Field Device exposes nine Device Variables

Device Variables Variables Meaning Units 0 Main Temperature °C

1 Main Flow B/s

2 Silica 1 ppb

3 Silica 2 ppb

4 Silica 3 ppb

5 Silica 4 ppb

6 Silica 5 ppb

7 Silica 6 ppb

8 Case Temperature °C

5.1 Device Variable 0 Temperature Temperature is read inside the FOME sensor (Refer to AMI Silica manual to details on it).

5.2 Device Variable 1 Flow Main Flow is read by the Bubble Detector (Refer to AMI Silica manual to details on it).

5.3 Device Variable 2 ÷ 7 Silica 1 ÷ 6 Silica 1 ÷ 6 are read by FOME sensor (Refer to AMI Silica manual to details on it).

5.4 Device Variable 8 Case Temperature Case Temperature shows the Temperature read inside the Electronic Box.

Page 346: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silica HART Manual

109364.00 / 270616 9

6. DYNAMIC VARIABLES 6.1 Mappable Variables Four mappable Dynamic Variables are implemented.

Dynamic Variables Variables Meaning Units

PV Silica 1 - Temperature - Flow Rate - Silica 2 ppb - °C - B/s - ppb

SV Silica 1 - Temperature - Flow Rate - Silica 2 ppb - °C - B/s - ppb

TV Silica 1 - Temperature - Flow Rate - Silica 2 ppb - °C - B/s - ppb

QV Silica 1 - Temperature - Flow Rate - Silica 2 ppb - °C - B/s - ppb

It is possible to associate any of these dynamic variables to PV, SV, TV or QV with a HART Master (or Handheld Communicator).

The PV is also settable from the instrument local display’s settings.

6.2 PV Transfer Functions The Primary Variable Transfer Function can be read with command 15. Its meaning is referred to the following table.

Transfer Function Type Code

Linear 240

Bilinear 241

Logarithmic 242

Control Upwards 243

Control Downwards 244

Page 347: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silica HART Manual

109364.00 / 270616 10

7. STATUS INFORMATION 7.1 Field Device Status The functions of the Field Device Status bits are specified in HCF_SPEC-99. Further details of their implementation are described in the following table.

Bit Name Notes

7 Device Malfunction Set on any detected Hardware Error

6 Configuration Changed Set if any changes are made to Field Device Configuration

5 Cold Start Set when powered-up or after a device reset

4 More Status Available Set if any Alarm or Maintenance has changed its status. More information is available via command 48

3 Loop Current Fixed The Loop Current is being held at a fixed value and is not responding to process variations

2 Loop Current Saturated The Loop Current has reached its upper (or lower) endpoint limit and cannot increase (or decrease) any further

1 Non-PV Out of Limits A Device Variable not mapped to the PV is beyond its

operating limits

0 PV Out of Limits The PV is beyond its operating limit

7.2 Extended Device Status Contains additional information regarding the status of the Field Device.

Bit Name Notes

2 Critical Power Failure Set when battery is becoming critically low (less than 15 min) and Field Device not connected to Power Supply

1 Device Variable Alert

Set when one or more Device Variables are in one of the following conditions:

• Hi/low limited (Limit Status)

• Bad (Process Data Status)

• Poor Accuracy (Process Data Status)

0 Maintenance Required Not Used

Page 348: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silica HART Manual

109364.00 / 270616 11

7.3 Additional Device Status (Command #48) Command #48 returns 10 additional bytes of data (Int32 or Int16 Little Endian), with the following status information:

ALARMS CODES:

Byte Bit Meaning Alarm Code

0 – 3

(INT32)

0 Si 1 Alarm high E001 1 Si 1 Alarm low E002 2 Si 2 Alarm high E003 3 Si 2 Alarm low E004 4 Reserved 5 Reserved 6 Sample Temp. high E007 7 Sample Temp. low E008 8 Sample Flow high E009 9 Sample Flow low E010 10 Reserved 11 Temp. disconnected E012 12 Case Temp. high E013 13 Case Temp. low E014 14 Valve defective E015 15 Reserved 16 Control Timeout E017 17 Reagent Pump E018 18 FOME not connected E019 19 FOME dirty E020 20 Reserved 21 Reagent empty E022 22 Sequencer E023 23 Input active E024 24 IC MK41T56 E025 25 IC LM75 E026 26 IC PCF8574 E027 27 Signal output open E028 28 EEProm Motherboard E029 29 Rovalve E030 30 Cal. Recout E031 31 Wrong Frontend E032

Page 349: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silica HART Manual

109364.00 / 270616 12

4-5 (INT16)

0 Reagents Low E065 1 Reserved 2 Reserved 3 Reserved 4 Reserved 5 Reserved 6 Reserved 7 Reserved 8 Reserved 9 Reserved 10 Reserved 11 Reserved 12 Reserved 13 Reserved 14 Reserved 15 Reserved

14-17 (INT32)

0 Sample Flow 1 low E033 1 Sample Flow 2 low E034 2 Sample Flow 3 low E035 3 Sample Flow 4 low E036 4 Sample Flow 5 low E037 5 Sample Flow 6 low E038 6 Sample Flow low E039

7-31 Reserved "Reserved" bits are always set to 0.

All bits used in these bytes indicate device/sensor failure or maintenances, and always set bit 4 of the Device Status byte.

Page 350: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silica HART Manual

109364.00 / 270616 13

8. UNIVERSAL COMMANDS Number Name Notes

0 Read Unique Identifier Returns identity information of the Field Device

1 Read Primary Variable Returns PV value and its unit

2 Read Loop Current and Percent of Range Returns AO value and % range

3 Read Dynamic Variables and Loop Current Returns PV, SV, TV and QV values and corresponding unit values along with AO value

6 Write Polling Address Changes Field Device’s polling address and loop current mode

7 Read Loop Configuration Returns polling address and loop current mode status

8 Read Dynamic Variable Classifications Returns dynamic variables classification

9 Read Device Variables with Status Returns device variables with status

11 Read Unique Identifier Associated With Tag Same response as command 0 when Tag matches

12 Read Message Returns 24 bytes of packed ASCII data

13 Read Tag, Descriptor, Date Returns tag, descriptor (packed ASCII format) and date from the device

14 Read Primary Variable Transducer Information Returns PV transducer limits and span

15 Read Device Information Returns PV unit value, LRV, URV, damping value and write protect code

16 Read Final Assembly Number Returns final assembly number

17 Write Message Write 24 bytes of packed ASCII data.

18 Write Tag, Descriptor, Date Writes tag, descriptor (packed ASCII format) and date to the device

Page 351: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silica HART Manual

109364.00 / 270616 14

19 Write Final Assembly Number Writes final assembly number to the device

20 Read Long Tag Returns 32-byte Long Tag

21 Read Unique Identifier Associated with Long Tag Same response as command 0 when Long Tag matches

22 Write Long Tag Writes Long Tag to the Field Device

38 Reset Configuration Changed Flag Resets the configuration change flag

48 Read Additional Device Status See 7.3 for details

Page 352: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silica HART Manual

109364.00 / 270616 15

9. COMMON-PRACTICE COMMANDS

9.1 Supported Common Practice Commands

9.2 Burst Mode This Field Device does not support Burst Mode.

9.3 Catch Device Variable This Field Device does not support Catch Device Variable.

10. DEVICE-SPECIFIC COMMANDS This Field Device does not support Device Specific Commands.

Number Name Notes

33 Read Device Variables Returns all the Supported Device Variables

50 Read Dynamic Variable Assignment Returns the Variable Numbers associated with PV, SV,TV and QV

51 Write Dynamic Variable Assignment Writes the Variable Numbers associated with PV, SV,TV and QV

Page 353: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silica HART Manual

109364.00 / 270616 16

11. TABLES 11.1 Engineering Type Unit Codes

Units of Measurement Unit Code Temperature Degrees Celsius 32 Electric Potential millivolts 36 Electric Resistance Ω 37 Miscellaneous Hertz 38 Electric Current milliamperes 39 Time Minutes 50 Time Seconds 51 Time Hours 52 Time Days 53 Miscellaneous Percent 57 Electric Potential Volts 58 Miscellaneous pH 59 Miscellaneous Micro Siemens per centimeter 67 Flow Liters per hour 138 Concentration Parts per million 139 Electric Resistance kΩ 163 Concentration Parts per billion 169 Bubbles per second 240 Not used 250

11.2 Classification Unit Codes Measurement Meas. Code Temperature 64 Volumetric flow 66 Time 70 Frequency 80 Analytical 81 Electric Potential 83 Current 84 Resistance 85 Conductance 87 Concentration 90 Turbidity 97 Not used 250 Special 253

Page 354: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silica HART Manual

109364.00 / 270616 17

12. PERFORMANCE 12.1 Sampling Rates Typical sampling rates are shown in the following table.

Temperature sensor value sample 1 per second

Flow rate sensor value sample 1 per second

Silica 1 sensor value sample 1 per second

Silica 2 value sample 1 per second

Case Temperature sensor sample 1 per second

Note: all the Device Variables use an Infinite Impulse Response Filter, with coefficients depending on the measured variable. The Damping Value is different for each of the Device Variables, and can be read through Command 15.

12.2 Power-Up On power up, the transmitter takes approximately 10 seconds to be ready. During this period, the device will not respond to HART commands.

12.3 Command Response Times

Minimum 2ms

Typical 5ms

Maximum 150ms

12.4 Long Messages The largest data field used is in the response to Command 9: up to 71 bytes including the two status bytes.

12.5 Non-Volatile Memory EEPROM is used to hold the device’s configuration parameters. New data is written to this memory immediately on execution of a write command, before the consequent response.

12.6 Modes Loop current mode can be disabled or enabled using command 6.

12.7 Write Protection Write-protection is not selectable, and is always set as “not write protected”.

12.8 Damping Damping time is calculated for each dynamic variable.

Page 355: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silica HART Manual

109364.00 / 270616 18

13. CAPABILITY CHECKLIST

Manufacturer, model and revision SWAN Analytic Instruments, AMI Silica rev. 1

Device type Transmitter

HART revision 7.x

Device Description available Yes

Number and type of sensors 4 (three external, one internal)

Number and type of actuators 0

Number and type of host side signals 1: 4 - 20mA analog

Number of Device Variables 9

Number of Dynamic Variables 4

Mappable Dynamic Variables? Yes

Number of common-practice commands 3

Number of device-specific commands 0

Bits of additional device status 80

Alternative operating modes? No

Burst mode? No

Write-protection? No

Page 356: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silica HART Manual

109364.00 / 270616 19

ANNEX A. DEFAULT CONFIGURATION

Parameter Default value

PV Sensor Type Silica 1

Lower Range Value 0 ppb

Upper Range Value 5000 ppb

PV Units ppb

Damping time constant 1.592 seconds

Fault-indication jumper Not used

Write-protect jumper Not used

Number of response preambles 5

Page 357: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silica HART Manual

109364.00 / 270616 20

ANNEX B. REVISION HISTORY

Document Title HART Interface Description AMI Silica

Document ID 109364.00

Document Revision

Date Device Revision DD Revision Description

1.0 27/06/2016 1 1 First release, for HART 7.x Device

Page 358: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments

HART® 7.x Field Device Specification for AMI Silitrace Transmitters

SWAN Analytical Instruments 8340, Studbachstrasse 13

Hinwil Switzerland

Page 359: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silitrace HART Manual

109365.01 / 231216 2

TABLE OF CONTENTS

1. Introduction ......................................................................................................................................4

1.1 Scope ....................................................................................................................................4

1.2 Purpose .................................................................................................................................4

1.3 Who should use this document? ..........................................................................................4

1.4 References ............................................................................................................................4

2. Device Identification ........................................................................................................................5

3. Product Overview ............................................................................................................................5

3.1 Connections..........................................................................................................................5

3.1.1 Point to point Mode ..............................................................................................5

3.1.2 Multidrop Mode ....................................................................................................6

3.1.3 HARTREC Board .................................................................................................6

4. Product Interfaces ............................................................................................................................7

4.1 Process Interface ..................................................................................................................7

4.1.1 Sensor Input Channels ..........................................................................................7

4.2 Host Interface .......................................................................................................................7

4.2.1 Process Silica 1 .....................................................................................................7

4.3 Local Interfaces ....................................................................................................................7

4.3.1 Local Controls and Displays .................................................................................7

4.3.2 Write Protection ....................................................................................................7

5. Device Variables ..............................................................................................................................8

5.1 Device Variable 0 Flow .......................................................................................................8

5.2 Device Variable 1 ÷ 6 Silica 1 ÷ 6 .......................................................................................8

5.3 Device Variable 7 Case Temperature ..................................................................................8

6. Dynamic Variables ...........................................................................................................................9

6.1 Mappable Variables .............................................................................................................9

6.2 PV Transfer Functions .........................................................................................................9

7. Status Information ..........................................................................................................................10

7.1 Field Device Status ............................................................................................................10

7.2 Extended Device Status .....................................................................................................10

Page 360: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silitrace HART Manual

109365.01 / 231216 3

7.3 Additional Device Status (Command #48) ........................................................................11

8. Universal Commands .....................................................................................................................13

9. Common-Practice Commands .......................................................................................................15

9.1 Supported Common Practice Commands ..........................................................................15

9.2 Burst Mode .........................................................................................................................15

9.3 Catch Device Variable .......................................................................................................15

10. Device-Specific Commands ...........................................................................................................15

11. Tables 16

11.1 Engineering Type Unit Codes ............................................................................................16

11.2 Classification Unit Codes ..................................................................................................16

12. Performance ...................................................................................................................................17

12.1 Sampling Rates ..................................................................................................................17

12.2 Power-Up ...........................................................................................................................17

12.3 Command Response Times................................................................................................17

12.4 Long Messages ...................................................................................................................17

12.5 Non-Volatile Memory ........................................................................................................17

12.6 Modes .................................................................................................................................17

12.7 Write Protection .................................................................................................................17

12.8 Damping .............................................................................................................................17

Default Configuration ..........................................................................................................................18

Annex A. Default Configuration ........................................................................................................19

Annex B. Revision History ................................................................................................................20

Page 361: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silitrace HART Manual

109365.01 / 231216 4

1. INTRODUCTION 1.1 Scope The SWAN Analytical Instruments model AMI Silitrace transmitter complies with HART Protocol Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering Unit Codes supported). The functionality of this Field Device is described sufficiently to allow its proper application in a process and its complete support in HART capable Host Applications.

1.2 Purpose This specification is designed to complement the AMI Silitrace manual by providing a complete description of this Field Device from a HART Communication perspective.

1.3 Who should use this document? The specification is designed to be a technical reference for HART capable Host Application Developers, System Integrators and knowledgeable End Users. It also provides functional specifications (e.g., commands and performance requirements) used during development, maintenance and testing. This document assumes the reader is familiar with HART Protocol requirements and terminology.

1.4 References HART Smart Communications Protocol Specification. HCF_SPEC-12. Available from the HCF.

MenAMI_Silitrace_xx.pdf. Available from the SWAN Analytical Instruments web page.

Page 362: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silitrace HART Manual

109365.01 / 231216 5

2. DEVICE IDENTIFICATION Manufacturer Name: SWAN Analytical

Instruments Model Name(s): AMI Silitrace

Manufacture ID Code: 24757 (60B5 Hex)

Device Type Code:

58192 (E350 Hex)

HART Protocol Revision 7.5 Device Revision: 2

Number of Device Variables 8

Physical Layers Supported FSK

Physical Device Category Transmitter, Non-DC-isolated Bus Device

3. PRODUCT OVERVIEW The AMI Silitrace HART communication option board provides a 4 to 20mA output signal and can be monitored and configured using a HART master device or a hand-held communicator.

3.1 Connections 3.1.1 Point to point Mode

An external minimum 250 Ω (maximum 800 Ω) resistor is needed in order to communicate with HART protocol.

Page 363: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silitrace HART Manual

109365.01 / 231216 6

3.1.2 Multidrop Mode

A single minimum 250 Ω resistor (maximum 800 Ω) is needed to communicate with all the instruments connected to the bus, and each of them must provide 4mA.

3.1.3 HARTREC Board

The HARTREC Board must be installed in the AMI transmitter in order to communicate with HART.

Page 364: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silitrace HART Manual

109365.01 / 231216 7

4. PRODUCT INTERFACES 4.1 Process Interface 4.1.1 Sensor Input Channels Refer to AMI Silitrace manual to details on mounting FOME sensor.

4.2 Host Interface 4.2.1 Process Silica 1 The 4 to 20mA output of the AMI Silitrace HART option board represents a process value measurement, scaled according to the configured range of the instrument. This output corresponds to the Primary Variable. HART Communication is supported on this loop.

Since Dynamic Variables are mappable, PV can correspond to one of the following variables:

- Silica 1

- Flow

- Silica 2

It is also possible to set the PV from the instrument local display, in the “Signal Output 3 / Parameter” settings.

4.3 Local Interfaces 4.3.1 Local Controls and Displays This device has a local display that allows the complete configurability of the instrument.

Refer to AMI Silitrace manual to details on it.

4.3.2 Write Protection The Field Device has no “Write protection mode”.

Page 365: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silitrace HART Manual

109365.01 / 231216 8

5. DEVICE VARIABLES This Field Device exposes eight Device Variables

Device Variables Variables Meaning Units 0 Flow l/h

1 Silica 1 ppb

2 Silica 2 ppb

3 Silica 3 ppb

4 Silica 4 ppb

5 Silica 5 ppb

6 Silica 6 ppb

7 Case Temperature °C

5.1 Device Variable 0 Flow Flow is read by the flow sensor (Refer to AMI Silitrace manual to details on it).

5.2 Device Variable 1 ÷ 6 Silica 1 ÷ 6 Silica 1 ÷ 6 are read by FOME sensor (Refer to AMI Silitrace manual to details on it).

5.3 Device Variable 7 Case Temperature Case Temperature shows the Temperature read inside the Electronic Box.

Page 366: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silitrace HART Manual

109365.01 / 231216 9

6. DYNAMIC VARIABLES 6.1 Mappable Variables Three mappable Dynamic Variables are implemented.

Dynamic Variables Variables Meaning Units

PV Silica 1 – Flow – Silica 2 ppb – l/h – ppb

SV Silica 1 – Flow – Silica 2 ppb – l/h – ppb

TV Silica 1 – Flow – Silica 2 ppb – l/h – ppb

It is possible to associate any of these dynamic variables to PV, SV or TV with a HART Master (or Handheld Communicator).

The PV is also settable from the instrument local display’s settings.

6.2 PV Transfer Functions The Primary Variable Transfer Function can be read with command 15. Its meaning is referred to the following table.

Transfer Function Type Code

Linear 240

Bilinear 241

Logarithmic 242

Control Upwards 243

Control Downwards 244

Page 367: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silitrace HART Manual

109365.01 / 231216 10

7. STATUS INFORMATION 7.1 Field Device Status The functions of the Field Device Status bits are specified in HCF_SPEC-99. Further details of their implementation are described in the following table.

Bit Name Notes

7 Device Malfunction Set on any detected Hardware Error

6 Configuration Changed Set if any changes are made to Field Device Configuration

5 Cold Start Set when powered-up or after a device reset

4 More Status Available Set if any Alarm or Maintenance has changed its status. More information is available via command 48

3 Loop Current Fixed The Loop Current is being held at a fixed value and is not responding to process variations

2 Loop Current Saturated The Loop Current has reached its upper (or lower) endpoint limit and cannot increase (or decrease) any further

1 Non-PV Out of Limits A Device Variable not mapped to the PV is beyond its

operating limits

0 PV Out of Limits The PV is beyond its operating limit

7.2 Extended Device Status Contains additional information regarding the status of the Field Device.

Bit Name Notes

2 Critical Power Failure Set when battery is becoming critically low (less than 15 min) and Field Device not connected to Power Supply

1 Device Variable Alert

Set when one or more Device Variables are in one of the following conditions:

• Hi/low limited (Limit Status)

• Bad (Process Data Status)

• Poor Accuracy (Process Data Status)

0 Maintenance Required Not Used

Page 368: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silitrace HART Manual

109365.01 / 231216 11

7.3 Additional Device Status (Command #48) Command #48 returns 10 additional bytes of data (Int32 or Int16 Little Endian), with the following status information:

ALARMS / MAINTENANCE CODES:

Byte Bit Meaning Alarm Code

0 – 3

(INT32)

0 Si 1 Alarm high E001 1 Si 1 Alarm low E002 2 Si 2 Alarm high E003 3 Si 2 Alarm low E004 4 Reserved 5 Reserved 6 SilTrace Temp. high E007 7 SilTrace Temp. low E008 8 Sample Flow high E009 9 Sample Flow low E010 10 Absorbance too high E011 11 Temp. Timeout E012 12 Case Temp. high E013 13 Case Temp. low E014 14 Pump Speed high E015 15 Pump Speed low E016 16 Control Timeout E017 17 Reagent Pump E018 18 SilTrace E019 19 FOME dirty E020 20 Signal Timeout E021 21 Reagent empty E022 22 Sequencer E023 23 Input active E024 24 Rovalve E025 25 IC LM75 E026 26 IC PCF8574 E027 27 Signal output open E028 28 EEProm Motherboard E029 29 EEProm Frontend E030 30 Cal. Recout E031 31 Wrong Frontend E032

Page 369: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silitrace HART Manual

109365.01 / 231216 12

4-5 (INT16)

0 Reagents Low E065 1 Reserved 2 Reserved 3 Reserved 4 Reserved 5 Reserved 6 Reserved 7 Reserved 8 Reserved 9 Reserved 10 Reserved 11 Reserved 12 Reserved 13 Reserved 14 Reserved 15 Reserved

14-17 (INT32)

0 Sample Flow 1 low E033 1 Sample Flow 2 low E034 2 Sample Flow 3 low E035 3 Sample Flow 4 low E036 4 Sample Flow 5 low E037 5 Sample Flow 6 low E038 6 Reserved 7 Reserved

8 Reserved 9 Reserved 10 Reserved 11 Reserved 12 Reserved 13 Reserved … … 31 Reserved

"Reserved" bits are always set to 0.

All bits used in these bytes indicate device/sensor failure or maintenances, and always set bit 4 of the Device Status byte.

Page 370: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silitrace HART Manual

109365.01 / 231216 13

8. UNIVERSAL COMMANDS Number Name Notes

0 Read Unique Identifier Returns identity information of the Field Device

1 Read Primary Variable Returns PV value and its unit

2 Read Loop Current and Percent of Range Returns AO value and % range

3 Read Dynamic Variables and Loop Current Returns PV, SV and TV values and corresponding unit values along with AO value

6 Write Polling Address Changes Field Device’s polling address and loop current mode

7 Read Loop Configuration Returns polling address and loop current mode status

8 Read Dynamic Variable Classifications Returns dynamic variables classification

9 Read Device Variables with Status Returns device variables with status

11 Read Unique Identifier Associated With Tag Same response as command 0 when Tag matches

12 Read Message Returns 24 bytes of packed ASCII data

13 Read Tag, Descriptor, Date Returns tag, descriptor (packed ASCII format) and date from the device

14 Read Primary Variable Transducer Information Returns PV transducer limits and span

15 Read Device Information Returns PV unit value, LRV, URV, damping value and write protect code

16 Read Final Assembly Number Returns final assembly number

17 Write Message Write 24 bytes of packed ASCII data.

18 Write Tag, Descriptor, Date Writes tag, descriptor (packed ASCII format) and date to the device

Page 371: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silitrace HART Manual

109365.01 / 231216 14

19 Write Final Assembly Number Writes final assembly number to the device

20 Read Long Tag Returns 32-byte Long Tag

21 Read Unique Identifier Associated with Long Tag Same response as command 0 when Long Tag matches

22 Write Long Tag Writes Long Tag to the Field Device

38 Reset Configuration Changed Flag Resets the configuration change flag

48 Read Additional Device Status See 7.3 for details

Page 372: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silitrace HART Manual

109365.01 / 231216 15

9. COMMON-PRACTICE COMMANDS

9.1 Supported Common Practice Commands

9.2 Burst Mode This Field Device does not support Burst Mode.

9.3 Catch Device Variable This Field Device does not support Catch Device Variable.

10. DEVICE-SPECIFIC COMMANDS This Field Device does not support Device Specific Commands.

Number Name Notes

33 Read Device Variables Returns all the Supported Device Variables

50 Read Dynamic Variable Assignment Returns the Variable Numbers associated with PV, SV and TV

51 Write Dynamic Variable Assignment Writes the Variable Numbers associated with PV, SV and TV

Page 373: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silitrace HART Manual

109365.01 / 231216 16

11. TABLES 11.1 Engineering Type Unit Codes

Units of Measurement Unit Code Temperature Degrees Celsius 32 Electric Potential millivolts 36 Electric Resistance Ω 37 Miscellaneous Hertz 38 Electric Current milliamperes 39 Time Minutes 50 Time Seconds 51 Time Hours 52 Time Days 53 Miscellaneous Percent 57 Electric Potential Volts 58 Miscellaneous pH 59 Miscellaneous Micro Siemens per centimeter 67 Flow Liters per hour 138 Concentration Parts per million 139 Electric Resistance kΩ 163 Concentration Parts per billion 169 Not used 250 Special 253

11.2 Classification Unit Codes Measurement Meas. Code Temperature 64 Volumetric flow 66 Time 70 Frequency 80 Analytical 81 Electric Potential 83 Current 84 Resistance 85 Conductance 87 Concentration 90 Turbidity 97 Not used 250 Special 253

Page 374: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silitrace HART Manual

109365.01 / 231216 17

12. PERFORMANCE 12.1 Sampling Rates Typical sampling rates are shown in the following table.

Flow sensor value sample 1 per second

Silica 1-6 sensor value sample 1 per second

Case Temperature sensor sample 1 per second

Note: all the Device Variables use an Infinite Impulse Response Filter, with coefficients depending on the measured variable. The Damping Value is different for each of the Device Variables, and can be read through Command 15.

12.2 Power-Up On power up, the transmitter takes approximately 10 seconds to be ready. During this period, the device will not respond to HART commands.

12.3 Command Response Times

Minimum 2ms

Typical 5ms

Maximum 150ms

12.4 Long Messages The largest data field used is in the response to Command 9: up to 71 bytes including the two status bytes.

12.5 Non-Volatile Memory EEPROM is used to hold the device’s configuration parameters. New data is written to this memory immediately on execution of a write command, before the consequent response.

12.6 Modes Loop current mode can be disabled or enabled using command 6.

12.7 Write Protection Write-protection is not selectable, and is always set as “not write protected”.

12.8 Damping Damping time is calculated for each dynamic variable.

Page 375: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silitrace HART Manual

109365.01 / 231216 18

DEFAULT CONFIGURATION

Manufacturer, model and revision SWAN Analytic Instruments, AMI Silitrace rev. 2

Device type Transmitter

HART revision 7.x

Device Description available Yes

Number and type of sensors 5 (four external, one internal)

Number and type of actuators 0

Number and type of host side signals 1: 4 - 20mA analog

Number of Device Variables 8

Number of Dynamic Variables 3

Mappable Dynamic Variables? Yes

Number of common-practice commands 3

Number of device-specific commands 0

Bits of additional device status 80

Alternative operating modes? No

Burst mode? No

Write-protection? No

Page 376: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silitrace HART Manual

109365.01 / 231216 19

ANNEX A. DEFAULT CONFIGURATION

Parameter Default value

PV Sensor Type Silica 1

Lower Range Value 0 ppb

Upper Range Value 1000 ppb

PV Units ppb

Damping time constant 1.592 seconds

Fault-indication jumper Not used

Write-protect jumper Not used

Number of response preambles 5

Page 377: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silitrace HART Manual

109365.01 / 231216 20

ANNEX B. REVISION HISTORY

Document Title HART Interface Description AMI Silitrace

Document ID 109365.01

Document Revision

Date Device Revision DD Revision Description

1.0 27/06/2016 1 1 First release, for HART 7.x Device

2.0 23/12/2016 2 1 Flow 2 removed

Page 378: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments

HART® 7.x Field Device Specification for AMI Silitrace Ultra Transmitters

SWAN Analytical Instruments 8340, Studbachstrasse 13

Hinwil Switzerland

Page 379: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silitrace Ultra HART Manual

109366.00 / 160616 2

TABLE OF CONTENTS

1. Introduction ......................................................................................................................................4

1.1 Scope ....................................................................................................................................4

1.2 Purpose .................................................................................................................................4

1.3 Who should use this document? ..........................................................................................4

1.4 References ............................................................................................................................4

2. Device Identification ........................................................................................................................5

3. Product Overview ............................................................................................................................5

3.1 Connections..........................................................................................................................5

3.1.1 Point to point Mode ..............................................................................................5

3.1.2 Multidrop Mode ....................................................................................................6

3.1.3 HARTREC Board .................................................................................................6

4. Product Interfaces ............................................................................................................................7

4.1 Process Interface ..................................................................................................................7

4.1.1 Sensor Input Channels ..........................................................................................7

4.2 Host Interface .......................................................................................................................7

4.2.1 Process Silitrace Ultra 1 ........................................................................................7

4.3 Local Interfaces ....................................................................................................................7

4.3.1 Local Controls and Displays .................................................................................7

4.3.2 Write Protection ....................................................................................................7

5. Device Variables ..............................................................................................................................8

5.1 Device Variable 0 Silica ......................................................................................................8

5.2 Device Variable 1 Flow Permeate .......................................................................................8

5.3 Device Variable 2 Flow Concentrate ...................................................................................8

5.4 Device Variable 3 Case Temperature ..................................................................................8

6. Dynamic Variables ...........................................................................................................................9

6.1 Mappable Variables .............................................................................................................9

6.2 PV Transfer Functions .........................................................................................................9

7. Status Information ..........................................................................................................................10

7.1 Field Device Status ............................................................................................................10

Page 380: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silitrace Ultra HART Manual

109366.00 / 160616 3

7.2 Extended Device Status .....................................................................................................10

7.3 Additional Device Status (Command #48) ........................................................................11

8. Universal Commands .....................................................................................................................13

9. Common-Practice Commands .......................................................................................................15

9.1 Supported Common Practice Commands ..........................................................................15

9.2 Burst Mode .........................................................................................................................15

9.3 Catch Device Variable .......................................................................................................15

10. Device-Specific Commands ...........................................................................................................15

11. Tables 16

11.1 Engineering Type Unit Codes ............................................................................................16

11.2 Classification Unit Codes ..................................................................................................16

12. Performance ...................................................................................................................................17

12.1 Sampling Rates ..................................................................................................................17

12.2 Power-Up ...........................................................................................................................17

12.3 Command Response Times................................................................................................17

12.4 Long Messages ...................................................................................................................17

12.5 Non-Volatile Memory ........................................................................................................17

12.6 Modes .................................................................................................................................17

12.7 Write Protection .................................................................................................................17

12.8 Damping .............................................................................................................................17

Annex A. Default Configuration ........................................................................................................19

Annex B. Revision History ................................................................................................................20

Page 381: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silitrace Ultra HART Manual

109366.00 / 160616 4

1. INTRODUCTION 1.1 Scope The SWAN Analytical Instruments model AMI Silitrace Ultra transmitter complies with HART Protocol Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering Unit Codes supported). The functionality of this Field Device is described sufficiently to allow its proper application in a process and its complete support in HART capable Host Applications.

1.2 Purpose This specification is designed to complement the AMI Silitrace Ultra manual by providing a complete description of this Field Device from a HART Communication perspective.

1.3 Who should use this document? The specification is designed to be a technical reference for HART capable Host Application Developers, System Integrators and knowledgeable End Users. It also provides functional specifications (e.g., commands and performance requirements) used during development, maintenance and testing. This document assumes the reader is familiar with HART Protocol requirements and terminology.

1.4 References HART Smart Communications Protocol Specification. HCF_SPEC-12. Available from the HCF.

MenAMI_SilitraceUltra_xx.pdf. Available from the SWAN Analytical Instruments web page.

Page 382: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silitrace Ultra HART Manual

109366.00 / 160616 5

2. DEVICE IDENTIFICATION Manufacturer Name: SWAN Analytical

Instruments Model Name(s): AMI Silitrace Ultra

Manufacture ID Code: 24757 (60B5 Hex)

Device Type Code:

58193 (E351 Hex)

HART Protocol Revision 7.5 Device Revision: 1

Number of Device Variables 4

Physical Layers Supported FSK

Physical Device Category Transmitter, Non-DC-isolated Bus Device

3. PRODUCT OVERVIEW The AMI Silitrace Ultra HART communication option board provides a 4 to 20mA output signal and can be monitored and configured using a HART master device or a hand-held communicator.

3.1 Connections 3.1.1 Point to point Mode

An external minimum 250 Ω (maximum 800 Ω) resistor is needed in order to communicate with HART protocol.

Page 383: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silitrace Ultra HART Manual

109366.00 / 160616 6

3.1.2 Multidrop Mode

A single minimum 250 Ω resistor (maximum 800 Ω) is needed to communicate with all the instruments connected to the bus, and each of them must provide 4mA.

3.1.3 HARTREC Board

The HARTREC Board must be installed in the AMI transmitter in order to communicate with HART.

Page 384: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silitrace Ultra HART Manual

109366.00 / 160616 7

4. PRODUCT INTERFACES 4.1 Process Interface 4.1.1 Sensor Input Channels Refer to AMI Silitrace Ultra manual to details on mounting FOME sensor.

4.2 Host Interface 4.2.1 Process Silitrace Ultra 1 The 4 to 20mA output of the AMI Silitrace Ultra HART option board represents a process value measurement, scaled according to the configured range of the instrument. This output corresponds to the Primary Variable. HART Communication is supported on this loop.

Since Dynamic Variables are mappable, PV can correspond to one of the following variables:

- Silica

- Flow permeate

- Flow Concentrate

It is also possible to set the PV from the instrument local display, in the “Signal Output 3 / Parameter” settings.

4.3 Local Interfaces 4.3.1 Local Controls and Displays This device has a local display that allows the complete configurability of the instrument.

Refer to AMI Silitrace Ultra manual to details on it.

4.3.2 Write Protection The Field Device has no “Write protection mode”.

Page 385: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silitrace Ultra HART Manual

109366.00 / 160616 8

5. DEVICE VARIABLES This Field Device exposes four Device Variables

Device Variables Variables Meaning Units 0 Silica ppb

1 Flow permeate l/h

2 Flow concentrate l/h

3 Case Temperature °C

5.1 Device Variable 0 Silica Silica is calculated by means of the photometer (Refer to AMI Silitrace Ultra manual to details on it).

5.2 Device Variable 1 Flow Permeate Flow permeate is read by means of flow meter high (Refer to AMI Silitrace Ultra manual to details on it).

5.3 Device Variable 2 Flow Concentrate Flow concentrate is read by means of flow meter low (Refer to AMI Silitrace Ultra manual to details on it).

5.4 Device Variable 3 Case Temperature Case Temperature shows the Temperature read inside the Electronic Box.

Page 386: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silitrace Ultra HART Manual

109366.00 / 160616 9

6. DYNAMIC VARIABLES 6.1 Mappable Variables Three mappable Dynamic Variables are implemented.

Dynamic Variables Variables Meaning Units

PV Silica – Flow permeate – Flow concentrate ppb – l/h – l/h

SV Silica – Flow permeate – Flow concentrate ppb – l/h – l/h

TV Silica – Flow permeate – Flow concentrate ppb – l/h – l/h

It is possible to associate any of these dynamic variables to PV, SV or TV with a HART Master (or Handheld Communicator).

The PV is also settable from the instrument local display’s settings.

6.2 PV Transfer Functions The Primary Variable Transfer Function can be read with command 15. Its meaning is referred to the following table.

Transfer Function Type Code

Linear 240

Bilinear 241

Logarithmic 242

Control Upwards 243

Control Downwards 244

Page 387: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silitrace Ultra HART Manual

109366.00 / 160616 10

7. STATUS INFORMATION 7.1 Field Device Status The functions of the Field Device Status bits are specified in HCF_SPEC-99. Further details of their implementation are described in the following table.

Bit Name Notes

7 Device Malfunction Set on any detected Hardware Error

6 Configuration Changed Set if any changes are made to Field Device Configuration

5 Cold Start Set when powered-up or after a device reset

4 More Status Available Set if any Alarm or Maintenance has changed its status. More information is available via command 48

3 Loop Current Fixed The Loop Current is being held at a fixed value and is not responding to process variations

2 Loop Current Saturated The Loop Current has reached its upper (or lower) endpoint limit and cannot increase (or decrease) any further

1 Non-PV Out of Limits A Device Variable not mapped to the PV is beyond its

operating limits

0 PV Out of Limits The PV is beyond its operating limit

7.2 Extended Device Status Contains additional information regarding the status of the Field Device.

Bit Name Notes

2 Critical Power Failure Set when battery is becoming critically low (less than 15 min) and Field Device not connected to Power Supply

1 Device Variable Alert

Set when one or more Device Variables are in one of the following conditions:

• Hi/low limited (Limit Status)

• Bad (Process Data Status)

• Poor Accuracy (Process Data Status)

0 Maintenance Required Not Used

Page 388: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silitrace Ultra HART Manual

109366.00 / 160616 11

7.3 Additional Device Status (Command #48) Command #48 returns 6 additional bytes of data (Int32 or Int16 Little Endian), with the following status information:

ALARMS / MAINTENANCE CODES:

Byte Bit Meaning Alarm Code

0 – 3

(INT32)

0 Silica high E001 1 Silica low E002 2 Flow Permeate high E003 3 Flow Permeate low E004 4 Flow Concentrate high E005 5 Flow Concentrate low E006 6 SilTrace Temp. high E007 7 SilTrace Temp. low E008 8 Reserved 9 Reserved 10 Absorbance too high E011 11 Temp. Timeout E012 12 Case Temp. high E013 13 Case Temp. low E014 14 Pump Speed high E015 15 Pump Speed low E016 16 Control Timeout E017 17 Reagent Pump E018 18 SilTrace E019 19 FOME dirty E020 20 Signal Timeout E021 21 Reagent empty E022 22 Reserved 23 Input active E024 24 Rovalve E025 25 IC LM75 E026 26 IC PCF8574 E027 27 Signal output open E028 28 EEProm Motherboard E029 29 EEProm Frontend E030 30 Cal. Recout E031 31 Silica high E032

Page 389: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silitrace Ultra HART Manual

109366.00 / 160616 12

4-5 (INT16)

0 Reagents Low E065 1 Reserved 2 Reserved 3 Reserved 4 Reserved 5 Reserved 6 Reserved 7 Reserved 8 Reserved 9 Reserved 10 Reserved 11 Reserved 12 Reserved 13 Reserved 14 Reserved 15 Reserved

"Reserved" bits are always set to 0.

All bits used in these bytes indicate device/sensor failure or maintenances, and always set bit 4 of the Device Status byte.

Page 390: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silitrace Ultra HART Manual

109366.00 / 160616 13

8. UNIVERSAL COMMANDS Number Name Notes

0 Read Unique Identifier Returns identity information of the Field Device

1 Read Primary Variable Returns PV value and its unit

2 Read Loop Current and Percent of Range Returns AO value and % range

3 Read Dynamic Variables and Loop Current Returns PV, SV and TV values and corresponding unit values along with AO value

6 Write Polling Address Changes Field Device’s polling address and loop current mode

7 Read Loop Configuration Returns polling address and loop current mode status

8 Read Dynamic Variable Classifications Returns dynamic variables classification

9 Read Device Variables with Status Returns device variables with status

11 Read Unique Identifier Associated With Tag Same response as command 0 when Tag matches

12 Read Message Returns 24 bytes of packed ASCII data

13 Read Tag, Descriptor, Date Returns tag, descriptor (packed ASCII format) and date from the device

14 Read Primary Variable Transducer Information Returns PV transducer limits and span

15 Read Device Information Returns PV unit value, LRV, URV, damping value and write protect code

16 Read Final Assembly Number Returns final assembly number

17 Write Message Write 24 bytes of packed ASCII data.

18 Write Tag, Descriptor, Date Writes tag, descriptor (packed ASCII format) and date to the device

Page 391: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silitrace Ultra HART Manual

109366.00 / 160616 14

19 Write Final Assembly Number Writes final assembly number to the device

20 Read Long Tag Returns 32-byte Long Tag

21 Read Unique Identifier Associated with Long Tag Same response as command 0 when Long Tag matches

22 Write Long Tag Writes Long Tag to the Field Device

38 Reset Configuration Changed Flag Resets the configuration change flag

48 Read Additional Device Status See 7.3 for details

Page 392: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silitrace Ultra HART Manual

109366.00 / 160616 15

9. COMMON-PRACTICE COMMANDS

9.1 Supported Common Practice Commands

9.2 Burst Mode This Field Device does not support Burst Mode.

9.3 Catch Device Variable This Field Device does not support Catch Device Variable.

10. DEVICE-SPECIFIC COMMANDS This Field Device does not support Device Specific Commands.

Number Name Notes

33 Read Device Variables Returns all the Supported Device Variables

50 Read Dynamic Variable Assignment Returns the Variable Numbers associated with PV, SV and TV

51 Write Dynamic Variable Assignment Writes the Variable Numbers associated with PV, SV and TV

Page 393: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silitrace Ultra HART Manual

109366.00 / 160616 16

11. TABLES 11.1 Engineering Type Unit Codes

Units of Measurement Unit Code Temperature Degrees Celsius 32 Electric Potential millivolts 36 Electric Resistance Ω 37 Miscellaneous Hertz 38 Electric Current milliamperes 39 Time Minutes 50 Time Seconds 51 Time Hours 52 Time Days 53 Miscellaneous Percent 57 Electric Potential Volts 58 Miscellaneous pH 59 Miscellaneous Micro Siemens per centimeter 67 Flow Liters per hour 138 Concentration Parts per million 139 Electric Resistance kΩ 163 Concentration Parts per billion 169 Not used 250 Special 253

11.2 Classification Unit Codes Measurement Meas. Code Temperature 64 Volumetric flow 66 Time 70 Frequency 80 Analytical 81 Electric Potential 83 Current 84 Resistance 85 Conductance 87 Concentration 90 Turbidity 97 Not used 250 Special 253

Page 394: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silitrace Ultra HART Manual

109366.00 / 160616 17

12. PERFORMANCE 12.1 Sampling Rates Typical sampling rates are shown in the following table.

Silica value sample 1 per second

Flow rate sensors value sample 1 per second

Case Temperature sensor sample 1 per second

Note: all the Device Variables use an Infinite Impulse Response Filter, with coefficients depending on the measured variable. The Damping Value is different for each of the Device Variables, and can be read through Command 15.

12.2 Power-Up On power up, the transmitter takes approximately 10 seconds to be ready. During this period, the device will not respond to HART commands.

12.3 Command Response Times

Minimum 2ms

Typical 5ms

Maximum 150ms

12.4 Long Messages The largest data field used is in the response to Command 9: up to 71 bytes including the two status bytes.

12.5 Non-Volatile Memory EEPROM is used to hold the device’s configuration parameters. New data is written to this memory immediately on execution of a write command, before the consequent response.

12.6 Modes Loop current mode can be disabled or enabled using command 6.

12.7 Write Protection Write-protection is not selectable, and is always set as “not write protected”.

12.8 Damping Damping time is calculated for each dynamic variable. Capability Checklist

Page 395: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silitrace Ultra HART Manual

109366.00 / 160616 18

Manufacturer, model and revision SWAN Analytic Instruments, AMI Silitrace Ultra rev. 1

Device type Transmitter

HART revision 7.x

Device Description available Yes

Number and type of sensors 4 (three external, one internal)

Number and type of actuators 0

Number and type of host side signals 1: 4 - 20mA analog

Number of Device Variables 4

Number of Dynamic Variables 3

Mappable Dynamic Variables? Yes

Number of common-practice commands 3

Number of device-specific commands 0

Bits of additional device status 48

Alternative operating modes? No

Burst mode? No

Write-protection? No

Page 396: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silitrace Ultra HART Manual

109366.00 / 160616 19

ANNEX A. DEFAULT CONFIGURATION

Parameter Default value

PV Sensor Type Silitrace Ultra

Lower Range Value 0 ppb

Upper Range Value 50 ppb

PV Units ppb

Damping time constant 4.777 seconds

Fault-indication jumper Not used

Write-protect jumper Not used

Number of response preambles 5

Page 397: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Silitrace Ultra HART Manual

109366.00 / 160616 20

ANNEX B. REVISION HISTORY

Document Title HART Interface Description AMI Silitrace Ultra

Document ID 109366.00

Document Revision

Date Device Revision DD Revision Description

1.0 16/06/2016 1 1 First release, for HART 7.x Device

Page 398: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments

HART® 7.x Field Device Specification for AMI Sodium Transmitters

SWAN Analytical Instruments 8340, Studbachstrasse 13

Hinwil Switzerland

Page 399: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Sodium HART Manual

109367.00 / 270616 2

TABLE OF CONTENTS

1. Introduction ......................................................................................................................................4

1.1 Scope ....................................................................................................................................4

1.2 Purpose .................................................................................................................................4

1.3 Who should use this document? ..........................................................................................4

1.4 References ............................................................................................................................4

2. Device Identification ........................................................................................................................5

3. Product Overview ............................................................................................................................5

3.1 Connections..........................................................................................................................5

3.1.1 Point to point Mode ..............................................................................................5

3.1.2 Multidrop Mode ....................................................................................................6

3.1.3 HARTREC Board .................................................................................................6

4. Product Interfaces ............................................................................................................................7

4.1 Process Interface ..................................................................................................................7

4.1.1 Sensor Input Channels ..........................................................................................7

4.2 Host Interface .......................................................................................................................7

4.2.1 Process Sodium 1 ..................................................................................................7

4.3 Local Interfaces ....................................................................................................................7

4.3.1 Local Controls and Displays .................................................................................7

4.3.2 Write Protection ....................................................................................................7

5. Device Variables ..............................................................................................................................8

5.1 Device Variable 0 Sodium 1 ................................................................................................8

5.2 Device Variable 1 Sodium 2 ................................................................................................8

5.3 Device Variable 2 pH ...........................................................................................................8

5.4 Device Variable 3 Temperature ...........................................................................................8

5.5 Device Variable 4 Sample flow / pH Ctl .............................................................................8

5.6 Device Variable 5 Case Temperature ..................................................................................8

6. Dynamic Variables ...........................................................................................................................9

6.1 Mappable Variables .............................................................................................................9

6.2 PV Transfer Functions .........................................................................................................9

Page 400: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Sodium HART Manual

109367.00 / 270616 3

7. Status Information ..........................................................................................................................10

7.1 Field Device Status ............................................................................................................10

7.2 Extended Device Status .....................................................................................................10

7.3 Additional Device Status (Command #48) ........................................................................11

8. Universal Commands .....................................................................................................................13

9. Common-Practice Commands .......................................................................................................15

9.1 Supported Common Practice Commands ..........................................................................15

9.2 Burst Mode .........................................................................................................................15

9.3 Catch Device Variable .......................................................................................................15

10. Device-Specific Commands ...........................................................................................................15

11. Tables 16

11.1 Engineering Type Unit Codes ............................................................................................16

11.2 Classification Unit Codes ..................................................................................................16

12. Performance ...................................................................................................................................17

12.1 Sampling Rates ..................................................................................................................17

12.2 Power-Up ...........................................................................................................................17

12.3 Command Response Times................................................................................................17

12.4 Long Messages ...................................................................................................................17

12.5 Non-Volatile Memory ........................................................................................................17

12.6 Modes .................................................................................................................................17

12.7 Write Protection .................................................................................................................17

12.8 Damping .............................................................................................................................17

13. Capability Checklist .......................................................................................................................18

Annex A. Default Configuration ........................................................................................................19

Annex B. Revision History ................................................................................................................20

Page 401: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Sodium HART Manual

109367.00 / 270616 4

1. INTRODUCTION 1.1 Scope The SWAN Analytical Instruments model AMI Sodium transmitter complies with HART Protocol Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering Unit Codes supported). The functionality of this Field Device is described sufficiently to allow its proper application in a process and its complete support in HART capable Host Applications.

1.2 Purpose This specification is designed to complement the AMI Sodium manual by providing a complete description of this Field Device from a HART Communication perspective.

1.3 Who should use this document? The specification is designed to be a technical reference for HART capable Host Application Developers, System Integrators and knowledgeable End Users. It also provides functional specifications (e.g., commands and performance requirements) used during development, maintenance and testing. This document assumes the reader is familiar with HART Protocol requirements and terminology.

1.4 References HART Smart Communications Protocol Specification. HCF_SPEC-12. Available from the HCF.

MenAMI_Sodium_xx.pdf. Available from the SWAN Analytical Instruments web page.

Page 402: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Sodium HART Manual

109367.00 / 270616 5

2. DEVICE IDENTIFICATION Manufacturer Name: SWAN Analytical

Instruments Model Name(s): AMI Sodium

Manufacture ID Code: 24757 (60B5 Hex)

Device Type Code:

58194 (E352 Hex)

HART Protocol Revision 7.5 Device Revision: 1

Number of Device Variables 6

Physical Layers Supported FSK

Physical Device Category Transmitter, Non-DC-isolated Bus Device

3. PRODUCT OVERVIEW The AMI Sodium HART communication option board provides a 4 to 20mA output signal and can be monitored and configured using a HART master device or a hand-held communicator.

3.1 Connections 3.1.1 Point to point Mode

An external minimum 250 Ω (maximum 800 Ω) resistor is needed in order to communicate with HART protocol.

Page 403: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Sodium HART Manual

109367.00 / 270616 6

3.1.2 Multidrop Mode

A single minimum 250 Ω resistor (maximum 800 Ω) is needed to communicate with all the instruments connected to the bus, and each of them must provide 4mA.

3.1.3 HARTREC Board

The HARTREC Board must be installed in the AMI transmitter in order to communicate with HART.

Page 404: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Sodium HART Manual

109367.00 / 270616 7

4. PRODUCT INTERFACES 4.1 Process Interface 4.1.1 Sensor Input Channels Refer to AMI Sodium manual to details on mounting FOME sensor.

4.2 Host Interface 4.2.1 Process Sodium 1 The 4 to 20mA output of the AMI Sodium HART option board represents a process value measurement, scaled according to the configured range of the instrument. This output corresponds to the Primary Variable. HART Communication is supported on this loop.

Since Dynamic Variables are mappable, PV can correspond to one of the following variables:

- Sodium 1

- Sodium 2

- pH

- Temperature

- Sample flow / pH Ctl.

It is also possible to set the PV from the instrument local display, in the “Signal Output 3 / Parameter” settings.

4.3 Local Interfaces 4.3.1 Local Controls and Displays This device has a local display that allows the complete configurability of the instrument.

Refer to AMI Sodium manual to details on it.

4.3.2 Write Protection The Field Device has no “Write protection mode”.

Page 405: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Sodium HART Manual

109367.00 / 270616 8

5. DEVICE VARIABLES This Field Device exposes six Device Variables

Device Variables Variables Meaning Units 0 Sodium 1 ppb

1 Sodium 2 ppb

2 pH pH

3 Temperature °C

4 Sample flow / pH Ctl B/s - %

5 Case Temperature °C

5.1 Device Variable 0 Sodium 1 Sodium 1 is read by means of the Sodium Electrode (Refer to AMI Sodium manual to details on it).

5.2 Device Variable 1 Sodium 2 Sodium 2 is read by means of the Sodium Electrode (Refer to AMI Sodium manual to details on it).

5.3 Device Variable 2 pH pH is read by means of the pH Electrode (Refer to AMI Sodium manual to details on it).

5.4 Device Variable 3 Temperature Temperature is read with the Temperature sensor.

5.5 Device Variable 4 Sample flow / pH Ctl Flow is read by means of the Flow cell (Refer to AMI Sodium manual to details on it) and is read in bubbles per second.

5.6 Device Variable 5 Case Temperature Case Temperature shows the Temperature read inside the Electronic Box.

Page 406: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Sodium HART Manual

109367.00 / 270616 9

6. DYNAMIC VARIABLES 6.1 Mappable Variables Four mappable Dynamic Variables are implemented.

Dynamic Variables Variables Meaning Units

PV Sodium 1 – Sodium 2 – pH – Temperature –

Flow [pH Ctl] ppb–ppb–pH–°C–B/s[%]

SV Sodium 1 – Sodium 2 – pH – Temperature –

Flow [pH Ctl] ppb–ppb–pH–°C–B/s[%]

TV Sodium 1 – Sodium 2 – pH – Temperature –

Flow [pH Ctl] ppb–ppb–pH–°C–B/s[%]

QV Sodium 1 – Sodium 2 – pH – Temperature –

Flow [pH Ctl] ppb–ppb–pH–°C–B/s[%]

It is possible to associate any of these dynamic variables to PV, SV, TV or QV with a HART Master (or Handheld Communicator).

The PV is also settable from the instrument local display’s settings.

6.2 PV Transfer Functions The Primary Variable Transfer Function can be read with command 15. Its meaning is referred to the following table.

Transfer Function Type Code

Linear 240

Bilinear 241

Logarithmic 242

Control Upwards 243

Control Downwards 244

Page 407: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Sodium HART Manual

109367.00 / 270616 10

7. STATUS INFORMATION 7.1 Field Device Status The functions of the Field Device Status bits are specified in HCF_SPEC-99. Further details of their implementation are described in the following table.

Bit Name Notes

7 Device Malfunction Set on any detected Hardware Error

6 Configuration Changed Set if any changes are made to Field Device Configuration

5 Cold Start Set when powered-up or after a device reset

4 More Status Available Set if any Alarm or Maintenance has changed its status. More information is available via command 48

3 Loop Current Fixed The Loop Current is being held at a fixed value and is not responding to process variations

2 Loop Current Saturated The Loop Current has reached its upper (or lower) endpoint limit and cannot increase (or decrease) any further

1 Non-PV Out of Limits A Device Variable not mapped to the PV is beyond its

operating limits

0 PV Out of Limits The PV is beyond its operating limit

7.2 Extended Device Status Contains additional information regarding the status of the Field Device.

Bit Name Notes

2 Critical Power Failure Set when battery is becoming critically low (less than 15 min) and Field Device not connected to Power Supply

1 Device Variable Alert

Set when one or more Device Variables are in one of the following conditions:

• Hi/low limited (Limit Status)

• Bad (Process Data Status)

• Poor Accuracy (Process Data Status)

0 Maintenance Required Not Used

Page 408: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Sodium HART Manual

109367.00 / 270616 11

7.3 Additional Device Status (Command #48) Command #48 returns 6 additional bytes of data (Int32 or Int16 Little Endian), with the following status information:

ALARMS - MAINTENANCE CODES:

Byte Bit Meaning Alarm Code

0 – 3

(INT32)

0 Sodium 1 Alarm high E001 1 Sodium 1 Alarm low E002 2 pH Alarm high E003 3 pH Alarm low E004 4 Sodium 2 Alarm high E005 5 Sodium 2 Alarm low E006 6 Sample Temp. high E007 7 Sample Temp. low E008 8 Sample Flow high E009 9 Sample Flow low E010 10 Temp. shorted E011 11 Temp. disconnected E012 12 Case Temp. high E013 13 Case Temp. low E014 14 undefined E015 15 undefined E016 16 Control Timeout E017 17 Reagent empty E018 18 No Sample E019 19 pH low E020 20 undefined E021 21 undefined E022 22 Cleaning Reagent E023 23 Input active E024 24 IC MK41T56 E025 25 IC LM75 E026 26 IC PCF8574 E027 27 Signal output open E028 28 EEProm Motherboard E029 29 EEProm Frontend E030 30 Calibration Recout E031 31 Wrong Frontend E032

Page 409: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Sodium HART Manual

109367.00 / 270616 12

4-5 (INT16)

0 Photometer dirty E065 1 Filter congested E066 2 Reserved 3 Reserved 4 Reserved 5 Reserved 6 Reserved 7 Reserved 8 Reserved 9 Reserved 10 Reserved 11 Reserved 12 Reserved 13 Reserved 14 Reserved 15 Reserved

"Reserved" bits are always set to 0.

All bits used in these bytes indicate device/sensor failure or maintenances, and always set bit 4 of the Device Status byte.

Page 410: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Sodium HART Manual

109367.00 / 270616 13

8. UNIVERSAL COMMANDS Number Name Notes

0 Read Unique Identifier Returns identity information of the Field Device

1 Read Primary Variable Returns PV value and its unit

2 Read Loop Current and Percent of Range Returns AO value and % range

3 Read Dynamic Variables and Loop Current Returns PV, SV, TV and QV values and corresponding unit values along with AO value

6 Write Polling Address Changes Field Device’s polling address and loop current mode

7 Read Loop Configuration Returns polling address and loop current mode status

8 Read Dynamic Variable Classifications Returns dynamic variables classification

9 Read Device Variables with Status Returns device variables with status

11 Read Unique Identifier Associated With Tag Same response as command 0 when Tag matches

12 Read Message Returns 24 bytes of packed ASCII data

13 Read Tag, Descriptor, Date Returns tag, descriptor (packed ASCII format) and date from the device

14 Read Primary Variable Transducer Information Returns PV transducer limits and span

15 Read Device Information Returns PV unit value, LRV, URV, damping value and write protect code

16 Read Final Assembly Number Returns final assembly number

17 Write Message Write 24 bytes of packed ASCII data.

18 Write Tag, Descriptor, Date Writes tag, descriptor (packed ASCII format) and date to the device

Page 411: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Sodium HART Manual

109367.00 / 270616 14

19 Write Final Assembly Number Writes final assembly number to the device

20 Read Long Tag Returns 32-byte Long Tag

21 Read Unique Identifier Associated with Long Tag Same response as command 0 when Long Tag matches

22 Write Long Tag Writes Long Tag to the Field Device

38 Reset Configuration Changed Flag Resets the configuration change flag

48 Read Additional Device Status See 7.3 for details

Page 412: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Sodium HART Manual

109367.00 / 270616 15

9. COMMON-PRACTICE COMMANDS

9.1 Supported Common Practice Commands

9.2 Burst Mode This Field Device does not support Burst Mode.

9.3 Catch Device Variable This Field Device does not support Catch Device Variable.

10. DEVICE-SPECIFIC COMMANDS This Field Device does not support Device Specific Commands.

Number Name Notes

33 Read Device Variables Returns all the Supported Device Variables

50 Read Dynamic Variable Assignment Returns the Variable Numbers associated with PV, SV,TV and QV

51 Write Dynamic Variable Assignment Writes the Variable Numbers associated with PV, SV,TV and QV

Page 413: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Sodium HART Manual

109367.00 / 270616 16

11. TABLES 11.1 Engineering Type Unit Codes

Units of Measurement Unit Code Temperature Degrees Celsius 32 Electric Potential millivolts 36 Electric Resistance Ω 37 Miscellaneous Hertz 38 Electric Current milliamperes 39 Time Minutes 50 Time Seconds 51 Time Hours 52 Time Days 53 Miscellaneous Percent 57 Electric Potential Volts 58 Miscellaneous pH 59 Miscellaneous Micro Siemens per centimeter 67 Flow Liters per hour 138 Concentration Parts per million 139 Electric Resistance kΩ 163 Concentration Parts per billion 169 Bubbles per second (custom) 240 Not used 250

11.2 Classification Unit Codes Measurement Meas. Code Temperature 64 Volumetric flow 66 Time 70 Frequency 80 Analytical 81 Electric Potential 83 Current 84 Resistance 85 Conductance 87 Concentration 90 Turbidity 97 Not used 250 Special 253

Page 414: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Sodium HART Manual

109367.00 / 270616 17

12. PERFORMANCE 12.1 Sampling Rates Typical sampling rates are shown in the following table.

Temperature sensor value sample 1 per second

Flow rate sensor value sample 1 per second

Sodium 1 sensor value sample 1 per second

Sodium 2 value sample 1 per second

Case Temperature sensor sample 1 per second

Note: all the Device Variables use an Infinite Impulse Response Filter, with coefficients depending on the measured variable. The Damping Value is different for each of the Device Variables, and can be read through Command 15.

12.2 Power-Up On power up, the transmitter takes approximately 10 seconds to be ready. During this period, the device will not respond to HART commands.

12.3 Command Response Times

Minimum 2ms

Typical 5ms

Maximum 150ms

12.4 Long Messages The largest data field used is in the response to Command 9: up to 71 bytes including the two status bytes.

12.5 Non-Volatile Memory EEPROM is used to hold the device’s configuration parameters. New data is written to this memory immediately on execution of a write command, before the consequent response.

12.6 Modes Loop current mode can be disabled or enabled using command 6.

12.7 Write Protection Write-protection is not selectable, and is always set as “not write protected”.

12.8 Damping Damping time is calculated for each dynamic variable.

Page 415: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Sodium HART Manual

109367.00 / 270616 18

13. CAPABILITY CHECKLIST

Manufacturer, model and revision SWAN Analytic Instruments, AMI Sodium rev. 1

Device type Transmitter

HART revision 7.x

Device Description available Yes

Number and type of sensors 7 (six external, one internal)

Number and type of actuators 0

Number and type of host side signals 1: 4 - 20mA analog

Number of Device Variables 6

Number of Dynamic Variables 4

Mappable Dynamic Variables? Yes

Number of common-practice commands 3

Number of device-specific commands 0

Bits of additional device status 48

Alternative operating modes? No

Burst mode? No

Write-protection? No

Page 416: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Sodium HART Manual

109367.00 / 270616 19

ANNEX A. DEFAULT CONFIGURATION

Parameter Default value

PV Sensor Type Sodium 1

Lower Range Value 0 ppb

Upper Range Value 50000 ppb

PV Units ppb

Damping time constant 28.662 seconds

Fault-indication jumper Not used

Write-protect jumper Not used

Number of response preambles 5

Page 417: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Sodium HART Manual

109367.00 / 270616 20

ANNEX B. REVISION HISTORY

Document Title HART Interface Description AMI Sodium

Document ID 109367.00

Document Revision

Date Device Revision DD Revision Description

1.0 27/06/2016 1 1 First release, for HART 7.x Device

Page 418: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments

HART® 7.x Field Device Specification for AMI Solicon 4 Transmitters

SWAN Analytical Instruments 8340, Studbachstrasse 13

Hinwil Switzerland

Page 419: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Solicon 4 HART Manual

109345.00 / 270616 2

TABLE OF CONTENTS

1. Introduction ......................................................................................................................................4

1.1 Scope ....................................................................................................................................4

1.2 Purpose .................................................................................................................................4

1.3 Who should use this document? ..........................................................................................4

1.4 References ............................................................................................................................4

2. Device Identification ........................................................................................................................5

3. Product Overview ............................................................................................................................5

3.1 Connections..........................................................................................................................5

3.1.1 Point to point Mode ..............................................................................................5

3.1.2 Multidrop Mode ....................................................................................................6

3.1.3 HARTREC Board .................................................................................................6

4. Product Interfaces ............................................................................................................................7

4.1 Process Interface ..................................................................................................................7

4.1.1 Sensor Input Channels ..........................................................................................7

4.2 Process Flow Rate 4-20mA Analog Output .........................................................................7

4.3 Local Interfaces ....................................................................................................................7

4.3.1 Local Controls and Displays .................................................................................7

4.3.2 Write Protection ....................................................................................................7

5. Device Variables ..............................................................................................................................8

5.1 Device Variable 0 Conductivity ...........................................................................................8

5.2 Device Variable 1 Temperature ...........................................................................................8

5.3 Device Variable 2 Flow Rate ...............................................................................................8

5.4 Device Variable 3 Uncompensated Conductivity ................................................................8

5.5 Device Variable 4 Concentration .........................................................................................8

5.6 Device Variable 5 Case Temperature ..................................................................................8

6. Dynamic Variables ...........................................................................................................................9

6.1 Mappable Variables .............................................................................................................9

6.2 PV Transfer Functions .........................................................................................................9

7. Status Information ..........................................................................................................................10

Page 420: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Solicon 4 HART Manual

109345.00 / 270616 3

7.1 Field Device Status ............................................................................................................10

7.2 Extended Device Status .....................................................................................................10

7.3 Additional Device Status (Command #48) ........................................................................11

8. Universal Commands .....................................................................................................................13

9. Common-Practice Commands .......................................................................................................15

9.1 Supported Common Practice Commands ..........................................................................15

9.2 Burst Mode .........................................................................................................................15

9.3 Catch Device Variable .......................................................................................................15

10. Device-Specific Commands ...........................................................................................................15

11. Tables 16

11.1 Engineering Type Unit Codes ............................................................................................16

11.2 Classification Type Unit Codes .........................................................................................16

12. Performance ...................................................................................................................................17

12.1 Sampling Rates ..................................................................................................................17

12.2 Power-Up ...........................................................................................................................17

12.3 Command Response Times................................................................................................17

12.4 Long Messages ...................................................................................................................17

12.5 Non-Volatile Memory ........................................................................................................17

12.6 Modes .................................................................................................................................17

12.7 Write Protection .................................................................................................................17

12.8 Damping .............................................................................................................................17

Annex A. Capability Checklist ...........................................................................................................18

Annex B. Default Configuration ........................................................................................................19

Annex C. Revision History ................................................................................................................20

Page 421: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Solicon 4 HART Manual

109345.00 / 270616 4

1. INTRODUCTION 1.1 Scope The SWAN Analytical Instruments model AMI Solicon 4 transmitter complies with HART Protocol Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering Unit Codes supported). The functionality of this Field Device is described sufficiently to allow its proper application in a process and its complete support in HART capable Host Applications.

1.2 Purpose This specification is designed to complement the AMI Solicon 4 manual by providing a complete description of this Field Device from a HART Communication perspective.

1.3 Who should use this document? The specification is designed to be a technical reference for HART capable Host Application Developers, System Integrators and knowledgeable End Users. It also provides functional specifications (e.g., commands and performance requirements) used during development, maintenance and testing. This document assumes the reader is familiar with HART Protocol requirements and terminology.

1.4 References HART Smart Communications Protocol Specification. HCF_SPEC-12. Available from the HCF.

MenAMI_Solicon_4_xx.pdf. Available from the SWAN Analytical Instruments web page.

Page 422: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Solicon 4 HART Manual

109345.00 / 270616 5

2. DEVICE IDENTIFICATION Manufacturer Name: SWAN Analytical

Instruments Model Name(s): AMI Solicon 4

Manufacture ID Code: 24757 (60B5 Hex)

Device Type Code:

58181 (E345 Hex)

HART Protocol Revision 7.5 Device Revision: 1

Number of Device Variables 6

Physical Layers Supported FSK

Physical Device Category Transmitter, Non-DC-isolated Bus Device

3. PRODUCT OVERVIEW The AMI Solicon 4 HART communication option board provides a 4 to 20mA output signal and can be monitored and configured using a HART master device or a hand-held communicator.

3.1 Connections 3.1.1 Point to point Mode

An external minimum 250 Ω (maximum 800 Ω) resistor is needed in order to communicate with HART protocol.

Page 423: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Solicon 4 HART Manual

109345.00 / 270616 6

3.1.2 Multidrop Mode

A single minimum 250 Ω resistor (maximum 800 Ω) is needed to communicate with all the instruments connected to the bus, and each of them must provide 4mA.

3.1.3 HARTREC Board

The HARTREC Board must be installed in the AMI transmitter in order to communicate with HART.

Page 424: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Solicon 4 HART Manual

109345.00 / 270616 7

4. PRODUCT INTERFACES 4.1 Process Interface 4.1.1 Sensor Input Channels Refer to AMI Solicon 4 manual to details on mounting external sensors.

4.2 Process Flow Rate 4-20mA Analog Output The 4 to 20mA output of the AMI Solicon 4 HART option board represents a process value measurement, scaled according to the configured range of the instrument. This output corresponds to the Primary Variable. HART Communication is supported on this loop.

Since Dynamic Variables are mappable, PV can correspond to one of the following variables:

- Conductivity

- Temperature

- Flow rate

- Concentration

- Uncompensated Conductivity

It is also possible to set the PV from the instrument local display, in the “Signal Output 3 / Parameter” settings.

4.3 Local Interfaces 4.3.1 Local Controls and Displays This device has a local display that allows the complete configurability of the instrument.

Refer to AMI Solicon 4 manual to details on it.

4.3.2 Write Protection The Field Device has no “Write protection mode”.

Page 425: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Solicon 4 HART Manual

109345.00 / 270616 8

5. DEVICE VARIABLES This Field Device exposes five Device Variables

Device Variables Variables Meaning Units 0 Conductivity uS/cm

1 Temperature °C

2 Flow Rate l/h

3 Uncomp. Conductivity uS/cm

4 Concentration % - mg/l

5 Case Temperature °C

5.1 Device Variable 0 Conductivity The Conductivity is read by the Conductivity sensor Swansensor Shurecon P (Refer to AMI Solicon 4 manual to details on it).

5.2 Device Variable 1 Temperature Temperature is read by the temperature sensor inside the Conductivity sensor (Refer to AMI Solicon 4 manual to details on it).

5.3 Device Variable 2 Flow Rate Flow Rate is read by the Flow sensor (Refer to AMI Solicon 4 manual to details on it).

5.4 Device Variable 3 Uncompensated Conductivity Uncomp. Conductivity is read by the Conductivity sensor.

5.5 Device Variable 4 Concentration Concentration is calculated based on the conductivity (Refer to AMI Solicon 4 manual to details on it).

5.6 Device Variable 5 Case Temperature Case Temperature shows the Temperature read inside the Electronic Box.

Page 426: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Solicon 4 HART Manual

109345.00 / 270616 9

6. DYNAMIC VARIABLES 6.1 Mappable Variables Four mappable Dynamic Variables are implemented.

Dynamic Variables Variables Meaning Units

PV Conductivity– Temperature – Flow Rate –

Uncomp. Cond. - Concentration uS/cm - °C – l/h – uS/cm -

% or mg/l

SV Conductivity– Temperature – Flow Rate –

Uncomp. Cond. - Concentration uS/cm - °C – l/h – uS/cm -

% or mg/l

TV Conductivity– Temperature – Flow Rate –

Uncomp. Cond. - Concentration uS/cm - °C – l/h – uS/cm -

% or mg/l

QV Conductivity– Temperature – Flow Rate –

Uncomp. Cond. - Concentration uS/cm - °C – l/h – uS/cm -

% or mg/l

It is possible to associate any of these dynamic variables to PV, SV, TV or QV with a HART Master (or Handheld Communicator).

The PV is also settable from the instrument local display’s settings.

6.2 PV Transfer Functions The Primary Variable Transfer Function can be read with command 15. Its meaning is referred to the following table.

Transfer Function Type Code

Linear 240

Bilinear 241

Logarithmic 242

Control Upwards 243

Control Downwards 244

Page 427: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Solicon 4 HART Manual

109345.00 / 270616 10

7. STATUS INFORMATION 7.1 Field Device Status The functions of the Field Device Status bits are specified in HCF_SPEC-99. Further details of their implementation are described in the following table.

Bit Name Notes

7 Device Malfunction Set on any detected Hardware Error

6 Configuration Changed Set if any changes are made to Field Device Configuration

5 Cold Start Set when powered-up or after a device reset

4 More Status Available Set if any Alarm or Maintenance has changed its status. More information is available via command 48

3 Loop Current Fixed The Loop Current is being held at a fixed value and is not responding to process variations

2 Loop Current Saturated The Loop Current has reached its upper (or lower) endpoint limit and cannot increase (or decrease) any further

1 Non-PV Out of Limits A Device Variable not mapped to the PV is beyond its

operating limits

0 PV Out of Limits The PV is beyond its operating limit

7.2 Extended Device Status Contains additional information regarding the status of the Field Device.

Bit Name Notes

2 Critical Power Failure Set when battery is becoming critically low (less than 15 min) and Field Device not connected to Power Supply

1 Device Variable Alert

Set when one or more Device Variables are in one of the following conditions:

• Hi/low limited (Limit Status)

• Bad (Process Data Status)

• Poor Accuracy (Process Data Status)

0 Maintenance Required Not Used

Page 428: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Solicon 4 HART Manual

109345.00 / 270616 11

7.3 Additional Device Status (Command #48) Command #48 returns 6 additional bytes of data (Int32 or Int16 Little Endian), with the following status information:

ALARMS CODES:

Byte Bit Meaning Alarm Code

0 – 3

(INT32)

0 Cond. Alarm high E001 1 Cond. Alarm low E002 2 Conc. Alarm high E003 3 Conc. Alarm low E004 4 Reserved 5 Reserved 6 Sample Temp. high E007 7 Sample Temp. low E008 8 Sample Flow high E009 9 Sample Flow low E010 10 Temp. shorted E011 11 Temp. disconnected E012 12 Case Temp. high E013 13 Case Temp. low E014 14 Reserved 15 Reserved 16 Control Timeout E017 17 Temp. out of Table E018 18 Conc. out of Table E019 19 Reserved 20 Reserved 21 Reserved 22 Reserved 23 Input active E024 24 IC MK41T56 E025 25 IC LM75 E026 26 IC PCF8574 E027 27 Signal output open E028 28 EEProm Motherboard E029 29 EEProm Frontend E030 30 Calibration Recout E031 31 Wrong Frontend E032

"Reserved" bits are always set to 0.

Page 429: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Solicon 4 HART Manual

109345.00 / 270616 12

All bits used in this four bytes indicate device or sensor failure, and always set bit 4 of the Device Status byte.

MAINTENANCE CODES:

Byte Bit Meaning Alarm Code

4-5 (INT16)

0 Photometer dirty E065 1 Filter congested E066 2 Reserved 3 Reserved 4 Reserved 5 Reserved 6 Reserved 7 Reserved 8 Reserved 9 Reserved

10 Reserved 11 Reserved 12 Reserved 13 Reserved 14 Reserved 15 Reserved

Page 430: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Solicon 4 HART Manual

109345.00 / 270616 13

8. UNIVERSAL COMMANDS Number Name Notes

0 Read Unique Identifier Returns identity information of the Field Device

1 Read Primary Variable Returns PV value and its unit

2 Read Loop Current and Percent of Range Returns AO value and % range

3 Read Dynamic Variables and Loop Current Returns PV, SV, TV and QV values and corresponding unit values along with AO value

6 Write Polling Address Changes Field Device’s polling address and loop current mode

7 Read Loop Configuration Returns polling address and loop current mode status

8 Read Dynamic Variable Classifications Returns dynamic variables classification

9 Read Device Variables with Status Returns device variables with status

11 Read Unique Identifier Associated With Tag Same response as command 0 when Tag matches

12 Read Message Returns 24 bytes of packed ASCII data

13 Read Tag, Descriptor, Date Returns tag, descriptor (packed ASCII format) and date from the device

14 Read Primary Variable Transducer Information Returns PV transducer limits and span

15 Read Device Information Returns PV unit value, LRV, URV, damping value and write protect code

16 Read Final Assembly Number Returns final assembly number

17 Write Message Write 24 bytes of packed ASCII data.

18 Write Tag, Descriptor, Date Writes tag, descriptor (packed ASCII format) and date to the device

Page 431: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Solicon 4 HART Manual

109345.00 / 270616 14

19 Write Final Assembly Number Writes final assembly number to the device

20 Read Long Tag Returns 32-byte Long Tag

21 Read Unique Identifier Associated with Long Tag Same response as command 0 when Long Tag matches

22 Write Long Tag Writes Long Tag to the Field Device

38 Reset Configuration Changed Flag Resets the configuration change flag

48 Read Additional Device Status See 7.3 for details

Page 432: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Solicon 4 HART Manual

109345.00 / 270616 15

9. COMMON-PRACTICE COMMANDS

9.1 Supported Common Practice Commands

9.2 Burst Mode This Field Device does not support Burst Mode.

9.3 Catch Device Variable This Field Device does not support Catch Device Variable.

10. DEVICE-SPECIFIC COMMANDS This Field Device does not support Device Specific Commands.

Number Name Notes

33 Read Device Variables Returns all the Supported Device Variables

50 Read Dynamic Variable Assignment Returns the Variable Numbers associated with PV, SV,TV and QV

51 Write Dynamic Variable Assignment Writes the Variable Numbers associated with PV, SV,TV and QV

Page 433: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Solicon 4 HART Manual

109345.00 / 270616 16

11. TABLES 11.1 Engineering Type Unit Codes Units of Measurement Unit Code Temperature Degrees Celsius 32 Electric Potential millivolts 36 Electric Resistance Ω 37 Miscellaneous Hertz 38 Electric Current milliamperes 39 Time Minutes 50 Time Seconds 51 Time Hours 52 Time Days 53 Miscellaneous Percent 57 Electric Potential Volts 58 Miscellaneous pH 59 Miscellaneous Micro Siemens per centimeter 67 Flow Liters per hour 138 Concentration Parts per million 139 Electric Resistance kΩ 163 Concentration Parts per billion 169 Milligram per liter (custom) 242 Not used 250

11.2 Classification Type Unit Codes Measurement Meas. Code Temperature 64 Volumetric flow 66 Time 70 Frequency 80 Analytical 81 Electric Potential 83 Current 84 Resistance 85 Conductance 87 Concentration 90 Turbidity 97 Not used 250 Special 253

Page 434: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Solicon 4 HART Manual

109345.00 / 270616 17

12. PERFORMANCE 12.1 Sampling Rates Typical sampling rates are shown in the following table.

Conductivity sensor value sample 1 per second

Temperature sensor value sample 1 per second

Flow rate sensor value sample 1 per second

Uncompensated conductivity value sample 1 per second

Concentration 1 per second

Case Temperature sensor sample 1 per second

Note: all the Device Variables use an Infinite Impulse Response Filter, with coefficients depending on the measured variable. The Damping Value is different for each of the Device Variables, and can be read through Command 15.

12.2 Power-Up On power up, the transmitter takes approximately 10 seconds to be ready. During this period, the device will not respond to HART commands.

12.3 Command Response Times Minimum 2ms

Typical 5ms

Maximum 150ms

12.4 Long Messages The largest data field used is in the response to Command 9: up to 71 bytes including the two status bytes.

12.5 Non-Volatile Memory EEPROM is used to hold the device’s configuration parameters. New data is written to this memory immediately on execution of a write command, before the consequent response.

12.6 Modes Loop current mode can be disabled or enabled using command 6.

12.7 Write Protection Write-protection is not selectable, and is always set as “not write protected”.

12.8 Damping Damping time is calculated for each dynamic variable.

Page 435: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Solicon 4 HART Manual

109345.00 / 270616 18

ANNEX A. CAPABILITY CHECKLIST

Manufacturer, model and revision SWAN Analytic Instruments, AMI Solicon 4 rev. 1

Device type Transmitter

HART revision 7.x

Device Description available Yes

Number and type of sensors 4 (three external, one internal)

Number and type of actuators 0

Number and type of host side signals 1: 4 - 20mA analog

Number of Device Variables 6

Number of Dynamic Variables 4

Mappable Dynamic Variables? Yes

Number of common-practice commands 3

Number of device-specific commands 0

Bits of additional device status 48

Alternative operating modes? No

Burst mode? No

Write-protection? No

Page 436: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Solicon 4 HART Manual

109345.00 / 270616 19

ANNEX B. DEFAULT CONFIGURATION

Parameter Default value

PV Sensor Type Conductivity

Lower Range Value 0 uS/cm

Upper Range Value 300000 uS/cm

PV Units uS/cm

Damping time constant 1.592 seconds

Fault-indication jumper Not used

Write-protect jumper Not used

Number of response preambles 5

Page 437: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Solicon 4 HART Manual

109345.00 / 270616 20

ANNEX C. REVISION HISTORY

Document Title HART Interface Description AMI Solicon 4

Document ID 109345.00

Document Revision

Date Device Revision DD Revision Description

1.0 27/06/2016 1 1 First release, for HART 7.x Device

Page 438: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments

HART® 7.x Field Device Specification for AMI Trides Transmitters

SWAN Analytical Instruments 8340, Studbachstrasse 13

Hinwil Switzerland

Page 439: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Trides HART Manual

109370.00 / 230616 2

TABLE OF CONTENTS

1. Introduction ......................................................................................................................................4

1.1 Scope ....................................................................................................................................4

1.2 Purpose .................................................................................................................................4

1.3 Who should use this document? ..........................................................................................4

1.4 References ............................................................................................................................4

2. Device Identification ........................................................................................................................5

3. Product Overview ............................................................................................................................5

3.1 Connections..........................................................................................................................5

3.1.1 Point to point Mode ..............................................................................................5

3.1.2 Multidrop Mode ....................................................................................................6

3.1.3 HARTREC Board .................................................................................................6

4. Product Interfaces ............................................................................................................................7

4.1 Process Interface ..................................................................................................................7

4.1.1 Sensor Input Channels ..........................................................................................7

4.2 Host Interface .......................................................................................................................7

4.2.1 Process Sodium .....................................................................................................7

4.3 Local Interfaces ....................................................................................................................7

4.3.1 Local Controls and Displays .................................................................................7

4.3.2 Write Protection ....................................................................................................7

5. Device Variables ..............................................................................................................................8

5.1 Device Variable 0 Disinfectant ............................................................................................8

5.2 Device Variable 1 pH / Redox .............................................................................................8

5.3 Device Variable 2 Temperature ...........................................................................................8

5.4 Device Variable 3 Flow rate ................................................................................................8

5.5 Device Variable 4 Hypochlorus acid ...................................................................................8

5.6 Device Variable 5 Case Temperature ..................................................................................8

6. Dynamic Variables ...........................................................................................................................9

6.1 Mappable Variables .............................................................................................................9

6.2 PV Transfer Functions .........................................................................................................9

Page 440: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Trides HART Manual

109370.00 / 230616 3

7. Status Information ..........................................................................................................................10

7.1 Field Device Status ............................................................................................................10

7.2 Extended Device Status .....................................................................................................10

7.3 Additional Device Status (Command #48) ........................................................................11

8. Universal Commands .....................................................................................................................12

9. Common-Practice Commands .......................................................................................................14

9.1 Supported Common Practice Commands ..........................................................................14

9.2 Burst Mode .........................................................................................................................14

9.3 Catch Device Variable .......................................................................................................14

10. Device-Specific Commands ...........................................................................................................14

11. Tables 15

11.1 Engineering Type Unit Codes ............................................................................................15

11.2 Classification Unit Codes ..................................................................................................15

12. Performance ...................................................................................................................................16

12.1 Sampling Rates ..................................................................................................................16

12.2 Power-Up ...........................................................................................................................16

12.3 Command Response Times................................................................................................16

12.4 Long Messages ...................................................................................................................16

12.5 Non-Volatile Memory ........................................................................................................16

12.6 Modes .................................................................................................................................16

12.7 Write Protection .................................................................................................................16

12.8 Damping .............................................................................................................................16

Annex B. Default Configuration ........................................................................................................18

Annex C. Revision History ................................................................................................................19

Page 441: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Trides HART Manual

109370.00 / 230616 4

1. INTRODUCTION 1.1 Scope The SWAN Analytical Instruments model AMI Trides transmitter complies with HART Protocol Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering Unit Codes supported). The functionality of this Field Device is described sufficiently to allow its proper application in a process and its complete support in HART capable Host Applications.

1.2 Purpose This specification is designed to complement the AMI Trides manual by providing a complete description of this Field Device from a HART Communication perspective.

1.3 Who should use this document? The specification is designed to be a technical reference for HART capable Host Application Developers, System Integrators and knowledgeable End Users. It also provides functional specifications (e.g., commands and performance requirements) used during development, maintenance and testing. This document assumes the reader is familiar with HART Protocol requirements and terminology.

1.4 References HART Smart Communications Protocol Specification. HCF_SPEC-12. Available from the HCF.

MenAMI_Trides_xx.pdf. Available from the SWAN Analytical Instruments web page.

Page 442: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Trides HART Manual

109370.00 / 230616 5

2. DEVICE IDENTIFICATION Manufacturer Name: SWAN Analytical

Instruments Model Name(s): AMI Trides

Manufacture ID Code: 24757 (60B5 Hex)

Device Type Code:

58197 (E355 Hex)

HART Protocol Revision 7.5 Device Revision: 1

Number of Device Variables 6

Physical Layers Supported FSK

Physical Device Category Transmitter, Non-DC-isolated Bus Device

3. PRODUCT OVERVIEW The AMI Trides HART communication option board provides a 4 to 20mA output signal and can be monitored and configured using a HART master device or a hand-held communicator.

3.1 Connections 3.1.1 Point to point Mode

An external minimum 250 Ω (maximum 800 Ω) resistor is needed in order to communicate with HART protocol.

Page 443: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Trides HART Manual

109370.00 / 230616 6

3.1.2 Multidrop Mode

A single minimum 250 Ω resistor (maximum 800 Ω) is needed to communicate with all the instruments connected to the bus, and each of them must provide 4mA.

3.1.3 HARTREC Board

The HARTREC Board must be installed in the AMI transmitter in order to communicate with HART.

Page 444: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Trides HART Manual

109370.00 / 230616 7

4. PRODUCT INTERFACES 4.1 Process Interface 4.1.1 Sensor Input Channels Refer to AMI Trides manual to details on mounting FOME sensor.

4.2 Host Interface 4.2.1 Process Sodium The 4 to 20mA output of the AMI Trides HART option board represents a process value measurement, scaled according to the configured range of the instrument. This output corresponds to the Primary Variable. HART Communication is supported on this loop.

Since Dynamic Variables are mappable, PV can correspond to one of the following variables:

- Disinfectant

- pH/Redox

- Temperature

- Flow rate

- Hypochlorus acid

It is also possible to set the PV from the instrument local display, in the “Signal Output 3 / Parameter” settings.

4.3 Local Interfaces 4.3.1 Local Controls and Displays This device has a local display that allows the complete configurability of the instrument.

Refer to AMI Trides manual to details on it.

4.3.2 Write Protection The Field Device has no “Write protection mode”.

Page 445: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Trides HART Manual

109370.00 / 230616 8

5. DEVICE VARIABLES This Field Device exposes four Device Variables

Device Variables Variables Meaning Units 0 Disinfectant ppm

1 pH/Redox pH/mV

2 Temperature °C

3 Flow rate rpm

4 Hypochlorus acid ppm

5 Case Temperature °C

5.1 Device Variable 0 Disinfectant Disinfectant is read by means of the Trides Sensor (Refer to AMI Trides manual to details on it).

5.2 Device Variable 1 pH / Redox pH/Redox is read with the pH/Redox electrode (Refer to AMI Trides manual to details on it).

5.3 Device Variable 2 Temperature Temperature is read by means of the Temperature sensor (Refer to AMI Trides manual to details on it).

5.4 Device Variable 3 Flow rate Flow rate is read by means of the Hall effect sensor (Refer to AMI Trides manual to details on it).

5.5 Device Variable 4 Hypochlorus acid Hypochlorus acid is calculated starting from disinfectant and pH values (Refer to AMI Trides manual to details on it).

5.6 Device Variable 5 Case Temperature Case Temperature shows the Temperature read inside the Electronic Box.

Page 446: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Trides HART Manual

109370.00 / 230616 9

6. DYNAMIC VARIABLES 6.1 Mappable Variables Three mappable Dynamic Variables are implemented.

Dynamic Variables Variables Meaning Units

PV Disinfectant - pH/Redox -Temp. - Flow rate -

Hypochlorus ppm - pH/mV - °C - rpm -

ppm

SV Disinfectant - pH/Redox -Temp. - Flow rate -

Hypochlorus ppm - pH/mV - °C - rpm -

ppm

TV Disinfectant - pH/Redox -Temp. - Flow rate -

Hypochlorus ppm - pH/mV - °C - rpm -

ppm

QV Disinfectant - pH/Redox -Temp. - Flow rate -

Hypochlorus ppm - pH/mV - °C - rpm -

ppm

It is possible to associate any of these dynamic variables to PV, SV, TV or QV with a HART Master (or Handheld Communicator).

The PV is also settable from the instrument local display’s settings.

6.2 PV Transfer Functions The Primary Variable Transfer Function can be read with command 15. Its meaning is referred to the following table.

Transfer Function Type Code

Linear 240

Bilinear 241

Logarithmic 242

Control Upwards 243

Control Downwards 244

Page 447: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Trides HART Manual

109370.00 / 230616 10

7. STATUS INFORMATION 7.1 Field Device Status The functions of the Field Device Status bits are specified in HCF_SPEC-99. Further details of their implementation are described in the following table.

Bit Name Notes

7 Device Malfunction Set on any detected Hardware Error

6 Configuration Changed Set if any changes are made to Field Device Configuration

5 Cold Start Set when powered-up or after a device reset

4 More Status Available Set if any Alarm or Maintenance has changed its status. More information is available via command 48

3 Loop Current Fixed The Loop Current is being held at a fixed value and is not responding to process variations

2 Loop Current Saturated The Loop Current has reached its upper (or lower) endpoint limit and cannot increase (or decrease) any further

1 Non-PV Out of Limits A Device Variable not mapped to the PV is beyond its

operating limits

0 PV Out of Limits The PV is beyond its operating limit

7.2 Extended Device Status Contains additional information regarding the status of the Field Device.

Bit Name Notes

2 Critical Power Failure Set when battery is becoming critically low (less than 15 min) and Field Device not connected to Power Supply

1 Device Variable Alert

Set when one or more Device Variables are in one of the following conditions:

• Hi/low limited (Limit Status)

• Bad (Process Data Status)

• Poor Accuracy (Process Data Status)

0 Maintenance Required Not Used

Page 448: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Trides HART Manual

109370.00 / 230616 11

7.3 Additional Device Status (Command #48) Command #48 returns 4 additional bytes of data (Int32 or Int16 Little Endian), with the following status information:

ALARMS CODES:

Byte Bit Meaning Alarm Code

0 – 3

(INT32)

0 DIS. Alarm high E001 1 DIS. Alarm low E002 2 pH/Redox Alarm high E003 3 pH/Redox Alarm low E004 4 Reserved 5 Reserved 6 Sample Temp. high E007 7 Sample Temp. low E008 8 Sample Flow high E009 9 Sample Flow low E010 10 Temp. shorted E011 11 Temp. disconnected E012 12 Case Temp. high E013 13 Case Temp. low E014 14 TRIDES Reference E015 15 Reserved 16 Control Timeout E017 17 Reserved 18 Reserved 19 Reserved 20 Reserved 21 Reserved 22 Cleaning Reagent E023 23 Input active E024 24 IC MK41T56 E025 25 IC LM75 E026 26 IC PCF8574 E027 27 Signal output open E028 28 EEProm Motherboard E029 29 EEProm Frontend E030 30 Cal. Recout E031 31 Wrong Frontend E032

"Reserved" bits are always set to 0.

Page 449: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Trides HART Manual

109370.00 / 230616 12

All bits used in these bytes indicate device/sensor failure or maintenances, and always set bit 4 of the Device Status byte.

8. UNIVERSAL COMMANDS Number Name Notes

0 Read Unique Identifier Returns identity information of the Field Device

1 Read Primary Variable Returns PV value and its unit

2 Read Loop Current and Percent of Range Returns AO value and % range

3 Read Dynamic Variables and Loop Current Returns PV, SV, TV and QV values and corresponding unit values along with AO value

6 Write Polling Address Changes Field Device’s polling address and loop current mode

7 Read Loop Configuration Returns polling address and loop current mode status

8 Read Dynamic Variable Classifications Returns dynamic variables classification

9 Read Device Variables with Status Returns device variables with status

11 Read Unique Identifier Associated With Tag Same response as command 0 when Tag matches

12 Read Message Returns 24 bytes of packed ASCII data

13 Read Tag, Descriptor, Date Returns tag, descriptor (packed ASCII format) and date from the device

14 Read Primary Variable Transducer Information Returns PV transducer limits and span

15 Read Device Information Returns PV unit value, LRV, URV, damping value and write protect code

16 Read Final Assembly Number Returns final assembly number

17 Write Message Write 24 bytes of packed ASCII data.

Page 450: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Trides HART Manual

109370.00 / 230616 13

18 Write Tag, Descriptor, Date Writes tag, descriptor (packed ASCII format) and date to the device

19 Write Final Assembly Number Writes final assembly number to the device

20 Read Long Tag Returns 32-byte Long Tag

21 Read Unique Identifier Associated with Long Tag Same response as command 0 when Long Tag matches

22 Write Long Tag Writes Long Tag to the Field Device

38 Reset Configuration Changed Flag Resets the configuration change flag

48 Read Additional Device Status See 7.3 for details

Page 451: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Trides HART Manual

109370.00 / 230616 14

9. COMMON-PRACTICE COMMANDS 9.1 Supported Common Practice Commands

9.2 Burst Mode This Field Device does not support Burst Mode.

9.3 Catch Device Variable This Field Device does not support Catch Device Variable.

10. DEVICE-SPECIFIC COMMANDS This Field Device does not support Device Specific Commands.

Number Name Notes

33 Read Device Variables Returns all the Supported Device Variables

50 Read Dynamic Variable Assignment Returns the Variable Numbers associated with PV, SV, TV and QV

51 Write Dynamic Variable Assignment Writes the Variable Numbers associated with PV, SV, TV and QV

Page 452: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Trides HART Manual

109370.00 / 230616 15

11. TABLES 11.1 Engineering Type Unit Codes

Units of Measurement Unit Code Temperature Degrees Celsius 32 Electric Potential millivolts 36 Electric Resistance Ω 37 Miscellaneous Hertz 38 Electric Current milliamperes 39 Time Minutes 50 Time Seconds 51 Time Hours 52 Time Days 53 Miscellaneous Micro Siemens 56 Miscellaneous Percent 57 Electric Potential Volts 58 Miscellaneous pH 59 Flow Liters per hour 138 Concentration Parts per million 139 Electric Resistance kΩ 163 Concentration Parts per billion 169 Flow Revolutions per minute 241 Not used 250

11.2 Classification Unit Codes Measurement Meas. Code Temperature 64 Volumetric flow 66 Time 70 Frequency 80 Analytical 81 Electric Potential 83 Current 84 Resistance 85 Conductance 87 Concentration 90 Turbidity 97 Not used 250 Special 253

Page 453: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Trides HART Manual

109370.00 / 230616 16

12. PERFORMANCE 12.1 Sampling Rates Typical sampling rates are shown in the following table.

Trides sensor value sample 1 per second

pH electrode value sample 1 per second

Temperature sensor sample 1 per second

Hall effect sensor sample 1 per second

Case Temperature sensor sample 1 per second

Note: all the Device Variables use an Infinite Impulse Response Filter, with coefficients depending on the measured variable. The Damping Value is different for each of the Device Variables, and can be read through Command 15.

12.2 Power-Up On power up, the transmitter takes approximately 10 seconds to be ready. During this period, the device will not respond to HART commands.

12.3 Command Response Times

Minimum 2ms

Typical 5ms

Maximum 150ms

12.4 Long Messages The largest data field used is in the response to Command 9: up to 71 bytes including the two status bytes.

12.5 Non-Volatile Memory EEPROM is used to hold the device’s configuration parameters. New data is written to this memory immediately on execution of a write command, before the consequent response.

12.6 Modes Loop current mode can be disabled or enabled using command 6.

12.7 Write Protection Write-protection is not selectable, and is always set as “not write protected”.

12.8 Damping Damping time is calculated for each dynamic variable.

Page 454: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Trides HART Manual

109370.00 / 230616 17

ANNEX A: CAPABILITY CHECKLIST

Manufacturer, model and revision SWAN Analytic Instruments, AMI Trides rev. 1

Device type Transmitter

HART revision 7.x

Device Description available Yes

Number and type of sensors 5 (four external, one internal)

Number and type of actuators 0

Number and type of host side signals 1: 4 - 20mA analog

Number of Device Variables 6

Number of Dynamic Variables 4

Mappable Dynamic Variables? Yes

Number of common-practice commands 3

Number of device-specific commands 0

Bits of additional device status 32

Alternative operating modes? No

Burst mode? No

Write-protection? No

Page 455: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Trides HART Manual

109370.00 / 230616 18

ANNEX B. DEFAULT CONFIGURATION

Parameter Default value

PV Sensor Type Disinfectant

Lower Range Value 0 ppm

Upper Range Value 20 ppm

PV Units ppm

Damping time constant 4.777 seconds

Fault-indication jumper Not used

Write-protect jumper Not used

Number of response preambles 5

Page 456: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Trides HART Manual

109370.00 / 230616 19

ANNEX C. REVISION HISTORY

Document Title HART Interface Description AMI Trides

Document ID 109370.00

Document Revision

Date Device Revision DD Revision Description

1.0 23/06/2016 1 1 First release, for HART 7.x Device

Page 457: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments

HART® 7.x Field Device Specification for AMI Turbi Transmitters

SWAN Analytical Instruments 8340, Studbachstrasse 13

Hinwil Switzerland

Page 458: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Turbi HART Manual

109371.00 / 270616 2

TABLE OF CONTENTS

1. Introduction ......................................................................................................................................4

1.1 Scope ....................................................................................................................................4

1.2 Purpose .................................................................................................................................4

1.3 Who should use this document? ..........................................................................................4

1.4 References ............................................................................................................................4

2. Device Identification ........................................................................................................................5

3. Product Overview ............................................................................................................................5

3.1 Connections..........................................................................................................................5

3.1.1 Point to point Mode ..............................................................................................5

3.1.2 Multidrop Mode ....................................................................................................6

3.1.3 HARTREC Board .................................................................................................6

4. Product Interfaces ............................................................................................................................7

4.1 Process Interface ..................................................................................................................7

4.1.1 Sensor Input Channels ..........................................................................................7

4.2 Host Interface .......................................................................................................................7

4.2.1 Process Turbidity ..................................................................................................7

4.3 Local Interfaces ....................................................................................................................7

4.3.1 Local Controls and Displays .................................................................................7

4.3.2 Write Protection ....................................................................................................7

5. Device Variables ..............................................................................................................................8

5.1 Device Variable 0 Turbidity.................................................................................................8

5.2 Device Variable 1 Flow rate ................................................................................................8

5.3 Device Variable 2 Temperature ...........................................................................................8

5.4 Device Variable 3 Case Temperature ..................................................................................8

6. Dynamic Variables ...........................................................................................................................9

6.1 Mappable Variables .............................................................................................................9

6.2 PV Transfer Functions .........................................................................................................9

7. Status Information ..........................................................................................................................10

7.1 Field Device Status ............................................................................................................10

Page 459: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Turbi HART Manual

109371.00 / 270616 3

7.2 Extended Device Status .....................................................................................................10

7.3 Additional Device Status (Command #48) ........................................................................11

8. Universal Commands .....................................................................................................................13

9. Common-Practice Commands .......................................................................................................15

9.1 Supported Common Practice Commands ..........................................................................15

9.2 Burst Mode .........................................................................................................................15

9.3 Catch Device Variable .......................................................................................................15

10. Device-Specific Commands ...........................................................................................................15

11. Tables 16

11.1 Engineering Type Unit Codes ............................................................................................16

11.2 Classification Unit Codes ..................................................................................................16

12. Performance ...................................................................................................................................17

12.1 Sampling Rates ..................................................................................................................17

12.2 Power-Up ...........................................................................................................................17

12.3 Command Response Times................................................................................................17

12.4 Long Messages ...................................................................................................................17

12.5 Non-Volatile Memory ........................................................................................................17

12.6 Modes .................................................................................................................................17

12.7 Write Protection .................................................................................................................17

12.8 Damping .............................................................................................................................17

Annex B. Default Configuration ........................................................................................................19

Annex C. Revision History ................................................................................................................20

Page 460: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Turbi HART Manual

109371.00 / 270616 4

1. INTRODUCTION 1.1 Scope The SWAN Analytical Instruments model AMI Turbi transmitter complies with HART Protocol Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering Unit Codes supported). The functionality of this Field Device is described sufficiently to allow its proper application in a process and its complete support in HART capable Host Applications.

1.2 Purpose This specification is designed to complement the AMI Turbi manual by providing a complete description of this Field Device from a HART Communication perspective.

1.3 Who should use this document? The specification is designed to be a technical reference for HART capable Host Application Developers, System Integrators and knowledgeable End Users. It also provides functional specifications (e.g., commands and performance requirements) used during development, maintenance and testing. This document assumes the reader is familiar with HART Protocol requirements and terminology.

1.4 References HART Smart Communications Protocol Specification. HCF_SPEC-12. Available from the HCF.

MenAMI_Turbi_xx.pdf. Available from the SWAN Analytical Instruments web page.

Page 461: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Turbi HART Manual

109371.00 / 270616 5

2. DEVICE IDENTIFICATION Manufacturer Name: SWAN Analytical

Instruments Model Name(s): AMI Turbi

Manufacture ID Code: 24757 (60B5 Hex)

Device Type Code:

58198 (E356 Hex)

HART Protocol Revision 7.5 Device Revision: 1

Number of Device Variables 4

Physical Layers Supported FSK

Physical Device Category Transmitter, Non-DC-isolated Bus Device

3. PRODUCT OVERVIEW The AMI Turbi HART communication option board provides a 4 to 20mA output signal and can be monitored and configured using a HART master device or a hand-held communicator.

3.1 Connections 3.1.1 Point to point Mode

An external minimum 250 Ω (maximum 800 Ω) resistor is needed in order to communicate with HART protocol.

Page 462: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Turbi HART Manual

109371.00 / 270616 6

3.1.2 Multidrop Mode

A single minimum 250 Ω resistor (maximum 800 Ω) is needed to communicate with all the instruments connected to the bus, and each of them must provide 4mA.

3.1.3 HARTREC Board

The HARTREC Board must be installed in the AMI transmitter in order to communicate with HART.

Page 463: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Turbi HART Manual

109371.00 / 270616 7

4. PRODUCT INTERFACES 4.1 Process Interface 4.1.1 Sensor Input Channels Refer to AMI Turbi manual to details on mounting FOME sensor.

4.2 Host Interface 4.2.1 Process Turbidity The 4 to 20mA output of the AMI Turbi HART option board represents a process value measurement, scaled according to the configured range of the instrument. This output corresponds to the Primary Variable. HART Communication is supported on this loop.

Since Dynamic Variables are mappable, PV can correspond to one of the following variables:

- Turbidity / Concentration

- Flow rate

It is also possible to set the PV from the instrument local display, in the “Signal Output 3 / Parameter” settings.

4.3 Local Interfaces 4.3.1 Local Controls and Displays This device has a local display that allows the complete configurability of the instrument.

Refer to AMI Turbi manual to details on it.

4.3.2 Write Protection The Field Device has no “Write protection mode”.

Page 464: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Turbi HART Manual

109371.00 / 270616 8

5. DEVICE VARIABLES This Field Device exposes four Device Variables

Device Variables Variables Meaning Units 0 Turbidity / Concentration FNU-NTU/ppm

1 Flow rate l/h

2 Temperature °C

3 Case Temperature °C

5.1 Device Variable 0 Turbidity Turbidity is read inside the measuring chamber (Refer to AMI Turbi manuals to details on it).

5.2 Device Variable 1 Flow rate Flow rate is read by means of the flow meter (Refer to AMI Turbi manuals to details on it).

5.3 Device Variable 2 Temperature Temperature is read by means of the Temperature sensor (Refer to AMI Turbi manuals to details on it).

5.4 Device Variable 3 Case Temperature Case Temperature shows the Temperature read inside the Electronic Box.

Page 465: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Turbi HART Manual

109371.00 / 270616 9

6. DYNAMIC VARIABLES 6.1 Mappable Variables Three mappable Dynamic Variables are implemented.

Dynamic Variables Variables Meaning Units

PV Turbidity / Concentration – Flow rate FNU – NTU / ppm – l/h

SV Turbidity / Concentration – Flow rate FNU – NTU / ppm – l/h

It is possible to associate any of these dynamic variables to PV or SV with a HART Master (or Handheld Communicator).

The PV is also settable from the instrument local display’s settings.

6.2 PV Transfer Functions The Primary Variable Transfer Function can be read with command 15. Its meaning is referred to the following table.

Transfer Function Type Code

Linear 240

Bilinear 241

Logarithmic 242

Control Upwards 243

Control Downwards 244

Page 466: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Turbi HART Manual

109371.00 / 270616 10

7. STATUS INFORMATION 7.1 Field Device Status The functions of the Field Device Status bits are specified in HCF_SPEC-99. Further details of their implementation are described in the following table.

Bit Name Notes

7 Device Malfunction Set on any detected Hardware Error

6 Configuration Changed Set if any changes are made to Field Device Configuration

5 Cold Start Set when powered-up or after a device reset

4 More Status Available Set if any Alarm or Maintenance has changed its status. More information is available via command 48

3 Loop Current Fixed The Loop Current is being held at a fixed value and is not responding to process variations

2 Loop Current Saturated The Loop Current has reached its upper (or lower) endpoint limit and cannot increase (or decrease) any further

1 Non-PV Out of Limits A Device Variable not mapped to the PV is beyond its

operating limits

0 PV Out of Limits The PV is beyond its operating limit

7.2 Extended Device Status Contains additional information regarding the status of the Field Device.

Bit Name Notes

2 Critical Power Failure Set when battery is becoming critically low (less than 15 min) and Field Device not connected to Power Supply

1 Device Variable Alert

Set when one or more Device Variables are in one of the following conditions:

• Hi/low limited (Limit Status)

• Bad (Process Data Status)

• Poor Accuracy (Process Data Status)

0 Maintenance Required Not Used

Page 467: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Turbi HART Manual

109371.00 / 270616 11

7.3 Additional Device Status (Command #48) Command #48 returns 6 additional bytes of data (Int32 or Int16 Little Endian), with the following status information:

ALARMS - MAINTENANCE CODES:

Byte Bit Meaning Alarm Code

0 – 3

(INT32)

0 Alarm high E001 1 Alarm low E002 2 Reserved 3 Reserved 4 Range E005 5 Reserved 6 Reserved 7 Reserved 8 Sample Flow high E009 9 Sample Flow low E010 10 Reserved 11 Reserved 12 Case Temp. high E013 13 Case Temp. low E014 14 Reserved 15 Zero too high E016 16 Control Timeout E017 17 Turbi disconnected E018 18 Turbi Overflow E019 19 Lamp off E020 20 EEProm Turbi E021 21 Reserved 22 Cleaning Reagent E023 23 Input active E024 24 IC MK41T56 E025 25 IC LM75 E026 26 IC PCF8574 E027 27 Signal output open E028 28 EEProm Motherboard E029 29 EEProm Frontend E030 30 Calibration Recout E031 31 Wrong Frontend E032

Page 468: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Turbi HART Manual

109371.00 / 270616 12

4 – 5

(INT16)

0 Photometer dirty E065 1 Filter congested E066 2 Check absorber E067 3 Reserved 4 Reserved 5 Reserved 6 Reserved 7 Reserved 8 Reserved 9 Reserved 10 Reserved 11 Reserved 12 Reserved 13 Reserved 14 Reserved 15 Reserved

"Reserved" bits are always set to 0.

All bits used in these bytes indicate device/sensor failure or maintenances, and always set bit 4 of the Device Status byte.

Page 469: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Turbi HART Manual

109371.00 / 270616 13

8. UNIVERSAL COMMANDS Number Name Notes

0 Read Unique Identifier Returns identity information of the Field Device

1 Read Primary Variable Returns PV value and its unit

2 Read Loop Current and Percent of Range Returns AO value and % range

3 Read Dynamic Variables and Loop Current Returns PV and SV values and corresponding unit values along with AO value

6 Write Polling Address Changes Field Device’s polling address and loop current mode

7 Read Loop Configuration Returns polling address and loop current mode status

8 Read Dynamic Variable Classifications Returns dynamic variables classification

9 Read Device Variables with Status Returns device variables with status

11 Read Unique Identifier Associated With Tag Same response as command 0 when Tag matches

12 Read Message Returns 24 bytes of packed ASCII data

13 Read Tag, Descriptor, Date Returns tag, descriptor (packed ASCII format) and date from the device

14 Read Primary Variable Transducer Information Returns PV transducer limits and span

15 Read Device Information Returns PV unit value, LRV, URV, damping value and write protect code

16 Read Final Assembly Number Returns final assembly number

17 Write Message Write 24 bytes of packed ASCII data.

18 Write Tag, Descriptor, Date Writes tag, descriptor (packed ASCII format) and date to the device

Page 470: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Turbi HART Manual

109371.00 / 270616 14

19 Write Final Assembly Number Writes final assembly number to the device

20 Read Long Tag Returns 32-byte Long Tag

21 Read Unique Identifier Associated with Long Tag Same response as command 0 when Long Tag matches

22 Write Long Tag Writes Long Tag to the Field Device

38 Reset Configuration Changed Flag Resets the configuration change flag

48 Read Additional Device Status See 7.3 for details

Page 471: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Turbi HART Manual

109371.00 / 270616 15

9. COMMON-PRACTICE COMMANDS 9.1 Supported Common Practice Commands

9.2 Burst Mode This Field Device does not support Burst Mode.

9.3 Catch Device Variable This Field Device does not support Catch Device Variable.

10. DEVICE-SPECIFIC COMMANDS This Field Device does not support Device Specific Commands.

Number Name Notes

33 Read Device Variables Returns all the Supported Device Variables

50 Read Dynamic Variable Assignment Returns the Variable Numbers associated with PV and SV

51 Write Dynamic Variable Assignment Writes the Variable Numbers associated with PV and SV

Page 472: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Turbi HART Manual

109371.00 / 270616 16

11. TABLES 11.1 Engineering Type Unit Codes Units of Measurement Unit Code Temperature Degrees Celsius 32 Electric Potential millivolts 36 Electric Resistance Ω 37 Miscellaneous Hertz 38 Electric Current milliamperes 39 Time Minutes 50 Time Seconds 51 Time Hours 52 Time Days 53 Miscellaneous Micro Siemens 56 Miscellaneous Percent 57 Electric Potential Volts 58 Miscellaneous pH 59 Flow Liters per hour 138 Concentration Parts per million 139 Electric Resistance kΩ 163 Concentration Parts per billion 169 Turbidity Formazin Nephelometric Units 170 Turbidity Nephelometric Turbidity Unit 172 Not used 250 Special 253

11.2 Classification Unit Codes Measurement Meas. Code Temperature 64 Volumetric flow 66 Time 70 Frequency 80 Analytical 81 Electric Potential 83 Current 84 Resistance 85 Conductance 87 Concentration 90 Turbidity 97 Not used 250 Special 253

Page 473: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Turbi HART Manual

109371.00 / 270616 17

12. PERFORMANCE 12.1 Sampling Rates Typical sampling rates are shown in the following table.

Turbi sensor value sample 1 per second

Temperature sensor sample 1 per second

Flow meter sensor sample 1 per second

Case Temperature sensor sample 1 per second

Note: all the Device Variables use an Infinite Impulse Response Filter, with coefficients depending on the measured variable. The Damping Value is different for each of the Device Variables, and can be read through Command 15.

12.2 Power-Up On power up, the transmitter takes approximately 10 seconds to be ready. During this period, the device will not respond to HART commands.

12.3 Command Response Times

Minimum 2ms

Typical 5ms

Maximum 150ms

12.4 Long Messages The largest data field used is in the response to Command 9: up to 71 bytes including the two status bytes.

12.5 Non-Volatile Memory EEPROM is used to hold the device’s configuration parameters. New data is written to this memory immediately on execution of a write command, before the consequent response.

12.6 Modes Loop current mode can be disabled or enabled using command 6.

12.7 Write Protection Write-protection is not selectable, and is always set as “not write protected”.

12.8 Damping Damping time is calculated for each dynamic variable.

Page 474: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Turbi HART Manual

109371.00 / 270616 18

ANNEX A: CAPABILITY CHECKLIST

Manufacturer, model and revision SWAN Analytic Instruments, AMI Turbi rev. 1

Device type Transmitter

HART revision 7.x

Device Description available Yes

Number and type of sensors 3 (two external, one internal)

Number and type of actuators 0

Number and type of host side signals 1: 4 - 20mA analog

Number of Device Variables 4

Number of Dynamic Variables 2

Mappable Dynamic Variables? Yes

Number of common-practice commands 3

Number of device-specific commands 0

Bits of additional device status 48

Alternative operating modes? No

Burst mode? No

Write-protection? No

Page 475: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Turbi HART Manual

109371.00 / 270616 19

ANNEX B. DEFAULT CONFIGURATION

Parameter Default value

PV Sensor Type Turbidity

Lower Range Value 0 FNU

Upper Range Value 250 FNU

PV Units FNU

Damping time constant 4.777 seconds

Fault-indication jumper Not used

Write-protect jumper Not used

Number of response preambles 5

Page 476: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

SWAN Analytical Instruments AMI Turbi HART Manual

109371.00 / 270616 20

ANNEX C. REVISION HISTORY

Document Title HART Interface Description AMI Turbi

Document ID 109371.00

Document Revision

Date Device Revision DD Revision Description

1.0 27/06/2016 1 1 First release, for HART 7.x Device

Page 477: HART - irp-cdn.multiscreensite.com · Revision 7.5. This document specifies all the device specific features and documents HART Protocol implementation details (i.e. the Engineering

HART Interface Description

A-96.250.861 / 160718

SWAN is represented worldwide by subsidiary companies

and distributors.

cooperates with independent representatives

all over the world.

SWAN Products Analytical Instruments for

High Purity Water

Feedwater, Steam and Condensate

Potable Water

Pool and Sanitary Water

Cooling Water

Waste Water and Effluents

Made in Switzerland