Skip to content

EntityMetadata

Part of Entities in the Python API reference.

Related guidance: concepts/entities, quickstarts/sensor-publisher, how-to/pli-entities, how-to/tracks-detections.

Runnable examples: publish_entity.py, watch_detections.py, watch_tracks.py.

from picogrid_ecn_client import EntityMetadata

Carry optional display hints and explicit JSON-valued extension data.

EntityMetadata(
*,
display: DisplayMetadata | None = None,
properties: dict[str, JsonValue] = dict(),
)

Source · models/entity.py

NameTypeRequiredDefaultConstraintsDescription
displayDisplayMetadata | NonenoNoneOptional reader-facing display hints for this entity.
propertiesdict[str, JsonValue]nodict()JSON-valued domain metadata; defaults to an empty mapping.

Version 0.2.0 · branch main