The person integration in Home Assistant allows you to track the location of people in your household. It is a collection of device trackers that are grouped together to represent the current location of a person. Additionally, a person may have a user account attached to it, which allows the person to log in to the Home Assistant.
Spook adds some new actions to the person integration, that allows you to dynamically change the device trackers attached to a person in Home Assistant.
Figure 1:Spook adds some new actions to the person integration.
Devices & entities¶
Spook does not provide any new devices or entities for this integration.
Actions¶
Spook adds the following new actions to your Home Assistant instance:
Add a device tracker¶
Adds a device tracker to a person.
Action properties | |
|---|---|
Person: Add a device tracker 👻 | |
| |
No | |
No response | |
Newly added action | |
Action data parameters | |||
|---|---|---|---|
Attribute | Type | Required | Default / Example |
| Yes |
| |
| Yes |
|
1 2 3 4action: person.add_device_tracker data: entity_id: person.frenck device_tracker: device_tracker.iphone
To add multiple device trackers at once, use a list:
1 2 3 4 5 6action: person.add_device_tracker data: entity_id: person.frenck device_tracker: - device_tracker.iphone - device_tracker.ipad
Remove a device tracker¶
Removes a device tracker from a person.
Action properties | |
|---|---|
Person: Remove a device tracker 👻 | |
| |
No | |
No response | |
Newly added action | |
Action data parameters | |||
|---|---|---|---|
Attribute | Type | Required | Default / Example |
| Yes |
| |
| Yes |
|
1 2 3 4action: person.remove_device_tracker data: entity_id: person.frenck device_tracker: device_tracker.iphone
To remove multiple device trackers at once, use a list:
1 2 3 4 5 6action: person.remove_device_tracker data: entity_id: person.frenck device_tracker: - device_tracker.iphone - device_tracker.ipad
Repairs¶
While Spook is floating around in your Home Assistant instance, it will raise repairs issues if it has found something that is not right.
Unknown device trackers¶
A person is a collection of device trackers, and the person’s location is whatever those trackers say it is. Spook inspects every person to find trackers that no longer exist. If Spook finds such a case, it will raise a repair issue, naming the person and the trackers that are missing.
This usually happens when a tracker was renamed, or when the integration providing it was removed. Nothing announces it: the person keeps working on the trackers that remain, so somebody whose phone tracker quietly disappeared just becomes a little less accurately located.
The raised issue is fixable. Spook can remove the missing trackers from the person for you, or you can fix it yourself on the People page. A person set up in YAML cannot be edited by Spook, so for those the issue points you at your configuration instead.
Use cases¶
Some use cases for the enhancements Spook provides for this integration:
Adding/removing temporary device trackers that represent a location of a person. For example, if you have a tracker in a car, you could temporary attach it to a person if you know that person took that car.
Blueprints & tutorials¶
There are currently no known blueprints or tutorials for the enhancements Spook provides for this integration. If you created one or stumbled upon one, please let us know in our discussion forums.
Feature requests, ideas, and support¶
If you have an idea on how to further enhance this integration, for example, by adding a new action, entity, or repairs detection; feel free to let us know in our discussion forums.
Are you stuck using these new features? Or maybe you’ve run into a bug? Please check the Support page on where to go for help.