Stream 2 - Equipment Control¶

Overview¶

Stream 2 messages are used for equipment control, configuration, and remote command execution.

Supported Messages¶

Message	Name	Direction	Description
S2F13	Equipment Constant Request	H→E	Request EC values
S2F14	Equipment Constant Data	E→H	Return EC values
S2F15	New Equipment Constant Send	H→E	Set EC values
S2F16	New Equipment Constant Acknowledge	E→H	Set EC response
S2F17	Date and Time Request	H→E	Request date/time
S2F18	Date and Time Data	E→H	Return date/time
S2F23	Trace Initialize Send	H→E	Configure trace
S2F24	Trace Initialize Acknowledge	E→H	Trace config response
S2F29	Equipment Constant Namelist Request	H→E	Request EC definitions
S2F30	Equipment Constant Namelist	E→H	Return EC definitions
S2F31	Date and Time Set Request	H→E	Set date/time
S2F32	Date and Time Set Acknowledge	E→H	Set date/time response
S2F33	Define Report	H→E	Define report content
S2F34	Define Report Acknowledge	E→H	Report definition response
S2F35	Link Event Report	H→E	Link reports to events
S2F36	Link Event Report Acknowledge	E→H	Link response
S2F37	Enable/Disable Event Report	H→E	Enable/disable events
S2F38	Enable/Disable Event Acknowledge	E→H	Enable response
S2F41	Host Command Send	H→E	Remote command
S2F42	Host Command Acknowledge	E→H	Command response
S2F43	Define Spool Streams	H→E	Configure spooling
S2F44	Spool Stream Acknowledge	E→H	Spool config response

S2F13 - Equipment Constant Request¶

Direction: H→E Reply: S2F14 W-Bit: Yes

Structure¶

S2F13 W
<L[n]
  <ECID U4>          // Equipment constant IDs
  ...
>

Empty list requests all ECs:

S2F13 W
<L[0]>

S2F14 - Equipment Constant Data¶

Direction: E→H Reply Required: No

Structure¶

S2F14
<L[n]
  <ECV>              // Equipment constant values
  ...
>

S2F15 - New Equipment Constant Send¶

Direction: H→E Reply: S2F16 W-Bit: Yes

Structure¶

S2F15 W
<L[n]
  <L[2]
    <ECID U4>        // Equipment constant ID
    <ECV>            // New value
  >
  ...
>

Example¶

S2F15 W
<L[2]
  <L[2]
    <U4 10>          // ECID: T3 Timer
    <U2 60>          // New value: 60 seconds
  >
  <L[2]
    <U4 11>          // ECID: T5 Timer
    <U2 15>          // New value: 15 seconds
  >
>

S2F16 - New Equipment Constant Acknowledge¶

Direction: E→H Reply Required: No

Structure¶

S2F16
<EAC B[1]>

EAC Values¶

Value	Description
0x00	Accepted
0x01	Denied, at least one constant invalid
0x02	Denied, busy
0x03	Denied, at least one ECID invalid
0x04	Denied, at least one ECV out of range

S2F17 - Date and Time Request¶

Direction: H→E Reply: S2F18 W-Bit: Yes

Structure¶

S2F17 W
<L[0]>

S2F18 - Date and Time Data¶

Direction: E→H Reply Required: No

Structure¶

S2F18
<TIME A[12-16]>      // YYYYMMDDHHmmss or YYYYMMDDHHmmsscc

Example¶

S2F18
<A "20241231120000">

S2F29 - Equipment Constant Namelist Request¶

Direction: H→E Reply: S2F30 W-Bit: Yes

Structure¶

S2F29 W
<L[n]
  <ECID U4>          // ECIDs to query (empty = all)
  ...
>

S2F30 - Equipment Constant Namelist¶

Direction: E→H Reply Required: No

Structure¶

S2F30
<L[n]
  <L[6]
    <ECID U4>
    <ECNAME A>
    <ECMIN>          // Minimum value
    <ECMAX>          // Maximum value
    <ECDEF>          // Default value
    <UNITS A>
  >
  ...
>

S2F31 - Date and Time Set Request¶

Direction: H→E Reply: S2F32 W-Bit: Yes

Structure¶

S2F31 W
<TIME A>

S2F32 - Date and Time Set Acknowledge¶

Direction: E→H Reply Required: No

Structure¶

S2F32
<TIACK B[1]>

TIACK Values¶

Value	Description
0x00	Accepted
0x01	Error, not done

S2F33 - Define Report¶

Direction: H→E Reply: S2F34 W-Bit: Yes

Structure¶

S2F33 W
<L[2]
  <DATAID U4>
  <L[n]              // Report definitions
    <L[2]
      <RPTID U4>     // Report ID
      <L[m]          // Variable list
        <VID U4>
        ...
      >
    >
    ...
  >
>

Example¶

S2F33 W
<L[2]
  <U4 1>
  <L[1]
    <L[2]
      <U4 100>       // Report ID
      <L[3]          // Variables in report
        <U4 1>       // Clock
        <U4 2>       // ControlState
        <U4 3>       // ProcessState
      >
    >
  >
>

S2F34 - Define Report Acknowledge¶

Direction: E→H Reply Required: No

Structure¶

S2F34
<DRACK B[1]>

DRACK Values¶

Value	Description
0x00	Accepted
0x01	Denied, insufficient space
0x02	Denied, invalid format
0x03	Denied, at least one RPTID already defined
0x04	Denied, at least one VID invalid

S2F35 - Link Event Report¶

Direction: H→E Reply: S2F36 W-Bit: Yes

Structure¶

S2F35 W
<L[2]
  <DATAID U4>
  <L[n]              // Event-Report links
    <L[2]
      <CEID U4>      // Collection Event ID
      <L[m]          // Report IDs to link
        <RPTID U4>
        ...
      >
    >
    ...
  >
>

S2F36 - Link Event Report Acknowledge¶

Direction: E→H Reply Required: No

Structure¶

S2F36
<LRACK B[1]>

LRACK Values¶

Value	Description
0x00	Accepted
0x01	Denied, insufficient space
0x02	Denied, invalid format
0x03	Denied, at least one CEID not defined
0x04	Denied, at least one RPTID not defined

S2F37 - Enable/Disable Event Report¶

Direction: H→E Reply: S2F38 W-Bit: Yes

Structure¶

S2F37 W
<L[2]
  <CEED Boolean>     // 0=Disable, 1=Enable
  <L[n]              // Event IDs (empty = all)
    <CEID U4>
    ...
  >
>

S2F38 - Enable/Disable Event Acknowledge¶

Direction: E→H Reply Required: No

Structure¶

S2F38
<ERACK B[1]>

ERACK Values¶

Value	Description
0x00	Accepted
0x01	Denied, at least one CEID invalid

S2F41 - Host Command Send¶

Direction: H→E Reply: S2F42 W-Bit: Yes

Structure¶

S2F41 W
<L[2]
  <RCMD A>           // Remote command name
  <L[n]              // Command parameters
    <L[2]
      <CPNAME A>     // Parameter name
      <CPVAL>        // Parameter value
    >
    ...
  >
>

Example¶

S2F41 W
<L[2]
  <A "START">
  <L[2]
    <L[2]
      <A "RecipeID">
      <A "RECIPE001">
    >
    <L[2]
      <A "LotID">
      <A "LOT001">
    >
  >
>

S2F42 - Host Command Acknowledge¶

Direction: E→H Reply Required: No

Structure¶

S2F42
<L[2]
  <HCACK B[1]>       // Command acknowledge
  <L[n]              // Parameter status (if error)
    <L[2]
      <CPNAME A>
      <CPACK B[1]>   // Parameter acknowledge
    >
    ...
  >
>

HCACK Values¶

Value	Description
0x00	Acknowledge, command accepted
0x01	Denied, invalid command
0x02	Denied, cannot perform now
0x03	Denied, parameter error
0x04	Acknowledge, will complete later
0x05	Rejected, already in desired state
0x06	Denied, no such object

CPACK Values¶

Value	Description
0x01	CPNAME not valid
0x02	CPVAL illegal value
0x03	CPVAL out of range

S2F43 - Define Spool Streams¶

Direction: H→E Reply: S2F44 W-Bit: Yes

Structure¶

S2F43 W
<L[n]
  <L[2]
    <STRID U1>       // Stream ID
    <STSPM U1>       // 0=Off, 1=On, 2=Purge
  >
  ...
>

S2F44 - Spool Stream Acknowledge¶

Direction: E→H Reply Required: No

Structure¶

S2F44
<L[n]
  <L[2]
    <STRID U1>
    <STSPACK B[1]>
  >
  ...
>

STSPACK Values¶

Value	Description
0x00	OK
0x01	Stream not valid
0x02	Stream not supported for spooling