> For the complete documentation index, see [llms.txt](https://docs.heisenware.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.heisenware.com/reference/functions/connectors.md).

# Connectors

Connectors are the [functions](https://docs.heisenware.com/concepts/executors-and-instances.md) that speak to the world outside Heisenware: machines, industrial protocols, web APIs, mail servers, databases and devices. They come with the platform, on the agent named **Connectors**.

## Where a connector runs

Every executor carries an address, and its agent decides which network the call goes out from. So the question is always: can the platform reach that system itself?

### Direct connection

When it can, the connector runs on the platform's own Connectors agent and you choose nothing. This holds for:

* The Heisenware Cloud reaching systems on the public internet, such as a cloud API, a web service, or a public MQTT broker.
* An [on-premise installation](https://docs.heisenware.com/self-hosting/self-hosting/install.md) reaching systems within the same network.

### Local connection (via an agent)

If the target system sits in an isolated network segment the platform cannot reach, such as a PLC in a machine network, an agent inside that network runs the connector. It comes as a [native agent](https://docs.heisenware.com/app-manager/app-manager/agents/native-agent.md), a [Docker agent](https://docs.heisenware.com/app-manager/app-manager/agents/docker-agent.md) or an [LXC agent](https://docs.heisenware.com/app-manager/app-manager/agents/lxc-agent.md).

{% stepper %}
{% step %}

#### Build

The App Manager's **Agents** panel builds one. **Build agent** asks for a name, the target platform and the connectors to include, and says what each of them can do on the host. The finished build appears under **Builds**, with the installer to download and the requirements for your IT.
{% endstep %}

{% step %}

#### Install

Your IT installs it on a host inside that network. The agent dials out to the platform, so no inbound hole is needed.
{% endstep %}

{% step %}

#### Use

Once the agent is online it appears by its name in the [Functions explorer](https://docs.heisenware.com/app-builder/app-builder/functions.md), with the connectors it was built with. An executor on that agent runs next to the devices.
{% endstep %}
{% endstepper %}

{% hint style="info" %}
Which network a function runs in is the executor's address. See [Agents and where code runs](https://docs.heisenware.com/concepts/agents-and-where-code-runs.md).
{% endhint %}

## Instance creation

Most connectors need an instance before they can reach a target system: a living object inside the agent that holds the connection and its credentials. The `create` function is the constructor; `delete` ends it.

An instance has a name, unique on its agent, and every App of the workspace reaches it by that name. It is created once and then outlives deployments and platform restarts: the agent remembers how it was born and re-creates it when it starts. Trigger the constructor with `onAppStart`, and creating an instance that already exists does nothing.

{% hint style="warning" %}
An instance is constructed, never reconfigured. Changing a `create` executor's inputs and triggering it again does not re-apply them. Use the class's setter functions for what can change at runtime; otherwise delete the instance, set the new inputs and create it again.
{% endhint %}

Some connectors need no instance and work right away. [File I/O](https://docs.heisenware.com/reference/functions/connectors/file-i-o.md), [GraphQL](https://docs.heisenware.com/reference/functions/connectors/graphql.md), [Operating system (OS)](https://docs.heisenware.com/reference/functions/connectors/operating-system-os.md) and [Trusted certificates](https://docs.heisenware.com/reference/functions/connectors/trusted-certificates.md) offer static functions only, and [HTTP / REST](https://docs.heisenware.com/reference/functions/connectors/http-rest.md) has both: static functions for a single call, an instance where many calls share a base URL and credentials.

## Available connectors

The following table lists the available connectors and their required configuration types. Each link leads to a detailed configuration guide.

| Connector                                                                                                            | Description                                                                         | Type                                |
| -------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------- |
| [Allen-Bradley](https://docs.heisenware.com/reference/functions/connectors/allen-bradley.md)                         | Connects directly to Allen-Bradley PLCs for machine data acquisition and control.   | Instance creation required          |
| [ctrlX Data Layer](https://docs.heisenware.com/reference/functions/connectors/ctrlx-data-layer.md)                   | Reads, writes and subscribes to the Data Layer of a Bosch Rexroth ctrlX CORE.       | Instance creation required          |
| [Email](https://docs.heisenware.com/reference/functions/connectors/email.md)                                         | Sends emails via SMTP.                                                              | Instance creation required          |
| [File I/O](https://docs.heisenware.com/reference/functions/connectors/file-i-o.md)                                   | Reads from and writes to files on a connected file system.                          | Static functions only               |
| [GraphQL](https://docs.heisenware.com/reference/functions/connectors/graphql.md)                                     | Interacts with any GraphQL API for flexible data queries.                           | Static functions only               |
| [GPIO counter](https://docs.heisenware.com/reference/functions/connectors/gpio-counter.md)                           | Counts digital pulses on Raspberry Pi GPIO pins, with automatic run/stop detection. | Instance creation required          |
| [Heidenhain DNC](https://docs.heisenware.com/reference/functions/connectors/heidenhain-dnc.md)                       | Reaches Heidenhain controls without OPC UA, over Heidenhain's DNC interface.        | On request, as its own agent        |
| [Heidenhain OPC UA](https://docs.heisenware.com/reference/functions/connectors/heidenhain-opc-ua.md)                 | Connects to Heidenhain controllers using the OPC UA protocol.                       | Instance creation required          |
| [HTTP / REST](https://docs.heisenware.com/reference/functions/connectors/http-rest.md)                               | Makes requests to standard web APIs and HTTP endpoints.                             | Mixed (Static and instance options) |
| [Hydra MIP](https://docs.heisenware.com/reference/functions/connectors/hydra-mip.md)                                 | Integrates natively with the Manufacturing Integration Platform (MIP).              | Instance creation required          |
| [Kuando Busylight](https://docs.heisenware.com/reference/functions/connectors/kuando-busylight.md)                   | Controls Kuando Busylight status indicators.                                        | Instance creation required          |
| [Label printer](https://docs.heisenware.com/reference/functions/connectors/label-printer.md)                         | Sends print commands to ZPL-compatible label printers.                              | Instance creation required          |
| [Modbus](https://docs.heisenware.com/reference/functions/connectors/modbus.md)                                       | Communicates with industrial devices using the Modbus protocol.                     | Instance creation required          |
| [MQTT Client](https://docs.heisenware.com/reference/functions/connectors/mqtt-client.md)                             | Connects to an MQTT broker to publish and subscribe to topics.                      | Instance creation required          |
| [OPC UA Client](https://docs.heisenware.com/reference/functions/connectors/opc-ua-client.md)                         | Connects to an OPC UA server for industrial automation data exchange.               | Instance creation required          |
| [OPC UA Server](https://docs.heisenware.com/reference/functions/connectors/opc-ua-server.md)                         | Deploys an OPC UA server to expose data from the application.                       | Instance creation required          |
| [Operating system (OS)](https://docs.heisenware.com/reference/functions/connectors/operating-system-os.md)           | Accesses statistics and information from the host operating system.                 | Static functions only               |
| [Relational database](https://docs.heisenware.com/reference/functions/storage/relational-database.md)                | Connects to external SQL databases.                                                 | Instance creation required          |
| [RS-232/485](https://docs.heisenware.com/reference/functions/connectors/rs-232-485.md)                               | Communicates with devices over a serial port.                                       | Instance creation required          |
| [SAP Digital Manufacturing](https://docs.heisenware.com/reference/functions/connectors/sap-digital-manufacturing.md) | Integrates natively with SAP Digital Manufacturing.                                 | Instance creation required          |
| [Siemens S7](https://docs.heisenware.com/reference/functions/connectors/siemens-s7.md)                               | Connects directly to Siemens S7 PLCs for data acquisition and control.              | Instance creation required          |
| [Timeseries database](https://docs.heisenware.com/reference/functions/storage/timeseries-database.md)                | Connects to external InfluxDB databases.                                            | Instance creation required          |
| [Trusted certificates](https://docs.heisenware.com/reference/functions/connectors/trusted-certificates.md)           | Trusts the machines and servers on your own network once, for every connector.      | Static functions only               |
| [Zebra RFID IoT](https://docs.heisenware.com/reference/functions/connectors/zebra-rfid-iot.md)                       | Interacts with Zebra RFID readers and devices.                                      | Instance creation required          |


---

# 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.heisenware.com/reference/functions/connectors.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.
