---
alias: user-guide-automation-task-core-getequipmentproperties
tags:
- automation tasks
description: "This task retrieves equipment properties via a driver, triggering a value request"
---

# Get Equipment Properties

:iot-get-equipment-property-value-lg:{style="font-size: 100px"}

This task is used to ask the equipment for a specific property, therefore it's associated to a particular driver.

![Get Equipment Properties task parameters](../images/get_equipment_properties_parameters.png)

## Details

| Fields            | Details                                                                            |
| ----------------- | ---------------------------------------------------------------------------------- |
| Scope             | Connect IoT |
| Workflow          | Data flow <br> Control flow                                                        |
| `IsProtocol` flag | :material-check:{style="color:#4DB6AC"}                                       |

## Inputs

| Name     | Data Type | IsTrigger  | Description        |
| -------- | --------- | ---------- | ------------------ |
| Activate | `any`     | Yes        | Requests the equipment for the configured properties values. |

## Outputs

| Name    |   Data Type   | Description |
| ------  |  ---------|   --------- |
| `<custom list>` | \`<custom>`|  Output properties|
|  Success  |`Boolean`|  If there was no problem emits a true |
|  Error    |`Error`  |      Error that occurred during the processing of this task |

## Settings

On the `General Tab`, you have the usual settings and the following settings:

| Name    |   Data Type   | Description |
| ------  |  ---------|   --------- |
| Driver  | `String` |  Chosen Driver |

![Get Equipment Properties task settings](../images/get_equipment_properties_settings.png)

!!! note "Extended Data"
    This task shows extended data in the `Outputs` tab. The extended data shown depends on the driver in use.

On the `Outputs Tab`, you have the following settings:

| Name    | Data Type | Values | Default   | Description       |
| ------  |  ---------|   --------- | ---------  | ---------  |
| Equipment Property | `EquipmentProperty` |  | \<empty\> | A driver definition property.    |
| Output Type        | `enum`       | `Value`<br />`RawValue` | `Value`   | The output type of the property. |

![Get Equipment Properties task settings](../images/get_equipment_properties_outputs.png)

## Behavior

In this task you choose a driver when dropping it into the workflow (if you have more than one driver associated with the controller). When sending a value to the input `activate`, the task will activate and request the equipment for the values of the properties configured.

## Remarks

All the communication with the equipment is handled by the driver in the backend.