User s Manual DTSX3000 Communications(Modbus) Guide First Edition
Blank Page
< Introduction > i Introduction About this Manual Thank you for purchasing the DTSX3000 Distributed Temperature Sensor. This document describes the (Modbus) communications function of the DTSX3000. Read it carefully before using the function to ensure proper use. You may also refer to the following manuals for other information related to the DTSX3000. Manual name Document No. Description DTSXL Distributed Temperature Sensor Long Range System Guide DTAP3000 DTSX3000 Control Visualization Software Guide DTAP3000 DTSX3000 Control Visualization Software LAS 2.0 Data Conversion Guide IM 39J06B40-01E IM 39J02B40-01E IM 39J02B40-02E This document describes the functions, operation and usage precautions of the DTSXL Distributed Temperature Sensor Long Range System This document describes the functions, operation and usage precautions of the DTSX3000 Control Visualization Software, which can be used to configure the DTSX Series Distributed Temperature Sensor and display its measurement result. This document describes the functions, operation and usage precautions of the software for converting and transmitting measurement data of the DTSX3000 Distributed Temperature Sensor in LAS format. Caution Trademarks YOKOGAWA reserves the right to make improvements in the manuals and product at any time, without notice or obligation. If you have any questions, or you find mistakes or omissions in the manuals, please contact our sales representative or your local distributor. No part of the manual may be transferred or reproduced without prior written consent from YOKOGAWA. The following names are trademarks or registered trademarks of their respective holders DTSX, STARDOM and CENTUM are trademarks of Yokogawa Electric Corporation. Ethernet is a registered trademark of Xerox Corporation. Modbus is a registered trademark of AEG Schneider.
Blank Page
< CONTENTS > iii DTSX3000 Communications(Modbus) Guide CONTENTS Introduction... i CONTENTS... iii 1. Overview of the Communications Function... 1 2. Specifications... 3 2.1. Communications Interface Specifications... 3 2.1.1. Ethernet... 3 2.1.2. RS-232C... 3 2.2. Modbus Communications Protocol Specifications... 4 2.2.1. Modbus/TCP... 4 2.2.2. Modbus Serial... 4 3. Communications Setup... 5 3.1. Modbus/TCP... 5 3.1.1. Settings... 5 3.1.2. Setup Procedure... 5 3.2. Modbus Serial Communications... 8 3.2.1. Modbus Communications Related Settings... 8 3.2.2. Setup Procedure... 8 4. Modbus Communications Protocol... 11 4.1. Overview... 11 4.2. Message Structure... 11 4.2.1. Device Number... 11 4.2.2. Function Code... 11 4.2.3. Data... 12 4.2.4. Error Check Code... 12 4.3. Slave Response... 13 4.3.1. Normal Response... 13 4.3.2. Exception Response... 13 4.3.3. No Response... 13 4.4. Function Codes... 14 5. Message Description... 15 5.1. Read Holding Registers... 15 5.1.1. Message Structure... 15 5.1.2. Function Description... 15
< CONTENTS > iv 5.1.3. Example of Message Exchange... 15 5.2. Read Input Registers... 16 5.2.1. Message Structure... 16 5.2.2. Function Description... 16 5.2.3. Example of Message Exchange... 16 5.3. Write Single Register... 17 5.3.1. Message Structure... 17 5.3.2. Function Description... 17 5.3.3. Example of Message Exchange... 17 5.4. Write Multiple Registers... 18 5.4.1. Message Structure... 18 5.4.2. Function Description... 18 5.4.3. Example of Message Exchange... 18 6. Address Map... 19 6.1. Handling of Fractional Data... 19 6.2. Holding Register Address Map... 19 6.2.1. List of Holding Registers... 19 6.2.2. Description of Holding Registers... 20 6.3. Input Register Address Map... 42 6.3.1. List of Input Registers... 42 6.3.2. Description of Input Registers... 43 7. Measurement Data Monitoring Function... 53 7.1. Functional Overview... 53 7.2. Specifications... 54 7.2.1. Measurement Data Monitoring Function... 54 7.2.2. Accessing Modbus Registers... 54 7.2.3. Measurement Data Registers... 55 7.2.4. Holding Registers for Writing and Reading Measurement Condition... 57 7.2.5. Input Registers for Reading Status... 57 7.2.6. Maximum Number of Connected Modbus/TCP clients... 57 7.3. Register Structure Definition File... 58 7.3.1. File Name... 58 7.3.2. File Content... 58 7.3.3. File Loading Errors... 63 7.4. How to Use the Function... 64 7.4.1. Enabling Measurement Data Monitoring Function... 64 7.4.2. Loading Settings File... 66 Revision Information... i
< 1. Overview of the Communications Function> 1 1. Overview of the Communications Function The DTSX3000 supports communications based on the Modbus protocol via builtin Ethernet and RS-232C ports as communications interfaces. Using Modbus communications, a client/master can configure, control, as well as retrieve status information and measurement data from a remote DTSX3000. The figure below shows an example system configuration. PC PC PC STARDOM,CENTUM Control device Modbus/TCP Modbus/TCP Modbus/TCP Modbus/TCP Ethernet DTSX200 RS-232C Modbus Serial (ASCII, RTU) If connection to the DTSX3000 is by Ethernet, the Modbus/TCP communications protocol is used, the DTSX3000 runs as a Modbus/TCP server and can connect to a maximum of four client devices. If connection to the DTSX3000 is by RS-232C, the DTSX3000 runs as a slave device and communicates one-to-one with a master device. Both the RTU and ASCII serial transmission modes are supported. For RS-232C communications, a slave address must be defined for the DTSX3000.
Blank Page
2. Specifications < 2. Specification> 3 2.1. Communications Interface Specifications 2.1.1. Ethernet Item Connector type RJ-45 connector Number of ports 1 Electrical and mechanical specifications IEEE802.3 compliant Transmission mode 100BASE-TX/10BASE-T Specifications 2.1.2. RS-232C Item Connector type Number of ports Electrical and mechanical specifications Transmission mode Synchronization Baud rate Character length Parity Stop bits Flow control Specifications RJ-45 connector 3 (COM1, COM2 and COM3) * COM1 and COM2 ports are available for Modbus serial communications. EIA RS-232 compliant Full-duplex Start-stop synchronization 1200, 2400, 4800, 9600, 19200, 38400, 57600 or 115200 bps (selectable) * The COM2 port supports baud rates up to 38400 bps. 7 or 8 bits None, even or odd 1 bit or 2 bits None, rts/cts or xon/xoff
2.2. Modbus Communications Protocol Specifications 2.2.1. Modbus/TCP < 2. Specification> 4 The DTSX3000 supports the Modbus/TCP server function (equivalent to the Modbus slave function) and allows connection to a maximum of five client devices. It also has a timeout function, which automatically disconnects a client device if there is no communication for a specified timeout interval or longer. To maintain connection, communicate with the DTSX3000 regularly. Item Transmission media Transmission mode Error detection Port number used Number of clients Communication timeout 2.2.2. Modbus Serial Specification Ethernet RTU mode Compliant with TCP/IP error-checking specification 502 * can be changed from the Maintenance web page 5 max. 5 to 1800 seconds The DTSX3000 supports the Modbus slave function. Item Specification Transmission media RS-232C Transmission mode RTU mode or ASCII mode (selectable) Slave address 1 to 247 Port number used COM1 or COM2 (selectable) Baud rate Selectable from 1200, 2400, 4800, 9600, 19200, 38400, 57600 or 115200 bps (selectable) * The COM2 port supports baud rates up to 38400 bps. Data bits 7 or 8 bits. * 8 bits must be specified for RTU transmission mode. Parity None, even or odd Stop bits 1 bit or 2 bits Flow control None, rts/cts or xon/xoff (selectable) Data interval 24-bit time or shorter Error detection CRC-16 (for RTU mode) and LRC (for ASCII mode)
3. Communications Setup 3.1. Modbus/TCP < 3. Communication Setup> 5 This section describes how to set up the DTSX3000 for Modbus/TCP communications. 3.1.1. Settings Setting Port Number 502 or 1024 to 65535 Communication timeout interval 5 to 1800 seconds Setting Range 3.1.2. Setup Procedure 1. Open the web application in Maintenance (Auth) mode. SEE ALSO For details, see Subsection B6.1.3, Operation States and Operation Authority of Chapter B6, System Configuration of the DTSXL Distributed Temperature Sensor Long Range System Guide (IM 39J06B40-01E). 2. Click Application Setting Modbus TCP to display the [Modbus TCP] page.
< 3. Communication Setup> 6 3. Specify the port number for Modbus/TCP communications in [Port Number] and the communication timeout duration in [Comm Timeout]. Select yes for [Port Enable] to enable the port number for Modbus/TCP communications. After you have completed all required settings, click the [Set] button. Clicking the [Initialize] button reverts all settings to their default values, namely, 502 for [Port Number], 600 for [Comm Timeout] and yes for [Port Enable] respectively. 4. When the following page is displayed, click [OK].
< 3. Communication Setup> 7 5. When the following page is displayed, click Operations-Reboot to reboot the system in online mode. SEE ALSO For details, see Subsection B6.1.3, Operation States and Operation Authority of Chapter B6, System Configuration of the DTSXL Distributed Temperature Sensor Long Range System Guide (IM 39J06B40-01E).
3.2. Modbus Serial Communications < 3. Communication Setup> 8 This section describes how to perform setup for Modbus serial communications. 3.2.1. Modbus Communications Related Settings Setting Slave Address 1 to 247 Protocol rtu or ascii SEE ALSO Setting Range For details on serial communications related settings, see Subsection B6.4.8, Serial Port Configuration (Serial) of the DTSXL Distributed Temperature Sensor Long Range System Guide (IM 39J06B40-01E). 3.2.2. Setup Procedure 1. Open the web application in Maintenance (Auth) mode. SEE ALSO For details, see Subsection B6.1.3, Operation States and Operation Authority of Chapter B6, System Configuration of the DTSXL Distributed Temperature Sensor Long Range System Guide (IM 39J06B40-01E). 2. Click Application Setting Modbus Serial to display the Modbus Serial page.
< 3. Communication Setup> 9 3. Specify the [Slave Address] and [Protocol], and then click the [Set] button. To revert these settings to their default values, click the [Initialize] button. This will revert [Slave Address] to 1 and [Protocol] to rtu. 4. When the following page is displayed, click the [OK] button.
< 3. Communication Setup> 10 5. When the following page is displayed, click Operations-Reboot to reboot in online mode. SEE ALSO For details, see Subsection B6.1.3, Operation States and Operation Authority of Chapter B6, System Configuration of the DTSXL Distributed Temperature Sensor Long Range System Guide (IM 39J06B40-01E).
< 4. Modbus Communications Protocol> 11 4. Modbus Communications Protocol 4.1. Overview In a communications system based on the Modbus protocol, the master initiates a transaction and the slave responds to it. The communications protocol is as follows: 1) A master sends a request message to slaves. 2) Each slave compares the device number in the received message to its own device number. 3) If the device numbers match, the slave sends a response message. 4) If the device numbers do not match, the slave discards the received request message and waits for the next request message. By specifying a device number in a request message, a master can communicate with a specific slave even when multiple slaves are connected to the same line. 4.2. Message Structure Each request message or response message comprises four fields, namely a device number, a function code, a data field and an error check code, which are transmitted sequentially in the given order. Modbus defines two serial transmission modes, namely, the RTU mode and the ASCII mode, with different message formats. The ASCII mode permits only data comprising ASCII characters 0-9 and A-F. Device number (1 byte) Function code (1 byte) Data (n bytes) Error check code (CRC) (2 bytes) RTU mode Start (1 character): colon (:) Device number (2 characters) Function code (2 characters) Data (n characters) Error check code (LRC) (2 characters) End (2 characters): CR+LF ASCII mode Each message field is described in more details below. 4.2.1. Device Number The device number specifies a slave. Only the DTSX3000 with a matching device number will process the request message. 4.2.2. Function Code The function code specifies the function to be executed by the slave. SEE ALSO For more details on the function code, see Section 4.4, Function Codes.
< 4. Modbus Communications Protocol> 12 4.2.3. Data The data field contains data required for executing the function defined by the function code. The data structure varies with the function code. Each DTSX3000 setting is assigned a unique register number. To read or write a setting, specify its register number. Register numbers must be specified as relative addresses in transmitted messages. The relative address of a register is given by the formula: Relative address = Last 5 digits of the register number 1 For example, to specify register number 400003 as a parameter for a function code, you should specify relative address 00002 in the message: Relative address = (last 5 digits of 400003) 1 = 0002 4.2.4. Error Check Code The error check code is used for detecting message errors (bit changes), if any, introduced during signal transmission. CRC (Cyclic Redundancy Check) is used in RTU serial transmission mode. LRC (Longitudinal Redundancy Check) is used in ASCII serial transmission mode.
< 4. Modbus Communications Protocol> 13 4.3. Slave Response 4.3.1. Normal Response If no error occurs in relation to the function requested in a properly received request message, the slave creates and returns a normal response message. The message structure is as described in Section 4.2. The content of the data field varies with the function code. SEE ALSO For details on the function code, see Section 4.4, Function Codes. 4.3.2. Exception Response If a request message contains a non-transmission-related error (such as a non-existent function code), the slave creates and returns an error response message without executing the request. The figure below shows the structure of an error response message. In an error response, the function code is 80H higher than the function code of the original request. Device number Function code+80 H Error code Error check code (CRC) RTU mode Start (1 character): colon (:) Device number Function code+80 H Error code Error check code (LRC) End (2 characters): CR+LF ASCII mode The error codes are listed in the table below. Table: Error Codes Error Code Error Description 01 H Invalid function code The specified function code is non-existent. Check the specified function code. 02 H Invalid address for coil or register The specified relative address of a register number is not allowed for the specified function code. 03 H Invalid number of registers The specified number of registers is too large and covers a range containing non-existent register numbers. 4.3.3. No Response A slave ignores a request message and returns no response if: - The device number specified in the request message does not match slave s own device number; - The error check code does not match; or - A transmission error (such as a parity error) is detected.
4.4. Function Codes < 4. Modbus Communications Protocol> 14 In the Modbus protocol, each function code can only act on certain allocated register numbers. The table below shows the mapping between function codes and register numbers for the DTSX3000. Table: Mapping between Function Codes and Addresses Function Code Register Number Number Function Object Number Description 03 H Read (contiguous) Holding registers 4XXXXX Read-write word data 04 H Read (contiguous) Input registers 3XXXXX Read-only word data 06 H Write Holding register 4XXXXX Read-write word data 10 H Write (contiguous) Holding registers 4XXXXX Read-write word data
< 5. Message Description> 15 5. Message Description 5.1. Read Holding Registers 5.1.1. Message Structure Request message structure (bytes) Device number Function code Starting register number (relative address) No. of words to read CRC data 5.1.2. Function Description Hi Lo Hi Lo Hi Lo Response message structure (bytes) Device number Function code No. of bytes read First word data Second word data Last word data CRC data Hi Lo Hi Lo ~ ~ This function is used to read from a remote DTSX3000 contiguous word data starting from a specified starting register number for a specified number of words to read. The DTSX3000 transmits the high order byte of returned word data before the low order byte. 5.1.3. Example of Message Exchange The following example reads the channel 1 settings for repetition rate, measurement time setting mode and averaging times from the DTSX3000 identified by device number 1. Relative address of the register for channel 1 repetition rate setting: 0400 H; data count: 08 H Request message structure (bytes) Response message structure (bytes) Device number Function code Starting register number (relative address) 01 H 03 H 04 H 00 H Device number Function code No. of bytes read Word data 1 01 H 03 H 08 H 00 H 00 H 00 H No. of words to read 00 H 00 H Word data 2 45 H 00 H CRC data 39 H 00 H Word data 3 04 H Hi Lo Hi Lo Word data 4 CRC data 00 H 00 H D4 H 16 H The meaning of the returned data is as follows: Ch1 repetition rate (first word data read) = 00 00 H (normal speed) Ch1 measurement time setting mode (second word data read) = 00 00 H (by averaging times) Ch1 averaging times (last word data read) = 00 04 00 00 H (= 262144)
< 5. Message Description> 16 5.2. Read Input Registers 5.2.1. Message Structure Request message structure (bytes) Device number Function code Starting register number (relative address) No. of words to read CRC data 5.2.2. Function Description Hi Lo Hi Lo Hi Lo Response message structure (bytes) Device number Function code No. of bytes read First word data Second word data Last word data CRC data Hi Lo Hi Lo ~ ~ This function is used to read from a remote DTSX3000 contiguous words of read-only data starting from a specified starting register number for a specified number of words to read. The DTSX3000 transmits the high order byte of returned word data before the low order byte. 5.2.3. Example of Message Exchange The following example reads status information and measurement progress information (Active channel number and progress percentage) from the DTSX3000 identified by device number 1. Relative address of the status information register: 0000 H; Data count: 06 H Hi Lo Hi Lo Request message structure (bytes) Response message structure (bytes) Device number Function code Starting register number (relative address) 01 H 04 H 00 H 00 H Device number Function code No. of bytes read Word data 1 01 H 04 H 06 H 00 H 00 H 01 H No. of words to read 03 H 00 H Word data 2 B0 H 01 H CRC data 0B H 01 H Word data 3 43 H CRC data 4C H F2 H The meaning of the returned data is as follows: Status information (read word data 1) = 00 01 H (measurement in progress) Active channel number (read word data 2) = 00 01 H (Ch1) Channel measurement progress percentage (read word data 3) = 01 43 H (32.3%) SEE ALSO Response messages cannot contain fractional data values so the data value 32.3 in the above example is returned as data value 323 (143H). For details on the handling of the respective data, see Chapter 6, Address Map.
< 5. Message Description> 17 5.3. Write Single Register 5.3.1. Message Structure Request message structure (bytes) Device number Function code Register number (relative address) Word data to write CRC data 5.3.2. Function Description Hi Lo Hi Lo Hi Lo Response message structure (bytes) Device number Function code Register number (relative address) Word data written CRC data This function is used to write one word of data to a specified register number in a remote DTSX3000. The high order byte of the word data to be written must be transmitted to DTSX3000 before the low order byte. 5.3.3. Example of Message Exchange The following example writes the power save mode setting value to the DTSX3000 identified by device number 1. Relative address of the power save mode setting register: 0100 H Power save mode setting value: 0001 H (ON) Request message structure (bytes) Device number Function code 01 H Hi Lo Hi Lo Hi Lo Response message structure (bytes) Device number Function code 01 H Register number (relative address) 01 H 00 H 06 H 01 H 06 H Register number (relative address) 00 H Word data to write 00 H 01 H Word data written 00 H 01 H CRC data 49 H F6 H CRC data 49 H F6 H
< 5. Message Description> 18 5.4. Write Multiple Registers 5.4.1. Message Structure ~ Request message structure (bytes) Device number Function code Starting register number (relative address) No. of words to write No. of bytes to write First word data Second word data Last word data CRC data 5.4.2. Function Description Hi Lo Hi Lo Hi Lo Hi Lo Hi Lo Hi Lo ~ Response message structure (bytes) Device number Function code Starting register number (relative address) No. of words written CRC data This function is used to write to a remote DTSX3000 contiguous word data starting from a specified starting register number for a specified number of words to write. The high order byte of the word data to be written must be transmitted to DTSX3000 before the low order byte. 5.4.3. Example of Message Exchange The following example writes the fiber length of section 1 of channel 1 to the DTSX3000 identified by device number 1. It sets the fiber length to 10000.0 m. Relative address of register for fiber length of section 1 of channel 1: 0802 H; Data count: 02 H Ch1 section 1 fiber length setting value: 00002710 H (=10000 D ) Hi Lo Hi Lo Hi Lo SEE ALSO Request messages cannot contain decimal points so data value 1000.0 in the above example must be transmitted as data value 100000. For details on the handling of the data, see Chapter 6, Address Map. Request message structure (bytes) Device number 01 H Function code 10 H Response message structure (bytes) Device number 01 H Function code 10 H Starting register number (relative address) 08 H 02 H Starting register number (relative address) 08 H 02 H No. of words to write 00 H 02 H No. of words written 00 H 02 H No. of bytes to write Word data 1 04 H 00 H 00 H CRC data E2 H 68 H Word data 2 27 H 10 H CRC data 0F H 8A H
6. Address Map 6.1. Handling of Fractional Data < 6. Address Map > 19 Some DTSX3000 settings allow fractional values but transmission of fractional values in messages is not allowed. In the address map tables in the following pages, a setting parameter allowing fractional values is specified with its fixed number of decimal places. When handling fractional data, calculate its proper value using its fixed number of decimal places as shown in the following examples. Example 1: Reading the fiber length setting for section 1 of channel 1 (register number: 402051) If the DTSX3000 returns a value of 1000 for this parameter, which has 1 decimal place, the fiber length of section 1 of channel 1 is given by: 1000 10 = 100.0 Example 2: Writing the fiber length setting for section 1 of channel (register number: 402051) To set the fiber length of section 1 of channel 1 to 100.0, the value to be written to the DTSX3000 for this parameter, which has 1 decimal place, is given by: 100.0x10 = 1000 6.2. Holding Register Address Map 6.2.1. List of Holding Registers Register Number Function 400001 to 400002 Execution control functions 400017 Data conversion function 400033 Temperature calibration function 400065 Initialization function 400258 to 400286 Measurement sequence control settings 400513 to 400757 Measurement sequence table settings 401025 to 402022 Measurement condition settings 424577 to 424623 Fiber settings Channel settings 424705 to 424754 Alarm settings 424833 to 424858 Sectional data settings 432769 Data conversion function Data conversion function selection 433025 to 433155 Header settings LAS/CSV data conversion 435330 to 435459 Conversion and transmission settings
< 6. Address Map > 20 6.2.2. Description of Holding Registers (1) Execution control functions Relative Address Register Number Data Type 0000 H 400001 Short 0001 H 400002 Short (2) Data conversion function Relative Address Register Number Data Type 0010 H 400017 Short (3) Temperature calculation function Relative Address Register Number 0080 H 400129 Int Data Type Description Measurement execution control Self-diagnosis execution control Description Data conversion execution control Description Reference temperature remote input 0: Stop request ; 1: Start request 0: Stop request ; 1: Start request 0: Stop request ; 1: Start request Write Data Write Data Write Data -27315 to 99999 2 fixed decimal places (-273.15 to 999.99) (4) Other functions Relative Register Data Address Number Type Description Write Data 0090 H 400145 Short Settings initialization 1: Execute request 00A0 H 400161 Short Reboot 1: Execute request 00A1 H 400162 Short Reset reboot Reboot with Initialized 1: Execute request settings and status 00A2 H 400163 Short Shutdown 1: Execute request TIP - For a standard reboot (warm boot), the DTSX3000 starts up in its previous state, with all settings and its running state preserved. For a reset boot (cold boot), the DTSX3000 starts up with all settings initialized, as well as all measurement and data conversion processes terminated. - Data types are representated as follows within this manual. Short : 16-bit signed integer Ushort : 16-bit unsigned integer Int : 32-bit signed integer Uint : 32-bit unsigned integer Char : (8-bit) character Uchar : 8-bit unsigned character
< 6. Address Map > 21 (5) Measurement sequence control settings Relative Register Data Address Number Type Description Read/Write Data No. 0101 H 400258 Short Sequence mode 0: Single; 1: Continuous 1 0102 H 400259 Short Repetition mode 0: Sequence interval; 1: Sequence start time 2 0103 H 400260 Short Sequence start time 0: 1 cycle; 1: every day repetition 3 0104 H 400261 Int Sequence interval 0 to 86400 4 0106 H 400263 Short Use flag of sequence start time 1 0: Off; 1: On 5 0108 H 400265 Short 2 010A H 400267 Short 010C H 400269 Short 2 010E H 400271 Short 0110 H 400273 Short 2 0112 H 400275 Short 0114 H 400277 Short 2 0116 H 400279 Short 0118 H 400281 Short 2 011A H 400283 Short 011C H 400285 TIP Short 2 Sequence start time 1 Use flag of sequence start time 2 Sequence start time 2 Use flag of sequence start time 3 Sequence start time 3 Use flag of sequence start time 4 Sequence start time 4 Use flag of sequence start time 5 Sequence start time 5 Use flag of sequence start time 6 Sequence start time 6 Hour (data 1): 0 to 23 Minute (data 2): 0 to 59 0: Off; 1: On 5 Hour (data 1): 0 to 23 Minute (data 2): 0 to 59 0: Off; 1: On 5 Hour (data 1): 0 to 23 Minute (data 2): 0 to 59 0: Off; 1: On 5 Hour (data 1): 0 to 23 Minute (data 2): 0 to 59 0: Off; 1: On 5 Hour (data 1): 0 to 23 Minute (data 2): 0 to 59 0: Off; 1: On 5 Hour (data 1): 0 to 23 Minute (data 2): 0 to 59 - These parameters cannot be modified during measurement. - The screen capture below maps the measurement condition settings displayed in the DTSX3000 Control Visualization Software to their allocated Modbus registers. The labels shown in the screen capture map to the No. column in the above table. Example: The field labeled as (5)-1 in the screen capture refers to the sequence mode in the above table. 6 6 6 6 6 6
< 6. Address Map > 22 (6) Measurement sequence table settings Relative Register Data Address Number Type Description Read/Write Data No. 0200 H 400513 Short Sequence 1 Use flag 0: Off; 1: On 1 0201 H 400514 Short Sequence 1 Principle 0: Single-end; 1: Double-end 2 0202 H 400515 Short Sequence 1 Channel (Near) 1: Ch1,, 16: Ch16 3 0203 H 400516 Short Sequence 1 Channel (Far) 1: Ch1,, 16: Ch16 4 0204 H 400517 Short Sequence 1 Interval 0 to 3600 5 0210 H 400529 Sequence 2 settings (same data structure as sequence 1) - 0220 H 400545 Sequence 3 settings (same data structure as sequence 1) - 0230 H 400561 Sequence 4 settings (same data structure as sequence 1) - 0240 H 400577 Sequence 5 settings (same data structure as sequence 1) - 0250 H 400593 Sequence 6 settings (same data structure as sequence 1) - 0260 H 400609 Sequence 7 settings (same data structure as sequence 1) - 0270 H 400625 Sequence 8 settings (same data structure as sequence 1) - 0280 H 400641 Sequence 9 settings (same data structure as sequence 1) - 0290 H 400657 Sequence 10 settings (same data structure as sequence 1) - 02A0 H 400673 Sequence 11 settings (same data structure as sequence 1) - 02B0 H 400689 Sequence 12 settings (same data structure as sequence 1) - 02C0 H 400705 Sequence 13 settings (same data structure as sequence 1) - 02D0 H 400721 Sequence 14 settings (same data structure as sequence 1) - 02E0 H 400737 Sequence 15 settings (same data structure as sequence 1) - 02F0 H 400753 Sequence 16 settings (same data structure as sequence 1) - TIP - These parameters cannot be modified during measurement. - The screen capture below maps the sequence table settings displayed in the DTSX3000 Control Visualization Software to their allocated Modbus registers. The labels shown in the screen capture map to the No. column in the above table. Example: The field labeled as (6)-1 in the screen capture refers to the Sequence 1 Use Flag setting in the above table. (6)-2 (6)-3 (6)-4 (6)-1 (6)-5
< 6. Address Map > 23 (7) Channel settings Relative Register Data Address Number Type Description Read/Write Data No. 0400 H 401025 Short Ch1 repetition rate 0: Standard rate; 1: Fast rate 1 0401 H 401026 Short Ch1 measurement time 0: Averaging times; setting mode 1: Duration 2 0402 H 401027 Int Ch1 averaging times 4096 to 268435456 3 0404 H 401029 Int Ch1 measurement time 1 to 86400 4 0406 H 401031 6000: 6 km; 10000: 10 km Ushor Ch1 distance range 16000: 16 km; 20000: 20 km t 30000: 30 km; 50000: 50 km 5 0407 H 401032 Short Ch1 sampling resolution 50: 50cm; 100: 1 m; 200: 2 m 6 0408 H 401033 Short Ch1 fiber failure detection 0: Off; 1: On 7 0 to 999 Ch1 fiber failure threshold 0409 H 401034 Short 1 fixed decimal place 8 level (0.0 to 99.9) 040C H 401037 Int Ch1 switch length 040E H 401039 Int Ch1 well inlet position 0410 H 401041 Int Ch1 Fiber all length 0412 H 401043 Short Ch1 Calculation range 0 to 500000 1 fixed decimal place (0.0 to 50000.0) 0 to 500000 1 fixed decimal place (0.0 to 50000.0) 0 to 500000 1 fixed decimal place (0.0 to 50000.0) 0: All Data; 1: Total Length 2: Range Setting 0413 H 401044 Short Ch1 More alarm sections 0: Off; 1: On 13 Ch1 ST-AS differential loss 0: Measurement; 0414 H 401045 Short setting type for doubleended 14 1: Setting measurement 0416 H 401047 Int 0418 H 401049 Short 0419 H 401050 Short 041A H 401051 Int 041C H 401053 Int 041E H 401055 Short 0420 H 401057 Int Ch1 distance of W to P1 for double-ended measurement Ch1 near end averaging distance for double-ended measurement Ch1 far end distance type for double-ended measurement Ch1 distance of W to P2 for double-ended measurement Ch1 distance of E to P2 for double-ended measurement Ch1 far end averaging distance for double-ended measurement Ch1 Start of calculation range 0422 H 401059 Int Ch1 End of calculation range 0424 H 401061 Int 0426 H 401063 Short 0427 H 401064 Short Ch1 ST-AS differential loss for double-ended measurement Ch1 Use flag for Increased loss alarm Ch1 Increased loss threshold 0 to 500000 1 fixed decimal place (0.0 to 50000.0) 50 to 200 1 fixed decimal place (5.0 to 20.0) 0: W to P2; 1: E to P2 0 to 500000 1 fixed decimal place (0.0 to 50000.0) 0 to 500000 1 fixed decimal place (0.0 to 50000.0) 50 to 200 1 fixed decimal place (5.0 to 20.0) 9 10 11 12 15 16 17 18 19 20 0 to 500000 1 fixed decimal place 21 (0.0 to 50000.0) 0 to 500000 1 fixed decimal place 22 (0.0 to 50000.0) -99999 to 99999 4 fixed decimal places 23 (-9.9999 to 9.9999) 0: Off; 1: On 24-999 to 0 1 fixed decimal places (-99.9 to 0.0) 0440 H 401089 Channel 2 settings (same data structure as channel 1) - 0480 H 401153 Channel 3 settings (same data structure as channel 1) - 04C0 H 401217 Channel 4 settings (same data structure as channel 1) - 0500 H 401281 Channel 5 settings (same data structure as channel 1) - 25
< 6. Address Map > 24 0540 H 401345 Channel 6 settings (same data structure as channel 1) - 0580 H 401409 Channel 7 settings (same data structure as channel 1) - 05C0 H 401473 Channel 8 settings (same data structure as channel 1) - 0600 H 401537 Channel 9 settings (same data structure as channel 1) - 0640 H 401061 Channel 10 settings (same data structure as channel 1) - 0680 H 401665 Channel 11 settings (same data structure as channel 1) - 06C0 H 401729 Channel 12 settings (same data structure as channel 1) - 0700 H 401793 Channel 13 settings (same data structure as channel 1) - 0740 H 401857 Channel 14 settings (same data structure as channel 1) - 0780 H 401921 Channel 15 settings (same data structure as channel 1) - 07C0 H 401985 Channel 16 settings (same data structure as channel 1) - TIP - These parameters cannot be modified during measurement. - Averaging times should be specified as a multiple of 4096. Otherwise, it will be rounded down to the nearest multiple of 4096 with the remainder discarded. - The available distance range options depend on the suffix code. For details, see Section B7.3, Channel Settings of the DTSXL Distributed Temperature Sensor Long Range System Guide (IM39J06B40-01E). - The available sampling resolution options depend on the distance range. For details, see Section B7.3, Channel Settings of the DTSXL Distributed Temperature Sensor Long Range System Guide (IM39J06B40-01E). Moreover, if a specified distance range causes the sampling resolution setting to become invalid, the sampling resolution setting will default to 2 m. - The screen captures below map the channel settings displayed in the DTSX3000 Control Visualization Software to their allocated Modbus registers. The labels shown in the screen captures map to the No. column in the above table. Example: The field labeled as (7)-1 in the screen capture refers to the repetition rate of channel 1. (7)-5 (7)-1 (7)-6 (7)-7 (7)-2 (7)-24 (7)-25 (7)-3 (7)-4 (7)-8
< 6. Address Map > 25 (7)-9 (7)-10 (7)-12 (7)-11 (7)-21 (7)-22 (7)-14 (7)-23 (7)-15 (7)-16 (7)-17 (7)-18 (7)-19 (7)-20 (7)-13
< 6. Address Map > 26 (8) Fiber settings Before specifying the fiber settings, designate the fiber section to be configured by specifying the following channel number specifier and fiber section specifier, which are used for register address mapping. - Configured fiber section specifier Relative Register Data Address Number Type Description Read/Write Data No. 6000 H 424577 Short Channel number specifier 0: Ch1,, 15: Ch16-6001 H 424578 Short Fiber section specifier 0: Section 1,, 19: Section 20 - Next, specify the fiber settings for the fiber section designated by the above channel number specifier and fiber section specifier. - Fiber settings Relative Register Data Address Number Type Description Read/Write Data No. 6010 H 424593 Short Use flag 0: No; 1: Yes 1 6012 H 424595 Int Fiber length 1 to 500000 1 fixed decimal place 2 (0.1 to 50000.0) 6014 H 424597 Int Group index 130000 to 179999 5 fixed decimal places 3 (1.30000 to 1.79999) 6016 H 424599 Int Winding coefficient 1 to 99999 3 fixed decimal places 4 (0.001 to 99.999) 6018 H 424601 Int Loss correction -99999 to 99999 4 fixed decimal places 5 (-9.9999 to 9.9999) 601A H 424603 Short Wavenumber setting mode 0: Default; 1: Setting 6 601C H 424605 Int Wavenumber 1 to 99999 2 fixed decimal places 7 (0.01 to 999.99) 601E H 424607 Short Correction use flag 0: Off; 1: On 8 601F H 424608 Short Linearity 1 to 9999 3 fixed decimal places 9 (0.001 to 9.999) 6020 H 424609 Short Slope -9999 to 9999 3 fixed decimal places 10 (-9.999 to 9.999) 6022 H 424611 Int Offset -27315 to 99999 2 fixed decimal places 11 (-273.15 to 999.99) 6024 H 424613 Short Calibration use flag 0: Off; 1: On 12 6025 H 424614 Short Calibration type 0: Manual input 1: Remote input 13 2: Optical switch 6026 H 424615 Int T1 (thermometer reading) -27315 to 99999 2 fixed decimal places 14 (-273.15 to 999.99) 6028 H 424617 Int T1 (DTS reading) -27315 to 99999 2 fixed decimal places 15 (-273.15 to 999.99) 602A H 424619 Int T1 (DTS reading) position 0 to 500000 1 fixed decimal place (0.0 to 50000.0) 16 602C H 424621 Short 10 to 200 T1 (DTS reading) average 1 fixed decimal place distance (1.0 to 20.0) 17 602D H 424622 Short Noise filter use flag 0: Off; 1: On 18 602E H 424623 Short Noise filter filter length 3,5 19 TIP - These parameters cannot be modified during measurement.
< 6. Address Map > 27 - The screen captures below map the fiber settings displayed in the DTSX3000 Control Visualization Software to their allocated Modbus registers. The labels shown in the screen captures map to the No. column in the above table. Example: The field labeled as (8)-1 in the screen capture refers to the use flag of channel 1 section 1. (8)-1 (8)-2 (8)-3 (8)-5 (8)-4 (8)-12 (8)-8 (8)-9 (8)-18 (8)-19 (8)-10 (8)-11 (8)-13 (8)-6 (8)-14 (8)-15 (8)-7 (8)-17 (8)-16
< 6. Address Map > 28 (9) Alarm settings Before specifying the temperature alarm settings, designate the alarm section to be configured by specifying the following channel number specifier and alarm section specifier, which are used for register address mapping. - Configured alarm section specifier Relative Register Data Address Number Type Description Read/Write Data No. 6080 H 424705 Short Channel number specifier 0: Ch1,, 15: Ch16-6081 H 424706 Short Alarm section specifier 0: Section 1,, 49: Section 50 - Next, specify the alarm settings for the alarm section designated by the above channel number specifier and alarm section specifier. - Alarm settings Relative Register Data Address Number Type Description Read/Write Data No. 6090 H 424721 Short Use flag 0: Off; 1: On 1 6091 H 424722 Short Start depth use flag 0: Off; 1: On 2 6092 H 424723 Int Depth 1 to 500000 1 fixed decimal place 3 (0.1 to 50000.0) 6094 H 424725 Int Start depth 0 to 500000 1 fixed decimal place 4 (0.0 to 50000.0) 6096 H 424727 Short Alarm combination Each setting bit enables (value 1) or disables (value 0) the detection of an associated alarm type as follows: bit0: temperature high alarm bit1: temperature low alarm bit2: temperature rise alarm bit3: temperature fall alarm bit4: temperature difference 5 alarm bit5: delayed temperature high alarm bit6: delayed temperature low alarm bit7: Average temperature difference high limit bit8: Average temperature difference low limit 6097 H 424728 Short Alarm mode Each setting bit selects section average (value 0) or any point (value 1) as the detection mode of an associated alarm type as follows: bit0: temperature high alarm bit1: temperature low alarm bit2: temperature rise alarm 6 bit3: temperature fall alarm bit4: indefinite (not configurable) bit5: delayed temperature high alarm bit6: delayed temperature low alarm 6098 H 424729 Int Temperature high limit -27315 to 99999 2 fixed decimal places 7 (-273.15 to 999.99) 609A H 424731 Int Temperature low limit -27315 to 99999 2 fixed decimal places 8 (-273.15 to 999.99) 609C H 424733 Int Temperature rise limit 0 to 127314 2 fixed decimal places (0.0 to 1273.14) 9
< 6. Address Map > 29 609E H 424735 Short Temperature rise comparison interval 60A0 H 424737 Int Temperature fall limit 60A2 H 424739 Short 60A4 H 424741 Int 60A6 H 424743 Short 60A8 H 424745 Int 60AA H 424747 Short Temperature fall comparison interval Delayed temperature high limit Delayed temperature high alarm delay Delayed temperature low limit Delayed temperature low alarm delay 60AC H 424749 Int Temperature difference limit 60AE H 424751 Int 60B0 H 424753 Int Average temperature difference high limit Average temperature difference low limit 1 to 10 Specify the number of previous measurements from the current measurement for temperature comparison. 0 to 127314 2 fixed decimal places (0.0 to 1273.14) 1 to 10 Specify the number of previous measurements from the current measurement for temperature comparison. -27315 to 99999 2 fixed decimal places (-273.15 to 999.99) Specify the alarm delay as a measurement count from 1 to 10. -27315 to 99999 2 fixed decimal places (-273.15 to 999.99) Specify the alarm delay as a measurement count from 1 to 10. 0 to 127314 2 fixed decimal places (0.0 to 1273.14) 0 to 127314 2 fixed decimal places (0.0 to 1273.14) 0 to 127314 2 fixed decimal places (0.0 to 1273.14) 10 11 12 13 14 15 16 17 18 19 TIP - These parameters cannot be modified during measurement. - The screen captures below map the alarm settings displayed in the DTSX3000 Control Visualization Software to their allocated Modbus registers. The labels shown in the screen captures map to the No. column in the above table. Example: The field labeled as (9)-1 in the screen capture refers to the use (enable) flag of alarm section 1 of channel 1. (9)-3 (9)-2 (9)-1 (9)-4
< 6. Address Map > 30
< 6. Address Map > 31 (10) Sectional data settings Before specifying the sectional data settings, designate the section to be configured by specifying the following channel number specifier and section specifier, which are used for register address mapping. - Configured section specifier Relative Register Data Address Number Type Description Read/Write Data No. 6100 H 424833 Short Channel number specifier 0: Ch1,, 15: Ch16-6101 H 424834 Short Section specifier 0: Section 1,, 9: Section 10 - Next, specify the sectional data for the section designated by the above channel number specifier and section specifier. - Sectional data settings Relative Register Data Address Number Type Description Read/Write Data No. 6110 H 424849 Short Section use flag 0: Off; 1:On 1 6111 H 424850 Short Start depth use flag 0: Off; 1:On 2 6112 H 424851 Int Depth 1 to 300000 1 fixed decimal place 3 (0.1 to 30000.0) 6114 H 424853 Short Data type 0: Average; 1: Maximum; 2: Minimum; 4 3: Difference; 4: Slope 6116 H 424855 Int Unit 1 to 300000 1 fixed decimal place 5 (0.1 to 30000.0) 6118 H 424857 Int Start depth 0 to 300000 1 fixed decimal place (0.0 to 30000.0) 6 TIP - These parameters cannot be modified during measurement. - The screen captures below map the sectional data settings displayed in the DTSX3000 Control Visualization Software to their allocated Modbus registers. The labels shown in the screen captures map to the No. column in the above table. Example: The field labeled as (10)-1 in the screen capture refers to the section use flag of section 1 of channel 1. (10)-1 (10)-5 (10)-4 (10)-3 (10)-2 (10)-6
< 6. Address Map > 32 (11) Data conversion function settings Relative Address Register Number Data Type 8000 H 432769 Short Description Conversion function selection Read/Write Data 0: LAS2.0 100: WITSML1.3.1.1 200: CSV TIP Setting value 100 is not allowed if the WITSML format data conversion function (software option) is not installed on the DTSX3000. (12) Header settings for LAS format conversion Relative Address Register Number Data Type 8100 H 433025 Short Description Channel number for parameter 8101 H 433026 Short Parameter ID 8102 H 433027 Short 129 Parameter value Read/Write Data 0: Ch1,, 15: Ch16 0: Company name 1: Well name 2: Field name 3: Location name 4: Province name 5: County name 6: State name 7: Country name 8: Service company name 9: Unique well ID 10: API number 11: Measurement date/time format 100: Use flag of length along fiber 101: Use flag of measured depth of casing 102: Use flag of DTS temperature 103: Use flag of stokes intensity 104: Use flag of anti-stokes intensity 105: Use flag of province 106: Use flag of unique well ID 107: License number 108: Unit of distance 109: Unit of temperature 110: CFL data output For parameters 0 to 10: Character string (256 characters max.) For parameter 11: Character string (64 characters max.) For parameters 100 to 106: 0: Off; 1: On For parameter 107: 0 to 2147483647 For parameter 108: 0: m; 1: ft; 2: yd; 3: mi For parameter 109: 4: K; 5: degc; 6: degf For parameters 110: 0: Off; 1: On SEE ALSO For details on how to specify the measurement date/time format parameter, see Subsection B8.2.3, Format of Measurement Start Time of the DTSXL Distributed Temperature Sensor Long Range System Guide (IM 39J06B40-01E).
< 6. Address Map > 33 TIP - These parameters cannot be modified during LAS conversion. - Be sure to specify a channel number using register number 433025 and a parameter type using register number 433026 before reading or writing its parameter value using register number 433027. - Only non-control ASCII characters and the null byte (0x00) are allowed. Two-byte coded data is not supported. - When writing a character string parameter, always append a null byte (0x00) at the end of the character string data. Otherwise, the parameter may be improperly set (partially modified or unmodified). - To specify a double-quote ( ) character within character string data, precede it with a backslash (\) escape character. In this case, two bytes are used for the character but the number of allowable characters for the parameter value is not reduced by one. - The screen capture below maps the LAS conversion header fields displayed in the DTSX3000 Control Visualization Software LAS2.0 Data Conversion to their allocated parameters. Each label shown in the screen capture maps to a value for the parameter (register 433026) in the above table. Example: The field labeled as (12)-0 in the screen capture refers to the company name parameter. (12)-0 (12)-1 (12)-2 (12)-3 (12)-105 (12)-4 (12)-5 (12)-6 (12)-7 (12)-8 (12)-11 (12)-106 (12)-9 (12)-10 (12)-107 (12)-104 (12)-103 (12)-102 (12)-108 (12)-110 (12)-100 (12)-101 (12)-109
< 6. Address Map > 34 (13) Conversion and transmission settings for LAS format conversion Relative Address Register Number Data Type 8A01 H 435330 Short Parameter ID 8A02 H 435331 Short 129 Description Parameter value Read/Write Data 0: URI 1: Proxy host name 2: Destination server user ID 3: Destination server password 4: Transmission mode 5: Form data name 6: Conversion file name 100: Transmission enable 101: Transmission method 102: Proxy use flag 103: Proxy port number 104: Deflate flag 105: Conversion format type 106: UTC flag For parameters 0, 1, 2, 3 and 5: Character string (255 characters max.) For parameter 4: LAST, NEW or transmission file name Transmission file name: character string (32 characters max.) For parameter 6: Character string (64 characters max.) For parameters 100, 102 and 104: 0: Off; 1: On For parameter 101: 0: PUT; 1: POST For parameter 103: 1 to 65535 (unsigned short) For parameter 105: 1 to 99 (short) For parameter 106: 0: local time 1: International standard time SEE ALSO For details on how to specify the conversion file name parameter, see Subsection B8.4.2, File Name Structure of the DTSXL Distributed Temperature Sensor Long Range System Guide (IM 39J06B40-01E). TIP - These parameters cannot be modified during LAS conversion. - Be sure to specify a parameter ID using register number 435330 before reading or writing its parameter value using register number 435331. - Reading of the destination server user ID (parameter 2), password (parameter 3) and form data name (parameter 5) is prohibited for security reason. - Only non-control ASCII characters and the null byte (0x00) are allowed. Two-byte coded data is not supported. - When writing a character string parameter, always append a null byte (0x00) at the end of the character string data. Otherwise, the parameter may be improperly set (partially modified or unmodified). - To specify a double-quote ( ) character within character string data, precede it with a backslash (\) escape character. In this case, two bytes are used for the character but the number of allowable characters for the parameter value is not reduced by one.
< 6. Address Map > 35 - For the URI parameter, characters other than reserved characters and unreserved characters defined in RFC2396 and the # character must be encoded as URI escape characters. The table below lists the characters that must be escaped with their escape characters. Escape characters Characters (URI encoding) space %20 " %22 % %25 < %3C > %3E [ %5B \ %5C ] %5D ^ %5E ` %60 { %7B %7C } %7D The pound (#) character is used as a delimiter character for URI references and fragment identifiers. Only one # character can be specified in a URI. For details on fragment identifier, see the RFC2396. - The screen capture below maps the LAS conversion transmission settings displayed in the DTSX3000 Control Visualization Software LAS2.0 Data Conversion to their associated parameters. Each label shown in the screen captures maps to a value for the parameter ID(register 435330) in the above table. Example: The field labeled as (13)-0 in the screen capture refers to the URI parameter. (13)-100 (13)-0 (13)-101 (13)-104 (13)-102 (13)-1 (13)-103 (13)-105 (13)-106 (13)-6
< 6. Address Map > 36 (13)-2 (13)-3 (13)-5 (13)-4
< 6. Address Map > 37 (14) Header settings for CSV format conversion Relative Address Register Number Data Type 8100 H 433025 Short Description Channel number for parameter 8101 H 433026 Short Parameter ID 8102 H 433027 Short 129 Parameter value Read/Write Data 0: Ch1,, 15: Ch16 0: Company name 1: Well name 2: Field name 3: Location name 4: Province name 5: County name 6: State name 7: Country name 8: Service company name 9: Unique well ID 10: API number 11: Measurement date/time format 100: Use flag of length along fiber 101: Use flag of measured depth of casing 102: Use flag of DTS temperature 103: Use flag of stokes intensity 104: Use flag of anti-stokes Intensity 105: CFL data output 106: Use flag of company name 107: Use flag of well name 108: Use flag of field name 109: Use flag of location name 110: Use flag of province name 111: Use flag of county name 112: Use flag of state name 113: Use flag of country name 114: Use flag of service company name 115: Use flag of unique well ID 116: Use flag of API number 117: Use flag of license number 118: Use flag of measurement date/time 119: License number 120: Unit of distance 121: Unit of temperature For parameters 0 to 10: Character string (256 characters max.) For parameter 11: Character string (64 characters max.) For parameters 100 to 118: 0: Off; 1: On For parameter 119: 0 to 2147483647 For parameter 120: 0: m; 1: ft; 2: yd; 3: mi For parameter 121: 4: K; 5: degc; 6: degf SEE ALSO For details on how to specify the measurement date/time format parameter, see Subsection B8.2.3, Format of Measurement Start Time of the DTSXL Distributed Temperature Sensor Long Range System Guide (IM 39J06B40-01E).
< 6. Address Map > 38 TIP - These parameters cannot be modified during CSV conversion. - Be sure to specify a channel number using register number 433025 and a parameter type using register number 433026 before reading or writing its parameter value using register number 433027. - Only non-control ASCII characters and the null byte (0x00) are allowed. Two-byte coded data is not supported. - When writing a character string parameter, always append a null byte (0x00) at the end of the character string data. Otherwise, the parameter may be improperly set (partially modified or unmodified). - To specify a double-quote ( ) character within character string data, precede it with a backslash (\) escape character. In this case, two bytes are used for the character but the number of allowable characters for the parameter value is not reduced by one. - The screen capture below maps the CSV conversion header fields displayed in the DTSX3000 Control Visualization Software LAS2.0 Data Conversion to their allocated parameters. Each label shown in the screen capture maps to a value for the parameter (register 433026) in the above table. Example: The field labeled as (14)-0 in the screen capture refers to the company name parameter. (14)-106 (14)-107 (14)-108 (14)-109 (14)-110 (14)-111 (14)-112 (14)-113 (14)-114 (14)-118 (14)-115 (14)-116 (14)-117 (14)-0 (14)-1 (14)-2 (14)-3 (14)-4 (14)-5 (14)-6 (14)-7 (14)-8 (14)-11 (14)-9 (14)-10 (14)-119 (14)-105 (14)-104 (14)-102 (14)-103 (14)-100 (14)-101 (14)-121 (12)-120
< 6. Address Map > 39 (15) Conversion and transmission settings for CSV format conversion Relative Address Register Number Data Type 8A01 H 435330 Short Parameter ID 8A02 H 435331 Short 129 Description Parameter value Read/Write Data 0: URI 1: Proxy host name 2: Destination server user ID 3: Destination server password 4: Transmission mode 5: Form data name 6: Conversion file name 100: Transmission enable 101: Transmission method 102: Proxy use flag 103: Proxy port number 104: Deflate flag 105: Conversion format type 106: UTC flag For parameters 0, 1, 2, 3 and 5: Character string (255 characters max.) For parameter 4: LAST, NEW or transmission file name Transmission file name: character string (32 characters max.) For parameter 6: Character string (64 characters max.) For parameters 100, 102 and 104: 0: Off; 1: On For parameter 101: 0: PUT; 1: POST For parameter 103: 1 to 65535 (unsigned short) For parameter 105: 1 to 99 (short) For parameter 106: 0: local time 1: International standard time SEE ALSO For details on how to specify the conversion file name parameter, see Subsection B8.4.2, File Name Structure of the DTSX3000 Guide (IM 39J06B40-01E). TIP - These parameters cannot be modified during CSV conversion. - Be sure to specify a parameter ID using register number 435330 before reading or writing its parameter value using register number 435331. - Reading of the destination server user ID (parameter 2), password (parameter 3) and form data name (parameter 5) is prohibited for security reason. - Only non-control ASCII characters and the null byte (0x00) are allowed. Two-byte coded data is not supported. - When writing a character string parameter, always append a null byte (0x00) at the end of the character string data. Otherwise, the parameter may be improperly set (partially modified or unmodified). - To specify a double-quote ( ) character within character string data, precede it with a backslash (\) escape character. In this case, two bytes are used for the character but the number of allowable characters for the parameter value is not reduced by one.
< 6. Address Map > 40 - For the URI parameter, characters other than reserved characters and unreserved characters defined in RFC2396 and the # character must be encoded as URI escape characters. The table below lists the characters that must be escaped with their escape characters. Escape characters Characters (URI encoding) space %20 " %22 % %25 < %3C > %3E [ %5B \ %5C ] %5D ^ %5E ` %60 { %7B %7C } %7D The pound (#) character is used as a delimiter character for URI references and fragment identifiers. Only one # character can be specified in a URI. For details on fragment identifier, see the RFC2396. - The screen capture below maps the CSV conversion transmission settings displayed in the DTSX3000 Control Visualization Software LAS2.0 Data Conversion to their associated parameters. Each label shown in the screen captures maps to a value for the parameter ID(register 435330) in the above table. Example: The field labeled as (15)-0 in the screen capture refers to the URI parameter. (15)-100 (15)-0 (15)-101 (15)-104 (15)-102 (15)-1 (15)-103 (15)-105 (15)-106 (15)-6
< 6. Address Map > 41 (15)-2 (15)-3 (15)-5 (15)-4
6.3. Input Register Address Map 6.3.1. List of Input Registers < 6. Address Map > 42 Register Number Function 300001 to 300008 DTS status information 300033 to 300039 LAS data conversion information 300065 to 300071 CSV data conversion information 300257 to 300278 Maintenance information 300513 to 300581 Product information 300991 to 300992 Measurement data information 301000 Channel number for the latest measurement data 301001 to 301400 Sectional data monitoring area for the latest measurement 301401 to 301600 Alarm information monitoring area for the latest measurement 302001 to 302400 Ch1 sectional data monitoring area 302401 to 302600 Ch1 alarm information monitoring area 303001 to 303400 Ch2 sectional data monitoring area 303401 to 303600 Ch2 alarm information monitoring area 304001 to 304400 Ch3 sectional data monitoring area 304401 to 304600 Ch3 alarm information monitoring area 305001 to 305400 Ch4 sectional data monitoring area 305401 to 305600 Ch4 alarm information monitoring area 306001 to 306400 Ch5 sectional data monitoring area 306401 to 306600 Ch5 alarm information monitoring area 307001 to 307400 Ch6 sectional data monitoring area 307401 to 307600 Ch6 alarm information monitoring area 308001 to 308400 Ch7 sectional data monitoring area 308401 to 308600 Ch7 alarm information monitoring area 309001 to 309400 Ch8 sectional data monitoring area 309401 to 309600 Ch8 alarm information monitoring area 310001 to 310400 Ch9 sectional data monitoring area 310401 to 310600 Ch9 alarm information monitoring area 311001 to 311400 Ch10 sectional data monitoring area 311401 to 311600 Ch10 alarm information monitoring area 312001 to 312400 Ch11 sectional data monitoring area 312401 to 312600 Ch11 alarm information monitoring area 313001 to 313400 Ch12 sectional data monitoring area 313401 to 313600 Ch12 alarm information monitoring area 314001 to 314400 Ch13 sectional data monitoring area 314401 to 314600 Ch13 alarm information monitoring area 315001 to 315400 Ch14 sectional data monitoring area 315401 to 315600 Ch14 alarm information monitoring area 316001 to 316400 Ch15 sectional data monitoring area 316401 to 316600 Ch15 alarm information monitoring area 317001 to 317400 Ch16 sectional data monitoring area 317401 to 317600 Ch16 alarm information monitoring area 318001 to 319600 Alarm log 320001 to 320032 Fiber failure location information
6.3.2. Description of Input Registers (1) DTSX3000 status information Relative Address Register Number Data Type Description 0000 H 300001 Short DTS status register < 6. Address Map > 43 0001 H 300002 Short Active channel number 1 to 16 0002 H 300003 Short Channel measurement progress percentage 0003 H 300004 Short Active sequence number 1 to 16 0004 H 300005 Short Sequence measurement progress percentage 0006 H 300007 Uint Measurement count 1 to 4294967295 Read Data Each bit of the register indicates a DTS status aspect as follows: bit0: Measurement in progress 0: No; 1: Yes bit1: Self-testing 0: No; 1: Yes bit2: Fiber failure detected 0: No; 1: Yes bit3: Failure detected 0: No; 1: Yes bit4: Converting WITSML data 0: No; 1: Yes bit5: Converting LAS data 0: No; 1: Yes bit6: Initializing 0: No; 1: Yes bit7: HTTP communication error detected 0: No; 1: Yes bit8: HTTP communication warning detected 0: No; 1: Yes bit9: Converting CSV data 0: No; 1: Yes 0 to 1000 1 fixed decimal place (0.0 to 100.0) 0 to 1000 1 fixed decimal place (0.0 to 100.0) (2) LAS data conversion progress information Relative Address Register Number 0020 H 300033 Int 0022 H 300035 Int 0024 H 300037 Int Data Type Description LAS conversion transmission rate LAS conversion number of files to be sent LAS conversion number of files sent 0026 H 300039 Short HTTP transmission result Read Data 0 to 2147483647 (Unit: bytes per second) 0 to 2147483647 0 to 2147483647 This indicates the result of transmission of converted LAS files to a specified server. 0: Transmission succeeded 1: Transmission failed 2: Server or proxy name search failed 3: User authentication by server failed 4: User authentication by prox failed 5: Connection to server failed 6: Connection timed out 7: Setting error 8: Request to resend 19: Invalid URI
< 6. Address Map > 44 (3) CSV data conversion progress information Relative Address Register Number 0040 H 300065 Int 0042 H 300067 Int 0044 H 300069 Int Data Type Description CSV conversion transmission rate CSV conversion number of files to be sent CSV conversion number of files sent 0046 H 300071 Short HTTP transmission result Read Data 0 to 2147483647 (Unit: bytes per second) 0 to 2147483647 0 to 2147483647 This indicates the result of transmission of converted CSV files to a specified server. 0: Transmission succeeded 1: Transmission failed 2: Server or proxy name search failed 3: User authentication by server failed 4: User authentication by prox failed 5: Connection to server failed 6: Connection timed out 7: Setting error 8: Request to resend 19: Invalid URI (4) DTSX3000 maintenance information Relative Register Data Address Number Type Description Read Data 0100 H 300257 Short Result of self-test 0: OK; 1: NG 0102 H 300259 Char 16 Software version reading Character string (16 bytes) 010A H 300267 Uint Total power-on time 0 to 4294967295 010C H 300269 Uint CPU failure information 0: No error; Non-zero: error detected Each bit of the register indicates the presence (value 1) or absence (value 0) of an exception condition as follows: bit0: PLL status error bit1: DTS clock status error bit2: FPGA version error bit3: ADF board version error bit4: DTS interrupt line error bit5: ADC status error bit6: ADC reference voltage error bit7: Reference temperature status error bit8: DAC Set voltage error bit9: Analog power voltage error bit10: LD temperature error bit11: LD temperature control 010E H 300271 Uint bit13: Photoreceiver APD temperature error bit14: Photoreceiver APD bias voltage error bit15: Not used as failure information bit16: Photoreceiver amplifier setup error bit17: Photoreceiver ADC data error bit18: Photoreceiver ADC overflow bit19: Measurement start/stop error bit20: Reference temperature data error bit21: Transmitter circuit failure bit22: Photoreceiver circuit ST failure bit23: Photoreceiver circuit AS DTS hardware failure current error information bit12: LD drive current error
< 6. Address Map > 45 0110 H 300273 Ushor t Optical switch failure information 0112 H 300275 Uint Fiber failure information 0114 H 300277 Uint Alarm detected status 0116 H 300279 Uint Increased loss information failure bit24: Excitation LD drive current error bit25: Light amplifier ASE level current error Each bit of the register indicates the presence (value 1) or absence (value 0) of an exception condition as follows: bit0: Optical switch interrupt line error bit1: Optical switch communication error bit2: Optical switch standby failure bit3: Optical switch internal temperature error bit4: Optical switch drive current error bit5: Optical switch channel setup error bit6: Optical switch origin error bit7: Optical switch ROM check error bit8: Optical switch communication error bit9: Optical switch response timeout bit10: Optical switch response error bit30: The counter of optical switch channel switching exceed Each bit of the register indicates the presence (value 1) or absence (value 0) of fiber failure as follows: bit0: Ch1 fiber failure bit1: Ch2 fiber failure bit2: Ch3 fiber failure bit3: Ch4 fiber failure bit4: Ch5 fiber failure bit5: Ch6 fiber failure bit6: Ch7 fiber failure bit7: Ch8 fiber failure bit8: Ch9 fiber failure bit9: Ch10 fiber failure bit10: Ch11 fiber failure bit11: Ch12 fiber failure bit12: Ch13 fiber failure bit13: Ch14 fiber failure bit14: Ch15 fiber failure bit15: Ch16 fiber failure Each bit of the register indicates the presence (value 1) or absence (value 0) of an alarm condition as follows: bit0: Ch1 alarm detected bit1: Ch2 alarm detected bit2: Ch3 alarm detected bit3: Ch4 alarm detected bit4: Ch5 alarm detected bit5: Ch6 alarm detected bit6: Ch7 alarm detected bit7: Ch8 alarm detected bit8: Ch9 alarm detected bit9: Ch10 alarm detected bit10: Ch11 alarm detected bit11: Ch12 alarm detected bit12: Ch13 alarm detected bit13: Ch14 alarm detected bit14: Ch15 alarm detected bit15: Ch16 alarm detected Each bit of the register indicates the presence (value 1) or absence (value 0) of increased loss as follows:
< 6. Address Map > 46 bit0: Ch1 increased loss bit1: Ch2 increased loss bit2: Ch3 increased loss bit3: Ch4 increased loss bit4: Ch5 increased loss bit5: Ch6 increased loss bit6: Ch7 increased loss bit7: Ch8 increased loss bit8: Ch9 increased loss bit9: Ch10 increased loss bit10: Ch11 increased loss bit11: Ch12 increased loss bit12: Ch13 increased loss bit13: Ch14 increased loss bit14: Ch15 increased loss bit15: Ch16 increased loss (5) DTSX3000 product information Relative Address Register Number Data Type 0200 H 300513 Char 32 0210 H 300529 Char 16 0218 H 300537 Char 16 0220 H 300545 Char 16 0228 H 300553 Uchar 6 022C H 300557 Char 16 0234 H 300565 Char 16 023C H 300573 Char 16 0244 H 300581 Short Model FPGA version Description Hardware version Serial number MAC address Model of optical switch Serial number of optical switch FPGA version of optical switch Number of channels for optical switch Read Data Character string (32 characters max.) Character string (16 characters max.) Character string (16 characters max.) Character string (16 characters max.) 0 to 0xFF 6 bytes Character string (16 characters max.) Character string (16 characters max.) Character string (16 characters max.) 1, 2, 4 or 16 TIP The number of channels for the optical switch varies with the installed optical switch model.
< 6. Address Map > 47 (6) Measurement data - Measurement data information Relative Address Register Number Data Type 03DE H 300991 Short 03DF H 300992 Short Description Number of decimal places for sectional data Number of decimal places for alarm depth 0 to 9 0 to 9 Read Data - Latest measurement data Relative Address Register Number Data Type Description 03E7 H 301000 Short Channel number of latest measurement data 03E8 H 301001 Int Sectional data 1 03E9 H 301003 Int Sectional data 2......... 0574 H 301397 Int Sectional data 199 0576 H 301399 Int Sectional data 200 0578 H 301401 Int Section 1 alarm info 057A H 301403 Int Section 1 alarm depth 057C H 301405 Int Section 2 alarm info 057E H 301407 Int Section 2 alarm depth......... 0638 H 301593 Int Section 49 alarm info 063A H 301595 Int Section 49 alarm depth 063C H 301597 Int Section 50 alarm info 063E H 301599 Int Section 50 alarm depth Read Data 1 to 16 Sectional data 1for the latest measurement data Sectional data 2 for the latest measurement data Sectional data 199 for the latest measurement data Sectional data 200 for the latest measurement data Section 1 alarm info for the latest measurement data Section 1 alarm depth for the latest measurement data Section 2 alarm info for the latest measurement data Section 2 alarm depth for the latest measurement data Section 49 alarm info for the latest measurement data Section 49 alarm depth for the latest measurement data Section 50 alarm info for the latest measurement data Section 50 alarm depth for the latest measurement data
< 6. Address Map > 48 - Measurement data monitoring area Relative Address Register Number Data Type Description 07D0 H 302001 Int Ch1 sectional data 1 07D2 H 302003 Int Ch1 sectional data 2......... 095C H 302397 Int Ch1 sectional data 199 095E H 302399 Int Ch1 sectional data 200 0960 H 302401 Int Ch1 section 1 alarm info 0962 H 302403 Int Ch1 section 1 alarm depth 0964 H 302405 Int Ch1 section 2 alarm info 0966 H 302407 Int Ch1 section 2 alarm depth......... Read Data Sectional data 1 for measurement data of ch1 Sectional data 2 for measurement data of ch1 Sectional data 199 for measurement data of ch1 Sectional data 200 for measurement data of ch1 Section 1 alarm info for measurement data of ch1 Section 1 alarm depth for measurement data of ch1 Section 2 alarm info for measurement data of ch1 Section 2 alarm depth for measurement data of ch1 0A20 H 302593 Int Ch1 section 49 alarm info Section 49 alarm info for measurement data of ch1 0A22 H 302595 Int Ch1 section 49 alarm depth Section 49 alarm depth for measurement data of ch1 0A24 H 302597 Int Ch1 section 50 alarm info Section 50 alarm info for measurement data of ch1 0A26 H 302599 Int Ch1 section 50 alarm depth Section 50 alarm depth for measurement data of ch1 0BB8 H 303001 Ch2 measurement data (same data structure as Ch1 measurement data) 0FA0 H 304001 Ch3 measurement data (same data structure as Ch1 measurement data) 1388 H 305001 Ch4 measurement data (same data structure as Ch1 measurement data) 1770 H 306001 Ch5 measurement data (same data structure as Ch1 measurement data) 1B58 H 307001 Ch6 measurement data (same data structure as Ch1 measurement data) 1F40 H 308001 Ch7 measurement data (same data structure as Ch1 measurement data) 2328 H 309001 Ch8 measurement data (same data structure as Ch1 measurement data) 2710 H 310001 Ch9 measurement data (same data structure as Ch1 measurement data) 2AF8 H 311001 Ch10 measurement data (same data structure as Ch1 measurement data) 2EE0 H 312001 Ch11 measurement data (same data structure as Ch1 measurement data) 32C8 H 313001 Ch12 measurement data (same data structure as Ch1 measurement data) 36B0 H 314001 Ch13 measurement data (same data structure as Ch1 measurement data) 3A98 H 315001 Ch14 measurement data (same data structure as Ch1 measurement data) 3E80 H 316001 Ch15 measurement data (same data structure as Ch1 measurement data) 4268 H 317001 Ch16 measurement data (same data structure as Ch1 measurement data) SEE ALSO - For details on sectional data, read Chapter B10, Sectional Data Generation of the DTSXL Distributed Temperature Sensor Long Range System Guide (IM 39J06B40-01E). - For details on alarm data, read Chapter B9, Alarm Detection of the DTSXL Distributed Temperature Sensor Long Range System Guide (IM 39J06B40-01E). TIP - These are read-only registers, which can be read but not written. - Registers for the latest measurement data are updated with the measurement result at the end of each measurement so that the latest measurement data is constantly available. - Measurement data registers for each channel are updated at the end of each measurement for the corresponding channel.
< 6. Address Map > 49 - The figure below shows the data structure of measurement data. Structure of Measurement Data Ch1 sectional data group Ch1 alarm info data group Ch2 sectional data group Ch2 alarm info data group Ch16 sectional data group Ch16 alarm info data group Ch1 sectional data 1 Ch1 sectional data 2 Ch1 sectional data 3 Ch1 sectional data 200 Ch1 section 1 alarm info Ch1 section 1 alarm depth Ch1 section 2 alarm info Ch1 section 2 alarm depth Ch1 section 50 alarm info Ch1 section 50 alarm depth Each sectional data group stores sectional data for 200 sections of a channel. The sectional data content depends on the following parameters: - Start depth - Depth - Data type (Maximum, minimum, average, difference, slope) Sectional data of the corresponding channel is updated at the end of each measurement. Each alarm info data group stores alarm info and alarm depth data for 50 sections of a channel. Alarm info contains bit data indicating the presence (value 1) or absence (value 0) of each alarm type as shown below. Alarm depth stores the depth (in metres) of the first alarm detected within a section. bit32 bit0 Temperature high alarm detected Temperature low alarm detected Temperature rise alarm detected Temperature fall alarm detected Temperature difference alarm detected Delay temperature high alarm detected Delay temperature low alarm detected Average temperature difference high alarm detected Average temperature difference low alarm detected - Handling of sectional data and alarm depth data: Sectional data and alarm depth data are fixed point data with their number of decimal places stored in register 300991 and register 300992 respectively. The actual value is given by: Register value 10^(Number of decimal places)
< 6. Address Map > 50 (7) Alarm log Alarm log maintains alarm information for up to 10 detected temperature alarms for each channel. Alarm log data is updated whenever a different alarm type is detected. After ten updates, the oldest alarm information is removed, and new alarm information is stored as the tenth alarm log information. Relative Address Register Number Data Type Description Read Data 4650 H 318001 Int Ch1 alarm type Bit data indicating the presence (value 1) or absence (1) of each of the following alarm types: bit0:temperature high alarm detected bit1: Temperature low alarm detected bit2: Temperature rise alarm detected bit3: Temperature fall alarm detected bit4: Temperature difference alarm detected bit5: Delay temperature high alarm detected bit6: Delay temperature low alarm detected bit7: Average temperature difference Ch1 alarm info 1 high alarm detected bit8: Average temperature difference low alarm detected 4652 H 318003 Int Ch1 alarm depth 4654 H 318005 Short Ch1 alarm time (year) 4-digit, Western calendar 4655 H 318006 Short Ch1 alarm time (month) 1 to 12 4656 H 318007 Short Ch1 alarm time (date) 1 to 31 4657 H 318008 Short Ch1 alarm time (hour) 0 to 23 4658 H 318009 Short Ch1 alarm time (minute) 4659 H 318010 Short 465A H 318011 Ch1 alarm info 2 4664 H 318021 Ch1 alarm info 3 466E H 318031 Ch1 alarm info 4 4678 H 318041 Ch1 alarm info 5 4682 H 318051 Ch1 alarm info 6 468C H 318061 Ch1 alarm info 7 4696 H 318071 Ch1 alarm info 8 46A0 H 318081 Ch1 alarm info 9 46AA H 318091 Ch1 alarm info 10 46B4 H 318101 Ch2 alarm info 1 to 10 4718 H 318201 Ch3 alarm info 1 to 10 477C H 318301 Ch4 alarm info 1 to 10 47E0 H 318401 Ch5 alarm info 1 to 10 4844 H 318501 Ch6 alarm info 1 to 10 48A8 H 318601 Ch7 alarm info 1 to 10 490C H 318701 Ch8 alarm info 1 to 10 4970 H 318801 Ch9 alarm info 1 to 10 49D4 H 318901 Ch10 alarm info 1 to 10 4A38 H 319001 Ch11 alarm info 1 to 10 4A9C H 319101 Ch12 alarm info 1 to 10 4B00 H 319201 Ch13 alarm info 1 to 10 4B64 H 319301 Ch14 alarm info 1 to 10 4BC8 H 319401 Ch15 alarm info 1 to 10 4C2C H 319501 Ch16 alarm info 1 to 10 0 to 59 Ch1 alarm time (second) 0 to 59
< 6. Address Map > 51 TIP - Alarm depth stores the depth (in metres) of the first temperature alar m detected within a specified section. - Alarm log is initialized to all zeros at the start of measurement. (8) Fiber failure location information Fiber failure location information stores the location (represented as actual distance in meters) of the fiber failure detected for a measurement channel. Relative Address Register Number Data Type Description 4E20 H 320001 Int Ch1 fiber failure location 4E22 H 320003 Ch2 fiber failure location 4E24 H 320005 Ch3 fiber failure location 4E26 H 320007 Ch4 fiber failure location 4E28 H 320009 Ch5 fiber failure location 4E2A H 320011 Ch6 fiber failure location 4E2C H 320013 Ch7 fiber failure location 4E2E H 320015 Ch8 fiber failure location 4E30 H 320017 Ch9 fiber failure location 4E32 H 320019 Ch10 fiber failure location 4E34 H 320021 Ch11 fiber failure location 4E36 H 320023 Ch12 fiber failure location 4E38 H 320025 Ch13 fiber failure location 4E3A H 320027 Ch14 fiber failure location 4E3C H 320029 Ch15 fiber failure location 4E3E H 320031 Ch16 fiber failure location Read Data 0 to 5000000 2 fixed decimal places (0.00 to 50000.00)
Blank Page
< 7. Measurement Data Monitoring Function > 53 7. Measurement Data Monitoring Function 7.1. Functional Overview The DTSX3000 supports the Measurement Data Monitoring function using Modbus (Modbus/TCP) communications. The measurement data monitoring function enables measurement data to be read using Modbus registers (called measurement data registers hereinafter). This function has the following features: - 16 sets of measurement data registers are provided. - Access can be switched between the 16 sets of measurement data registers by specifying the required Unit ID value in a Modbus/TCP message. - Addresses for each set of measurement data registers can be defined using a register structure definition file (csv file). Moreover, the measurement data monitoring function is enabled when register structure definition files are present in the DTSX3000 unit.
< 7. Measurement Data Monitoring Function > 54 7.2. Specifications 7.2.1. Measurement Data Monitoring Function The Measurement Data Monitoring function is enabled when one or more register structure definition files exist in the /mnt/intl/setup directory on the DTSX3000 unit. Remove register structure definition files if you are not using the measurement data monitoring function. This function supports the Modus/TCP protocol only. SEE ALSO For details on how to enable the measurement data monitoring function, see Section 7.4.1, Enabling Measurement Data Monitoring Function. 7.2.2. Accessing Modbus Registers When the measurement data monitoring function is enabled, the DTSX3000 supports the following holding registers: - 16 sets of measurement data registers (holding registers) - 1 set of registers for reading and writing measurement condition settings (holding registers) The DTSX3000 associates a Unit ID value with each set of holding registers to allow access to multiple holding registers. You can switch between sets of holding registers to be accessed by specifying the corresponding unit ID value in a Modbus/TCP message. The table below lists the holding registers associated with Unit IDs. Unit ID Holding Registers 1 to 16 16 sets of measurement data registers 17 to 247 One set of registers for writing/reading the measurement condition 0 and 248 to 255 (ignored)
7.2.3. Measurement Data Registers General Specifications < 7. Measurement Data Monitoring Function > 55 Item Specification Register type Holding registers Number of sets 16 Size 128 Kbytes (register number 1 to 65536) Supported Unit IDs 1 to 16 Address definition User-configurable using dedicated register structure definition files Limitations Only the Read function is supported Measurement Data Monitoring Items The following measurement data items can be monitored. Item Channel number Number of fixed decimal places Measurement end time Number of valid measurement data values Measurement data Distance data Signal Level Data CFL data Specification The specified measurement channel number Data range: 1 to 16 (for Ch1 to Ch16). Signed 16-bit integer. This value is currently always 1 so all measurement data contain one fixed decimal place. Signed 16-bit integer. Time when measurement ended 6 signed 16-bit integers with the following data structure: Year: 4-digit year in Gregorian calendar (19xx to 20xx) Month: 1 to 12 Date: 1 to 31 Hour: 0 to 23 Minute: 0 to 59 Second: 0 to 59 Number of valid measurement data values Signed 32-bit integer. (Temperature) measurement data. Unsigned16-bit integer data in Kelvin (K) units The data contains one fixed decimal place so the actual measured (temperature) value is the returned value divided by 10. Distance data Signed 32-bit integer data in metre (m) units The data contains 2 fixed decimal places so the actual measured distance value is the returned value divided by 100. Stokes and Anti-Stokes intensity ratio data. Signed 32-bit integer data in db units. The data contains 6 fixed decimal places so the actual signal level data value is the returned value divided by 1000000. CFL (Calculated Fiber Loss) Signed 32-bit integer data in db units. The data contains 6 fixed decimal places so the actual CFL data value is the returned value divided by 1000000.
< 7. Measurement Data Monitoring Function > 56 When is Measurement Data Updated? All measurement data registers are initialized to zero values at power on. Measurement data stored in measurement data registers are updated at the end of measurement. The last measured value is preserved until the end of the next measurement, even if the measurement is stopped halfway and restarted. Precaution If measurement data is stored to all measurement data registers, consecutive retrievals of 1 to 125 data each time are required to retrieve all measurement data. As these operations take time, there is a risk that measurement data may be updated while a retrieval is still under way if the measurement interval is too short. To avoid this, you may need to adopt control measures (such as allowing ample measurement interval or performing single measurements) at the Modbus/TCP client side which is retrieving measurement data.
< 7. Measurement Data Monitoring Function > 57 7.2.4. Holding Registers for Writing and Reading Measurement Condition Only one set of holding registers for writing and reading measurement condition is provided. This set of registers can be accessed by specifying any value between 17 to 247 for the Unit ID in a Modbus/TCP message after enabling the measurement data monitoring function. The addresses for this set of registers cannot be defined by a user using a register structure definition file. SEE ALSO For details on the holding registers for writing and reading measurement condition, see Section 6.2, Holding Register Address Map. 7.2.5. Input Registers for Reading Status Only one set of input registers is provided for reading status information. Access to this set of registers is independent of the value of the Unit ID in a Modbus/TCP message. SEE ALSO For details on the input registers for reading status, see Section 6.3, Input Register Address Map. 7.2.6. Maximum Number of Connected Modbus/TCP clients Up to 5 clients can be connected concurrently when the measurement data monitoring function is enabled. SEE ALSO For details on Modbus/TCP communications, see Section 2.2, Modbus Communications Protocol Specifications.
< 7. Measurement Data Monitoring Function > 58 7.3. Register Structure Definition File 7.3.1. File Name You can define the address allocations for the measurement data registers for each Unit ID value using a register structure definition file (csv file). Register structure definition files must be assigned filenames of the form: UIDxx.csv where xx denotes the Unit ID (01 to 16) For example, the register structure definition file for measurement data registers for Unit ID 2 should be named "UID02.csv". 7.3.2. File Content A register structure definition file is to be coded with definition statements, which define the address allocations of measurement data registers. Register Structure Definition Statements Comment text definition Syntax: # Comment text Description: A line that begins with a # character is treated as a comment line. Measurement channel number definition Syntax: Ch<x>_ChNo,<register> <x>: channel number (1 to 16) <register>: register number (400001 to 465536) Description: To store the specified channel number <x> in register number <register>. Example: To store channel number 1 in register number 400001, specify: Ch1_ChNo,400001 Definition for number of fixed decimal places in measurement data Syntax: Temp_DecPlaces,<register> <register>: register number (400001 to 465536) Description: To store the number of fixed decimal places of temperature data in register number <register>. Example: To store the number of fixed decimal places of temperature data in register number 400002, specify: Temp_DecPlaces,400002 Measurement end time definition Syntax: Ch<x>_MeasTime,<register> <x>: channel number (1 to 16) <register>: register number (400001 to 465536) Description: To store the measurement end time for channel <x> in register number <register>. Example: To store the measurement end time for channel 8 into register number 400020, specify: Ch8_MeasTime,400020
< 7. Measurement Data Monitoring Function > 59 Definition for number of valid measurement data values Syntax: Ch<x>_DataNum,<register>,<start>,<number>,<step> <x>: channel number (1 to 16) <register>: register number (400001 to 465536) <start>: the first data to retrieve (1 to 38500) <number>: number of data to retrieve (1 to 38500) <step>: data step (1 to 100) Description: To store the number of valid data values in register number <register> after retrieving the number designated by <number> of temperature measurement data values of channel <x>, starting from the data value designated by <start>, at intervals of the number of data values designated by <step>. Example: To store the actual number of valid data values in register number 400010 after retrieving 200 temperature measurement data values of channel 2, starting from the 1000th data value, at intervals of 5 data values, specify: Ch2_DataNum,400010,1000,200,5 Temperature data definition Syntax: Ch<x>_Temp,<register>,<start>,<number>,<step> <x>: channel number (1 to 16) <register>: register number (400001 to 465536) <start>: the first data to retrieve (1 to 38500) <number>: number of data to retrieve (1 to 38500) <step>: data step (1 to 100) Description: To store the number designated by <number> of temperature measurement data values of channel <x>, starting from the data value designated by <start>, at intervals of the number of data values designated by <step>, into registers, starting from the register number <register>. Example: To store 1000 temperature measurement data values of channel 1, starting from the first data value, at intervals of 10 data values, into registers, starting from register number 400100, specify: Ch1_Temp,400100,1,1000,10 Remarks: Temperature data is represented as unsigned 16-bit integer data in Kelvin (K) units. The data contains one fixed decimal place so the actual temperature value is the returned value divided by 10. If the number of temperature data values to be retrieved exceeds the actual number of DTSX3000 measurement data values, 0 values will be returned for missing values. The actual number of valid data values retrieved can be determined by coding a statement as described earlier under Definition for number of valid measurement data values. In addition, the actual distance values of the temperature data can be determined by coding a statement as described later under Distance data definition. Distance data definition Syntax: Ch<x>_Dist, <register>, <start>, <number>, <step> <x>: channel number (1 to 16) <register>: register number (400001 to 465536) <start>: the first data to retrieve (1 to 38500) <number>: number of data to retrieve (1 to 38500) <step>: data step (1 to 100)
< 7. Measurement Data Monitoring Function > 60 Description: To store the number designated by <number> of distance data values of channel <x>, starting from the data value designated by <start>, at intervals of the number of data values designated by <step>, into registers starting from the register number <register>. Example: Remarks: To store 1000 distance data values of channel 1, starting from the first data value, at intervals of 10 data values, into registers starting from register number 402000, specify: Ch1_Dist,402000,1,1000,10 Distance data is represented as signed 32-bit integer data in metre (m) units. The data contains 2 fixed decimal places so the actual distance value is the returned value divided by 100. If the number of distance data values to be retrieved exceeds the actual number of DTSX3000 measurement data values, 0 values will be returned for missing values. The actual number of valid data values retrieved can be determined by coding a statement as described earlier under Definition for number of valid measurement data values. The largest number of distance data values that can be retrieved using one set of measurement data registers is 32768. To retrieve 32769 or more data values, use two sets of measurement data registers. Signal level (ST/AS intensity ratio) data definition Syntax: Ch<x>_SigLvlST,<register>,<start>,<number>,<step> Ch<x>_SigLvlAS,<register>,<start>,<number>,<step> <x>: channel number (1 to 16) <register>: register number (400001 to 465536) <start>: the first data to get (1 to 38500) <number>: number of data to get (1 to 38500) <step>: data step (1 to 100) Description: To store the number designated by <number> of signal level data values of channel <x>, starting from the data value designated by <start>, at intervals of the number of data values designated by <step>, into registers, starting from the register number <register>. Example: Remarks: To store 1000 ST intensity ratio data values of channel 2, starting from the first data value, at intervals of 10 data values, into registers, starting from register number 401001, specify: Ch2_SigLvlST,401001,1,1000,10 Signal level data is represented as signed 32-bit integer data in db units. The data contains 6 fixed decimal places so the actual signal level data value is the returned value divided by 1000000. If the number of signal level data values to get exceeds the actual number of DTSX3000 measurement data values, 0 values will be returned for missing values. The number of valid data values returned for a specified condition can be determined as described under Definition for number of valid measurement data values in subsection 3.2.1, Register Structure Definition Statements of the DTSX3000 Communications (Modbus) Guide: Measurement Data Monitoring Function manual (IM39J06B40-05E). Up to 32768 signal level data values can be returned using one set of measurement data registers. To get 32769 or more signal level data values, you need to use two sets of measurement data registers.
< 7. Measurement Data Monitoring Function > 61 CFL data definition Syntax: Ch<x>_Cfl, <register>, <start>, <number>, <step> <x>: channel number (1 to 16) <register>: register number (400001 to 465536) <start>: the first data to retrieve (1 to 38500) <number>: number of data to retrieve (1 to 32768) <step>: data step (1 to 100) Description: To store the number designated by <number> of CFL data values of channel <x>, starting from the data value designated by <start>, at intervals of the number of data values designated by <step>, into registers starting from the register number <register>. Example: Remarks: TIP To store 1000 CFL data values of channel 1, starting from the first data value, into registers starting from register number 400001, specify: Ch1_Cfl,400001,1,1000,1 CFL data is represented as signed 32-bit integer data in db units. The data contains 6 fixed decimal places so the actual CFL data value is the returned value divided by 1000000. If the number of CFL data values to be retrieved exceeds the actual number of DTSX3000 measurement data values, 0 values will be returned for missing values. The actual number of valid data values retrieved can be determined by coding a statement as described earlier under Definition for number of valid measurement data values. The largest number of CFL data values that can be retrieved using one set of measurement data registers is 32768. To retrieve 32769 or more data values, use two sets of measurement data registers. - The actual distance value for measurement data (temperature, signal level, CFL data) can be calculated from the data number using the following formula: D = (I-1)*S*10^(-8)*C/(2*n) D: distance [m] I: data number (starting from 1, which corresponds to 0 to sampling resolution[m]) S: sampling resolution [m] (setting value of 0.1, 0.2, 0.5 or 1.0 m) C: speed of light (299792458 [m/s]) n: group index (varies with optical fiber with typical value of 1.48) However, if Calculation Range of the DTSX3000 sensor fiber settings is set to Range Setting, then measurement data of data number 1 corresponds to measurement data at the specified Start of Calculation Range. In this case, get the actual distance value of measurement data using the Distance Data Definition statement instead of using the above formula, - One register structure definition file can be coded with definition statements for one or more channel numbers. - Beware of the following restrictions when coding definition statements: -- Only the first 100 lines (excluding comment lines) of a file can be loaded. -- Coding is case-sensitive. -- Do not insert space characters (0x20, etc.) before or after character strings delimited by comma (,) characters. -- Do not duplicate/overlap register numbers between definition statements. Otherwise, proper operation is not guaranteed.
< 7. Measurement Data Monitoring Function > 62 Sample Register Structure Definition File Sample UID01.csv file #Channel1 Results Of Measurement (1-2000points) Ch1_ChNo,400001 Temp_DecPlaces,400002 Ch1_MeasTime,400003 Ch1_DataNum,400009,1,2000,1 Ch1_Dist,400011,1,2000,1 Ch1_Temp,404011,1,2000,1 Ch1_SigLvlST,406011,1,2000,1 Ch1_SigLvlAS,410011,1,2000,1 Ch1_Cfl,414001,1,2000,1 The above register structure definition file defines the following measurement data register structure. Register Number Specification 400001 1(channel number 1) 400002 1(number of fixed decimal places) 400003 to 400008 Measurement end time for Ch1 400009,400010 Number of valid data values for Ch1 400011,400012 Distance data for Ch1 (data number 1) 404009,404010 Distance data for Ch1 (data number 2000) 404011 Temperature data for Ch1 (data number 1) 406010 Temperature data for Ch1 (data number 2000) 406011,406012 Stokes intensity ratio data for Ch1 (data number 1) 410009,410010 Stokes intensity ratio data for Ch1 (data number 2000) 410011,410012 Anti-Stokes intensity ratio data for Ch1 (data number 1) 414009,414010 Anti-Stokes intensity ratio data for Ch1 (data number 2000) 414011,414012 CFL data for Ch1 (data number 1) 418009,418010 CFL data for Ch1 (data number 2000)
7.3.3. File Loading Errors < 7. Measurement Data Monitoring Function > 63 If the filename or content of a register structure definition file is invalid, a file loading error will be reported. If this happens, value -1 will be assigned to all measurement data registers and measurement data will not be updated. A file loading error will be reported if: - The file name is invalid; - A coded definition statement or parameter string is unrecognizable. - Too many or too few parameters are coded in a definition statement; or - A parameter coded in a definition statement is out of range. - A parameter value coded in a definition statement is duplicated in another definition statement. When a file loading error is detected, an error message will be output to the application log of the Systems Settings window of the DTSX3000. SEE ALSO For details on the application log of the systems settings window, see Subsection B6.4.2, Log Display of the DTSXL Distributed Temperature Sensor Long Range System Guide (IM 39J06B40-01E). File loading error messages are listed below along with possible remedies. Message Undefined File Name YYY.csv. Description The file YYY.csv has filename of the form "UIDxx.csv" where xx is not within the range of 01 to 16. Remedy Delete the file. Message Description Remedy Undefined Index Field Found in line XXX in YYY.csv. An unrecognizable definition statement is coded in line XXX of file named "YYY.csv. Check and fix the definition statement line indicated in the message for the following errors: - Errors in definition statement; - incorrect upper- or lowercase; or - invalid space character (0x20) or some other character inserted before or after comma-delimited character strings. Message Description Remedy Number of Field Error Found in line XXX in YYY.csv. Too many or too few parameters are coded in the definition statement on line XXX of file named YYY.csv. Ensure that a correct number of parameters are coded in the definition statement line indicated in the message. Message Description Remedy Parameter Range Error Found in line XXX in YYY.csv. A parameter coded on line XXX of file named YYY.csv is out of range. Ensure that the parameter value coded in the definition statement line indicated in the message is within valid range. Message Description Remedy Register Duplication Error Found in line XXX in YYY.csv. A duplicate register number is coded on line XXX of file named YYY.csv. Ensure that the parameter value coded in the definition statement line indicated in the message is not duplicated in another definition statement line.
< 7. Measurement Data Monitoring Function > 64 7.4. How to Use the Function 7.4.1. Enabling Measurement Data Monitoring Function The procedure for enabling the measurement data monitoring function is described below. 1. Creating register structure definition files Using any general text editor, create a register structure definition file for each unit ID value. Created register structure definition files must be assigned file names "UID01" to "UID16" and file extension.csv. SEE ALSO For details on register structure definition files, see Chapter 7.3, "Register Structure Definition File. 2. Connecting to the DTSX3000 using SFTP client software Run SFTP client software and connect (login) to the DTSX3000. Example: WinSCP Ver5.1.7 Host name : hostname or IP address of DTSX3000 Port number : 22 User name : username of a DTSX3000 user (with read-write privileges) Password : password Protocol : select SFTP Specify the SFTP protocol. Specify the following settings: -Hostname or IP address destination DTSX3000 -Username and password of a DTSX3000 user -Port number 22 3. Storing register structure definition files Move to directory /mnt/intl/setup, and copy the register structure definition files. Files must be copied using text format or they may fail to load successfully later. 4. Rebooting the DTSX3000 Reboot the DTSX3000 from the System Settings window. If the copied register structure definition files are loaded successfully, the measurement data monitoring function is enabled, and the measurement data registers are initialized to value 0 and available for use. If register structure definition files fail to be loaded successfully for whatever reason, value -1 will be assigned to all measurement data registers.
< 7. Measurement Data Monitoring Function > 65 SEE ALSO - For details on how to reboot the DTSX30000 from the Systems Settings screen, see Subsection B6.4.17, Reboot of the DTSXL Distributed Temperature Sensor Long Range System Guide (IM 39J06B40-01E). - For details on reported errors when loading files, see Section 7.3.3, "File Loading Errors."
7.4.2. Loading Settings File < 7. Measurement Data Monitoring Function > 66 The procedure for loading a settings file to the DTSX3000 using Modbus communications is described below. 1. Running the software Run the DTSX3000 Control Visualization Software. 2. Editing and saving settings After the software is started, edit the settings. When you have finished editing, select [Save] from the context menu of User Setting in the Solution Tree window. Save the file with filename "UserSetup.dual". SEE ALSO For details, see DTAP3000 DTSX3000 Control Visualization Software Guide (IM 39J02B40-01E). 3. Changing to file extension xml Change the file extension of the file saved in step 2 to xml (XML format) 4. Connecting to DTSX3000 using SFTP client software Run SFTP client software and connect (login) to the DTSX. Example: WinSCP Ver5.1.7 Host name : hostname or IP address of DTSX3000 Port number : 22 User name : username of a DTSX3000 user (with read-write privileges) Password : password Protocol : select SFTP Specify the SFTP protocol. Specify the following settings: -Hostname or IP address destination DTSX3000 -Username and password of a DTSX3000 user -Port number 22 5. Storing settings file Move to directory /mtn/intl/setup and, and copy the settings file (XML formatted file) created in step 3.