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

# MacroInfo

## `MacroInfo` (FB)

FUNCTION\_BLOCK MacroInfo IMPLEMENTS IMacroInfo

### Short description

> Display of status information for a macro\
> Application: Visualization

### Representation

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

### Interfaces

#### Inputs

| Name       | Data type | Value range | Initial value | Function                                                                   |
| ---------- | --------- | ----------- | ------------- | -------------------------------------------------------------------------- |
| *sVersion* | STRING    |             |               | Version of the macro                                                       |
| *xAlarm*   | BOOL      |             |               | Collective fault message                                                   |
| *xHint*    | BOOL      |             |               | General note                                                               |
| *xAuto*    | BOOL      |             |               | Status message of the operating mode (0 = manual mode, 1 = automatic mode) |

#### Outputs

| Name            | Data type | Value range | Initial value | Function                  |
| --------------- | --------- | ----------- | ------------- | ------------------------- |
| *sTitle*        | STRING    |             |               | Name of the macro         |
| *sLine1*        | STRING    |             |               | Line 1 of the tile        |
| *sLine2*        | STRING    |             |               | Line 2 of the tile        |
| *sInstanceName* | STRING    |             |               | Name of the instance      |
| *sInstancePath* | STRING    |             |               | Path name of the instance |

#### Setpoints / Parameters

| Name           | Data type | Value range | Initial value | Function                         |
| -------------- | --------- | ----------- | ------------- | -------------------------------- |
| **sEditLine1** | STRING    |             | ‘Line1’       | Input value - line 1 of the tile |
| **sEditLine2** | STRING    |             | ‘’            | Input value - line 2 of the tile |

### Functional description

#### General

This function block is used to display status information about a macro. For this purpose, the entire instance path is split depending on the desired function and displayed.

#### Output *sTitle*

The output *sTitle* is identical to the output *sInstanceName* and contains the current name of the macro.

#### Output *sLine1*

The output *sLine1* the content of the setpoint / parameter **sEditLine1** is displayed.

#### Output *sLine2*

The output *sLine2* the content of the setpoint / parameter **sEditLine2** is displayed.

#### Output *sInstanceName*

The output *sInstanceName* is identical to the output *sTitle* and contains the current name of the macro.

#### Output *sInstancePath*

The output *sInstancePath* contains the current instance path of the macro (Device.Application.POU)

### CODESYS

InOut:

| Scope       | Name            | Type       | Initial |
| ----------- | --------------- | ---------- | ------- |
| Input       | `xAlarm`        | `BOOL`     |         |
| Input       | `xHint`         | `BOOL`     |         |
| Input       | `xAuto`         | `BOOL`     |         |
| Input       | `sVersion`      | `STRING`   |         |
| Input Const | `sEditLine2`    | `STRING`   | ‘’      |
| Input Const | `sEditLine1`    | `STRING`   | ‘Line1’ |
| Output      | `itfMacroInfo`  | IMacroInfo | THIS^   |
| Output      | `sTitle`        | `STRING`   |         |
| Output      | `sLine1`        | `STRING`   |         |
| Output      | `sLine2`        | `STRING`   |         |
| Output      | `sInstanceName` | `STRING`   |         |
| Output      | `sInstancePath` | `STRING`   |         |

Properties:

> MacroData

Structure:

* MacroData (Property)


---

# 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/general/macroinfo.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.
