Skip to content

Commit fbfff75

Browse files
authored
README revamp (#549)
* updated readme * another update on the readme
1 parent 5e781c6 commit fbfff75

File tree

1 file changed

+69
-42
lines changed

1 file changed

+69
-42
lines changed

README.md

Lines changed: 69 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -5,85 +5,109 @@
55

66
![ma-logo]
77

8-
# Your areas so smart it's almost magic! 🪄
8+
# Magic Areas for Home Assistant
9+
> Your areas so smart it's almost magic! 🪄
910
10-
Magic Areas is a custom component for [Home Assistant](https://www.home-assistant.io/) that magically makes sense of the devices and entities in your areas so you don't have to! Its main purpose is tracking presence in your Home Assistant's areas but in reality it's much, much more than that.
11+
Ever had your lights turn off while you're still in the room?
1112

12-
<img align="right" width='450' src="assets/images/readme_combined_presence_sources.gif" style="margin-left: 30px; margin-top: 8px;">
13+
**Magic Areas** fixes that. It turns Home Assistant's built-in Areas into **intelligent, presence-aware zones**, automatically detecting when someone is in a room — and when they’ve left — using your existing motion, presence, or occupancy sensors.
1314

14-
### Multiple sources of presence
15+
No more motion-only logic that fails when you sit still. Magic Areas intelligently tracks presence and adds powerful automations like light control, fan activation, and climate presets — all managed through a clean UI.
1516

16-
Motion-activated lights are so 2000s. Magic Areas tracks multiple sources of presence in order to gauge an area's `occupancy` state, which you can use in automations but as you'll see, you might not even have to.
17+
Works out of the box. Fully customizable if you want it.
1718

18-
Motion sensors, doors, media devices, device presence (`device_trackers`) are supported and you can use [Threshold](https://www.home-assistant.io/integrations/threshold/) and [Template](https://www.home-assistant.io/integrations/template/) binary sensors to track presence from power consumption and other entities' states!
19+
## How It Works
1920

20-
In the demo on the left, the area gets cleared instantly for illustration purposes but in reality you can configure the timeout you want for an area to not receive any presence event before it gets marked as clear/not occupied.
21+
* Detects sensors in your areas automatically (motion, presence, BLE, etc.)
22+
* Tracks room presence with a smart `area_state` sensor
23+
* Adds secondary states like `bright`/`dark`, `sleep`, and `extended`
24+
* Includes built-in, automation-like features: light control, fan groups, climate preset switching, and more
25+
* Fully configurable through the UI
2126

22-
The "Presence Hold" feature gives you a `switch` that is considered a source of presence and will let users hold an area `occupied` while the switch is `on`.
27+
## Features
2328

24-
<img align="right" src="assets/images/upstairs-controls.png" style="margin-left: 30px; margin-top: 25px;">
29+
### 💡 Smart Light Groups
2530

26-
### Meta-areas
31+
Automatically groups your lights by purpose — overhead, task, accent, and sleep — and controls them based on presence state. Lights can be set to trigger only in the dark or after extended occupancy.
2732

28-
Magic Areas allows you to specify if an area is `interior` or `exterior` which allows it to create Meta-areas which groups all entities from said areas into their respective meta-areas.
33+
➡️ Group `light` entities like `Kitchen Overhead Lights`, `Bedroom Accent Lights`
2934

30-
Since the addition of `floors` to Home Assistant, Magic Areas now supports `floor` meta-areas in the same way as it does for the `exterior` / `interior` ones!
35+
### 🌡️ Climate Control
3136

32-
Some features (such as aggregation and groups) are available for meta-areas which allows you to control all your lights, media player devices, covers and climate devices of exterior areas, interior areas or whole floors in a single place.
37+
Map area states to climate device presets. For example: set your HVAC to `eco` when empty, and back to `comfort` when occupied or in sleep mode.
3338

34-
Meta-areas simplify things by allowing you to use their aggregate sensors such as "Interior Motion" and "Exterior Door" in your alarm setups, "Exterior Light" as your area light sensors and much more!
39+
➡️ Works best in meta-areas like Interior or Floor
3540

36-
<img align="right" width='450' src="assets/images/temperature-aggregate.png" style="margin-left: 30px; margin-top: 8px">
41+
### 🧠 Wasp in a Box
3742

38-
### Aggregate sensors
43+
Reliable presence sensing that accounts for people entering/leaving rooms with doors. Combines motion and door/garage sensors to prevent lights from turning off while you’re still inside.
3944

40-
Group and automatically convert different unit sensors of the same `device class` together!
45+
### 🕰️ Smart Presence Timeouts
4146

42-
Aggregates are plain Home Assistant [Groups](https://www.home-assistant.io/integrations/group/) and behave the same. Sensors of the same `device class` but with different `units of measurement` will be normalized and converted according to your unit system.
47+
Each area has a configurable timeout for clearing presence after the last motion. If motion is detected again within the timeout, it resets — no abrupt shutoffs.
4348

44-
Even if you only have one sensor of each `device class`, aggregates allows you to reference a single entity in your automations while considering all others of the same `device class` but also allowing you to add new devices/entities to an area and having them automatically be considered in your automations that reference their aggregates.
49+
### 🕯️ Secondary States
4550

46-
### Light Groups
51+
Define subtle room states for more nuanced automations:
4752

48-
Probably the most utilized feature of Magic Areas, allows you to automatically control your area's lights according an area's state. Would you like to have your overhead lights turned on when dark, but only your accent lights when watching TV unless you're sleeping then only a small light strip under your bed? Magic Areas has got you covered!
53+
* `dark` / `bright`: Based on light sensors or sun
54+
* `sleep`: Tracked by any entity
55+
* `extended`: When a room has been occupied beyond a set time
56+
* `accented`: Track presence based on entertainment like media players
4957

50-
Our light groups are also smarter, meaning when you, for example, change brightness or color in a Magic Light Group, unlike regular Light Groups, it won't turn on other lights that are members of the same group that are off, effecively allowing changes in a light group to affect only lights that are currently on!
58+
### 🔥 Fan Groups
5159

52-
When an area is clear or it gets bright, Magic Areas will take care of turning the lights off for you!
60+
Auto-creates a `fan` group entity for each area and lets you control it using an aggregated value like temperature, humidity, or CO₂. Great for exhaust fans, ceiling fans, or air quality fans.
5361

54-
### Climate Groups
62+
### 📶 Area-Aware Media Player
5563

56-
It (usually) doesn't make sense to have your fans running when you're not there, right? If you pair your fans with [Generic Thermostats](https://www.home-assistant.io/integrations/generic_thermostat), you can have Magic Areas turn your fans on (and off!) for you! A clever twist is that areas have an `extended` state and you can set your climate group to only turn on after you've been there for a while, to avoid them coming on when you're just passing by.
64+
Play media (like TTS alerts) only in rooms that are currently occupied. Forward notifications to the right areas — not empty ones.
5765

58-
### Area-aware media player
66+
➡️ Configurable per area: pick devices, states, and behavior
5967

60-
Sending Text-to-speech notifications to media players is awesome, but sending notifications where no-one will hear isn't very smart and not magical at all. Area-aware media player is a media player group that will only forward `play` events to configured notification devices (i.e. media players) in areas that are currently `occupied`.
68+
### 🧮 Sensor Aggregates
6169

62-
But wait, you won't wake up your kids! Magic areas allows you to specify states in which an area must be in order to receive notifications. Since Magic Areas supports a `sleep` state, if you leave that state out, areas that are sleeping won't be notified!
70+
Aggregates all `sensor` and `binary_sensor` entities in the area by `device_class` and `unit_of_measurement`. Great for dashboards, alerts, and logic.
6371

64-
_And that's just the coolest ones, for all the features Magic Areas provides, check out the [wiki](https://github.com/jseidl/hass-magic_areas/wiki/Features)._
72+
➡️ Auto-generates `sensor.area_temperature` or `binary_sensor.area_motion` style entities
6573

66-
## Demo / How can Magic Areas help me?
74+
### 🚨 Health Sensors
6775

68-
Check out the wiki cookbook [Magic Areas in every room](https://github.com/jseidl/hass-magic_areas/wiki/Magic-Areas-in-every-room) to see how you can apply Magic Areas to make every room in your house, magic!
76+
Auto-aggregated binary sensors for safety-related device classes:
77+
78+
* `gas`, `smoke`, `moisture` (leaks), `problem`, `safety`
79+
80+
➡️ Works in all areas including meta-areas
81+
82+
### ✋ Presence Hold
83+
84+
Creates a switch to manually override presence in an area. Useful if sensors aren’t fully reliable yet or for guests. 📖 [Learn more](https://github.com/jseidl/hass-magic_areas/wiki/Presence-Hold)
6985

70-
## Installation
86+
➡️ Optional timeout to reset the hold automatically
7187

72-
_Magic Areas_ is available on [HACS](https://hacs.xyz/)! For installation instructions check the installation [wiki](https://github.com/jseidl/hass-magic_areas/wiki/Installation).
88+
### 📡 BLE Tracker Integration
7389

74-
## Configuration
75-
Configuration options for `Magic Areas` are on a per-area basis.
90+
Track text-based BLE sensors (like ESPresense, Bermuda, or Room Assistant) directly. Magic Areas will convert their values into usable presence sensors automatically.
7691

77-
> ⚠️ Before you start: Please make sure you understand all the **Concepts** on the [wiki](https://github.com/jseidl/hass-magic_areas/wiki).
92+
### 🏠 Meta-Areas and Hierarchies
7893

79-
> 💡 Light Groups won't control any lights unless the `Light Control` switch for that area is turned `on`!
94+
Tag areas as **interior**, **exterior**, or assign them to **floors**. Magic Areas will create meta-areas to track grouped presence (e.g., upstairs occupied). Presence logic and secondary states are inherited and calculated automatically.
8095

81-
Go to **Configuration** > **Integrations**. You will see the *Magic Areas* integration and configure each area (and [Meta-Areas](https://github.com/jseidl/hass-magic_areas/wiki/Meta-Areas)!).
96+
> 📖 Check out all the features on the [Magic Areas wiki](https://github.com/jseidl/hass-magic_areas/wiki/Features)!
8297
83-
See all configuration options in the [wiki](https://github.com/jseidl/hass-magic_areas/wiki/Configuration).
98+
## 🧙 Demo / How can Magic Areas help me?
8499

100+
Check out the wiki cookbook [Magic Areas in every room](https://github.com/jseidl/hass-magic_areas/wiki/Magic-Areas-in-every-room) to see how you can apply Magic Areas to make every room in your house, magic!
101+
102+
## 🚀 Getting Started
103+
104+
1. Install via [HACS](https://hacs.xyz/) → Magic Areas
105+
2. Go to Settings → Devices & Services → Magic Areas
106+
3. Start adding your Areas and tweaking settings
85107

86-
## Magic Areas in your language!
108+
📖 Visit the [Wiki](https://github.com/jseidl/hass-magic_areas/wiki/Configuration) for complete guides, examples, and tips.
109+
110+
## 🌐 Magic Areas in your language!
87111

88112
Magic Areas has full translation support, meaning even your entities will be translated and is available in the following languages:
89113

@@ -93,7 +117,7 @@ Magic Areas has full translation support, meaning even your entities will be tra
93117

94118
Help to translate Magic Areas into your language from your web browser! We use [Hosted Weblate](https://hosted.weblate.org/engage/magic-areas/) so you don't need to fool around with pull requests nor JSON files!
95119

96-
## Problems/bugs, questions, feature requests?
120+
## 🛠️ Problems/bugs, questions, feature requests?
97121

98122
### Questions?
99123

@@ -116,10 +140,13 @@ As soon as the issue occurs capture the contents of the log (`/config/home-assis
116140

117141
Please do not open issues for feature requests. Use the [Feature Request discussions area](https://github.com/jseidl/hass-magic_areas/discussions/categories/ideas-feature-requests) to contribute with your ideas!
118142

119-
## Contributions are welcome!
143+
### Contributions are welcome!
120144

121145
If you would like to contribute to Magic Areas please read the [Contribution guidelines](CONTRIBUTING.md).
122146

147+
---
148+
149+
Enjoy smarter automations — and areas that finally understand you're still in the room ✨
123150

124151
***
125152

0 commit comments

Comments
 (0)