Module `homey.pair_session`

Classes

class PairSession

A pairing session, prompting users for information to add new devices.

This class must not be initialized by the developer, but is passed to Driver.on_pair().

async def done(self) ‑> None

Close the pairing session.

async def emit(self, event: str, data: Any | None = None) ‑> None

Emits an event with the given name, along with any data, to the pairing view.

async def show_view(self, id: str) ‑> None

Show the view with the given id in the pairing flow, as defined in app.json.

async def next_view(self) ‑> None

Go to the next pairing step.

async def prev_view(self) ‑> None

Go to the previous pairing step.

def set_handler(self, event: str, listener: Callable[..., Coroutine[Any, Any, Any]]) ‑> Self

Register a listener for events of the given name emitted by the pairing view. Any data returned will be sent back to the view.

listener: An async listener that receives any data that is passed along with the event.

This pairing session, for chained calls.