Functions¶

Wrappers for SECS stream and functions

class secsgem.secs.functions.SecsS00F00(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 00, function 00 - hsms communication

Example:

>>> import secsgem
>>> secsgem.SecsS00F00()
S0F0

Parameters:	value (None) – function has no parameters

class secsgem.secs.functions.SecsS01F00(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 01, function 00 - abort transaction stream 1

Example:

>>> import secsgem
>>> secsgem.SecsS01F00()
S1F0

Parameters:	value (None) – function has no parameters

class secsgem.secs.functions.SecsS01F01(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 01, function 01 - are you online - request

Example:

>>> import secsgem
>>> secsgem.SecsS01F01()
S1F1 W

Parameters:	value (None) – function has no parameters

class secsgem.secs.functions.SecsS01F02(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 01, function 02 - on line data

Caution

This Stream/function has different structures depending on the source. If it is sent from the eqipment side it has the structure below, if it is sent from the host it is an empty list. Be sure to fill the array accordingly.

Structure E->H:

{
    MDLN: A[20]
    SOFTREV: A[20]
}

Example:

>>> import secsgem
>>> secsgem.SecsS01F02(['secsgem', '0.0.3']) # E->H
S1F2
  <L [2]
    <A "secsgem">
    <A "0.0.3">
  >
>>> secsgem.SecsS01F02() #H->E
S1F2
  <L>

Parameters:	value (list) – parameters for this function (see example)

class secsgem.secs.functions.SecsS01F03(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 01, function 03 - selected equipment status - request

Structure:

[
    SVID: U4[1]
    ...
]

Example:

>>> import secsgem
>>> secsgem.SecsS01F03([1, 6, 12])
S1F3 W
  <L [3]
    <U4 1 >
    <U4 6 >
    <U4 12 >
  >

Parameters:	value (list) – parameters for this function (see example)

class secsgem.secs.functions.SecsS01F04(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 01, function 04 - selected equipment status - data

Structure:

[
    SV: various
    ...
]

Example:

>>> import secsgem
>>> secsgem.SecsS01F04([secsgem.SecsVarU1(value=1), "text", secsgem.SecsVarU4(value=1337)])
S1F4
  <L [3]
    <U1 1 >
    <A "text">
    <U4 1337 >
  >

Parameters:	value (list) – parameters for this function (see example)

class secsgem.secs.functions.SecsS01F11(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 01, function 11 - status variable namelist - request

Structure:

[
    SVID: U4[1]
    ...
]

Example:

>>> import secsgem
>>> secsgem.SecsS01F11([1, 1337])
S1F11 W
  <L [2]
    <U4 1 >
    <U4 1337 >
  >

An empty list will return all available status variables.

Parameters:	value (list) – parameters for this function (see example)

class secsgem.secs.functions.SecsS01F12(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 01, function 12 - status variable namelist - reply

Structure:

[
    {
        SVID: U4[1]
        SVNAME: A[n]
        UNITS: A[n]
    }
    ...
]

Example:

>>> import secsgem
>>> secsgem.SecsS01F12([{"SVID": 1, "SVNAME": "SV1", "UNITS": "mm"}, {"SVID": 1337, "SVNAME": "SV2", "UNITS": ""}])
S1F12
  <L [2]
    <L [3]
      <U4 1 >
      <A "SV1">
      <A "mm">
    >
    <L [3]
      <U4 1337 >
      <A "SV2">
      <A>
    >
  >

Parameters:	value (list) – parameters for this function (see example)

class secsgem.secs.functions.SecsS01F13(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 01, function 13 - establish communication - request

Caution

This Stream/function has different structures depending on the source. If it is sent from the eqipment side it has the structure below, if it is sent from the host it is an empty list. Be sure to fill the array accordingly.

Structure E->H:

{
    MDLN: A[20]
    SOFTREV: A[20]
}

Example:

>>> import secsgem
>>> secsgem.SecsS01F13(['secsgem', '0.0.3']) # E->H
S1F13 W
  <L [2]
    <A "secsgem">
    <A "0.0.3">
  >
>>> secsgem.SecsS01F13() #H->E
S1F13 W
  <L>

Parameters:	value (list) – parameters for this function (see example)

class secsgem.secs.functions.SecsS01F14(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 01, function 14 - establish communication - acknowledge

Caution

This Stream/function has different structures depending on the source. See structure definition below for details. Be sure to fill the array accordingly.

Structure E->H:

{
    COMMACK: B[1]
    DATA: {
        MDLN: A[20]
        SOFTREV: A[20]
    }
}

Structure H->E:

{
    COMMACK: B[1]
    DATA: []
}

Example:

>>> import secsgem
>>> secsgem.SecsS01F14({"COMMACK": 1, "DATA": ["secsgem", "0.0.3"]})
S1F14
  <L [2]
    <B 0x1>
    <L [2]
      <A "secsgem">
      <A "0.0.3">
    >
  >

Parameters:	value (dict) – parameters for this function (see example)

class secsgem.secs.functions.SecsS01F15(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 01, function 15 - request offline

Example:

>>> import secsgem
>>> secsgem.SecsS01F15()
S1F15 W

Parameters:	value (None) – function has no parameters

class secsgem.secs.functions.SecsS01F16(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 01, function 16 - offline acknowledge

Structure:

OFLACK: B[1]

Example:

>>> import secsgem
>>> secsgem.SecsS01F16(1)
S1F16
  <B 0x1>

Parameters:	value (byte) – parameters for this function (see example)

class secsgem.secs.functions.SecsS01F17(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 01, function 17 - request offline

Example:

>>> import secsgem
>>> secsgem.SecsS01F17()
S1F17 W

Parameters:	value (None) – function has no parameters

class secsgem.secs.functions.SecsS01F18(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 01, function 18 - online acknowledge

Structure:

ONLACK: B[1]

Example:

>>> import secsgem
>>> secsgem.SecsS01F18(1)
S1F18
  <B 0x1>

Parameters:	value (byte) – parameters for this function (see example)

class secsgem.secs.functions.SecsS02F00(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 02, function 00 - abort transaction stream 2

Example:

>>> import secsgem
>>> secsgem.SecsS02F00()
S2F0

Parameters:	value (None) – function has no parameters

class secsgem.secs.functions.SecsS02F13(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 02, function 13 - equipment constant - request

Structure:

[
    ECID: U4[1]
    ...
]

Example:

>>> import secsgem
>>> secsgem.SecsS02F13([1, 1337])
S2F13 W
  <L [2]
    <U4 1 >
    <U4 1337 >
  >

An empty list will return all available equipment constants.

Parameters:	value (list) – parameters for this function (see example)

class secsgem.secs.functions.SecsS02F14(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 02, function 14 - equipment constant - data

Structure:

[
    ECV: various
    ...
]

Example:

>>> import secsgem
>>> secsgem.SecsS02F14([secsgem.SecsVarU1(value=1), "text"])
S2F14
  <L [2]
    <U1 1 >
    <A "text">
  >

Parameters:	value (list) – parameters for this function (see example)

class secsgem.secs.functions.SecsS02F15(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 02, function 15 - new equipment constant - send

Structure:

[
    {
        ECID: U4[1]
        ECV: various
    }
    ...
]

Example:

>>> import secsgem
>>> secsgem.SecsS02F15([{"ECID": 1, "ECV": secsgem.SecsVarU4(value=10)}, {"ECID": 1337, "ECV": "text"}])
S2F15 W
  <L [2]
    <L [2]
      <U4 1 >
      <U4 10 >
    >
    <L [2]
      <U4 1337 >
      <A "text">
    >
  >

Parameters:	value (list) – parameters for this function (see example)

class secsgem.secs.functions.SecsS02F16(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 02, function 16 - new equipment constant - acknowledge

Structure:

EAC: B[1]

Example:

>>> import secsgem
>>> secsgem.SecsS02F16(1)
S2F16
  <B 0x1>

Parameters:	value (byte) – parameters for this function (see example)

class secsgem.secs.functions.SecsS02F29(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 02, function 29 - equipment constant namelist - request

Structure:

[
    ECID: U4[1]
    ...
]

Example:

>>> import secsgem
>>> secsgem.SecsS02F29([1, 1337])
S2F29 W
  <L [2]
    <U4 1 >
    <U4 1337 >
  >

An empty list will return all available equipment constants.

Parameters:	value (list) – parameters for this function (see example)

class secsgem.secs.functions.SecsS02F30(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 02, function 30 - equipment constant namelist

Structure:

[
    {
        ECID: U4[1]
        ECNAME: A[n]
        ECMIN: various
        ECMAX: various
        ECDEF: various
        UNITS: A[n]
    }
    ...
]

Example:

>>> import secsgem
>>> secsgem.SecsS02F30([{"ECID": 1, "ECNAME": "EC1", "ECMIN": secsgem.SecsVarU1(value=0), "ECMAX": secsgem.SecsVarU1(value=100), "ECDEF": secsgem.SecsVarU1(value=50), "UNITS": "mm"}, {"ECID": 1337, "ECNAME": "EC2", "ECMIN": "", "ECMAX": "", "ECDEF": "", "UNITS": ""}])
S2F30
  <L [2]
    <L [6]
      <U4 1 >
      <A "EC1">
      <U1 0 >
      <U1 100 >
      <U1 50 >
      <A "mm">
    >
    <L [6]
      <U4 1337 >
      <A "EC2">
      <A>
      <A>
      <A>
      <A>
    >
  >

Parameters:	value (list) – parameters for this function (see example)

class secsgem.secs.functions.SecsS02F33(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 02, function 33 - define report

Structure:

{
    DATAID: U4[1]
    DATA: [
        {
            RPTID: U4[1]
            RPT: [
                VID: various[n]
                ...
            ]
        }
        ...
    ]
}

Example:

>>> import secsgem
>>> secsgem.SecsS02F33({"DATAID": 1, "DATA": [{"RPTID": 1000, "VID": [12, 1337]}, {"RPTID": 1001, "VID": [1, 2355]}]})
S2F33 W
  <L [2]
    <U4 1 >
    <L [2]
      <L [2]
        <U4 1000 >
        <L [2]
          <U1 12 >
          <U1 1337 >
        >
      >
      <L [2]
        <U4 1001 >
        <L [2]
          <U1 1 >
          <U1 2355 >
        >
      >
    >
  >

Parameters:	value (list) – parameters for this function (see example)

class secsgem.secs.functions.SecsS02F34(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 02, function 34 - define report - acknowledge

Structure:

DRACK: B[1]

Example:

>>> import secsgem
>>> secsgem.SecsS02F34(0)
S2F34
  <B 0x0>

Parameters:	value (byte) – parameters for this function (see example)

class secsgem.secs.functions.SecsS02F35(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 02, function 35 - link event report

Structure:

{
    DATAID: U4[1]
    DATA: [
        {
            CEID: U4[1]
            RPTID: [
                ID: U4[1]
                ...
            ]
        }
        ...
    ]
}

Example:

>>> import secsgem
>>> secsgem.SecsS02F35({"DATAID": 1, "DATA": [{"CEID": 1337, "RPTID": [1000, 1001]}]})
S2F35 W
  <L [2]
    <U4 1 >
    <L [1]
      <L [2]
        <U4 1337 >
        <L [2]
          <U4 1000 >
          <U4 1001 >
        >
      >
    >
  >

Parameters:	value (list) – parameters for this function (see example)

class secsgem.secs.functions.SecsS02F36(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 02, function 36 - link event report - acknowledge

Structure:

LRACK: B[1]

Example:

>>> import secsgem
>>> secsgem.SecsS02F36(0)
S2F36
  <B 0x0>

Parameters:	value (byte) – parameters for this function (see example)

class secsgem.secs.functions.SecsS02F37(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 02, function 37 - en-/disable event report

Structure:

{
    CEED: BOOL[1]
    CEID: [
        ID: U4[1]
        ...
    ]
}

Example:

>>> import secsgem
>>> secsgem.SecsS02F37({"CEED": True, "CEID": [1337]})
S2F37 W
  <L [2]
    <BOOLEAN True >
    <L [1]
      <U4 1337 >
    >
  >

Parameters:	value (list) – parameters for this function (see example)

class secsgem.secs.functions.SecsS02F38(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 02, function 38 - en-/disable event report - acknowledge

Structure:

ERACK: B[1]

Example:

>>> import secsgem
>>> secsgem.SecsS02F38(0)
S2F38
  <B 0x0>

Parameters:	value (byte) – parameters for this function (see example)

class secsgem.secs.functions.SecsS02F41(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 02, function 41 - host command - send

Structure:

{
    RCMD: A[n]
    PARAMS: [
        {
            CPNAME: A[n]
            CPVAL: A[n]
        }
        ...
    ]
}

Example:

>>> import secsgem
>>> secsgem.SecsS02F41({"RCMD": "COMMAND", "PARAMS": [{"CPNAME": "PARAM1", "CPVAL": "VAL1"}, {"CPNAME": "PARAM2", "CPVAL": "VAL2"}]})
S2F41 W
  <L [2]
    <A "COMMAND">
    <L [2]
      <L [2]
        <A "PARAM1">
        <A "VAL1">
      >
      <L [2]
        <A "PARAM2">
        <A "VAL2">
      >
    >
  >

Parameters:	value (list) – parameters for this function (see example)

class secsgem.secs.functions.SecsS02F42(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 02, function 42 - host command - acknowledge

Structure:

{
    HCACK: B[1]
    PARAMS: [
        {
            CPNAME: A[n]
            CPACK: B[1]
        }
        ...
    ]
}

Example:

>>> import secsgem
>>> secsgem.SecsS02F42({"HCACK": 1, "PARAMS": [{"CPNAME": "PARAM1", "CPACK": 2}, {"CPNAME": "PARAM2", "CPACK": 3}]})
S2F42
  <L [2]
    <B 0x1>
    <L [2]
      <L [2]
        <A "PARAM1">
        <B 0x2>
      >
      <L [2]
        <A "PARAM2">
        <B 0x3>
      >
    >
  >

Parameters:	value (list) – parameters for this function (see example)

class secsgem.secs.functions.SecsS05F00(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 05, function 00 - abort transaction stream 5

Example:

>>> import secsgem
>>> secsgem.SecsS05F00()
S5F0

Parameters:	value (None) – function has no parameters

class secsgem.secs.functions.SecsS05F01(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 05, function 01 - alarm report - send

Structure:

{
    ALCD: B[1]
    ALID: U4[1]
    ALTX: A[120]
}

Example:

>>> import secsgem
>>> secsgem.SecsS05F01({"ALCD": 1, "ALID": 100, "ALTX": "text"})
S5F1
  <L [3]
    <B 0x1>
    <U4 100 >
    <A "text">
  >

Parameters:	value (list) – parameters for this function (see example)

class secsgem.secs.functions.SecsS05F02(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 05, function 02 - alarm report - acknowledge

Structure:

ACKC5: B[1]

Example:

>>> import secsgem
>>> secsgem.SecsS05F02(0)
S5F2
  <B 0x0>

Parameters:	value (byte) – parameters for this function (see example)

class secsgem.secs.functions.SecsS06F00(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 06, function 00 - abort transaction stream 6

Example:

>>> import secsgem
>>> secsgem.SecsS06F00()
S6F0

Parameters:	value (None) – function has no parameters

class secsgem.secs.functions.SecsS06F11(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 06, function 11 - event report

Structure:

{
    DATAID: U4[1]
    CEID: U4[1]
    RPT: [
        {
            RPTID: U4[1]
            V: [
                DATA: various
                ...
            ]
        }
        ...
    ]
}

Example:

>>> import secsgem
>>> secsgem.SecsS06F11({"DATAID": 1, "CEID": 1337, "RPT": [{"RPTID": 1000, "V": ["VAR", secsgem.SecsVarU4(value=100)]}]})
S6F11 W
  <L [3]
    <U4 1 >
    <U4 1337 >
    <L [1]
      <L [2]
        <U4 1000 >
        <L [2]
          <A "VAR">
          <U4 100 >
        >
      >
    >
  >

Parameters:	value (list) – parameters for this function (see example)

class secsgem.secs.functions.SecsS06F12(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 06, function 12 - event report - acknowledge

Structure:

ACKC6: B[1]

Example:

>>> import secsgem
>>> secsgem.SecsS06F12(0)
S6F12
  <B 0x0>

Parameters:	value (byte) – parameters for this function (see example)

class secsgem.secs.functions.SecsS06F15(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 06, function 15 - event report request

Structure:

{
    CEID: U4[1]
}

Example:

>>> import secsgem
>>> secsgem.SecsS06F15(1337)
S6F15 W
    <U4 1337 >

Parameters:	value (list) – parameters for this function (see example)

class secsgem.secs.functions.SecsS06F16(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 06, function 16 - event report data

Structure:

{
    DATAID: U4[1]
    CEID: U4[1]
    RPT: [
        {
            RPTID: U4[1]
            V: [
                DATA: various
                ...
            ]
        }
        ...
    ]
}

Example:

>>> import secsgem
>>> secsgem.SecsS06F16({"DATAID": 1, "CEID": 1337, "RPT": [{"RPTID": 1000, "V": ["VAR", secsgem.SecsVarU4(value=100)]}]})
S6F16 W
  <L [3]
    <U4 1 >
    <U4 1337 >
    <L [1]
      <L [2]
        <U4 1000 >
        <L [2]
          <A "VAR">
          <U4 100 >
        >
      >
    >
  >

Parameters:	value (list) – parameters for this function (see example)

class secsgem.secs.functions.SecsS07F00(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 07, function 00 - abort transaction stream 7

Example:

>>> import secsgem
>>> secsgem.SecsS07F00()
S7F0

Parameters:	value (None) – function has no parameters

class secsgem.secs.functions.SecsS07F01(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 07, function 01 - process program load - inquire

Structure:

{
    PPID: A[n]
    LENGTH: U4[1]
}

Example:

>>> import secsgem
>>> secsgem.SecsS07F01({"PPID": "program", "LENGTH": 4})
S7F1 W
  <L [2]
    <A "program">
    <U4 4 >
  >

Parameters:	value (dict) – parameters for this function (see example)

class secsgem.secs.functions.SecsS07F02(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 07, function 02 - process program load - grant

Structure:

PPGNT: B[1]

Example:

>>> import secsgem
>>> secsgem.SecsS07F02(0)
S7F2
  <B 0x0>

Parameters:	value (byte) – parameters for this function (see example)

class secsgem.secs.functions.SecsS07F03(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 07, function 03 - process program - send

Structure:

{
    PPID: A[n]
    PPBODY: B[n]
}

Example:

>>> import secsgem
>>> secsgem.SecsS07F03({"PPID": "program", "PPBODY": "data"})
S7F3 W
  <L [2]
    <A "program">
    <B 0x64 0x61 0x74 0x61>
  >

Parameters:	value (dict) – parameters for this function (see example)

class secsgem.secs.functions.SecsS07F04(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 07, function 04 - process program - acknowledge

Structure:

ACKC7: B[1]

Example:

>>> import secsgem
>>> secsgem.SecsS07F04(0)
S7F4
  <B 0x0>

Parameters:	value (byte) – parameters for this function (see example)

class secsgem.secs.functions.SecsS07F05(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 07, function 05 - process program - request

Structure:

PPID: A[n]

Example:

>>> import secsgem
>>> secsgem.SecsS07F05("program")
S7F5 W
  <A "program">

Parameters:	value (byte) – parameters for this function (see example)

class secsgem.secs.functions.SecsS07F06(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 07, function 06 - process program - data

Structure:

{
    PPID: A[n]
    PPBODY: B[n]
}

Example:

>>> import secsgem
>>> secsgem.SecsS07F06({"PPID": "program", "PPBODY": "data"})
S7F6
  <L [2]
    <A "program">
    <B 0x64 0x61 0x74 0x61>
  >

Parameters:	value (dict) – parameters for this function (see example)

class secsgem.secs.functions.SecsS07F17(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 07, function 17 - delete process program - send

Structure:

[
    PPID: A[n]
    ...
]

Example:

>>> import secsgem
>>> secsgem.SecsS07F17(["program1", "program2"])
S7F17 W
  <L [2]
    <A "program1">
    <A "program2">
  >

Parameters:	value (dict) – parameters for this function (see example)

class secsgem.secs.functions.SecsS07F18(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 07, function 18 - delete process program - acknowledge

Structure:

ACKC7: B[1]

Example:

>>> import secsgem
>>> secsgem.SecsS07F18(0)
S7F18
  <B 0x0>

Parameters:	value (byte) – parameters for this function (see example)

class secsgem.secs.functions.SecsS07F19(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 07, function 19 - current equipment process program - request

Example:

>>> import secsgem
>>> secsgem.SecsS07F19()
S7F19 W

Parameters:	value (dict) – parameters for this function (see example)

class secsgem.secs.functions.SecsS07F20(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 07, function 20 - current equipment process program - data

Structure:

[
    PPID: A[n]
    ...
]

Example:

>>> import secsgem
>>> secsgem.SecsS07F20(["program1", "program2"])
S7F20
  <L [2]
    <A "program1">
    <A "program2">
  >

Parameters:	value (dict) – parameters for this function (see example)

class secsgem.secs.functions.SecsS09F00(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 09, function 00 - abort transaction stream 9

Example:

>>> import secsgem
>>> secsgem.SecsS09F00()
S9F0

Parameters:	value (None) – function has no parameters

class secsgem.secs.functions.SecsS09F01(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 09, function 01 - unrecognized device id

Structure:

MHEAD: B[10]

Example:

>>> import secsgem
>>> secsgem.SecsS09F01("HEADERDATA")
S9F1
  <B 0x48 0x45 0x41 0x44 0x45 0x52 0x44 0x41 0x54 0x41>

Parameters:	value (byte) – parameters for this function (see example)

class secsgem.secs.functions.SecsS09F03(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 09, function 03 - unrecognized stream type

Structure:

MHEAD: B[10]

Example:

>>> import secsgem
>>> secsgem.SecsS09F03("HEADERDATA")
S9F3
  <B 0x48 0x45 0x41 0x44 0x45 0x52 0x44 0x41 0x54 0x41>

Parameters:	value (byte) – parameters for this function (see example)

class secsgem.secs.functions.SecsS09F05(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 09, function 05 - unrecognized function type

Structure:

MHEAD: B[10]

Example:

>>> import secsgem
>>> secsgem.SecsS09F05("HEADERDATA")
S9F5
  <B 0x48 0x45 0x41 0x44 0x45 0x52 0x44 0x41 0x54 0x41>

Parameters:	value (byte) – parameters for this function (see example)

class secsgem.secs.functions.SecsS09F07(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 09, function 07 - illegal data

Structure:

MHEAD: B[10]

Example:

>>> import secsgem
>>> secsgem.SecsS09F07("HEADERDATA")
S9F7
  <B 0x48 0x45 0x41 0x44 0x45 0x52 0x44 0x41 0x54 0x41>

Parameters:	value (byte) – parameters for this function (see example)

class secsgem.secs.functions.SecsS09F09(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 09, function 09 - transaction timer timeout

Structure:

MHEAD: B[10]

Example:

>>> import secsgem
>>> secsgem.SecsS09F09("HEADERDATA")
S9F9
  <B 0x48 0x45 0x41 0x44 0x45 0x52 0x44 0x41 0x54 0x41>

Parameters:	value (byte) – parameters for this function (see example)

class secsgem.secs.functions.SecsS09F11(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 09, function 11 - data too long

Structure:

MHEAD: B[10]

Example:

>>> import secsgem
>>> secsgem.SecsS09F11("HEADERDATA")
S9F11
  <B 0x48 0x45 0x41 0x44 0x45 0x52 0x44 0x41 0x54 0x41>

Parameters:	value (byte) – parameters for this function (see example)

class secsgem.secs.functions.SecsS09F13(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 09, function 13 - conversation timeout

Structure:

{
    MEXP: A[6]
    EDID: A[80]
}

Example:

>>> import secsgem
>>> secsgem.SecsS09F13({"MEXP": "S01E01", "EDID": "data"})
S9F13
  <L [2]
    <A "S01E01">
    <A "data">
  >

Parameters:	value (dict) – parameters for this function (see example)

class secsgem.secs.functions.SecsS10F00(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 10, function 00 - abort transaction stream 10

Example:

>>> import secsgem
>>> secsgem.SecsS10F00()
S10F0

Parameters:	value (None) – function has no parameters

class secsgem.secs.functions.SecsS10F01(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 10, function 01 - terminal - request

Structure:

{
    TID: B[1]
    TEXT: A[]
}

Example:

>>> import secsgem
>>> secsgem.SecsS10F01({"TID": 0, "TEXT": "hello?"})
S10F1
  <L [2]
    <B 0x0>
    <A "hello?">
  >

Parameters:	value (dict) – parameters for this function (see example)

class secsgem.secs.functions.SecsS10F02(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 10, function 02 - terminal - acknowledge

Structure:

ACK10: B[1]

Example:

>>> import secsgem
>>> secsgem.SecsS10F02(0)
S10F2
  <B 0x0>

Parameters:	value (byte) – parameters for this function (see example)

class secsgem.secs.functions.SecsS10F03(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 10, function 03 - terminal single - display

Structure:

{
    TID: B[1]
    TEXT: A[]
}

Example:

>>> import secsgem
>>> secsgem.SecsS10F03({"TID": 0, "TEXT": "hello!"})
S10F3
  <L [2]
    <B 0x0>
    <A "hello!">
  >

Parameters:	value (dict) – parameters for this function (see example)

class secsgem.secs.functions.SecsS10F04(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 10, function 04 - terminal single - acknowledge

Structure:

ACK10: B[1]

Example:

>>> import secsgem
>>> secsgem.SecsS10F04(0)
S10F4
  <B 0x0>

Parameters:	value (byte) – parameters for this function (see example)

class secsgem.secs.functions.SecsS12F00(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 12, function 00 - abort transaction stream 12

Example:

>>> import secsgem
>>> secsgem.SecsS12F00()
S12F0

Parameters:	value (None) – function has no parameters

class secsgem.secs.functions.SecsS12F01(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 12, function 01 - map setup data - send

Structure:

{
    MID: A[16]
    IDTYP: B[1]
    FNLOC: U2[1]
    FFROT: U2[1]
    ORLOC: B[1]
    RPSEL: U1[1]
    REF: [
        REFP: I4[2]
        ...
    ]
    DUTMS: A[n]
    XDIES: U4[1]
    YDIES: U4[1]
    ROWCT: U4[1]
    COLCT: U4[1]
    NULBC: A[n]
    PRDCT: U4[1]
    PRAXI: B[1]
}

Example:

>>> import secsgem
>>> secsgem.SecsS12F01({"MID": "materialID",
        "IDTYP": 0,
        "FNLOC": 0,
        "FFROT": 0,
        "ORLOC": 0,
        "RPSEL": 0,
        "REF": [[1,2], [2,3]],
        "DUTMS": "unit",
        "XDIES": 100,
        "YDIES": 100,
        "ROWCT": 10,
        "COLCT": 10,
        "NULBC": "{x}",
        "PRDCT": 100,
        "PRAXI": 0,
        })
S12F1 W
  <L [15]
    <A "materialID">
    <B 0x0>
    <U2 0 >
    <U2 0 >
    <B 0x0>
    <U1 0 >
    <L [2]
      <I4 1 2 >
      <I4 2 3 >
    >
    <A "unit">
    <U4 100 >
    <U4 100 >
    <U4 10 >
    <U4 10 >
    <A "{x}">
    <U4 100 >
    <B 0x0>
  >

Parameters:	value (dict) – parameters for this function (see example)

class secsgem.secs.functions.SecsS12F02(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 12, function 02 - map setup data - acknowledge

Structure:

SDACK: B[1]

Example:

>>> import secsgem
>>> secsgem.SecsS12F02(0)
S12F2
  <B 0x0>

Parameters:	value (byte) – parameters for this function (see example)

class secsgem.secs.functions.SecsS12F03(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 12, function 03 - map setup data - request

Structure:

{
    MID: A[16]
    IDTYP: B[1]
    MAPFT: B[1]
    FNLOC: U2[1]
    FFROT: U2[1]
    ORLOC: B[1]
    PRAXI: B[1]
    BCEQU: U1[n]
    NULBC: A[n]
}

Example:

>>> import secsgem
>>> secsgem.SecsS12F03({"MID": "materialID",
        "IDTYP": 0,
        "MAPFT": 0,
        "FNLOC": 0,
        "FFROT": 0,
        "ORLOC": 0,
        "PRAXI": 0,
        "BCEQU": [1, 3, 5, 7],
        "NULBC": "{x}",
        })
S12F3 W
  <L [9]
    <A "materialID">
    <B 0x0>
    <B 0x0>
    <U2 0 >
    <U2 0 >
    <B 0x0>
    <B 0x0>
    <U1 1 3 5 7 >
    <A "{x}">
  >

Parameters:	value (dict) – parameters for this function (see example)

class secsgem.secs.functions.SecsS12F04(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 12, function 04 - map setup data

Structure:

{
    MID: A[16]
    IDTYP: B[1]
    FNLOC: U2[1]
    ORLOC: B[1]
    RPSEL: U1[1]
    REF: [
        REFP: I4[2]
        ...
    ]
    DUTMS: A[n]
    XDIES: U4[1]
    YDIES: U4[1]
    ROWCT: U4[1]
    COLCT: U4[1]
    PRDCT: U4[1]
    BCEQU: U1[n]
    NULBC: A[n]
    MLCL: U4[1]
}

Example:

>>> import secsgem
>>> secsgem.SecsS12F04({"MID": "materialID",
        "IDTYP": 0,
        "FNLOC": 0,
        "ORLOC": 0,
        "RPSEL": 0,
        "REF": [[1,2], [2,3]],
        "DUTMS": "unit",
        "XDIES": 100,
        "YDIES": 100,
        "ROWCT": 10,
        "COLCT": 10,
        "PRDCT": 100,
        "BCEQU": [1, 3, 5, 7],
        "NULBC": "{x}",
        "MLCL": 0,
        })
S12F4
  <L [15]
    <A "materialID">
    <B 0x0>
    <U2 0 >
    <B 0x0>
    <U1 0 >
    <L [2]
      <I4 1 2 >
      <I4 2 3 >
    >
    <A "unit">
    <U4 100 >
    <U4 100 >
    <U4 10 >
    <U4 10 >
    <U4 100 >
    <U1 1 3 5 7 >
    <A "{x}">
    <U4 0 >
  >

Parameters:	value (dict) – parameters for this function (see example)

class secsgem.secs.functions.SecsS12F05(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 12, function 05 - map transmit inquire

Structure:

{
    MID: A[16]
    IDTYP: B[1]
    MAPFT: B[1]
    MLCL: U4[1]
}

Example:

>>> import secsgem
>>> secsgem.SecsS12F05({"MID": "materialID", "IDTYP": 0, "MAPFT": 0, "MLCL": 0})
S12F5 W
  <L [4]
    <A "materialID">
    <B 0x0>
    <B 0x0>
    <U4 0 >
  >

Parameters:	value (dict) – parameters for this function (see example)

class secsgem.secs.functions.SecsS12F06(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 12, function 06 - map transmit - grant

Structure:

GRNT1: B[1]

Example:

>>> import secsgem
>>> secsgem.SecsS12F06(0)
S12F6
  <B 0x0>

Parameters:	value (byte) – parameters for this function (see example)

class secsgem.secs.functions.SecsS12F07(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 12, function 07 - map data type 1 - send

Structure:

{
    MID: A[16]
    IDTYP: B[1]
    [
        {
            RSINF: I4[3]
            BINLT: U1[]
        }
    ]
}

Example:

>>> import secsgem
>>> secsgem.SecsS12F07({"MID": "materialID", "IDTYP": 0, "DATA": [{"RSINF": [1, 2, 3], "BINLT": [1, 2, 3, 4]}, {"RSINF": [4, 5, 6], "BINLT": [5, 6, 7, 8]}]})
S12F7 W
  <L [3]
    <A "materialID">
    <B 0x0>
    <L [2]
      <L [2]
        <I4 1 2 3 >
        <U1 1 2 3 4 >
      >
      <L [2]
        <I4 4 5 6 >
        <U1 5 6 7 8 >
      >
    >
  >

Parameters:	value (dict) – parameters for this function (see example)

class secsgem.secs.functions.SecsS12F08(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 12, function 08 - map data type 1 - acknowledge

Structure:

MDACK: B[1]

Example:

>>> import secsgem
>>> secsgem.SecsS12F08(0)
S12F8
  <B 0x0>

Parameters:	value (byte) – parameters for this function (see example)

class secsgem.secs.functions.SecsS12F09(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 12, function 09 - map data type 2 - send

Structure:

{
    MID: A[16]
    IDTYP: B[1]
    STRP: I2[2]
    BINLT: U1[]
}

Example:

>>> import secsgem
>>> secsgem.SecsS12F09({"MID": "materialID", "IDTYP": 0, "STRP": [0, 1], "BINLT": [1, 2, 3, 4, 5, 6]})
S12F9 W
  <L [4]
    <A "materialID">
    <B 0x0>
    <I2 0 1 >
    <U1 1 2 3 4 5 6 >
  >

Parameters:	value (dict) – parameters for this function (see example)

class secsgem.secs.functions.SecsS12F10(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 12, function 10 - map data type 2 - acknowledge

Structure:

MDACK: B[1]

Example:

>>> import secsgem
>>> secsgem.SecsS12F10(0)
S12F10
  <B 0x0>

Parameters:	value (byte) – parameters for this function (see example)

class secsgem.secs.functions.SecsS12F11(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 12, function 11 - map data type 3 - send

Structure:

{
    MID: A[16]
    IDTYP: B[1]
    [
        {
            XYPOS: I2[2]
            BINLT: U1[]
        }
    ]
}

Example:

>>> import secsgem
>>> secsgem.SecsS12F11({"MID": "materialID", "IDTYP": 0, "DATA": [{"XYPOS": [1, 2], "BINLT": [1, 2, 3, 4]}, {"XYPOS": [3, 4], "BINLT": [5, 6, 7, 8]}]})
S12F11 W
  <L [3]
    <A "materialID">
    <B 0x0>
    <L [2]
      <L [2]
        <I2 1 2 >
        <U1 1 2 3 4 >
      >
      <L [2]
        <I2 3 4 >
        <U1 5 6 7 8 >
      >
    >
  >

Parameters:	value (dict) – parameters for this function (see example)

class secsgem.secs.functions.SecsS12F12(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 12, function 12 - map data type 3 - acknowledge

Structure:

MDACK: B[1]

Example:

>>> import secsgem
>>> secsgem.SecsS12F12(0)
S12F12
  <B 0x0>

Parameters:	value (byte) – parameters for this function (see example)

class secsgem.secs.functions.SecsS12F13(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 12, function 13 - map data type 1 - request

Structure:

{
    MID: A[16]
    IDTYP: B[1]
}

Example:

>>> import secsgem
>>> secsgem.SecsS12F13({"MID": "materialID", "IDTYP": 0})
S12F13 W
  <L [2]
    <A "materialID">
    <B 0x0>
  >

Parameters:	value (dict) – parameters for this function (see example)

class secsgem.secs.functions.SecsS12F14(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 12, function 14 - map data type 1

Structure:

{
    MID: A[16]
    IDTYP: B[1]
    [
        {
            RSINF: I4[3]
            BINLT: U1[]
        }
    ]
}

Example:

>>> import secsgem
>>> secsgem.SecsS12F14({"MID": "materialID", "IDTYP": 0, "DATA": [{"RSINF": [1, 2, 3], "BINLT": [1, 2, 3, 4]}, {"RSINF": [4, 5, 6], "BINLT": [5, 6, 7, 8]}]})
S12F14
  <L [3]
    <A "materialID">
    <B 0x0>
    <L [2]
      <L [2]
        <I4 1 2 3 >
        <U1 1 2 3 4 >
      >
      <L [2]
        <I4 4 5 6 >
        <U1 5 6 7 8 >
      >
    >
  >

Parameters:	value (dict) – parameters for this function (see example)

class secsgem.secs.functions.SecsS12F15(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 12, function 15 - map data type 2 - request

Structure:

{
    MID: A[16]
    IDTYP: B[1]
}

Example:

>>> import secsgem
>>> secsgem.SecsS12F15({"MID": "materialID", "IDTYP": 0})
S12F15 W
  <L [2]
    <A "materialID">
    <B 0x0>
  >

Parameters:	value (dict) – parameters for this function (see example)

class secsgem.secs.functions.SecsS12F16(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 12, function 16 - map data type 2

Structure:

{
    MID: A[16]
    IDTYP: B[1]
    STRP: I2[2]
    BINLT: U1[]
}

Example:

>>> import secsgem
>>> secsgem.SecsS12F16({"MID": "materialID", "IDTYP": 0, "STRP": [0, 1], "BINLT": [1, 2, 3, 4, 5, 6]})
S12F16
  <L [4]
    <A "materialID">
    <B 0x0>
    <I2 0 1 >
    <U1 1 2 3 4 5 6 >
  >

Parameters:	value (dict) – parameters for this function (see example)

class secsgem.secs.functions.SecsS12F17(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 12, function 17 - map data type 3 - request

Structure:

{
    MID: A[16]
    IDTYP: B[1]
    SDBIN: B[1]
}

Example:

>>> import secsgem
>>> secsgem.SecsS12F17({"MID": "materialID", "IDTYP": 0, "SDBIN": 1})
S12F17 W
  <L [3]
    <A "materialID">
    <B 0x0>
    <B 0x1>
  >

Parameters:	value (dict) – parameters for this function (see example)

class secsgem.secs.functions.SecsS12F18(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 12, function 18 - map data type 3

Structure:

{
    MID: A[16]
    IDTYP: B[1]
    [
        {
            XYPOS: I2[2]
            BINLT: U1[]
        }
    ]
}

Example:

>>> import secsgem
>>> secsgem.SecsS12F18({"MID": "materialID", "IDTYP": 0, "DATA": [{"XYPOS": [1, 2], "BINLT": [1, 2, 3, 4]}, {"XYPOS": [3, 4], "BINLT": [5, 6, 7, 8]}]})
S12F18
  <L [3]
    <A "materialID">
    <B 0x0>
    <L [2]
      <L [2]
        <I2 1 2 >
        <U1 1 2 3 4 >
      >
      <L [2]
        <I2 3 4 >
        <U1 5 6 7 8 >
      >
    >
  >

Parameters:	value (dict) – parameters for this function (see example)

class secsgem.secs.functions.SecsS12F19(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 12, function 19 - map error report - send

Structure:

{
    MAPER: B[1]
    DATLC: U1[1]
}

Example:

>>> import secsgem
>>> secsgem.SecsS12F19({"MAPER": 1, "DATLC": 0})
S12F19
  <L [2]
    <B 0x1>
    <U1 0 >
  >

Parameters:	value (dict) – parameters for this function (see example)

class secsgem.secs.functions.SecsS14F00(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 14, function 00 - abort transaction stream 14

Example:

>>> import secsgem
>>> secsgem.SecsS14F00()
S14F0

Parameters:	value (None) – function has no parameters

class secsgem.secs.functions.SecsS14F01(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 14, function 01 - GetAttr request

Structure:

{
    OBJSPEC: A[]
    OBJTYPE: various
    OBJID: [
        DATA: various
        ...
    ]
    FILTER: [
        {
            ATTRID: various
            ATTRDATA: various
            ATTRRELN: U1[]
        }
        ...
    ]
    ATTRID: [
        DATA: various
        ...
    ]
}

Example:

>>> import secsgem
>>> secsgem.SecsS14F01({"OBJSPEC": '', "OBJTYPE": 'StripMap', "OBJID": ['MAP001'], "FILTER": [], "ATTRID": ['OriginLocation', 'Rows', 'Columns', 'CellStatus', 'LotID']})
S14F1 W
  <L [5]
    <A>
    <A "StripMap">
    <L [1]
      <A "MAP001">
    >
    <L>
    <L [5]
      <A "OriginLocation">
      <A "Rows">
      <A "Columns">
      <A "CellStatus">
      <A "LotID">
    >
  >

Parameters:	value (dict) – parameters for this function (see example)

RELATION = {'NOTEQUAL': 1, 'GREATEREQUAL': 5, 'GREATER': 4, 'LESS': 2, 'LESSEQUAL': 3, 'NOTPRESENT': 7, 'EQUAL': 0, 'PRESENT': 6}¶

class secsgem.secs.functions.SecsS14F02(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 14, function 02 - GetAttr data

Structure:

{
    DATA: [
        {
            OBJID: various
            ATTRIBS: [
                {
                    ATTRID: various
                    ATTRDATA: various
                }
                ...
            ]
        }
        ...
    ]
    ERRORS: {
        OBJACK: U1
        ERROR: [
            {
                ERRCODE: various
                ERRTEXT: A[]
            }
            ...
        ]
    }
}

Example:

>>> import secsgem
>>> secsgem.SecsS14F02({"DATA": [{"OBJID": "MAP001", "ATTRIBS": [{"ATTRID": "OriginLocation", "ATTRDATA": "0"},{"ATTRID": "Rows", "ATTRDATA": 4},{"ATTRID": "Columns", "ATTRDATA": 4},{"ATTRID": "CellStatus", "ATTRDATA": 6},{"ATTRID": "LotID", "ATTRDATA":"LOT001"}]}], "ERRORS": {"OBJACK": 0}})
S14F2
  <L [2]
    <L [1]
      <L [2]
        <A "MAP001">
        <L [5]
          <L [2]
            <A "OriginLocation">
            <A "0">
          >
          <L [2]
            <A "Rows">
            <A "4">
          >
          <L [2]
            <A "Columns">
            <A "4">
          >
          <L [2]
            <A "CellStatus">
            <A "6">
          >
          <L [2]
            <A "LotID">
            <A "LOT001">
          >
        >
      >
    >
    <L [2]
      <U1 0 >
      <L>
    >
  >

Parameters:	value (dict) – parameters for this function (see example)

class secsgem.secs.functions.SecsS14F03(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 14, function 03 - SetAttr request

Structure:

{
    OBJSPEC: A[]
    OBJTYPE: various
    OBJID: [
        DATA: various
        ...
    ]
    ATTRIBS: [
        {
            ATTRID: various
            ATTRDATA: various
        }
        ...
    ]
}

Example:

>>> import secsgem
>>> secsgem.SecsS14F03({"OBJSPEC": '', "OBJTYPE": 'StripMap', "OBJID": ['MAP001'], "ATTRIBS": [ {"ATTRID": "CellStatus", "ATTRDATA": 3} ] })
S14F3 W
  <L [4]
    <A>
    <A "StripMap">
    <L [1]
      <A "MAP001">
    >
    <L [1]
      <L [2]
        <A "CellStatus">
        <A "3">
      >
    >
  >

Parameters:	value (dict) – parameters for this function (see example)

class secsgem.secs.functions.SecsS14F04(value=None)[source]¶

Bases: secsgem.secs.functionbase.SecsStreamFunction

Secs stream and function class for stream 14, function 04 - SetAttr data

Structure:

{
    DATA: [
        {
            OBJID: various
            ATTRIBS: [
                {
                    ATTRID: various
                    ATTRDATA: various
                }
                ...
            ]
        }
        ...
    ]
    ERRORS: {
        OBJACK: U1
        ERROR: [
            {
                ERRCODE: various
                ERRTEXT: A[]
            }
            ...
        ]
    }
}

Example:

>>> import secsgem
>>> secsgem.SecsS14F04({"DATA": [{"OBJID": "MAP001", "ATTRIBS": [{"ATTRID": "OriginLocation", "ATTRDATA": "0"},{"ATTRID": "Rows", "ATTRDATA": 4},{"ATTRID": "Columns", "ATTRDATA": 4},{"ATTRID": "CellStatus", "ATTRDATA": 6},{"ATTRID": "LotID", "ATTRDATA":"LOT001"}]}], "ERRORS": {"OBJACK": 0}})
S14F4
  <L [2]
    <L [1]
      <L [2]
        <A "MAP001">
        <L [5]
          <L [2]
            <A "OriginLocation">
            <A "0">
          >
          <L [2]
            <A "Rows">
            <A "4">
          >
          <L [2]
            <A "Columns">
            <A "4">
          >
          <L [2]
            <A "CellStatus">
            <A "6">
          >
          <L [2]
            <A "LotID">
            <A "LOT001">
          >
        >
      >
    >
    <L [2]
      <U1 0 >
      <L>
    >
  >

Parameters:	value (dict) – parameters for this function (see example)