Person

The person integration allows connecting device tracker entities to one or more person entities. The state updates of a connected device tracker will set the state of the person. When multiple device trackers are used, the state of person will be determined in this order:

1. If there are stationary trackers (non-GPS trackers, e.g., a router or Bluetooth device tracker) presenting the state home, the tracker most recently updated will be used.
2. If there are trackers of type gps, then the most recently updated tracker will be used.
3. Otherwise, the latest tracker with state not_home will be used.

Let’s say, for example, that you have three trackers: tracker_gps, tracker_router and tracker_ble.

1. You’re at home, all three devices show state home - the state of your Person entity will be home with source tracker_router or tracker_ble, whichever was most recently updated.
2. You just left home. tracker_gps shows state not_home, but the other two trackers show state home (they may not have yet updated due to their consider_home setting see device_tracker). Since the stationary trackers have priority, you are considered home.
3. After some time, both stationary trackers show state not_home. Now your Person entity has state not_home with source tracker_gps.
4. While you are away from home, your Home Assistant instance is restarted. Until the tracker_gps receives an update, your status will be determined by the stationary trackers, since they will have the most recent update after a restart. Obviously, the state will be not_home.
5. Then you’re going into a zone you have defined as zone1, tracker_gps sends an update, and now your state is zone1 with source tracker_gps.
6. You’ve returned home and your mobile device has connected to the router, but tracker_gps hasn’t updated yet. Your state will be home with source tracker_router.
7. After the tracker_gps update occurs, your state will still be home with source tracker_router or tracker_ble, whichever has the most recent update.

In short, when you’re at home, your position is determined first by stationary trackers (if any) and then by GPS. When you’re outside your home, your position is determined firstly by GPS and then by stationary trackers.

Hint: When you use multiple device trackers together, especially stationary and GPS trackers, it’s advisable to set consider_home for stationary trackers as low as possible see device_tracker).

You can manage persons via the UI from the person page inside the configuration panel or via YAML in your configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file.

Adding a person to Home Assistant

If you have administrator rights, you can add other persons to Home Assistant and create them a user account. Depending on the rights you give them, they can then use Home Assistant on their own devices, can have their own dashboards, and be used in automations.

1. Go to Settings > People and select Add person.
2. Enter their Name.
3. Add an image if you like.
4. Under Allow login, select if they should be able to log in.
   • If they cannot log in, they do not get a user account, and they cannot do much with Home Assistant.
   • They cannot have their own dashboard, for example.
   • But they can still be used for device tracking and show up on a map and be used in automations.
5. If they are able to log in, fill in the user information.
   • Check if the username is correct. A suggestion is made based on the person name. But they do not have to be identical.
     • The username must be lowercase and contain no spaces.
     • The username is required to log in.
     • The person name is the name displayed in the UI.
   • Enter a password and store it in a safe location.
   • Define if they should have Local access only.
     • If this is enabled, they won’t have access to Home Assistant when they are outside your network, for example from their phone.
   • Define if they should have Administrator rights.
   • Select Create.
6. If you have already set up devices for presence detection, select the devices that belong to this person.

Customizing the picture for a person

You can easily upload a picture in the frontend. Simply click on a person, select or drop an image in the input field, and then crop it.

See the documentation about hosting files for more information about the www folder.

Configuring the person integration via the Home Assistant configuration panel

This integration is by default enabled, unless you’ve disabled or removed the default_config: line from your configuration. If that is the case, the following example shows you how to enable this integration manually:

person:

Configuring the person integration via YAML

If you prefer YAML, you can also configure your persons via the configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file:

# Example configuration.yaml entry
person:
  - name: Ada
    id: ada6789
    device_trackers:
      - device_tracker.ada

An extended example would look like the following sample:

# Example configuration.yaml entry
person:
  - name: Ada
    id: ada6789
    device_trackers:
      - device_tracker.ada
  - name: Stacey
    id: stacey12345
    user_id: 12345678912345678912345678912345
    device_trackers:
      - device_tracker.stacey
      - device_tracker.beacon

If you change the YAML, you can reload it by calling the person.reload action.