Page 1
RGB LASER LUMINANCE METER TM6104 OPTICAL POWER METER This manual explains the communication commands for Models TM6102 RGB Laser Illuminance Meter, TM6103 RGB Laser Luminance Meter, and TM6104 Optical Power Meter. Please refer to the instruction manual for Model TM6102/TM6103/TM6104 for details regarding communication settings.
Contents 1 Introduction ............................. 1 Message Format ............................. 1 Output Queue and Input Buffer ......................5 Event Registers ............................6 Initialization Items ..........................8 Command Execution Time ........................8 Errors During Communications ......................8 Color Expressions ..........................9 Unit of Radiometric Quantity ........................ 9 Unit of Photometric Quantity ........................
Page 4
:DARK:AVERaging ........................24 :DARK:JUDGment ......................... 24 (10) Dark Estimation ......................... 26 :DARK:ESTimate ........................... 25 :DARK:ESTimate:RESult ......................25 (11) Dark Value Acquisition State ....................28 :DARK:STATe:# ..........................26 (12) Clearing Dark Value ........................28 :DARK:CLEar:# ..........................26 (13) Normal Measurement Settings ....................28 (a) Average Times ...........................
1 Introduction In this publication, items relevant only to the TM6102, TM6103, and TM6104 are indicated as “the instrument.” Various messages are supported for controlling the instrument through the interfaces. Messages can be either program messages, sent from the controller such as PC to the instrument, or response messages, sent from the instrument to the controller.
Page 7
Response Messages When a query message is received, its syntax is checked and a response message is generated. If an error occurs when a query message is received, no response message is generated for that query. Command Syntax Command names are chosen to mnemonically represent their function, and can be abbreviated.
Page 8
Message Terminators This instrument recognizes the following message terminators (delimiters): • CR+LF Separators (1) Message Unit Separator Multiple messages can be written in one line by separating them with semicolons “;”. :RANGE:R 1 IDN? • When messages are combined in this way and if one command contains an error, all subsequent messages up to the next terminator will be ignored.
Page 9
Data Formats The instrument uses character data, decimal numeric data and character string data depending on the command. (1) Character Data Character data always begins with an alphabetic character, and subsequent characters may be either alphabetic or numeric. Character data is not case-sensitive, although response messages from the instrument are only upper case.
Compound Command Header Omission When several commands having a common header are combined to form a compound command :RANGe:AUTO:R :RANGe:AUTO:B (e.g., ) if they are written together in sequence, the common :RANGe:AUTO portion (here, ) can be omitted after its initial occurrence. This common portion is called the “current path”...
Event Registers Standard Event Status Register (SESR) The Standard Event Status Register is an 8-bit register. The Standard Event Status Register is cleared in the following situations: • When a *CLS command is executed • When an event register query ( *ESR? ) is executed •...
Page 12
Device-Specific Event Status Registers This instrument provides Event Status Register 0 for controlling events. The Event Status Register is an 8-bit register. Event Status Registers 0 is cleared in the following situations: • When a *CLS command is executed •...
RGB: RGB mixed light (Three colors, R, G, and B, are mixed.) Unit of Radiometric Quantity The unit of the radiometric quantity is omitted in descriptions. Each instrument uses the unit as described below. TM6102: [W/m TM6103: [W/sr•m TM6104: [W] Unit of Photometric Quantity The unit of the photometric quantity is omitted in descriptions.
2 Cautions on Communication Program Creation The TCP/IP communication performs the process so that large data is sent efficiently. Therefore, when small data such as a command to control the instrument is sent, the send process may not be performed until the size of the send data reaches a certain level.
3 Message List Messages Data Description [ ]: Omissible [ ]: Omissible, ( ): Response data Standard Commands (<Manufacturer name>,<Model name>,<Serial number>,<Software Queries the Device ID (Identify code). *IDN? version>) Initializes the device. *RST (<PASS/FAIL>) Initiates a self-test and queries the result. *TST? Requests the measurement start.
Page 17
Messages Data Description [ ]: Omissible [ ]: Omissible, ( ): Response data Measurement Range <1/0/ON/OFF> Sets the auto range function. :RANGe:AUTO:# (# is R, G, or B) (<1/0 >) Queries the auto range function. :RANGe:AUTO:#? (# is R, G, or B) <Measurement range number>...
Page 18
Messages Data Description [ ]: Omissible [ ]: Omissible, ( ): Response data (<Gain value>) Queries the gain value of the radiometric quantity. :SCALe:RADiometry:GAIN:DATA:#? (# is R, G, or B) <1/0/ON/OFF> Sets the chromaticity (x,y) offset function. :SCALe:XY:OFFSet (<1/0 >) Queries the chromaticity (x,y) offset function.
4 Message Reference Message Reference Interpretation < >: Indicates the contents (character or numeric parameters) of the data portion of a message. Character parameters are returned as all capital letters. Numeric Parameters : • NRf Number format may be any of NR1, NR2 and NR3 •...
Query Response <Manufacturer name>,<Model name>,<Serial number>,<Software version> Example *IDN? HIOKI,TM6102,123456789,V1.00 The Device ID is HIOKI TM6102, 123456789, software version 1.00. The <Model name> will be the following. For TM6102: TM6102 For TM6103: TM6103 For TM6104: TM6104 (2) Internal Operation Commands...
(3) Synchronized Commands Set OPC Bit of SESR when Finished with All Pending Operations *OPC Command Syntax Description Sets OPC (bit 0) of SESR (Standard Event Status Register) to 1 when all commands prior to the *OPC command have finished processing. Respond with ASCII “1”...
Device-Specific Commands (1) Event Status Register Query Event Status Register 0 Syntax :ESR0? Query Response <0/2/4/6 (NR1)> bit7 bit6 bit5 bit4 bit3 bit2 bit1 bit0 Description Example :ESR0? The sampling complete event and measurement complete event occurred in the instrument. (2) Communications Settings Set and Query IP Address in User Setting Mode Command...
Set and Query Subnet Mask in User Setting Mode Command :SYSTem:COMMunicate:LAN:SMASk Syntax <Subnet mask> Query :SYSTem:COMMunicate:LAN:SMASk? Response < Subnet mask > < Subnet mask > = nnn,nnn,nnn,nnn Command Description Sets the subnet mask. Query Queries the currently set subnet mask. Example :SYST:COMM:LAN:SMAS 255,255,255,0 :SYST:COMM:LAN:UPDate...
(3) Trigger Set and Query Trigger Source Command Syntax :TRIGger:SOURce <BUS/ EXTernal> Query :TRIGger:SOURce? Response <BUS/ EXT> <BUS> = Communication triggering <EXTernal> = External triggering Command Description Sets the trigger source. When the command is accepted, the measured value is cleared and the instrument enters the non-measurement state.
(4) Measurement Mode Set and Query Measurement Mode Command Syntax :MODE <NORMal/DARK/PULSe> Query :MODE? Response <NORM/DARK/PULS> <NORMal> = Normal Measurement <DARK> = Dark Measurement <PULSe> = Modulation Frequency Measurement Command Description Sets the measurement mode. When the command is accepted, the measured value is cleared and the instrument enters the non-measurement state.
(6) Modulated Light Function Set and Query Modulated Light Function Command Syntax :PULSe <1/0/ON/OFF> Query :PULSe? Response <1/0 (NR1) > Command Description Sets the modulated light function. When the command is accepted, the measured value is cleared and the instrument enters the non-measurement state. Query Queries the currently set modulated light function.
(7) Measurement Range Set and Query Auto Range Function (# is R, G, or Syntax Command :RANGe:AUTO:# <1/0/ON/OFF > Query :RANGe:AUTO:#? Response < 1/0 (NR1) > Description Command Sets the auto range function. When the command is accepted, the measured value is cleared and the instrument enters the non-measurement state.
Queries the maximum measurable radiometric quantity when the specified centroid wavelength is measured in the specified measurement range. Example :RANG:AREA:R? 16,632.8 (For TM6102) 5.09288E-02 When 632.8 nm is measured in red range 16, the maximum measurable radiometric quantity is 50.9288 [mW/m :RANG:AREA:G? 16,532 5.90504E-02...
(8) Setting for Color-matching Functions Set and Query Color-matching Functions Command Syntax :ANGLe <Setting for Color-matching Functions (NRf) > Query :ANGLe? Response <Setting for Color-matching Functions (NR1) > <Setting for Color-matching Functions> = 2,10[°] Command Description Sets the color-matching function setting (2° or 10°). When the command is accepted, the measured value is cleared and the instrument enters the non-measurement state.
Query Set Number of Average Times of Dark Measurement Command Syntax :DARK:AVERaging <Average Times (NRf)> Query :DARK:AVERaging? Response <Average times(NR1)> <Average times> = 1 to 100 Command Description Sets the number of average times of the dark measurement. When the command is accepted, the measured value is cleared and the instrument enters the non-measurement state.
(10) Dark Estimation Set and Query Dark Estimation Function Command Syntax :DARK:ESTimate <1/0/ON/OFF > Query :DARK:ESTimate? Response <1/0(NR1)> Command Description Sets the dark estimation function. If the modulation frequency (:PULSe:FREQuency) is changed when this setting is set to ON, the dark value estimation is executed. When the command is accepted, the measured value is cleared and the instrument enters the non-measurement state.
Query Dark Estimation Result Syntax Query :DARK:ESTimate:RESult? Response <1/0(NR1)> Description Command Query Queries the last dark estimation result. Response is 1.: PASS judgment. The last dark estimation is succeeded. Response is 0.: FAIL judgment. The last dark estimation is failed. Example Enable the dark estimation function.
(11) Dark Value Acquisition State Query Dark Value Acquisition State (# is R, G, or Query Syntax :DARK:STATe:#? <Measurement range number (NRf) > Response <1/0(NR1)> <Measurement range number> = 1 to 16 Description Command Query Queries the dark value acquisition state. Response is 1.: Already acquired.
(b) White Balance Adjustment Assistance Function Set and Query White Balance Adjustment Assistance Function Command Syntax :TARGet <1/0/ON/OFF > Query :TARGet? Response <1/0 (NR1) > Command Description Sets the white balance adjustment assistance function. When the command is accepted, the measured value is cleared and the instrument enters the non-measurement state.
Example Set the target value of the photometric quantity to 10000 ± 10 [lx]. :TARG:DEV:PHOT 10000,10 (For TM6102) :TARG:DEV: PHOT? 1.00000E+04, 1.00000E+01 • The tolerance of the photometric quantity that is larger than the target value of the Note photometric quantity cannot be set.
(c) Centroid Wavelength Input Mode (Correction Function) Set and Query Centroid Wavelength Input Mode (# is R, G, or Syntax :SCALe:WAVelength:# Command <1/0/ON/OFF > :SCALe:WAVelength:#? Query Response <1/0(NR1)> Description Command Sets the centroid wavelength input mode. When the centroid wavelength input mode is enabled, the measured value of the centroid wavelength becomes the value set by :SCALe:WAVelength:DATA:#.
(d) Centroid Wavelength Offset (Correction Function) Set and Query Centroid Wavelength Offset Function Command Syntax :SCALe:WAVelength:OFFSet <1/0/ON/OFF > Query :SCALe:WAVelength:OFFSet? Response <1/0(NR1)> Command Description Sets the centroid wavelength offset function. When the centroid wavelength offset function is enabled, the value set :SCALe:WAVelength:OFFSet:DATA:# is added to the measured value of the centroid wavelength.
(e) Radiometric Quantity Gain (Correction Function) Set and Query Radiometric Quantity Gain Function Command Syntax :SCALe:RADiometry:GAIN <1/0/ON/OFF > Query :SCALe:RADiometry:GAIN? Response <1/0(NR1)> Command Description Sets the radiometric quantity gain function. When the radiometric quantity gain function is enabled, the value set :SCALe:RADiometry:GAIN:DATA:# is added to the measured value of the radiometric quantity.
(f) Chromaticity (x,y) Offset (Correction Function) Set and Query Chromaticity (x,y) Offset Function Command Syntax :SCALe:XY:OFFSet <1/0/ON/OFF > Query :SCALe:XY:OFFSet? Response <1/0(NR1)> Command Description Sets the chromaticity (x,y) offset function. When the chromaticity (x,y) offset function is enabled, the value set :SCALe:XY:OFFSet:DATA:# is added to the measured value of the chromaticity (x,y) of the RGB mixed light.
(g) Radiometric Quantity Gain (Correction Function) Set and Query Photometric Quantity Gain Function Command Syntax :SCALe:PHOTometry:GAIN <1/0/ON/OFF > Query :SCALe:PHOTometry:GAIN? Response <1/0(NR1)> Command Description Sets the radiometric quantity gain function. When the radiometric quantity gain function is enabled, the value set :SCALe:PHOTometry:GAIN:DATA is added to the measured value of the photometric quantity of the RGB mixed light.
A system error occurred that affects the measured value. → The repair is needed. Contact your local distributor or the High HIOKI International Sales Department at os-com@hioki.co.jp. Overflow The measurement could not be performed in the range where the measurement was performed.
(c) Reading Measured Values Measurement (waits for trigger and reads the measured values) Syntax Query :READ? Response (1) Modulation Frequency Measurement (:MODE PULSe Settings) <Modulation frequency (NR2) >,<Measurement status (NR1) > (2) Dark Measurement (:MODE DARK Settings) <Judgment result (NR1) > (3) Normal Measurement (:MODE NORMal Settings)
Abort Measurement :ABORt Syntax Query Description Aborts (forcibly terminates) the measurement or waiting for measurement completion by :READ?. Example *TRG :ABOR Aborts the measurement. :READ? :ABOR Aborts the waiting for measurement completion. Query Measured Value of Centroid Wavelength (# is R, G, or Syntax Query :FETCh:WAVelength:CENTroid:#?
Query Measured Value of Dominant Wavelength (# is R, G, or Syntax Query :FETCh:WAVelength:DOMinant:#? Response <Measured value of dominant wavelength(NR3)>,<Measurement status(NR1)> <Measured value of dominant wavelength> = Unit: [nm] “Measurement Value Formats” (p.37), “Measurement Status” (p.36) See: Reads the last measured value of the dominant wavelength. Description Example :MODE NORM...
“Measurement Value Formats” (p.37), “Measurement Status” (p.36), “Unit of See: Photometric Quantity” (p.9) Reads the last measured value of the radiometric quantity. Description Example :MODE NORM (For TM6102) :READ? *TRG 3.7109E-01,3.4633E-01,4.24932E+03,0 :FETC:RAD:R? 7.92924E+00,0 The red radiometric quantity is 7.92924 [W/m :FETC:RAD:G? 4.53508E+00,0...
Query Measured Value of Chromaticity (x,y) (# is R, G, B, or RGB) Query Syntax :FETCh:XY:#? Response <Measured value of chromaticity (x)(NR3)>,<Measured value of chromaticity (y)(NR3)> ,<Measurement status(NR1)> “Measurement Value Formats” (p.37), “Measurement Status” (p.36) See: Description Reads the last measured values of the chromaticity (x,y). Example :MODE NORM :READ?
“Measurement Value Formats” (p.37), “Measurement Status” (p.36), “Unit of See: Photometric Quantity” (p.9) Description Reads the last measured value of the photometric quantity. Example :MODE NORM (For TM6102) :READ? *TRG 3.7209E-01,3.4709E-01,1.92834E+03,0 :FETC:PHOT:R? 5.51704E+02,0 The red photometric quantity is 551.704 [lx].
“Measurement Value Formats” (p.37), “Measurement Status” (p.36) See: Reads the last measured values of the chromaticity (u’,v’). Description Example :MODE NORM (For TM6102) :READ? *TRG 3.7209E-01,3.4709E-01,1.92834E+03,0 :FETC:UDVD:R? 5.6858E-01,5.1470E-01,0 u’ and v’ of the red chromaticity (u’,v’) are 0.56858 and 0.51470, respectively.
Query Measured Value of Delta uv Query Syntax :FETCh:DELUv? Response <Delta uv(NR3)>,<Measurement status(NR1)> “Measurement Value Formats” (p.37), “Measurement Status” (p.36) See: Description Reads the last measured value of the delta uv. Example :MODE NORM :READ? *TRG 3.7209E-01,3.4709E-01,1.92834E+03,0 :FETC:DELU? -1.2074E-02,0 • When the delta uv is larger than 0.02 or when the delta uv cannot be calculated, it is Note treated as unmeasured.
Query Detection Levels Syntax Query :FETCh:LEVel? Response <Red detection level(NR2)>,<Green detection level(NR2)>,<Blue detection level(NR2)> <Detection level of each color> = Unit: [%] “Measurement Value Formats” (p.37) See: Queries the last measured detection levels. Description The detection level shows what percentage of the F.S. of the measured range has been measured.
When the measured value of the radiometric quantity enters a range between the upper and lower thresholds, the judgment is PASS. Example :MODE NORM; :TARG ON (For TM6102) :TARG:DEV:X 0.37, 0.05; Y 0.34, 0.05; PHOT 12000, 500 :READ?; *TRG 3.7479E-01,3.4711E-01,1.14464E+04,0 :FETC:RAD:R? 2.14841E+01,0...
:FETC:RAD:B? 7.48744E+00,0 :TARG:RES:B? 8.36588E+00,0,1,5.05005E+00,1.27150E+01 Measured value of blue radiometric quantity: 7.48744 [W/m Target value of blue radiometric quantity: 8.36588 [W/m Lower threshold of tolerance: 5.05005 [W/m ] Upper threshold of tolerance: 12.7150 [W/m Judgment: PASS judgment (The measured value of the radiometric quantity is between the upper and lower thresholds of the tolerance.) •...
Page 55
• Target Value of Photometric Quantity - Tolerance of Photometric Quantity ≤ Measurement Value of Photometric Quantity ≤ Target Value of Photometric Quantity + Tolerance of Photometric Quantity Example :MODE NORM (For TM6102) :TARG ON :TARG:DEV:X 0.37, 0.05 :TARG:DEV:Y 0.34, 0.05 :TARG:DEV:PHOT 12000, 500 :READ?;...
(15) Others Set and Query Power LED Lighting Command Syntax :SYSTem:POWer:LED <1/0/ON/OFF > Query :SYSTem:POWer:LED? Response <1/0(NR1)> Command Description Sets the power LED lighting. ON: Lights up or flashes in accordance with the instrument state. OFF: Always off. Query Queries the currently set power LED lighting setting. Example :SYST:POW:LED ON :SYST:POW:LED?
Read Error Information :SYSTem:ERRor? Syntax Query <Error No. (NR1) > Response <Error No.> = 32768 16384 8192 4096 2048 1024 bit 15 bit 14 bit 13 bit 12 bit 11 bit 10 bit 9 bit 8 Measurement RAM error Mode error AD error error bit 7...
Page 58
5 Measurement Flow Basic Measurement Flow Send Command Response Details :TRIG:SOUR BUS Makes the settings for triggering from the communication. Modulation Frequency Measurement :MODE PULS Sets the modulation frequency measurement mode. :READ? Sets the measurement complete wait state. *TRG Starts the measurement. 59.9988, 0 Acquires the response of :READ?.
Need help?
Do you have a question about the TM6102 and is the answer not in the manual?
Questions and answers