> For the complete documentation index, see [llms.txt](https://support.powerio.com/hub/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://support.powerio.com/hub/codesys-hvac/en/hvac-library/functionblocks/generic/automationportalconnector.md).

# AutomationPortalConnector

## `AutomationPortalConnector` (FB)

FUNCTION\_BLOCK AutomationPortalConnector

### Short description

> Connects the controller to the HVAC Automation Portal. More information at [www.hvac-automation.com.\\](http://www.hvac-automation.com.\\)
> Allows variables to be transferred via the CODESYS symbol configuration.\
> In the portal, these can then be recorded and evaluated.\
> In addition, alarms can be forwarded, the CODESYS visualization can be accessed, and the device directory can be accessed.\
> For the powerIO IoT Gateway and PLC controller H1.M100, a VPN connection can be established directly via the portal.

### Representation

<figure><img src="https://2592874069-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FQR4vCFzt6ixgsqlR3pdR%2Fuploads%2Fgit-blob-add5a849000d6f7bc031c3722d0adbe13aa34f8b%2Fimage.png?alt=media" alt=""><figcaption></figcaption></figure>

### Functional description

To connect, please follow the steps below:

#### Transfer variables:

> 1. <https://portal.hvac-automation.com> visit and register for free.
> 2. Attach the generated project ID to the input **diProjectId** attach. Set xEn to TRUE.
> 3. Password at the input **sPassword** assign.
> 4. Right-click on “Application” and create “Symbol configuration”. There, check the variables that should be transferred to the portal.
> 5. Download the application to the controller.
> 6. In the HVAC Automation Portal, the controller now appears orange; the password you created yourself must be entered here. Done.

<figure><img src="https://2592874069-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FQR4vCFzt6ixgsqlR3pdR%2Fuploads%2Fgit-blob-99ba0c5fd2bf105f728ef1ca6ae57e46df96dc5d%2Fimage.png?alt=media" alt=""><figcaption></figcaption></figure>

#### Transfer visualization:

> To transfer the visualization, you must enter at the input **sLocalVisuUrl** enter the visualization to be transferred. If the local CODESYS visualization is to be transferred, it is sufficient to enter ‘<http://127.0.0.1>’ or ‘<http://127.0.0.1:8080/webvisu.htm>’.\
> In the HVAC Automation Portal, the visualization can then be placed and used like a variable.

<figure><img src="https://2592874069-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FQR4vCFzt6ixgsqlR3pdR%2Fuploads%2Fgit-blob-4b393968908db1f27f8e5f5e3cdab7d09fd755f7%2Fimage.png?alt=media" alt=""><figcaption></figcaption></figure>

#### Transfer device directory:

> The folder structure of the device can be accessed via the HVAC Automation Portal in order to back up files remotely, for example. To do this, at the input **sBrowsePath** either ‘/’ for the complete root directory or ‘./’ for the CODESYS PLC directory must be entered.

<figure><img src="https://2592874069-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FQR4vCFzt6ixgsqlR3pdR%2Fuploads%2Fgit-blob-7f632363471c86bba95e7f1f9fd8262d7e863b07%2Fimage.png?alt=media" alt=""><figcaption></figcaption></figure>

InOut:

| Scope  | Name                 | Type          | Initial              |
| ------ | -------------------- | ------------- | -------------------- |
| Input  | `xEn`                | `BOOL`        | TRUE                 |
| Input  | `diProjectId`        | `DINT`        | -1                   |
| Input  | `sPassword`          | `STRING`      |                      |
| Input  | `sStorageDirectory`  | `STRING`      |                      |
| Input  | `tLiveValueInterval` | `TIME`        | TIME#1s0ms           |
| Input  | `sLocalVisuUrl`      | `STRING(200)` | ‘<http://127.0.0.1>’ |
| Input  | `sBrowsePath`        | `STRING`      |                      |
| Output | `sStatus`            | `STRING(255)` |                      |
| Output | `xError`             | `BOOL`        |                      |
| Output | `xConnected`         | `BOOL`        |                      |


---

# 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://support.powerio.com/hub/codesys-hvac/en/hvac-library/functionblocks/generic/automationportalconnector.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.