> 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/openprotocolconnection.md).

# Open Protocol Connection Properties

## `host` (string, required)

Hostname or IP address of the tightening controller.

Example: `"192.168.0.10"`

## `port` (integer)

TCP port the controller listens on for Open Protocol. 4545 is the protocol default.

Default: `4545`

Example: `4545`

Additional restrictions:

* Minimum: `1`
* Maximum: `65535`

## `device` (object, required)

Vendor and model of the controller, both required. The vendor, matched case-insensitively, picks the default headerStyle (see there); beyond that both are used for diagnostics and logging only. Controllers that need different revisions or message layouts are configured through fixedRevisions.

Properties of the `device` object:

#### `vendor` (string, required)

AtlasCopco, Bosch or Desoutter, in any letter case. Another vendor is accepted and gets the header style of Atlas Copco.

Examples: `"AtlasCopco"`, `"Bosch"`, `"Desoutter"`

#### `model` (string, required)

Free-form model or device identifier.

Example: `"myPowerFocus6000"`

## `keepAlive` (integer)

Interval in milliseconds between keep-alive messages (MID 9999). Stay below the controller's own keep-alive timeout: the protocol specification recommends 15000 at most, because controllers drop a link that has been silent for 15 seconds.

Default: `10000`

Example: `7000`

Additional restrictions:

* Minimum: `1000`

## `fixedRevisions`

Pin individual MIDs to a fixed revision. Each entry names the MID that is sent and its revision, as "{60,3}", "60,3" or JSON {"MID": 60, "Revision": 3}. A single string holding a JSON list of such objects, or a JSON object of MID to revision, is accepted as well. The connector pins {1,1}, {900,1} and {901,1} unless an entry names these MIDs. Without a pin, a subscription or request starts at the revision the previous connector used and steps down when the controller refuses it. Use pins for controllers that close the connection when they receive a MID at an unexpected revision (Bosch Rexroth controllers in particular).

The object must be one of the following types:

* `undefined`
* `undefined`

Examples: `["{1,3}","{60,3}"]`, `["{\"MID\": 14, \"Revision\": 1}"]`

## `disableMidParsing` (string)

Comma-separated list of MIDs whose payload is published as the bytes received from the controller instead of a parsed object. Empty or "000" parses everything. MIDs without a parser are always published as their ASCII body.

Default: `"000"`

Example: `"61,900"`

Additional restrictions:

* Regex pattern: `^\s*([0-9]{1,4}(\s*,\s*[0-9]{1,4})*)?\s*$`

## `genericMode` (boolean)

Send requests with the generic request message (MID 0006) and open subscriptions with the generic subscription message (MID 0008, closed with MID 0009) instead of the dedicated MIDs of each group. The specification allows the generic messages to substitute the dedicated ones, and some controllers only implement one of the two.

Default: `false`

## `headerStyle` (string, enum)

How the optional fields of the 20-byte message header are written when they are not used: revision 1, station 1, spindle 1, no sequence number, no message linking. 'digits' writes them as explicit digits (001, 01, 01, 00, 00); 'spaces' leaves them blank, which is the specification's default and means the same to a controller that follows it. Left unset, Desoutter controllers get spaces, because they are reported to refuse explicit header digits, and every other vendor gets digits, the format Connectware has always sent to Atlas Copco and Bosch Rexroth controllers.

This element must be one of the following enum values:

* `digits`
* `spaces`

Example: `"digits"`

## `rawData` (boolean)

Add a '\_raw' property carrying the message body exactly as received from the controller, alongside the payload.

Default: `false`

## `checkHostReachable` (boolean)

Log whether the host is reachable at the configured port before connecting. Diagnostics only; it does not change the connection attempt.

Default: `false`

## `timeOut` (integer)

Time in milliseconds to wait for the controller to answer a message. Together with retryTimes it sets how long the connector waits before it gives up on a message and reconnects: timeOut \* (retryTimes + 1).

Default: `3000`

Additional restrictions:

* Minimum: `100`

## `retryTimes` (integer)

How many more timeOut periods the connector waits for an answer before it gives up. See timeOut.

Default: `3`

## `linkLayerActivate` (boolean,null)

Acknowledge messages on the link level (MID 9997/9998, specification §2.2.5) instead of with the application level acknowledgement MIDs. Needs a controller that announces link level support. Unset or false uses the application level.

Default: `null`

## `watchdog` (object)

Detects a connection on which nothing arrives any more although the socket is still open. Every message counts, keep-alive replies included, so with keep-alive on the watchdog only triggers when the controller stops answering. The connection is then dropped and reconnected according to connectionStrategy.

Properties of the `watchdog` object:

#### `enabled` (boolean)

Default: `true`

#### `interval` (integer)

How often the watchdog checks, in milliseconds.

Default: `30000`

Additional restrictions:

* Minimum: `5000`

#### `inactivityThreshold` (integer)

How long nothing may arrive, in milliseconds, before the connection is dropped.

Default: `120000`

Additional restrictions:

* Minimum: `10000`

## `connectionStrategy` (object)

If a connection attempt fails, retries will be performed with increasing delay (waiting time) in between. The following parameters control how these delays behave.

Properties of the `connectionStrategy` object:

#### `initialDelay` (integer)

Delay (waiting time) of the first connection retry (in milliseconds). For subsequent retries, the delay will be increased according to the parameter incrementFactor which has a default value of 2.

Default: `1000`

Additional restrictions:

* Minimum: `100`

#### `maxDelay` (integer)

Maximum delay (waiting time) to wait until the next retry (in milliseconds). The delay (waiting time) for any subsequent connection retry will not be larger than this value. Must be strictly greater than initialDelay.

Default: `30000`

Additional restrictions:

* Minimum: `1000`

#### `incrementFactor` (number)

The factor used to increment initialDelay up to maxDelay, 1 or more. For example if initialDelay is set to 1000 and maxDelay to 5000 the values for the delay would be 1000, 2000, 4000, 5000 with the default of 2, and 1000, 1500, 2250, 3375, 5000 with 1.5.

Default: `2`

Additional restrictions:

* Minimum: `1`


---

# 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/openprotocolconnection.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.
