Services¶

The Area Occupancy Detection integration provides services that can be called from automations or scripts.

area_occupancy.run_analysis¶

Runs the historical analysis process for an Area Occupancy instance. This imports recent state data from the recorder, updates priors and likelihoods, and refreshes the coordinator.

Example:

service: area_occupancy.run_analysis
data:
  entry_id: your_config_entry_id_here

Returns: - area_name: Name of the area - current_prior: Current global prior probability - global_prior: Global prior after analysis - time_prior: Time-based prior used in calculations - prior_entity_ids: List of entities included in analysis - total_entities: Total number of entities - entity_states: Current states of all entities - likelihoods: Updated likelihood data per entity - update_timestamp: ISO timestamp of when the analysis completed

area_occupancy.reset_entities¶

Resets all entity probabilities and learned data for a specific Area Occupancy instance.

Example:

service: area_occupancy.reset_entities
data:
  entry_id: your_config_entry_id_here

area_occupancy.get_entity_metrics¶

Returns basic metrics about entities in the Area Occupancy instance. This service returns data and can be used for monitoring and diagnostics.

Example:

service: area_occupancy.get_entity_metrics
data:
  entry_id: your_config_entry_id_here

Returns: - total_entities: Total number of entities - active_entities: Number of entities currently providing evidence - available_entities: Number of available entities - unavailable_entities: Number of unavailable entities - decaying_entities: Number of entities currently in decay state - availability_percentage: Percentage of entities available - activity_percentage: Percentage of entities active - summary: Human readable summary of metrics

area_occupancy.get_problematic_entities¶

Identifies entities that may need attention, such as unavailable entities or those with stale updates. This service returns data for troubleshooting purposes.

Example:

service: area_occupancy.get_problematic_entities
data:
  entry_id: your_config_entry_id_here

Returns: - unavailable: List of entity IDs that are currently unavailable - stale_updates: List of entity IDs that haven't been updated in over an hour - total_problems: Count of unavailable and stale entities - summary: Human readable summary of issues

area_occupancy.get_area_status¶

Returns the current occupancy status and confidence level for the area, along with entity metrics for context.

Example:

service: area_occupancy.get_area_status
data:
  entry_id: your_config_entry_id_here

Returns: - area_name: Name of the area - occupied: Boolean indicating if area is currently occupied - occupancy_probability: Current probability of occupancy (0.0-1.0) - area_baseline_prior: The baseline prior probability - confidence_level: Text description of confidence - confidence_description: Detailed description of confidence level - entity_summary: Counts of total, active, available, unavailable and decaying entities - status_summary: Human readable summary of the area state

Notes: - All services except reset_entities return response data that can be used in automations or scripts. - Services that query historical data (run_analysis) can be resource-intensive. - The entry_id can be found in Home Assistant under Settings → Devices & Services → Area Occupancy Detection → (click on an instance).