Upload NeonPlan 3D background image
neonplan_upload_background_imageUploads a PNG, JPEG or WebP image as a shared NeonPlan 3D background so you can trace a scanned floor plan in the editor. Returns an image_id to reference in a floor's background right away.
Instructions
Store a png, jpeg or webp image as a NeonPlan 3D background (floor tracing) image and return its image_id.
Reads the file (or decodes the base64), checks the real content type
and the 8 MiB data URL limit, refuses an existing image_id unless
overwrite (image/get), and sends neonplan3d/image/set (admin).
Images are shared by all plans. WARNING: the integration deletes images
no plan references at its next start, so reference it right away in a
floor's background ({"image_id", "x", "z", "width", "opacity", "rotation"}) with neonplan_patch_plan.
Use when: tracing a scanned floor plan in the NeonPlan editor.
Not for: Lovelace or card images — use card_builder_upload_media.
Returns: {"uploaded": true, "image_id", "type", "bytes", "data_url_chars", "replaced", "warning"}.
Errors: invalid_image_id, invalid_source, invalid_path,
path_not_allowed, file_not_found, unsupported_image,
image_too_large, invalid_base64 (all without I/O to HA),
image_exists, neonplan_version_unsupported, admin_required,
neonplan_not_installed, ha_unreachable.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"image_id": "<image_id>"
},
"name": "neonplan_upload_background_image"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | No | png/jpeg/webp file under /config (or /media when mounted), e.g. `/config/www/plan.png`. | |
| force | No | True writes even when the integration is not version 3.0.x (format checked by you). | |
| image_id | Yes | Id to store the image under, e.g. `ground_floor_scan` (A-Z a-z 0-9 _ - ., 1-64). | |
| overwrite | No | True replaces an image already stored under image_id. | |
| data_base64 | No | The image as base64 (a `data:image/...;base64,` prefix is accepted) instead of path. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||