REST API Up - Industry4/MultiPlug.Ext.Hermes GitHub Wiki

<<- Back to REST API Home

Index

SMEMA

Boards

Hermes

SMEMA Machine Ready

Description

Returns the SMEMA Machine Ready I/O State

URL

GET /api/multiplug.ext.hermes/up/smema/

Data

  • String lane Optional. Guid of the Lane. If not specified then first lane will be used.

JSON Response Example

{
    "ready": false
}

HTTP Response Codes

  • 200 OK
  • 400 BadRequest - Lane Not Found. If lane guid not specified, no lanes are setup.
  • 403 Forbidden - API Not Enabled

Set SMEMA Machine Ready

Description

Sets the SMEMA Machine Ready I/O State

URL

POST /api/multiplug.ext.hermes/up/smema/

Data

  • String lane Optional. Guid of the Lane. If not specified then first lane will be used.
  • Bool ready Options: true false

JSON Response Example

{
    "ready": true
}

HTTP Response Codes

  • 200 OK
  • 422 Unprocessed - Lane Not Found. If lane guid not specified, no lanes are setup.
  • 403 Forbidden - API Not Enabled

All Boards

Description

Returns all Upstream Boards

URL

POST /api/multiplug.ext.hermes/up/boards/all/

Data

  • String lane Optional. Guid of the Lane. If not specified then first lane will be used.

JSON Response Example

[
    {
        "guid": "0167be38-5427-4592-bbb3-18cad11a3a40",
        "boardId": "647d5b52-bd51-41d1-a4ad-4104a460b100",
        "boardIdCreatedBy": "DEK NeoHorizon",
        "failedBoard": 1,
        "productTypeId": "Basic",
        "flippedBoard": 0,
        "topBarcode": "0123456789",
        "length": 50.0,
        "width": 32.0,
        "thickness": 2.0
    }
]

HTTP Response Codes

  • 200 OK
  • 400 BadRequest - Lane Not Found. If lane guid not specified, no lanes are setup.
  • 403 Forbidden - API Not Enabled

Board Forecast

Description

Returns any Board Forecast

URL

POST /api/multiplug.ext.hermes/up/boards/forecast/

Data

  • String lane Optional. Guid of the Lane. If not specified then first lane will be used.

JSON Response Example

{
    "forecastId": "556893030033",
    "timeUntilAvailable": 20.0,
    "boardId": "13c53a66-a45a-49a2-86cb-6fd5a1d62edc",
    "boardIdCreatedBy": "DEK NeoHorizon",
    "failedBoard": 1,
    "flippedBoard": 1,
    "length": 55.0,
    "width": 21.0,
    "thickness": 2.0
}

HTTP Response Codes

  • 200 OK
  • 400 BadRequest - Lane Not Found. If lane guid not specified, no lanes are setup.
  • 400 BadRequest - Board Forecast Unavailable.
  • 403 Forbidden - API Not Enabled

Hermes Service Description

Description

Returns the Hermes Service Description from the Upstream Connection

URL

GET /api/multiplug.ext.hermes/up/hermes/servicedescription/

Data

  • String lane Optional. Guid of the Lane. If not specified then first lane will be used.

JSON Response Example

{
    "machineId": "???UpstreamSimulation",
    "laneId": 1,
    "interfaceId": "UpStreamInterface",
    "version": "1.3",
    "supportedFeatures": {
        "featureCheckAliveResponse": true,
        "featureBoardForecast": true,
        "featureQueryBoardInfo": false,
        "featureSendBoardInfo": true,
        "featureCommand": false
    }
}

HTTP Response Codes

  • 200 OK
  • 400 Bad Request - Lane Not Found. If lane guid not specified, no lanes are setup.
  • 400 Bad Request - Service Description not received.
  • 403 Forbidden - API Not Enabled

Restart Hermes Connection

Description

Reconnects the Upstream Hermes connection

URL

POST /api/multiplug.ext.hermes/up/hermes/connection/restart

Data

  • String lane Optional. Guid of the Lane. If not specified then first lane will be used.

HTTP Response Codes

  • 200 OK
  • 403 Forbidden - API Not Enabled