> For the complete documentation index, see [llms.txt](https://docs.cybus.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cybus.io/2-7-0/connectors/shop-floor-connectors/open-protocol/openprotocolendpoint.md).

# Open Protocol Endpoint Properties

## `midGroup` (string, enum)

Name of the MID group this endpoint addresses. Each group stands for the MIDs the Open Protocol specification defines for one function, e.g. lastTightening for the MID 0060 to 0063 quartet. Which groups are valid depends on the operation: subscribe groups are push subscriptions, read groups are request and reply MID pairs, write groups are command MIDs.

This element must be one of the following enum values:

* `abortJob`
* `alarm`
* `alarmAcknowledged`
* `alarmStatus`
* `autoDisableSettings`
* `automaticManualMode`
* `bypassIdentifier`
* `communicationStop`
* `controllerReboot`
* `deviceCommand`
* `digitalInputFunction`
* `disableTool`
* `disconnectTool`
* `displayUserTextOnCompact`
* `displayUserTextOnGraph`
* `enableTool`
* `executeDynamicJob`
* `flashGreenLightOnTool`
* `histogramUpload`
* `identifierDownload`
* `ioDeviceStatus`
* `jobBatchDecrement`
* `jobBatchIncrement`
* `jobDataUpload`
* `jobIdUpload`
* `jobInfo`
* `jobLineControl`
* `jobOff`
* `jobRestart`
* `keepAlive`
* `lastPowerMACSTighteningResultStationData`
* `lastTightening`
* `lockAtBatchDoneUpload`
* `modeDataUpload`
* `modeIdUpload`
* `motorTuning`
* `motorTuningResultData`
* `multiSpindleResult`
* `multiSpindleStatus`
* `multipleIdentifierResultParts`
* `oldTighteningResultUpload`
* `openProtocolCommandsDisabled`
* `parameterUserSetDownload`
* `passwordRequest`
* `passwordResponse`
* `plotData`
* `psetData`
* `psetID`
* `psetSelected`
* `readTimeUpload`
* `relayFunction`
* `resetAllIdentifiers`
* `resetDigitalInputFunction`
* `resetLatestIdentifier`
* `resetPsetBatchCounter`
* `selectJob`
* `selectMode`
* `selectParameterSetDynamically`
* `selectPset`
* `selectorControlGreenLights`
* `selectorControlRedLights`
* `selectorSocketInfo`
* `setCalibrationValue`
* `setDigitalInputFunction`
* `setExternallyControlledRelays`
* `setJobLineAlert1`
* `setJobLineAlert2`
* `setJobLineControlStart`
* `setPrimaryTool`
* `setPsetBatchSize`
* `setTime`
* `statusExternallyMonitoredInputs`
* `toolDataUpload`
* `toolPairingHandling`
* `toolTagID`
* `traceData`
* `userData`
* `userDataDownload`
* `userDataDownloadWithOffset`
* `vin`
* `vinDownload`

Examples: `"lastTightening"`, `"selectPset"`, `"psetData"`

## `mid` (integer)

Address one MID directly instead of naming a midGroup. For the MIDs no group covers: a controller may implement MIDs beyond the documented groups, and the Open Protocol specification reserves 1000 and up for vendor ranges. Whatever the specification defines for the number is applied automatically -- for a subscribe endpoint this is the data MID the controller pushes with, and its subscribe, acknowledge and unsubscribe MIDs are derived from it; for a read endpoint it is the request MID; for a write endpoint the command MID. Mutually exclusive with midGroup.

Example: `1000`

Additional restrictions:

* Minimum: `1`
* Maximum: `9999`

## `replyMid` (integer)

Which MID answers a read endpoint's request, for the request MIDs the specification does not pair with one. Only needed alongside mid, and only when the pairing is not documented -- a documented request MID derives its reply on its own.

Example: `1235`

Additional restrictions:

* Minimum: `1`
* Maximum: `9999`

## `traceType` (string, enum)

Which curve to subscribe for. Only used by the traceData group.

This element must be one of the following enum values:

* `angle`
* `torque`
* `current`
* `gradient`
* `stroke`
* `force`

Default: `"torque"`

## `functionNumber` (integer)

Which single function to subscribe, for the groups that subscribe one function at a time instead of a stream: relayFunction takes the relay function number, digitalInputFunction the digital input function number. The controller's own tables define the numbering. Without it the subscription goes out without a function number, as the previous connector sent it, and receives the pushes of every function.

Example: `1`

Additional restrictions:

* Maximum: `999`

## `revision` (integer)

Send this endpoint's MID at exactly this revision, instead of starting at the connector's default revision and stepping down when the controller refuses it. A pin in the connection's fixedRevisions for the same MID must name the same revision.

Examples: `1`, `8`

Additional restrictions:

* Minimum: `1`
* Maximum: `999`


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.cybus.io/2-7-0/connectors/shop-floor-connectors/open-protocol/openprotocolendpoint.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
