Hioki 3169-20 User manual

RS-232C
INSTRUCTION MANUAL
For 3169-20/21

i
Contents
Contents
Introduction.................................................................................1
Safety Notes...............................................................................1
Chapter 1 Specification ______________________ 3
Chapter 2 Details on Interface RS-232C _________ 5
2.1 Communication Methods .............................................5
2.1.1 Message Format .............................................................6
2.1.2 Output Queue and Input Buffer .....................................10
2.1.3 Setting Command .........................................................11
2.2 Flow Control ...............................................................12
Chapter 3 Command Function________________ 15
3.1 Command Reference .................................................15
3.1.1 Command Reference Format ........................................16
3.2 Command List ............................................................65
3.2.1 Command List ...............................................................65
3.2.2 Command Hierarchical Structure ..................................70
3.2.3 Enabled Commands by Status ......................................72
3.2.4 Initialization Item List .....................................................75
3.2.5 RS-232C Troubleshooting .............................................76

ii
Contents

1
Introduction
This instruction manual provides details of the RS-232C communica-
tions interface for the 3169-20/21 CLAMP ON POWER HiTESTER.
For the specifications of the RS-232C and connection with a PC, see
Chapter 9 "Using the Instrument with a Computer" (145 page), of the
instruction manual.
Safety Notes
This manual contains information and warnings essential for safe
operation of the product and for maintaining it in safe operating condi-
tion. Before using the product, be sure to carefully read the following
safety notes.
Safety Symbols
The following symbols in this manual indicate the relative importance
of cautions and warnings.
To connect the 3169-20/21 to a PC, use the optional 9612 RS-232C
CABLE.
Indicates that incorrect operation presents an
extreme hazard that could result in serious injury or
death to the user.
Indicates that incorrect operation presents a signifi-
cant hazard that could result in serious injury or
death to the user.
Indicates that incorrect operation presents a possibil-
ity of injury to the user or damage to the product.
Advisory items related to performance or correct
operation of the product.

2

3
Transfer Method
Connector Specifications
Specification Chapter 1
Transfer method Full duplex
Synchronous method Asynchronous communication method
Baud rate 2400/ 9600/ 19200/ 38400 bps
Data length 8 bits
Parity check None
Stop bit 1
Message Terminators
(Delimiter)
CR+LF, CR
Flow control None, XON/XOFF, RTS/CTS
Pin Functions CCITT EIA JIS Signal
Name Pin
Circuit No. Code Addr. Code Addr.
2Receive Data 104 BB RD RxD 2
3Send Data 103 BA SD TxD 3
5Signal Ground 102 AB SG GND 5
7Request to Send 105 CA RS RTS 7
8Clear to Send 106 CB CS CTS 8

4

Communication Methods
5
Various messages are supported in order to control the 3169-20/21
through the interface.
Messages are divided into program messages, which are sent to the
3169-20/21 from the PC, and response messages, which are sent to
the PC from the 3169-20/21.
The message system has the following hierarchy.
Details on Interface
RS-232C Chapter 2
2.1 Communication Methods
3169-20/21
Program messages
Response messages
PC
Program messages
Response messages
Answer messages
Messages
Command messages
Query messages

6
Communication Methods
2.1.1 Message Format
Program Message Program messages can be divided into either command messages or
query messages.
• Command Message
Orders for controls of the unit, such as for making measurement condition
settings or for reset or the like.
(example)
Command message which sets the frequency
:FREQUENCY 60
• Query Message
Orders for responses relating to results of operation, results of measure-
ment, or the state of device settings.
(example)
Queries the current frequency
:FREQUENCY?
Response
messages
After a query message has been received, a response message is
produced the moment that its syntax has been checked.
Whether or not headers are prefixed to response messages is set by
the HEADer command.
The response-message unit parameter can be changed from a semi-
colon (;) to a comma (,) using the :TRANsmit:SEParator com-
mand. The parameter is set to a semicolon (;) by default.
Header ON
U1_INST[V] +101.25E+0;I1_INST[A]_1 +50.246E+0
Header OFF +101.25E+0;+50.246E+0
Answer Message An answer message is a character string created after one line of data
(up to the terminator) from a PC has been analyzed and processed.
This string is returned to the PC. Using this data, the 3169-20/21 is
synchronized with the PC.
Header portion Space Data portion
Header portion Question mark

Communication Methods
7
Command Syntax The names of commands for the 3169-20/21 are as far as possible
mnemonic. Furthermore, all commands have a long form, and an
abbreviated short form.
In command references in this manual, the short form is written in
upper case letters, and then this is continued in lower case letters so
as to constitute the long form.
Either of these forms will be accepted during operation, but intermedi-
ate forms will not be accepted. Further, during operation both lower
case letters and upper case letters will be accepted without distinction.
MEASure? OK (long form)
MEAS? OK (short form)
MEASU Error
MEA Error
Response messages generated by the 3169-20/21 are in long form
and in upper case letters.
Headers It is essential to prefix headers to program messages.
The response messages to the :CARD:PICKout? and :MEM-
ory:PICKout? queries will not have a header, regardless of whether
the queries have a header.
(1) Command program headers
There are two types of command: simple commands and compound
commands.
• Simple command header
This header is a sequence of letters and digits.
:HOLD
• Compound command header
This header is made up from a plurality of simple command type
headers marked off by colons " :".
:CARD:FORMat
(2) Query program headers
These are for commands used for interrogating the unit about the
results of operations, about measured values, or about the current
states of settings for the unit. As shown by the following examples,
they can be recognized as queries by a question mark "?" appearing
after the program header.
:FREQuency?
:VT?
Message
Terminators
(Delimiter)
The 3169-20/21 supports the CR+LF and CR message terminators.
In addition, the 3169-20/21 sends response messages in conjunction
with the CR+LF or CR message terminator.

8
Communication Methods
Separators
(1) Message unit separator
A semicolon ";" is used as a message unit separator when it is
desired to set out several messages on a single line.
Do not link :CARD:PICKout? and :MEMory:PICKout? queries with
other commands or queries.
(2) Header separator
In a message which has a header and data, a space " " is used as the
header separator to separate the header from the data.
(3) Data separator
If a message has several data items, commas are required as data
separators for separating these data items from one another.
Data Formats The main unit uses character string data and decimal numeric data,
and the type used varies according to the command in question.
(1) Character data
The character data can be either alphabetic characters or numerals.
Although in character data either upper case letters or lower case let-
ters are accepted, response messages output by the main unit are
always in upper case letters.
(2) Decimal data
The numeric data values are all represented in decimal, in three for-
mats identified as NR1, NR2 and NR3, and each of these can appear
as either a signed number or an unsigned number. Unsigned numbers
are taken as positive.
Further, if the accuracy of a numerical value exceeds the range with
which the main unit can deal, it is rounded off. (5 and above is rounded
up; 4 and below is rounded down).
• NR1 integer data .................. (examples: +12, -23, 34)
• NR2 fixed point numbers ......(examples: +1.23, -23.45, 3.456)
• NR3 floating point numbers ..(examples: +1.0E-2, -2.3E+4)
The term "NRf format" includes all these three formats.
When the main unit is receiving it accepts NRf format.
For the response data, the format is specified for each commands and
the data in specified format is transmitted. The VT ratio will be set to 5
in all the examples below.
:VT 5
:VT 5.2
:VT 4.998E2
:VT 2.0;:VOLTage:RANGe 150;:BEEPer ON
:VOLTage:RANGe 300
:CARD:PICKout? filename,1,1000
:INTERVAL 10S

Communication Methods
9
Abbreviation of
Compound
Commands
When several compound commands have a common head portion, for
example :STARt:TIME and :STARt:TIME?, then, when and only
when writing them directly following on from one another, this common
portion (:STARt: in this example) can be omitted from each com-
mand.
This common portion is called "the current path", by analogy with the
general concept of the current directory in the directory structure of
UNIX or MS-DOS, and until it is cleared the analysis of following com-
mands is performed by deeming them to be preceded by the current
path which has been curtailed in the interests of brevity. This manner
of using the current path is shown in the following example:
Normal expression
:STARt:TIME 2001,12,10,10,15;:STARt:TIME?
Abbreviated expression
:STARt:TIME 2001,12,10,10,15;TIME?
The current path is cleared when the power is turned on, when a colon
“:” appears at the start of a command, and when a message termina-
tor is detected.
It is not necessary to prefix a colon ":" at the start of headers of simple
commands and compound commands. However, in order to prevent
confusion with abbreviated forms and mistakes in operation, it is rec-
ommended practice always to prefix ":" to headers.
On the 3169-20/21, the current paths are as follows:
:AOUT
:CARD
:CURRent
:DATAout
:DISPlay
:FILEname
:MEMory
:RS232c
:STARt
:STOP
:TIME
:TRANsmit
:VOLTage
This becomes the current path, and can be curtailed from the
following messages.

10
Communication Methods
2.1.2 Output Queue and Input Buffer
Output Queue Response messages are stored in the output queue. If data is read out
on the PC, the queue will be cleared. The output queue is also cleared
in the following cases:
• When the power is turned off and turned on again.
• When a query error is generated.
The 3169-20/21 has an output queue of 50 K bytes capacity. If the
response messages overflow this limit of 50 K bytes, a query error is
generated, and the output queue is cleared.
Input Buffer The 3169-20/21 has an input buffer of 2048 bytes capacity.
When data exceeding 2048 bytes is transmitted and the buffer
becomes full, data will be deleted until analysis of the input buffer is
complete. Make sure that each command line is shorter than 2048
bytes.
The length of a single command should be less than 2048 bytes.

Communication Methods
11
2.1.3 Setting Command
The following setting commands are enabled only when the time-
series measurement is stopped and Hold is OFF. However, queries
are enabled even when the measurement data is held.
:AOUT:CH1
:AOUT:CH2
:AOUT:CH3
:AOUT:CH4
:AOUT:RATE
:AVEraging
:CIRcuitnum
:CLOCk
:CT
:CURRent:RANGe
:DATAout:COPY:MEDIa
:DATAout:ITEM
:DATAout:MEDIa
:DATAout:WAVE
:FREQuency
:ID
:INTErval
:LANGuage
:OPERationvar
:PT
:RS232c:CONNect
:SAMPling
:START:METHod
:STARt:TIME
:STOP:METHod
:STOP:TIME
:VOLTage:RANGe
:VT
:WIRing
Answer Message Upon receiving a command, the 3169-20/21 returns to the PC an
answer message indicating whether the command has been success-
fully received. When creating a program, make sure the PC accepts
this answer message.
An answer message contains one of the following contents (character
strings), according to the status.
ALL RIGHT will not be returned upon receipt of the RS232:BAUD
command or any query. For details, see Command Reference.
Status Message
Operating normally ALL RIGHT
Errors Execution error EXECUTE ERROR
Command error COMMAND ERROR
Query error QUERY ERROR
Device-depen-
dent error
DEVICE ERROR

12
Flow Control
If the input buffer of a device has small capacity, the device may not be
able to receive all data. To avoid this problem, a receiving device must
send a signal to a sending device to stop sending data before the input
buffer becomes full. This is referred to as "flow control." There are two
types of flow control: hardware handshaking and software handshak-
ing.
(1) Hardware Handshaking
Data flow is controlled by turning ON and OFF the RTS (RS) or CTS
(CS) signal line.
• Receiving
When the input buffer is more than 3/4 full, RTS is set to Low.
When the input buffer is 1/4 full or less, RTS is set to Hi.
• Sending
When CTS = low, the sending device stops sending data.
When CTS = Hi, the sending device sends data.
(2) Software Handshaking
Data flow is controlled by sending XON and XOFF codes.
• Receiving
When the input buffer is more than 3/4 full, XOFF (13H) is sent.
When the input buffer is 1/4 full or less, XON (11H) is sent.
• Sending
If the sending device receives 13H (XOFF), it stops sending data.
If the sending device receives 11H (XON), it sends data.
2.2 Flow Control
• The input buffer of the 3169-20/21 has a capacity of 2048 bytes. The
output queue size is 50 KB.
• Flow control for the 3169-20/21 is normally set to OFF. The flow-con-
trol setting is selectable from among four presets: OFF, RTS/CTS,
XON/XOFF, and Both RTS/CTS and XON/XOFF.

Flow Control
13
(3) Precautions on using :CARD:PICKout? and :MEMory:PICK-
out?
These queries are used for the transmission of data from the PC card
or internal memory. Since a large amount of data may be transmitted,
executing queries without flow control may result in data not being
transmitted correctly. Before executing these queries, set flow control
between the 3169-20/21 and PC to XON/XOFF, then perform mea-
surement. For binary data files, set flow control to RTS/CTS.
(4) Flow-Control Setting Commands
Use these commands when measurement has been performed with
flow control set to OFF and :MEMory:PICKout? is to be executed
with flow control. Flow control setting can be changed using the follow-
ing commands without affecting the saved data.
:RS232C:FLOW <characters>
<Characters> Flow Control
XONXOFF XON/XOFF
RTSCTS RTS/CTS
BOTH Both XON/XOFF and RTS/CTS
OFF OFF
• After the response message has been received, set flow control
back to OFF if necessary.
• This setting can be changed when time-series measurement is not
performed and display not held.
• The current setting can be checked using :RS232C:FLOW?.

14
Flow Control

Command Reference
15
This chapter explains each command.
Command
Function Chapter 3
3.1 Command Reference

16
Command Reference
3.1.1 Command Reference Format
Shows the command description.
Describes the message syntax.
Explains the command data or
response message.
Explains the message.
Illustrates the actual command
application. (Generally, the
explanation is directed to the “HEAD-
ER ON” case, except for the HEAD-
ER command.)
Explains command errors.
Provides notes on using the
command.
Setting and Inquiry of Setting File Name
Syntax Command
Query
Response
:FILEname:SET <characters>
:FILEname:SET?
:FILENAME:SET <characters>
(Headers: ON)
<characters>
(Headers: OFF)
<characters> = Character-string data with up
to 8 characters size
Function Command Sets the name of a setting file.
Clears the set file name if the command does not
have <characters>.
Query Returns the set setting file name.
Example Command
Response
:FILE:SET 69SET00
ALL RIGHT
Query
Response
:FILE:SET?
69SET00
Sets the setting file name to "69SET00".
Error A device-dependent error will occur in the following
cases:
• Execution of this command is attempted while
the instrument is standing by for or performing
time-series measurement.
Note The extension (.SET) is added automatically.
The file will be saved as "69SET**" (** is a
number) after time-series measurement has
started, and provided that the specified file
name already exists on the medium.
Shows the command message that contains numerical or character parameters.
<numeric>: Numeric data values
(NR1) integer data
(NR2) fixed point numbers
(NR3) floating point numbers
(NRf) format that contains NR1, NR2, and NR3
<characters>: Character string data
• A query is an inquiry for acquiring various data, such as the current
instrument settings and measurement results. If an error occurs in a
query, a response message to the query will not be created.
• In case of a system error, a query will not be executed and the error
will be detected as a device-dependent error.