Get NeonPlan 3D status
neonplan_get_statusCheck whether NeonPlan 3D is installed and loaded, report version, license, packs, plans, and open screens, and verify no editor is open before saving or running other NeonPlan tools.
Instructions
Report whether NeonPlan 3D is installed and loaded, its version, license, packs, plans and open screens.
Reads the neonplan3d config entry, then neonplan3d/building/get
(version), license/get (only whether a license is active), packs/list,
plans/list and screens/list (panels and cards open right now — an open
editor with unsaved changes would overwrite a save made through nexus).
A section the integration refuses holds {"error", ...}. Changes nothing.
Use when: before any other neonplan_* tool, or checking that no editor
is open before neonplan_save_plan or neonplan_patch_plan.
Not for: the plan itself — use neonplan_get_plan; HACS updates — use
hacs_get_hacs_repository.
Returns: {"installed", "loaded", "config_entry", "version", "version_warning", "license": {active, error}, "packs": [...], "plans": [...], "screens": [...], "screens_open"}.
Errors: neonplan_not_installed (with config_entry when an entry
exists but is not loaded), ha_unreachable.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "neonplan_get_status"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||