Search Homey devices
homey_devices_searchSearch Homey devices by zone, class, capability, or name, with optional live values. Get device state summaries for questions like 'what is the state of the living room' in one call.
Instructions
Finds devices by zone, class, capability or name, and optionally returns their live values. Set includeCapabilitySummaries to answer a question like "what is the state of the living room" in one call. Every filter is combined with AND. Results are projected down to what is useful for reasoning: protocol settings, icons, images and interface layout are never returned. The Homey API cannot paginate, so paging happens here: use offset with limit and check truncated.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| zone | No | Zone name or id. Use homey_home_overview to see the zone tree. | |
| limit | No | Defaults to 50. | |
| offset | No | Devices to skip, for paging. Defaults to 0. | |
| available | No | Filter on whether Homey can currently reach the device. | |
| capability | No | Capability id the device must have, for example onoff or measure_temperature. Prefix match. | |
| deviceClass | No | Homey device class, for example light, socket, sensor, thermostat. Matches virtualClass too. | |
| nameContains | No | Case and accent insensitive substring of the device name. | |
| includeChildZones | No | Also match devices in zones below the named zone. Defaults to false. | |
| includeCapabilitySummaries | No | Fills capabilitySummaries on every device returned: the title, current value, unit and setable flag of each capability. Defaults to false. For the full record of one capability, with its type, decimals and allowed range, call homey_device_get instead. |