Skip to content

UUID identity

Every public entity identity is a canonical hyphenated UUID. The same UUID follows an entity across JSON and protobuf messages, embedded or dedicated locations, Position Location Information (PLI), and exact task topics.

Generate an identity once for a durable sensor, effector, or platform and persist it in the integration’s own configuration. Do not derive a UUID from a display name or reuse one for a different real-world object.

from uuid import UUID
entity_id = UUID("00000000-0000-4000-8000-000000000001")

JSON entity and location topics include the UUID. Protobuf entity identity is payload-carried. Protobuf location identity is carried only by EntityLocationMessage.entity_id on the two-segment entity_location_pb/{integration} topic.

Version 0.2.0 · branch main