jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-06-18 08:06:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document device registry entry serial_number (#1477)

Browse Source
This commit is contained in:
Erik Montnemery 2023-10-22 15:15:21 +02:00 committed by GitHub
parent 149d362e12
commit e02db33c47
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/device_registry_index.md
View File

@ -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://<path>`. |
| 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. |