# AutomationPortalConnector

## `AutomationPortalConnector` (FB)

FUNCTION\_BLOCK AutomationPortalConnector

### Short description

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

### Representation

<figure><img src="/files/894a0802124e5b9c8a87e25f597bec3c7ac1ba0d" alt=""><figcaption></figcaption></figure>

### Function description

To connect, please go through the following steps:

#### Transfer variables:

> 1. <https://portal.hvac-automation.com> visit and register for free.
> 2. Generated project ID to the input **diProjectId** append. 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 are to 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="/files/41f901bfe1790df5a437c4f6365e0697ce1e10ed" alt=""><figcaption></figcaption></figure>

#### Transfer visualization:

> To transfer the visualization, you must enter the visualization to be transferred at the input **sLocalVisuUrl** If you want to transfer the local CODESYS visualization, 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="/files/7b0ca267eb55393dd837e724f79793ed0e7fbae5" alt=""><figcaption></figcaption></figure>

#### Transfer device directory:

> The HVAC Automation Portal can be used to access the device's folder structure, e.g. to back up files remotely. 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="/files/8fa0524cde0369dc75e815bd014ee45d4ef1d783" 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: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://support.powerio.com/hub/codesys-hvac/en/hvac-library/functionblocks/generic/automationportalconnector.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
