update_device
Modify an existing device's properties such as location, type, material, or threshold, while preserving its device identifier.
Instructions
Update an existing device (target or detector).
Selects the device by device_id and changes only the parameters you provide; any left as None is unchanged. The device's id is the selector and is not changed here.
Parameters
model_id : str Id of the model to modify. device_id : str Id of the device to update. comp_id : str or None, optional Compartment in which the device is located. None leaves it unchanged. location : list[float] or None, optional Position [x, y, z] from the left wall, front wall and floor. Default units: m. None leaves it unchanged. type : str or None, optional One of PLATE, CYLINDER, HEAT_DETECTOR, SMOKE_DETECTOR, SPRINKLER. None leaves it unchanged. material_id : str or None, optional What the target is made of; must already exist. None leaves it unchanged. surface_orientation : str or None, optional Predefined surface orientation for targets. None leaves it unchanged. normal : list[float] or None, optional Unit vector [nx, ny, nz] perpendicular to the target surface. None leaves it unchanged. thickness : float or None, optional Thickness of the target material. Default units: m. None leaves it unchanged. temperature_depth : float or None, optional Depth at which the internal target temperature is reported (meters when depth_units="M", else a fraction in [0, 1]). None leaves it unchanged. depth_units : str or None, optional Units for temperature_depth: "M" for meters. None leaves it unchanged. setpoint : float or None, optional Activation temperature for HEAT_DETECTOR and SPRINKLER. Default units: °C. None leaves it unchanged. rti : float or None, optional Response Time Index. Default units: (m·s)^(1/2). None leaves it unchanged. obscuration : float or None, optional Obscuration at or above which a SMOKE_DETECTOR activates. Default units: %/m. None leaves it unchanged. spray_density : float or None, optional Amount of water dispersed by a sprinkler. Default units: m/s. None leaves it unchanged.
Returns
str Confirmation, the updated model summary, and any warnings.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| rti | No | ||
| type | No | ||
| normal | No | ||
| comp_id | No | ||
| location | No | ||
| model_id | Yes | ||
| setpoint | No | ||
| device_id | Yes | ||
| thickness | No | ||
| depth_units | No | ||
| material_id | No | ||
| obscuration | No | ||
| spray_density | No | ||
| temperature_depth | No | ||
| surface_orientation | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |