get_ecn_location

Part of Reusable workflows in the Python API reference.

Related guidance: shipped-tooling.

Runnable examples: get_ecn_location.py.

from picogrid_ecn_client.workflows import get_ecn_location

Wait for the next terminal-geolocation MQTT event.

async def get_ecn_location(
    client: ECNClient,
    *,
    timeout: float | None = None,
) -> ECNLocationResult

Parameters

Name	Type	Default	Description
client	ECNClient	—	Configured SDK client used to observe terminal geolocation.
timeout	float | None	None	Optional maximum wait in seconds.

Returns

Type	Description
ECNLocationResult	The next observed terminal-geolocation event.

Raises

Exception	Description
ECNClientError	If the stream cannot be opened or consumed.
TimeoutError	If no event arrives before timeout.

Source · workflows/observe.py