developers.home-assistant/blog/20240924-device-tracker-entity-description.md
epenet c5a1a8034e
Document device tracker shorthand attributes and EntityDescription changes (#2333)
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
2024-09-25 08:31:37 +02:00

1.1 KiB

author, authorURL, title
author authorURL title
epenet https://github.com/epenet 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)