Eternet Portal Documentation

Widget Catalog

Catalog behavior

The catalog reads default dashboard definitions for devices, hubs, and vehicles, extracts card properties, normalizes widget schemas, and renders them through the shared widget renderer. This page is a presentation/catalog surface, not a complete dashboard layout editor.

Widget Dashboard route

The separate Widget Dashboard route loads schemas through the legacy-compatible /etr/GetFakeStreamData endpoint. The endpoint name explicitly indicates fake stream data; treat these records as preview/test data unless independently verified against a live source.

Live values

Live updates depend on a resource-matched stream, supported widget type, and valid incoming telemetry. A widget can render its schema even when no live value is available; rendering and data freshness are separate checks.

Widget schemas and rendering

A widget is the visual interpretation of a value or structured result. The portal extracts widget properties from default dashboard definitions for devices, hubs, and vehicles, then normalizes the schema into a shared model. This approach allows several entity types to reuse the same renderer while preserving their own source identity. A schema can define the kind of widget, labels, limits, units, colors, axes, map options, or table columns. The renderer uses those details to choose a supported presentation, but it cannot infer missing domain meaning. Customers should understand that a widget’s title is descriptive metadata and that the schema’s source reference determines where its value is expected to come from.

Different widget families have different data requirements. A gauge generally needs a numeric value and suitable minimum/maximum bounds; a line chart needs ordered observations and usually a timestamp; a map needs valid coordinates; a table needs structured rows and column definitions; and a status or label element may accept a scalar or text value. Incorrect types can produce blank or misleading visuals even if the widget card itself renders. When a widget appears empty, inspect the source entity, stream ID, payload value type, units, and schema rather than assuming the catalog is broken.

Catalog versus live monitoring

The Widgets catalog derives cards from API-provided dashboard definitions. It does not independently subscribe to every source simply because a card is visible. Live updates rely on the connected device/hub/vehicle data path and the portal’s resource matching. A card can therefore be present in the catalog while its source is offline, its value is stale, or its stream is not configured. The separate Widget Dashboard route calls /etr/GetFakeStreamData; the endpoint name means that those schemas or values should be treated as preview/test data unless the environment proves otherwise. A successful demo rendering from that endpoint is not evidence of production telemetry.

For an operational dashboard, verify end to end: retrieve the correct dashboard definition, match its source entity to a real resource, confirm the stream exists, deliver or retrieve a value, and compare what the renderer shows with the raw response. Include timestamp and unit checks. Avoid presenting an animation or changing number as proof of a live connection unless the underlying message path has been confirmed.

Customer value and deployment readiness

Reusable widgets make it easier to create consistent views across equipment and teams. They let an operator scan key signals quickly and open the source entity for details when further investigation is needed. Schema reuse also reduces the need to implement a separate visual component for each device category. For customer rollout, define a small set of supported widget schemas, document each data contract, and test empty, invalid, stale, and live values. Agree on alert thresholds and units outside the renderer where necessary. The portal provides the catalog and shared presentation layer; source ownership, telemetry generation, and persistence remain in the connected services.