Connect IoT - SECS/GEM Driver#

The SECS/GEM is the semiconductor's equipment interface protocol for equipment-to-host data communications. In an automated fab, the interface can start and stop equipment processing, collect measurement data, change variables and select recipes for products. The SECS (SEMI Equipment Communications Standard)/GEM (Generic Equipment Model) standards do all this in a defined way.

The Connect IoT SECS/GEM driver is the implementation of the SECS/GEM driver for a Critical Manufacturing MES environment. For more information, see http://www.edgeintegration.com/downloads/Guide_to_understanding_SECS.pdf ⧉.

Data Types#

These are the supported specific data types:

Table: SECS/GEM specific data types

Protocol Parameters#

The protocol supports the following parameters, used to define the communication parameters, as well as the expected behavior of the driver:

Table: SECS/GEM specific parameters

Extended Parameters#

Property#

All Automation Properties defined in the Driver Definition that use this protocol will have the following extended (extra) attributes available to customize

Table: SECS/GEM specific extended properties

Event#

All Automation Events defined in the Driver Definition that use this protocol will have the following extended (extra) attributes available to customize

Table: SECS/GEM specific extended events

Event Property#

All Automation EventProperty defined in the Driver Definition that use this protocol will have the following extended (extra) attributes available to customize

Command#

All Automation Command defined in the Driver Definition that use this protocol will have the following extended (extra) attributes available to customize

Table: SECS/GEM specific command

Initial configuration flow#

When connection is requested and the autoConfigure configuration is set, the following message exchange is performed to configure the equipment:

• Establish Communication (S1F13)
  • Expect S1F14 with 0x00 ACK
• Set Online (S1F17)
  • Expect S1F18 with 0x00 or 0x02 ACK
• Delete Reports (S2F33) based on deleteReportsMode setting
  • Expect S2F34 with 0x00 ACK
• Define Reports (S2F33)
  • Expect S2F34 with 0x00 ACK
• Link Events with reports (S2F35)
  • Expect S2F36 with 0x00 ACK
• Enable/Disable events (S2F37) based on enableDisableEventsMode setting
  • Expect S2F38 with 0x00 ACK
• Enable/Disable alarms (S5F3) based on enableDisableAlarmsMode setting
  • Expect S5F4 with 0x00 ACK

Driver Extensions#

This protocol driver provides a set of extension that allow the customization to perform actions that are independent of the Driver Definitions associated. This means you can, using customization, register events that are not present in the Driver Definition.

This is particularly useful when accessing equipment data that is shared/too complex to access using the regular mechanisms. Also useful when needing to access data whose naming convention may vary from device to device.

Objects#

The objects are structures that are either passed as parameters or returned as result values.

RegisterHandler#

Table: SECS/GEM specific handler registration

UnregisterHandler#

Table: SECS/GEM specific handler unregistration

SecsMessage#

Table: SECS/GEM specific SecsMessage

SecsItem#

Table: SECS/GEM specific SecsItem

SecsTransaction#

Table: SECS/GEM specific SecsTransaction

Methods#

Register Handler#

Notifies the protocol driver to raise the occurrences of a specific SECS/GEM message type when it occurs.

void connect.iot.driver.secsgem.registerHandler(data: RegisterHandler)

Example#

Notify connect.iot.driver.secsgem.registerHandler

{
  "type": "S1F13",
  "mode": "HandleFullProcess"
}

Unregister Handler#

Notifies the protocol driver to stop raising the occurrences of a specific message when it occurs.

void connect.iot.driver.secsgem.unregisterHandler(data: UnregisterHandler)

Example#

Notify connect.iot.driver.secsgem.unregisterHandler

{
  "type": "S1F13"
}

Send Message#

Sends a message (or reply) to the equipment.

any connect.iot.driver.secsgem.sendMessage (data: SecsMessage)

Example#

SendRequest connect.iot.driver.secsgem.sendMessage

{
    "type": "S1F13",
    "item": {
        "type": "L",
        "value": [ {
            "type": "A",
            "name": "MLDN",
            "value": "Equipment TopModel"
        }, {
            "type": "A",
            "name": "SOFTREV",
            "value": "Software Rev 1.0"
        } ]
    }
}

Example (Reply)#

SendRequest connect.iot.driver.secsgem.sendMessage

{
    "type": "REPLY_1234567890",
    "content": {
        "type": "L",
        "value": [ {
            "type": "BI",
            "name": "COMMACK",
            "value": "0x00"
        } ]
    }
}

Internal Delete Reports#

Sends the message Delete Reports (S2F33) based on deleteReportsMode setting. This is used if you desire to send some custom handshake flow.

bool connect.iot.driver.secsgem.internalDeleteReports()

Internal Define Reports#

Sends the message Define Reports (S2F33). This is used if you desire to send some custom handshake flow.

bool connect.iot.driver.secsgem.internalDefineReports()

Internal Link Events#

Sends the message Link Events with reports (S2F35). This is used if you desire to send some custom handshake flow.

bool connect.iot.driver.secsgem.internalLinkEvents()

Internal Enable Disable Events#

Sends the message Enable/Disable events (S2F37) based on enableDisableEventsMode setting. This is used if you desire to send some custom handshake flow.

bool connect.iot.driver.secsgem.internalEnableDisableEvents()

Internal Enable Disable Alarms#

Sends the message Enable/Disable alarms (S5F3) based on enableDisableAlarmsMode setting. This is used if you desire to send some custom handshake flow.

bool connect.iot.driver.secsgem.internalEnableDisableAlarms()

Events#

connect.iot.driver.secsgem.receivedMessage.*#

Events are raised only if registered first. The content of the event is of type SecsTransaction, where the values will vary depending on the event that was triggered.

The full name of the event triggered will have appended the full name of the event previously registered.

Example (assuming the message S1F13 was previously registered using registerHandler):

{
    "id": "1234567890",
    "systemBytes": [0x00, 0x01, 0x02, 0x03],
    "needsReply": true,
    "primary": {
        "type": "S1F13",
        "item": {
            "type": "L",
            "value": [ {
                "type": "A",
                "name": "MLDN",
                "value": "Equipment TopModel"
            }, {
                "type": "A",
                "name": "SOFTREV",
                "value": "Software Rev 1.0"
            } ]
        }
    },
    "secondary": {
        "type": "S1F14",
        "item": {
            "type": "L",
            "value": [ {
                "type": "BI",
                "name": "COMMACK",
                "value": "0x00"
            }]
  }
    }
}

To send a reply (and replace the template reply) for this message, use Publish/SendRequest connect.iot.driver.secsgem.sendMessage

{
    "type": "REPLY_1234567890",
    "content": {
        "type": "L",
        "value": [ {
            "type": "BI",
            "name": "COMMACK",
            "value": "0x01"
        }]
    }
}