Skip to content

publish_location

Part of Reusable workflows in the Python API reference.

Related guidance: shipped-tooling.

Runnable examples: publish_location.py.

from picogrid_ecn_client.workflows import publish_location

Publish one typed public location for an entity identity.

async def publish_location(
client: ECNClient,
*,
entity_id: UUID,
location: Location,
) -> PublishLocationResult
NameTypeDefaultDescription
clientECNClientConfigured SDK client used for publication.
entity_idUUIDCanonical identity associated with the location.
locationLocationValidated public location to publish.
TypeDescription
PublishLocationResultThe entity identity, published location, and broker acknowledgement.
ExceptionDescription
ECNClientErrorIf validation, connection, or publication fails.

Source · workflows/publish.py

Version 0.2.0 · branch main