Omega CN32Pt User manual

CN32Pt, CN16Pt, CN16PtD, CN8Pt, CN8PtD
DP32Pt, DP16Pt, DP8Pt
Load & Save
File Format

The information contained in this document is believed to be correct, but OMEGA accepts no liability for any errors it contains, and
reserves the right to alter specifications without notice.

Platinum Load & Save File Format
Table of Contents
1Introduction........................................................................................................... 2
1.1 Purpose....................................................................................................................2
1.2 Definition of Terms and Acronyms ........................................................................2
1.3 Applicable Documents............................................................................................3
2File Format ............................................................................................................ 4
2.1 Meta records............................................................................................................4
2.1.1 User Meta-records.................................................................................................................5
2.2 Comments................................................................................................................5
2.3 Data records ............................................................................................................5
2.3.1 Item Field...............................................................................................................................5
2.3.2 Value Field ............................................................................................................................5
2.4 Device Configuration Records ...............................................................................5
Revision 0.1 Page 1 of 15

Platinum Load & Save File Format
1 Introduction
1.1 Purpose
The following document defines the file format used by the Platinum series Load and Save
commands.
The Save command is intended to capture the configuration of a Platinum series controller and save
it on removable media (ie: USB Stick memory).
The Load command is intended to read a configuration image from an external device (ie: USB
memory stick) and store it on a Platinum device.
The file format used is an ASCII text file, with tab delimiters between each field. These files may be
reviewed or modified using a simple text editor or application programs such as Microsoft Excel that
support reading tab delimited files.
1.2 Definition of Terms and Acronyms
I2C 2 wire serial interface
Base Device Device connected to slave device
Smart Input Device supporting 1 or more Input sensors
Smart Output Device supporting 1 or more Output Elements
Sensor Element One of the physical sensing elements on a Smart Output
AC Alternating Current
DC Direct Current
CS Chip Select
ADC Analog to Digital Converter
DAC Digital to Analog Converter
RS485 Electrical signals used for serial communications
RS232 Electrical signals used for serial communications
CSV Comma Separated Values
COTS Commercially-Off-The-Shelf
ESD Electo Static Discharge
FW Firmware
HW Hardware
I/O Input/Output
LED Light Emitting Diode
Hexadecimal Values expressed using base 16 (24)
Revision 0.1 Page 2 of 15

Platinum Load & Save File Format
1.3 Applicable Documents
Doc. # Name / Description Rev. #, Date
Device Serialization and Version Information Rev 0.1
Omega Engineering Coding Standard Rev 1.2.0
Revision 0.1 Page 3 of 15

Platinum Load & Save File Format
2 File Format
The file format uses multiple records with each record having one or more fields. The ‘tab’ character
is used to separate fields within a record. All data information is represented by ASCII strings. Each
record is terminated by a CR/LF (0xd/0xa) character sequence.
Records fall into three general categories:
1) Comment / blank records
2) Keyword records
3) Data records
Record
Type Tag character Use Example
Meta Record % Defines
operations/information
other than data records
%File <tab> Platinum_0000.txt
Comment // Allow users to insert
comments to document
files
// This is a comment
Blank Line Allow separating blocks
of information
Data record <any
printable
character>
Defines data to be read
or written INPUT_SENSOR <tab> 2
NOTE: The first record within the file must contain the Keyword %Platinum.
2.1 Meta records
The following Meta Records are defined:
Meta Record
Load Function
Save Function
%Platinum
Must be first record in
the file
Generated as first record
in the file
%File <tab> Platinum_xxxx.txt
Ignored
Generated based on file
number entered by user
%Version <tab> yyy.yyyy.yyyy.yyy
Ignored
Records device F/W
version information
%Date <tab> …
Ignored
Not generated
%Author <tab> …
Ignored
Not generated
%DeviceID <tab> xxxxxxxxx
Ignored
Generated based on
internal DeviceID
information
Revision 0.1 Page 4 of 15

Platinum Load & Save File Format
%Profile <tab> xx
Saves current Profile
information and starts
loading new R&S profile
Generated, xx = 00-99
%Segment <tab> xx
Saves current segment
information and starts
loading new R&S segment
Generated, xx = 1..8
%<user defined> <tab> ????
Ignored
Ignored
2.1.1 User Meta-records
Additional meta-records may be defined by the user. Upon loading, they will be ignored and the data
will not be retained. User meta-records are not generated during the Save function.
Future versions of Platinum f/w may include support for Date Created, Date Loaded, Author and other
meta-record information.
2.2 Comments
All text following a double slash (//) will be ignored. Users may add comment information on blocks of
records on individual records following the data field.
Note that load function stops parsing the record after the data field has been captured. Extraneous
characters following the data field will be ignored.
Blank records (lines) are ignored.
2.3 Data records
Data records consist of 2 fields, an item and a value, separated by a tab character.
Item <tab> Value
2.3.1 Item Field
The item field provides a named field from the device data base.
During the load operation unrecognized items will be ignored. This allows configuration files to be
maintained across versions that introduce expanded items.
2.3.2 Value Field
The value field will be generate as either a floating point value (xx.x) or an unsigned 32 bit integer
(xx). The parser will process all characters up to the first non-numeric character.
2.4 Device Configuration Records
Device Configuration records allow loading data that enable / disable specific device features.
Device Configuration records may only be written when the device serialization mechanism is in the
write enable state. During a Load operation these records are ignored device serialization
mechanism is not in the write enable state.
During the Save operation all Device Configuration records as written to the file.
Revision 0.1 Page 5 of 15

Platinum Load & Save File Format
2.5 Example File (Partial Excel)
Revision 0.1 Page 6 of 15

Platinum Load & Save File Format
3 Parameter Name List
The following table summarizes all parameter names supported by the LOAD and SAVE file
commands.
The data TYPE column key is:
L – long (32 bit) integer
R – short (16 bit) integer
F – floating point value
Mnemonic
Type
Description
DEVICE_ID
L
Device Identifier
VERSION_NUMBER
L
Device Version (xxx.xxx.xxx.xxx)
INPUT_SENSOR
R
Enumerated sensor (input) type
TC_TYPE
R
Enumerated Thermocouple type
RTD_WIRE
R
Enumerated RTD wire type
RTD_ACRV_OHM_TYPE
R
Enumerated RTD Curve
THERMISTOR_VALUE
R
Enumerated Thermistor type
PROCESS_RANGE
R
Enumerated process input range
INPUT_SENSOR
R
Enumerated sensor (input) type
TC_TYPE
R
Enumerated Thermocouple type
RTD_WIRE
R
Enumerated RTD wire type
DB_4_20_MANUAL_LIVE
R
Enumerated Input Process mode
DB_4_20_MANUAL_READING_1
F
Manual Scale reading value 1
DB_4_20_MANUAL_INPUT_1
F
Manual Scale input value 1
DB_4_20_MANUAL_READING_2
F
Manual Scale reading value 2
DB_4_20_MANUAL_INPUT_2
F
Manual Scale input value 2
DB_4_20_LIVE_READING_1
F
Live Scale reading value 1
DB_4_20_LIVE_INPUT_1
F
Live Scale input value 1
DB_4_20_LIVE_READING_2
F
Live Scale reading value 2
DB_4_20_LIVE_INPUT_2
F
Live Scale input value 2
DB_0_24_MANUAL_LIVE
R
DB_0_24_MANUAL_READING_1
F
DB_0_24_MANUAL_INPUT_1
F
DB_0_24_MANUAL_READING_2
F
DB_0_24_MANUAL_INPUT_2
F
DB_0_24_LIVE_READING_1
F
Revision 0.1 Page 7 of 15

Platinum Load & Save File Format
DB_0_24_LIVE_INPUT_1
F
DB_0_24_LIVE_READING_2
F
DB_0_24_LIVE_INPUT_2
F
DB_10_MANUAL_LIVE
R
DB_10_MANUAL_READING_1
F
DB_10_MANUAL_INPUT_1
F
DB_10_MANUAL_READING_2
F
DB_10_MANUAL_INPUT_2
F
DB_10_LIVE_READING_1
F
DB_10_LIVE_INPUT_1
F
DB_10_LIVE_READING_2
F
DB_10_LIVE_INPUT_2
F
DB_1_MANUAL_LIVE
R
DB_1_MANUAL_READING_1
F
DB_1_MANUAL_INPUT_1
F
DB_1_MANUAL_READING_2
F
DB_1_MANUAL_INPUT_2
F
DB_1_LIVE_READING_1
F
DB_1_LIVE_INPUT_1
F
DB_1_LIVE_READING_2
F
DB_1_LIVE_INPUT_2
F
DB_POINT_1_MANUAL_LIVE
R
DB_POINT_1_MANUAL_READING_1
F
DB_POINT_1_MANUAL_INPUT_1
F
DB_POINT_1_MANUAL_READING_2
F
DB_POINT_1_MANUAL_INPUT_2
F
DB_POINT_1_LIVE_READING_1
F
DB_POINT_1_LIVE_INPUT_1
F
DB_POINT_1_LIVE_READING_2
F
DB_POINT_1_LIVE_INPUT_2
F
READING_DECIMAL_POSITION
R
Enumerated value – number of dec. points
DISPLAY_UNITS
R
Enumerated value – units of measure
Revision 0.1 Page 8 of 15