> 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="/files/e8dadec845f18a27407193a057585f5ae42adf2e" alt=""><figcaption></figcaption></figure>

### Interfaces

#### Inputs

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

#### 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 |

### Function description

#### General

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

#### 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 is **sEditLine1** displayed.

#### Output *sLine2*

The output *sLine2* the content of the setpoint / parameter is **sEditLine2** 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 dynamically by asking a question.

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

```
GET https://support.powerio.com/hub/codesys-hvac/en/hvac-library/functionblocks/general/macroinfo.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.