Spectrolino SpectroScan

Transcription

1 Spectrophotometer & XY Table Spectrolino SpectroScan SERIAL INTERFACE Edition 5 GretagMacbeth SI 0202 en Printed in Switzerland

2

3 Table of contents Table of contents 1 GENERAL Compatibility to the SPM family Short introduction in the principles of communication Data transmission format The decimal format The hexadecimal format 8 2 PROGRAMMING THE SPECTROLINO Procedure to initialize the Spectrolino Procedure to execute measurements Procedure to execute reflectance measurements Procedure to execute emission measurements Execute measurements and read values Reading measurements values with printout Query measurement values with protocol 14 3 SPECTROLINO COMMUNICATION PROTOCOL The Spectrolino communication functions Measurements Printout of measurement values 1) Optical parameters Query measuring results White reference values Photometric mode Table values Device data's Several other instructions Error messages 33 4 PROGRAMMING THE SPECTROSCAN Procedure to initialize the SpectroScan Procedure to perform measurements on the SpectroScan Procedure to execute reflectance measurements Procedure to execute transmission measurements Timeouts 38 5 SPECTROSCAN COMMUNICATION PROTOCOL The SpectroScan communication functions Moving the axis of the XY table Query actual position 40 3

4 Table of contents Initialization Setting device ON or OFF Hold or release paper Set table mode T) : Set light level T) tr) : Set transmission standby position T) tr) : Digitizing mode Change interface settings Several other instructions Identification data's Error messages 49 6 ALL COMMUNICATION TYPES General Alphabetical listing and description of all types 51 APPENDIX A -CONNECTIONS 69 APPENDIX B -INTERFACE SPECIFICATION 71 APPENDIX C -SPECTROLINO BACKUP DATA 75 APPENDIX D -SPECTROLINO COMMAND SUMMARY 77 APPENDIX E -SPECTROSCAN COMMAND SUMMARY 83 4

5 General 1 General This manual contains specifications, protocol and functional descriptions of the serial interface of the Spectrolino spectrophotometer and the SpectroScan XY table. All commands for the Spectrolino are listed in chapter 3, page 17. The commands for the SpectroScan are in chapter 5, page 39. Each command is built up with different types. Detailed description of each type can be found in chapter 6 listed in alphabetical order. 1.1 Compatibility to the SPM family The communication protocol of the Spectrolino is compatible to the protocol of the SPM spectrophotometers. This makes it possible to use former programs written for the SPM. However, a few new commands have been introduced for the Spectrolino, which are not valid for the SPM. This commands are specially marked. The protocol for the SpectroScan is based on the SPM. Thus, all definition of the protocol for the Spectrolino are also valid for the SpectroScan. 1.2 Short introduction in the principles of communication Data transmission is performed using the query / reply principle: For each query sent from the host computer, the Spectrolino (and the SpectroScan) sends the respective reply. - Each query from the host begins with a start character. - Each reply from the Spectrolino begins with a start character. Queries and replies are concluded with "<CR><LF>". (<CR> = ASCII (13)) and (<LF> = ASCII (10)). After each query has been terminated with "<CR><LF>" the Spectrolino executes the command and sends the respective reply. All data are transmitted in ASCII code. Only printable characters are used which facilitates monitoring of data line communication. 5

6 Section 1 A complete query from the host is structured as followed: <Start character> <Message Number> [no, one or more parameters] <CR><LF> where a) b) c) d) a) <Start character> Host start mark: Each query from the host starts with a special character to indicate the beginning. b) <Message Number> Each message has its message number to determine the function of the query. c) [no, one or more parameters] Some queries need no additional parameters, others need one or more parameters. Refer to section 3 for more detailed information about the function of the queries. d) <CR><LF> Each message has to be terminated by the stop mark <CR><LF>. A complete reply from the Spectrolino is structured as followed: <Start character> <Message Number> [one or more parameters] <CR><LF> where a) b) c) d) a) <Start character> Spectrolino start mark: Each reply from the Spectrolino starts with a special start sign to indicate the beginning. b) <Message Number> Each reply has its message number to determine the function of the reply. c) [one or more parameters] The results of the reply. d) <CR><LF> Each reply will be terminated by the stop mark <CR><LF>. 6

7 General 1.3 Data transmission format Two data formats, i.e. the hexadecimal and decimal formats are available for data transmission. In the hexadecimal format, a copy of the memory contents is transferred, while in the decimal format, values are converted into readable ones. The Spectrolino answers each query in the format in which it was received The decimal format The Spectrolino will read the parameters of a query as decimal values if the first character after the start mark is a blank. At least one blank (' ' = ASCII(32)) must be sent prior to each parameter in order to separate individual values. Each value may only be displayed with a maximum of 12 characters (excluding blanks). If a value has more than 12 characters, the Spectrolino considers only the first 12 characters. The device replies with the same format as the query was. Different data types are coded as follows: One byte types: (e.g. BOOLEAN, CHAR, tabulation types) Decimal value: 81 Perm. query formats: ' 81', ' ', ' 081', ' +81',... Reply format: ' 81' (= ASCII(32, 32, 56, 49)) Two byte types: (e.g. INTEGER, CARDINAL, SET) Decimal value: 1234 Perm. query formats: ' 1234', ' 1234', ' ',... CARDINAL reply format: ' 1234' (= ASCII(32, 32, 49, 50, 51, 52)) INTEGER reply format: ' 1234' (= ASCII(32, 32, 32, 49, 50, 51, 52)) Four byte type: (SREAL) Decimal value: Perm. query formats: ' ', ' ', ' -3456E-03',... Reply format: ' ' (= ASCII(32, 32, 32, 32, 45, 51, 46, 52, 53, 54, 48)) Example of a complete query and the respective reply: Query: Reply: '; 3 9<CR><LF>' ': <CR><LF>' The above-mentioned query/reply in ASCII: Query: ASCII( 59, 32, 51, 32, 57, 13, 10) Reply: ASCII( 58, 32, 32, 49, 52, 32, 32, 32, 57, 32, 32, 32, 32, 32, 49, 46, 50, 55, 49, 50, 32, 32, 32, 32, 32, 49, 46, 50, 50, 50, 57, 32, 32, 32, 32, 32, 49, 46, 51, 56, 56, 56, 32, 32, 32, 32, 32, 51, 46, 51, 53, 51, 56, 32, 32, 32, 51, 32, 32, 32, 49, 32, 32, 32, 32, 32, 48, 13, 10) (The meaning of the above-mentioned query will be explained later). 7

8 Section The hexadecimal format The hexadecimal format will be recognized when the message value starts immediately after the start character ';'. No Space is required between two message parameters. The answer of a query will also be in hexadecimal format. Note: The Spectrolino uses the INTEL format. For all data which consists of more than one byte, the least significant byte is always transferred first. Different Data Types are coded as followed: One byte types: (e.g. BOOLEAN, tabulation types) Decimal value: 181 Hexadecimal value: B5 Transmitted as: 'B5' (= ASCII(66,53)) Two byte types: (e.g. INTEGER, CARDINAL, SET) Decimal value: 2346 Hexadecimal value: 092A Transmitted as: '2A09' (= ASCII(50,65,48,57)) Four byte type: (SREAL) The SREAL type corresponds to the IEEE 754 single precision real format and is defined as follows: SEEE EEEE EMMM MMMM MMMM MMMM MMMM MMMM (32 Bit) S-field: (Sign) 1: negative; 0: positive E-field: exponent (E-field: exponent: ) M-field: Mantisse standardized, 23 bit (MSB is always 1 and is therefore omitted) Example: value: Hexadecimal value: 3E1B3D07 Transmitted as: '073D1B3E' (= ASCII(48,55,51,68,49,66,51,69)) Example of a complete query and the respective reply: Query: Reply: ';0309<CR><LF>' ':0E0918B6A23FD6869C3F37C5B13FE3A <CR><LF>' The above-mentioned query/reply in ASCII: Query: ASCII( 59, 48, 51, 48, 57, 13, 10) Reply: ASCII( 58, 48, 69, 48, 57, 49, 56, 66, 54, 65, 50, 51, 70, 68, 54, 56, 54, 57, 67, 51, 70, 51, 55, 67, 53, 66, 49, 51, 70, 69, 51, 65, 52, 49, 54, 52, 48, 48, 51, 48, 49, 48, 48, 48, 48, 13, 10) (The meaning of the above-mentioned query will be explained later.) 8

9 Programming the Spectrolino 2 Programming the Spectrolino 2.1 Procedure to initialize the Spectrolino When starting a program, it is recommended to do an initialization sequence at first to make sure the measuring device is in a defined state. Start initialization routine Check baud rate Correct answer? Yes No Change baud rate of the host No All baud rates checked? Yes Check baud rate: Send the instruction "ParameterRequest" (<;00>/{; 0}) to the Spectrolino. If the reply starts with "ParameterAnswer" (<;0B>/{; 11}), the baud rate is correct. If not, change the baud rate of the computer and try again until the correct answer is received. It is recommended to scan for the baud rate in the following order: 9600, 19200, 57600, 28800, 4800, 2400, 1200, 600, 300, 150, 110 Baud. Device is a Spectrolino? No Check connection Refer to the manual of the device Device is a Spectrolino: Send the instruction "TargetIdRequest" (<;2B>/{; 43}) and check the <TargetTechType> (refer to section ). Reset the Spectrolino Reset the Spectrolino: Send the instruction "ResetStatusDownload" (<;5A010405>/ {; }) and reset the parameters to default values (without the baud rate and the handshake). (refer to section ). End of initialization routine 9

10 Section Procedure to execute measurements With the Spectrolino you can execute reflectance and emission measurements. The procedure to initialize a reflectance measurement (2.2.1) is not the same as the procedure to initialize an emission measurement (refer to 2.2.2) Procedure to execute reflectance measurements To execute reflectance measurements it is recommended to use the following sequence: Start of remission measurement procedure Set measurement type First remission measurement after starting host application? Yes Set white base to absolute Advise user to check white reference No Set measurement type: Send the instruction "MeasControlDownload" (<;4D9B>/ {; }) and set the measurement type to reflectance measurement (refer to section ). First reflectance measurement after starting host application?: Control with the host application, if this is the first reflectance measurement after starting the application. If the first reflectance measurement will be executed, the white calibration must be executed. Set white base to absolute: Send the instruction "ParameterDownload" (<;16...>/{; 22...}) and set the white base to absolute (refer to section ). Advise user to check white reference: Send the instruction "WhiteReferenceRequest" (<;B3...>/ {; }) (refer section ). Get the white reference name in the "Name18Type" of the answer and write it on the display. Advise the user to check the name with the one on his white reference for correspondence. Advise user to place unit on white reference Perform a white calibration Physical filter correct? Yes Perform a measurement and read values Execute more measurements? No End of remission measurement routine Advise user to change physical filter No Yes Advice user to check physical filter: The user must be advised to change the physical filter (No-filter, polarization-filter,.. ), if the wrong is adapted to the Spectrolino. Advice user to change physical filter: The user must be advised to change the physical filter of the Spectrolino. Advice user to place unit on white reference: The user must be advised to place the Spectrolino on the white reference. Perform a white calibration: Send the instruction "ExecRefMeasurement" (<;220907>/ {; }). The reply should be <:2513>/{: 37 19} (refer to section ). Physical filter correct?: Send the instruction "ParameterRequest" (<;00>/{; 0}) and check if the <ActualFilterType> is set to the desired physical filter (No-filter, polarization-filter,.. ) (refer to section ). Perform a measurement and read values: (refer to section 2.3). If you use paper white, in advance set the white base to paper and perform a paper white measurement. Execute more measurements?: Only if relevant parameter (such as the measurement type, the white base or the physical filter) are changed during the application, a new white calibration has to be performed. 10

11 Programming the Spectrolino Procedure to execute emission measurements To execute emission measurements it is recommended to use the following sequence: Start of emission measurement procedure Set white base to absolute Set measurement type to remission Advise user to check white reference Advise user to place unit on white reference Perform a white calibration Physical filter is no-filter? Yes Set measurement type to emission Perform an emission calibration Set photometric mode to absolute or relative Perform a measurement and read values Execute more measurements? No End of emission measurement routine Advice user to adapt no-filter tubus No Yes Set white base to absolute: Send the instruction "ParameterDownload" (<;16...>/ {; 22...}) and set the white base to absolute (refer to section ). Advice user to adapt No-filter tubus: The user must be advised to adapt the No-filter tubus to the Spectrolino. Set measurement type to reflectance: Send the instruction "MeasControlDownload" (<;4D9B>/ {; }) and set the measurement type to reflectance measurement (refer to section ). Advise user to check white reference: Send the instruction "WhiteReferenceRequest" (<;B3>/ {; 179}) (refer section ). Get the white reference name in the "Name18Type" of the answer and write it on the display. Advise the user to check the name with the one on his white reference for correspondence. Advice user to place unit on white reference: The user must be advised to place the Spectrolino on the white reference. Perform a white calibration: Send the instruction "ExecRefMeasurement" (<;220907>/ {; }). The reply should be <:2513>/{: 37 19} (refer to section ). Physical filter is No-filter?: Send the instruction "ParameterRequest" (<;00>/{; 0}) and check if the <ActualFilterType> is set to "NoFilter".(refer to section ). Set measurement type to emission: Send the instruction "MeasControlDownload" (<;4D9D>/ {; }) and set the measurement type to emission measurement (refer to section ). Perform an emission calibration (dark measurement): Send the instruction "ExecRefMeasurement" (<;220908>/ {; }). The reply should be <:2534>/{: 37 52} (refer to section ). For this step, the Spectrolino must be placed on a white reference. Set photometric mode to absolute or relative: Send the instruction "MeasControlDownload" (<;4D9E>/ {; }, resp. (<;4D9F>/{; ). (refer to section ). If it is set to relative, the reference value should be set with the command "FloatDownload" (<;C2...>/{; ). (refer to section ) Perform a measurement and read values: (refer to section 2.3). Execute more measurements?: If the measurement type is changed during the application, a new emission calibration has to be performed. 11

12 Section Execute measurements and read values There are different methods to get measurement values of a color field. A measurement can be performed by the computer or by pressing the measurement key of the Spectrolino. The measurement values are either returned after each measurement (refer to 2.3.1) or on special request (refer to 2.3.2) Reading measurements values with printout The easiest way to read the values of a color field is by processing the printout. The printout can be defined by modifying the "OutputSet" with the command "MeasurementOutput" (refer section 3.1.2). Now, the desired values will be sent to the serial interface each time a measurement has been executed. If no printout is required, all "OutputSet" should be set to zero. Note: This method can not be used with the SPM! Executing measurement by computer Start of perform measurement and read values Define "OutputSet" Perform measurement and get printout Define "OutputSet": Send the instruction "SetMeasurementOutput" (<;B1...>/{; }) and set the OutputSet to the desired measuring results (refer to section 3.1.2). Perform a measurement and get values: Send the instruction "ExecMeasurement" (<;20>/{; 32}) (refer to section ). With the answer the defined measuring results will be sent. Execute more measurements? Yes Execute more measurements?: Another measurement may be performed. No End of perform measurement and read values Example 1: (hexadecimal protocol) ;B10202<CR><LF> Define output: Lab :1F0000<CR><LF> ;20<CR><LF> Perform a measurement :2500<CR><LF>:BE02029B3F054218AA2A428E367441FF00<CR><LF> ;20<CR><LF> Perform next measurement :2500<CR><LF>:BE02026A2C B449E161854FF00<CR><LF> Example 2: (decimal protocol) ; <CR><LF> Define output: xyy, Lab : 31 0<CR><LF> ; 32<CR><LF> Perform measurement : 37 0<CR><LF>: <CR> <CR> 255 0<CR><LF> 12

13 Programming the Spectrolino Executing measurement by pressing measurement key A measurement can also be executed at the measurement key. Therefore, define the desired "OutputSet". After that the values will be sent after each measurement. Start of perform measurement and read values Define "OutputSet" Define "OutputSet": Send the instruction "SetMeasurementOutput" (<;B1...>/{; }) and set the OutputSet to the desired measuring results (refer to section 3.1.2). Printout detected? No Printout detected: If a Printout has been sent from the Spectrolino, a measurement has been executed by pressing the measurement key. The printout includes the defined measuring results. Yes Execute more measurements? Yes Execute more measurements?: Another measurement may be performed. No End of perform measurement and read values 13

14 Section Query measurement values with protocol Executing measurement by computer After performing a measurement with 'ExecMeasurement', the values of the color field can be queried. See section for further information. Start of perform measurement and read values Perform a measurement Query the measuring result Execute more measurements? Yes Perform a measurement: Send the instruction "ExecMeasurement" (<;20>/{; 32}) (refer to section ). Query the measuring result: Query the desired measuring result (e.g.: Lab, Spetrum). (refer to section 3.1.4) Execute more measurements?: Another measurement may be performed. No End of perform measurement and read values Example 1: (hexadecimal protocol) ;20<CR><LF> Perform a measurement :2500<CR><LF> ;BA0903<CR><LF> Query 'CIE-Luv' :BB09039B3F054247D68B423A <CR><LF> ;BA0900<CR><LF> Query 'CIE-xyY' :BB FF4DEA33EC4D4F <CR><LF> Example 2: (decimal protocol) ; 32<CR><LF> Perform a measurement : 37 0<CR><LF> ; <CR><LF> Query 'CIE-Luv' : <CR><LF> ; <CR><LF> Query 'CIE-xyY' : <CR><LF> 14

15 Programming the Spectrolino Executing measurement by pressing measurement key If a measurement should be executed directly at the device, the handling is a little bit more difficult. Here, the computer has to poll with the command 'NewMeasureRequest' until a measurement has been executed. Then, further commands can be sent by the computer in order to get the desired values. Start of perform measurement and read values Query if new measurement done? Yes Query the measuring result Execute more measurements? No Yes Query if new measurement done?: Send the instruction "NewMeasureRequest" (<;07>/{; 7}) and check if a new measurement has be performed by pressing the measurement key (refer to section ). Query the measuring result: Query the desired measuring result (e.g.: Lab, Spetrum). (refer to section 3.1.4) Execute more measurements?: Another measurement may be performed. No End of perform measurement and read values Example: (hexadecimal protocol) ;07<CR><LF> Measurement performed since the last query? :120109<CR><LF> No ask again / Yes continue ;BA0900<CR><LF> Query 'CIE-xyY' :BB FF4DEA33EC4D4F <CR><LF> ;BA0903<CR><LF> Query 'CIE-Luv' :BB09039B3F054247D68B423A <CR><LF> 15

16

17 Spectrolino communication protocol 3 Spectrolino communication protocol 3.1 The Spectrolino communication functions All queries and instructions, that can be performed using the serial interface, are listed in this section. The types (building blocks of the instructions) are listed in alphabetical order in section 6. When type names are written within the characters "<" and ">" (e.g. <ErrorType>) the values consist of one byte. Names within brackets (e.g. [SpectrumType]) consist of more than one byte Measurements Perform measurement Performs a measurement. It is possible to perform either emission measurements (e.g. monitors) or reflectance measurement (e.g. color fields on paper). Therefore, the measurement type has to be defined prior to a measurement with the command "MeasControlDownload" (refer to section ). (Message numbers <20>/{32}, <25>/{37}) ExecMeasurement ;<20> <CR><LF> ExecError :<25> <ErrorType> <CR><LF> Example: Hexadecimal query --> ;20<CR><LF> Hexadecimal reply --> :2500<CR><LF> Decimal query --> ; 32<CR><LF> Decimal reply --> : 37 0<CR><LF> Meaning of the reply: Measurement performed, no error occurred. 1) : These functions are only valid for the Spectrolino 17

18 Section Perform white measurement If "MeasurementModeType" is set to "WhiteCalWithWarn", a white measurement will be performed and the spectrophotometer checks automatically if the device is set on the white reference field. If not, a warning will be returned. (Message numbers <22>/{34}, <25>/{37}) ExecRefMeasurement ;<22> <09> <MeasurementModeType> <CR><LF> ExecError :<25> <ErrorType> <CR><LF> Example: Hexadecimal query --> ;220907<CR><LF> Hexadecimal reply --> :2532<CR><LF> Decimal query --> ; <CR><LF> Decimal reply --> : 37 50<CR><LF> Meaning of the reply: White measurement done. A warning has been returned: The device might not been set on the white reference field. For reasons of compatibility to the SPM family, the following command can be used as well to perform a white measurement. For new developments, it is recommended to use the command "ExecRefMeasurement". (Message numbers <21>/{33}, <25>/{37}) ExecWhiteMeasurement ;<21> <CR><LF> ExecError :<25> <ErrorType> <CR><LF> 1) : These functions are only valid for the Spectrolino 18

19 Spectrolino communication protocol Printout of measurement values 1) Sometimes it might be useful to get the output values directly each time a measurement has been performed. This values can be defined with "OutputSet". After a reset, no output will be sent. To define the printout, the following command has to be used: (Message numbers <B1>/{177}, <1F>/{31}) SetMeasurementOutput ;<B1> <OutputSetType> <OutputSet> <CR><LF> DownloadError :<1F> [RemoteErrorSet] <CR><LF> For each "OutputSetType", the "OutputSet" should be defined. After the definition of the printout, after every measurement the values will be sent as followed: <:> <BE> [type of output] [output values] <CR> [next output]... <FF> <ErrorType> <CR><LF> a) b) c) d) e) f) g) h) where a) <Start character> Start mark: Each printout starts, like any other reply, with a semicolon (<;>) to indicate the beginning. b) <Message Number> The message number of the printout is <BE>/{190}. c) [type of output] for each defined output, the "OutputSetType" and the "OutputSet" are sent first d) [output values] the measurement values are sent depending on the type e) <value separation> each measurement value is separated by a <CR> f) [next output] for each defined Output, the measurement value will be sent, according to number c), d) and e). g) <ErrorType> at last an error is returned h) <CR><LF> The printout is terminated by the stop mark <CR><LF>. To reset the printout of measurement values, the "OutputSet" of each "OutputSetType" should be set to zero. Remarks: If the output is sent in decimal or hexadecimal format depends on the last remote command sent to the device. 1) : These functions are only valid for the Spectrolino 19

20 Section 4 Example 1: Hexadecimal query --> ;B10406<CR><LF> Hexadecimal reply --> :1F0000<CR><LF> Decimal query --> ; <CR><LF> Decimal reply --> : 31 0<CR><LF> Meaning of the reply: After each measurement, the Density value of cyan and magenta will be sent. The output is defined as followed: Hexadecimal output: Decimal output: :BE0402D6869C3F<CR>040437C5B13F<CR>FF00<CR><LF> : <CR> <CR> 255 0<CR><LF> If the output is sent in decimal or hexadecimal format depends on the last remote command sent to the device. So this output says: Dc = , Dm = , no error occurred Example 2: Query 1 --> ;B1000E<CR><LF> Reply 1 --> :1F0000<CR><LF> Query 2 --> ;B1020A<CR><LF> Reply 2 --> :1F0000<CR><LF> Meaning of the reply: After each measurement, the parameters "White reference", "Illuminant type" and "observer angle" and the colorimetry values "Lab" and "Luv" will be sent. The output is defined as followed: Hexadecimal output: Decimal output: :BE000201<CR>000403<CR>000800<CR> 02029B3F054218AA2A428E367441<CR> 02089B3F054247D68B423A739140<CR>FF00<CR><LF> : <CR> 0 4 3<CR> 0 8 0<CR> <CR> <CR><LF> This output says: White reference is absolute, Illuminant type is D50, Observer angle is 2, Lab = , Luv = ) : These functions are only valid for the Spectrolino 20

21 Spectrolino communication protocol Optical parameters Query colorimetric parameters Queries on the parameters density standard, white reference, illuminant, observer angle, physical filter setting: (Message numbers <00>/{0}, <0B>/{11}) ParameterRequest ;<00> <CR><LF> ParameterAnswer :<0B> <DStdType> <WBaseType> <IllumType> <ObserverType> <ActualFilterType> <CR><LF> Example: Hexadecimal query --> ;00<CR><LF> Hexadecimal reply --> :0B <CR><LF> Decimal query --> ; 0<CR><LF> Decimal reply --> : <CR><LF> Meaning of the reply: Density standard = ANSI A; White base = Absolute; Actual filter = Pol; Illuminant type = Illuminant A; Observer angle = Sets the colorimetric parameters Set parameters density standard, white reference, illuminant, observer angle. (Message numbers <16>/{22}, <1F>/{31}) ParameterDownload ;<16> <DStdType> <WBaseType> <IllumType> <ObserverType> <CR><LF> DownloadError :<1F> [RemoteErrorSet] <CR><LF> 1) : These functions are only valid for the Spectrolino 21

22 Section Query measuring results Query of spectral measuring results Unit for emission measuring results: mw m 2 * sr* nm Query of spectral measuring results and belonging parameters 1) Queries the spectrum of the last measured field and the actual parameters: (Message numbers <B8>/{184}, <B9>/{185}). SpecParameterRequest ;<B8> <09> <SpectType> <CR><LF> SpecParameterAnswer :<B9> <09> <SpectType> [SpectrumType] <RefValidType> <ActualFilterType> <WBaseType> <02> [RemoteErrorSet] <CR><LF> Example: Hexadecimal query --> ;B80901<CR><LF> Hexadecimal reply --> :B F8E F04740E F2A40F5DA20408C E8FF0E407BBA F93FC054F03FDA0EE63FA381D83F8265C A3F6FD6BD3FBE97B53F0B6FB03F9CA3AD3F37A6A83F28A6A33FAEBEA23F4E0 0A43FB277A63F6B4FA93FCBB0AC3F9A09B03FC87CB33FC8DDB63F9271BA3F1 28DBE3F99ACC33FFB22C93FDE90CF3F1B40D73F72EFE03F <CR><LF> Decimal query --> ; <CR><LF> Decimal reply --> : <CR><LF> Meaning of the reply: Density spectrum of measured field: D[380] = ;.. D[730] = ; the measured values are valid; Actual filter is D65; White base is absolute; no communication error reported Query of spectral measuring results Similar to the upper command "SpecParameterRequest" this command queries the spectrum of a measured field, but without the measurement parameter. This command is also valid for the SPM family. For new developments, the command "SpecParameterRequest" is recommended. (Message numbers <05>/{5},<10>/{16}). SpectrumRequest ;<05> <09> <SpectType> <CR><LF> SpectrumAnswer :<10> <09> <SpectType> [SpectrumType] <RefValidType> [RemoteErrorSet] <CR><LF> 1) : These functions are only valid for the Spectrolino 22

23 Spectrolino communication protocol Query of colorimetric measuring results Query of colorimetric measuring results and belonging parameters 1) Query of all 3 parameters (e.g. L, a, b) in the respective color space for the last measured field and the actual parameters: (Message numbers <BA>/{186}, <BB>/{187}) CParameterRequest CParameterAnswer ;<BA> <09> <CType> <CR><LF> :<BB> <09> <CType> [ColorType] <RefValidType> <ActualFilterType> <WBaseType> <02> <IllumType> <ObserverType> [RemoteErrorSet] <CR><LF> Example: Hexadecimal query --> ;BA0903<CR><LF> Hexadecimal reply --> :BB D421305B642B5E30F <CR><LF> Decimal query --> ; <CR><LF> Decimal reply --> : <CR><LF> Meaning of the reply: Luv values of a measured field: L = , u = , v = ; the measured value is valid; Actual filter is Pol; White base is absolute; Illuminant is Illuminant A; Observer angle is 2, no communication error Query of colorimetric measuring results and belonging parameters Similar to the upper command "CParameterRequest" this command queries all 3 parameters (e.g. L, a, b) in the respective color space for the last measured field, but without the measurement parameter. This command is also valid for the SPM family. For new developments, the command "CParameterRequest" is recommended. (Message numbers <06>/{6}, <11>/{17}) CRequest ;<06> <09> <CType> <CR><LF> CAnswer :<11> <09> <CType> [ColorType] <RefValidType> [RemoteErrorSet] <CR><LF> 1) : These functions are only valid for the Spectrolino 23

24 Section Query of densitometric measuring results Query of densitometric measuring results and belonging parameters 1) Query density of the last measured field and the actual parameters: (Message numbers <BC>/{188}, <BD>/{189}) DensityParameterRequest ;<BC> <09> <CR><LF> DensityParameterAnswer :<BD> <09> [DensityFilterArrayType] <StdDensityFilterType> <RefValidType> <ActualFilterType> <WBaseType> <02> <DStdType> [RemoteErrorSet] <CR><LF> Explanation: StdDensityFilterType filter selected from automatic filter selection Example: Hexadecimal query --> ;BC09<CR><LF> Hexadecimal reply --> :BD0918B6A23FD6869C3F37C5B13FE3A <CR><LF> Decimal query --> ; 188 9<CR><LF> Decimal reply --> : <CR><LF> Meaning of the reply: Density value: Db = ;... Dy = ; Automatic filter selection: Dy; Measuring value is valid; Actual filter is Pol; White base is paper; Density standard is DIN; no communication error Query of densitometric measuring results Similar to the upper command "DensityParameterRequest" this command queries the density of the last measured field, but without the measurement parameter. This command is also valid for the SPM family. For new developments, the command "DensityParameterRequest" is recommended. (Message numbers <03>/{3}, <0E>/{14}) DensityRequest ;<03> <09> <CR><LF> DensityAnswer :<0E> <09> [DensityFilterArrayType] <StdDensityFilterType> <RefValidType> [RemoteErrorSet] <CR><LF> Queries regarding the maximum density values of a sample (Message numbers <04>/{4}, <0F>/{15}). DmaxRequest ;<04> <09> <CR> <LF> DmaxAnswer :<0F> <09> <DmaxType> <LambdaType> <DmaxokType> <RefValidType> [RemoteErrorSet] <CR> <LF> 1) : These functions are only valid for the Spectrolino 24

25 Spectrolino communication protocol White reference values Reflection spectra of the white reference 1) Queries for the spectra of the white reference for the desired filter. "OriginalWhiteRef" specifies whether the original or user data's are valid. If user data's are valid, the "Name18Type" contains the name of the data table. If original data's are valid, the white reference number will be given in the string. (Message numbers <B3>/{179}, <B4>/{180}) WhiteReferenceRequest ;<B3> <ActualFilterType> <CR><LF> WhiteReferenceAnswer :<B4> <ActualFilterType> [SpectrumType] <OriginalWhiteRefType> [Name18Type] <CR><LF> Load spectra of a user defined white reference from the host 1) Load the spectra of a user defined white reference for the desired filter. A name can be given to the white reference with the "Name18Type". (Message numbers <B7>/{183}, <1F>/{31}) WhiteReferenceDownld ;<B7> <ActualFilterType> [SpectrumType] [Name18Type] <CR><LF> DownloadError :<1F> [RemoteErrorSet]<CR><LF> Reset spectra of the respective white reference to original data (Message numbers <4A>/{74},<25>/{37}) ExecWhiteRefToOrigDat ;<4A> <CR><LF> ExecError :<25> <ErrorType><CR><LF> 1) : These functions are only valid for the Spectrolino 25

26 Section Photometric mode If you execute emission measurements and get colorimetric results, the photometric mode should be defined. Photometric absolute: The colorimetric values are absolute in cd/m 2. Photometric relative: The colorimetric values are relative to the downloadable luminance reference value (e.g. for the luminance of 80 cd/m 2, Y = 100) Load for the photometric mode This instruction permits to set the photometric mode to absolute or relative: (Message numbers <4D>/{77}, <1F>/{31}) MeasControlDownload ;<4D> <ControlType> <CR><LF> DownloadError :<1F> [RemoteErrorSet] <CR><LF> Query for the photometric mode This instruction permits to ask for the current setting of the photometric mode. In the "MeasControlAnswer", the first <ControlType> is set to the value of the "MeasControlRequest", the second <ControlType> is set to the value according to the actual setting of the measuring device: (Message numbers <5B>/{91}, <5C>/{92}) MeasControlRequest ;<5B> <ControlType> <CR><LF> MeasControlAnswer :<5C> <ControlType> <ControlType> [RemoteErrorSet] <CR><LF> Queries the photometric reference value Queries the reference value for relative photometric measurements. (Message numbers <C0>/{192},<C1>/{193}) FloatRequest FloatAnswer ;<C0> <COMFloatType> <CR><LF> :<C1> <COMFloatType> [COMFloatValueType] [RemoteErrorSet] <CR><LF> Load the photometric reference value Load the reference value for relative photometric measurements. (Message numbers <C2>/{194},<1F>/{31}) FloatDownload ;<C2> <COMFloatType> [COMFloatValueType] <CR><LF> DownloadError :<1F> [RemoteErrorSet] <CR><LF> 1) : These functions are only valid for the Spectrolino 26

27 Spectrolino communication protocol Table values Query standard or user definable illuminant tables (Colorimetry) Queries of the illuminant tables: (Message numbers <38>/{56}, <39>/{57}) IllumTabRequest ;<38> <00> <IllumType> <CR><LF> IllumTabAnswer :<39> <00> <IllumType> [SpectrumType] [RemoteErrorSet] <CR><LF> Load user definable illuminant tables (Colorimetry) from the Host Load user definable illuminant tables: (Message numbers <3A>/{58},<1F>/{31}) IllumTabDownload ;<3A> <08> [SpectrumType] <CR><LF> DownloadError :<1F> [RemoteErrorSet] <CR><LF> Queries for color temperature of daylight illuminant Dxx This query permits access of color temperature divided by 100 of the freely programmable daylight illuminates: (Message numbers <47>/{71},<48>/{72}) GetValNr ;<47> <60> <CR><LF> ValNrAnswer :<48> <60> [DxxTempNrType] [RemoteErrorSet] <CR><LF> Loading of color temperature of daylight illuminant Dxx This instruction permits to store the color temperature divided by 100 of the freely programmable daylight illuminates in the unit: (Message numbers <49>/{73},<1F>/{31}.) SetValNr ;<49> <60> [DxxTempNrType] <CR><LF> DownloadError :<1F> [RemoteErrorSet] <CR><LF> 1) : These functions are only valid for the Spectrolino 27

28 Section Queries slope values of densitometry Query slope values: (Message numbers <01>/{1}, <0C>/{12}) SlopeRequest ;<01> <CR><LF> SlopeAnswer :<0C> [DensityFilterArrayType] <CR><LF> Example: Hexadecimal query --> ;01<CR><LF> Hexadecimal reply --> :0CFEA9813FE97C7F3F86EB813F0000A03F<CR><LF> Decimal query --> ; 1<CR><LF> Decimal reply --> : <CR><LF> Meaning of the reply: Slope factor: Db = Dy = Load slope values of densitometry Load slope values: (Message numbers <17>/{23}, <1F>/{31}) SlopeDownload ;<17> [DensityFilterArrayType] <CR><LF> DownloadError :<1F> [RemoteErrorSet] <CR><LF> Queries of the standard or user definable densitometric tables Queries of the densitometric corrected value tables: (Message numbers <3B>/{59}, <3C>/{60}) DensTabRequest ;<3B> <00> <DStdType> <CR><LF> DensTabAnswer :<3C> <00> <DStdType> [DensFilSpecArrayType] [RemoteErrorSet] <CR><LF> Load user definable densitometric tables from the host (Message numbers <3D>/{61}, <1F>/{31}) DensTabDownload ;<3D> [DensFilSpecArrayType] <CR><LF> DownloadError :<1F> [RemoteErrorSet] <CR><LF> 1) : These functions are only valid for the Spectrolino 28

29 Spectrolino communication protocol Device data's Query for specific device data 1) Query for device data's such as serial number, software release. (Message numbers <B5>/{181}, <B6>/{182}) DeviceDataRequest ;<B5> <CR><LF> DeviceDataAnswer :<B6> [DeviceNameType] <DeviceNumberType> [ArticleNumberType] [SerialNumberType] [SoftwareReleaseType] [ReserveType] <CR><LF> Query special device data's This command gives more special data's about the device. It is manly introduced because of compatibility reasons. Therefore, the above command 'DeviceDataRequest' should be used for future applications. (Message numbers <2B>/{43}, <31>/{49}) TargetIdRequest ;<2B> <CR><LF> TargetIdAnswer :<31> [DeviceNameType] [TargetIdType] [TargetTechType] [TargetSpecType] <CR><LF> 1) : These functions are only valid for the Spectrolino 29

30 Section Several other instructions Queries whether a new measurement was performed since the last access The commands returns, whether a new measurement was performed since the last query. The answer indicates the type of the last measurement. (Message numbers <07>/{7}, <12>/{18}) NewMeasureRequest ;<07> <CR><LF> NewMeasureAnswer :<12> <NewMeasurementType> <09> <CR><LF> Example: Hexadecimal query --> ;07<CR><LF> Hexadecimal reply --> :120109<CR><LF> Decimal query --> ; 7<CR><LF> Decimal reply --> : <CR><LF> Meaning of the reply: One measurement was performed since the last query Queries whether or not a key was pressed since the last access (Message numbers <08>/{8},<13>/{19}) NewKeyRequest ;<08> <CR><LF> NewKeyAnswer :<13> <NewKeyType> [KeySet] <CR><LF> Set measurement type This instruction permits to set the measurement type to reflectance or emission: (Message numbers <4D>/{77}, <1F>/{31}) MeasControlDownload ;<4D> <ControlType> <CR><LF> DownloadError :<1F> [RemoteErrorSet] <CR><LF> Query for the current measurement type This instruction permits to ask for the measurement type. In the "MeasControlAnswer", the first <ControlType> is set to the value of the "MeasControlRequest", the second <ControlType> is set to the value according to the actual setting of the spectrophotometer: (Message numbers <5B>/{91}, <5C>/{92}) MeasControlRequest ;<5B> <ControlType> <CR><LF> MeasControlAnswer :<5C> <ControlType> <ControlType> [RemoteErrorSet] <CR><LF> 1) : These functions are only valid for the Spectrolino 30

31 Spectrolino communication protocol Set interface parameters This instruction permits to set the interface parameters, (baud rate. and handshake): (Message numbers <4D>/{77}, <1F>/{31}) MeasControlDownload ;<4D> <ControlType> <CR><LF> DownloadError :<1F> [RemoteErrorSet] <CR><LF> Note: If you change the baud rate (communication speed of the serial interface), the answer of the command will already be sent in the new baud rate. Therefore, it is recommended to ignore the answer of the spectrophotometer and change the baud rate of the host after a delay of 1 second Query for the current interface parameters This instruction permits to ask for the current interface parameters of the Spectrolino. In the "MeasControlAnswer", the first <ControlType> is set to the value of the "MeasControlRequest", the second <ControlType> is set to the value according to the actual setting of the spectrophotometer: (Message numbers <5B>/{91}, <5C>/{92}) MeasControlRequest ;<5B> <ControlType> <CR><LF> MeasControlAnswer :<5C> <ControlType> <ControlType> [RemoteErrorSet] <CR><LF> Set target status This instruction allows to lock the key function of the device: (Message numbers <33>/{51}, <1F>/{31}) TargetOnOffStDownload ;<33> [TargetOnOffStatusType] <CR><LF> DownloadError :<1F> [RemoteErrorSet] <CR><LF> Total reset of the device Perform a total reset to get the same status like after the startup (backuped values will be reseted to default values (refer to Appendix C). (Message numbers <5A>/{90},<1F>/{31}) ResetStatusDownload ;<5A> <01> <04> <StatusModeType> <CR><LF> DownloadError :<1F> [RemoteErrorSet] <CR><LF> 1) : These functions are only valid for the Spectrolino 31

32 Section Set the speaker *)1.20 This instruction allows to switch the speaker On and Off. After a measurement by the measure key the speaker sounds normally. This sound can be switched On and Off. (Message numbers <4D>/{77}, <1F>/{31}) MeasControlDownload ;<4D> <ControlType> <CR><LF> DownloadError :<1F> [RemoteErrorSet] <CR><LF> Query for the speaker setting *)1.20 This instruction permits to ask for the setting of the speaker (refer to ). In the "MeasControlAnswer", the first <ControlType> is set to the value of the "MeasControlRequest", the second <ControlType> is set to the value according to the actual setting of the spectrophotometer: (Message numbers <5B>/{91}, <5C>/{92}) MeasControlRequest ;<5B> <ControlType> <CR><LF> MeasControlAnswer :<5C> <ControlType> <ControlType> [RemoteErrorSet] <CR><LF> 1) : These functions are only valid for the Spectrolino 32

33 Spectrolino communication protocol Error messages Reply to an erroneous query The measuring device always sends a reply when it receives a <CR><LF>. The unit replies with "COMErr" if this query was incomplete or invalid: (Message number <26>/{38}) xxxx ;<??> <??> <CR><LF> COMErr :<26> <DTCOMErrType> <CR><LF> Example: Hexadecimal query --> ;<CR><LF> Hexadecimal reply --> :2604<CR><LF> Decimal query --> ; <CR><LF> Decimal reply --> : 38 4<CR><LF> Meaning of the reply: The Spectrolino indicates that no valid message number was received Query for the general error status (Message numbers <29>/{41}, <2F>/{47}) ActErrorRequest ;<29> <CR><LF> ActErrorAnswer :<2F> [ErrorType] <00> <00> <CR><LF> 1) : These functions are only valid for the Spectrolino 33

34

35 Programming the SpectroScan 4 Programming the SpectroScan 4.1 Procedure to initialize the SpectroScan When starting a program, it is recommended to do an initialization sequence at first to make sure the SpectroScan and the Spectrolino are in a defined state. Start of initialisation routine Check baud rate Correct answer? No Change baud rate of the host Yes All baud rates checked? Check baud rate: Send the instruction "OutputStatus" (<;D024>/{; }) to the SpectroScan. If the reply starts with "StatusAnswer" (<;D1>/{; 209}), the baud rate is correct. If not, change the baud rate of the computer and try again until the correct answer is received. It is recommended to scan for the baud rate in the following order: 9600, 57600, 28800, 19200, 4800, 2400, 1200, 600, 300, 150, 110 Baud. No Check connection Initialize the GRETAG Spectrolino connection Initialize the Spectrolino connection: Send the instruction "ScanSpectrolino" (<;D00B>/ {; }). (refer to section ). Reset the GRETAG Spectrolino Reset the Spectrolino: Send the instruction "ResetStatusDownload" (<;5A010405>/ {; }) and reset the parameters to default values (without the baud rate and the handshake). (refer to section ). Set measurement type Set measurement type: Send the instruction "MeasControlDownload" (<;4D9B>/ {; }) and set the measurement type to reflectance measurement (refer to section ). Set white base to absolut Set white base to absolute: Send the instruction "ParameterDownload" (<;16...>/{; 22...}) and set the white base to absolute (refer to section ). End of initialisation routine 35

36 Section Procedure to perform measurements on the SpectroScan Procedure to execute reflectance measurements To execute measurements with the Spectrolino adapted to the SpectroScan it is recommended to use the following sequence, after the execution of the initialisation routine (refer to section 4.1): Start of measurement procedure on the GRETAG SpectroScan Move GRETAG Spectrolino to the white reference Move GRETAG Spectrolino down Perform a white calibration Advise user to change physical filter Set table mode to reflectance: If SpectroScanT is set to transmission mode send the instruction "SetTableMode" (<;D00D00>/ {; }) (refer to section 5.1.6). Move Spectrolino to the white reference: Send the instruction "MoveToWhiteRefPos" (<;D006..>/ {; }). The reply should be <:D18000>/{: } (refer to section ). Move Spectrolino down: Send the instruction "MoveDown" (<;D004>/ {; 208 4}). The reply should be <:D18000>/{: } (refer to section ). Advice user to change physical filter: The user must be advised to change the physical filter of the Spectrolino. Perform a white calibration: Send the instruction "ExecRefMeasurement" (<;220907>/ {; }). The reply should be <:2513>/{: 37 19} (refer to section ). Physical filter correct? Yes No Physical filter correct?: Send the instruction "ParameterRequest" (<;00>/{; 0}) and check if the <ActualFilterType> is set to the desired physical filter (No-filter, polarization-filter,.. ) (refer to section ). Move GRETAG Spectrolino to position X/Y Move GRETAG Spectrolino down Perform a measurement and read values Execute more measurements? No Move GRETAG Spectrolino to home position End of measurement procedure on the GRETAG SpectroScan No 50 measurements done? Yes Perform a white calibration Move GRETAG Spectrolino down Move GRETAG Spectrolino to the white reference Yes Move Spectrolino to position X/Y: Send the instruction "MoveAbsolut" (<;D000...>/ {; }). The reply should be <:D18000>/{: } (refer to section 5.1.1). Move Spectrolino down: Send the instruction "MoveDown" (<;D004>/ {; 208 4}). The reply should be <:D18000>/{: } (refer to section ). Perform a measurement and read values: Send the instruction "ExecMeasurement" (<;20>/{; 32}) (refer to section ). Query the desired measuring result (e.g.: Lab, Spetrum). (refer to section 3.1.4) 50 measurements done?: In order to enhance the accuracy, a new white calibration should be performed every 50 measurements. Execute more measurements?: When all measurements are performed, move the Spectrolino to the home position. Move Spectrolino to home position: Send the instruction "MoveHome" (<;D002>/ {; 208 2}). The reply should be <:D18000>/{: } (refer to section 5.1.1). 1) : These functions are only valid for the Spectrolino 36

37 Programming the SpectroScan Procedure to execute transmission measurements To execute transmission measurements using SpectroScanT it is recommended to use the following sequence: Start of mesurement procedure on SpectroScanT Physical filter correct? Advise user to insert the aperture on SpectroScanT Advise user to change physical filter No Advice user to adapt No-filter tubus: The user must be advised to adapt the No-filter tubus to the Spectrolino. Advice user to insert an aperture on SpectroScanT The user must be advised to insert an aperture on SpectroScanT before the device is set to transmission mode. Set table mode to transmission: Send the instruction "SetTableMode" (<;D00D01>/ {; }) (refer to section 5.1.6). An optimum position for the Spectrolino relative to the lamp for transmission measurements is searched. The table mode can also be changed manually by pressing <Zero> and <Measure> simultaneously. When switched to transmission mode, lights are turned on and Spectrolino is moved to find the optimum position for transmission measurements. It is then moved to a standby position. When switched to reflectance mode, Spectrolino is moved to home position. Set SpectroScanT to transmission mode Perform a white calibration No Yes 10 measurements done? Perform repositioning Perform a white calibration: Send the instruction "ExecRefMeasurement" (<;220907>/ {; }). The reply should be <:2513>/{: 37 19} (refer to section ). A white calibration can also be executed manually by pressing the <Zero> key shortly. Perform repositioning and white calibration: Press <Zero> key on SpectroScanT until device starts moving. The optimum position for the Spectrolino relative to the lamp for transmission measurements is searched. A white calibration is done afterwards. Pressing the <Zero> key shortly only executes a white calibration. Perform a measurement and read values No Yes Change aperture? Perform a measurement and read values: (refer to section 2.3). A measurement can also be executed manually by pressing the <Measure> key. Execute more measurements? No End of transmission measurement routine Yes 10 measurements done?: In order to enhance the accuracy, a new white calibration should be performed every 10 measurements. Execute more measurements?: If the measurement type is changed during the application, a new emission calibration has to be performed. 37