Entity

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 Entity

Represent a timestamped entity and its current public attributes.

Entity(
    *,
    id: UUID,
    category: EntityCategory,
    integration: str,
    recorded_at: datetime,
    type: str,
    fingerprint: str | None = None,
    name: str | None = None,
    status: EntityStatus = EntityStatus.UNKNOWN,
    affiliation: Affiliation = Affiliation.UNKNOWN,
    parent_id: UUID | None = None,
    metadata: EntityMetadata = EntityMetadata(),
    position: Location | None = None,
)

Source · models/entity.py

Fields

Name	Type	Required	Default	Constraints	Description
id	UUID	yes	—	—	Canonical UUID identifying the entity.
category	EntityCategory	yes	—	—	Domain category of the entity.
integration	str	yes	—	min_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.
recorded_at	datetime	yes	—	—	Timezone-aware time when the entity state was recorded.
type	str	yes	—	min_length=1, max_length=128	Source-defined entity type, from 1 through 128 characters.
fingerprint	str | None	no	None	min_length=1, max_length=256	Optional source-specific fingerprint, from 1 through 256 characters.
name	str | None	no	None	min_length=1, max_length=256	Optional reader-facing entity name, from 1 through 256 characters.
status	EntityStatus	no	EntityStatus.UNKNOWN	—	Activity state; defaults to UNKNOWN when unspecified.
affiliation	Affiliation	no	Affiliation.UNKNOWN	—	Reported affiliation; defaults to UNKNOWN when unspecified.
parent_id	UUID | None	no	None	—	Optional UUID of the entity that contains or owns this entity.
metadata	EntityMetadata	no	EntityMetadata()	—	Display and JSON-valued extension metadata; defaults to empty metadata.
position	Location | None	no	None	—	Optional embedded Position Location Information for the entity.

identity

Return the entity’s stable ID, integration, and optional fingerprint.

identity: EntityIdentity

Source · models/entity.py