Back to the catalog

Concepts

Bundle OKF 0.1 · 3 conceitos · polaralias/homeassistant-customzones

Open source Repository Open in the app JSON README (API)

About

<!-- Generated by repo-knowledge-engineering OKF index builder. -->

# Concepts

- [homeassistant-customzones complete Markdown inventory](documentation-inventory.md) - Classifies every in-scope tracked or pending Markdown file in the homeassistant-customzones repository by OKF or approved specialised schema.
- [homeassistant-customzones documentation map](documentation-map.md) - Indexes the RKE-governed knowledge concepts and execution truth for the homeassistant-customzones repository.
- [homeassistant-customzones repository OKF visualization](repository-visualization.md) - Defines the source, scope, outputs, interpretation, and verification contract for the repository-wide OKF visualization.

Details

Kind
OKF bundles
Topic
Files & documents
Publisher
polaralias
Origin
okf_github
Category
dados
Version
0.1
Open pull requests
1
Last push
2026-07-29T05:39:40Z
Repository state
ativo
Language
Python
License
Apache-2.0
Added
2026-09-08 16:05:40
Updated
2026-09-08 16:05:40
Origin id
polaralias/homeassistant-customzones:docs/knowledge/index.md

README

---
type: "Repository Guide"
title: "Custom Zone"
description: "Documents Custom Zone for the homeassistant-customzones repository."
timestamp: 2026-07-28T21:55:36Z
authority: canonical
verification: untested
owner: polaralias
tags:
  - homeassistant-customzones
  - repository-guide
navigation:
  role: entry-point
  order: 10
---
<p align="center">
  <img src="CustomZones%20Banner.png" alt="CustomZones banner" width="960" />
</p>

# Custom Zone

Custom Zone is a Home Assistant custom integration for polygon-based presence zones.

## What It Does

The integration lets you define a polygon in the Home Assistant UI, attach one or more `person` or `device_tracker` entities to it, and expose an aggregate sensor that reports how many tracked entities are currently inside the zone.

## Core Features

- polygon-based zone definition from the Home Assistant UI
- one or more tracked entities per zone
- aggregate zone sensor output
- options flow for renaming the zone, changing trackers, and editing the polygon
- in-repo geometry rules and tracker-confidence handling

## Installation

### Preferred: HACS

1. Go to **HACS -> Integrations**.
2. Open the three-dot menu and choose **Custom repositories**.
3. Add this repository URL.
4. Choose **Integration** as the category.
5. Install **Custom Zone**.
6. Restart Home Assistant.

### Fallback: Manual

1. Copy `custom_components/custom_zone` into your Home Assistant `config/custom_components/` directory.
2. Restart Home Assistant.

## How To Use It

1. Add the **Custom Zone** integration.
2. Enter a unique zone name.
3. Select one or more `person` or `device_tracker` entities.
4. Add at least three polygon points.
5. Use the created sensor to track how many entities are currently inside the zone.

## Documentation

Start with:

- [docs/product-specs/custom-zone-contract.md](docs/product-specs/custom-zone-contract.md)
- [ARCHITECTURE.md](ARCHITECTURE.md)
- [docs/RELIABILITY.md](docs/RELIABILITY.md)

For repository workflow and agent-focussed context, read [AGENTS.md](AGENTS.md).

## Repository knowledge

- [Documentation map](docs/knowledge/documentation-map.md) — RKE-managed reading order and relationship hub.

More