From 1e3b9e32a3dcaf1dbb6f3a8ace4f2c3cd0a5f44f Mon Sep 17 00:00:00 2001 From: mdeweerd Date: Fri, 27 Oct 2023 19:08:46 +0200 Subject: [PATCH] Update documentation for scan_device --- README.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 2a67683..9893752 100644 --- a/README.md +++ b/README.md @@ -1151,15 +1151,21 @@ intervals are provided, as well as the reportable change: ## `scan_device`: Scan a device/Read all attribute values -This operation will discover the device attributes and read their values. -Some values are excluded from reading, for instance Arrays as their length -depends on the specification. +`scan_device` will generated a report the discovered clusters, attributes, +values and commands if the device implements this feature. + +This can help you in discovering what you can configure on your device and +what the values are at some point in time. + +If the device does not fully support the discovery features, you could +still write a script that would try to read the attributes that you want to +poke using `attr_read`. The result of the scan is written to the `scan` directory located in the configuration directory of Home Assistant (`config/scan/*_result.txt`). -The result is also added to the event data in the event\['data'\]\['scan'\] -field +The result is also added to the event data in the `event['data']['scan']` +field which is also available in the response data. ```yaml service: zha_toolkit.scan_device