Functions

Wrappers for SECS stream and functions

class secsgem.secs.functions.SecsS00F00(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

Hsms communication

Structure:

>>> import secsgem
>>> secsgem.SecsS00F00
Header only

Example:

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

Parameters:value (None) – function has no parameters

class secsgem.secs.functions.SecsS01F00(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

abort transaction stream 1

Structure:

>>> import secsgem
>>> secsgem.SecsS01F00
Header only

Example:

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

Parameters:value (None) – function has no parameters

class secsgem.secs.functions.SecsS01F01(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

are you online - request

Structure:

>>> import secsgem
>>> secsgem.SecsS01F01
Header only

Example:

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

Parameters:value (None) – function has no parameters

class secsgem.secs.functions.SecsS01F02(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

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.6']) # E->H
S1F2
  <L [2]
    <A "secsgem">
    <A "0.0.6">
  > .
>>> secsgem.SecsS01F02() #H->E
S1F2
  <L> .

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

class secsgem.secs.functions.SecsS01F03(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

Selected equipment status - request

Data Items

• SVID

Structure:

>>> import secsgem
>>> secsgem.SecsS01F03
[
    SVID: U1/U2/U4/U8/I1/I2/I4/I8/A
    ...
]

Example:

>>> import secsgem
>>> secsgem.SecsS01F03([1, "1337", 12])
S1F3 W
  <L [3]
    <U1 1 >
    <A "1337">
    <U1 12 >
  > .

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

class secsgem.secs.functions.SecsS01F04(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

selected equipment status - data

Data Items

• SV

Structure:

>>> import secsgem
>>> secsgem.SecsS01F04
[
    SV: L/BOOLEAN/U1/U2/U4/U8/I1/I2/I4/I8/F4/F8/A/B
    ...
]

Example:

>>> import secsgem
>>> secsgem.SecsS01F04([secsgem.SecsVarU1(1), "text", secsgem.SecsVarU4(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)

Bases: secsgem.secs.functionbase.SecsStreamFunction

status variable namelist - request

Data Items

• SVID

Structure:

>>> import secsgem
>>> secsgem.SecsS01F11
[
    SVID: U1/U2/U4/U8/I1/I2/I4/I8/A
    ...
]

Example:

>>> import secsgem
>>> secsgem.SecsS01F11([1, 1337])
S1F11 W
  <L [2]
    <U1 1 >
    <U2 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)

Bases: secsgem.secs.functionbase.SecsStreamFunction

status variable namelist - reply

Data Items

• SVID
• SVNAME
• UNITS

Structure:

>>> import secsgem
>>> secsgem.SecsS01F12
[
    {
        SVID: U1/U2/U4/U8/I1/I2/I4/I8/A
        SVNAME: A
        UNITS: A
    }
    ...
]

Example:

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

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

class secsgem.secs.functions.SecsS01F13(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

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.6']) # E->H
S1F13 W
  <L [2]
    <A "secsgem">
    <A "0.0.6">
  > .
>>> secsgem.SecsS01F13() #H->E
S1F13 W
  <L> .

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

class secsgem.secs.functions.SecsS01F14(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

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.

Data Items

• COMMACK

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": secsgem.COMMACK.ACCEPTED, "MDLN": ["secsgem", "0.0.6"]})
S1F14
  <L [2]
    <B 0x0>
    <L [2]
      <A "secsgem">
      <A "0.0.6">
    >
  > .

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

class secsgem.secs.functions.SecsS01F15(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

request offline

Structure:

>>> import secsgem
>>> secsgem.SecsS01F15
Header only

Example:

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

Parameters:value (None) – function has no parameters

class secsgem.secs.functions.SecsS01F16(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

offline acknowledge

Data Items

• OFLACK

Structure:

>>> import secsgem
>>> secsgem.SecsS01F16
OFLACK: B[1]

Example:

>>> import secsgem
>>> secsgem.SecsS01F16(secsgem.OFLACK.ACK)
S1F16
  <B 0x0> .

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

class secsgem.secs.functions.SecsS01F17(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

request offline

Structure:

>>> import secsgem
>>> secsgem.SecsS01F17
Header only

Example:

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

Parameters:value (None) – function has no parameters

class secsgem.secs.functions.SecsS01F18(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

online acknowledge

Data Items

• ONLACK

Structure:

>>> import secsgem
>>> secsgem.SecsS01F18
ONLACK: B[1]

Example:

>>> import secsgem
>>> secsgem.SecsS01F18(secsgem.ONLACK.ALREADY_ON)
S1F18
  <B 0x2> .

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

class secsgem.secs.functions.SecsS02F00(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

abort transaction stream 2

Structure:

>>> import secsgem
>>> secsgem.SecsS02F00
Header only

Example:

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

Parameters:value (None) – function has no parameters

class secsgem.secs.functions.SecsS02F13(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

equipment constant - request

Data Items

• ECID

Structure:

>>> import secsgem
>>> secsgem.SecsS02F13
[
    ECID: U1/U2/U4/U8/I1/I2/I4/I8/A
    ...
]

Example:

>>> import secsgem
>>> secsgem.SecsS02F13([1, 1337])
S2F13 W
  <L [2]
    <U1 1 >
    <U2 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)

Bases: secsgem.secs.functionbase.SecsStreamFunction

equipment constant - data

Data Items

• ECV

Structure:

>>> import secsgem
>>> secsgem.SecsS02F14
[
    ECV: L/BOOLEAN/I8/I1/I2/I4/F8/F4/U8/U1/U2/U4/A/B
    ...
]

Example:

>>> import secsgem
>>> secsgem.SecsS02F14([secsgem.SecsVarU1(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)

Bases: secsgem.secs.functionbase.SecsStreamFunction

new equipment constant - send

Data Items

• ECID
• ECV

Structure:

>>> import secsgem
>>> secsgem.SecsS02F15
[
    {
        ECID: U1/U2/U4/U8/I1/I2/I4/I8/A
        ECV: L/BOOLEAN/I8/I1/I2/I4/F8/F4/U8/U1/U2/U4/A/B
    }
    ...
]

Example:

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

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

class secsgem.secs.functions.SecsS02F16(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

new equipment constant - acknowledge

Data Items

• EAC

Structure:

>>> import secsgem
>>> secsgem.SecsS02F16
EAC: B[1]

Example:

>>> import secsgem
>>> secsgem.SecsS02F16(secsgem.EAC.BUSY)
S2F16
  <B 0x2> .

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

class secsgem.secs.functions.SecsS02F17(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

date and time - request

Structure:

>>> import secsgem
>>> secsgem.SecsS02F17
Header only

Example:

>>> import secsgem
>>> secsgem.SecsS02F17()
S2F17 W .

Parameters:value (None) – function has no parameters

class secsgem.secs.functions.SecsS02F18(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

date and time - data

Data Items

• TIME

Structure:

>>> import secsgem
>>> secsgem.SecsS02F18
TIME: A[32]

Example:

>>> import secsgem
>>> secsgem.SecsS02F18("160816205942")
S2F18
  <A "160816205942"> .

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

class secsgem.secs.functions.SecsS02F29(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

equipment constant namelist - request

Data Items

• ECID

Structure:

>>> import secsgem
>>> secsgem.SecsS02F29
[
    ECID: U1/U2/U4/U8/I1/I2/I4/I8/A
    ...
]

Example:

>>> import secsgem
>>> secsgem.SecsS02F29([1, 1337])
S2F29 W
  <L [2]
    <U1 1 >
    <U2 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)

Bases: secsgem.secs.functionbase.SecsStreamFunction

equipment constant namelist

Data Items

• ECID
• ECNAME
• ECMIN
• ECMAX
• ECDEF
• UNITS

Structure:

>>> import secsgem
>>> secsgem.SecsS02F30
[
    {
        ECID: U1/U2/U4/U8/I1/I2/I4/I8/A
        ECNAME: A
        ECMIN: BOOLEAN/I8/I1/I2/I4/F8/F4/U8/U1/U2/U4/A/B
        ECMAX: BOOLEAN/I8/I1/I2/I4/F8/F4/U8/U1/U2/U4/A/B
        ECDEF: BOOLEAN/I8/I1/I2/I4/F8/F4/U8/U1/U2/U4/A/B
        UNITS: A
    }
    ...
]

Example:

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

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

class secsgem.secs.functions.SecsS02F33(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

define report

Data Items

• DATAID
• RPTID
• VID

Structure:

>>> import secsgem
>>> secsgem.SecsS02F33
{
    DATAID: U1/U2/U4/U8/I1/I2/I4/I8/A
    DATA: [
        {
            RPTID: U1/U2/U4/U8/I1/I2/I4/I8/A
            VID: [
                DATA: U1/U2/U4/U8/I1/I2/I4/I8/A
                ...
            ]
        }
        ...
    ]
}

Example:

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

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

class secsgem.secs.functions.SecsS02F34(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

define report - acknowledge

Data Items

• DRACK

Structure:

>>> import secsgem
>>> secsgem.SecsS02F34
DRACK: B[1]

Example:

>>> import secsgem
>>> secsgem.SecsS02F34(secsgem.DRACK.INVALID_FORMAT)
S2F34
  <B 0x2> .

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

class secsgem.secs.functions.SecsS02F35(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

link event report

Data Items

• DATAID
• CEID
• RPTID

Structure:

>>> import secsgem
>>> secsgem.SecsS02F35
{
    DATAID: U1/U2/U4/U8/I1/I2/I4/I8/A
    DATA: [
        {
            CEID: U1/U2/U4/U8/I1/I2/I4/I8/A
            RPTID: [
                DATA: U1/U2/U4/U8/I1/I2/I4/I8/A
                ...
            ]
        }
        ...
    ]
}

Example:

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

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

class secsgem.secs.functions.SecsS02F36(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

link event report - acknowledge

Data Items

• LRACK

Structure:

>>> import secsgem
>>> secsgem.SecsS02F36
LRACK: B[1]

Example:

>>> import secsgem
>>> secsgem.SecsS02F36(secsgem.LRACK.CEID_UNKNOWN)
S2F36
  <B 0x4> .

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

class secsgem.secs.functions.SecsS02F37(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

en-/disable event report

Data Items

• CEED
• CEID

Structure:

>>> import secsgem
>>> secsgem.SecsS02F37
{
    CEED: BOOLEAN[1]
    CEID: [
        DATA: U1/U2/U4/U8/I1/I2/I4/I8/A
        ...
    ]
}

Example:

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

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

class secsgem.secs.functions.SecsS02F38(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

en-/disable event report - acknowledge

Data Items

• ERACK

Structure:

>>> import secsgem
>>> secsgem.SecsS02F38
ERACK: B[1]

Example:

>>> import secsgem
>>> secsgem.SecsS02F38(secsgem.ERACK.CEID_UNKNOWN)
S2F38
  <B 0x1> .

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

class secsgem.secs.functions.SecsS02F41(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

host command - send

Data Items

• RCMD
• CPNAME
• CPVAL

Structure:

>>> import secsgem
>>> secsgem.SecsS02F41
{
    RCMD: U1/I1/A
    PARAMS: [
        {
            CPNAME: U1/U2/U4/U8/I1/I2/I4/I8/A
            CPVAL: BOOLEAN/U1/U2/U4/U8/I1/I2/I4/I8/A/B
        }
        ...
    ]
}

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)

Bases: secsgem.secs.functionbase.SecsStreamFunction

host command - acknowledge

Data Items

• HCACK
• CPNAME
• CPACK

Structure:

>>> import secsgem
>>> secsgem.SecsS02F42
{
    HCACK: B[1]
    PARAMS: [
        {
            CPNAME: U1/U2/U4/U8/I1/I2/I4/I8/A
            CPACK: B[1]
        }
        ...
    ]
}

Example:

>>> import secsgem
>>> secsgem.SecsS02F42({             "HCACK": secsgem.HCACK.INVALID_COMMAND,             "PARAMS": [                 {"CPNAME": "PARAM1", "CPACK": secsgem.CPACK.CPVAL_ILLEGAL_VALUE},                 {"CPNAME": "PARAM2", "CPACK": secsgem.CPACK.CPVAL_ILLEGAL_FORMAT}]})
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)

Bases: secsgem.secs.functionbase.SecsStreamFunction

abort transaction stream 5

Structure:

>>> import secsgem
>>> secsgem.SecsS05F00
Header only

Example:

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

Parameters:value (None) – function has no parameters

class secsgem.secs.functions.SecsS05F01(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

alarm report - send

Data Items

• ALCD
• ALID
• ALTX

Structure:

>>> import secsgem
>>> secsgem.SecsS05F01
{
    ALCD: B[1]
    ALID: U1/U2/U4/U8/I1/I2/I4/I8
    ALTX: A[120]
}

Example:

>>> import secsgem
>>> secsgem.SecsS05F01({"ALCD": secsgem.ALCD.PERSONAL_SAFETY | secsgem.ALCD.ALARM_SET, "ALID": 100, "ALTX": "text"})
S5F1
  <L [3]
    <B 0x81>
    <U1 100 >
    <A "text">
  > .

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

class secsgem.secs.functions.SecsS05F02(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

alarm report - acknowledge

Data Items

• ACKC5

Structure:

>>> import secsgem
>>> secsgem.SecsS05F02
ACKC5: B[1]

Example:

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

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

class secsgem.secs.functions.SecsS05F03(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

en-/disable alarm - send

Data Items

• ALED
• ALID

Structure:

>>> import secsgem
>>> secsgem.SecsS05F03
{
    ALED: B[1]
    ALID: U1/U2/U4/U8/I1/I2/I4/I8
}

Example:

>>> import secsgem
>>> secsgem.SecsS05F03({"ALED": secsgem.ALED.ENABLE, "ALID": 100})
S5F3
  <L [2]
    <B 0x80>
    <U1 100 >
  > .

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

class secsgem.secs.functions.SecsS05F04(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

en-/disable alarm - acknowledge

Data Items

• ACKC5

Structure:

>>> import secsgem
>>> secsgem.SecsS05F04
ACKC5: B[1]

Example:

>>> import secsgem
>>> secsgem.SecsS05F04(secsgem.ACKC5.ACCEPTED)
S5F4
  <B 0x0> .

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

class secsgem.secs.functions.SecsS05F05(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

list alarms - request

Data Items

• ALID

Structure:

>>> import secsgem
>>> secsgem.SecsS05F05
[
    ALID: U1/U2/U4/U8/I1/I2/I4/I8
    ...
]

Example:

>>> import secsgem
>>> secsgem.SecsS05F05([100, 200])
S5F5 W
  <L [2]
    <U1 100 >
    <U1 200 >
  > .

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

class secsgem.secs.functions.SecsS05F06(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

list alarms - data

Data Items

• ALCD
• ALID
• ALTX

Structure:

>>> import secsgem
>>> secsgem.SecsS05F06
[
    {
        ALCD: B[1]
        ALID: U1/U2/U4/U8/I1/I2/I4/I8
        ALTX: A[120]
    }
    ...
]

Example:

>>> import secsgem
>>> secsgem.SecsS05F06([{"ALCD": secsgem.ALCD.PERSONAL_SAFETY | secsgem.ALCD.ALARM_SET, "ALID": 100, "ALTX": "text"}])
S5F6
  <L [1]
    <L [3]
      <B 0x81>
      <U1 100 >
      <A "text">
    >
  > .

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

class secsgem.secs.functions.SecsS05F07(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

list enabled alarms - request

Structure:

>>> import secsgem
>>> secsgem.SecsS05F07
Header only

Example:

>>> import secsgem
>>> secsgem.SecsS05F07()
S5F7 W .

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

class secsgem.secs.functions.SecsS05F08(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

list enabled alarms - data

Data Items

• ALCD
• ALID
• ALTX

Structure:

>>> import secsgem
>>> secsgem.SecsS05F08
[
    {
        ALCD: B[1]
        ALID: U1/U2/U4/U8/I1/I2/I4/I8
        ALTX: A[120]
    }
    ...
]

Example:

>>> import secsgem
>>> secsgem.SecsS05F08([{"ALCD": secsgem.ALCD.PERSONAL_SAFETY | secsgem.ALCD.ALARM_SET, "ALID": 100, "ALTX": "text"}])
S5F8
  <L [1]
    <L [3]
      <B 0x81>
      <U1 100 >
      <A "text">
    >
  > .

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

class secsgem.secs.functions.SecsS05F09(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

exception post - notify

Data Items

• TIMESTAMP
• EXID
• EXTYPE
• EXMESSAGE
• EXRECVRA

Structure:

>>> import secsgem
>>> secsgem.SecsS05F09
{
    TIMESTAMP: A[32]
    EXID: A[20]
    EXTYPE: A
    EXMESSAGE: A
    EXRECVRA: [
        DATA: A[40]
        ...
    ]
}

Example:

>>> import secsgem
>>> secsgem.SecsS05F09({             "TIMESTAMP": "161006221500",             "EXID": "EX123",             "EXTYPE": "ALARM",             "EXMESSAGE": "Exception",             "EXRECVRA": ["EXRECVRA1", "EXRECVRA2"] })
S5F9
  <L [5]
    <A "161006221500">
    <A "EX123">
    <A "ALARM">
    <A "Exception">
    <L [2]
      <A "EXRECVRA1">
      <A "EXRECVRA2">
    >
  > .

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

class secsgem.secs.functions.SecsS05F10(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

exception post - confirm

Structure:

>>> import secsgem
>>> secsgem.SecsS05F10
Header only

Example:

>>> import secsgem
>>> secsgem.SecsS05F10()
S5F10 .

Parameters:value (None) – function has no parameters

class secsgem.secs.functions.SecsS05F11(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

exception clear - notify

Data Items

• TIMESTAMP
• EXID
• EXTYPE
• EXMESSAGE

Structure:

>>> import secsgem
>>> secsgem.SecsS05F11
{
    TIMESTAMP: A[32]
    EXID: A[20]
    EXTYPE: A
    EXMESSAGE: A
}

Example:

>>> import secsgem
>>> secsgem.SecsS05F11({"TIMESTAMP": "161006221500", "EXID": "EX123", "EXTYPE": "ALARM", "EXMESSAGE": "Exception"})
S5F11
  <L [4]
    <A "161006221500">
    <A "EX123">
    <A "ALARM">
    <A "Exception">
  > .

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

class secsgem.secs.functions.SecsS05F12(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

exception clear - confirm

Structure:

>>> import secsgem
>>> secsgem.SecsS05F12
Header only

Example:

>>> import secsgem
>>> secsgem.SecsS05F12()
S5F12 .

Parameters:value (None) – function has no parameters

class secsgem.secs.functions.SecsS05F13(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

exception recover - request

Data Items

• EXID
• EXRECVRA

Structure:

>>> import secsgem
>>> secsgem.SecsS05F13
{
    EXID: A[20]
    EXRECVRA: A[40]
}

Example:

>>> import secsgem
>>> secsgem.SecsS05F13({"EXID": "EX123", "EXRECVRA": "EXRECVRA2"})
S5F13 W
  <L [2]
    <A "EX123">
    <A "EXRECVRA2">
  > .

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

class secsgem.secs.functions.SecsS05F14(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

exception recover - acknowledge

Data Items

• EXID
• ACKA
• ERRCODE
• ERRTEXT

Structure:

>>> import secsgem
>>> secsgem.SecsS05F14
{
    EXID: A[20]
    DATA: {
        ACKA: BOOLEAN[1]
        DATA: {
            ERRCODE: I1/I2/I4/I8
            ERRTEXT: A[120]
        }
    }
}

Example::

>>> import secsgem
>>> secsgem.SecsS05F14({"EXID": "EX123", "DATA": {"ACKA": False, "DATA": {"ERRCODE": 10, "ERRTEXT": "Error"}}})
S5F14
  <L [2]
    <A "EX123">
    <L [2]
      <BOOLEAN False >
      <L [2]
        <I1 10 >
        <A "Error">
      >
    >
  > .

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

class secsgem.secs.functions.SecsS05F15(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

exception recover complete - notify

Data Items

• TIMESTAMP
• EXID
• ACKA
• ERRCODE
• ERRTEXT

Structure:

>>> import secsgem
>>> secsgem.SecsS05F15
{
    TIMESTAMP: A[32]
    EXID: A[20]
    DATA: {
        ACKA: BOOLEAN[1]
        DATA: {
            ERRCODE: I1/I2/I4/I8
            ERRTEXT: A[120]
        }
    }
}

Example::

>>> import secsgem
>>> secsgem.SecsS05F15({"TIMESTAMP": "161006221500", "EXID": "EX123", "DATA": {"ACKA": False, "DATA": {"ERRCODE": 10, "ERRTEXT": "Error"}}})
S5F15
  <L [3]
    <A "161006221500">
    <A "EX123">
    <L [2]
      <BOOLEAN False >
      <L [2]
        <I1 10 >
        <A "Error">
      >
    >
  > .

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

class secsgem.secs.functions.SecsS05F16(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

exception recover complete - confirm

Structure:

>>> import secsgem
>>> secsgem.SecsS05F16
Header only

Example:

>>> import secsgem
>>> secsgem.SecsS05F16()
S5F16 .

Parameters:value (None) – function has no parameters

class secsgem.secs.functions.SecsS05F17(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

exception recover abort - request

Data Items

• EXID

Structure:

>>> import secsgem
>>> secsgem.SecsS05F17
EXID: A[20]

Example:

>>> import secsgem
>>> secsgem.SecsS05F17("EX123")
S5F17 W
  <A "EX123"> .

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

class secsgem.secs.functions.SecsS05F18(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

exception recover abort - acknowledge

Data Items

• EXID
• ACKA
• ERRCODE
• ERRTEXT

Structure:

>>> import secsgem
>>> secsgem.SecsS05F18
{
    EXID: A[20]
    DATA: {
        ACKA: BOOLEAN[1]
        DATA: {
            ERRCODE: I1/I2/I4/I8
            ERRTEXT: A[120]
        }
    }
}

Example::

>>> import secsgem
>>> secsgem.SecsS05F18({"EXID": "EX123", "DATA": {"ACKA": False, "DATA": {"ERRCODE": 10, "ERRTEXT": "Error"}}})
S5F18
  <L [2]
    <A "EX123">
    <L [2]
      <BOOLEAN False >
      <L [2]
        <I1 10 >
        <A "Error">
      >
    >
  > .

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

class secsgem.secs.functions.SecsS06F00(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

abort transaction stream 6

Structure:

>>> import secsgem
>>> secsgem.SecsS06F00
Header only

Example:

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

Parameters:value (None) – function has no parameters

class secsgem.secs.functions.SecsS06F05(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

multi block data inquiry

Data Items

• DATAID
• DATALENGTH

Structure:

>>> import secsgem
>>> secsgem.SecsS06F05
{
    DATAID: U1/U2/U4/U8/I1/I2/I4/I8/A
    DATALENGTH: U1/U2/U4/U8/I1/I2/I4/I8
}

Example:

>>> import secsgem
>>> secsgem.SecsS06F05({"DATAID": 1, "DATALENGTH": 1337})
S6F5 W
  <L [2]
    <U1 1 >
    <U2 1337 >
  > .

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

class secsgem.secs.functions.SecsS06F06(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

multi block data grant

Data Items

• GRANT6

Structure:

>>> import secsgem
>>> secsgem.SecsS06F06
GRANT6: B[1]

Example:

>>> import secsgem
>>> secsgem.SecsS06F06(secsgem.GRANT6.BUSY)
S6F6
  <B 0x1> .

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

class secsgem.secs.functions.SecsS06F07(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

data transfer request

Data Items

• DATAID

Structure:

>>> import secsgem
>>> secsgem.SecsS06F07
DATAID: U1/U2/U4/U8/I1/I2/I4/I8/A

Example:

>>> import secsgem
>>> secsgem.SecsS06F07(1)
S6F7 W
  <U1 1 > .

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

class secsgem.secs.functions.SecsS06F08(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

data transfer data

Data Items

• DATAID
• CEID
• DSID
• DVNAME

Structure:

>>> import secsgem
>>> secsgem.SecsS06F08
{
    DATAID: U1/U2/U4/U8/I1/I2/I4/I8/A
    CEID: U1/U2/U4/U8/I1/I2/I4/I8/A
    DS: [
        {
            DSID: U1/U2/U4/U8/I1/I2/I4/I8/A
            DV: [
                {
                    DVNAME: U1/U2/U4/U8/I1/I2/I4/I8/A
                    DVVAL: L/BOOLEAN/U1/U2/U4/U8/I1/I2/I4/I8/F4/F8/A/B
                }
                ...
            ]
        }
        ...
    ]
}

Example:

>>> import secsgem
>>> secsgem.SecsS06F08({             "DATAID": 1,             "CEID": 1337,             "DS": [{                 "DSID": 1000,                 "DV": [                     {"DVNAME": "VAR1", "DVVAL": "VAR"},                     {"DVNAME": "VAR2", "DVVAL": secsgem.SecsVarU4(100)}]}]})
S6F8
  <L [3]
    <U1 1 >
    <U2 1337 >
    <L [1]
      <L [2]
        <U2 1000 >
        <L [2]
          <L [2]
            <A "VAR1">
            <A "VAR">
          >
          <L [2]
            <A "VAR2">
            <U4 100 >
          >
        >
      >
    >
  > .

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

class secsgem.secs.functions.SecsS06F11(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

event report

Data Items

• DATAID
• CEID
• RPTID
• V

Structure:

>>> import secsgem
>>> secsgem.SecsS06F11
{
    DATAID: U1/U2/U4/U8/I1/I2/I4/I8/A
    CEID: U1/U2/U4/U8/I1/I2/I4/I8/A
    RPT: [
        {
            RPTID: U1/U2/U4/U8/I1/I2/I4/I8/A
            V: [
                DATA: L/BOOLEAN/U1/U2/U4/U8/I1/I2/I4/I8/F4/F8/A/B
                ...
            ]
        }
        ...
    ]
}

Example:

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

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

class secsgem.secs.functions.SecsS06F12(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

event report - acknowledge

Data Items

• ACKC6

Structure:

>>> import secsgem
>>> secsgem.SecsS06F12
ACKC6: B[1]

Example:

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

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

class secsgem.secs.functions.SecsS06F15(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

event report request

Data Items

• CEID

Structure:

>>> import secsgem
>>> secsgem.SecsS06F15
CEID: U1/U2/U4/U8/I1/I2/I4/I8/A

Example:

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

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

class secsgem.secs.functions.SecsS06F16(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

event report data

Data Items

• DATAID
• CEID
• RPTID
• V

Structure:

>>> import secsgem
>>> secsgem.SecsS06F16
{
    DATAID: U1/U2/U4/U8/I1/I2/I4/I8/A
    CEID: U1/U2/U4/U8/I1/I2/I4/I8/A
    RPT: [
        {
            RPTID: U1/U2/U4/U8/I1/I2/I4/I8/A
            V: [
                DATA: L/BOOLEAN/U1/U2/U4/U8/I1/I2/I4/I8/F4/F8/A/B
                ...
            ]
        }
        ...
    ]
}

Example:

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

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

class secsgem.secs.functions.SecsS06F19(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

individual report request

Data Items

• RPTID

Structure:

>>> import secsgem
>>> secsgem.SecsS06F19
RPTID: U1/U2/U4/U8/I1/I2/I4/I8/A

Example:

>>> import secsgem
>>> secsgem.SecsS06F19(secsgem.SecsVarU4(1337))
S6F19 W
  <U4 1337 > .

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

class secsgem.secs.functions.SecsS06F20(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

individual report data

Data Items

• V

Structure:

>>> import secsgem
>>> secsgem.SecsS06F20
[
    V: L/BOOLEAN/U1/U2/U4/U8/I1/I2/I4/I8/F4/F8/A/B
    ...
]

Example:

>>> import secsgem
>>> secsgem.SecsS06F20(["ASD", 1337])
S6F20
  <L [2]
    <A "ASD">
    <U2 1337 >
  > .

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

class secsgem.secs.functions.SecsS06F21(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

annotated individual report request

Data Items

• RPTID

Structure:

>>> import secsgem
>>> secsgem.SecsS06F21
RPTID: U1/U2/U4/U8/I1/I2/I4/I8/A

Example:

>>> import secsgem
>>> secsgem.SecsS06F21(secsgem.SecsVarU4(1337))
S6F21 W
  <U4 1337 > .

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

class secsgem.secs.functions.SecsS06F22(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

annotated individual report data

Data Items

• VID
• V

Structure:

>>> import secsgem
>>> secsgem.SecsS06F22
[
    {
        VID: U1/U2/U4/U8/I1/I2/I4/I8/A
        V: L/BOOLEAN/U1/U2/U4/U8/I1/I2/I4/I8/F4/F8/A/B
    }
    ...
]

Example:

>>> import secsgem
>>> secsgem.SecsS06F22([{"VID": "VID1", "V": "ASD"}, {"VID": 2, "V": 1337}])
S6F22
  <L [2]
    <L [2]
      <A "VID1">
      <A "ASD">
    >
    <L [2]
      <U1 2 >
      <U2 1337 >
    >
  > .

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

class secsgem.secs.functions.SecsS07F00(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

abort transaction stream 7

Structure:

>>> import secsgem
>>> secsgem.SecsS07F00
Header only

Example:

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

Parameters:value (None) – function has no parameters

class secsgem.secs.functions.SecsS07F01(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

process program load - inquire

Data Items

• PPID
• LENGTH

Structure:

>>> import secsgem
>>> secsgem.SecsS07F01
{
    PPID: A/B[120]
    LENGTH: U1/U2/U4/U8/I1/I2/I4/I8
}

Example:

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

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

class secsgem.secs.functions.SecsS07F02(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

process program load - grant

Data Items

• PPGNT

Structure:

>>> import secsgem
>>> secsgem.SecsS07F02
PPGNT: B[1]

Example:

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

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

class secsgem.secs.functions.SecsS07F03(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

process program - send

Data Items

• PPID
• PPBODY

Structure:

>>> import secsgem
>>> secsgem.SecsS07F03
{
    PPID: A/B[120]
    PPBODY: U1/U2/U4/U8/I1/I2/I4/I8/A/B
}

Example:

>>> import secsgem
>>> secsgem.SecsS07F03({"PPID": "program", "PPBODY": secsgem.SecsVarBinary("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)

Bases: secsgem.secs.functionbase.SecsStreamFunction

process program - acknowledge

Data Items

• ACKC7

Structure:

>>> import secsgem
>>> secsgem.SecsS07F04
ACKC7: B[1]

Example:

>>> import secsgem
>>> secsgem.SecsS07F04(secsgem.ACKC7.MATRIX_OVERFLOW)
S7F4
  <B 0x3> .

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

class secsgem.secs.functions.SecsS07F05(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

process program - request

Data Items

• PPID

Structure:

>>> import secsgem
>>> secsgem.SecsS07F05
PPID: A/B[120]

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)

Bases: secsgem.secs.functionbase.SecsStreamFunction

process program - data

Data Items

• PPID
• PPBODY

Structure:

>>> import secsgem
>>> secsgem.SecsS07F06
{
    PPID: A/B[120]
    PPBODY: U1/U2/U4/U8/I1/I2/I4/I8/A/B
}

Example:

>>> import secsgem
>>> secsgem.SecsS07F06({"PPID": "program", "PPBODY": secsgem.SecsVarBinary("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)

Bases: secsgem.secs.functionbase.SecsStreamFunction

delete process program - send

Data Items

• PPID

Structure:

>>> import secsgem
>>> secsgem.SecsS07F17
[
    PPID: A/B[120]
    ...
]

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)

Bases: secsgem.secs.functionbase.SecsStreamFunction

delete process program - acknowledge

Data Items

• ACKC7

Structure:

>>> import secsgem
>>> secsgem.SecsS07F18
ACKC7: B[1]

Example:

>>> import secsgem
>>> secsgem.SecsS07F18(secsgem.ACKC7.MODE_UNSUPPORTED)
S7F18
  <B 0x5> .

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

class secsgem.secs.functions.SecsS07F19(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

current equipment process program - request

Structure:

>>> import secsgem
>>> secsgem.SecsS07F19
Header only

Example:

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

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

class secsgem.secs.functions.SecsS07F20(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

current equipment process program - data

Data Items

• PPID

Structure:

>>> import secsgem
>>> secsgem.SecsS07F20
[
    PPID: A/B[120]
    ...
]

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)

Bases: secsgem.secs.functionbase.SecsStreamFunction

abort transaction stream 9

Structure:

>>> import secsgem
>>> secsgem.SecsS09F00
Header only

Example:

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

Parameters:value (None) – function has no parameters

class secsgem.secs.functions.SecsS09F01(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

unrecognized device id

Data Items

• MHEAD

Structure:

>>> import secsgem
>>> secsgem.SecsS09F01
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)

Bases: secsgem.secs.functionbase.SecsStreamFunction

unrecognized stream type

Data Items

• MHEAD

Structure:

>>> import secsgem
>>> secsgem.SecsS09F03
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)

Bases: secsgem.secs.functionbase.SecsStreamFunction

unrecognized function type

Data Items

• MHEAD

Structure:

>>> import secsgem
>>> secsgem.SecsS09F05
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)

Bases: secsgem.secs.functionbase.SecsStreamFunction

illegal data

Data Items

• MHEAD

Structure:

>>> import secsgem
>>> secsgem.SecsS09F07
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)

Bases: secsgem.secs.functionbase.SecsStreamFunction

transaction timer timeout

Data Items

• SHEAD

Structure:

>>> import secsgem
>>> secsgem.SecsS09F09
SHEAD: 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)

Bases: secsgem.secs.functionbase.SecsStreamFunction

data too long

Data Items

• MHEAD

Structure:

>>> import secsgem
>>> secsgem.SecsS09F11
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)

Bases: secsgem.secs.functionbase.SecsStreamFunction

conversation timeout

Data Items

• MEXP
• EDID

Structure:

>>> import secsgem
>>> secsgem.SecsS09F13
{
    MEXP: A[6]
    EDID: U1/U2/U4/U8/I1/I2/I4/I8/A/B
}

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)

Bases: secsgem.secs.functionbase.SecsStreamFunction

abort transaction stream 10

Structure:

>>> import secsgem
>>> secsgem.SecsS10F00
Header only

Example:

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

Parameters:value (None) – function has no parameters

class secsgem.secs.functions.SecsS10F01(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

terminal - request

Data Items

• TID
• TEXT

Structure:

>>> import secsgem
>>> secsgem.SecsS10F01
{
    TID: B[1]
    TEXT: U1/U2/U4/U8/I1/I2/I4/I8/A/B
}

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)

Bases: secsgem.secs.functionbase.SecsStreamFunction

terminal - acknowledge

Data Items

• ACKC10

Structure:

>>> import secsgem
>>> secsgem.SecsS10F02
ACKC10: B[1]

Example:

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

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

class secsgem.secs.functions.SecsS10F03(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

terminal single - display

Data Items

• TID
• TEXT

Structure:

>>> import secsgem
>>> secsgem.SecsS10F03
{
    TID: B[1]
    TEXT: U1/U2/U4/U8/I1/I2/I4/I8/A/B
}

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)

Bases: secsgem.secs.functionbase.SecsStreamFunction

terminal single - acknowledge

Data Items

• ACKC10

Structure:

>>> import secsgem
>>> secsgem.SecsS10F04
ACKC10: B[1]

Example:

>>> import secsgem
>>> secsgem.SecsS10F04(secsgem.ACKC10.TERMINAL_NOT_AVAILABLE)
S10F4
  <B 0x2> .

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

class secsgem.secs.functions.SecsS12F00(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

abort transaction stream 12

Structure:

>>> import secsgem
>>> secsgem.SecsS12F00
Header only

Example:

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

Parameters:value (None) – function has no parameters

class secsgem.secs.functions.SecsS12F01(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

map setup data - send

Data Items

• MID
• IDTYP
• FNLOC
• FFROT
• ORLOC
• RPSEL
• REFP
• DUTMS
• XDIES
• YDIES
• ROWCT
• COLCT
• NULBC
• PRDCT
• PRAXI

Structure:

>>> import secsgem
>>> secsgem.SecsS12F01
{
    MID: A/B[80]
    IDTYP: B[1]
    FNLOC: U2
    FFROT: U2
    ORLOC: B
    RPSEL: U1
    REFP: [
        DATA: I1/I2/I4/I8
        ...
    ]
    DUTMS: A
    XDIES: U1/U2/U4/U8/F4/F8
    YDIES: U1/U2/U4/U8/F4/F8
    ROWCT: U1/U2/U4/U8
    COLCT: U1/U2/U4/U8
    NULBC: U1/A
    PRDCT: U1/U2/U4/U8
    PRAXI: B[1]
}

Example:

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

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

class secsgem.secs.functions.SecsS12F02(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

map setup data - acknowledge

Data Items

• SDACK

Structure:

>>> import secsgem
>>> secsgem.SecsS12F02
SDACK: B[1]

Example:

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

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

class secsgem.secs.functions.SecsS12F03(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

map setup data - request

Data Items

• MID
• IDTYP
• MAPFT
• FNLOC
• FFROT
• ORLOC
• PRAXI
• BCEQU
• NULBC

Structure:

>>> import secsgem
>>> secsgem.SecsS12F03
{
    MID: A/B[80]
    IDTYP: B[1]
    MAPFT: B[1]
    FNLOC: U2
    FFROT: U2
    ORLOC: B
    PRAXI: B[1]
    BCEQU: U1/A
    NULBC: U1/A
}

Example:

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

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

class secsgem.secs.functions.SecsS12F04(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

map setup data

Data Items

• MID
• IDTYP
• FNLOC
• ORLOC
• RPSEL
• REFP
• DUTMS
• XDIES
• YDIES
• ROWCT
• COLCT
• PRDCT
• BCEQU
• NULBC
• MLCL

Structure:

>>> import secsgem
>>> secsgem.SecsS12F04
{
    MID: A/B[80]
    IDTYP: B[1]
    FNLOC: U2
    ORLOC: B
    RPSEL: U1
    REFP: [
        DATA: I1/I2/I4/I8
        ...
    ]
    DUTMS: A
    XDIES: U1/U2/U4/U8/F4/F8
    YDIES: U1/U2/U4/U8/F4/F8
    ROWCT: U1/U2/U4/U8
    COLCT: U1/U2/U4/U8
    PRDCT: U1/U2/U4/U8
    BCEQU: U1/A
    NULBC: U1/A
    MLCL: U1/U2/U4/U8
}

Example:

>>> import secsgem
>>> secsgem.SecsS12F04({"MID": "materialID",                 "IDTYP": secsgem.IDTYP.FILM_FRAME,                 "FNLOC": 0,                 "ORLOC": secsgem.ORLOC.CENTER_DIE,                 "RPSEL": 0,                 "REFP": [[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 0x2>
    <U2 0 >
    <B 0x0>
    <U1 0 >
    <L [2]
      <I1 1 2 >
      <I1 2 3 >
    >
    <A "unit">
    <U1 100 >
    <U1 100 >
    <U1 10 >
    <U1 10 >
    <U1 100 >
    <U1 1 3 5 7 >
    <A "{x}">
    <U1 0 >
  > .

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

class secsgem.secs.functions.SecsS12F05(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

map transmit inquire

Data Items

• MID
• IDTYP
• MAPFT
• MLCL

Structure:

>>> import secsgem
>>> secsgem.SecsS12F05
{
    MID: A/B[80]
    IDTYP: B[1]
    MAPFT: B[1]
    MLCL: U1/U2/U4/U8
}

Example:

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

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

class secsgem.secs.functions.SecsS12F06(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

map transmit - grant

Data Items

• GRNT1

Structure:

>>> import secsgem
>>> secsgem.SecsS12F06
GRNT1: B[1]

Example:

>>> import secsgem
>>> secsgem.SecsS12F06(secsgem.GRNT1.MATERIALID_UNKNOWN)
S12F6
  <B 0x5> .

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

class secsgem.secs.functions.SecsS12F07(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

map data type 1 - send

Data Items

• MID
• IDTYP
• RSINF
• BINLT

Structure:

>>> import secsgem
>>> secsgem.SecsS12F07
{
    MID: A/B[80]
    IDTYP: B[1]
    DATA: [
        {
            RSINF: I1/I2/I4/I8[3]
            BINLT: U1/A
        }
        ...
    ]
}

Example:

>>> import secsgem
>>> secsgem.SecsS12F07({             "MID": "materialID",             "IDTYP": secsgem.IDTYP.WAFER,             "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]
        <I1 1 2 3 >
        <U1 1 2 3 4 >
      >
      <L [2]
        <I1 4 5 6 >
        <U1 5 6 7 8 >
      >
    >
  > .

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

class secsgem.secs.functions.SecsS12F08(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

map data type 1 - acknowledge

Data Items

• MDACK

Structure:

>>> import secsgem
>>> secsgem.SecsS12F08
MDACK: B[1]

Example:

>>> import secsgem
>>> secsgem.SecsS12F08(secsgem.MDACK.ABORT_MAP)
S12F8
  <B 0x3> .

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

class secsgem.secs.functions.SecsS12F09(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

map data type 2 - send

Data Items

• MID
• IDTYP
• STRP
• BINLT

Structure:

>>> import secsgem
>>> secsgem.SecsS12F09
{
    MID: A/B[80]
    IDTYP: B[1]
    STRP: I1/I2/I4/I8[2]
    BINLT: U1/A
}

Example:

>>> import secsgem
>>> secsgem.SecsS12F09({"MID": "materialID", "IDTYP": secsgem.IDTYP.WAFER, "STRP": [0, 1], "BINLT": [1, 2, 3, 4, 5, 6]})
S12F9 W
  <L [4]
    <A "materialID">
    <B 0x0>
    <I1 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)

Bases: secsgem.secs.functionbase.SecsStreamFunction

map data type 2 - acknowledge

Data Items

• MDACK

Structure:

>>> import secsgem
>>> secsgem.SecsS12F10
MDACK: B[1]

Example:

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

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

class secsgem.secs.functions.SecsS12F11(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

map data type 3 - send

Data Items

• MID
• IDTYP
• XYPOS
• BINLT

Structure:

>>> import secsgem
>>> secsgem.SecsS12F11
{
    MID: A/B[80]
    IDTYP: B[1]
    DATA: [
        {
            XYPOS: I1/I2/I4/I8[2]
            BINLT: U1/A
        }
        ...
    ]
}

Example:

>>> import secsgem
>>> secsgem.SecsS12F11({             "MID": "materialID",             "IDTYP": secsgem.IDTYP.WAFER,             "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]
        <I1 1 2 >
        <U1 1 2 3 4 >
      >
      <L [2]
        <I1 3 4 >
        <U1 5 6 7 8 >
      >
    >
  > .

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

class secsgem.secs.functions.SecsS12F12(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

map data type 3 - acknowledge

Data Items

• MDACK

Structure:

>>> import secsgem
>>> secsgem.SecsS12F12
MDACK: B[1]

Example:

>>> import secsgem
>>> secsgem.SecsS12F12(secsgem.MDACK.FORMAT_ERROR)
S12F12
  <B 0x1> .

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

class secsgem.secs.functions.SecsS12F13(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

map data type 1 - request

Data Items

• MID
• IDTYP

Structure:

>>> import secsgem
>>> secsgem.SecsS12F13
{
    MID: A/B[80]
    IDTYP: B[1]
}

Example:

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

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

class secsgem.secs.functions.SecsS12F14(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

map data type 1

Data Items

• MID
• IDTYP
• RSINF
• BINLT

Structure:

>>> import secsgem
>>> secsgem.SecsS12F14
{
    MID: A/B[80]
    IDTYP: B[1]
    DATA: [
        {
            RSINF: I1/I2/I4/I8[3]
            BINLT: U1/A
        }
        ...
    ]
}

Example:

>>> import secsgem
>>> secsgem.SecsS12F14({             "MID": "materialID",             "IDTYP": secsgem.IDTYP.WAFER,             "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]
        <I1 1 2 3 >
        <U1 1 2 3 4 >
      >
      <L [2]
        <I1 4 5 6 >
        <U1 5 6 7 8 >
      >
    >
  > .

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

class secsgem.secs.functions.SecsS12F15(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

map data type 2 - request

Data Items

• MID
• IDTYP

Structure:

>>> import secsgem
>>> secsgem.SecsS12F15
{
    MID: A/B[80]
    IDTYP: B[1]
}

Example:

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

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

class secsgem.secs.functions.SecsS12F16(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

map data type 2

Data Items

• MID
• IDTYP
• STRP
• BINLT

Structure:

>>> import secsgem
>>> secsgem.SecsS12F16
{
    MID: A/B[80]
    IDTYP: B[1]
    STRP: I1/I2/I4/I8[2]
    BINLT: U1/A
}

Example:

>>> import secsgem
>>> secsgem.SecsS12F16({"MID": "materialID", "IDTYP": secsgem.IDTYP.WAFER, "STRP": [0, 1], "BINLT": [1, 2, 3, 4, 5, 6]})
S12F16
  <L [4]
    <A "materialID">
    <B 0x0>
    <I1 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)

Bases: secsgem.secs.functionbase.SecsStreamFunction

map data type 3 - request

Data Items

• MID
• IDTYP
• SDBIN

Structure:

>>> import secsgem
>>> secsgem.SecsS12F17
{
    MID: A/B[80]
    IDTYP: B[1]
    SDBIN: B[1]
}

Example:

>>> import secsgem
>>> secsgem.SecsS12F17({"MID": "materialID", "IDTYP": secsgem.IDTYP.WAFER, "SDBIN": secsgem.SDBIN.DONT_SEND})
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)

Bases: secsgem.secs.functionbase.SecsStreamFunction

map data type 3

Data Items

• MID
• IDTYP
• XYPOS
• BINLT

Structure:

>>> import secsgem
>>> secsgem.SecsS12F18
{
    MID: A/B[80]
    IDTYP: B[1]
    DATA: [
        {
            XYPOS: I1/I2/I4/I8[2]
            BINLT: U1/A
        }
        ...
    ]
}

Example:

>>> import secsgem
>>> secsgem.SecsS12F18({                 "MID": "materialID",                 "IDTYP": secsgem.IDTYP.WAFER,                 "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]
        <I1 1 2 >
        <U1 1 2 3 4 >
      >
      <L [2]
        <I1 3 4 >
        <U1 5 6 7 8 >
      >
    >
  > .

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

class secsgem.secs.functions.SecsS12F19(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

map error report - send

Data Items

• MAPER
• DATLC

Structure:

>>> import secsgem
>>> secsgem.SecsS12F19
{
    MAPER: B[1]
    DATLC: U1
}

Example:

>>> import secsgem
>>> secsgem.SecsS12F19({"MAPER": secsgem.MAPER.INVALID_DATA, "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)

Bases: secsgem.secs.functionbase.SecsStreamFunction

abort transaction stream 14

Structure:

>>> import secsgem
>>> secsgem.SecsS14F00
Header only

Example:

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

Parameters:value (None) – function has no parameters

class secsgem.secs.functions.SecsS14F01(value=None)

Bases: secsgem.secs.functionbase.SecsStreamFunction

GetAttr request

Data Items

• OBJSPEC
• OBJTYPE
• OBJID
• ATTRID
• ATTRDATA
• ATTRRELN

Structure:

>>> import secsgem
>>> secsgem.SecsS14F01
{
    OBJSPEC: A
    OBJTYPE: U1/U2/U4/U8/A
    OBJID: [
        DATA: U1/U2/U4/U8/A
        ...
    ]
    FILTER: [
        {
            ATTRID: U1/U2/U4/U8/A
            ATTRDATA: L/BOOLEAN/U1/U2/U4/U8/I1/I2/I4/I8/F4/F8/A/B
            ATTRRELN: U1
        }
        ...
    ]
    ATTRID: [
        DATA: U1/U2/U4/U8/A
        ...
    ]
}

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)

Bases: secsgem.secs.functionbase.SecsStreamFunction

GetAttr data

Data Items

• OBJID
• ATTRID
• ATTRDATA
• OBJACK
• ERRCODE
• ERRTEXT

Structure:

>>> import secsgem
>>> secsgem.SecsS14F02
{
    DATA: [
        {
            OBJID: U1/U2/U4/U8/A
            ATTRIBS: [
                {
                    ATTRID: U1/U2/U4/U8/A
                    ATTRDATA: L/BOOLEAN/U1/U2/U4/U8/I1/I2/I4/I8/F4/F8/A/B
                }
                ...
            ]
        }
        ...
    ]
    ERRORS: {
        OBJACK: U1[1]
        ERROR: [
            {
                ERRCODE: I1/I2/I4/I8
                ERRTEXT: A[120]
            }
            ...
        ]
    }
}

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">
            <U1 4 >
          >
          <L [2]
            <A "Columns">
            <U1 4 >
          >
          <L [2]
            <A "CellStatus">
            <U1 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)

Bases: secsgem.secs.functionbase.SecsStreamFunction

SetAttr request

Data Items

• OBJSPEC
• OBJTYPE
• OBJID
• ATTRID
• ATTRDATA

Structure:

>>> import secsgem
>>> secsgem.SecsS14F03
{
    OBJSPEC: A
    OBJTYPE: U1/U2/U4/U8/A
    OBJID: [
        DATA: U1/U2/U4/U8/A
        ...
    ]
    ATTRIBS: [
        {
            ATTRID: U1/U2/U4/U8/A
            ATTRDATA: L/BOOLEAN/U1/U2/U4/U8/I1/I2/I4/I8/F4/F8/A/B
        }
        ...
    ]
}

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)

Bases: secsgem.secs.functionbase.SecsStreamFunction

SetAttr data

Data Items

• OBJID
• ATTRID
• ATTRDATA
• OBJACK
• ERRCODE
• ERRTEXT

Structure:

>>> import secsgem
>>> secsgem.SecsS14F04
{
    DATA: [
        {
            OBJID: U1/U2/U4/U8/A
            ATTRIBS: [
                {
                    ATTRID: U1/U2/U4/U8/A
                    ATTRDATA: L/BOOLEAN/U1/U2/U4/U8/I1/I2/I4/I8/F4/F8/A/B
                }
                ...
            ]
        }
        ...
    ]
    ERRORS: {
        OBJACK: U1[1]
        ERROR: [
            {
                ERRCODE: I1/I2/I4/I8
                ERRTEXT: A[120]
            }
            ...
        ]
    }
}

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">
            <U1 4 >
          >
          <L [2]
            <A "Columns">
            <U1 4 >
          >
          <L [2]
            <A "CellStatus">
            <U1 6 >
          >
          <L [2]
            <A "LotID">
            <A "LOT001">
          >
        >
      >
    >
    <L [2]
      <U1 0 >
      <L>
    >
  > .

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