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-23 18:46:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document device tracker shorthand attributes and EntityDescription changes (#2333)

Browse Source 
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
This commit is contained in:
epenet 2024-09-25 08:31:37 +02:00 committed by GitHub
parent 1d8e53c54a
commit c5a1a8034e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
blog/20240924-device-tracker-entity-description.md Normal file
View File

@ -0,0 +1,23 @@
---
author: epenet
authorURL: https://github.com/epenet
title: "Enforce SourceType and add shorthand attributes and EntityDescription to device_tracker"
---
The `source_type` property of device_tracker entities is now always expected to be a `SourceType` enum value. Standard strings are no longer valid.
`TrackerEntity` and `ScannerEntity` now have a dedicated `ScannerEntityDescription` and `TrackerEntityDescription`, which need to be used as base class when associating an `EntityDescription` to the `Entity`.
The `source_type` for these entities now also defaults to `SourceType.GPS` and `SourceType.ROUTER`, and it may be possible to drop the overriding property.
The following shorthand attributes have also been added:
- `BaseTrackerEntity._attr_source_type`
- `TrackerEntity._attr_latitude`
- `TrackerEntity._attr_location_accuracy`
- `TrackerEntity._attr_location_name`
- `TrackerEntity._attr_longitude`
- `TrackerEntity._attr_source_type` (defaults to `SourceType.GPS`)
- `ScannerEntity._attr_hostname`
- `ScannerEntity._attr_ip_address`
- `ScannerEntity._attr_mac_address`
- `ScannerEntity._attr_source_type` (defaults to `SourceType.ROUTER`)