Skip to content

Symbols

Browse and search the PLC symbol tree. Requires feature flag Symbols enabled.

Browse Root Symbols

GET /api/plcs/{plcId}/symbols

Policy: ReadAccess

curl http://localhost:5000/api/plcs/Line1/symbols

Returns top-level symbols with their children (recursive tree).

Get Symbol Info

GET /api/plcs/{plcId}/symbols/{symbolPath}

Policy: ReadAccess

curl http://localhost:5000/api/plcs/Line1/symbols/MAIN.stMotor
{
  "data": {
    "instancePath": "MAIN.stMotor",
    "typeName": "ST_Motor",
    "size": 16,
    "comment": "Main drive motor",
    "children": [
      { "instancePath": "MAIN.stMotor.bEnabled", "typeName": "BOOL", "size": 1, "comment": "", "children": null },
      { "instancePath": "MAIN.stMotor.nSpeed", "typeName": "INT", "size": 2, "comment": "", "children": null }
    ]
  },
  "error": null
}

Search Symbols

GET /api/plcs/{plcId}/symbols?search=Motor&flat=true

Policy: ReadAccess

ParameterDescription
searchSubstring filter (case-insensitive)
flattrue returns flat list without children, false (default) includes children