From ebe4d3927e167841901480a9a37fa308d77ea877 Mon Sep 17 00:00:00 2001 From: Erik Montnemery Date: Tue, 19 Oct 2021 11:49:20 +0200 Subject: [PATCH] Document device registry configuration_url (#1097) Co-authored-by: Martin Hjelmare --- docs/device_registry_index.md | 32 ++++++++++++++++++-------------- 1 file changed, 18 insertions(+), 14 deletions(-) diff --git a/docs/device_registry_index.md b/docs/device_registry_index.md index a5b4847b..bf3dbded 100644 --- a/docs/device_registry_index.md +++ b/docs/device_registry_index.md @@ -23,20 +23,24 @@ Although not currently available, we could consider offering an option to users ## Device properties -| Attribute | Description | -| -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| id | Unique ID of device (generated by Home Assistant) | -| name | Name of this device | -| connections | A set of tuples of `(connection_type, connection identifier)`. Connection types are defined in the device registry module. | -| identifiers | Set of `(DOMAIN, identifier)` tuples. Identifiers identify the device in the outside world. An example is a serial number. | -| manufacturer | The manufacturer of the device. | -| model | The model of the device. | -| suggested_area | The suggested name for the area where the device is located. | -| config_entries | Config entries that are linked to this device. | -| sw_version | The firmware version of the device. | -| via_device | Identifier of a device that routes messages between this device and Home Assistant. Examples of such devices are hubs, or parent devices of a sub-device. This is used to show device topology in Home Assistant. | -| area_id | The Area which the device is placed in. | -| entry_type | The type of entry. Possible value is `None` and `"service"`. | +| Attribute | Description | +| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | +| area_id | The Area which the device is placed in. | +| config_entries | Config entries that are linked to this device. | +| configuration_url | A URL on which the device or service can be configured. | +| connections | A set of tuples of `(connection_type, connection identifier)`. Connection types are defined in the device registry module. | +| default_name | Default name of this device, will be overridden if `name` is set. Useful for example for an integration showing all devices on the network. | +| default_manufacturer | The manufacturer of the device, will be overridden if `manufacturer` is set. Useful for example for an integration showing all devices on the network. | +| default_model | The model of the device, will be overridden if `model` is set. Useful for example for an integration showing all devices on the network. | +| entry_type | The type of entry. Possible value is `None` and `"service"`. | +| id | Unique ID of device (generated by Home Assistant) | +| identifiers | Set of `(DOMAIN, identifier)` tuples. Identifiers identify the device in the outside world. An example is a serial number. | +| name | Name of this device | +| manufacturer | The manufacturer of the device. | +| model | The model of the device. | +| suggested_area | The suggested name for the area where the device is located. | +| sw_version | The firmware version of the device. | +| via_device | Identifier of a device that routes messages between this device and Home Assistant. Examples of such devices are hubs, or parent devices of a sub-device. This is used to show device topology in Home Assistant. | ## Defining devices