ECO History: Date Revision ECO# Description of Change

Size: px

Start display at page:

Download "ECO History: Date Revision ECO# Description of Change"

Sydney Anderson
5 years ago
Views:

1 Serial Commands Model Rev - Cognizant Individuals: Prepared by: Arndt Poecher Date: Approved by: Date: ECO History: Date Revision ECO# Description of Change Purpose and Scope: This document describes shared and special serial commands for the Model 8525 and Model 3007 Condensation Particle Counter. Communication Protocol: The Model 8525 and Model 3007 feature a serial interface allowing a host PC to interrogate and configure instrument parameters via an RS-232 serial interface. The commands consist of a predetermined number of ASCII characters including four command characters followed by data with a two byte terminator. Upon receipt of valid terminators, the instrument checks the command string and length for validity. If the command is valid, the specified action is completed and a return string transmitted from the instrument to the host. If an invalid command string is received, an error string is transmitted to the host. The communication protocol for data transmission is as follows: BAUD RATE: 9600 PARITY: NONE DATA BITS: 8 STOP BITS: 1 HANDSHAKING: NONE Serial_commands_Model3007.doc Page 1 of 12

2 A) Listing of the shared serial commands for the Model 8525 and Model 3007: Program Commands: Program commands allow a host PC to configure the Model 8525 and Model Upon receipt of a valid string by the instrument, the specified action is completed and an identical string returned to the host for validation. Incorrect command strings cause the instrument to return an error message. The following is a list of shared commands and description of the parameters: Program Instrument Serial Number Command String: PLSNUMaaaarmmyynnnn<CR><LF> [19] Variable: aaaa = model, r = revision, mm = month, yy = year, n = serial number Example: PLSNUM8525a <CR><LF> (model number = 8525, revision a, month = November, year = 99, serial number = 1001) Program Instrument Backlight Delay Command String: PLBACKxx<CR><LF> [8] Variables: xx = delay in seconds, 0 = no backlight Range: 0, 5,10,30 Example: PLBACK30<CR><LF> (30 second delay) Program Instrument Service Date Command String: PLSERVmm/dd/yy<CR><LF> [16] Variables: mm = month, dd = day, yy = year Example: PLSERV01/19/99<CR><LF> (January 19, 1999) Program Instrument Time Command String: PLTIMEhh:mm:ss<CR><LF> [14] Variables: hh = hours, mm = minutes, ss = seconds Example: PLTIME15:00:00<CR><LF> (3:00:00 p.m.) Program Instrument Date Command String: PLDATEmm/dd/yyyy<CR><LF> [16] Variables: mm = month, dd = day, yyyy = year Example: PLDATE01/19/1999<CR><LF> (January 19, 1999) Reset RunTime Clock Command String: PRUNCLK<CR><LF> [7] Variables: None Example: PRUNCLK<CR><LF> Program Data Clear Memory Command String: PLCLRM<CR><LF> [6] Variables: None Example: PLCLRM<CR><LF> (clear data memory) Serial_commands_Model3007.doc Page 2 of 12

3 Program Pump Voltage TSI Incorporated Command String: PLPUMPxxxx<CR><LF> [10] Variables: xxxx = voltage value x 1000 Range: 0 to 5000 Example: PLPUMP4200<CR><LF> (pump voltage set to volts) Program TED Voltage Command String: PLTEDVxxxx<CR><LF> [9] Variables: xxxx = voltage value x 1000 Range: 0 to 2000 Example: PLTEDV0900<CR><LF> (voltage set to volts) Program Instrument Serial Number Command String: PLSNUMaaaarmmyynnnn<CR><LF> [19] Variable: aaaa = model, r = revision, mm = month, yy = year, n = serial number Example: PLSNUM8525a <CR><LF> (model number = 8525, revision a, month = November, year = 99, serial number = 1001) Serial_commands_Model3007.doc Page 3 of 12

4 Program Data Logger The following commands are used to program the data logging functions through TrakPro and the Aerosol Instrument Manager (AIM). Most of these commands are not commonly used, and the level of documentation is rather crude. Program Logging Time Command String: PMTIME Program Logging Date Command String: PMDATE Program Logging Interval Command String: PMLINT Program Logging Sample Length Command String: PMSLEN Program Number of Tests Command String: PMNUMT Program Time Between Tests Command String: PMIDLE Program Statistics(?) Command String: PMSTAT Program Logging Interval Two? Command String: PLLINT Serial_commands_Model3007.doc Page 4 of 12

5 Undocumented Commands The following firmware commands are not currently documented. They exist in the Model 8525 and Model 3007 firmware (and other instruments). Command String: PLMODL Command String: PLLANG Command String: QLDISP Command String: QLSTAT Command String: QLDATM Command String: QLLOGN Command String: QLPMEM Command String: QLAMBP Command String: QLDIFP Command String: QLRAWC Command String: QLPULS Command String: QLNTST Error Message Command String:?<CR><LF> [1] Serial_commands_Model3007.doc Page 5 of 12

6 Query Commands Query commands allow a host PC to interrogate the configuration and operational parameters of the Model 8525 and Model Upon receipt of a valid string by the instrument, a string containing the requested data is returned to the host. Incorrect query requests cause the instrument to return an error message. The following is a list of commands and description of the parameters: Query Instrument Serial Number Command String: QLSNUM<CR><LF> [6] Return String: QLSNUMaaaarmmyynnnn<CR><LF> [19] Variable: aaaa = model, r = revision, mm = month, yy = year, nnnn = number Example: QLSNUM8525a <CR><LF> (model number = 8525, revision a, month = November, year = 98, serial number = 1001) Query Instrument Model Number Command String: QLMODL<CR><LF> [6] Return String: QLMODLxxxx<CR><LF> [10] Variables: xxxx = model number Example: QLMODL8525<CR><LF> (model number = 8525) Query Instrument Language Version Command String: QLLANG<CR><LF> [6] Return String: QLLANGx<CR><LF> [7] Variables: x = language version (0=English) Example: QLLANG0<CR><LF> (language is set to English) Query Instrument Backlight Delay Command String: QLBACK<CR><LF> [6] Return String: QLBACKxx<CR><LF> [8] Variables: xx = delay in seconds, 0 = no backlight Range: 0, 5, 10,30 Example: QLBACK30<CR><LF> (backlight delay = 30 seconds) Query Instrument Service Date Command String: QLSERV<CR><LF> [6] Return String: QLSERVmm/dd/yy<CR><LF> [18] Variables: mm = month, dd = day, yy = year Example: QLSERV01/30/99<CR><LF> (service date = January 30, 1999) Query Instrument RunTime Clock Command String: QLRTCLK<CR><LF> [9] Return String: QLRTCLKddd:hh<CR><LF> Variables: None Example: QLRTCLK150:23<CR><LF> (run time of 150 days, 23 hours) Note: ddd is a variable length field. It will truncate leading zeroes. Therefore, when the run time is reset to zero, this will result in a return of QLRTCLK0:00. Serial_commands_Model3007.doc Page 6 of 12

7 Query Instrument Time TSI Incorporated Command String: QLTIME<CR><LF> [6] Return String: QLTIMEhh:mm:ss<CR><LF> [14] Variables: hh = hours, mm = minutes, ss = seconds Example: QLTIME15:00:00 <CR><LF> (instrument time = 3:00:00 p.m.) Query Instrument Date Command String: QLDATE<CR><LF> [6] Return String: QLDATEmm/dd/yy<CR><LF> [16] Variables: mm = month, dd = day, yy = year Example: QLDATE01/19/99<CR><LF> (instrument date = January 19, 1999) Query Instrument Prom Version Command String: QLPROM<CR><LF> [6] Return String: QLPROMx.x<CR><LF> [9] Variables: x.x = prom revision Example: QLPROM1.0<CR><LF> (prom version = 1.0) Query Data Number of Logged Tests Command String: QLTEST<CR><LF> [6] Return String: QLTESTxxx<CR><LF> [9] Variables: xxx = number of tests Range: 0 to 999 Example: QLTEST010<CR><LF> (number of tests = 10) Query Log Data Free Memory Command String: QLFREE<CR><LF> [6] Return String: QLFREExxx<CR><LF> [8] Variables: xxx = % free memory Example: QLFREE050<CR><LF> (free memory = 50%) This query refers to the available memory for logging data files. It does not query the available memory for single data points. Query Number of Single Points Command String: QLNSDP<CR><LF> [6] Return String: QLNSDPx<CR><LF> [7] Variables: x = number of single data points (variable length field) Range: 0 to 999 Example: QLNSDP5<CR><LF> (number of single data points = 5) Query System Error Code Command String: QLSYSE<CR><LF> [6] Return String: QLSYSExx<CR><LF> [8] Variables: xx = error code Example: QLSYSE01<CR><LF> (error code = 01) Serial_commands_Model3007.doc Page 7 of 12

8 Query Pump Voltage Setpoint TSI Incorporated Command String: QLPUMP<CR><LF> Return String: QLPUMPxxxx<CR><LF> Variables: xxxx = voltage value x 1000 Range: 0 to 5000 Example: QLPUMP4200<CR><LF> (pump voltage is set at volts) Note: this queries the setpoint value. The actual pump voltage is read by the following command. Query Pump Voltage Actual Command String: QLPMPV<CR><LF> Return String: QLPMPVx.xx<CR><LF> Variables: x.xx = pump voltage value, with proper decimal place Example: QLPMPV3.19<CR><LF> (pump voltage is running at 3.19 volts) Query Pump Current Command String: QLPMPI<CR><LF> [6] Return String: QLPMPI.xxx<CR><LF> [10] Variable:.xxx = pump current (note decimal place) Example: QLPMPI.033<CR><LF> (pump current is amp) Query KeyPad Press Command String: QLKEYPD<CR><LF> [7] Return String: QLKEYPDx<CR><LF> [8] Variable: x = key number, (1=ENTER, 2=DOWN, 3=UP, 4=RIGHT, 5=LEFT) Example: QLKEYPD2<CR><LF> ( DOWN key was pressed) ( enter = 1; down = 2; up = 3; right = 4; and left = 5) Query Particle Concentration Command String: QLCONC<CR><LF> [6] Return String: QLCONCxxxxxx<CR><LF> [12] Variable: xxxxxx = particle concentration, pt/cc, 0-500,000 Example: QLCONC002500<CR><LF> (particle concentration is 2,500 pt/cc) Query TED Voltage Setpoint Command String: QLTEDV<CR><LF> [6] Return String: QLTEDVxxxx<CR><LF> [10] Variable: xxxx = TED voltage, x1000 Example: QLTED0850<CR><LF> (TED voltage set to volts; note leading zero) Query TED Voltage Actual Command String: QLTEDA<CR><LF> Return String: QLTEDAx.xx<CR><LF> Variables: x.xx = TED voltage value, with proper decimal place (leading zero) Example: QLTEDA0.83<CR><LF> (TED voltage is running at 0.83 volts) Query TED Current Command String: QLTEDI<CR><LF> [6] Return String: QLTEDI.xxx<CR><LF> [10] Variable:.xxx = TED current (note decimal place) Example: QLTEDI.200<CR><LF> (TED current is amp) Serial_commands_Model3007.doc Page 8 of 12

9 Query Laser Current TSI Incorporated Command String: QLLSRI<CR><LF> [6] Return String: QLLSRI.xxx<CR><LF> [10] Variable:.xxx = laser current (note decimal place) Example: QLLSRI.045<CR><LF> (laser current is amp) Query Detector Background Voltage Command String: QLBGND<CR><LF> [9] Return String: QLBGND.xxx<CR><LF> [10] Variable:.xxx = background voltage (note decimal place) Example: QLBGND.777<CR><LF> (background voltage is volts) Error Message Command String:?<CR><LF> [1] Serial_commands_Model3007.doc Page 9 of 12

10 B) Special serial commands for the Model3007 Condensation Particle Counter in addition to the serial command set for the Model8525: Program Commands: Program Differential Set Point Command String: PLDPSPxxxx<CR><LF> [10] Example: PLDPSP1720<CR><LF> (Program of the differential pressure set point [here 1720 bit], to set the flow control target) Program Aerosol Inlet Pressure Gain Command String: PLAIPGxxxx<CR><LF> [10] Example: PLAIPG0988<CR><LF> (After the transmission of the absolute pressure value [here 988mBar], the current inlet pressure transducer value is recorded, in order to calculate the gain. The offset is assumed to be zero.) Program Concentration Calibration Factor Command String: PLCCFxxxx<CR><LF> [9] Note: Multiply the concentration calibration factor by 1000 before it is send to the instrument. Example: To store a calibration factor of in the instrument send the command Send to Instrument: PLCCF1125<CR><LF> Serial_commands_Model3007.doc Page 10 of 12

11 Query Commands: Query Aerosol Inlet Pressure Command String: QLAINP<CR><LF> [6] Return String: QLAINPxxxx<CR><LF> [10] Variable: xxxx = (rounded to the nearest even number) Example: QLAINP0988<CR><LF> (Return of the current aerosol inlet pressure value [here 988 mbar]) Query Aerosol Inlet Pressure Transducer Gain Offset Command String: QLAIGO<CR><LF> [6] Return String: QLAIGOxxxx<CR><LF> [10] Example: QLAIGO0030<CR><LF> (Return of stored aerosol inlet pressure transducer gain and offset value in bit [here 30 bit]) Query Differential Pressure Command String: QLDIFP<CR><LF> [6] Return String: QLDIFPxxxx<CR><LF> [10] Example: QLDIFPO1735<CR><LF> (Return of the current differential pressure value in bit [here 1735 bit]) Query Differential Set Point Command String: QLDPSP<CR><LF> [6] Return String: QLDPSPxxxx<CR><LF> [10] Example: QLDPSP1720<CR><LF> (Return of the stored differential pressure set point (flow control target) Serial_commands_Model3007.doc Page 11 of 12

12 Read Commands: Read Display Command String: RD<CR><LF> [2] Return String: RDxxxxxx<CR><LF> [8] Variable: xxxxxx = Example: RD001000<CR><LF> (Return of the displayed, one second averaged, aerosol concentration [here 1000 particles per cubic centimeter]) Read Aerosol Inlet Pressure Command String: RAP<CR><LF> [3] Return String: RAPxxxx<CR><LF> [7] Variable: xxxx = (rounded to the nearest even number) Example: RAP0988<CR><LF> (Return of the current aerosol inlet pressure value [here 988 mbar]) Read Differential Pressure Command String: RDP<CR><LF> [3] Return String: RDPxxxx<CR><LF> [7] Example: RDP1735<CR><LF> (Return of the current differential pressure value in bit [here 1735 bit]) Read Concentration Calibration Factor Command String: RDCCF<CR><LF> [5] Return String: RDCCFxxxx<CR><LF> [9] Note: Divide the received value by 1000 to obtain the stored concentration calibration factor. Example: The calibration factor equals for the following string received from the instrument Send to Instrument: Received to Instrument: RDCCF<CR><LF> RDCCF1060<CR><LF> Serial_commands_Model3007.doc Page 12 of 12

QEL - DEDESCO 5935 Ottawa Street Richmond, Ontario, Canada, K0A 2Z0.

QEL - DEDESCO 5935 Ottawa Street Richmond, Ontario, Canada, K0A 2Z0. QTS-8000 RS-485 Data Communication Protocols 82050-005-000 Name Signature Date Prepared: Gang Li 00-05-15 Reviewed: Checked: Approved: