Skip to content

Connector screens

This page names every control on the connector screens. For the concepts (kinds, lifecycle, direction), see Connectors; for what each connector connects to, see the Connector catalog.

:::caution[Screenshot pending refresh] connector-manager.png predates the LiDAR catalog card — a fresh capture is queued (see public/screenshots/README.md). :::

The Connector Manager — catalog cards and the instances table

ControlWhat it is
All / Hardware (OT) / Cloud / IT filterNarrows the catalog by connector kind.
Search connectors…Filters the catalog by name.
Catalog cardsOne per connector type — icon, name, an OT/IT badge, a one-line description, an active / total instance count, and configure → to open the type’s page.
Instances tableEvery configured instance across all types.
ColumnWhat it shows
NameThe instance id.
TypeThe connector type, with its icon.
StatusA live status pill (Connected, Stopped, Error, …).
LatencyRound-trip time for the last exchange (where applicable).
EnabledA toggle that starts/stops the instance.
ConfigureOpens the instance in its type’s page.

Opening a type (e.g. Modbus) shows a header with its name, a one-line description, and a ← Connector Manager back-link, then two tabs: Instances and Bench Tools.

ControlWhat it is
+ NewCreates a new instance of this connector type.
ID / Enabled / Status / Connected columnsThe instances and their live state.
Enable connector (▷)Starts the instance (turns enabled on).
Edit configuration (✎)Opens the form editor (below).
Edit config JSON (<>)Edit the raw configuration directly.
Delete connector (🗑)Removes the instance.

Editing an instance opens a form split into Master (connection), Mapping (the tags), and a live Diagnostics panel, with Cancel / Save at the top. The fields below are the Modbus example; other connector types have an analogous, tailored set.

Editing a Modbus instance — master, mapping and diagnostics

Master (connection & polling):

FieldWhat it is
Instance IDThe id/slug for this instance (letters, digits, _, -).
NameA human-friendly label shown in the IDE.
TransportHow to reach the device (e.g. TCP, RTU).
Tags’ base pathThe folder the connector creates its tags under.
Host / PortThe device address (TCP).
Unit IDThe Modbus slave/unit address.
Cycle time (ms)How often the connector polls/exchanges.
Op timeout (ms)How long to wait for a single operation before failing it.
Force-reconnect after N failuresDrop and re-open the connection after this many consecutive failures.

Mapping (one row per value):

ColumnWhat it is
NameThe tag’s name.
Sub-pathAn optional extra folder under the base path.
SpaceThe register/area (e.g. Holding Registers).
AddrThe numeric address.
DirDirection — in (device→tag) or out (tag→device). See Direction.
TypeThe data type (e.g. u16).
copy / delete (row icons)Duplicate or remove a mapping row.
Filter registersFilters the mapping list.
+ Add registerAdds a mapping row.

Diagnostics panel (read-only, live): the instance’s Status, Connected, request/response latency, and cycle I/O timing — sourced from __sys/node/service/connectors/<type>/<id>/stats/*.

A per-connector-type workbench for direct device access during bring-up and diagnostics, independent of any configured instance. It connects on its own using the Host / Port / Unit ID fields at the top, then offers (for Modbus):

ToolWhat it does
Probe deviceA read-only scan that reports which addresses respond and which return errors — so you build your config from addresses that actually respond, not from a datasheet alone.
Detect byte orderHelps determine the device’s word/byte ordering.
ReadReads specific addresses on demand.
Write (marked destructive)Writes a value directly to the device — use with care; it changes the real device.
RunExecutes the selected tool.

Bench Tools is the fastest way to sanity-check wiring and addressing before you commit a mapping.