Set a scanned plan
set_backgroundPlace a scanned floor plan as a background at real-world scale, calibrate dimensions, adjust angle and opacity, or clear it to start fresh.
Instructions
Set a scanned plan as background at real scale: path, then cm_per_px (+cm_per_px_y), calibrate {a,b px, cm} or calibrations [{a,b,cm}…] (fits X/Y scales), angle (clockwise °); offset/opacity/visible; clear=true removes.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | No | Image file (png/jpg/webp/bmp). Required when there is no background yet | |
| angle | No | Clockwise turn of the image, degrees | |
| clear | No | Remove the background | |
| offset | No | Plan position cm of the image's top-left corner | |
| opacity | No | How opaque the image is drawn, 0..1 | |
| visible | No | Show or hide the image without removing it | |
| calibrate | No | Or scale by marking two pixels with a known real distance | |
| cm_per_px | No | Scale directly, cm per image pixel | |
| cm_per_px_y | No | Vertical scale cm/px when it differs from the horizontal one | |
| calibrations | No | Several known distances (e.g. one across, one down): fits separate horizontal and vertical scales when they differ, uniform otherwise |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| v | No | Plan version written to, when there are several | |
| ok | Yes | Always true | |
| ids | No | Ids created or touched | |
| rev | No | Plan revision | |
| text | Yes | The reply as written |