From e02db33c47390561d9650fee8ccd0ea60c53481e Mon Sep 17 00:00:00 2001 From: Erik Montnemery Date: Sun, 22 Oct 2023 15:15:21 +0200 Subject: [PATCH] Document device registry entry serial_number (#1477) --- docs/device_registry_index.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/device_registry_index.md b/docs/device_registry_index.md index 048e1693..e1d46fd6 100644 --- a/docs/device_registry_index.md +++ b/docs/device_registry_index.md @@ -28,18 +28,19 @@ Although not currently available, we could consider offering an option to users | 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, linking to paths inside the Home Assistant UI can be done by using `homeassistant://`. | -| connections | A set of tuples of `(connection_type, connection identifier)`. Connection types are defined in the device registry module. | +| connections | A set of tuples of `(connection_type, connection identifier)`. Connection types are defined in the device registry module. Each item in the set uniquely defines a device entry, meaning another device can't have the same connection. | | 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. | | 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. | | entry_type | The type of entry. Possible values are `None` and `DeviceEntryType` enum members (only `service`). | | hw_version | The hardware version of the device. | | 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. | +| identifiers | Set of `(DOMAIN, identifier)` tuples. Identifiers identify the device in the outside world. An example is a serial number. Each item in the set uniquely defines a device entry, meaning another device can't have the same identifier. | | name | Name of this device | | name_by_user | The user configured name of the device. | | manufacturer | The manufacturer of the device. | | model | The model of the device. | +| serial_number | The serial number of the device. Unlike a serial number in the `identifiers` set, this does not need to be unique. | | 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. |