Apple simulator sessions¶
This page covers device ownership rules specific to Apple simulators. For the general rules, see Device ownership.
- Apple TV: see Apple TV simulators.
- Apple Vision Pro: see Apple Vision Pro simulator.
Name
platform: "visionos"or a Vision Pro session.installApp,uninstallApp,launchApp,terminateAppandlistAppswork;launchApprefusesprototype: true. With the runner active,observeincludes ornaments, andtapOntaps an element by a unique accessibility identifier. - Apple Watch: see Apple Watch simulators and the session rules below.
Apple Watch sessions¶
A call reaches a watch only by naming it: platform: "watchos", or the
sessionUuid of a watch session. A call without a platform never lands on a
watch, even after one was selected.
setActiveDeviceselects a watch only withplatform: "watchos"; a bare watchdeviceIdis not found. With asessionUuidit binds the watch to that session. Otherwise it makes the watch the connection’s active watch, which only calls namingplatform: "watchos"use.startDevicewithplatform: "watchos"boots the watch, starts its runner, then binds a session. If the session ends before runner startup completes, the call fails; retrystartDevice. A second start reuses a connected runner. Ending the owning session or stopping the daemon also stops the runner.launchAppon a watch returns the app’spidand refusesintent,activityName,userIdandprototype: true. An app that is not installed fails withApp is not installed.installApprefuses.ipa,.apkand the Android-only options by name.provisionDevicerefuses a near match, an unknown identifier, or adeviceIdthat names no watch. Withboot(the default) it returns asessionId. If booting a watch it created fails, it deletes the watch again.readinessis always"none".- Unsupported device tools refuse a watch with
<tool> does not support watchOS yet.
A session request (--session-config / AUTOMOBILE_SESSION_CONFIG) asks for a
watch with device: { "schemaVersion": 1, "platform": "watchos", "spec": {
"runtime": "...", "deviceType": "..." } }. Use the exact watchOS runtime and
Apple Watch device type identifiers, as for provisionDevice. A watch counts
against the same device limit as every other device.
| Result | When |
|---|---|
readiness: { "mode": "none", "status": "device_ready" } and profile |
Ready: the watch is booted, with no automation runner |
unsupported_hardware |
Unknown device type (names the available ones), or the host is not a Mac |
missing_installed_runtime |
Unknown or unavailable runtime; names the available ones |
catalog_unavailable (retryable) |
The simulator catalog is unreadable |
On release, the host’s iOS reuse mode decides what happens to the watch:
| Reuse mode | On release |
|---|---|
erase |
Erases and reboots it for the next request with the same runtime and device type |
keep-booted |
Erases it, or destroys it when its fallback is destroy |
minimal or none |
Deletes it |