update_wall_vent
Update an existing wall vent's parameters such as connection compartments, position, and dimensions. Specify only the fields to change; unchanged fields remain as before.
Instructions
Update an existing wall vent.
Selects the vent by vent_id and changes only the parameters you provide; any left as None is unchanged. The vent's id is the selector and is not changed here.
Parameters
model_id : str Id of the model to modify. vent_id : str Id of the wall vent to update. comp_a : str or None, optional First compartment id; the reference for all vent specifications. To change the connection, provide both comp_a and comp_b. None leaves the connection unchanged. comp_b : str or None, optional Second compartment id, or "OUTSIDE" for the exterior. To change the connection, provide both comp_a and comp_b. None leaves the connection unchanged. bottom : float or None, optional Position of the bottom of the opening relative to the floor of the first compartment. Default units: m. None leaves it unchanged. height : float or None, optional Height of the opening relative to the bottom of the opening. Default units: m. None leaves it unchanged. width : float or None, optional Width of the opening. Default units: m. None leaves it unchanged. face : str or None, optional The wall on which the vent is positioned: FRONT, REAR, LEFT or RIGHT. None leaves it unchanged. offset : float or None, optional For visualization only, the horizontal distance between the near edge of the vent and the origin of the axis defined by the selected face. Default units: m. None leaves it unchanged.
Returns
str Confirmation, the updated model summary, and any warnings.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| face | No | ||
| width | No | ||
| bottom | No | ||
| comp_a | No | ||
| comp_b | No | ||
| height | No | ||
| offset | No | ||
| vent_id | Yes | ||
| model_id | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |