User’s Manual Models GX10/GX20/GP10/GP20 Paperless Recorder Communication Command User’s Manual IM 04L51B01-17EN 3rd Edition
Introduction Notes Trademarks Revisions Thank you for purchasing the SMARTDAC+ GX10/GX20/GP10/GP20 (hereafter referred to as the GX and GP) Series. This manual explains the dedicated commands for the GX/GP. To ensure correct use, please read this manual thoroughly before beginning operation. • The contents of this manual are subject to change without prior notice as a result of continuing improvements to the instrument’s performance and functions.
How to Use This Manual This manual explains the dedicated communication commands for the GX/GP and how to use them. For details on the features of the GX/GP and how to use it, see the following manuals. • Models GX10/GX20/GP10/GP20 Paperless Recorder First Step Guide (IM 04L51B0102EN) • Models GX10/GX20/GP10/GP20 Paperless Recorder User’s Manual (IM 04L51B0101EN) Conventions Used in This Manual Unit K k Markings WARNING CAUTION Note ii Denotes 1024. Example: 768K (file size) Denotes 1000.
Contents 1 Introduction................................................................................................................................................. i How to Use This Manual........................................................................................................................... ii Conventions Used in This Manual.............................................................................................................
Contents 2.10.20 2.10.21 2.10.22 2.10.23 2.10.24 2.10.25 2.10.26 2.10.27 2.10.28 2.10.29 2.10.30 2.10.31 2.10.32 2.11 Appendix iv External Storage Medium Free Space (FMedia)...................................................................2-75 Setting Data (FCnf)...............................................................................................................2-76 Decimal Place and Unit Information (FChInfo)......................................................................
Chapter 1 Using Dedicated Commands (General) 1.1 Operations over an Ethernet Network 1 Using Dedicated Commands (General) You can control the GX/GP by sending commands from a PC over an Ethernet network. There are various types of commands: setting commands, output commands, operation commands, communication control commands, and instrument information output commands. 1.1.
1.2 Operations over the Serial Interface You can control the GX/GP by sending commands from a PC through the serial interface. There are various types of commands: setting commands, output commands, operation commands, communication control commands, and instrument information output commands. Except for a few special commands, the commands are the same as those used over an Ethernet network. 1.2.1 Preparing the Instrument Connection See section 1.2.3, “RS-232 Connection Procedure,” or section 1.2.
1.2 Operations over the Serial Interface 1.2.3 1 RS-232 Connection Procedure Connection • Connector pin arrangement and signal names 2 5 4 3 2 1 6 7 App 8 9 Each pin corresponds to the signal indicated below. The following table shows the signal name, RS-232 standard, JIS, and ITU-T standard signals.
1.2 Operations over the Serial Interface Handshaking When using the RS-232 interface for transferring data, it is necessary for equipment on both sides to agree on a set of rules to ensure the proper transfer of data. The set of rules is called handshaking. Because there are various handshaking methods that can be used between the GX/GP and the PC, you must make sure that the same method is chosen by both the GX/GP and the PC. You can choose any of the four methods on the GX/GP in the table below.
1.2 Operations over the Serial Interface 1 Hardware handshaking is performed between the GX/GP and the PC. When the CS signal becomes False while sending data to the PC, the GX/GP stops the data transmission. When the CS signal becomes True, the GX/GP resumes the data transmission. The “X-OFF” and “X-ON” signals are treated as data. 2 Data reception control The operation is the same as with XON-RS.
1.2 Operations over the Serial Interface 1.2.4 RS-422/485 Connection Procedure Connect a cable to the terminal. Connection • Connecting the Cable As shown in the figure below, remove approximately 6 mm of the covering from the end of the cable to expose the conductor. Keep the exposed section from the end of the shield within 5 cm.
1.2 Operations over the Serial Interface • Four-wire system Terminator (external) Terminator (external) 120 Ω 1/2W or greater 2 RS-422/485 terminal on the GX/GP Host device side SDA( – ) (SDA–) SDB( + ) (SDB+) RDA( – ) (RDA–) RDB( + ) (RDB+) SG (SG) SDA– SDB+ RDA– RDB+ SG FG (SDA–) (SDB+) (RDA–) (RDB+) (SG) #1 SDA– SDB+ RDA– RDB+ SG FG (SDA–) (SDB+) (RDA–) (RDB+) (SG) #2 SDA– App SDB+ RDA– RDB+ SG FG #n (#n 32) Do not connect terminators to #1 through #n-1.
1.2 Operations over the Serial Interface Serial interface converter The recommended converter is given below. SYSMEX RA CO.,LTD./MODEL RC-770X, LINE EYE/SI-30FA, YOKOGAWA/ML2 Some converters not recommended by Yokogawa have FG and SG pins that are not isolated. In this case, do not follow the diagram on the previous page (do not connect anything to the FG and SG pins).
Chapter 2 Commands and Responses Command Transmission and GX/GP Responses 1 2.1.1 General Communication 2 2.1.2 Command Types and Functions The GX/GP can work with various applications through the use of commands. The communication that is achieved through commands is referred to as “general communication.” App The following types of commands are available. The first character of command names represents the command type. For example, in the command “SRangeAI,” “S” represents the command type.
2.1 Command Transmission and GX20 Responses Notes on Writing Commands in a Series • Only setting commands can be written in a series. • Queries (see the next section) cannot be written in a series. • If there is an error in one of the commands in a series, the commands before it are canceled, and those after it are not executed. Example of a Command SRangeAI,0001,VOLT,2V,OFF,-15000,18000,0;SRangeAI,0002,SKIP Queries Queries are used to inquire the GX/GP settings.
2.1 Command Transmission and GX20 Responses Parameters 1 Parameters are characteristic values that are attached to commands. Notes on Writing Parameters There are two types of parameters: predefined expressions and user-defined character strings. How to Write User-Defined Character Strings (Parameters) • Enclose user-defined character strings in single quotation marks. Example The command for setting the channel 0001 tag to “SYSTEM1” is shown below.
2.1 Command Transmission and GX20 Responses 2.1.4 GX/GP Responses The GX/GP returns the following responses to commands. • If the GX/GP successfully completes the processing of a received output request command, it outputs the requested data. • If the GX/GP successfully completes the processing of a received command that is not an output request command, it outputs an affirmative response. • If a command syntax error, setting error, or other error occurs, the GX/GP outputs a negative response.
2.2 2.2.
2.
2.2 List of Commands OAlarmAck 2.2.4 Communication Control Commands Command CCheckSum CSFilter CLogin CLogout ESC O ESC C 2.2.
2.3 Parameters This section describes parameters. 2.3.1 Measuring Range Parameters AI Channel Span Specify the span using an integer. Example If the range is -2.0000 V to 2.0000 V and you want to set the span lower limit to 0.5000 V and the span upper limit to 1.8000 V, set the parameters to 5000 and 18000, respectively. SRangeAI,0001,VOLT,2V,FF,5000,18000,0 Scaling Scaling is possible on AI and DI channels. Scaling is specified by a mantissa and decimal place. Example To set the scaling to -10.
2.4 Setting Commands • • • SScan Sets the scan interval. Syntax SScan,p1,p2 p1 Scan group (1) p2 Scan interval (100ms, 200ms, 500ms, 1s, 2s, 5s) SScan[,p1]? Query Example Set the scan interval to 1 second. SScan,1,1s Description • You cannot use this command to configure settings while recording is in progress. • You cannot use this command to configure settings while computation is in progress. SScanGroup Scan Group Registers a measurement channel in scan group 1.
2.4 Setting Commands Description • You cannot use this command to configure settings while recording is in progress. • You cannot use this command to configure settings while computation is in progress. • The setting specified with this command is valid if at least one module is installed. SMemory Recording Mode Sets the type of data to record. Syntax SMemory,p1 p1 Recording mode D Display data D+E1 Display data and event data E1 Event data SMemory? Query Example Record display data.
2.4 Setting Commands • • If p2=Off, you cannot set p3. There is a limit to the number of recording channels depending on the recording interval (SDispData command). • Number of Recording Channels 100 200 500 You cannot set a channel more than once. SRecEvent Channel for Recording Event Data Sets the channel for recording event data. Syntax SRecEvent,p1,p2,p3,p4 p1 Scan group (1) p2 Number (see “Description”) p3 Channel type Off Do not record event data.
2.4 Setting Commands SDirectory? Query Example Set the directory name to “DATA0.” SDirectory,’DATA0’ Description • For the characters that you can use in the directory name (p1), see Appendix 1. • The following character strings cannot be used for directory names. • Character String AUX CON PRN NUL CLOCK$ COM0 to COM9 LPT0 to LPT9 You cannot use a character string that starts or ends with a period or space for directory names.
2.4 Setting Commands SRangeAI Measurement Range of AI Channel IM 04L51B01-17EN Description • You cannot use this command to configure settings while recording is in progress. • You cannot use this command to configure settings while computation is in progress. • If p2=TC/RTD/DI, you cannot specify p4=Sqrt. • If p2=GS, you cannot specify p4=Off/Delta. • If p2=DI, you cannot set p7. • RTD cannot be specified if an electromagnetic relay scanner type (Type suffix code: -T1) analog input module is in use.
2.4 Setting Commands p2=Volt 20mV 60mV 200mV 1V 2V 6V 20V 50V p2=TC R S B K K-H E J T N W L U PLATINEL PR20-40 WRe3-25 KpvsAu7Fe NiNiMo WWRe26 N14 XK p2=RTD p2=GS Pt100 1-5V Pt100-H 0.4-2V JPt100 JPt100-H Cu10GE Cu10LN Cu10WEED Cu10BAILEY Cu10a392 Cu10a393 Cu25 Cu53 Cu100 J263B Ni100SAMA Ni100DIN Ni120 Pt25 Pt50 Pt200WEED Cu10G Cu50G Cu100G Pt46G Pt100G p2=DI Level DI SRangeDI Measurement Range of DI Channel Sets the measurement range of a DI channel.
2.4 Setting Commands SMoveAve Moving Average Sets the moving average of an AI channel. Syntax SMoveAve,p1,p2,p3 p1 Channel number p2 Enable or disable (Off, On) p3 Number of samples (2 to 100) SMoveAve[,p1]? Query Example Set the number of moving average samples for channel 0002 to 12. SMoveAve,0002,On,12 SBurnOut Behavior When a Sensor Burns Out Sets the behavior for when a burnout occurs on an AI channel.
2.4 Setting Commands p7 Output (Off) Output Alarms Syntax SAlarmIO,p1,p2,p3,p4,p5,p6,p7,p8 p1 Channel number p2 Alarm number (1 to 4) p3 Alarm on or off (On) P4 Alarm type (H, L, DH, DL, RH, RL, TH, TL) p5 Value p6 Detection (Off, On) p7 Output DO Output to a relay (DO channel) SW Output to an internal switch p8 Number If p7=DO Relay (DO channel) number If p7=SW Internal switch number (001 to 100) SAlarmIO[,p1[,p2]]? Query Example Set a high limit alarm (H) on alarm number 2 of channel 0001.
2.4 Setting Commands Description • The RGB values for different colors are indicated in the following table.
2.4 Setting Commands p7 Lower limit of the color scale band display (span lower limit to span upper limit) SBandIO[,p1]? Query Example For channel 0001, set a blue band in the range of -0.5000 to 1.0000. SBandIO,0001,In,0,0,255,5000,10000 Description • You cannot set this on a “Skip” channel. p2 is fixed to Off. • If p2=Off, you cannot set p3 or subsequent parameters. • For details on RGB values, see “Description” of the SColorIO command.
2.4 Setting Commands 1 SMathBasic Math Action (/MT) Sets the basic operation of math channels. Syntax SMathBasic,p1,p2,p3,p4 p1 Indication on computation error +Over Display the computed value as +Over. -Over Display the computed value as -Over. p2 SUM and AVE computation when overflow data is detected Error Sets the computation result to computation error. Skip Discards the data that overflowed and continues the computation.
2.4 Setting Commands Description • You cannot use this command to configure settings while recording is in progress. • You cannot use this command to configure settings while computation is in progress. • The math function is an option (/MT). SKConst Constant (/MT) Sets a constant for use in computations. Syntax SKConst,p1,p2 p1 Constant number (1 to 100) p2 Value (–9.999999E+29 to –1E–30, 0, 1E–30 to 9.999999E+29, seven significant digits) SKConst[,p1]? Query Example Set constant number 12 to 1.0000E–10.
2.4 Setting Commands Channel number Alarm number (1 to 4) Alarm on or off (On) Alarm type (H, L, TH, TL) Alarm value (within the span range) Detection (Off, On) Output DO Output to a relay (DO channel) SW Output to an internal switch p8 Number If p7=DO Relay (DO channel) number If p7=SW Internal switch number (001 to 100) SAlarmMath[,p1]? Query Example Set a high limit alarm (H) on alarm number 2 of math channel 015. Set the alarm value to 85.0.
2.4 Setting Commands SScaleMath[,p1]? Query Example Display the math channel 015 scale at display position 1. Display four equally spaced main scale marks. SScaleMath,015,1,4 SBarMath Bar Graph Display (/MT) Sets the bar graph display of a math channel.
2.4 Setting Commands SAlmMarkMath,015,On,Fixed,255,0,0, 165,42,42,255,165,0,255,255,0 Description • For details on RGB values, see “Description” of the SColorIO command. 1 SRangeCom Measurement Range (/MC) SValueCom Preset Operation (/MC) Sets the preset operation of a communication channel. Syntax SValueCom,p1,p2,p3 p1 Channel number p2 Value at power-on (Preset, Last) p3 Preset value (–9.999999E+29 to –1E–30, 0, 1E–30 to 9.
2.4 Setting Commands p3 Watchdog timer (1 to 120) [s] p4 Value at timer expired (Preset, Last) SWDCom[,p1]? Query Example Set the watchdog timer of communication channel 025 to 60 seconds. Replace the communication channel 025 value with its preset value at watchdog timer expiration. SWDCom,025,On,60,Preset Description • If p2=Off, you cannot set p3 or subsequent parameters. SAlarmCom Alarm (/MC) Sets the alarm of a communication channel.
2.4 Setting Commands SColorCom Channel Color (/MC) SZoneCom Waveform Display Zone (/MC) Sets the waveform display zone of a communication channel. Syntax SZoneCom,p1,p2,p3 p1 Channel number p2 Zone lower limit [%] (0 to 95) p3 Zone upper limit [%] (5 to 100) SZoneCom[,p1]? Query Example Set the waveform zone of communication channel 025 waveform to 0% to 30%. SZoneCom,025,0,30 SScaleCom Scale Display (/MC) Sets the scale display of a communication channel.
2.4 Setting Commands SAlmMarkCom Alarm Mark (/MC) Sets the display of the marker that indicates the specified alarm position of a communication channel.
2.4 Setting Commands SMatchTimer Match Time Timer Sets a match time timer.
2.
2.4 Setting Commands Description • You cannot use this command to configure settings while recording is in progress. • You cannot use this command to configure settings while computation is in progress. SRepTemp Report Output (/MT) Sets the report output mode. Syntax SRepTemp,p1,p2,p3 p1 EXCEL template Off Disabled On Enabled p2 PDF output (Off, On) p3 Printer output (Off, On) SRepTemp? Query Example Generate reports that use the Excel template.
2.4 Setting Commands SBackColor Screen Background Color Sets the screen background color. Syntax SBackColor,p1,p2,p3 p1 R value of RGB background colors (0 to 255) p2 G value of RGB background colors (0 to 255) p3 B value of RGB background colors (0 to 255) SBackColor? Query Example Set the background color to black. SBackColor,0,0,0 Description • For details on RGB values, see “Description” of the SColorIO command.
2.4 Setting Commands Example Set the number of digits to display for scale values to “Fine,” display the value indicators on a bar graph, and set the number of digits to display for channels that are added to the current value mark to 4 digits. StrdScale,Fine,Bar,4-digit Trend Line Width, Grid Sets the trend waveform line width and the grid in the display area.
2.4 Setting Commands Example Assign channels 0001, 0003, 0005, A001, and C023 to group 2 and name it “GROUP A.” SGroup,2,On,’GROUP A’,’1.3.5.A1. C23’ SMessage[,p1]? Query Example Assign character string “MESSAGE77” to message number 77. SMessage,77,’MESSAGE77’ STripLine Display Group Trip Line Sets a trip line for a display group.
2.4 Setting Commands Digit Letter Display the month using numerals (1 to 12) Display the month using characters (Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec) Description • • You cannot use this command to configure settings while recording is in progress. You cannot use this command to configure settings while computation is in progress. SDst Daylight Saving Time Set the daylight saving time.
2.4 Setting Commands • You cannot use this command to configure settings while computation is in progress. SFailSts Instrument Status to Output (/FL) Sets the instrument status to output from the fail relay (DO channel). Syntax SFailSts,p1,p2,p3,p4,p5 p1 Memory/media status (Off, On) p2 Measurement error (Off, On) p3 Communication error (Off, On) P4 Recording stop (Off, On) p5 Alarm (Off, On) SFailSts? Query Example Output all information.
2.4 Setting Commands Description • p3 is valid when p2=Alarm. SSerialBasic Serial Communication Basics (/C2 or / C3) Sets basic serial communication parameters.
2.4 Setting Commands p5 Register (1 to 465535) p6 Channel type IO I/O channel Math Math channel Com Communication channel p7 First channel p8 Last channel SModMCmd[p1]? Query Example Register the following command in command number 2: read the 32-bit signed integer data that is assigned to registers 30003 (upper 16 bits) and 30004 (lower 16 bits) in the slave device assigned to address 5 into channel C002.
2.4 Setting Commands Description • The settings specified with this command takes effect with the OIPApply command. The GX/GP IP address does not change until you send the OIPApply command. File to Transfer via FTP Sets the file to transfer via FTP. Syntax SFtpKind,p1,p2 p1 Setting type Data Automatically transfer display and event data files when files are generated. Report Automatically transfer report data files when files are generated.
2.4 Setting Commands Mail Header (Recipient Address) Sets the mail header including the recipient address. Syntax SMailHead,p1,p2,p3,p4 p1 Sender address (up to 64 characters, ASCII) p2 Recipient address 1 (up to 150 characters, ASCII) p3 Recipient address 2 (up to 150 characters, ASCII) P4 Character string to add to the subject (up to 32 characters, ASCII) SMailHead? Query Example Set the sender address to “recorder1@data. com” and the recipient address to “pc1@data. com.” Add “part1” to the subject.
2.4 Setting Commands p3 Reference time: Minutes (MM) (00 to 59) P4 Interval (1h, 2h, 3h, 4h, 6h, 8h, 12h, 24h) SMailTime[,p1]? Query Example Send mail to recipient 1 every day at 08:30. SMailTime,1,08,30,24 SNTP Client Sets the SNTP client operation and the connection destination server.
2.4 Setting Commands • For details on data types, registers, and channel types, see section 4.5.1, “Modbus Client and Master Function” in the Models GX10/GX20/GP10/GP20 Paperless Recorder User’s Manual (IM 04L51B0101EN). SServer Server Function Enables or disables the server function. Syntax SServer,p1,p2,p3 p1 Server type (FTP, HTTP, SNTP, MODBUS, GENE) p2 Operation (Off, On) p3 Port number (1 to 65535) SServer[,p1]? Query Example Use the FTP server function.
2.4 Setting Commands • • Password to Unlock Operation Sets the password that is used to release the operation lock. Syntax SOpePass,p1 p1 Password (up to 20 characters, ASCII) SOpePass? Query The password is displayed using asterisks. Example Set the password to “password1.” SOpePass,’password1’ Description You cannot use this command to configure settings when logged in as a user (when the user level is User). SOpeLimit Operation Lock Details Sets which operations to lock.
2.
2.4 Setting Commands p2 Status (see the table of the SMonitor command) SHomeMonitor[,p1]? Query Example Set the trend display to all-channel display. SHomeMonitor,Trend,All Standard Screen Set the standard screen.
2.5 Output Commands FData Outputs the Most Recent Channel Data Outputs the most recent I/O channel, math channel, and communication channel data. Syntax FData,p1,p2,p3 p1 Output format 0 The most recent data in ASCII format 1 The most recent data in binary format p2 First channel p3 Last channel Example Output the most recent data of channels 0001 to 0020 in ASCII format. FData,0,0001,0020 Description • If you omit p2 and p3, all channels will be output.
2.5 Output Commands FAddr Outputs the IP Address Description • For the ASCII output format, see page 2-62. FStat Outputs the GX/GP Status Outputs the GX/GP status. Syntax FStat,p1 p1 Status output (0) Example Output the GX/GP status. FStat,0 Description • For the ASCII output format, see page 2-63. FLog Outputs the Log Outputs the alarm summary, message summary, error log, etc.
2.5 Output Commands Free Space on the External Storage Medium Syntax FMedia,p1 p1 Output type (CHKDSK) Example Output the free space on the external storage medium. FMedia,CHKDSK Description • For the ASCII output format, see page 2-75. FCnf Outputs Setting Data Outputs the GX/GP setting data. Syntax FCnf,p1 p1 Operation ALL IO MATH COMM GROUP IP SECURITY OTHERS Read all settings. Read I/O settings. Read Math settings. Read communication settings. Read display group settings. Read IP address settings.
2.6 Operation Commands Sets the Time Sets the time. Syntax OSetTime,p1 p1 Time to set “YYYY/MO/DD_HH:MI:SS” (the underscore denote a space), “YYYY/MO/ DD”, or “HH:MI:SS.” YYYY Year (2001 to 2035) MO Month (01 to 12) DD Day (01 to 31) HH Hour (00 to 23) MI Minute (00 to 59) SS Second (00 to 59) OSetTime? Query The OSetTime query outputs the GX/GP current time. Example Set the time to 23:00:00 on May 24, 2013. OSetTime,2013/05/24 23:00:00 ORec Starts or Stops Recording Starts or stops recording.
2.6 Operation Commands OPassword Changes the Password Changes the password. Syntax OPassword,p1,p2,p3 p1 Old password (up to 20 characters, ASCII) p2 New password (up to 20 characters, ASCII) p3 New password (enter the same password as p2) Example Change the password from “PASS001” to “WORD005.” OPassword,’PASS001’,’WORD005’,’WO RD005’ Description • For the characters that you can use for the password, see Appendix 1.
2.6 Operation Commands ORTReset,2 OMTReset Resets the Match Time Timer OCmdRelay Outputs the DO Channel and Internal Switch Status Outputs the DO channel and internal switch status. Syntax OCmdRelay,p1 p1 Specification of a setting • Express the setting. Set a channel status as follows: [channel number]-[status]. Use a hyphen as a separator. • You can specify the following values for the channel number. DO channel number Internal switch number • You can specify the following values for the status.
2.6 Operation Commands OLoadConf Loads Setting Data Loads a setting data file from the GX/GP external storage medium into the GX/GP. Syntax OLoadConf,p1,p2,p3 p1 File name (up to 240 characters, ASCII) Specify the path and file name, excluding the extension.
2.7 Communication Control Commands Sets the Checksum Sets the presence or absence of checksum. Syntax CCheckSum,p1 p1 Checksum usage 0 Do not compute 1 Compute Query Example Enable the checksum. CCheckSum,1 CSFilter Sets the Status Filter Sets the filter used when outputting the GX/GP status. Syntax CSFilter,p1 p1 Filter values for status information numbers 1 to 4 (0.0.0.0 to 255.255.255.255) CSFilter? Query Example Set the status filter value to 255.127.63.31. CSFilter,255.127.63.
2.8 Instrument Information Output Commands _MFG Outputs the Instrument Manufacturer Outputs the instrument manufacturer. Syntax _MFG Description • _TYP Outputs the Instrument’s Temperature Unit and Daylight Saving Time Installation Information Outputs whether the instrument’s Fahrenheit temperature unit and daylight saving time setting is enabled or disabled. Syntax _TYP Description • For the ASCII output format, see page 2-80. For the ASCII output format, see page 2-78.
2.9 Responses to Commands 1 This section explains the responses that GX/GP returns in response to commands. There are three types of responses: affirmative response, negative response, and data output response. Affirmative Response (For commands other than output request commands) If the GX/GP successfully completes the processing of a received command that is not an output request command, it returns an affirmative response. Syntax E0CRLF “CRLF” is the terminator that the GX/GP uses.
2.9 Responses to Commands Response Example 3 In a string of two commands, if error number 10 occurs in the second parameter of the first command and error number 500 occurs in the fifth parameter of the second command, the GX/GP outputs: E1,10:1:2,500:2:5 Error Messages You can use the “instrument’s error number information output command” (_ERR) to output the error message that corresponds to an error number of a negative response. 2.9.
2.9 Responses to Commands Binary Output 1 The responses to output commands consisting of binary data output requests are in binary. Format App 4 bytes 2 bytes 1 byte 'E' 'B' CR LF Data length Flag Reserved area 1 Reserved area 2 Header sum Data block Data sum EBCRLF The EBCRLF block stores ASCII code “E,” ASCII code “B,” followed by “CR” “LF.” This indicates that the output data is binary.
2.9 Responses to Commands Data Block The actual output data. The format varies depending on the output content. For details, see section 2.11, “Format of the Data Block of Binary Output.” Data sum (16 bits, big endian) The data sum block indicates the sum of the data block. Use the CCheckSum command to specify whether to include data sum. By default, check sum is set to “No.” Whether data sum is included is expressed by a flag in the header block.
2.10 ASCII Output Format 1 2.10.1 Most Recent Channel Data (FData) The output in response to the command “FData,0” is shown below. Syntax EA DATE_yy/mo/dd TIME_hh:mm:ss.mmmt s_cccca1a2a3a4uuuuuufddddddddE-pp s_cccca1a2a3a4uuuuuufddddddddE-pp … s_cccca1a2a3a4uuuuuufddddddddE-pp EN yy/mo/dd Data time (year, month, day) yy Year (00 to 99) mo Month (01 to 12) dd Day (01 to 31) hh:mm:ss.
2.10 ASCII Output Format f dddddddd pp 2.10.2 V_¯_¯_¯_¯_ V ^C_¯_¯_¯_¯ °C Sign (+ or -) Mantissa (00000000 to 99999999; 8 digits) For erroneous data (data status is E), the mantissa is 99999999. If the data status is O (±over), the mantissa is 99999999 (+over) or –99999999 (–over). If the data status is B (burnout), the mantissa is 99999999 (+burnout) or –99999999 (–burnout). Exponent (00 to 05) Most Recent (DO Channel) Status (FRelay) The output in response to the command “FRelay,0” is shown below.
2.10 ASCII Output Format 2.10.3 1 Internal Switch Status (FRelay) The output in response to the command “FRelay,1” is shown below.
2.10 ASCII Output Format 2.10.4 Users Who Are Currently Logged In (FUser) The output in response to the command “FUser,0” is shown below. Syntax EA p_l_uuuuuuuuuuuuuuuuuuuu_abcdefghijk EN p l uuuuuuuuuuuuuuuuuuuu abcdefghijk 2-60 Login mode M Via general communication W Via Web (HTTP server) F Via FTP server S RS-232 or RS-422/485 D Via front panel User level A Administrator U User User name (fixed to 20 characters. Unused character positions are filled with spaces.
2.10 ASCII Output Format 2.10.5 1 All Users Who Are Currently Logged In (FUser) The output in response to the command “FUser,1” is shown below.
2.10 ASCII Output Format 2.10.6 Instrument Address (FAddr) The output in response to the command “FAddr,IP” is shown below. Syntax EA IP_Address_¯_¯_¯:xxx.xxx.xxx.xxx Subnet_Mask_¯_¯_:xxx.xxx.xxx.xxx Default_Gateway_:xxx.xxx.xxx.xxx Primary_DNS_¯_¯_:xxx.xxx.xxx.xxx Secondary_DNS_¯_:xxx.xxx.xxx.xxx Host_¯_¯_¯_¯_¯_¯:yyyyyyyyyyyyyyyyyyyy… Domain_¯_¯_¯_¯_¯:zzzzzzzzzzzzzzzzzzzz… EN xxx yyy... zzz...
2.10 ASCII Output Format 2.10.7 1 GX status (FStat) The output in response to the command “FStat,0” is shown below. Syntax 2 aaa bbb ccc ddd Commands and Responses EA aaa.bbb.ccc.
2.10 ASCII Output Format Status Information 4 Bit Name 0 1 Medium access complete 2 3 4 5 6 7 2.10.8 Description Set to 1 when a display, event, manual-sample, report, or screen-image data file is saved to the external storage medium. Set to 1 when settings have been successfully saved or loaded. Report generation complete Set to 1 when report generation is complete. Timeout Set to 1 when a timer expires. - Alarm Summary (FLog) The output in response to the command “FLog,ALARM” is shown below.
2.10 ASCII Output Format 2.10.9 1 Message Summary (FLog) The output in response to the command “FLog,MSG” is shown below.
2.10 ASCII Output Format 2.10.10 Event log (FLog) The output in response to the command “FLog,EVENT” is shown below.
2.10 ASCII Output Format 1 2.10.11 Error Log (FLog) The output in response to the command “FLog,ERROR” is shown below. Syntax 2 Commands and Responses EA yyyy/mo/dd_hh:mm:ss_nnn_uuu…u … EN App yyyy/mo/dd_hh:mm:ss Time of error occurrence yyyy Year (1900 to 2099) mo Month (01 to 12) dd Day (01 to 31) hh Hour (00 to 23) mm Minute (00 to 59) ss Second (00 to 59) nnn Error code (001 to 999) uuu…u Error message (fixed to 80 characters. Unused character positions are filled with spaces.
2.10 ASCII Output Format 2.10.12 Address Setting Log (FLog) The output in response to the command “FLog,DHCP” is shown below. Syntax EA yyyy/mo/dd_hh:mm:ss_kkk…k_mmm…m … EN yyyy/mo/dd_hh:mm:ss Time of occurrence yyyy Year (1900 to 2099) mo Month (01 to 12) dd Day (01 to 31) hh Hour (00 to 23) mm Minute (00 to 59) ss Second (00 to 59) kkk…k Type (fixed to 15 characters. Unused character positions are filled with spaces. See table below.) mmm…m Message (fixed to 20 characters.
2.10 ASCII Output Format 1 2.10.13 General Communication Log (FLog) The output in response to the command “FLog,General” is shown below. Syntax 2 yyyy/mo/dd_hh:mm:ss Time of command Tx/Rx yyyy Year (1900 to 2099) mo Month (01 to 12) dd Day (01 to 31) hh Hour (00 to 23) mm Minute (00 to 59) ss Second (00 to 59) nn Connection ID s0 Serial (general) e0 Ethernet connection #0 (general) e1 Ethernet connection #1 (general) e2 Ethernet connection #2 (general) uuu…u User name (fixed to 20 characters.
2.10 ASCII Output Format 2.10.14 Modbus Communication Log (FLog) The output in response to the command “FLog,Modbus” is shown below.
2.10 ASCII Output Format Detail* BAD_NUM BAD_CNT * “_” expresses an underscore. 2.10.15 FTP Client Log (FLog) The output in response to the command “FLog,FTP” is shown below.
2.10 ASCII Output Format 2.10.16 SNTP (Time Adjustment) Client Log (FLog) The output in response to the command “FLog,SNTP” is shown below.
2.10 ASCII Output Format 1 2.10.17 E-Mail Client Log (FLog) The output in response to the command “FLog,MAIL” is shown below.
2.10 ASCII Output Format 2.10.18 Web Log (FLog) The output in response to the command “FLog,WEB” is shown below. Syntax EA yyyy/mo/dd_hh:mm:ss_xxx.xxx.xxx.xxx_mmmmmmmm_uuu…u_ccc_nnn… … EN yyyy/mo/dd_hh:mm:ss Time of error occurrence yyyy Year (1900 to 2099) mo Month (01 to 12) dd Day (01 to 31) hh Hour (00 to 23) mm Minute (00 to 59) ss Second (00 to 59) xxx.xxx.xxx.
2.10 ASCII Output Format 1 2.10.19 External Storage Medium and Internal Memory File List (FMedia) The output in response to the command “FMedia,DIR” is shown below. Syntax 2 yyyy/mo/dd_hh:mm:ss lll…l fff… Time of file generation yy Year (1900 to 2099) mm Month (01 to 12) dd Day (01 to 31) hh Hour (00 to 23) mi Minute (00 to 59) ss Second (00 to 59) File size (fixed to 10 characters. Unused character positions are filled with spaces.) For directories,
is output. File name 2.10.2.10 ASCII Output Format 2.10.21 Setting Data (FCnf) The output in response to the command “FCnf” is shown below. Syntax EA EN The setting data is output in the format of the response to a setting query. 2.10.22 Decimal Place and Unit Information (FChInfo) The output in response to the command “FChInfo” is shown below.
2.10 ASCII Output Format 1 2.10.23 System Configuration (FSysConf) The output in response to the command “FSysConf” is shown below.
2.10 ASCII Output Format 2.10.24 Instrument Manufacturer (_MFG) The output in response to the command “_MFG” is shown below. Outputs the instrument manufacturer. Output Example EA YOKOGAWA EN 2.10.25 Instrument’s Product Name (_INF) The output in response to the command “_INF” is shown below. Output Example EA 'GX20/GP20',123456789,xx-xx-xx-xx-xx-xx,Rx.xx.xx EN ‘GX20/GP20’ 123456789 xx-xx-xx-xx-xx-xx Rx.xx.
2.10 ASCII Output Format 1 2.10.27 Instrument’s Firmware Version Information (_VER) The output in response to the command “_VER” is shown below. Output Example 2 B999999 Firmware part number (first line), Web program part number (second line) Firmware version (first line), Web program version (second line) Rx.xx.xx 2.10.28 Instrument’s Option Installation Information (_OPT) The output in response to the command “_OPT” is shown below.
2.10 ASCII Output Format 2.10.29 Instrument’s Temperature Unit and Daylight Saving Time Installation Information (_TYP) The output in response to the command “_TYP” is shown below. Output Example EA DST,’Summer time/Winter time’ DEGF,’degF’ EN DST DEGF Daylight saving time enabled Fahrenheit temperature unit enabled 2.10.30 Instrument’s Error Number Information (_ERR) The output in response to the command “_ERR” is shown below.
2.10 ASCII Output Format 1 2.10.31 Instrument’s Unit Configuration Information (_UNS or _UNR) The output in response to the command “_UNS” or “_UNR” is shown below. Syntax 2 App Output Example EA Main,0,'GX20-1J',123456789,xx-xx-xx-xx-xx-xx,R1.01,/MT /C2,0,10,0 EN One line (p1 to p10) contains configuration information of a single unit. pn Value Description p1 Main, Sub Unit dependency (main or sub) information. Fixed to “Main.” p2 0,1 Unit address number. Fixed at 0.
2.10 ASCII Output Format 2.10.32 Instrument’s Module Configuration Information (_MDS or MDR) The output in response to the command “_MDS” or “_MDR” is shown below. Syntax EA p1,p2,p3,p4,p5,p6,p7,p8,p9,p10,p11 p1,p2,p3,p4,p5,p6,p7,p8,p9,p10,p11 … EN Output Example EA Main,0,0,’AI’,1234567,R1.02,,0,10,0,xxx Main,0,1,’DO’,1234567,R1.01,,0,0,16,xxx EN One line (p1 to p10) contains configuration information of a single module.
2.11 Format of the Data Block of Binary Output 1 This section explains the data that is stored in the data block in the binary output of data output response. Most Recent Channel Data (FData) Configuration The output in response to the command “FData,1” is shown below. Outputs the most recent I/O channel, math channel, and communication channel data. The figure below shows the structure of the output data. Data is stored in “Block 1.
2.11 Format of the Data Block of Binary Output Additional Information (64 bits) Bit 0: Daylight saving time (0: standard time; 1: daylight saving time) Data Type (4 bits) Indicates the data type. (1: 32 bit integer; 2: 32 bit floating point) Channel Type (4 bits) Indicates the channel type. Value Channel Type 1 I/O channel 2 Math channel 3 Communication channel Status (8 bits) Indicates the channel status.
2.11 Format of the Data Block of Binary Output 1 The eight bit values of alarm 1 to alarm 4 are described in the table below. Bit Value Description 0 to 5 0 No alarm 1 High limit alarm 2 Low limit alarm 3 Difference high limit alarm 4 Difference low limit alarm 5 High limit on rate-of-change alarm 6 Low limit on rate-of-change alarm 7 Delay high limit alarm 8 Delay low limit alarm 6 0 No alarm is activated. 1 An alarm is activated.
2.11 Format of the Data Block of Binary Output 2.11.2 Channel FIFO Data (FFifoCur) Configuration The output in response to the command “FFifoCur,0” is shown below. Outputs the I/O channel, math channel, and communication channel FIFO data. Data is stored in “Block 1” shown below. 2 bytes Number of blocks 2 bytes Number of bytes Block 1 Block 2 Block N-1 Block N Number of Blocks (16 bits) Number of stored blocks.
2.11 Format of the Data Block of Binary Output 2.11.3 1 FIFO Data Read Range (FFifoCur) The output in response to the command “FFifoCur,1” is shown below. Outputs FIFO data read position information.
Blank
Appendix Appendix 1 ASCII Character Codes 1 The ASCII character code table is shown below.
Appendix 2 Login Procedure To communicate using the general communication feature, you must log in to the GX/GP from your PC. If you complete the procedure successfully up to “Login complete” in the following figure, you will be able to use the commands.
Appendix 2 Login Procedure 1 When Not Using the Login Function Connect E1: 732 No 2 Within the number of connections? Disconnect E0 App Appendix Login complete Start End Judge E1: 401 Response from the GX/GP (message omitted) Code Response IM 04L51B01-17EN App-3
Appendix 3 Output Flow Chart of External Storage Medium Files and File Lists Example for Outputting File aaaa.dtd The flow chart for outputting file aaaa.dtd in the DATA0 directory on the external storage medium is shown below. START Send command FMedia,GET,/DRV0/DATA0/aaaa.dtd,0,-1 Receive response (1) If the binary header flag (bit 0) is 0, there is more data. If it is 1, data transmission is complete.
Appendix 3 Output Flow Chart of External Storage Medium Files and File Lists 1 Example for Outputting a File List The flow chart for outputting the list of files in the DATA0 directory on the external storage medium is shown below. 2 START App Send command Appendix FMedia,DIR,/DRV0/DATA0/,0,-1 Receive response Are there more file lists? (1) Obtain the number of received files (2) (1) If there are no more files, EA[crlf]EN[crlf] is output. (2) Count the number of lines in the output file list.
Appendix 4 FIFO Data Output Flow Chart Overview of the FIFO Buffer The GX/GP internal memory is equipped with a dedicated FIFO (First-In-First-Out) buffer for outputting measured data. Measured data is written to the buffer at every scan interval. The PC can continuously retrieve the most recent measured data from the FIFO buffer. The size of the internal memory allocated for the FIFO buffer varies depending on the model.
Appendix 5 Check Sum Calculation Method 1 The check sum of binary data is calculated using an algorithm like the one shown below.
Blank
