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-07-14 04:46:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document entry_type (#495)

Browse Source
This commit is contained in:
Paulus Schoutsen 2020-05-05 02:41:29 -07:00 committed by GitHub
parent bd39ded944
commit 39792dc8b3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
docs/device_registry_index.md
View File

@ -25,17 +25,18 @@ Although not currently available, we could consider offering an option to users
## Device properties ## Device properties
| Attribute | Description | | Attribute | Description |
| --------- | ----------- | | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id | Unique ID of device (generated by Home Assistant) | id | Unique ID of device (generated by Home Assistant) |
| name | Name of this device | name | Name of this device |
| 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. |
| identifiers | Set of identifiers. They identify the device in the outside world. An example is a serial number. | identifiers | Set of identifiers. They identify the device in the outside world. An example is a serial number. |
| manufacturer | The manufacturer of the device. | manufacturer | The manufacturer of the device. |
| model | The model of the device. | model | The model of the device. |
| config_entries | Config entries that are linked to this device. | config_entries | Config entries that are linked to this device. |
| sw_version | The firmware version of the 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. | 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. | area_id | The Area which the device is placed in. |
| entry_type | The type of entry. Possible value is `None` and `"service"`. |
## Defining devices ## Defining devices