AutoSFDC Commands

From 42Q
Revision as of 15:51, 20 November 2014 by Ashley martin (talk | contribs) (Created page with "<br> <center>'''AutoSFDC Commands'''</center> <center>'''and Protocol'''</center> <br> === Introduction === This document describes the communication protocol which has be...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search


AutoSFDC Commands
and Protocol



Introduction

This document describes the communication protocol which has been implemented in Autosfdc XML 2.12b and greater. This protocol is based on a TCP socket call over IP. Autosfdc handles two TCP ports for communication: 18000 : for Autosfdc commands (protocol as described in this document). 18080 : Http GET commands only (for remote management).


Definition

  1. The protocol is client/server. Client initiates all communications.
  2. The client will only receive one answer per request.
  3. The minimum message length is four (4) bytes. Any shorter message will return a syntax error response.
  4. The ASCII characters which are valid in Autosfdc request are : 'a'..'z', 'A'..'Z', '0'..'9', '@', '&', '+', '-' ,'*', '#', '='
  5. Datacollector ID length is (3) bytes. It is the datacollector device ID, not the position on the PCC line. Leading zero(s) need to be added, if ID is less than 100. Example : Datacollector S020 --> ID = '020'.
  6. Error Code length is (2) bytes. See 'Error code definition' section for more information.


This table explains each AutoSFDC XML command function, the operation steps and the result of the operation.


Command Description Operation Result
O = Logout


Note: In AutoSFDC XML 2.12 and greater, the O command response can be configured.


CHANGE_O_CMMD_ERR_CODE=N return error codes (01,02...99) if fails.


# Enter Device ID + O command at the Serial Number? prompt.


# Response value is “00”


# Enter Device ID + O command at the Employee No.? prompt.


# Response value is “99”


# Enter Device ID + O command when at the Revision? prompt.


# Response value is “00”


# Enter Device ID + space + O command.


# Response value is “07”


# Enter O command at the Password? prompt.


# Response value is ”99”


O = Logout


Note: In AutoSFDC XML 2.12 and greater, the O command response can be configured.


CHANGE_O_CMMD_ERR_CODE=Y return 00 as O command answer code.


(Default) CHANGE_O_CMMD_ERR_CODE=Y

# Enter Device ID + O command at the Serial Number? Prompt.


# Response value is “00”


# Enter Device ID + O command at the Employee No.? prompt.


# Response value is “00”


# Enter Device ID + O command when at the Revision? prompt.


# Response value is “00”


# Enter Device ID + space + O command.


# Response value is “07”


# Enter O command at the Password? prompt.


# Response value is “00”


I = Login #
    1. Enter Device ID + I command at the Employee No.? prompt.


 # Response value is “00”


#
    1. Enter Device ID + I + wrong Employee No. at the Employee No.? prompt.


 # Response value is “99”


#
    1. Enter Device ID + I + Employee No. at the Password? prompt.


 # Response value is “00”


#
    1. Enter Device ID + I + Employee No. + @correct_password at the Password? prompt.


 # Response value is “00”


#
    1. Enter Device ID + I + Employee No. + @wrong_password at the Password? prompt.


 # Response value is “99”


P = End

Pass to next location

#
    1. Enter Device ID + P + S/N at the Serial Number? prompt.


 # Response value is “00”


#
    1. Enter Device ID + P + S/N at the Serial Number? prompt. (S/N is at a different location.)


 # Response value is “01” (system will display current location for this S/N.)


#
    1. Enter Device ID + P + wrong S/N format at the Serial Number? prompt.


 # Response value is “06”


#
    1. Enter Device ID + P + SN at the Revision? prompt.


 # Response value is “00” (serial not passed to next location.)


#
    1. Enter Device ID + P + S/N at the Serial Number? prompt. (Scanning the serial number will prompt for a Revision.)


 # Response value is “00” (although system prompts “00”, it prompts for Revision, but does not pass to the next location.)


T = Transparent

Enter corresponding parameter according to screen prompts. (T command includes all the commands in SFDC)


Note: In AutoSFDC XML 2.12 and greater, the T command response can be configured.


(Default)

CHANGE_T_CMMD_ERR_CODE=Y return 00 as T command answer code.

1. Enter Device ID + T + parameter (parameter must be a valid response to the displayed prompt.) # Response value is “00”


2. Enter Device ID + T + parameter (SFDC sever shutdown.) # Response value is “05”


3. Command Syntax Error. # Response value is “00”


4. Enter Device ID + T + parameter (parameter incorrect for prompt.) # Response value is “00”


T = Transparent

Enter corresponding parameter according to screen prompts. (T command includes all the commands in SFDC)


Note: In AutoSFDC XML 2.12 and greater, the T command response can be configured.


CHANGE_T_CMMD_ERR_CODE=N return error codes (01,02...99) if fails.

1. Enter Device ID + T + parameter (parameter must be a valid response to the displayed prompt.) # Response value is “00”


2. Enter Device ID + T + parameter (SFDC sever shutdown.) # Response value is “05”


3. Command Syntax Error. # Response value is “07”


4. Enter Device ID + T + parameter (parameter incorrect for prompt.) # Refer to the codes table for descriptions for specific error responses.


t = Transparent (extended)

Same as T command except that an extended response is returned. (example: When adding units to a container, the container count information is included).

1. Refer to T command information for command format. # Response matces T command, based upon the configuration of CHANGE_T_CMMD_ERR_CODE=Y/N


H = VWHST

view the S/N history

1. Enter Device ID + H + new S/N at the Serial Number? prompt. # Response value is “00” (message = Device ID 00+ S/N@<end>)


2. Enter Device ID + H + S/N at the Serial Number? prompt (existing serial number with unit history.) # Response value is “00” (message = Device ID 00+ S/N operation history@<end> )


C = Check

validate S/N location


Note: The C command can be used at a start station to create a serial record.

1. Enter Device ID + C + S/N at the Serial Number? prompt (S/N is in a current scanning location.) # Response value is “00”


2. Enter Device ID + C + new S/N at the Serial Number? prompt. # Response value is “00”


3. Enter Device ID + C + S/N at the Serial Number? prompt (S/N is in a different location than scanning location.) # Response value is “01” (message = Device ID 01+ S/N@ current location.)


F = RCDFC

(i.e. RDNNNNNNNNN), used to record a defect code


Note: Repaired=YES/NO. If YES is entered, defect is recorded, unit failed, repaired and passed to next location. If NO is entered, defect is recorded and unit failed to location specified in the route.

1. Enter Device ID + F+ S/N + @Defect code at the Serial Number? prompt. # Response value is “00”


2. Enter Device ID + F + S/N + @Defect code + @Qty at the Serial Number? prompt (CMD: RDQNNNNNNNN) # Response value is “00”


3. Enter Device ID + F + S/N + @Defect code + @Defect Quantity + @RefDes or N/A + @Pin 1 + @Pin 2 + @Surface + @N/A + @YES at the Serial Number? prompt (CMD=RDQQQQQQNNQ, where N/A is entered for DefPart and Yes is entered for Repaired.) # Response value is “00” (Defect is logged and unit failed, repaired, and passed to next location.)


4. Enter Device ID + F + S/N + @Defect code + @Defect Quantity + @RefDes or N/A + @Pin 1 + @Pin 2 + @Surface + @DefPart or N/A + @Manufacturer + @Mfr Lot Code + @Repaired at the Serial Number? prompt (CMD=RDQQQQQQQQQ) # Response value is “00” See Note regarding Repaired=YES/NO


M = Meas

Measurement key activity recorded against the s/n with key generated for use by SFDC Measurement.

1. Enter Device ID + M + S/N at the Menu Selection? prompt. # Response value is “00” (measurement activity recorded in unit history.)


R = RCRPR

Record a repair against a defect.


Note: There are 2 possible values that can be used for repaired (YES or repair/defect code). If no repaired value is enter, response is assumed to be YES


Note: To perform a complete repair, the R command should be followed with a P or T command to pass the unit back to the correct location as specified in the route.

1. Enter Device ID + R + S/N + @defect_description + @YES at the Menu Selection? prompt. # Response value is “00” (A RLSE is included as part of the command. Device will be at the Serial Number? prompt.)


2. Enter Device ID + R + S/N + @defect_description + @repair_code at the Menu Selection? prompt. # Response value is “00” (A RLSE is included as part of the command. Device will be at the Serial Number? prompt.)


Q = Assign Product Number


Note: This command can only be issued at a “Product Number?” prompt. The T or C commands can be used to create a serial record followed by the Q command to specify product number.

1. Enter Device ID + Q + product_number (part_number) at the Menu Selection? prompt. # Response value is “00” (A RLSE is included as part of the command. Device will be at the Serial Number? prompt.)


D = Tester Defect

Repair tester (existing) defect and record a new defect


Note: The customized record command can be modified and the correct parameters provided as part of the command string (example: RDNQNNNNNNQ@defcode@refdes@YES@END will record a new defect, with reference designator, and repair it.)

1. Enter Device ID + D + S/N + @RDNNNNNNNNN + @defcode + @[parameters] + @END at the Serial Number? prompt. # Response value is “00”
(RLSE can be substitued for END to leave the unit at the current location.)


Each code in a “response value” defines a particular message. The following table displays the response codes and the corresponding message.


Code Short description Comment
00 OK Transaction complete successfully.
01 Flow Error Previous step not complete.
02 Invalid Entry Data entry rejected by SFDC.
03 Time Out Interface PC did not answer before time-out.
04 System Busy SFDC system is not available.
05 System Shutdown SFDC system is shutdown.
06 Serial Not Found Serial number not declare to SFDC.
07 Syntax Error Invalid command or data format.
08 Ask for Prod Product part number is not define to SFDC.
09 Duplicate Id Not implemented.
10 Serial in Use Serial number already in use at another location.
20 Not Managed Datacollector Id is not managed by autosfdc.
21 Unit in Hold Serial number is in hold.
22 DTC in Use Datacollector Id already in use.
99 Unknown Error An unknown error occurred. (See Log file.)
Retrieved from "https://42qrpt1.42-q.com/mes_wiki/index.php?title=AutoSFDC_Commands&oldid=19318"