Skip to content

EntityIdentity

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 EntityIdentity

Identify an entity independently of its mutable state.

EntityIdentity(*, id: UUID, integration: str, fingerprint: str | None = None)

Source · models/entity.py

NameTypeRequiredDefaultConstraintsDescription
idUUIDyesCanonical UUID identifying the entity.
integrationstryesmin_length=2, max_length=128, pattern='^[A-Za-z0-9][A-Za-z0-9_-]{0,126}[A-Za-z0-9]$'Validated integration name that reports the entity.
fingerprintstr | NonenoNonemin_length=1, max_length=256Optional source-specific fingerprint, from 1 through 256 characters.

Version 0.2.0 · branch main