Skip to content

Installation

HACS

Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.

  1. Ensure HACS is installed: If you don't have the Home Assistant Community Store (HACS) installed, follow their instructions to set it up first.
  2. Navigate to HACS: Open your Home Assistant frontend and go to HACS in the sidebar.
  3. Search for Area Occupancy Detection: Search for "Area Occupancy Detection" and select then Download.
  4. Restart Home Assistant: After the download is complete, restart your Home Assistant instance

Initial Setup

  1. Go to Settings > Devices & Services > Integrations > + Add Integration.
  2. Search for Area Occupancy Detection and select it.
  3. Configure Area Name:
  4. Select a Home Assistant area for this occupancy detection. The area name will be automatically used for the device and entities.
  5. You may need to create the area in Home Assistant first if it doesn't exist.
  6. Configure Area Purpose:
  7. Choose the purpose of the area. This sets a sensible default for the decay half-life used when probability decreases. The purpose selection affects how quickly the system "forgets" about occupancy after activity stops.
  8. Configure Sensors:
  9. Select the sensors that will be used to detect occupancy.
  10. You will need to select at least one motion/presence sensor for the integration to work.
  11. You can then add sensors of many different types to the area to improve the accuracy of the occupancy detection.

Configuration

When you first create the integration you will be taken straight to configuring the first area.

When adding new areas you will need to navigate to Integrations -> Area Occupancy Detection -> Configure (⚙️ Cog icon). This will bring up the configuration menu.

There is detailed documentation on the configuration options here: Configuration.

Before You Start

For an ideal setup you will need to perform these steps in Home Assistant before setting up the integration:

Almost every option in the config is optional, sensible defaults are available for eveything. The minimum configuration for an area is:

The integration will work with just these configured. Everything else can be added as you get new devices. However the more you add in, the more accurate the predictions will be.

The main menu allows you to modify global settings, add a new area, manage existing areas, or manage people for sleep presence detection.

Main Menu

Global Settings

The global settings menu allows you to modify the global settings for the integration, these are limited for now and will be expanded in the future.

Global Settings

Add New Area

The add new area menu allows you to add a new area to the integration.

Add New Area

The next steps asks you for the motion sensors you have in that area. just add any sensors you have, leave the rest as default for initial config.

Add Motion Sensors

You can then choose any other sensors you have in the area to contribute, again on first config, just add any sensors you have, leave the weights and states as default. Everything here is optional.

Add Other Sensors

Manage Areas

The manage areas menu allows you to manage existing areas, you can see a summary of each area and the sensors associated with it. You can then select one of the areas to edit or remove.

Manage Areas

Manage Area

Manage People

The manage people menu allows you to add and configure people associated with your home, they must be set up as people in Home Assistant first so they can be selected in the people picker. Choosing entities for sleep confidence and device tracking (from HA Companion app for example) allows AOD to track sleep for a given area. Choosing an area for a person essentially defines their bedroom.

Manage People

Manage Person

Getting Help

If you encounter issues:

  1. Search GitHub Issues
  2. Join the Discussion